Parameters

The parameter element of the extraction profile is used to override the system defaults of a given extraction. All Transaction Server extraction processes come with a set of default values to use when extracting data. Refer to Table 1 for a list of extraction defaults. A parameterSet element with the parameters element can be used to override the default value for a particular extract. A parameterSet element can hold one or more parameter elements for overriding a default value and must be given a unique name.

One or more parameterSet elements can be configured within the parameters element for use with different extracts.

All parameter elements require a name attribute for identifying the parameter to override.

<extraction>
   <parameters>
      <parameterSet name="sample set of parameters">
         <parameter name="ftpRelativePath">incoming/</parameter>
         <parameter name="extractCommitRate">100</parameter>
         <parameter name="autoNotify">true</parameter>
      </parameterSet>

      <parameterSet name="another set of parameters">
         <parameter name="autoNotify">true</parameter>
      </parameterSet>
   </parameters>

   <profile>
      .
      .
      .
   </profile>
</extraction>

Table 1 shows the list of extraction parameters with their defaults.

Table 1. Extraction Parameters
Name	Values/ Example	Default	Description
ftpRelativePath	incoming	None	This path is the directory from where the transmission file is pulled with FTP (intermediatePath by default) and is relative to the home directory of the user ID performing the FTP. If the path is not specified, the absolute path is used as specified in the intermediatePath. This path must not contain blanks.
processedPath	../processed or c:\ITS\incoming\ processed	../processed	Directory where files are stored after they have been processed
errorPath	../error or c:\ITS\incoming\error	../error	Directory where files are copied when errors are detected
intermediatePath	../processing or c:\ITS\incoming\ processing	../processing	Directory where files are stored while they are being processed. Note: If you are not using the ftpRelativePath, this path (intermediatePath) must not contain blanks and must not be specified in the Universal Naming Convention (UNC) form of the file name; for example, \\serverName\share_name\path. The path is used to send the file to the host, and the FTP command cannot handle the \\servername syntax.
endOfFileExtension	.txe or .eof	.txe	The file extension to use when writing the file that signifies the TXS file is complete and ready for processing. The file extension should start with a period (.) and be followed by one or more valid file extension characters or unexpected results may occur.
extractCommitRate		1000	During the extraction process, this variable specifies the number of rows that can be extracted and updated before a database commit is issued. This prevents the extraction process from abnormally ending during large extractions because of database log buffer overruns.
sorterUserExit	com.ibm.icpcs.transactionserver.samples.cpcs.SampleSorterListUserExit	None	Fully-qualified Java™ class name of the server sorter list user exit. Used when `sorterSelection=SERVEREXIT`.
userStatusUpdateClass	com.ibm.icpcs.transactionserver.samples.cpcs.SimpleStatusUpdate	None	Fully-qualified Java class name of the user status update user exit. Allows the user to update status for file processing event.
userControlRecClass	com.ibm.icpcs.transactionserver.samples.cpcs.SampleUserControlRecord	None	Fully-qualified Java class name of the server user control record user exit. Allows the user to insert their own control documents in the transmission file.
sorterList	94, 95	None	List of sorter numbers used during extraction. Used when `sorterSelection=CONFIG`.
numTracers	20	0	The number of tracer documents to insert into the transmission file. Each tracer is assigned a unique ISN. The number of these tracers is limited to 9999. Note: If tracer records are inserted during ingestion, do not specify a number greater than zero for numTracers.
numDividers	5	0	The number of divider documents to insert into the transmission file. Dividers are inserted after any tracer documents and each divider is assigned a unique ISN. The number of these dividers is limited to 9999. Note: If tracer records are inserted during ingestion, do not specify a number greater than zero for numDividers.
TXSX937Exclude	26, 27, 28, 32, 33, 34, 35, 40, 41, 50, 52, 54, 55, 56, 61, 64, 68, 70, 75, 85, 90, 99	None	Identifies those records that should not be written to the transmission file. Specify the two-digit record types, separated by commas, that are to be omitted. This allows the user to omit records that are not used and, therefore, reduce the size of the transmission file. The 01, 10, 20, 25, and 31 record types may not be omitted.
sorterSelection	CONFIG or SERVEREXIT	CONFIG	Specifies the mode for obtaining the list of sorters. This keyword accepts only one of the parameters.
notificationMsgMode	blank or FILE or MQ	blank	Mode to use for transmitting the notification message. If this value is blank, a notification message is not generated. If the value is FILE, the notification message is placed in the folder specified by the notificationMsgPath keyword, with the same name as the incoming file, and with an extension equal to the value specified by the notificationMsgExt keyword. If the mode is MQ, the notification message is placed on the MQ queue manager and the queue defined in the MQ keywords. For these MQ keywords, see WebSphere® MQ (WMQ) Configuration Options.
numISNDigit	8	6	Identifies the maximum number of ISN digits to use for keeping track of the ISNs used for a particular day and sorter
entryNumberApplication	X937	None	If set, the Transaction Server entry number service application ID specified in this parameter is used to supply an entry number for the extraction. Note: When using this parameter to enable Transaction Server entry number generation, the four (4) character application ID specified for the entry number service must be found in the entryNumApplications Transaction Server configuration parameter. For more information about the entryNumApplications parameter, see Extraction properties.
txsFileCreate	false	false	If set to false, the extraction process does not create a CPCS TXS file.
isnGenerator	NONCPCS	NONCPCS	If set to NONCPCS, the item sequence numbers are generated using the ISN service.
versions	ALL or LAST	LAST	If ALL is specified, multiple versions of item data are included in the extract TXS file. These previous versions are written out with a record type class indicator of USR and a record type specifier of CTL. The document type field is filled in to indicate why the next version was created.
checkAllPresentmentsValid	true or false	false	If set to true, batches are extracted only from transmissions in which all of the batches are valid