Description of Attribute Scan Arguments - trillium_discovery - trillium_quality - 17.1

(REQUIRED) Specifies a block of settings in the settings file.

Values

Numeric value.

Example

<ENTRY>

<ENTRY_ID>1</ENTRY_ID>

(OPTIONAL) Used to enter descriptions of certain functions. For each description, you can use alphabetic or numeric input, with a 100-byte limit. If this argument is not defined, a No Description Specified message displays in the description column of the statistics file.

Format

ENTRY_DESCRIPTION <description>

Values

Alpha and numeric.

Example

<ENTRY_DESCRIPTION>Convert a to A</ENTRY_DESCRIPTION>

(REQUIRED) Attribute in the output schema that will be scanned for a specified scan value.

Values

Attribute name.

Example

<SCAN_FIELD>Phone Number</SCAN_FIELD>

(OPTIONAL) Attribute to store the result of the scan.

Values

Attribute name.

Example

<SCAN_FIELD>Phone Number</SCAN_FIELD>

<TARGET_FIELD>Area Code</TARGET_FIELD>

<SCAN_VALUE>"617"</SCAN_VALUE>

<SCAN_FUNCTION>CP</SCAN_FUNCTION>

(OPTIONAL) Specifies the type of justification to be performed on the specified attributes. This is performed prior to the function. Note that for Asian character data there is no distinction between full-width spaces and half-width spaces in this operation. Full-width spaces within the text are converted to half-width spaces.

Values

LA

Left Adjust. Remove all spaces around the value, pad the attribute with spaces, and change multiple spaces between the value to a single space.

RA

Right Adjust. Remove all spaces around the value, pad the attribute with spaces, and change multiple spaces between the value to a single space.

LT

Left Trim. Remove all spaces around the value and pad the attribute with spaces.

RT

Right Trim. Remove all spaces around the value and pad the attribute with spaces.

LP

Left Pack. Remove all spaces, pack left, and pad the attribute with spaces.

RP

Right Pack. Remove all spaces, pack right, and pad the attribute with spaces.

NJ

No Justification (default). No action is taken.

Example

<FIELD_JUSTIFICATION>LA</FIELD_JUSTIFICATION>

(OPTIONAL) The type of scanning to be performed on the data in SCAN_FIELD.

Values

L

Literal values, such as "abc" (default).

M

Mask values, such as NN-NN.

Example

<FIELD_JUSTIFICATION>LA</FIELD_JUSTIFICATION>

<SCAN_FORMAT>M</SCAN_FORMAT>

(OPTIONAL) Specifies the encoding instructions for interpreting the literal characters specified in the BETWEEN_SUBSTRING argument. The default is to use the platform native encoding.

Values

Encoding table.

Example

<BETWEEN_SUBSTRING_ENCODING>cp1252</BETWEEN_SUBSTRING_ENCODING>

(OPTIONAL) Specifies the starting substring of user-defined characters after which to scan. This argument can be used with the AND_SUBSTRING argument.

Values

User-specified string.

Example

If you are looking for the scan value "abc" in -abc-:

<BETWEEN_SUBSTRING>-</BETWEEN_SUBSTRING>

If you are looking for the scan value "abc" in -abc*:

<BETWEEN_SUBSTRING>-</BETWEEN_SUBSTRING>

<AND_SUBSTRING>*</AND_SUBSTRING>

(OPTIONAL) Specifies the ending substring of user-defined characters before which to scan. This argument can be used with the BETWEEN_SUBSTRING argument.

Values

User-specified string.

Example

If you are looking for the scan value "abc" in -abc*:

<BETWEEN_SUBSTRING>-</BETWEEN_SUBSTRING>

<AND_SUBSTRING>*</AND_SUBSTRING>

(OPTIONAL) Tells the attribute scanning function that the scan value is retained between the two characters specified in BETWEEN_SUBSTRING.

Values

Y

Scan for value found between the two characters specified in BETWEEN_SUBSTRING.

N

Do not scan for BETWEEN_SUBSTRING values (default).

Example

<RETAIN_BETWEEN_SUBSTRING>Y</RETAIN_BETWEEN_SUBSTRING>  

(OPTIONAL) Specifies the encoding instructions for interpreting characters in SCAN_VALUE. The default is the platform’s native encoding.

Values

Encoding table.

Example

<SCAN_VALUE_ENCODING>cp1252</SCAN_VALUE_ENCODING>

(OPTIONAL) Identifies the value to be scanned for in the attribute named in SCAN_FIELD.

Values

User-defined string.

Example

<SCAN_VALUE>"abc"</SCAN_VALUE>

(OPTIONAL)Indicates whether a case-sensitive scan is enabled for the literal type.

Values

Y

Transformer does a case-sensitive scan (default).

N

Transformer does a case-insensitive scan.

Example

<CASE_SENSITIVE_SCAN_VALUE>Y</CASE_SENSITIVE_SCAN_VALUE>

