CA API Gateway 9.1

9.4 9.1

Create, Edit, Delete Sample Messages

The Policy Manager uses the Web service's WSDL document to generate a sample message for each operation of the service. However, these sample messages are limited to elements declared in the WSDL and do not contain security-related headers. To allow the point-and-click selection of nodes in documents that cannot be generated automatically, you can configure your own sample messages.
gateway90
The Policy Manager uses the Web service's WSDL document to generate a sample message for each operation of the service. However, these sample messages are limited to elements declared in the WSDL and do not contain security-related headers. To allow the point-and-click selection of nodes in documents that cannot be generated automatically, you can configure your own sample messages.
Contents:
You can configure sample messages in the following assertions:
Create a Sample Message
To create a sample message:
  1. Open the properties for any of the assertions listed above.
  2. In the Sample Messages section of the dialog, click [
    Add
    ]. The Sample Message dialog appears.
  3. Configure the dialog as follows:
    Setting
    Description
    Sample Message Name
    Enter a descriptive name for the message. For example, "getQuote with UsernameToken".
    Operation Name
    Displays any Web Service Operation that was selected prior to opening the Sample Message dialog. If none selected, this field is blank.
    The Operation Name is only used to organize sample messages. It has no effect on message processing in the Gateway.
    XML Document
    Displays an automatically generated message. Edit the XML code if necessary. You can right-click within the box to access the XML Editor features.
    Security Zone
    Optionally choose a security zone. To remove this entity from a security zone (security role permitting), choose "No security zone".
    For more information about security zones, see Understanding Security Zones.
    This control is hidden if either: (a) no security zones have been defined, or (b) you do not have Read access to any security zone (regardless of whether you have Read access to entities inside the zones).
    The default security zone of a sample message differs as follows:
    • If you also have the "Manage Service <name>" role, you are able to set the security zone of the sample to any zone to which you have Read permission. In this case the first eligible zone (most like the "no security zone" option) is used as the default.
    • If you do not also have the "Manage Service <name>" role, then the zone defaults to your "Manage Zone <name>" zone.
  4. Click [
    OK
    ] when done. The new sample message is available from the
    Sample Messages
     drop-down list on the dialog.
Edit a Sample Message
To edit a sample message:
  1. Open the properties for any of the assertions listed above.
  2. From the
    Sample Messages
     drop-down list, select the message to edit. You cannot modify the automatically generated message. 
  3. Click [
    Modify
    ]. The Sample Message dialog appears. 
  4. Edit the message as required.  
  5. Click [
    OK
    ] to close the dialog.
Delete a Sample Message
To delete a sample message:
  1. Open the properties for any of the assertions listed above.
  2. From the
    Sample Messages
     drop-down list, select the message to delete. You cannot delete the automatically generated message.
  3. Click [
    Remove
    ]. You are prompted for confirmation.
  4. Click [
    OK
    ] to confirm.

Content feedback and comments