XML processing control file for outgoing files

The following table contains the XML elements that are allowed in an XML processing control file for outgoing files. It also shows the default value for the element if it is not specified. For some elements, the default value might come from the Gateway configuration file. These elements are all specified under the outgoing element in the XML file.
Note: Some values are case-sensitive. Refer to the XML schema to ensure that the correct case is used.
Table 1. XML element table
XML element name Values or examples Default Description
routingMode
  • DTA
  • SA
  • FILE
  • FTP
  • CONNECT:DIRECT
 outRouteMode configuration value Allows the user to specify how files are transmitted. Outgoing files can be transmitted by the following methods:
  • A Distributed Traffic Agent (DTA)
  • A Shared Archive (for example, Viewpointe)
  • A file copy to another folder
  • File Transfer Protocol (FTP)
  • Connect:Direct®.
routingDir C:/RoutingDir outTargetPath configuration value If the routingMode is FILE, this value is the directory to which to copy the file.
transmitCMD x937copy.cmd blank The name of a Windows operating system command file used to transmit the outbound cash letter from the intermediate directory to the target. If a command file is not specified, Gateway determines how to transmit the file.
This sample command file is passed the following parameters:
  1. The fully qualified name of the source file.
  2. The fully qualified name of the target file.
The user can modify this command file to run extra processing steps before or after the copy. This element is only valid if the routingMode is FILE.
Note: When you modify the sample command file:
  • Do not remove the %1 and %2. These values are required for the copy to work.
  • Use the > NUL option to suppress the messages sent to the screen.
FTPaddress 127.0.0.1 outFTPServer configuration value If the routingMode is FTP, this value is the FTP server to which to connect.
FTPport 3209 outFTPPort configuration value If the routingMode is FTP, this value is the port on the FTP server to which to connect.
FTPpath ftpHome/myDir outTargetPath configuration value If the routingMode is FTP, this value is the path on the FTP server to which to copy the file. The destination path must be created before a file is routed by FTP.
FTPuserID Username outFTPUserId configuration value If the routingMode is FTP, this value is the username on the FTP server with which to connect.
FTPpassword password outFTPPassword configuration value If the routingMode is FTP, this value is the password on the FTP server with which to connect.
FileSizeWarning 1500000000 fileSizeWarning configuration value If the size of the outgoing file that is being built with images is larger than this amount but less than the FileSizeError element, a warning message is issued.
FileSizeError 2000000000 fileSizeError configuration value If the size of the outgoing file that is being built with images is larger than this amount, the file is sent into the error state and is not transmitted.
Type54Records Include, Exclude, ExcludeITS Include For more information, see Values for Inclusion and Exclusion of Record Types.
Type26Records Include, Exclude, ExcludeITS Include For more information, see Values for Inclusion and Exclusion of Record Types.
Type27Records Include, Exclude, ExcludeITS Include For more information, see Values for Inclusion and Exclusion of Record Types.
Type28Records Include, Exclude, ExcludeITS Include For more information, see Values for Inclusion and Exclusion of Record Types.
Type32Records Include, Exclude, ExcludeITS Include For more information, see Values for Inclusion and Exclusion of Record Types.
Type33Records Include, Exclude, ExcludeITS Include For more information, see Values for Inclusion and Exclusion of Record Types.
Type34Records Include, Exclude, ExcludeITS Include For more information, see Values for Inclusion and Exclusion of Record Types.
Type35Records Include, Exclude, ExcludeITS Include For more information, see Values for Inclusion and Exclusion of Record Types.
viewsToInclude FBW, BBW, FGS, BGS retrieveImgSegments configuration value Lists the image segments that need to always be included in the outbound file.
alternateViews FBW, BBW, FGS, BGS alternateImgSegments configuration value Lists the alternative image segments that need to be included in the outbound file if the corresponding primary segment is not available.
dupChkViews FBW, BBW, FGS, BGS blank List the image segments that need to be included in the check for duplicate image check. If the segment is listed here, it needs to also be listed in the viewsToInclude element.
viewValue FBW, BBW, FGS, or BGS none Abbreviation for the image view that is wanted. This element can occur multiple times if multiple views are wanted for an item. These values are used to create the list for viewsToInclude, alternateViews, and dupChkViews.
characterEncoding ASCII, EBCDIC EBCDIC Allows the user to specify the character encoding to use for the outbound file with images.
transmitIncomingFile YES, NO NO If set to YES, the incoming file (file without images) is transmitted by using the mechanism that is specified in the routingMode element.
addImages true, false true When set to true, images are added to outgoing files that do not already contain images.
localImageRetrieval true, false false Set this element to true if, and only if, the image file sets for the items that are being retrieved are on a drive accessible to the Gateway. When set to true, overall throughput is increased because the image data is not sent across the network.
retrieveAddenda FromITS true, false true Set this element to false if you do NOT want to include ANY addenda records from the Transaction Server in the outbound file.
missingImgPercent 10.0 outMissingImgPercent configuration value The percentage of items in the outbound file that can have missing images before the file goes into the error state.
mod4Type54RecTemplate C:/ftmCorpPayments/mod4_54rec.xml blank Contains the fully qualified path and file name of the XML template that is used to populate a type 54 record for every image that is created from an IBM® Model 004 camera. If a template is not specified, the type 54 record is created from the suspect data (if it is a suspect), or by calling IQA (if configured to do so).
updateItemDisposition true, false true Activates and deactivates the option to set the item disposition in the Transaction Server Payment Db2® table to Truncated for the type 25 records.
Note: If the state of the disposition flag is already set to Truncated, a warning message is displayed. The file continues to normal completion.
update25RecOrigMicr true, false false When set to true, this option causes the Gateway to populate the following fields in the Type 25 record with the data from the original MICR fields returned by the Transaction Server:
  • Amount
  • Routing number
  • On-Us
  • External Processing Code
  • Auxiliary On-Us
