Agent yfs.properties

Use the customer_overrides.properties file to override properties in the Agent category of yfs.properties.

The following table contains the Agent yfs.properties and descriptions.

Property Values Description
Agent
yfs.agent.override.providerurl Default is not set. AgentServer Override for provider url: set the property to the provider URL which will be used by ALL Agent servers. This property does not impact integration servers configured in the service builder. This property overrides the url configured for time triggered transactions in config.

Example for WebLogic:

yfs.agent.override.providerurl=t3://<host>:<port>

Example for WebSphere®:

yfs.agent.override.providerurl=corbaloc::<host>:<boostrapport>

Example for ActiveMQ:

yfs.agent.override.providerurl=tcp://<host>:<port>

yfs.agent.override.icf Default is not set. AgentServer Override for InitialContextFactory Name: set the property to the InitialContextFactory Name which will be used by ALL Agent servers. This property does not impact integration servers configured in the service builder. This property overrides the InitialContextFactory configured for time triggered transactions in config.

Example for WebSphere:

yfs.agent.override.icf=com.ibm.websphere.naming.WsnInitialContextFactory

Example for WebLogic:

yfs.agent.override.icf=weblogic.jndi.WLInitialContextFactory

Example for ActiveMQ:

yfs.agent.override.icf=org.apache.activemq.jndi.ActiveMQInitialContextFactory

yfs.agent.override.qcf Default is not set. AgentServer Override for QueueConnectionFactory Name: set the property to the QueueConnectionFactory Name which will be used by ALL Agent servers. This property does not impact integration servers configured in the service builder. This property overrides the QueueConnectionFactory configured for time triggered transactions in config.

Example:

yfs.agent.override.qcf=<QueueConnectionFactory Name>

yfs.agent.override.retryCount Default is not set. AgentServer Override for RetryCount: set the property to the JMS RetryCount to be used by ALL Agent Servers. This property does not impact integration servers configured in the service builder.

Example:

yfs.agent.override.retryCount=<Number of Retries>

yfs.agent.override.retryInterval Default is not set. AgentServer Override for RetryInterval: set the property to the JMS RetryInterval to be used by ALL Agent Servers. This property does not impact integration servers configured in the service builder. This interval is specified in milliseconds.

Example:

yfs.agent.override.retryInterval=<RetryInterval in Milliseconds>

yfs.agent.backup.providerurl Default is not set. AgentServer Backup for JMS. Set these three properties to the JMSprovider URL InitialContextFactory Name and QueueConnectionFactory Name which will be used by ALL Agent servers as a Backup if the primary JMSServer becomes unavailable, the QueueName used by the Agent Server on the backup JMSServer will be the same as the one configured on the primary JMSServer.

These properties will be used only after a successful start of the Agent Server using the primary JMSServer configuration. If the AgentServer Override properties are specified, they are used as the primary JMSServer properties. The backup JMSServer will be used by the Agent Server only if all three properties are specified.

These properties do not impact integration servers configured in the service builder.

Examples for WebSphere:

yfs.agent.backup.providerurl=corbaloc::<host>:<boostrapport>

yfs.agent.backup.icf=com.ibm.websphere.naming.WsnInitialContextFactory

Examples for WebLogic:

yfs.agent.backup.providerurl=t3://<host>:<port>

yfs.agent.backup.icf=weblogic.jndi.WLInitialContextFactory

Example for ActiveMQ:

yfs.agent.backup.providerurl=tcp://<host>:<port>

yfs.agent.backup.icf=org.apache.activemq.jndi.ActiveMQInitialContextFactory

yfs.agent.backup.icf Default is not set.
yfs.agent.backup.qcf Default is not set.
yfs.agent.backup.retryCount Default = 0 Number of times to retry a failed JMS connection

Example: yfs.agent.backup.retryCount=3

yfs.agent.backup.retryInterval Default = 0 Number of milliseconds to wait between retries

Example: yfs.agent.backup.retryInterval=3

yfs.agent.override.auth.enabled Valid values = Y or N The agent override for the JMS Security parameter values specified in the Agent criteria. If set to Y, you must also include values for the following two properties (userid and password).

