Put Options


Use this tab to specify the options you want CASP to use to send messages (via kxcPutRequest and kxcPutResponse, for example) from applications.

Profile Type (pull-down)

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

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

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

For each put 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 KXCPUTOPTS structure should always be set (Always Use), which ones should never be set (Never Use), and which ones should be under the application's control.

For each put 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 copy the Message ID supplied by the application into the message being sent.

Use Correlation ID

Specifies that CASP copy the Correlation ID supplied by the application into the message being sent.

Increment Retry Count

Specifies that CASP increment a count for each time a message has been sent to the EMS. This information is available only to the EMS for tracking purposes (for example, the count allows EMS to track how many times it has tried and failed to repair a message). This is described in more detail in the CASP programmer's guides and the CASP Diagnosis Guide.

No Transformation

Specifies that CASP should not send the message to the transformation business component even if the next component in the workflow cannot accept the message in its current format. In this case, the put operation fails. (This option is useful to you only if you have a CASP broker integration product installed at your site.).

No Transactional Control

Allows CASP to send a transactional message to a non-transactional MSMQ queue.

No Error Management Service

Prevents CASP from sending the message to the exception message service if the put operation fails.

No Notify On Error

Prevents CASP from sending a notification message to the client when it encounters an error, even if the error profile instructs it to do so.

Free Buffer

Specifies that CASP free the buffer it previously allocated.

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

Use Existing Theme
Specifies that CASP use a theme created by a previous put or get operation for the current send operation.

Create New Theme
Specifies that CASP create a new theme for this put operation (this is not valid for put response operations).

Not Used
Specifies that neither of the above options is set in this profile record. In this case, CASP chooses whether to create a new theme or use the existing theme. The choice CASP makes is based on whether the recipient is a business element or a client, and if it is a client, whether the message being sent is a request or a datagram message.

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

Theme Retention

Retain Theme after Put
Specifies that CASP save the theme for subsequent put and get operations. CASP can also use this theme when calling kxcGetResponse to get a response message associated with a particular request.

Close Theme after Put
Specifies that CASP discard the current theme after sending the message.

Not Used
Specifies that neither of the above options is set in this profile record. In this case, CASP chooses whether to close or retain the theme based on whether the recipient is a business element or a client, and if it is a client, whether the message being sent is a request or a datagram message. This is described in more detail in the CASP programmer's guides.

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

Send As

Datagram
Specifies that CASP send the the message as a Datagram (this option cannot be used with kxcPutReponse and it is ignored with kxcPutToStorageQueue).

Notification
Specifies that CASP send a message back to the client (outside of the workflow) indicating success or failure.

Request and Response
Specifies CASP send the message as a request/response message (the default).

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

Exception Data

These checkboxes define how CASP is to handle undeliverable (exception) messages:

User Data
Specifies that exception message data include user information.

Time Stamp Data
Specifies that exception message data include time stamp information.

System Data
Specifies that exception message data include system configuration information.

Error Data
Specifies exception message data include error information.

CASP Data
Specifies that exception message data include CASP configuration information.

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.