OTMA User Data Formatting exit routine (DFSYDRU0)

Different clients can have different exit routine names, or the clients can all use the default exit routine name of DFSYDRU0.

The OTMA User Data Formatting exit routine must be reentrant.

The OTMA User Data Formatting exit routine must be included in an authorized library in the JOBLIB, STEPLIB, or LINKLIST library concatenated in front of the IMS.SDFSRESL. This exit routine is optional.

No special steps are required to include this routine.

When a matching destination descriptor with EXIT=YES is found and the DFSYPRX0 exit routine either sets RC=100 or does not exist, this field contains the tpipe name that is specified in the destination descriptor.

X'80'

An OTMA prefix exists.

X'40'

The user exit can override the client name.

X'20'

OTMA message submitted by OTMA client with super member support. The OTMA state data pointed to by the input parameter list has the 1-4 bytes super member name at offset x'E' from the beginning of the state data.

X'10'

The user exit is called to process a late response to a synchronous program switch request. If the X'80' flag is also set, the LTERM or tpipe name and input client member name in the parameter list are propagated from the original OTMA transaction that initiated the ICAL call.

X'08'

The destination name matches an entry in the OTMA destination descriptor for IMS Connect.

X'04'

The destination name matches an entry in the OTMA destination descriptor for IBM® MQ.

X'02'

The destination name matches an entry in the OTMA destination descriptor for a non-OTMA destination.

X'80'

Transaction pipe exists for the client.

X'40'

LTERM exists in IMS (non-maintenence versions).

X'20'

LU 6.2 descriptor exists.

X'10'

ETO is available.

X'08'

Client is active.

X'04'

tpipe trace is active.

X'02'

This DRU exit was entered for a different OTMA client destination which is specified by a previous DRU exit.

X'80'

If set, indicates that at offset +100, the parameter list includes the address of the information from the OTMA destination descriptor for IBM MQ or IMS Connect.

X'40'

If set, indicates that at offset +104, the parameter list includes the original CHNG call value.

X'20'

If set, indicates that at offset +116, the user exit parameter list includes the address of the OTMA security data prefix.

X'10'

If set, indicates that the SENDALTP function is on for IMS Connect input message that triggers this ALTPCB output.

When a matching descriptor with EXIT=YES is found and the DFSYPRX0 exit routine either sets RC=100 or does not exist, this field contains the tmember name that is specified in the destination descriptor.

If the exit is called to process a synchronous program switch response and the original transaction is from OTMA, this message control information is generated by IMS. The original message prefix from the OTMA client is not propagated to the user exit. However, the LTERM or tpipe name and the input client member name in this parameter list are from the original OTMA message.

Check the prefix flag in the Message Control Information section to determine the specific type of State Data section specified.

If the OTMA super member feature is used, the super member name is located at offset +14 from the beginning of the state data. See the TMAMSPNM field of the DFSYMSG macro.

If the exit is called to process a synchronous program switch response and the original transaction is from OTMA, this state data information is generated by IMS. The state data prefix from the OTMA client is not propagated to the user exit. However, the correlator field (TMAMHCOR), the LTERM or tpipe name, and the input client member name in this parameter list are from the original OTMA message.

The area is also used to return new or modified user data, up to a maximum of 1024 bytes.

If the destination name matches a non-OTMA destination descriptor, or the name does not match any entry in the OTMA destination descriptor, this field contains 0.

See the TMAMICON_DESCRIPTOR DSECT mapping for the layout of the routing information for an IMS Connect destination.

See the TMAMMQS_DESCRIPTOR DSECT mapping for the layout of the routing information for an IBM MQ destination.

This field is used when the destination is a different OTMA client. A return code of 8 must also be set.

X'80'

If this flag is set, a synchronized transaction pipe must be created. However, if the OTMASP initialization parameter is set to Y in the DFSPBxxx PROCLIB member, the synchronized transaction pipe is always created. This flag can be set only if the return code is 0.

X'40'

If this flag is set, the message is persistent and a recoverable sequence number must be set. This flag is valid only if a synchronized transaction pipe is specified.

X'20'

If this flag is set, OTMA ensures that the output is always saved in a hold queue. This is an optional flag that is used only in the following scenario:

In the shared-queues back-end IMS, the first call to DRU exit is to process a message from a non-OTMA client instead of an OTMA hold queue capable client.

However, without this flag set in this scenario, the output is stored in the regular tpipe queue instead of in the hold queue

X'10'

If this flag is set, the ALTPCB output message will be sent to a remote IMS system for processing through an IMS Connect to IMS Connect TCP/IP connection. You must build a user data prefix that includes at least the names of both the destination remote IMS system and the remote IMS Connect that supports the remote IMS system.

X'08'

If this flag is set, the IMS system needs to send this ALTPCB output message back to the input IMS Connect client that initiates the commit-then-send send-receive call through the input tpipe.

X'04'

If set, IMS needs to send this ALTPCB output message back to the inputting IMS Connect client which initiated the CM0 send-receive transaction. This is a response message for OTMA transaction orchestration.

X'02'

If set, indicates that the destination client name is a super member name. And this is a response message for OTMA transaction orchestration.

A 1-character value with option F, C®, or N. This value sets the security flag of the message prefix in an OTMA ALTPCB output message that is sent to a remote IMS system through IMS-to-IMS TCP/IP communications.

The remote IMS system uses the security flag setting in the output message only if the input message does not have a security flag, there is no match OTMA destination descriptor found, and the remote IMS OTMA security is set to PROFILE.

F

OTMA RACF® security is set to FULL.

C

OTMA RACF security is set to CHECK.

N

OTMA RACF security is set to NONE.

If the SENDALTP function is activated for this ALTPCB output message, this tpipe name is omitted.

This field specifies the name of the super member and is used only in the following scenario:

In the shared queues back-end IMS, the first call to DRU exit is to process a message from a non-OTMA client instead of an OTMA hold queue capable client. And, the output is destined to a hold queue capable client which supports super member.

This field is valid only when the return code of DRU exit is set to 0 and the output flag byte is set to X'20'.

When the destination client name is from a matching destination descriptor with EXIT=YES, the descriptor defines the default destination for output message. However, if any value in the output parameter list is set, the user exit then determines the output destination instead of the descriptor.