Skip to main content
Skip table of contents

AO Constant Key

Overview

AO Constant Key builds and maintains a constant record key, flagging duplicate IDs, identifying master records, if any, and adding new IDs as appropriate. Constant keys are typically used for situations that involve an initial "build" match process followed by a series of "update" match processes. The initial "build" match assigns constant keys to the match groups, whereas each "build" adjusts existing constant keys as households change, and assigns new constant keys to newly-added records.

The macro accepts a single input connection (usually from a database or matching process).

AO Constant Key configuration parameters

AO Constant Key has a single set of configuration parameters in addition to the standard execution options.

Input

Parameter

Definition

Existing constant key

(Required) An existing unique record identifier. For the initial "build" match process, this will be unused (leave the field name blank). For subsequent "update" processes, this will be mapped, where the previously-matched master records will contain constant key values, but the new "update" source records will contain null values.

  • Default: blank

Max existing key

(Required) Highest currently assigned constant key. This is usually computed by AO Max ID or by query from the master relational database. Leave this mapping blank for the initial "build", but populate it for "update".

  • Default: blank

Match ID

(Required) The match ID produced by the matching process. Must be null for unique records. These values are unrelated to the existing constant keys.

  • Default: blank

Output

Parameter

Definition

New constant key

(Required) Field for unique record identifier. This result combines the existing constant keys (if any) with the new matches to produce.

  • Default: NEW_ID

Multi-key flag

Field for Boolean flag indicating whether record belongs to belongs to a match group containing more than one existing constant key.

  • Default: MULTI_ID_FLAG

To see an example of this Advanced Object in action, open the AO Matching/Samples folder and then choose the Constant Key Simple Sample project.

Configure AO Constant Key

To configure AO Constant Key:

  1. Select the AO Constant Key icon.

  2. Go to the Configuration tab on the Properties pane.

  3. Select Existing constant key and select the field containing the existing unique record identifier.

  4. Select Max existing key and select the field containing the highest currently assigned constant key.

  5. Select Match ID and select the field containing the match ID produced by the upstream matching process. This must be null for unique records.

  6. Optionally, select New constant key and Multi-key flag and specify alternative output field names.

  7. Optionally, go to the Execution tab, and then set Web service options.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.