Common conrefs

Service request

The service request element contains the contents of the request and the transport information for this request. The contents is made of the SOAP envelope. The transport information refers to the information that is required to send, receive, and answer depending on the selected protocol.

Update request name automatically

Select this option to automatically rename the request in the Test Contents view.

Do not wait for response

Select this option to skip directly to the next request in the test after the current request is sent.

Operation and WSDL Name

These identify the WSDL name and operation to which the service request is binded.

WSDL Resource

This is the name of the WSDL resource in the workbench. Click the link to edit the WSDL file. If the WSDL file is missing, click the link to bind the request to a WSDL in the workspace or to import a WSDL.

Time Out (ms)

This is the timeout value in milliseconds. If no response is received after the specified time, an error is produced.

Think Time (ms)

This specifies the programmatically calculated time delay that is observed for each user when this test is run with multiple virtual users. Think time is a statistical emulation of the amount of time actual users spend reading or thinking before performing an action.

Update Response

Click this button to invoke the request with the current settings and to use the response to create a service response element or to update the existing response element.

Message

This page presents the XML contents of the request and provides access to data correlation. The same contents are presented in three views: Form, Tree, and Source.

Attachments

This page lists the MIME attachments that are attached to the request. The contents of this view conform to the Multipurpose Internet Mail Extensions (MIME) specification. You can use this page to add workbench resources as MIME attachments and change properties.

Transport

This page covers the transport protocol used to send the request. The transport protocol can be either HTTP, Java™ Message Service (JMS), or WebSphere® MQ. You can create several configurations for each protocol so that you can easily switch protocols or variants of protocols.

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.

Security for Response

Use this page to edit the security algorithm stacks that the security protocol applies to service requests after they are received. Security stacks are a set of algorithms that are executed in a given order.

Response page

These pages present the XML contents of the response and provide access to data correlation.

Message

This page presents the XML contents of the request and provides access to data correlation. The same contents are presented in Form, Tree or Source view.

Attachments

This page lists the MIME attachments that are attached to the response. The contents of this view conform to the Multipurpose Internet Mail Extensions (MIME) specification. You can use this page to retrieve MIME attachments as workbench resources.

Response Properties

This page lists the names and values of properties of the response.

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 your 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 if you want 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.

Important: 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.

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 easily 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 new 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 that are 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 new 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 new 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

Select this option to 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

Select this option to 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.

Protocol configuration

This page covers the transport configuration that is used to send a request. Transport configurations contain predefined settings that can be reused in multiple tests or service requests. You can create several configurations for each protocol so that you can easily 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.

Keep connection alive

Select this option to keep the connection open after the request.

SSL certificate

Select this option to use an SSL configuration. Click Open SSL Editor to create an SSL configuration or select an existing configuration.

Server authentication

In this section, specify the type of authentication that is required to access the service. Select None if no authentication is required.

Basic authentication

Select this option to specify the User Name and Password that are used for basic authentication.

NTLM authentication

Select this option to use the Microsoft® NT LAN Manager (NTLM) authentication protocol. NTLM uses challenge-response authentication. This view lists what is negotiated (supported by the client and requested of the server) and what is authenticated (the client reply to the challenge from the server).

Kerberos authentication

Select this option to use the Kerberos authentication protocol between the client and server.

Connect through proxy server

Specify the Address and Port of a proxy server. If the proxy requires authentication, select Basic proxy authentication.

Proxy authentication

In this section, specify the type of authentication that is required to access the proxy. Select None if no authentication is required.

Basic authentication

Select this option to specify the User Name and Password that are used for basic authentication.

NTLM authentication

Select this option to use the Microsoft NT LAN Manager (NTLM) authentication protocol. NTLM uses challenge-response authentication. This view lists what is negotiated (supported by the client and requested of the server) and what is authenticated (the client reply to the challenge from the server).

Kerberos authentication

Select this option to use the Kerberos authentication protocol between the client and server.

Message transformation custom code class

Select this option if communication requires complex, low-level processing with a custom Java code. Click Browse to select a Java class that uses the corresponding API. See Extending Rational Performance Tester for more information about using the custom code API.

JMS

Select JMS to use the Java Messaging Service transport for the request. On this page, you can add string properties that are attached to the request for a local JMS configuration. These properties are sent as message properties through JMS.

Destination style

This is the style of the JMS destination. Select either Topic or Queue.

End point address

This is the address of the destination.

Use temporary object

Select this option to send the JMS destination as a temporary object. For a JMS queue, a temporary JMS queue is sent in the message.

Reception point address

If Use temporary object is disabled, specify the JMS address of the destination endpoint.

Basic authentication

Select this option to specify the User Name and Password that are used for basic authentication.

Custom adapter class name

Set up a custom Java Naming and Directory Interface (JNDI) vendor adapter for this configuration. To use a custom adapter, you must write a Java class that extends the Axis class and methods. Specify the name of your custom adapter class in Adapter class name.

