Define - RED Interface Details

From the Define - Interfaces: RED page, click Add or double-click an existing RED interface, and then the RED Interface Details page is displayed.

The following table describes the items that are available on the RED Interface Details page:

Item Description
Name Type an RED interface name.
Description Type a short description for the RED interface.
Interface ID Type the interface identifier, which is the internal interface name for Substation ES.
Output Interface Specify an output interface, or click to select one.
CICS Endpoint Specify a CICS endpoint.
Hub Name Specify the Mainframe RED HUB this Substation ES RED interface uses for sending messages between Substation ES and the CICS region. The maximum length is 4 characters.
Admin Name Specify the RED target member in CICS region for the RED interface administrator activity use. The maximum length is 12 characters.

The default name is REDADM.

Trace Level: BES Enter the trace level of the messages produced by CICS resident programs that act on or on behalf of Substation ES. Messages are written to the CEEOUT and CEEMSG CICS output data sets.
Trace Level: RED
Specify the trace level specific to the RED interface when tracing payloads that pass through the interface. This parameter does not duplicate what is set on at the system TRCLVL setting but only shows entries in the RED interface.
  • 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.
Expand the CICS Related Parameters panel, the following items are available:
Group Name Specify the Mainframe RED group member name in which this Substation ES RED interface participates. The maximum length is 8 characters.
Group Monitor Name Specify the Mainframe RED monitor group member name in which this Substation ES RED interface participates. The maximum length is 8 characters.
Listener Name Specify the RED CICS recipe services listener name. The name specified here is the target member of the RED URL. The maximum length is 15 characters.
Listener Transaction Id Specify the Mainframe RED CICS receive recipe service transaction identifier. The maximum length is 4 characters.
Maximum Concurrency In the Transactions for Listener field, enter the maximum number of Mainframe RED CICS recipe service receive transactions that can be run concurrently.

Valid values for this field are in the range 5 - 100.

The default value is 21.

In the User Transactions field, enter the number of Mainframe RED CICS user recipe services that can be handled concurrently.

Valid values for this field are in the range 20 - 400.

The default value is 50.

Timeout In the General Message Reply (ms) field, enter a value, which is sent to SXXOSRVA and tells the RED interface how long it has to wait for a reply from Substation ES when a request with a reply confirmation is sent by the CICS side.
In the General Message Completion (sec) field, enter the XCF time to complete the send operation within the XCF environment.
Expand the Trigger Service - CICS Outbound Messaging panel, the following items are available:
64-bit Buffers If you want the async message buffer pool location to use the 64-bit mode, select this check box.

By default, this check box is cleared.

Ordered If you want to preserve the message delivery order used in the buffer pool, select this check box.

By default, this check box is selected.

Maximum Message Length Enter the maximum message length to be used in this RED interface.

Valid values for this field are in the range 1024 - 1000000.

The default value is 40000 bytes.

Number of Buffers Type the number of message buffers for processing the messages in buffer pool #, where # can be 1, 2, or 3.

Valid values for this field are in the range 5 - 50000.

The default value is 1000.

Buffer Size Type the length of the buffer message used to handle the messages in buffer pool #, where # can be 1, 2, or 3.

Valid values for this field are in the range 256 - 500000.

The default value is 8192.

Pacing Type the sending request to wait for the specified number of micro seconds after sending a message from the message pool # before returning to the CICS application.

Valid values for this field are in the range 0 - 5000000.

The default value is 0, which indicates no waiting time.

Trace Level Type the trace level for messages produced by the RED interface when tracing the processing of a message through the interface.
Workers Type the number of concurrent async message worker threads that are started to service messages in the pool.

Valid values for this field are in the range 0 - 40.

Message Name Type the RED target member name in which this Substation ES RED interface publishes messages. The maximum length is 12 characters.
Expand the Recipe Service - CICS Inbound Messaging panel, the following items are available:
Workers Enter the number of Substation ES worker threads within the CICS region.

Valid values for this field are in the range 0 - 50.

The default value is 5.

Start Dynamic Listeners Level Enter the number of Dynamic Listeners in the CICS (#RED) tasks.
Maximum Message Length Enter the maximum length of recipe messages that can be handled in this RED interface

Valid values for this field are in the range 1024 - 1000000.

The default value is 16382.

Number of Buffers Enter the number of message buffers used to process received messages.

Valid values for this field are in the range 5 - 5000.

The default value is 100.

Buffer Size Enter the length of the buffer message used to handle received messages.

Valid values for this field are in the range 1024 - 500000.

The default value is 4096.

Pacing Instructs the receive service to wait for the specified number of micro seconds after receiving a message before returning to the CICS application. Valid values range: 0 to 5000000.

The default value is 0, which indicates that there is no wait time.

Wait Enter the length of time (in seconds) that the received 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.

Valid values for this field are in the range 0 - 60.

The default value is 10.

Buffer Overflow(%) Instructs the CICS message listener to set an overflow percentage value for the number of buffers. For additional information, see the RED overflow percent handling documentation.

Valid values for this field are in the range 50 - 95.

The default value is 80.

Buffer Throttling(%) Instructs the CICS message listener receiving messages to set a throttle percent for the number of buffers in use. For additional information, see the RED throttle handling documentation.

Valid values for this field are in the range 40 - 95.

The default value is 70.

64-bit Buffers If you want the RED CICS receive services buffer pool location to use the 64-bit mode, select this check box.

By default, this check box is cleared.

Ordered If you want to preserve the receive services message delivery order used in the buffer pool, select this check box.

By default, this check box is selected.

Send With Confirmation

Specify whether the receiver is a guaranteed process.

By default, this check box is cleared.