Each rule is stored an XML-style format containing various elements to describe what the rule is and what it does. The elements are as follows:

• Id: automatically assigned - should not be changed.
• Name: the name of the rule - if this needs to be changed it should be changed in the relevant box above the rule text field.
• Description: the description for the rule - change in the relevant box.
• AccountCode: your account code - should not be changed.
• Username: the user the rule belongs to - change in the dropdown above the rule text box.
• IsPublic: boolean value denoting public status (1 = public, 0 = private) - should be changed in the top section of the editor window.
• Formatting: how the address is to be constructed when it is written in to the target application.
  • Type: integer value for the address format type.
    Possible values are:
    0 = use separate address lines (line 1, line 2 etc.);
    1 = individual PAF elements (separates out building name, number, street etc.);
    2 = single address label.
  • Lines: the number of address lines for type 0 formatting
  • SeparateCompany: boolean value denoting whether the company and deparment names should be separate to the rest of the address (1 = separated, 0 = included in address lines).
  • SeparateTown: boolean value denoting whether town, county and postcode fields should be separate to the rest of the address (1 = separated, 0 = included in address lines).
• Services: flags if any extra data sets are to be included along with the address.
  • IncludeAcorn: boolean value - true (1) if Acorn® data is to be included.
  • IncludeAdmin: boolean value - true (1) if ward, district and parliamentary constituency data is to be included.
  • IncludeGrid: boolean value - true (1) if grid reference data is to be included.
  • IncludeO2: boolean value - true (1) if Objective 2 eligibility data is to be included.
  • IncludePaf: boolean value - true (1) if mailsort, DPS and barcode values are to be included.
• Priority: integer value - rules with a higher priority are used over other rules for the same window.
• Windows: the windows (applications) that the rule will work with.
  • Window: the string representation of the window title for the selected application - can be all or part of the window title.
• Steps: the collection of rule steps to be taken.
  • Step: individual step details.
    • Type: the type of action the step will take.
      Possible values are:
      0 = Delete the postcode entered to trigger the lookup
      1 = Pause
      2 = Wait for the application to get focus
      3 = Write a specific key press
      4 = Write a specific data field
    • Value: string representation of the field name to be written out.
      Possible values are (explanations where necessary):
      PAF-COMPANY
      PAF-DEPARTMENT
      PAF-LABEL - writes the address with line breaks between each element.
      PAF-LABEL-CP - as PAF-LABEL but does not include the company/department or town/county/postcode.
      PAF-LABEL-C - as PAF-LABEL but does not include the company/department
      PAF-LABEL-P - as PAF-LABEL but does not include town/county/postcode
      PAF-LINE-1
      PAF-LINE-2
      PAF-LINE-3
      PAF-LINE-4
      PAF-LINE-5
      PAF-TOWN
      PAF-COUNTY
      PAF-POSTCODE
      PAF-FLAT
      PAF-BUILDING-NUMBER
      PAF-BUILDING-NAME
      PAF-STREET
      PAF-DISTRICT
      PAF-MAILSORT
      PAF-BARCODE - for use with the barcode font (included with the Client setup file)
      PAF-DPS - delivery point suffix
      ACN-GROUP - Acorn® group number
      ACN-GROUPDESCRIPTION
      ACN-TYPE - Acorn® type number
      ACN-TYPEDESCRIPTION
      PZN-EASTING - 100 metre accurate easting grid reference from Postzon
      PZN-NORTHING - 100 metre accurate northing grid reference from Postzon
      PZN-GRID - OS grid reference from Postzon
      PZN-LONGITUDE - WGS84 longitude value
      PZN-LATITUDE - WGS84 latitude value
      PZN-COUNTRY-CODE - 3 digit code from Postzon
      PZN-COUNTY-CODE - ONS county code from Postzon
      PZN-DISTRICT-NAME
      PZN-DISTRICT-CODE
      PZN-WARD-NAME
      PZN-WARD-CODE
      PZN-O2-STATUS - Objective 2 eligibility status
      PZN-O2-DESCRIPTION
    • ValueInCaps: boolean value - true (1) if the field should be in uppercase
    • Always: boolean value - true (1) if the step should be run even if the field has no value
    • KeysBefore: keys to press before the field is written out or for a type 3 (keypress) step.
      Special key presses should be in brackets {}.
      If a special key is pressed more than once this can also be represented within the brackets, e.g. {TAB 6}.
      Shift and a special key is denoted with +, e.g. +{TAB}
      Ctrl and a special key is denoted with ^, e.g. ^{TAB}
      Alt and a special key is denoted with %, e.g. %{TAB}
      Useful values are: TAB, ENTER, UP, DOWN, LEFT, RIGHT, DEL, BKSP, END, HOME, PGDN, PGUP, ESC.
    • KeysAfter: keys to press after the field is written out (as above).