Text message

Specify whether the message is a text or a byte message.

Context factory properties

Edit the properties for a context factory. Click Add to add string properties to the context factory configuration.

Connector properties

Edit the properties for a connector. Click Add to add string properties to the connector configuration. The product supports the following connectors:

• JMS priority
• JMS delivery mode
• JMS time to live

WebSphere MQ

Select MQ to use the IBM WebSphere MQ transport for the request. On this page, you can specify the SOAP action and override the settings for the WebSphere MQ configuration that is selected at the test level.

Queue Manager

Use this area to specify queue manager options for the service.

Queue manager name

Specify the name of the queue manager to which to send the request.

Use local queue manager

Select this option to use a local queue manager. If you disable this option, specify the following information:

Queue manager address

Specify the IP address or host name of the remote MQ server.

Queue manager port

Specify the listener port of the remote MQ server.

Client channel

Specify the server-connection mode channel of the remote queue manager.

Queues

Use this area to specify the send queue options for the service.

Send queue name

Specify the name of the queue that the queue manager manages.

Use temporary queue for response

Specifies whether the MQ server creates a temporary queue. If selected, the temporary queue is created for the sole purpose of receiving specific messages, and then deleted.

Receive queue name

If Use temporary queue is cleared, this option specifies the queue manager that is specified on the Queue manager name line. The specified queue manager must manage this queue.

Use RFH2 header

Select whether to use the transport for 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.

SSL connection

Select this option to use an SSL configuration if a Client Channel setting refers to a secure channel. Click Open SSL Editor to create an SSL configuration or Change to change the SSL configuration that is associated with the current test.

If the WSDL that you use to create the message request uses a supported JMS URI to point to the WebSphere MQ server, then the SSL configuration is created automatically. If the test generator is unable to create the SSL configuration, you must create a new one manually.

If the WSDL is generated with the WebSphere MQ service (amqwdeployWMService), you must edit the WSDL to change the transport binding from HTTP to JMS to prevent the test generator from producing an HTTP configuration.

Cipher suite

Specify the cipher suite that is used in the channel configuration.

Message Descriptor

Configure the fields of the request. 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.

Target service

When using Microsoft .NET framework with the SOAP over MQ feature of WebSphere MQ, specify the name of the target service for the WSDL.

Response Properties

This page lists the names and values of properties of the response.

Security for Request

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 user's password.

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 your 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 your 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 your 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

Select this option to strip any WS-Addressing headers from the response.

Security for Response

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 your 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.

Keystores

Defined Keystores

Click Add or Remove to add or remove keystore files from the workbench.

Keystore Details

Specify a keystore, which contains either trusted server certificates or client certificates that must be provided to the server.

File

Click Browse to specify a KS (keystore), JKS (Java keystore), or JCEKS (Java Cryptography Extension keystore) file containing a valid server certificate.

Password

If the keystore file is encrypted, type the required password.

SSL configuration

Define an SSL configuration for certificate authentication between the client and the server. SSL configurations can be used by any message request in the test. If you use multiple SSL configurations in the test, you must specify the configuration in each message request.

The default SSL configuration always trusts servers, which is equivalent to no authentication.

Configured SSL

Select an existing SSL configuration or create one. You can use the toolbar push buttons to create a New SSL configuration and to Rename or Delete existing SSL configurations. You can also Copy and Paste SSL configurations to and from the SSL editor and the test editor.

Single Authentication

This section describes how the client trusts the server.

Always trust server

Select this option if no authentication is required or to ignore server certificates so that all servers are trusted. If you are using single authentication and you want to accept trusted servers only, then disable this option and specify a truststore that contains the trusted server certificates.

Client truststore

When you are using single authentication, the client truststore contains the certificates of all trusted servers. Click Browse to specify a KS, JKS, or JCEKS file containing valid certificates of the trusted servers.

Password

If the client truststore file is encrypted, type the password required to access the file.

Double Authentication

This section describes how the server trusts the client.

Use client certificate

If you are using double authentication, select this option to specify a keystore containing the client certificate. This certificate allows the server to authenticate the client.

Client certificate keystore

Click Browse to specify a KS, JKS , or JCEKS file containing a valid certificate that will authenticate the client.

Password

If the client truststore file is encrypted, type the password required to access the file.

Binary Editor Preferences

Use this page to configure the appearance of the binary editor.

Encoding used to display binary data

Select the default encoding type for the character column of the binary editor.

Colors

Click the color buttons to change the foreground and background colors used to display in the binary editor.

Fonts

Click the Choose buttons to change the font type and size for each column of the binary editor.

Special Characters

Specify the characters to use for displaying ISO controls, non-character byte sequences, and invalid bytes in the character column.

Preview

This area displays a preview of the appearance of the binary editor with the current settings.