Example:

yfs.agent.override.auth.enabled=Y

yfs.agent.override.auth.userid

yfs.agent.override.auth.password

Default is not set. If yfs.agent.override.auth.enabled is set to Y, these properties (userid and password) must be present, otherwise an error is thrown.
yfs.agentserver.queryTimeout   Set this property to specify the Query Time out for Agents. This is the global property applicable for all agents.

It is possible for individual agents to override this property by specifying their own query timeouts. For example, the User Activity Audit Purge Agent can specify a property such as USERACTAUDITPRG.queryTimeout. This will override this global property. Set to zero means unlimited.

Example:

yfs.agentserver.queryTimeout=

yfs.agent.bulk.sender.enabled Default = False If yfs.agent.bulk.sender.enabled is set to True, the JMS messages are put in the internal JMS queue in batches. All the messages received from the 'getJobs' method are divided into batches and each batch is sent to the JMS Queue, using a single JMS connection or session. This improves the performance of the agent server.
Note: If a user enables the session pooling (by setting the property yfs.jms.session.disable.pooling=N), the sessions will be reused among different batches. Otherwise, a new session will be created for each batch of the messages.

Example:

yfs.agent.bulk.sender.enabled=False

yfs.agent.bulk.sender.batch.size Default = 1 This property will determine the batch size, the number of messages to be sent to the JMS queue using the same QueueSender object. The optimum value of the property may vary between different JMS vendors.

Example:

yfs.agent.bulk.sender.batch.size=1

yfs.ChangeDataPublisherExportDirectory <full path to export dir> Export directory where the changes are published and must be the same folder as the one specified in the customer_overrides.properties file. This property must be set in the customer_overrides.properties file before the Change Data Export agent is run.

Example:

yfs.ChangeDataPublisherExportDirectory=<full path of export directory>

yfs.ChangeDataPublisherWorkingDirectory <full path to working dir> Working directory for the Change Data Export agent, which may or may not be the same as the export directory. This property must be set in the customer_overrides.properties file before the Change Data Export agent is run.

Example:

yfs.ChangeDataPublisherWorkingDirectory=<full path of working directory>

yfs.ChangeDataPublisherCompletionDirectory <full path to completion dir> Completion directory for the Change Data Export agent, which may or may not be the same as the export directory. This property must be set in the customer_overrides.properties file before the Change Data Export agent is run.

Example:

yfs.ChangeDataPublisherCompletionDirectory=<full path of completion directory>

yfs.ChangeDataPublisherFilePrefix Default is not set. Specify any prefix in the customer_overrides.properties.file before the Change Data Export agent is run.
yfs.ChangeDataImportDirectory <full path to import dir> Import directory from which the ChangeDataImport agent will find the files to import. This property must be set in the customer_overrides.properties file before the ChangeDataImport agent is run.

Example:

yfs.ChangeDataImportDirectory=<full path of import directory>

yfs.changeImport.sleepCount Default = 60000 milliseconds Determines how long the Import agent will sleep before checking again that all threads operating on a zip file have completed.

Example:

yfs.changeImport.sleepCount=60000

yfs.changeImport.maxRetryCount Default = 30 Determines how many times the Import agent will check for all threads to complete before raising a failure event.

Example:

yfs.changeImport.maxRetryCount=30

The value can be small when running the agent with a single thread. When running the agent in a multi-threaded environment, increase the value to accommodate the size of the data being processed.

yfs.changeExport.maxRetryCount Default = 30 Determines how many times the Export agent will check for all threads to complete before raising a failure event.

Example:

yfs.changeExport.maxRetryCount=30

The value can be small when running the agent with a single thread. When running the agent in a multi-threaded environment, increase the value to accommodate the size of the data being processed.

Note: The sleep interval between the Export agent retries is the Zip Retry Interval criteria in the Change Data Export Agent.
yfs.skip.boStatus.records Default =
false
If this property is set to true, then the Enhanced Order Monitor Agent ignores the orders in the "Backordered from Node" status.

For example, yfs.skip.boStatus.records=true