Administration Console Online Help

Store-and-Forward Agents: Configuration: General

Configuration Options     Advanced Configuration Options     Related Tasks     Related Topics

Use this page to define basic and advanced general property values for a SAF sending or receiving agent.

Configuration Options

Name	Description
Name	The name of this Store-and-Forward agent. MBean Attribute: WebLogicMBean.Name Changes take effect after you redeploy the module or restart the server.
Persistent Store	The persistent disk-based file store or JDBC-accessible database for the SAF agent. If a store is not configured, the server's default store is used. If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted). MBean Attribute: SAFAgentMBean.Store Changes take effect after you redeploy the module or restart the server.
Agent Type	The type of service that this SAF agent provides. JMS requires only a Sending agent on the sending side for messages. Whereas, Web Services Reliable Messaging requires both a Sending and Receiving agent for messages. Sending-only Configures an agent that stores messages in persistent storage, forwards messages to the receiving side, and re-transmits messages when acknowledgements do not come back in time. Receiving-only Configures an agent that detects and eliminates duplicate messages sent by a receiving agent, and delivers messages to the final destination. Both Configures an agent that has sending and receiving agent functionality. If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted). MBean Attribute: SAFAgentMBean.ServiceType Changes take effect after you redeploy the module or restart the server.
Conversation Idle Time Maximum	The maximum amount of time allowed, in milliseconds, before a sending side releases the resources used by a conversation. If there is no activity for a conversation for the specified amount of time, the sending agent releases all resources for that conversation and notifies the receiving agent to do the same. A value of 0 specifies that resources for a conversation are not released unless the application explicitly closes the conversation. Updating ConversationIdleTimeMaximum causes connections starting after the update to use the new value. MBean Attribute: SAFAgentMBean.ConversationIdleTimeMaximum Minimum value: 0

Advanced Configuration Options

