These settings appear in each layout in the qaworld.ini file, which you should call with QABatchWV_Open. The keywords in this section can be prefixed by [identifier]. This makes it possible to define address formats for more than one data mapping within a single configuration layout. Identifiers are set up using the DataMappings keyword. For example, the setting CapitaliseItem would become AUSCapitaliseItem for the default Australian data mapping.
[identifier]AddressLineCount={integer}
0
This defines the number of lines in the formatted output address. The format of each individual line is specified with the AddressLineN keyword. The number of lines you specify should include any lines of address and DataPlus information.
The following setting tells Batch API to produce formatted output addresses of six lines for the 'AUS' data mapping.
AUSAddressLineCount=6
[identifier]AddressLine1=W{width},{element list}
[identifier]AddressLine2=W{width},{element list}
…
[identifier]AddressLineN=W{width},{element list}
Blank
This specifies which address element or DataPlus information is to appear on which line. W signifies that the number that follows it is the maximum width of the line in characters, and {element list} is a comma-separated list of element code. Address element codes are listed in the Data Guide associated with your dataset. If you do not specify {element list} Batch API will automatically spread the standard address over the available lines. By specifying element codes, you force Batch API to place the elements on a particular line (if the element exists in the matched address).
Name information
By default, if an input address contains a recognized alternative version of an official address element it will be replaced by the official version. To configure Batch API to retain the version in the input address, append the element with a #. For example, NZLAddressLine3=L21#.
If you want to return DataPlus information, use the base name and the element name in place of an address element (see example 2). You can allow Batch API to insert other suitable elements before, after or between fixed elements by using the format specifier '…'.
The following instructs Batch API to give line 1 of the 'NZL' output address a maximum width of 30 characters:
NZLAddressLine1=W30,S21,...
The Whole Street element is fixed to the line, and any subsequent elements can also appear on the line if they fit there.
This example tells Batch API to give line 6 of the 'AUS' output address a maximum width of 40 characters, and fix the description part of the MOSAIC DataPlus set to that line:
AUSAddressLine6=W40,AUSMOS.Desc
[identifier]CapitaliseItem={element list}
Blank
This keyword defines which address elements should appear in upper case in the formatted address. The value of the keyword is a list of element codes separated by spaces.
The following setting means that the building name and country name elements will be capitalized:
AUSCapitaliseItem=P21 X11
[identifier]AbbreviateItem={element list}
Blank
This keyword defines which address elements should be abbreviated in the formatted address. The value of the keyword is a list of element codes separated by spaces.
The following setting means that the Australian state name will be abbreviated:
AUSAbbreviateItem=L12
GBR or USA data
[identifier]ConditionalFormat={text string}
This setting has a different function depending on the dataset being used. For the GBR with additional Business dataset this setting allows the user to specify whether to display the PAF or Experian organization data, or a combination of both. There are four possible values for this keyword:
| Values | Description |
|---|---|
| ExperianOrgPref (default) |
The Experian organization name takes priority, but the PAF organization name will be used if there is no Experian equivalent for the address. |
| ExperianOrgOnly | Only Experian organisation names will be returned, and PAF organisation names will be suppressed if there is no Experian equivalent for the address. |
| PostOrgPref | The PAF organisation name takes priority, but the Experian organisation name will be used if there is no PAF equivalent for the address. |
| PostOrgOnly | Only PAF organisation names will be returned, and Experian organisation names will be suppressed if there is no PAF equivalent for the address. |
For the USA dataset this setting allows the user to specify whether to return the full city name or the abbreviated city name.
There are two possible values for this keyword:
| Values | Description |
|---|---|
| NormCity (default) |
The full city name will be returned. |
| AbbCity | The abbreviated city name will be returned. This will have a maximum of 13 characters. |
Data
AbbreviateAddr={Boolean}
No
This setting allows you to limit the first line of output addresses to a maximum of 30 characters. This setting works with Batch Compatibility Formatting mode and in CASS Certified Mode.
If you want to limit the first line of output addresses to a maximum of 30 characters, use the following:
AbbreviateAddr=Yes
Data
CompatibilityFormatting={Boolean}
No
This setting determines whether Batch should run in Compatibility Formatting mode. Compatibility Formatting mode is not certified, and will not use Delivery Point Validation, but does offer increased flexibility in matching and output address formatting.
If you want Batch to run in Compatibility Formatting Mode, use the following:
CompatibilityFormatting=Yes
MultiValueDPSeparator={string}
|
This keyword can be specified for each layout in the configuration file. If you are using United Kingdom with Gas or Electricity data, Batch API will return all multiple meter numbers. This keyword can be used to change the default delimiter.
The delimiter cannot be alphanumeric. The API will verify the setting and use the default character if an invalid character is used.
If you want the multiple meter numbers to be returned separated by a comma, use the following:
MultiValueDPSeparator=,
