Get Options


Use this tab to specify the options you want CASP to use when reading messages from a queue in response to application get requests (such as kxcGetRequest and kxcGetResponse for example).

Profile Type (pull-down)

The profile type you select here determines how CASP chooses which get options to use.

Let Application Decide
Creates a default profile and does not set any get options in the KXCGETOPTS structure when the application specifies KXCGOPT_USEDEFAULT. If the application does not specify KXCGOPT_USEDEFAULT, CASP uses the fields set by the application.

Use Directory
Creates a default profile, and allows you to select those get options that are set in the KXCGETOPTS structure when the application specifies KXCGOPT_USEDEFAULT. If the application does not specify KXCGOPT_USEDEFAULT, then CASP uses the fields set by the application.

For each get option you can specify one of the following:

Always Use—turn the option on
Never Use—turn the option off

Use Selected
Creates an override profile, and allows you to define which get options in the KXCGETOPTS structure should always be set (Always Use), which ones should never be set (Never Use), and which ones should be under application control.

For each get option, you can specify one of the following:

Always Use—turn the option on
Never Use—turn the option off
Let Application Decide—let the application set the option

Options

Use Message ID

Specifies that CASP return the first message on the queue that matches the MsgId field contents.

Use Correlation ID

Specifies that CASP return the first message on the queue that has a correlation ID that matches the CorrelID field contents.

Allow Native Messages

Specifies that the application can accept native as well as CASP messages. If CASP reads a message that is not in CASP message format and this option is not set, CASP sends the message to the exception management service. This option is ignored on kxcGetFromStorageQueue calls.

Automatically Allocate Buffer

Specifies that CASP allocate a buffer for the received message if either of the following is true:

  • the application did not allocate a buffer

  • the received message is longer than the allocated buffer

Wait

Specifies that CASP wait for the amount of time specified in the WaitLength field before returning control to the application without a message.

No Notify on Error

Specifies that if CASP detects an error, it should not send notification messages back to the client.

No Error Mgmt Service

Specifies that if CASP detects an error, it should not send a message to the exception message service.

Use Signal (MVS Only)

Specifies that CASP use the OS/390 facility UseSignal. This facility causes MQSeries to set an event flag after receiving a message; the application can check for this flag, and if it is set, it can call MQSeries to read the message.

Terminate Supported

Specifies that application management can notify business element applications that they should terminate.

Suppress Error Profile

Specifies that CASP not call the Error Analysis Routine even if one has been configured.

Theme Reuse (radio buttons)

Use Existing Theme
Specifies that CASP return the first message on the queue that has a theme used in a previous CASP call.

Use Any Theme
Specifies that CASP return the first message on the queue regardless of theme.

Not Used
Specifies that neither of the above options is set in this profile record. In this case, CASP chooses whether to use the existing theme or any theme. For more information on profiling and this option, refer to the CASP Programmer's Guide for Procedural Languages or the CASP Programmer's Guide for Object-Oriented Languages.

Let Application Decide
Use the application settings for these options (available only if you chose Use Selected for Profile Type).

Theme Retention (radio buttons)

Retain Theme after Get
Specifies that CASP save the theme for subsequent get or put operations.

Close Theme after Get
Specifies that CASP discard the current theme after returning the message to the application.

Not Used
Specifies that this profile does not use this parameter. In this case, CASP chooses whether to close or retain the theme. For more information on profiling and this option, refer to the CASP Programmer's Guide for Procedural Languages or the CASP Programmer's Guide for Object-Oriented Languages.

Let Application Decide
Use the application settings for these options (available only if you chose Use Selected for Profile Type).

Get Message from Queue

Browse First
Specifies that CASP read the first message on the queue (that matches the specified criteria) without removing it from the queue.

Browse Next
Specifies that CASP read the next message (that matches the specified criteria) on the queue without removing it from the queue.

Browse Same
Specifies that CASP read the same message that was read in the previous browse operation and leave the message on the queue.

Read Last Browsed
Specifies that CASP read the last message it browsed and then remove that message from the queue.

Read Next
Specifies that CASP read the next message on the queue; this option deactivates any of the "browse" options described above.

Let Application Decide
Use the application settings for these options (available only if you chose Use Selected for Profile Type).

For more detailed information about API profiling, please refer to the CASP Programmer's Guide for Object-Oriented Languages and/or the CASP Programmer's Guide for Procedural Languages.