AO Combined Report
Overview
This reporting macro provides four different summary outputs. Each one produces a different data report. This information is useful for examining the processing results of a project that performs both address correction and matching.
Advanced Object (AO) Combined Report takes a single stream as input and produces four different outputs:
"A" Address outputs counts for the Status Code, Address Type, Non-deliverable Flag, and Component Status Code. This is useful for examining the type of address found in the source data and what level of correction was possible.
"C" Component outputs information on each position of the 13-character Component Status Code. This is useful for examining what data was changed in each of the address components.
"M" Match: If a Match macro is used upstream, this will output the same information as AO Match Report By Source, plus a timestamp.
"S" Source produces a simple record count by each source identified by AO Define Source.
Each of the output connectors includes a Date Processed field. This is useful for populating a metadata repository with historical data on a project.
AO Combined Report configuration parameters
AO Combined Report has a single set of configuration parameters:
Parameter | Description |
|---|---|
ID | (Required) Refers to the Match ID generated from a matching process. For correct reporting, this will assume empty (null) values are Unique (U) and calculate single source only matches (S) and multi-source matches (M) based on the Source value.
|
Source | (Required) Source name, typically assigned using AO Define Source.
|
Priority | (Required) Match Rank Priority value. This is typically assigned using AO Define Source and determines a record's position in a match group. This will determine which source receives the "Master" designation in multi source matches. If you have used AO Match Append Info already, use the output Group Order field as the priority. This will eliminate the need for tie-breakers.
|
Suppress flag | (Optional) Indicates that the record is from a source used for suppression. This is typically assigned using AO Define Source.
|
Status | (Required) The status code from upstream Standardize Address tool or AO Address Quality macro.
|
Address type | (Required) The Address Type code from upstream Standardize Address tool or AO Address Quality macro.
|
Non-deliverable flag | Required. Non-deliverable flag from upstream Standardize Address tool or AO Address Quality.
|
Address status code | (Required) Component Status Code from upstream Standardize Address tool or AO Address Quality. This contains a separate numeric code for each element (such as Address Number, Predirectional, or Street Name).
|
Master record
Values in text fields sort in alphabetical order, even if the characters are numbers. Numbers are sorted by the first digit, then by the second digit, and so on, instead of by the numeric values. Thus "12" will appear before "7". Check data types or use leading zeros ("07") to ensure correct tie-breaking. Most text fields have a limit of 100MB.
Random priority
Uses random sorting as final tie-breaker. This option may generate different results for each run. If this is option is not selected, the final tie-breaker is the input record order.
Default: no
Parameter | Description |
|---|---|
Random priority | Uses random sorting as final tie-breaker. This option may generate different results for each run. If this is option is not selected, the final tie-breaker is the input record order.
|
Tie-breaker field 1 | The first field used to break priority ties.
|
Order 1 | If ASCENDING, then lower values of Tie-breaker 1 field will have higher priority.
|
Tie-breaker field 2 | The second field used to break priority ties.
|
Order 2 | If ASCENDING, then lower values of Tie-breaker 2 field will have higher priority.
|
Tie-breaker field 3 | The third field used to break priority ties.
|
Order 3 | If ASCENDING, then lower values of Tie-breaker 3 field will have higher priority.
|
AO Combined Report Address output connection
The "A" (Address) connection outputs the following information.
Parameter | Description |
|---|---|
Date processed | Timestamp from generated results.
|
Value | Field for which output is counted (one of Status Code, Address Type, Non-deliverable Flag, or Component Status Code).
|
Code | An entry for each Status Code value that was counted.
|
Meaning | The meaning of the Code.
|
Count | Total number of records for that Value and Code.
|
AO Combined Report Component output connection
The "C" (Component) connection outputs the following information.
Field | Description |
|---|---|
Date processed | Timestamp from generated results.
|
Value | Each of the 13 positions represented in the Address Component Status Code: Address number, Predirectional, Street Name, Suffix, Postdirectional, Unit designator, Unit number, City Name, State, ZIP Code, Plus4, Carrier Route, Delivery Point Code.
|
Code | An entry for each Status Code value that was counted.
|
Meaning | The numeric code for this component. |
Record count | Total number of records for that Code.
|
AO Combined Report Match output connection
The "M" (Match) connection outputs the following information.
Field | Description |
|---|---|
Date processed | Timestamp from generated results.
|
Record count | Total number of records for that Code.
|
Unique count | Total number of records matching no other record.
|
Single master count | Total number of records matching only within a single source (single source masters).
|
Single dupe count | Total number of presumed duplicates (records 2 through N) of groups matching only within a single source (single source duplicates).
|
Multiple master count | Total number of records that are the first record of a group matching more than one source (multi-source masters.
|
Multiple dupe count | Total number of presumed duplicates (records 2 through N) of groups matching more than one source (multi-source duplicates).
|
Suppressed master count | Total number of records that are the first record of a group matching a suppression source.
|
Suppressed dupe count | Total number of presumed duplicates (records 2 through N) of groups matching a suppression source.
|
AO Combined Report Source output connection
The "S" (Source) connection outputs the following information.
Field | Description |
|---|---|
Date processed | Timestamp from generated results.
|
Source name | Source name taken from the Source Name column/field parameter.
|
Source count | Total records from each data source.
|
Configure AO Combined Report
Select the AO Combined Report icon.
Go to the Configuration tab on the Properties pane.
Select ID and choose the field containing the match ID generated by the upstream matching process.
Select Source and choose the source name, typically assigned using an upstream AO Define Source macro.
Select Priority and choose either the Match Rank Priority field (assigned by upstream AO Define Source) or Group Order field (assigned by upstream AO Match Append Info).
Optionally, select Suppress flag and choose the field indicating whether the source is used for suppression. This is typically assigned using AO Define Source.
Select Status, Address type, Non-deliverable flag, and Address status code to choose the fields assigned by an upstream Standardize Address tool or AO Address Quality macro.
Optionally, select Random priority to use random sorting as final tie-breaker rather than input record order.
Optionally, select Tie breaker field 1 and choose a field to be used as final tie-breaker.
Select Order 1 and choose Ascending or Descending sort order. You may add up to three tie-breaker fields.
Optionally, go to the Execution tab, and then set Web service options.