Run-Time Arguments

You can provide arguments to EngageOne™ Enrichment at run time to supplement or override certain tag values specified in the control file and to create user-defined variables. The following table shows valid run-time arguments:

Argument Description
-A=traceLevel,[n] Specifies whether to enable tracing for Finalist processing. This can be used to isolate problematic addresses during the cleansing process.

traceLevel is one of the following: A trace level value where:

  • 1—Displays ADDRSCAN input.
  • 2—Displays ADDRSCAN results.
  • 4—Displays Finalist input.
  • 8—Displays Finalist results.

A combination of these values can be used. For example:

A=12 Enable 4 and 8 (Finalist input and output).

A=7 Enable 1, 2 and 4

A=15 Enable all

A=3 Enable 1 and 2

If an invalid value is specified EngageOne™ Enrichment uses the default value of 15.

n specifies the number of documents to process prior to enabling the trace. This is optional
-C=filename Specifies the control file to use for EngageOne™ Enrichment processing. If you do not use this switch, EngageOne™ Enrichment assumes the control file is DD:CONTROL for mainframe systems or STREAMW.CON for UNIX and Windows. If you have not defined DD:CONTROL on your mainframe system, processing halts.
-E=errorlevel Defines the level of error at which EngageOne™ Enrichment processing will stop, where errorlevel is one of the following:
S Stops processing only if EngageOne™ Enrichment issues a severe message.
W Stops processing if EngageOne™ Enrichment issues a warning or severe message.
I Stops processing when EngageOne™ Enrichment issues an informational, warning, or severe message.
This switch overrides the Environment tag group's <ERRORLEVEL> tag setting in the control file. If you do not use this switch, EngageOne™ Enrichment stops processing according to the <ERRORLEVEL> tag setting. If you have not set the <ERRORLEVEL> tag, processing stops only when a severe message occurs.
-F=filename Specifies the name of the file or DD in which the compiled or decompiled control file will be stored. The default compile DD is DD:COMPCNTL for mainframe systems or STREAMW.CMP for UNIX and Windows. The default decompile DD is DD:DECNTL for mainframe systems or STREAMW.DMP for UNIX and Windows.
-G=filename Specifies the name of the file or DD in which the memory log will be stored. This will store all memory allocations and deallocations used by EngageOne™ Enrichment. Do not use this argument unless instructed to by Technical Support. There is no default.
-I=include Indicates additional content that you want to include in the EngageOne™ Enrichment report file. Currently the only valid value is R, which specifies the inclusion of a numbered listing of the rule file in the EngageOne™ Enrichment report.

Encrypted rule files cannot be included in the EngageOne™ Enrichment report.
-K=key Identifies a key used to compile or decompile control files. A key consists of up to 10 characters that are used to lock or unlock the control file. Any rules included in the control file with the Content tag group are also compiled or decompiled using the key. The first time a control file is processed using a specific key, it is compiled. The next time it is run using the same key, it is decompiled. For more information on compiling and decompiling, refer to Securing a Control File.
-L=length Specifies the size of EngageOne™ Enrichment output messages, where length is one of the following:
S Messages break to the next line every 80 characters.
L Messages break to the next line every 132 characters.

This switch overrides the Environment tag group <REPORTLENGTH> tag setting in the control file. If you do not use this switch, EngageOne™ Enrichment breaks messages according to the <REPORTLENGTH> tag setting. If you have not set the <REPORTLENGTH> tag, EngageOne™ Enrichment breaks messages to the next line every 80 characters.
This switch overrides the Environment tag group <REPORTLENGTH> tag setting in the control file. If you do not use this switch, EngageOne™ Enrichment breaks messages according to the <REPORTLENGTH> tag setting. If you have not set the <REPORTLENGTH> tag, EngageOne™ Enrichment breaks messages to the next line every 80 characters.
-M=filename Specifies the filename for the EngageOne™ Enrichment message file. If you do not use this switch, EngageOne™ Enrichment assumes the message file is DD:REPORT for mainframe systems or STREAMW.MSG for UNIX or Windows. If you have not defined DD:REPORT on your mainframe system, EngageOne™ Enrichment routes messages to JES output (as if you specified SYSOUT=*) and generates a warning.
-O=filename Specifies the filename for the EngageOne™ Enrichment uplift report. The uplift report is generated whenever you use a secondary CASS™ product. (To use a secondary CASS™ product, specify the second parameter of the <CASSTYPE> tag.)
The EngageOne™ Enrichment uplift report shows you the CASS™ coding percentage for each CASS™ product and how much the secondary CASS™ product improved your coding percentage. The EngageOne™ Enrichment uplift report is generated whenever you use a secondary CASS™ product, regardless of whether or not you specify the O run-time parameter. If you do not specify the O parameter the uplift report is placed in the default location as follows:
  • Windows and UNIX: The uplift report is placed in the working directory as is named uplift.txt.
  • Mainframe: The uplift report is placed in DD:UPLIFT.
