# Summary of Definition Panel (Recipe)

The Summary of Definition panel displays a recipe in detail.

## Panel Layout

    SXTP09D -------------------- Summary of Definition --------- Row 1 to 77 of 77
    Command ===>                                                   Scroll ==> CSR

    |Recipe name  : Substation-Admin-IMS
    |    Subject  : tibss.admin.sxi.request
    |    Response : , Always: Y
    |    Err Subj : tibss.error.out
    |    Error Thresholds:  Count: 0, Percent: 0
    |    Transcode: , MOI:8, Trace: 0, Reply: 3
    |    Dynamic Subject Leng:0, Start: 0, Limit: 0, SSID Filter:No
    | CICS Fields:
    |   Mirror tran:  User-tran:  N, Tranid:      System-name:
    |   Channel Name        :
    |   Single CTN Name     :
    |   Container Invocation:P
    |   Container Process   :S
    |   Forward Destinations:No
    |   Resource 2 :               Resource 3 :
    |   Resource 4 :               Resource 5 :
    | IMS Fields:
    |   Variable Length Tran : N Transaction Len:0
    |   Seqment Esc Seq      : 00000000
    |   MFS Map Name         :
    | EMS Extensions:
    |   Destination Types: Input: Q, Output: Q, Error: Q
    |   Output: Prty: N Expir: N, Compr: N, Presv: N, Trace: N
    |   Expire: 0, Units: S, Priority: 4
    |   Durable Subscriber: N, Clientid:
    |   SMSL Mode: RA, Delivery Mode: R
    |   Message type: M, Copy Correlation id: N

    | Back End System: Interface-IMS
    |     Type: I, Target: IMS
    | ESB RV Endpoint id: RENDEZVOUS, Network: 127.0.0.1
    | Daemon:
    |     Service: 7555, Port: 0, Multicast: N, Startup: Y
    |     Multicast-addr:
    | SSL Required: N, SSL Authonly: N
    |   KeyRingFile    :
    |   KeyRingLabel   :
    |   Cipher         :
    |   LDAP URL       :
    |     LDAP Userid  :
    |     LDAP Password:
    |   Enable FIPS    : N
    |   Enable Trace   : N Enable Debug Trace: N
    |   Enable SSLV3   : N Enable TLS1 : N
    |   Exp Host Member:
    |   Ver Ex Host    : N
    | ConnFact Name: , Password: Null, Userid:
    | USE SSL Parms for ECF:N
    | ECF URL   :
    | ConnFactory Metric: 0
    |             Attempts   Delay    Timeout
    | Connect:            0         0         0
    | Reconnect:          0         0         0
    | Admin Con:No Admin Userid:

    | Input Conversion: CVR-I-ADMIN
    |     Max buffer size: 0
    |     Receiving Buffer max: 0, id: BUF-IO-ADMIN
    |     Input Message id: MSG-IN-ADMIN

    |   From Message id: 0, name: SXS-COMMAND
    |       To offset: 00000000, length: 00008192, name: COMMAND-STR
    |       In decimal: 0, Out decimal: 0, Buf-type: STR
    |       Truncate: Y, Required: Y, Lead-sign: N
    |       Sep-sign: N, Right-just: N, Pad: 40
    |       Init len: 0, Init value:

    | Output Conversion: CVR-O-ADMIN
    |     Max buffer size: 0
    |     Sending Buffer max: 0, id: BUF-IO-ADMIN
    |     Output Message id: MSG-OUT-ADMIN

    |    From offset: 00000000, length: 00008192, name: COMMAND-STR
    |        Buffer decimal: 0, Message decimal: 0, Buf-type: STR
    |        To Message id: 0, Type: STR, Reqd: Y, name: SXS-RESULT

    ******************************* Bottom of data ********************************

## Field Description

The following table lists the fields in the Summary of Definition panel:

