To create a new data import template

Parent Previous Next

The procedure to create a new data import template is as follows:

  1. Navigate to Quick Menu > System > File Import and Export > File Import and Export Templates. The File Import and Export Template window is displayed.
  2. Click on New Template 1. All fields are activated ready for data entry.
  3. Enter a Description for the data import template into the field provided 2.
  4. Using the Type drop-down field, select the desired template category matching the source data to be imported e.g. Payments, Entitlements, Adjustments, Standard Rents, Promaster Gas, Service Charge Scheme, etc. 3. Multi-select the desired Payment types, Entitlement providers, Rent elements, Standard rent types, etc. as appropriate, from the supplementary drop-down fields, or choose the ALL option, as required 4 1.
  5. Using the Companies drop-down field, multi-select all companies for which this data import template is relevant, or choose the All option, as required.
  6. Using the File format drop-down field, select the option matching the structure of the source data to be imported i.e. XML, Fixed Width Text File or Delimited Text File.
  7. Optionally, to configure the data import template for an XML file structure: (a) Enter the Header tag name into the field provided; (b) Enter the Detail section tag name into the field provided; (c) Enter the Detail item tag name into the field provided; (d) Enter the Footer tag name into the field provided 5.
  8. Optionally, to configure the data import template for a Fixed Width Text File structure: (a) Enter the number of Header rows contained in the source file - The Up and Down arrows are available to increment or decrement the value, as required; (b) Enter the number of Footer rows contained in the source file - The Up and Down arrows are available to increment or decrement the value, as required.
  9. Optionally, to configure the data import template for a Delimited Text File structure: (a) Using the Delimiter drop-down field, select the option matching the structure of the source data i.e. Comma, Tab or Pipe; (b) Enter the Text qualifier symbol into the field provided; (c) Enter the number of Header rows contained in the source file - The Up and Down arrows are available to increment or decrement the value, as required; (d) Enter the number of Footer rows contained in the source file - The Up and Down arrows are available to increment or decrement the value, as required.
  10. Choose an Effective from date for this data import template i.e. the date on which it came into effect.
  11. Choose an Effective to date if the data import template is to be reviewed on a specific date or to capture a change of circumstances; a blank field means the template will be continually valid.
  12. Click on Save 6. All data fields supported by the selected import type are displayed in the Data Fields summary table (Details tab).


Tip

1 Where only a small number of parameter values are not required, activate the All tick box first and then deselect individual items from the full list, as appropriate; the All tick box will be automatically removed once an item is deselected.

Note

1 Upon first access, all fields are automatically activated ready for data entry; hence the New Template button is inactive.

2 System validation rules ensure that the description entered for each data import template is unique for the effective period.

3 The Data Import Framework contains a broad range of prescribed import template options, which is continually expanding in line with new partner integration opportunities.

4 Specific data entry fields pertinent to the selected Import type will be automatically revealed or hidden. For Adjustments, the available Rent elements will be filtered in accordance with the system preference Rent elements to display in rent adjustment wizard where adjustment only is true.

5 Any tags that do not form part of the source data structure can be left blank.

6 To amend the details of an existing data import template, expand an import type heading and select an associated data import template from the alphabetical list, or type its name into the Search File Import and Export Template field. By default the list is filtered to show Current data import templates. An alternative filter can be applied using the Select view drop-down field: Expired, Future or All combinations. Only a limited number of fields can be updated once a record has been created.


See related topics...

Data import management overview

To define the field properties of a data import template