-R=print Specifies which messages EngageOne™ Enrichment should include in the message file, where print is one of the following:
N Reports no messages.
D Reports detailed messages. This is the most comprehensive level of reporting.
S Reports only severe messages. Severe messages reflect conditions that halt EngageOne™ Enrichment processing.
W Reports warnings and severe messages. Warning messages reflect error conditions that may not cause EngageOne™ Enrichment to stop but can produce unexpected processing results.
I Reports informational, warning, and severe messages. EngageOne™ Enrichment displays informational messages to indicate progress during processing. Informational messages require no corrective action.
P Reports processing, informational, warning, and severe messages. Processing messages are more specific than informational messages and may be helpful as troubleshooting aids.
This switch overrides the Environment tag group <MESSAGELEVEL> tag in the control file. If you do not apply this switch, EngageOne™ Enrichment uses the <MESSAGELEVEL> tag setting to place messages in the processing report. If you have not set the <MESSAGELEVEL> tag, EngageOne™ Enrichment places processing, informational, warning, and severe messages in the report.
-S=messagenumYN Defines whether EngageOne™ Enrichment will place message numbers in the reports it generates, where messagenumYN is one of the following:
Y Message numbers appear in the report.
N Message numbers do not appear in the report.
If you do not use this switch, EngageOne™ Enrichment assumes S=Y.
-T=tracelevel Specifies the level of trace information to include in the EngageOne™ Enrichment Report, where tracelevel is one of the following:
I Includes an intermediate amount of trace information.
F Includes full trace information.
This switch is useful for troubleshooting, especially if there appear to be problems with EngageOne™ Enrichment output.
-U=varname=value Creates a user-defined variable, %%varname, and assigns to it the given value. For example,

-U=myvar=some_value

This would create a variable named %%myvar with a value of some_value.

You can define as many unique variables as you want but you can only specify each variable once.

Do not include the double percent (%%) when you define the variable name. EngageOne™ Enrichment will automatically add this.

The variable name cannot be a system, CASS, or presort variable.

The maximum total length of the variable name, second equal sign, and value is 129 characters.

Command line variables may be used as file names on all file tags, including <REJECTFILE>. Using command line variables for file names does not affect the behavior of DYNAFILE.

Note: The rule file may change the value of a command line variable used as a file name, but the changes will not affect the value used for the file. This is because the value used for the file is set when the control file is processed. Since the rule file is processed after the control file, it is too late to alter the file name.
-V Validates the control file for correct tagging and syntax, but does not process input or output files. This switch is useful for troubleshooting control files.
-W=maxRecordSize For Postscript only, specifies the maximum record size, in KB, of a record present in any input files. This should only be used if records greater than 32k are present in an input file.
-Y

On mainframe systems, prior to version 6.6.2, EngageOne™ Enrichment opened READ files as text files. This caused records read to have spaces truncated. Depending on how the file was allocated, carriage control bytes could have been interpreted rather than returned to the user. Currently, EngageOne™ Enrichment opens READ files as binary in order to return the true contents of the file.

Enabling this flag, will cause EngageOne™ Enrichment to open READ files as text files and process them as it did prior to version 6.6.2.
-Z For mainframe systems only, removes trailing spaces from records read by the READ function.