Workflows

Typically, the process of searching with the SingleLine engine follows this format:

1. Pre-search: an optional check on the validity of a search using the DoCanSearch action.
2. Initial search: the DoSearch action can be used for the initial search. It returns a Picklist object which contains PicklistItems that can be displayed. Each item can remain merely informational, be expanded or formatted into a final address.
3. Handling picklists and monikers: the picklist items are displayed to the user. Depending on the user's actions, one of the following will occur:
   • The DoRefine action can be used to 'step into' a picklist result (for example, a street name will show a picklist of premises). This hierarchical picklist behavior is the default. If a single flattened picklist is required, the flatten flag has to be set before the initial search is performed.
   • The DoRefine action can be used to narrow down the current picklist to one with a subset of items (for example, using "high" on street names will return another picklist containing only streets starting with "high").
     The DoRefine action is also called in certain special cases. For example, when an item is an unresolvable range (certain countries) or a Phantom Primary Point (AUS only).
   • The DoGetAddress action can be used to format a final address. A call to stepIn, refine or DoGetAddress requires a moniker from either the Picklist or a PicklistItems returned by a previous call. These monikers encode the information required to recreate a particular picklist/picklist item, and are the means by which any integration navigates the search process.
4. Format the final address: once the final address has been identified, the DoGetAddress action will apply a layout to this item, returning a FormattedAddress object that contains the final formatted address.

The Verification engine is designed to require minimal, if any, interaction from the user. This can be defined by the integrator.

The user should enter the full address in the same format that they would write it on an envelope, and the entire address is submitted to the engine.

Picklists are only returned by verification searches where the verification level is high enough to match to at least one address, but not high enough to confidently match a single address, for example PremisesPartial, StreetPartial or Multiple.

In such cases, the integrator may decide to offer the user a picklist and let them proceed in a similar fashion to the address search process above or simply to ignore the picklist and use the address as originally entered (in order to minimise user interaction).

The DoCanSearch action may be called for the Verification engine, but it is unlikely that this extra step in the workflow will be useful: the page can simply perform a search and process the results as required.

The typical search process for verification is as follows:

1. Pre-check: an optional check on the validity of a search using the DoCanSearch action.
2. Initial search: call the DoSearch action which returns a SearchResult object that may contain a FormattedAddress object and/or a Picklist object, as well as VerifyLevel.
   If picklists are not being handled, the integrator may simply check that the VerifyLevel is high enough before using FormattedAddress.
3. (Optional step) if required, you can handle the picklist using the DoRefine action.
4. Format the final address: once the final address has been identified, the DoGetAddress action will apply a layout to this item, returning a FormattedAddress object that contains the final formatted address.