(OPTIONAL) Indicates that the scan value is included in the target attribute. This argument becomes invalid if SCAN_FUNCTION is set to CH (change) or F (flag).

Values

S

Retain the scan value in the scan attribute but not in the target attribute.

T

Retain the scan value in the target attribute but not in the scan attribute.

B

Retain the scan value in both the scan attribute and the target attribute.

N

Do not retain the scan value in either the scan attribute or the target attribute.

Example

<RETAIN_SCAN_VALUE>S</RETAIN_SCAN_VALUE>

(REQUIRED) Indicates which specific function to perform, if the scan value is found in the scan attribute.

Values

CH

Change (the specified scan attribute’s data).

CP

Copy (data from scan attribute to target attribute).

CT

Cut (data from scan attribute and place in target attribute).

F

Flag (place data specified in FLAG_VALUE in target attribute).

Example

<SCAN_FUNCTION>CH</SCAN_FUNCTION>

(OPTIONAL) Direction from which to begin scanning the data in the scan attribute.

Values

L

Begin scanning from the left (default).

R

Begin scanning from the right.

Example

<SCAN_DIRECTION>L</SCAN_DIRECTION>

(OPTIONAL) Specifies the location in the attribute from which to start scanning.

Values

B

Beginning (value is found exactly at the beginning of the scan attribute).

D

Default (value is found anywhere in scan attribute) (default).

E

End (value is found exactly at the end of scan attribute).

S

Start of text (value is found exactly at the beginning of the text in the scan attribute).

F

Finish of text (value is found exactly at the end of the text in the scan attribute).

Example

<SCAN_POSITION>B</SCAN_POSITION>

(OPTIONAL) Specifies whether to scan at the field (attribute) or word level. The default delimiter used is a "space" character. If word scanning is required, you should use the WORD_DELIMITER argument to define the delimiter.

Values

F

Field—scan entire attribute for scan value (default).

W

Word—scan each word for scan value.

Example

<SCAN_LEVEL>W</SCAN_LEVEL>

(OPTIONAL) Specifies how much of the scan attribute data is to be captured in the process of recoding. This argument becomes invalid if SCAN_FUNCTION is set to CH (change) or F (flag).

Values

L

Left—all data found to the left of the scanned value.

R

Right—all data found to the right of the scanned value.

A

All—the entire field data.

V

Value—just the scanned value (default).

Example

<SCAN_CAPTURE>R</SCAN_CAPTURE>

(OPTIONAL) Encoding used to interpret literal characters specified in WORD_DELIMITER. If not specified, the default is the platform’s native encoding.

Values

Encoding table.

Example

<WORD_DELIMITER_ENCODING>cp1252</WORD_DELIMITER_ENCODING>

(OPTIONAL) The character that was used as word separator in the scan attribute’s data (such as a space or a tab).

Values

User-defined entry for delimiter character. Default is space.

Example

<WORD_DELIMITER>tab</WORD_DELIMITER>

(OPTIONAL) Specifies the starting delimiter to scan words.

Values

User-defined entry for delimiter character.

Example

<START_DELIMITER>"//"</START_DELIMITER>

(OPTIONAL) Specifies the ending delimiter to scan words.

Values

User-defined entry for delimiter character.

Example

<END_DELIMITER>"//"</END_DELIMITER>

(OPTIONAL) Provides encoding instructions that are used to interpret literal values specified in the CHANGE_VALUE argument. The default is to use the platform native encoding.

Values

Encoding table.

Example

<CHANGE_VALUE_ENCODING>cp1252</CHANGE_VALUE_ENCODING>

(OPTIONAL) Specifies a value that replaces each occurrence of the found scan value in the specified scan attribute. This argument works in conjunction with the SCAN_FUNCTION argument set to CH (change).

Values

User-defined value.

Example

In this example, the value NNN-NN-NNNN would replace each occurrence of the found scan value in the Phone Number attribute.

<SCAN_FIELD>Phone Number</SCAN_FIELD>

<SCAN_FUNCTION>CH</SCAN_FUNCTION>

<CHANGE_VALUE>NNN-NN-NNNN</CHANGE_VALUE>

(OPTIONAL) Specifies the number of scan value occurrences to be changed in the specified scan attribute. Used when SCAN_FUNCTION argument set to CH (change).

Values

A, 0, 1, 2, ...,n. Default is 1. The values 0 and A refer to all occurrences.

Example

In this example, all occurrences of the found scan value would be changed.

<CHANGE_OCCURENCES>A</CHANGE_OCCURENCES>

(OPTIONAL) Specifies the encoding instructions used to interpret literal characters specified in FLAG_VALUE. If not specified, the default is the platform’s native encoding.

Values

Encoding table.

Example

<FLAG_VALUE_ENCODING>cp1252</FLAG_VALUE_ENCODING>