RED-Specific Parameters

The RED-specific Parameters table lists the specific and advanced parameters for the Substation ES interface for RED. You can change the values of these parameters only if you are knowledgeable about the system or if you are assisted by a Substation ES representative.

RED-Specific Parameters
Parameter Description
ADM-NAME = {REDADM | name} The ADM-NAME parameter defines the RED target member in a CICS region for the RED Interface administrator activity use. The maximum length is 12 characters. The default name is REDADM.
AMSG-BUFFER-64 = {Y | Yes, No} The AMSG-BUFFER-64 parameter determines whether or not the async message buffer pool location uses 64-bit mode.
AMSG-MAXLEN = {40000 | number} The AMSG-MAXLEN parameter sets the maximum async message length to be used in RED Interface. The valid values range from 1024 to 1000000. The default value is 40000 bytes.
AMSG-ORDERED-YN = {Y | Yes, No} The AMSG-ORDERED-YN parameter sets the message delivery order type used in the buffer pool. The valid values are as follows:
  • Y: indicates that the order is preserved in the buffer pool. The default value is Y.
  • N: indicates that the order is not preserved.
CICS-LSN-NAME = {name} The CICS-LSN-NAME parameter specifies the name of RED CICS recipe services listener. The name specified here is the target member of the RED URL. The maximum length is 15 characters.
CICS-MAIN-MAX = {21 | number} The CICS-MAIN-MAX parameter specifies the maximum number of Mainframe RED CICS recipe service receive transactions that can be run concurrently. The valid range is from 5 to 100. The default value is 21.
CICS-MAIN-TXID = {#RED | name} The CICS-MAIN-TXID parameter specifies the identifier of a Mainframe RED CICS receive recipe service transaction. The maximum length is 4 characters.
Note: Do not change this setting except under direction by TIBCO Substation ES support personnel.
CICS-USER-MAX = {50 | number} The CICS-USER-MAX parameter specifies the maximum number of Mainframe RED CICS user recipe services that can be handled concurrently. The valid range is from 20 to 400. The default value is 50.
CMSG-BUFFERS = {100 | number} The CMSG-BUFFERS parameter specifies the number of message buffers used to process receive messages. The valid values range from 5 to 5000. The default value is 100.
CMSG-BUFFER-64 = {N | Yes, No} The CMSG-BUFFER-64 parameter indicates the buffer pool location of RED CICS Receive services uses 64-bit mode. The default value is N.
CMSG-BUFFER-SZ = {4096 | number} The CMSG-BUFFER-SZ parameter specifies the length of the buffer message used to handle receive messages. The valid values range from 1024 to 500000. The default value is 4096.
CMSG-BUFF-OFLOW = {80 | number} The CMSG-BUFF-OFLOW parameter instructs the CICS message listener to set an overflow percentage value for the number of buffers.

For more information, see the RED overflow percent handling documentation.

The valid values range from 50 to 95. The default value is 80.

CMSG-BUFF-THROT = {70 | number} The CMSG-BUFF-THROT parameter instructs the CICS message listener receiving messages to set a throttle percent for the number of buffers in use.

For more information, see the RED throttle handling documentation.

The valid values range from 40 to 95. The default value is 70.

CMSG-CHECK-STG = 100 The CMSG-CHECK-STG parameter is used to determine how often SXCO#RED checks the amount of storage that has been used. The number of transactions executed between each storage check. During a storage check, if the storage grows by more than 100000 bytes, SXC#RED recycles itself so that CICS can clean up memory.

The minimum value is 0, the maximum value is 10000, and the default value is 100.

CMSG-CICS-WAIT={10 | number} The CMSG-CICS-WAIT parameter specifies the timeout value in seconds for the CICS RED server program SXCO#RED to react when it is waiting for a Commit or ROLLBACK command from Substation ES. If Substation ES does not respond back to SXCO#RED within this allotted wait time, an EXEC CICS SYNCPOINT ROLLBACK message is issued.

The parameter value implementation applies only to "Guaranteed" Recipes. The valid range is from 5 to 60. The default value is 10.

CMSG-MAXLEN = {16382 | number} The CMSG-MAXLEN parameter sets the maximum length of recipe messages that can be handled in RED Interface The valid values range from 1024 to 1000000. The default value is 16382.
CMSG-ORDERED-YN = {Y | Yes, No} The CMSG-ORDERED-YN parameter sets the receive services message delivery order type used in the buffer pool. Y indicates that the order is preserved in the buffer pool; N indicates the order is not preserved. The default value is Y.
CMSG-PACING = {0 | number} The CMSG-PACING parameter instructs the receive service to wait for the specified number of micro seconds after receiving a message before returning to the CICS application.

The valid range is from 0 to 5000000. The default value is 0, which indicates no wait time.

CMSG-WAIT = {20 | number} The CMSG-WAIT parameter determines the length of time (in seconds) that the receive messages thread sets in the RIB for a reply message to return to the sender.

This option takes effect only when a reply is required. The valid values range from 0 to 60 seconds. The default value is 20.

CMSG-WORKERS = {10 | number} The CMSG-WORKERS parameter specifies the number of Substation ES worker threads within the CICS region. The valid values range from 0 to 50. The default value is 10.
CMSG-SEND-CONFIRM = {N | Yes, No} The CMSG-SEND-CONFIRM parameter indicates whether the receiver is a guaranteed process. The default value is N.
CMSG-START-DYN = {10 | number} This CMSG-START-DYN parameter controls Dynamic Listeners in the CICS (#RED) tasks. The range is from 2 to 2000. The default value is 10.
GMSG-BES-COMP-TO = {1 | number} The GMSG-BES-COMP-TO parameter specifies the XCF time to complete the send operation inside the XCF environment. The valid values range from 1 to 30 seconds. The default value is 1 second.
GMSG-BES-REPLY-TO = {3000 | number} The value of the GMSG-BES-REPLY-TO parameter is sent to SXXOSRVA and tells RED Interface how long it should wait for a reply from Substation ES when a request with a reply confirmation is sent by the CICS side.

The valid values range from 1 to 30000 milliseconds. The default value is 3000 milliseconds.

GROUP-MONITOR = {TIBMON | name} The GROUP-MONITOR parameter specifies the Mainframe RED monitor group member name in which Substation ES RED Interface participates. The maximum length is 8 characters.
GROUP-NAME = {TIBSS | name} The GROUP-NAME parameter specifies the Mainframe RED group member name in which Substation ES RED Interface participates. The maximum length is 8 characters.
HUB-NAME = {RMF1 | } The HUB-NAME parameter specifies the Mainframe RED HUB that Substation ES RED Interface uses to send messages between Substation ES and the CICS region. The maximum length is 4 characters.
P#-AMSG-BUFFERS = {1000 | number} The P#-AMSG-BUFFERS parameter specifies the number of message buffers for processing the async messages in buffer pool #, where # can be 1, 2, or 3. The valid buffer count is from 5 to 50000. The default value is 1000.
P#-AMSG-BUFFER-SZ = {8192 | number} The P#-AMSG-BUFFER-SZ parameter specifies the length of the buffer message used to handle the async messages in buffer pool #, where # can be 1, 2, or 3. The valid buffer length is from 256 to 500000. The default value is 8192.
P#-AMSG-NAME = {P#AMSG| number} The P#-AMSG-NAME parameter specifies the RED target member name in which Substation ES RED Interface publishes async messages. The maximum length is 12 characters.
P#-AMSG-PACING = {0 | number} The P#-AMSG-PACING parameter instructs the sending request to wait for the specified number of micro seconds after an async message is sent from the async message pool # before returning to the CICS application. The valid values range from 0 to 5000000. The default value is 0, which indicates no wait time.
P#-AMSG-TRCLVL = {0 | 0-5} The P#-AMSG-TRCLVL parameter specifies the trace level for messages produced by RED Interface when tracing the processing of an async message through the interface.
P#-AMSG-WORKERS = {0 | number} The P#-AMSG-WORKERS parameter specifies the number of concurrent async message worker threads that are started to service async messages in the pool. The valid values range from 0 to 40.
SMSG-BUFFERS = {100 | number} The SMSG-BUFFERS parameter specifies the number of message buffers for processing synchronous messages. The valid buffer count is from 5 to 50000. The default value is 0.
SMSG-BUFFER-SZ = {1024 | number} The SMSG-BUFFER-SZ parameter specifies the length of the buffer message used to handle synchronous messages. The valid buffer length is from 1024 to 500000 bytes. The default value is 0 bytes.
SMSG-MAXLEN = {16382 | number} The SMSG-MAXLEN parameter sets the maximum length of serialized messages that can be handled in RED Interface. The valid values are from 1024 to 4000000. The default value is 4096 bytes.
SMSG-NAME = {SYNCMSG#1| name} The SMSG-NAME parameter specifies the RED target member name to which Substation ES RED Interface publishes synchronous messages. The maximum length is 12 characters.
SMSG-WAIT = {10 | number} The SMSG-WAIT parameter determines the length of time (in seconds) that the synchronous messages thread sets in the RIB for a reply message to return to the sender. This option takes effect only when a reply is required. The valid values range from 0 to 60 seconds. The default value is 10 seconds.
SMSG-WORKERS = {3 | number} The SMSG-WORKERS parameter specifies the number of concurrent serialized message worker threads that are started to service synchronous messages. The valid values range from 0 to 10.

The default value is 3.

TRCLVL = {0 | 0-5} The TRCLVL parameter specifies the trace level specific to RED Interface when tracing payloads that pass through the interface.

This parameter does not duplicate what is set on the system TRCLVL setting but only shows entries in RED Interface.

The valid values are as follows:
  • Levels 1 to 3 show information mostly useful to users and TIBCO field staff.
  • Levels 4 and 5 show information only useful to engineering staff. The information is detailed and usually specific to internal stacks and control blocks.
TRCLVL-ONL = {0 | 0-5} The TRCLVL-ONL parameter specifies the trace level of the messages produced by CICS resident programs that act on or on behalf of Substations ES. Messages are written to the CEEOUT and CEEMSG CICS output data sets.