updateItemRecOrigMicr true, false false When set to true, this element causes Gateway to populate the following fields in the transaction (include type 25 and 31) record with the data from the original MICR fields that are returned by the Transaction Server:
  • Amount
  • Routing number
  • On-Us
  • External Processing Code
  • Auxiliary On-Us
This option can be overwritten by update25RecOrigMicr for the type 25 record.
origMicrUpdateInclude AMOUNT, ROUTING_NUMBER, ON_US, EXT_PROC_CODE, AUX_ON_US   When update25RecOrigMicr or updateItemRecOrigMicr is set to true, it causes the Gateway to populate the subsequent fields in the transaction (Type 25 or 31) record with the data from the original MICR fields that are returned by the Transaction Server. The default value is blank, which means all of the transaction record values are updated by the original MICR values except amount. For Type 31 records not in the X9.100-180 transmission, AUX_ON_US is applied to auxiliary on-us (Field 3) in the attached Type 33 record, if the Type 33 record exists.
match25RecAmount true, false false When set to true, Gateway matches amount in the Type 25 record with the data that is returned by the Transaction Server. If not matched, it is a missing item.
targetSuffix _imagesAdded _i Specifies a suffix to append to the outgoing file with images to differentiate it from the incoming file without images.
saveImageFile true, false false When set to true, the new outbound ICL file with the images added is saved after it is sent. The extension of the image file is changed to IBK and it is moved to the outProcessed folder with the processed outbound ICL file set.
convert2xAddendaTo3x true, false true Specifies whether the outbound files contain return items (type 31 records). Any type 2x records that are found in the database need to be converted to their type 3x record equivalent.
IQA enable true, false outIQAenable configuration value Specifies whether IQA needs to be run on the outbound file to generate a type 54 record.
profilename myIQAprofile outIQAProfileName configuration value Specifies the name of the IQA profile to use to start the IQA job for the file that is being processed.
views FBW, BBW outIQAViews configuration value Specifies the image views to run IQA against.
userParameters   blank Specifies any user control parameters to be passed to the IQA user exit for interpretation by the user exit.
docTypeMatrix   blank For more information, see Updating the Documentation Type and Record Type Fields.
sharedArchive   not applicable If the routingMode is set to SA, this element contains the parameters.
thruPointe true, false false The attribute of the sharedArchive element is used to control whether the outgoing file is sent in the ThruPointe Exchange model or not.
destinationID   blank The unique ID for the receiving point bank within the service delivery center. Refer to Outgoing shared archive file control summary.
cutoffInterval   blank Minutes until the cutoff. Used for ECP file to get file created time. Time is the current time to create the file plus cutoff interval. Refer to Outgoing shared archive file control summary.
forwardECPExtension   blank Forwarded ECP file extension. This value is used for only ECP and ECPX files. For ECPR files, omit this element. Refer to Outgoing shared archive file control summary.
taskName   blank Task name to use in messages for ECPI file transmissions. This element applies to ECPI files only. Valid task name values are SENDLD and RECVLD. RECVLD indicates a Pointe2Pointe ECPI transmit and SENDLD an ImageShare ECPI load. When this element is omitted, it defaults to SENDLD. Refer to Outgoing shared archive file control summary.
forInternalExchange Yes, No No Set to yes if, and only if, the DAT file is intended for internal exchange. For example, the x9.37 / x9.100 DAT file that is generated by the Gateway outbound process (typically at regional processing center), is later captured by the Gateway inbound process (typically at virtual processing center) in the same organization. This way, the inbound file is not counted for fee charging.

