General properties
| Keyword | Values or example | Description |
|---|---|---|
| fileKeepDays | 10 | Number of days to keep processed X9.37 files and transmissions in the eodComplete directory. Based on the date, files are saved to disk and are filed by the current date. |
| userControlRecClass | com.ibm.icpcs.gatewayserver.samples.SampleUpdateItemAddenda |
Fully qualified Java™ class name of the server user control record user exit. You can use the user exit to insert your own control documents in the transmission before it is sent to the host. For more information about the user exit, see User control record user exit. |
| maxFileThreads | 1 | The number of threads used to process incoming transmissions. Do not set this value higher than the number of processors on the server that is running the code. If it is set to zero, incoming transmission processing is turned off. |
| inFileQueueSize | 1 - 100 | Incoming transmission queue size. For instances of Gateway Server that use the same source folder, don't set this value to be more than the value of maxFileThreads for large transmissions and twice the maxFileThreads value for the small transmissions. |
| maxUpdateThreads | 1 | Number of threads used to process incoming update transmissions. |
| inUpdateQueueSize | 1 - 100 | Incoming update transmission queue size. For instances of Gateway Server that use the same source folder, don't set this value to be more than the value of maxUpdateThreads for large transmissions and twice the maxUpdateThreads value for the small transmissions. |
| failOnValidationWarn | true or false | If set to true, the Gateway Server does not process any transmissions that have validation warnings. Validation warnings are generated for things like bundle, batch (ICL), or transmission totals that don't match the actual values that are found in the transmission. If this value is false, validation warnings are generated, but processing of the transmission continues. |
| micrFilename | ..\\properties\\irec.ctl | Fully qualified path and name of the MICR definition file name. Field length information is requested from this file. |
| micrFilenameUserClass | com.ibm.icpcs.gatewayserver.samples.SampleMICRDefinitionFilename |
Fully qualified Java class name of the server user exit that is used to determine which MICR definition file to use. You can use the user exit to specify a different MICR definition for the different transmissions that are being processed. |
| userStatusUpdateClass | com.ibm.icpcs.gatewayserver.samples.status.UserStatusUpdate |
Fully qualified Java class name of the user status update user exit. You can use the user exit to update status for the transmission processing event. |
| userFileLevelClass | com.ibm.icpcs.gatewayserver.samples.SampleFileLevelCalls |
Fully qualified Java class name of the user exit for setting transmission level properties. You can use the user exit to change the name that is used to send outgoing transmissions. For more information, see Transmission Level Calls user exit. |
| userItemLevelClass | com.ibm.icpcs.gatewayserver.samples.SampleItemLevelFields |
Fully qualified Java class name of the user exit for setting transaction level fields. You can use the user exit to set transaction level flags such as the clearing channel. For more information, see Transaction Level Fields user exit. |
| presentmentAttributeClass |
|
|
| userFileAttributeClass | com.ibm.icpcs.gatewayserver.samples.SampleIncomingFileAttributes |
Fully qualified Java class name of the user exit for setting transmission level fields. You can use the user exit to update the incoming transmission attributes. For more information, see Incoming Transmission Attributes user exit. |
| ClearingAttributesClass | com.ibm.icpcs.gatewayserver.samples.SampleClearingAttributes |
Fully qualified Java class name of the clearing attributes user exit. When the user exit is not specified, the Gateway Server uses the Business Rules workflow that is specified in the ClearingAttributesBusinessRulesWorkflow property to obtain the clearing attributes. For more information, see Business Rules Integration and Clearing Attributes user exit. |
| paperPresentedReturnsValid | true, false | When set to true, the Gateway Server considers return transactions that were
forwarded as paper or were electronically truncated to be valid. When set to false, the Gateway Server generates validation warnings for return transactions that were not electronically
truncated. The Gateway Server determines whether a transaction was electronically truncated or presented as paper by looking in the Transaction Server. The Gateway Server does this validation only when connectivity to the Transaction Server is enabled. For example, when ITSenable is set to true. To cause validation warnings to stop processing a transmission with return transactions, set failOnValidationWarn to true. The default value is true. |
| controlPartnerRoutingNumber | fileHeader, cashLetter1 | When set to cashLetter1, Gateway Server gets the routing number (sending point
routing number for incoming transmissions and receiving point routing number for outgoing transmissions) from
the first type 10 record. Otherwise, Gateway Server gets the routing number from the type 01
record. The default value is fileHeader. |
| recoverThreadInterval | 300 - 36000 | The Gateway Server checks the status of all monitored threads every
nnn seconds. The default thread recovery interval is 36000 seconds and the recommended thread recovery interval is 1200 seconds. |
| recoverMaxRetry | 1 - 999 | The maximum number of times the Gateway Server attempts to recover a thread it detects as hung. |
| ciffMicrMapTable | ..\\properties\\ciffFieldMap.TBL | Fully qualified path and name of the table that maps CIFF item index fields into MICR fields. |
| enablePayDirRecvTimeStamp | true, false | When set to true, Gateway Server adds “PayDirRecvTimeStamp" to the RTE file
for those transmissions retrieved from the following channels.
The default value is true. |
| itemMaxProcessingTime | 300 | The maximum amount of time, in seconds, that Gateway waits for an
individual transaction to be processed. If this time is exceeded, Gateway logs messages with
the amount of processing time that was spent in the following areas to help determine the cause of the problem.
After it reports the error, Gateway attempts to restart the threads that are hung. |
| userInsertItemClass | com.ibm.icpcs.gatewayserver.samples.status.SampleUserInsertItem |
Fully qualified Java class name of the user insert item user exit that you can use to insert normalized transactions into the transmission. |
| fileMovingInterval | 100 | The amount of time, in milliseconds, that Gateway Server waits before it
retries a file move that failed. The default value is 100 milliseconds. |
| fileMovingRetries | 5 | The maximum number of times Gateway Server attempts to move a file between the
processing folders. Gateway moves a file by renaming it. However, on the last try, it opens
the file, copies it, and deletes the original. Valid values are 1 - 30. The default is 5. |
| clearfsEnable | false, true | Setting this value to true allows the console operator to clear the work in progress data from the database tables. If this parameter is not specified, the default is to not allow the clearfs command to be entered. |
| filePollingInterval | 5000 | The number of milliseconds that a Gateway Server file processor waits when polling the Gateway source folder for work. |
| monitorInterval | 0 - 600 | Number of minutes that the Gateway Server monitor service collects performance
data before the data is written to the database. The default value is 1 minute, which writes data to the database every minute. |
| alertMonitorIntervals | 1 - 99 | The number of alert monitor intervals for which the Gateway Server collects
performance data before the collected data is analyzed to determine whether alerts are logged. The limits are
tested at the end of each monitor interval. The alert is generated when the limit is exceeded in all of the
recent monitor intervals. The default value is 3. |
| inSourceMonitor | true, false | When this value is true, the Gateway Server monitors the number of
transmissions in the inbound source folder and saves the number in the Gateway ingestion
performance monitor data. If multiple instances of Gateway Server use the same inbound source
folder, set this value to true for only one Gateway Server to prevent the number of inbound
transmissions from being counted multiple times. The default value is true. |
| outSourceMonitor | true, false | When this value is true, the Gateway Server monitors the number of
transmissions in the outbound source folder and saves the number in the Gateway outbound
performance monitor data. If multiple instances of Gateway Server use the same outbound source
folder, set this value to true for only one Gateway Server to prevent the number of outbound
transmissions from being counted multiple times. The default value is true. |
| defaultIclStandardLevel | unknown, 03, 13, 20, 30, 103 | Set the image cash letter file default standard level and process the transmission as the
specified file format:
|
| defaultIclFileType | ICL, ICLR, ECP, ECPD, ECPI | Set the default image cash letter transmission type. The default value is ICL. |
| rejectIntelFormatFiles | true, false | Indicates whether transmissions in the Intel, or
little endian, format are allowed. When set to true, the transmissions are rejected and sent to the error
folder. For more information about using this parameter, see the X9.37 ANSI
standard, Annex F.
The default value for this parameter is false. |
| autoPauseInbound | 25 | The number of consecutive, inbound transmissions that can fail before auto-pause stops
Gateway transmission processing. Use this parameter to prevent large numbers of transmissions
from being placed in the error folder and needing to be manually restarted. The default value is 25. Valid values are 0 - 999999. Use 0 to disable auto-pause. |
| autoPauseOutbound | 25 | The number of consecutive, outbound transmissions that can fail before auto-pause stops
Gateway transmission processing. Use this parameter to prevent large numbers of transmissions
from being placed in the error folder and needing to be manually restarted. The default value is 25. Valid values are 0 - 999999. Use 0 to disable auto-pause. |
| autoSetOutboundReady | true, false | When this value is true, Gateway automatically sets the Distribution Outbound_Ready flag to on. Setting the flag to on results in good work not being held over
when the PresentmentReady event does not run. For more information about PaymentReadyEventHandler, see
Distribution User's Guide. The default value is false. |
| unparsedFileErrorCode | IMA0026 | Defines the error code that is used when an unparsed transmission is loaded into the
Transaction Server (file header (01) record can be parsed). Note: This error code must exist in the
ERROR_CODES table or an exception is received.
The default value is IMA0026. |
| errorOutUnparsedFiles | true, false | Controls whether an unparsed inbound transmission produces an error or is processed and
marked as rejected. Setting this parameter to true causes unparsed inbound transmissions to produce errors
instead of being processed. The default value is false. |
| restartRefreshInterval | 5000 | The amount of time, in milliseconds, that Gateway waits when polling for transmissions that are ready to restart. |
| maxWaitTime | 1800000 | When this property is set, it overrides the default timeout for Gateway. Use a smaller value to force a shutdown. Because normal processing might take a minute or two to complete, be careful not to set this value too low. |
| enableSignalHandler | false | Set this property to true for AIX® and Linux®. |
| invalidEofPadErrorCode | IMA0031 | Specify an existing error code to use when an invalid number of EOF pad records are found.
If the specified error code does not exist, it causes an error to occur. The default value for this parameter is IMA0031. |
| invalidBlockCountErrorCode | IMA0032 | Specify an existing error code to use when an invalid number of block records are found. If
the specified error code does not exist, it causes a configuration error to occur. If this error condition occurs when a transmission is loaded and you did not specify an error code in this property, loading stops for the transmission and it is not processed. If this error condition occurs and you did specify an error code in this property, Gateway Server ignores the overridable setting that you configured for your error code. It always rejects the transmission and treats the error code as nonoverrideable. The default value for this parameter is IMA0032. |
| invalidRecordLengthErrorCode | IMA0033 | Specify an existing error code to use when the record length is invalid. If the specified
error code does not exist, it causes an error to occur. The default value for this parameter is IMA0033. |
| missingControlTotalErrorCode | IMA0035 | Specify an existing error code to use when the control total file for the inbound
transmission is not found. The default value for this parameter is IMA0035. |
| missingBatchHeaderErrorCode | IMA0036 | Specify an existing error code to use when the batch header record is missing for the
corresponding batch control record. The variable ACTUAL contains the trace number of first entry in this batch
(ICL). If this error condition occurs when a transmission is loaded and you did not specify an error code in this property, loading stops for the transmission and it is not processed. If this error condition occurs and you did specify an error code in this property, Gateway Server ignores the overridable setting that you configured for your error code. It always rejects the transmission and treats the error code as nonoverrideable. |
| missingBatchControlErrorCode | IMA0037 | Specify an existing error code to use when the batch control record is missing for the
corresponding batch header record. The variable ACTUAL contains the value of BATCH_SEQ_NUM. If this error condition occurs when a transmission is loaded and you did not specify an error code in this property, loading stops for the transmission and it is not processed. If this error condition occurs and you did specify an error code in this property, Gateway Server ignores the overridable setting that you configured for your error code. It always rejects the transmission and treats the error code as nonoverrideable. |
| maxInvalidRecordCountAllowed | 10 | The maximum number of consecutive bad record types that can be read before the processing
of the ACH transmission is stopped. To limit the problems that are caused by bad record types, especially for large transmissions, the ACH file reader monitors the number of consecutive bad record types that are read. After this number of consecutive records with bad record types are read from the ACH transmission, the ACH file reader stops processing the transmission. The records with bad record types are assigned the error code that is configured in the invalidRecordTypeErrorCode property. Set this property to 0 to disable checking for consecutive bad records. The default value is 10. |
| invalidRecordTypeErrorCode | IMA0038 | Specify an existing error code to use when an invalid record type is found in the
transmission. The invalid record types are 2, 3, and 4. If this error condition occurs when a transmission is loaded and you did not specify an error code in this property, loading stops for the transmission and it is not processed. If this error condition occurs and you did specify an error code in this property, Gateway Server ignores the overridable setting that you configured for your error code. It always rejects the transmission and treats the error code as nonoverrideable. |
| missingFileControlErrorCode | IMA0053 | Specify an existing error code to use when record type 9 is missing in the transmission. If this error condition occurs when a transmission is loaded and you did not specify an error code in this property, loading stops for the transmission and it is not processed. If this error condition occurs and you did specify an error code in this property, Gateway Server ignores the overridable setting that you configured for your error code. It always rejects the transmission and treats the error code as nonoverrideable. |
| incompleteBlockingErrorCode | IMA0054 | Specify an existing error code to use when the transmission is not properly divided into
blocks of 10 records. It is assigned only when a file control record is present in the transmission. If this error condition occurs when a transmission is loaded and you did not specify an error code in this property, loading stops for the transmission and it is not processed. If this error condition occurs and you did specify an error code in this property, Gateway Server ignores the overridable setting that you configured for your error code. It always rejects the transmission and treats the error code as nonoverrideable. |
| clearingAttributeThreads | 8 | The number of threads to use to get the clearing attributes for a batch (ICL) record. Use
this property to increase the throughput for assigning clearing attributes to batches (ICLs) during
transmission processing. A value of one assigns the clearing attributes for a batch (ICL) one at a time. A
value of five processes and assigns the clearing attributes for up to five batches (ICLs) concurrently. The default value is 5. |
| clearingAttributeMaxWaitTime | 7000000 | The amount of time, in milliseconds, that the transmission reader waits for the clearing
attributes to be assigned to all of the batches (ICLs) in the transmission before it times out. Choose the
timeout value to use based on your expected batch (ICL) volume. The default value is 6000000 milliseconds, which is 100 minutes. |
| webServiceAPIApprovalRejectErrorCode | TCH0001RJC | The validation error code that the FTM file reader assigns to a web service initiated The Clearing House (TCH) transaction when it is rejected by the approval officer. Examples of these transactions are Initiate Credit Transfer or Request for Payment. The default error code, TCH0001RJC, is used if an error code is not specified. |
| fileDupCheck | <blank>, true, false |
Controls Gateway Server file duplicate detection.
|
| fileDupErrorCode | IMA0008 | When fileDupCheck is set to true, then duplicate files are assigned with fileDupErrorCode. |
| mqGatewayEngineQueue | FXH.GATEWAY.INPUT.QUEUE | The Gateway server sends a control total notification process message to the Gateway engine queue, and the engine processes this message to trigger the alert notification services framework task. |