Generic service client call details
In the generic service client, service calls contain the content and the transport information for the call. The contents are made of the SOAP envelope. The transport information refers to the information that is required to send and receive and answer depending on the selected protocol.
Message
This page presents the XML contents of the request and provides access to data correlation. The same contents are presented in three different manners.
- Form
- This view provides a simplified view of the message focused on editing the values of the XML content.
- Tree
This view provides a hierarchical view of the XML structure of the message, including elements, namespaces, and the associated values. You can use Add, Insert, Remove, Up, and Down to edit the XML elements and namespaces in the tree.
Click Filter to hide or show namespace, attribute, or text nodes, depending on requirements.
Click Allow only valid modifications to enable smart editing, based on a specified XML schema document (XSD).
To specify a set of XSD documents for the workbench, in the test navigator, right-click the project and select Properties and Schema Catalog. Disable Allow only valid modifications if you do not have an XSD or to bypass the schema.
You can right-click an XML element to convert it to an XML fragment. This enables you to perform data correlation (use datapools and create references) on the entire XML fragment instead of only on the value.
- Source
- This view displays the source XML content of the message or plain text content.
In the Source view, do not edit the tags that start with SoaTag. If you delete or change these tags, any references and substitutions in the test will be broken. You cannot recreate these tags after you delete them.
Attachments
This page lists the MIME attachments that are attached to the request. The contents of this view correspond to the specification of Multipurpose Internet Mail Extensions (MIME). You can use this page to add workbench resources as MIME attachments and change properties.
To use Web service attachments, add a set of Java™ libraries to the Java Runtime Environment (JRE) that the workbench uses. See Configure the environment for handling file attachments for more information. The Content ID is the identifier that the request uses to refer to the attachments. The method for using this identifier depends on your server requirements.
- Use MTOM transmission mechanism
- By default, the request uses SOAP Messages with Attachments (SwA) to handle attachments.
Select this option to handle attachments with the SOAP MTOM.
Transport
This page covers the transport settings used to send the request. The transport protocol settings apply to a transport configuration, which can be either HTTP, Java Message Service (JMS), or WebSphere MQ. You can create several configurations for each protocol so that you can switch protocols or variants of protocols.
- HTTP
- Select HTTP to use the HTTP transport for the request. At the request level, you can update a URL or SOAP action and the reference to the global configuration of a test.
- Protocol configuration
- Click Change to specify a predefined transport configuration or to create a configuration. HTTP transport configurations contain proxy and authentication settings that can be reused.
- Method and Version
- Specify the HTTP method and version to be used to invoke the service request.
- URL
- Specify the URL end point of the service request.
- Headers
- Specify the names and values of any custom HTTP headers that are required by the service. Click Add, Edit or Remove to modify the headers list.
- Cookies
- Specify the names and values of any cookies required by the service. Click Add, Edit or Remove to modify the cookies list.
- JMS
Select JMS to use the Java Messaging Service transport for the request. This page enables you to add string properties that are attached to the request for a JMS configuration. These will be sent as message properties through JMS.
- Protocol configuration
- Click Change to specify a predefined transport configuration or to create a configuration. JMS transport configurations contain generic end point, reception point, and adapter settings that can be reused.
- Properties
- Specify the names and values of any string properties that are required by the request for the current JMS transport configuration. These are sent as message properties through JMS. Click Add, Edit or Remove to modify the properties list.
- WebSphere MQ
- Select MQ to use the IBM WebSphere MQ transport for the request. This page enables you to specify the SOAP action and override the settings for the WebSphere MQ configuration selected at the test level.
- Protocol configuration
- Click Change to specify a predefined transport configuration or to create a configuration. MQ transport configurations contain generic queue, header, and SSL settings that can be reused.
- SOAP Action
- Specifies the SOAP action to be used to invoke the MQ request.
- Override MQ protocol configuration values
- Configure the fields of the MQ message.
You can replace a subset of an MQ message descriptor with a custom format for use with other server types, specifically when using an XML message request. Refer to WebSphere MQ documentation for details about message descriptors. These settings replace the message descriptor and header settings of the MQ protocol configuration.
- Use custom header
- Specify custom headers for the transport for the SOAP over MQ feature that is provided by WebSphere MQ. This feature uses a predetermined MQ message format (RFH2), therefore, when selected, other Message Descriptor options are disabled.
Security for Request
Use this page to edit the security algorithm stacks that the security protocol applies to service requests before they are sent. Security stacks are a set of algorithms that are executed in a given order.
- Override WSDL Security Editor settings
- By default, you edit the security algorithm stack attached to a specific WSDL file in the WSDL Security Editor. Select this option to specify a different security algorithm stack only for the current service request.
- Security Algorithm Details
- Click Add, Insert, or Remove to add or remove security algorithms in the stack. Click Up and Down to change the order of a selected algorithm in the security stack. The following security algorithms can be added to the security stack:
- Time Stamp
- The time stamp security algorithm adds time stamp information to the XML document in the response. For details on security algorithms, refer to the Web service security specification.
- Actor / role name
- Specify the name of the actor, if required.
- Must understand
- Select whether the security algorithm needs to be understood.
- Time stamp
- Specify the delay before adding the time stamp.
- User name token
- The user name token security algorithm adds a user name token to the XML document in the response. For details on security algorithms, refer to the Web service security specification.
- Actor / role name
- Specify the name of the actor, if required.
- Must understand
- Select whether the security algorithm must be understood.
- Name
- Type the name of the user.
- Password
- Type the password of the user.
- Password type
- Specify the password type for the security algorithm.
- XML Encryption
- The XML encryption security algorithm specifies how the XML document is encrypted. For details on security algorithms, refer to the Web service security specification.
- Actor / role name
- Specify the name of the actor, if required.
- Must understand
- Select whether the security algorithm must be understood.
- Identifier type
- Select the type of key identifier to be used for the encryption:
- ISSUER_SERIAL
- BST_DIRECT_REFERENCE
- X509_KEY_IDENTIFIER
- SKI_KEY_IDENTIFIER
- EMBEDDED_KEYNAME
- THUMBPRINT_IDENTIFIER
- User XPath part selection
- This enables you to specify an XPath query that describes parts of the XML document that can be subjects of the algorithm. By default, the body is the subject.
- Key
- Select the key used for the encryption. The details of each key vary.
- x509 key: This specifies the name and password of the x509 key and the key store where it is located.
- Raw key: This specifies the name and the byte value of key in hexadecimal.
- User name token key: This specifies a user name and password for the token.
- Encrypted key: This specifies an encrypted key that was previously defined in the security stack. Click Insert a new encrypted key to create a new encrypted key definition block.
- Key Encoding Algorithm
- Specify the standard algorithm for encoding the transport key.
- XML Signature
- The XML signature security algorithm specifies how the XML document is signed. For details on security algorithms, refer to the Web service security specification.
- Actor / role name
- Specify the name of the actor, if required.
- Must understand
- Specify whether the security algorithm needs to be understood.
- Identifier type
- Select the type of key identifier to be used for the encryption:
- ISSUER_SERIAL
- BST_DIRECT_REFERENCE
- X509_KEY_IDENTIFIER
- SKI_KEY_IDENTIFIER
- EMBEDDED_KEYNAME
- KEY_VALUE
- USER_NAME_TOKEN
- CUSTOM_SYMM_SIGNATURE
- User XPath part selection
- Specify an XPart query that describes parts of the XML document that can be subjects of the algorithm. By default, the body is the subject.
- Key
- Select the key used for the encryption. The details of each key vary.
- x509 key: This specifies the name and password of the x509 key and the key store where it is located.
- Raw key: This specifies the name and the byte value of key in hexadecimal.
- User name token key: This specifies a user name and password for the token.
- Encrypted key: This specifies an encrypted key that was previously defined in the security stack. Click Insert a new encrypted key to create a new encrypted key definition block.
- Signature algorithm name
- Specify the standard algorithm to be used for the signature.
- Canonicalization
- Specify the algorithm to be used for canonicalization.
- Encrypted Key
- This block defines an encrypted key that can be used in an XML signature or XML encryption block. The encrypted key block must be before a block that uses the encrypted key.
- Actor / role name
- Specify the name of the actor, if required.
- Must understand
- Specify whether the security algorithm needs to be understood.
- Key name
- Specify the name of the encrypted key.
- Identifier type
- Select the type of key identifier to be used for the encryption:
- ISSUER_SERIAL
- BST_DIRECT_REFERENCE
- X509_KEY_IDENTIFIER
- EMBEDDED_KEYNAME
- THUMBPRINT_IDENTIFIER
- SKI_KEY_IDENTIFIER
- Key size
- Specify the size of the key in bits.
- Key encoding algorithm name
- Specify the algorithm to be used for encoding the key.
- Keystore
- Select a keystore or click Edit Security to define a new keystore or to manage the existing keystores.
- Name
- Select a key contained in the specified keystore.
- Password
- Type the password for the selected key name.
- Custom Security Algorithm
- If you have implemented a Java class as a custom security algorithm, then use this stack element to apply the custom algorithm to the service.
- Name
- Specify the name of the custom security algorithm.
- Implementation class
- Specify the name of the class that implements the custom security algorithm. Click Browse to select a Java class from the workspace.
- Properties
- Use this table to send any specific properties and associated values to the custom security algorithm.
- WS-Addressing Algorithm
- Add this stack if service uses either WS-Addressing 2004/08 or the WS-Addressing 1.0 Core standard.
- Namespace
- Specify the namespace for either WS-Addressing 2004/08 or WS-Addressing 1.0 Core.
- Action if request uses WS-Addressing
- Select the action to perform if WS-Addressing is already in the request.
- Replace anonymous address in Reply-to with:
- Select this option to generate the specified address in the Reply-to header instead of an anonymous address.
- Remove WS-Addressing from response
- Strip any WS-Addressing headers from the response.
Security for Response
Use this page to edit the security algorithm stacks that the security protocol applies to responses after they are received. Security stacks are a set of algorithms that are executed in a given order.
- Override WSDL Security Editor
- By default, you edit the security algorithm stack attached to a specific WSDL file in the WSDL Security Editor. Select this option to specify a different security algorithm stack only for the current response.
- Security Algorithm Details
- Click Add, Insert, or Remove to add or remove security algorithms in the stack. Click Up and Down to change the order of a selected algorithm in the security stack. The following security algorithms can be added to the security stack:
- XML Encryption
- The XML encryption security algorithm specifies how the XML document is encrypted. For details on security algorithms, refer to the Web service security specification.
- Actor / role name
- Specify the name of the actor, if required.
- Must understand
- Select whether the security algorithm must be understood.
- Identifier type
- Select the type of key identifier to be used for the encryption:
- ISSUER_SERIAL
- BST_DIRECT_REFERENCE
- X509_KEY_IDENTIFIER
- SKI_KEY_IDENTIFIER
- EMBEDDED_KEYNAME
- THUMBPRINT_IDENTIFIER
- User XPath part selection
- This enables you to specify an XPath query that describes parts of the XML document that can be subjects of the algorithm. By default, the body is the subject.
- Key
- Select the key used for the encryption. The details of each key vary.
- x509 key: This specifies the name and password of the x509 key and the keystore where it is located.
- Raw key: This specifies the name and the byte value of key in hexadecimal.
- User name token key: This specifies a user name and password for the token.
- Encrypted key: This specifies an encrypted key that was previously defined in the security stack. Click Insert a new encrypted key to create a new encrypted key definition block.
- Key Encoding Algorithm
- Specify the standard algorithm for encoding the transport key.
- Encrypted Key
- This block defines an encrypted key that can be used in an XML signature or XML encryption block. The encrypted key block must be before a block that uses the encrypted key.
- Actor / role name
- Specify the name of the actor, if required.
- Must understand
- Specify whether the security algorithm needs to be understood.
- Key name
- Specify the name of the encrypted key.
- Identifier type
- Select the type of key identifier to be used for the encryption:
- ISSUER_SERIAL
- BST_DIRECT_REFERENCE
- X509_KEY_IDENTIFIER
- EMBEDDED_KEYNAME
- THUMBPRINT_IDENTIFIER
- SKI_KEY_IDENTIFIER
- Key size
- Specify the size of the key in bits.
- Key encoding algorithm name
- Specify the algorithm to be used for encoding the key.
- Keystore
- Select a keystore or click Edit Security to define a new keystore or to manage the existing keystores.
- Name
- Select a key contained in the specified keystore.
- Password
- Type the password for the selected key name.
- Custom Security Algorithm
- If you have implemented a Java class as a custom security algorithm, then use this stack element to apply the custom algorithm to the service.
- Name
- Specify the name of the custom security algorithm.
- Implementation class
- Specify the name of the class that implements the custom security algorithm. Click Browse to select a Java class from the workspace.
- Properties
- Use this table to send any specific properties and associated values to the custom security algorithm.