When the element is set to yes, a SIG file is generated in addition to the outbound DAT and EOF files. The file needs to be moved with the DAT and EOF files, as a group, to the Virtual Processing Center Gateway Inbound Process Source folder to avoid fee charging.
isResend Yes, No No Indicates whether the file set is a resend file set. For inbound processing, the duplicate databases are still loaded (in case this is the first instance received), but no duplicate failures are reported. For outbound processing, this value is set if a file set is resent from the Gateway.
fileReaderClassName     The full class name of the file reader used to parse the file.
fileExtension     The file extension of the data file in the file set. Do not specify the dot.
fileTypeId     The transmission type ID, which should match the transmission type ID in the FILE_TYPE table. If Gateway cannot find the transmission type ID in the file, the trackable service uses the value that is specified in this element to find the trackable record.
partner     The receiving point routing number of the file, which the trackable service uses to match trackable record.
ConnectDirectHost CDREMOTEHOST outConnectDirectHost configuration value If the routingMode is CONNECT:DIRECT, this value is the name of the remote Connect:Direct node.
ConnectDirectConfig C:\CDDEF.BIN outConnectDirectConfig configuration value If the routingMode is CONNECT:DIRECT, this value is the fully qualified path and file name of the node definition file for the local Connect:Direct node.
ConnectDirectUserId REMOTEID outConnectDirectUserId configuration value If the routingMode is CONNECT:DIRECT, this value is the user ID used to access the remote Connect:Direct node.
ConnectDirectPassword REMOTEPW outConnectDirectPassword configuration value If the routingMode is CONNECT:DIRECT, this value is the password that is used to access the remote Connect:Direct node.

Outgoing shared archive file control summary

The following example is a sample processing control file that shows shared archive control.
<?xml version="1.0" encoding="UTF-8"?>
<destinations>
  <destRouting>
    <icpcsRouting>
      <outgoing>
        <routingMode>SA</routingMode>
        <sharedArchive>
          <destinationID>BAC</destinationID>
          <cutoffInterval>30</cutoffInterval>
          <taskName>RECVLD</taskName>
        </sharedArchive>
      </outgoing>
      <incoming>
        <fileRouteMode type="PROCESS"/>
      </incoming>
    </icpcsRouting>
  </destRouting>
</destinations>