Name	Description
Message Compression Options	Specifies the type of message compression used when JMS message body compression is enabled for Persistent Stores and JMS Paging Stores. Use GZIP_DEFAULT_COMPRESSION to enable message compression using the JDK GZIP API with DEFAULT_COMPRESSION level. Use GZIP_BEST_COMPRESSION to enable message compression using the JDK GZIP API with BEST_COMPRESSION level. Use GZIP_BEST_SPEED to enable message compression using the JDK GZIP API with BEST_SPEED level. Use LZF to enable message compression using Open Source LZF. MBean Attribute: SAFAgentMBean.MessageCompressionOptions
Store Message Compression Enabled	Enables the JMS store to perform message body compression. When set to false, the default value, no compression is performed. MBean Attribute: SAFAgentMBean.StoreMessageCompressionEnabled
Paging Message Compression Enabled	Enables the JMS paging store to perform message body compression on persistent and non-persistent messages. When false, the default value, no compression is performed. MBean Attribute: SAFAgentMBean.PagingMessageCompressionEnabled
Retry Delay Base	The amount of time, in milliseconds, between the original delivery attempt and the first retry. If RetryDelayMultiplier is set to 1, this defines the interval between any two successive retry attempts. Applies only to agents with sending capability. Updating DefaultRetryDelayBase causes connections starting after the update to use the new value. Range of Values: <= RetryDelayMaximum if RetryDelayMultiplier is not 1.0. MBean Attribute: SAFAgentMBean.DefaultRetryDelayBase Minimum value: 1
Retry Delay Maximum	The maximum amount of time, in milliseconds, between two successive delivery retry attempts. Applies only to agents with sending capability. Updating DefaultRetryDelayMaximum causes connections starting after the update to use the new value. Range of Values: > = RetryDelayBase if RetryDelayMultiplier is not 1.0. MBean Attribute: SAFAgentMBean.DefaultRetryDelayMaximum Minimum value: 1
Retry Delay Multiplier	The factor used to multiply the previous delay time to calculate the next delay time to be used. Applies only to agents with sending capability. Updating DefaultRetryDelayMuliplier causes connections starting after the update to use the new value. Range of Values: >= 1. MBean Attribute: SAFAgentMBean.DefaultRetryDelayMultiplier Minimum value: 1.0
Logging Enabled	Specifies whether a message is logged in the server log file when a message fails to be forwarded. If selected, this applies to messages that fail to be forwarded and delivered to the final destination when there is no error handling in a SAF application or the application's error handling fails. Applies only to agents with receiving capability. Updating LoggingEnabled causes connections starting after the update to use the new value. MBean Attribute: SAFAgentMBean.LoggingEnabled
Time-To-Live	The default amount of time, in milliseconds, that the agent guarantees to reliably send messages. A value of 0 means the agent guarantees to reliably send messages for the duration of the conversation. Updating DefaultTimeToLive causes conversations starting after the update to use the new value. MBean Attribute: SAFAgentMBean.DefaultTimeToLive Minimum value: 0
Window Interval	The maximum amount of time, in milliseconds, that a JMS sending agent waits before forwarding messages in a single batch. For a distributed queue or topic, WindowInterval setting is ignored. A sending agent waits to forward the message batch until either: (A) the source destination message count is greater than or equal to the configured Window Size; (B) it has waited a specified Window Interval, whichever comes first. MBean Attribute: SAFAgentMBean.WindowInterval Minimum value: 0
Paging Directory	Specifies where message bodies are written when the size of the message bodies in the JMS server exceeds the message buffer size. If unspecified, messages are written to the tmp directory in the host WebLogic Server instance's directory. For example, domainName/servers/servername/tmp. For best performance, this directory should not be the same as the directory used by the SAF agent's persistent store. Applies only to agents with sending capability. If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted). MBean Attribute: SAFAgentMBean.PagingDirectory Changes take effect after you redeploy the module or restart the server.
Message Buffer Size	The amount of memory used to store message bodies in memory before they are paged out to disk. A value of -1 (the default) specifies that the server will automatically determine a size based on the maximum heap size of the JVM. This default will be set to either one-third the maximum heap size, or 512 megabytes, whichever is smaller. The larger the buffer, the more memory JMS will consume when many messages are waiting on queues or topics. Once the buffer is surpassed, JMS may write message bodies to the directory specified by PagingDirectory in an effort to reduce memory usage below this buffer. Surpassing the buffer size does not stop the JMS server from accepting new messages. It is still possible to run out of memory if messages are arriving faster than they can be written to disk. Users with high messaging loads who wish to support the highest possible availability should consider setting a quota or setting a threshold and enabling flow control. Applies only to agents with sending capability. Paging is always supported. Updating the memory size resets the message count so that only requests arriving after the update are charged against the new memory size. MBean Attribute: SAFAgentMBean.MessageBufferSize Minimum value: -1
Pause Incoming Messages At Startup	Specifies whether the agent is paused for incoming messages at startup time. When enabled, the sending agent accepts new messages. Otherwise, the sending agent does not accept any new messages. If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted). MBean Attribute: SAFAgentMBean.IncomingPausedAtStartup Changes take effect after you redeploy the module or restart the server.
Pause Forwarding Messages At Startup	Specifies whether the agent is paused for forwarding messages at the startup time. When enabled, the sending agent forwards messages. Otherwise, the sending agent does not forward any messages. If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted). MBean Attribute: SAFAgentMBean.ForwardingPausedAtStartup Changes take effect after you redeploy the module or restart the server.
Window Size	For JMS messages, the number of messages in a batch. A sending agent waits to forward a message batch until the source destination message count is greater than or equal to this value. For a distributed queue or topic, WindowSize setting is ignored and always internally set to 1 message. For WSRM, the maximum number of unacknowledged messages allowed between a source destination and a target destination during a conversation. MBean Attribute: SAFAgentMBean.WindowSize Minimum value: 1
Acknowledge Interval	The maximum interval between two successive acknowledgements sent by the receiving side. Applies only to agents with receiving capability. A value of -1 specifies that there is no time limit between successive acknowledgement. Updating AcknowlegeInterval causes connections starting after the update to use the new value. MBean Attribute: SAFAgentMBean.AcknowledgeInterval
Pause Receiving Messages At Startup	Specifies whether the agent is paused for receiving messages at the startup time. When enabled, the sending agent receives messages. Otherwise, the sending agent does not receive any messages. If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted). MBean Attribute: SAFAgentMBean.ReceivingPausedAtStartup Changes take effect after you redeploy the module or restart the server.

Related Tasks

• Configure SAF agent general properties

Related Topics

• Administering the Store-and-Forward Service for Oracle WebLogic Server