filegateway.properties

The filegateway.properties file contains properties which control the operation of Sterling File Gateway.

The following table describes properties in the filegateway.properties file:

Important: Do not edit the filegateway.properties file. Make all changes in the customer_overrides.properties file. For example, to change the pgpCmdline2svcname property, enter the following line into customer_overrides.properties:

filegateway.pgpCmdline2svcname=CUSTOM

substituting CUSTOM with the name of your Command Line 2 adapter. See Using Property Files in the Sterling B2B Integrator 5.2 online library.

Property	Description
`ignoreFilename`x	Setting a regex pattern for this will cause any arrived file that matches your regex pattern to be ignored by Sterling File Gateway. This is useful for recognizing and ignoring temporary files sent by producers before they are renamed to the expected name. These will not be routed and are not considered failures. Specify one or more file name patterns to ignore in the following format: filegateway.ignoreFilename1=<regex expression> filegateway.ignoreFilename2=<regex expression> filegateway.ignoreFilename3=<regex expression> filegateway.ignoreFilenamex=<regex expression> For example: `filegateway.ignoreFilename1=.+[.]tmp$` would have the effect of ignoring all files with an extension of tmp. Note: The regex pattern must match the file name in its entirety. Partial matches are not recognized.
`ftpClientAdapterName`	The FTP Client Adapter instance or service group that the `FileGatewayDeliverFTP` business process will use. Override this property in customer_overrides.properties if a custom FTP Client Adapter instance must be used to contact trading partners. You can also specify an adapter group name to load-balance outbound FTP sessions across multiple adapter instances. Default is: `ftpClientAdapterName=FTPClientAdapter`
`bpCompletionProbes.1` `bpCompletionSleepMsec.1` `bpCompletionProbes.2` `bpCompletionSleepMsec.2`	Timeouts and sleep intervals that control how long Sterling File Gateway waits for every sub-business process it invokes. These control the timeouts when a business process is executed synchronously during routing. Used for consumer identification business processes and for PGP processing. Enables one set of relatively quick probes followed by a second set of slower probes. The first set will be very reactive, but consume more processor time. The second set will activate for longer-running processes and will consume less processor time. First probe 120 times with 100 Milliseconds between, for a total of 12 seconds. Default is: `bpCompletionProbes.1=120 and bpCompletionSleepMsec.1=100` Then probe 600 times with 2000 Milliseconds between, for a total of 1200 seconds (20 minutes). Default is: `bpCompletionProbes.2=600 and bpCompletionSleepMsec.2=2000`
`pgpCmdline2svcname`	The name of the Command Line 2 adapter to be used for PGP packaging and unpackaging. Override this property in customer_overrides.properties if a custom Command Line 2 adapter must be used for PGP operations. You can also specify an adapter group name to load-balance outbound PGP sessions across multiple adapter instances. Default is: `pgpCmdline2svcname=PGPCmdlineService`
`fgRoutePGPCmdLineSocketTimeout`	Timeout value, in milliseconds, for PGP package and unpackage operations invoked by Sterling File Gateway. Default value is 240000 milliseconds (4 minutes)
fgRouteConcurrentSessionLimit	Limits the number of File Gateway services that can be running concurrently. The services are split into two groups, and each group has this value as a limit. Therefore, there will be a maximum of two times the value of this property services running. It is best to set this somewhat (but not too much) higher than the number of business process threads in queues 4 and 6 (these are the queues where the File Gateway Services run.) The default is 8. To change this value, set: `filegateway.fgRouteConcurrentSessionLimit =(# of limit)`
`required_si_build_ver`	The build number (version) of Sterling B2B Integrator that Sterling File Gateway requires. This is checked at system start up. If the current version of Sterling B2B Integrator does not equal the `required_si_build_ver`, a warning is issued and the system is shut down. Required. Do not change or override this property.
`fgmaxBroadcastListSize`	Maximum allowed size of the consumer list used for broadcast. If the returned list of consumers exceeds this size, the file is not routed. By default, the maximum size of a broadcast list is set to 100.
`grantIntermediateMailboxPermissions`	Controls permissions granted to intermediate mailboxes (those between a partner user's virtual root and the leaf mailbox). These mailboxes are created during routing channel creation or dynamic routing. Setting this property to true grants View & Execute rights to the intermediate mailboxes to eligible partner users. View rights are required to list mailbox contents. Execute rights are required to ‘log in' to a mailbox. Setting both rights allows users of the FTP and SFTP protocol adapters to traverse through any intermediate mailboxes to reach the leaf. The default is false. For example: grantIntermediateMailboxPermissions=false
`extensionBPStatusIndicatorElement`= IgnoreThisFault	Use in conjunction with custom business processes that extend the capabilities of Sterling File Gateway, to override its default behavior when such a business process fails. Normally, a custom business process that encounters a fault causes processing of the associated file to fail. If extensionBPStatusIndicatorElement is set to IgnoreThisFault and the custom business process has created an element named IgnoreThisFault with value "true", Sterling File Gateway will disregard the fault and attempt to continue processing the arrived file or route. The value IgnoreThisFault is suggested for the element name value, but the value can be any string that is a legal element name in XML. By default, this property is not included in filegateway.properties. Use the following assignment in the custom business process to set the value of the Process Data element: `<assign name="Assign" to="IgnoreThisFault">true</assign>` See Handling Errors in Custom Business Processes for how to implement.
FileGatewaySendMessageExtractBP (Sterling File Gateway V2.2.5.0, interim fix 8 and higher)	This property allows you to run an arbitrary business process when the FileGatewaySendMessage system business process is run. Set `filegateway.FileGatewaySendMessageExtractBP=<arbitrary BP name>` The arbitrary business process specified in the property is then executed as part of the FileGatewaySendMessage system business process. Note: The arbitrary business process will be run inline irrespective of whether the route/delivery passes or fails.