Field | Description
--- | ---
Recipe name | The name of the recipe.
Subject | The subject Substation ES listens for to invoke a given transformation.
Response | The subject that a message is published on for a given transaction.
Always | This field determines where the response from a transaction process is sent. For details, see the Publish Always field of the Recipe Details Panel.
Err Subj | The subject that an error message is published on if Transformer conversion or BES encounters errors.
Count | The number of errors allowed before the recipe is disabled.
Percent | The percentage of errors allowed before the recipe is disabled.
Transcode | The name of the resource.
MOI | The method of invocation that initiates the configured transformation. For details, see the Method of Invocation field of the Recipe Details Panel.
Trace | The user trace debug level.
Reply | The type of data expected as output from the transaction processing application. For details, see the Reply Method field of the Recipe Details Panel.
Dynamic Subject Leng | The number of bytes to be used for the dynamic subject name.
Start | The starting offset in the buffer to be used for the dynamic subject name.
Limit | The maximum number of concurrent messages to be processed by an ESB endpoint for this recipe. This parameter is only valid with EMS transports.
SSID Filter | The SSID filter used to filter messages that are to be processed by the Substation ES instance with a matching SSID.
Mirror tran | The CICS-specific field used to invoke different transactions for Substation ES to CICS communications during run time.
User-tran | This field indicates whether it is a CSMI user transaction.
Tranid | A four-character identifier that specifies the transaction responsible for running the program on the remote CICS system.
System-name | A four-character system identifier that specifies the CICS region where the program will ultimately be run. This is referred to as the SYSID in CICS terms.
Channel Name | The name of the channel to be set when container data input and output is used.
Single CTN Name | The name of the container to be set when single container input and output is used.
Container Invocation | The method of container invocation. The valid selections are P(for a program link) and T(to start a transaction in CICS).
Container Process | The type of container channel. The valid selections are S(ingle container) and M(ultiple containers).
Forward Destinations | If this parameter is enabled and the process has multiple containers without conversion rules, then Substation ES creates two additional containers named tibss-ListenTo and tibss-ReplyTo and sends them to CICS. These containers contain the corresponding destination or subject names of this service.
Resource N | Two to five additional resources can be specified. Each of these fields can specify an additional resource name for special CICS execution.
Variable Length Tran | This field indicates whether the IMS transaction ID provided in the resource name is less than eight characters.
Segment Esc Seq | The eight hex characters that represent the segment separator in the message.
MFS Map Name | The MFS map name to use.
Input | The destination of the subject that Substation ES listens to invoke a given transformation for: T(opic) or Q(ueue).
Output | The destination of an outbound subject that a message is published on for a given transaction process: T(opic) or Q(ueue).
Error | The subject destination where an error message is published when Transformer conversion or BES encounters errors: T(opic) or Q(ueue).
Prty | This field indicates whether the priority is set for this message.
Expir | This field indicates whether the expiration is set for this message.
Compr | This field indicates whether compression is set for this message.
Presv | This field indicates whether the message is to be preserved on the server.
Trace | This field indicates whether messages that include the message body are generated.
Expire | The EMS expiration value for the message.
Units | The EMS legal unit value for the message.
Priority | The EMS priority value for the message.
Durable Subscriber | This field indicates whether to connect the session as a durable subscriber.
ClientId | The client identifier in a durable connection.
SMSL Mode | The SMSL mode used for this message by Substation ES.
Delivery Mode | The delivery mode used for this message by Substation ES.
Message type | The types of the TIBCO Enterprise Message Service output message: M(ap), S(tream), T(ext), or B(ytes). This selection only applies to the output message (not for the input message). The input message can be any types (Map, Stream, Text, or Bytes). Substation ES will attempt to convert it properly.
Copy Correlation id | Copies the JMSCorrelationID value from an inbound message and puts it in the output message. The following are valid settings: N(o) Y(es) E(nvelope) M(sgId) W(CorId or MsgId)
EMS Selector | A free-form field for specifying a selector statement. For details, see the EMS Selector Specification Panel.
Back End System | The description of the Substation ES interface, both Primary and Alternate.
Type | The type of interface: A(dmin), C(ICS), or I(MS).
Target | The identification of the interface that Substation ES communicates with the transaction processing application through. Must match the interface ID that is configured through the INTF-ID parameter in the system initialization member.
ESB EMS/RV Endpoint id | The name of the ESB endpoint.
Daemon / URL | The host name or host IP address used by Substation ES to find the Rendezvous daemon or EMS Server and establish communication.
Network | The service group selected by network IP network number or multicast addresses.
Service | The value provided for the UDP service port number that defines the service group.
Port | The TCP port given to an ESB endpoint that distinguishes both Substation ES and the role of the ESB endpoint within it.
Multicast | This field indicates whether the address is multicast enabled.
Startup | This field indicates whether to start this ESB during Substation ES startup.
Multicast-addr | The multicast addresses, if the host computer has multiple network interfaces.
SSL Required | This field indicates whether this ESB uses an SSL connection to server.
SSL Authonly | This field indicates whether this ESB connection uses SSL only for authentication.
KeyRingFile | The Resource Access Control Facility (RACF) ring name.
KeyRingLabel | The RACF identity name.
Cipher | The IBM cipher codes for encryption.
LDAP URL | The URL to address LDAP server.
LDAP Userid | The user ID used to access the LDAP server.
LDAP Password | The password used to access the LDAP server.
Enable FIPS | This field indicates whether to use FIPS 140-2.
Enable Trace | This field indicates whether to turn on SSL Trace.
Enable Debug Trace | This field indicates whether to turn on SSL Debug Trace.
Enable SSLV3 | This field indicates whether to turn on SSL V3.
Enable TLS1 | This field indicates whether to turn on TLS1.
Exp Host Member | The name of the EMS server name that is being interfaced with.
Ver Ex Host | This field indicates whether to verify the name of the EMS server against the value specified in the Exp. EMS Host Name field.
ConnFact Name | The name of the connection factory.
Password | The connection object authenticates the user identity using this password.
Userid | The connection object presents this user identity to the server.
USE SSL Parms for ECF | This field indicates whether to use SSL parameters from SSL panel.
ECF URL | The URL string to which connections created by this factory will be connected.
ConnFactory Metric | The load balancing metric of this connection factory.
Connect Attempts | This field limits the number of times that Substation ES attempts to establish a connection to the EMS server when the EMS server is not present at Substation ES startup.
Reconnect Attempts | This field limits the number of times that Substation ES attempts to reestablish a connection to the EMS server.
Connect Delay | The time (in milliseconds) between connection attempts.
Reconnect Delay | The time (in milliseconds) between reconnection attempts.
Connect Timeout | The maximum time (in milliseconds) the Substation ES will wait for a connection to the server to be established.
Reconnect Timeout | The maximum time (in milliseconds) the Substation ES will wait for a reconnection to the server to be established.
Admin Con | This field indicates whether to create this ESB Admin connection during Substation ES startup.
Admin Userid | The user identifier that has EMS server administrator privileges.
Input Conversion | The name of the conversion rule for the input conversion.
Max buffer size | The maximum input buffer size defined for the conversion rule.
Receiving Buffer max | The maximum size of the inbound buffer.
id | The name of the buffer associated with the transformation for the receiving buffer.
Input Message id | The name of the message.
From Message id | A message field identifier. Zero (0) is a special value that signifies no message field identifier.
name | The field name you specify in the message definition associated with the transformation from which data is to be extracted.
To offset | The number of bytes for the field that is the starting offset in the inbound buffer. The buffer offset positions the data at a given byte position.
length | The length of the data type field in the buffer definition associated with the transformation.
name | The name you specify for the field in the buffer definition associated with the transformation.
In decimal | The implied number of digits after the decimal point in the input. For example, for the number 345.67, the implied decimal is 2. This field only applies to numeric values.
Out decimal | The implied number of digits after the decimal point in the output. For example, for the number 345.67, the implied decimal is 2. This field only applies to numeric values.
Buf-type | The mainframe type of data that the invoked application expects: Str, Text, Pdec, Updec, Zdec, Uzdec, Ubin, Bin, Float, and Opa. For type definitions, see Type.
Truncate | This field indicates whether data that extends beyond the specified buffer length allocated for a message field was truncated. By default, the truncate option is Yes. The S field serves as a system field, which means no mapping to the buffer field is required.
Required | This field indicates whether the field is required for a conversion. The default value is Y. If you specify Y, the transaction is not considered complete unless a field with this name is encountered in the inbound Rendezvous message. If you specify N, no specific check is made as to the availability of that message field in the Rendezvous message.
Lead-sign | The field contains a leading sign, as opposed to a trailing sign.
Sep-sign | This field indicates whether a byte is reserved for the sign. Valid selections: N(one), L(eading), and T(railing). Default selection: N.
Right-just | The positioning of the string. You can use padding characters to fill in the data on either side, as applicable. The default value is NO and strings are left justified.
Pad | The character for padding. You can use keyboard accessible characters as a pad, which are placed at the beginning, at the end, or in both positions, depending on the configuration. The default pad character is a space.
Init len | The length of the Init Value field when used.
Init value | The value or characters for filling in the field if the data is not available in the buffer.
Output Conversion | The name you specify for the output conversion associated with the transformation.
Max buffer size | The maximum outbound buffer size of all fields defined in the Msg-Field or Buffer-Field conversion rule.
Sending Buffer max | The maximum size of the outbound buffer for this recipe process to be sent.
id | The name you specify for the buffer associated with the transformation for the sending buffer.
Output Message id | The name of the message definition associated with the transformation that was entered on the Message Definitions panel.
From offset | The number of bytes for the field that is the starting offset in the outbound buffer. The buffer offset positions the data at a given byte position.
length | The length of the data type field in the buffer definition associated with the transformation.
name | The name you specify for the field in the buffer definition associated with the transformation.
Buffer decimal | The implied number of digits after the decimal point in the buffer. For example, for the number 345.67, the implied decimal is 2. This field only applies to numeric values.
Message decimal | The implied number of digits after the decimal point in the message field. For example, for the number 345.67, the implied decimal is 2. This field only applies to numeric values.
Buf-type | The mainframe type of data that the invoked application expects. The valid buffer types are Str, Text, Pdec, Updec, Zdec, Uzdec, Ubin, Bin, Float, and Opa. For the definitions of the buffer types, see Type.
To Message id | A message field identifier. Zero (0) is a special value that signifies no field identifier.
Type | The TIBCO message data type for the current field. The current valid message types are DAT, OPA, MSG, STR, BOL, I8, U8, I16, U16, I32, U32, I64, U64, F32, F64, POR, and IPA. For the definitions of the message types, see Type.
Reqd | This field indicates whether the field is required for a conversion. The default value is Y. If you set this field to N, if the data type is numeric, and if the content of the field has not been initialized by the host-side application, the Transformer initializes the field and no editing errors occur.
name | The name you specify for the field in the message definition associated with the transformation that was entered in the Define Fields in a message panel.

Copyright © TIBCO Software Inc. All rights reserved.