Copyright © Cloud Software Group, Inc. All Rights Reserved

Partner Link Configuration

Shared Resource

The Partner Link Configuration associates abstract partner portTypes with concrete port bindings. This allows you to easily link to new partner services without changing processes that invoke the partners.

See Partners for more information about partners and Partner Link Configuration resources.

Configuration

The Configuration tab has the following fields.

Field	Global Var?	Description
Name	No	The name to appear as the label for the resource.
Description	No	Short description of the resource.
Partner Links	No   Yes       No       No	Use the + button to add partner links to the list, use the X button to delete partner links from the list, use the arrow buttons to move partner links up and down in the list. Specify the following in the columns of the table for each partner: • Name : Double-click on this field to specify a name for the partner. • Timeout : Double-click on this field to specify a timeout in milliseconds (msec) for invocations of this partner. By default, the timeout is zero (0) which provides an unlimited amount of time for invocations. • Service Endpoint — The endpoint of the service. You can use concrete WSDL resources with port bindings or you can specify local service resources with Local specified in the endpoint binding. • Endpoint Type — By default the field selection is SOAP. It can be used when we check enable for AMX check box and change to AMX endpoint. This endpoint of the service populated from the concrete WSDL.
Attachment Style	No	This field allows you to choose the attachment style for the outbound/response messages. Two attachment styles are available: SwA and MTOM.
Operations	No	The operation that this process definition implements. The drop down list in this field is populated with the operations contained in the specified port type in the specified WSDL. You can choose one operation to implement per process definition. If you want to implement multiple operations, you must create a process definition for each.
SOAP Action	Yes	The soapAction that is expected from incoming SOAP requests. This field is required, and by default, the operation name is used as the soapAction. Each operation in an interface must have a unique value for SOAP Action. See the SOAP specification for more information about soapAction. Note - When Partner Link Configuration is created, these fields get populated with the values from concrete WSDL. You can override these values in Partner Link Configuration. If the concrete WSDL is changed after configuring Partner Link Configuration, the changes will not be visible in the Partner Link Configuration.
Additional Configuration for HTTP Endpoints
EndPoint URI	No	It will have the endpoint of the service populated from the concrete WSDL. Note - When Partner Link Configuration is created, this field get populated with the values from concrete WSDL. You can override these values in Partner Link Configuration. If the concrete WSDL is changed after configuring Partner Link Configuration , the changes will not be visible in the Partner Link Configuration.
Use HTTP Proxy	No	Specifies to use a proxy server to gain access outside of a firewall.
Proxy Name	No	Host name or IP address of the proxy server.
HTTP Authentication	No	Specifies what authentication should be used. An authentication can be of the following three types: • NONE — is default. • BASIC — to continue with the current implementation of using username and password credentials. The Identity field appears when this field is enabled. • NTLM — Identity and Domain fields appear when NTLM is selected. Identity is a reference of the Username and Password combination.
Identity	No	When Basic and NTLM authentication (username and password) is required, provide an Identity resource in this field that contains the appropriate username and password. See TIBCO Designer Palette Reference for more information.
Domain	No	Specifies the domain to be used for Authentication. The user name and password specified in the Identity field must exist in the domain.
SSL	No	When SSL is required for authentication to the service, click the Configure SSL button to supply the appropriate properties. See HTTP SSL Configuration Fields for more information.
HTTP SSL Configuration Fields
Trusted Certificates Folder	No	Folder in the project containing one or more certificates from the trusted certificate authorities. This folder is checked when an invocation is made to the partner service to ensure that the server is trusted. This prevents connections to rogue servers.
Identity	No	This is an identity resource that contains the client’s digital certificate and private key. See TIBCO Designer Palette Reference for more information.
Strong Cipher Suites Only	No	Specifies that only cipher suites with strong encryption should be used, if they are available on the host you are connecting to.
Additional Configuration for JMS Endpoints
JNDI Tab
Context URL	Yes	Th URL for the JNDI connection to the JMS server (javax.naming.Context.PROVIDER_URL).
User Name	Yes	The user name for logging into the JNDI server (javax.naming.Context.SECURITY_PRINCIPAL). If the JNDI provider does not require access control, this field can be empty.
Password	Yes	The password for logging into the JNDI server (javax.naming.Context.SECURITY_CREDENTIALS). If the JNDI provider does not require access control, this field can be empty.
Connection Factory	Yes	The QueueConnectionFactory or TopicConnectionFactory object stored in JNDI. This object is used to create a queue connection with a JMS application. The value for this field is taken from the WSDL file, if it is available in the <jms:connectionFactory> element in the service specification. You can override the supplied value, if you want to use a different connection factory. See your JNDI provider documentation for more information about creating and storing QueueConnectionFactory objects.
SSL	No	When SSL is required for authentication to the service, click the Configure SSL button to supply the appropriate SSL information. See JMS SSL Configuration Fields for more information.
JMS Tab
Use Shared JMS Configuration	No	Check this field if you want to specify a JMS Connection shared configuration resource to override the JMS transport parameters in the concrete WSDL. When checked, the JMS Connection field appears. Note - When selected, the JNDI fields get disabled.
JMS Connection	No	This field only appears when the Use Shared JMS Configuration field is selected. This field allows you to specify a JMS Connection shared configuration resource that contains the connection information you want to use.
User Name	Yes	User name to use when logging into the JMS server. If the JMS provider does not require access control, this field can be empty.
Password	Yes	Password to use when logging into the JMS server. If the JMS provider does not require access control, this field can be empty.
JMS Destination	Yes	This field is available when a JMS transport is selected. This field specifies the name of the destination for incoming JMS messages for this service. The syntax of the destination name is specific to the JMS provider you are using. See your JMS provider documentation for more information about destination names. Note: If you are using TIBCO Enterprise Message Service as your JMS provider, you can use the Browse button next to this field after specifying a valid connection in the JMS Connection field. The Browse button displays a list of configured destinations in the JMS server that are appropriate for this activity.
Delivery Mode	No	The delivery mode of the message. It can be one of the following: • Persistent : signifies the messages are stored and forwarded. • Non-Persistent : messages are not stored and may be lost due to failures in transmission. • TIBCO EMS Reliable: this mode is only available when using TIBCO Enterprise Message Service. See the TIBCO Enterprise Message Service documentation for more information about this mode.
Expiration	No	Corresponds to JMSExpiration property that specifies how long the message can remain active (in seconds). If set to 0, the message does not expire. This field is set in seconds, but the JMSExpiration property is displayed in milliseconds.
Priority		Priority of the message. You may set the priority to a value from 0-9. The default value is 4.
Enable W3C SOAP JMS 1.0 Compliance	No	This is a read-only field that displays whether the service is W3C SOAP Over JMS 1.0 compliant or not.
Target Service	No	This field is available only when the check box Enable W3C SOAP JMS 1.0 Compliance is selected. Specify the target service value, if any. Note: If Target Service is configured, the value is reflected in the WSDL as a query parameter.
Note - When Partner Link Configuration is created, these fields get populated with the values from concrete WSDL. You can override these values in Partner Link Configuration. If the concrete WSDL is changed after configuring Partner Link Configuration, the changes are not visible in the Partner Link Configuration.
JMS SSL Configuration Fields
Basic Tab Trusted Certificates Folder	No	Folder in the project containing one or more certificates from trusted certificate authorities. This folder is checked when an invocation is made to the partner service to ensure that the server is trusted. This prevents connections to rogue servers.
Basic Tab Identity	No	This is an identity resource that contains the client’s digital certificate and private key. See TIBCO Designer Palette Reference for more information.
Advanced Tab Trace	No	Specifies whether SSL tracing should be enabled during the connection. If checked, the SSL connection messages are logged and sent to the console.
Advanced Tab Debug Trace	No	Specifies whether SSL debug tracing should be enabled during the connection. Debug tracing provides more detailed messages than standard tracing.
Advanced Tab Verify Host Name	No	This field specifies to check the host name of the server against the host name listed in the server’s digital certificate. This provides additional verification that the host name you believe you are connecting to is in fact the desired host. If the host name specified in the endpoint binding is not an exact match to the host name specified in the server’s digital certificate, the connection is refused. Note: If an equivalent host name (for example, an IP address) is specified in the endpoint binding, but the name is not an exact match of the hostname in the host’s digital certificate, the connection is refused.
Advanced Tab Expected Host Name	No	Specifies the name of the host you are expecting to connect to. This field is only relevant if the Verify Host Name field is also checked. If the name of the host in the host’s digital certificate does not match the value specified in this field, the connection is refused. This prevents hosts from attempting to impersonate the host you are expecting to connect to.
Advanced Tab Strong Cipher Suites Only	No	When checked, this field specifies that the minimum strength of the cipher suites used can be specified with the bw.plugin.security.strongcipher.minstrength custom engine property. See TIBCO ActiveMatrix BusinessWorks Administration for more information about this property. The default value of the property disables cipher suites with an effective key length below 128 bits. When this field is unchecked, only cipher suites with an effective key length of up to 128 bits can be used.

Advanced SOAP Settings

For each operation, you can specify advanced configuration options. To access the advanced configuration options, perform the following:

1.	Select Partner Link.

2.	Select the operation.

The Advanced SOAP Settings dialog appears. The following sections describe the tabs on this dialog.

Input Headers

The Input Headers tab allows you to specify a SOAP message parts used for any SOAP Undescribed headers expected in the Outgoing Request.

Use the +, X, and arrow keys to add, delete and move the input header messages in the list.

The Input Headers tab has the following fields.

Field	Description
Part Name	This field contains a drop-down list with all parts of the specified SOAP message. You can specify a cardinality for the part, if applicable.
Message Name	The message in a WSDL file to use as the Undescribed input header for the outgoing SOAP request. This WSDL file does not have to be the same as the file used for output headers or the file used to configure the port type and operation of the incoming request. Use the Browse button in this field to search for valid WSDL File resources and to select the desired message in the WSDL File.
Undescribed	Select this check box to declare the header as Undescribed header.
Cardinality	This field contains a drop-down list with two options: Repeating and Optional.

Output Headers

The Output Headers tab allows you to specify a SOAP message part used for any SOAP undescribed headers expected in the Incoming Response.

Use the +, X, and arrow keys to add, delete and move the input header messages in the list.

The Output Headers tab has the following fields.

Field	Description
Part Name	This field contains a drop-down list with all parts of the specified SOAP message. You can specify a cardinality for the part, if applicable.
Message Name	The message in a WSDL file to use as the undescribed output header for the SOAP incoming response. This WSDL file does not have to be the same as the file used for input headers or the file used to configure the port type and operation of the incoming request. Use the Browse button in this field to search for valid WSDL File resources and to select the desired message in the WSDL File.
Undescribed	Select this check box to declare the header as Undescribed header.
Cardinality	This field contains a drop-down list with two options: Repeating and Optional.

Input Context

The Input Context tab allows you to specify a Context Resource that contains transport-specific data. The data you provide to the context resource is available to the process definition that implements the operation.

The Input Context tab has the following fields.

Field	Description
Context	The Context Resource that specifies the schema you want to use. The schema of this resource should include elements for each data element you want to provide to the output Headers for the message.
Mapping Panel	The mapping panel is similar to the mapping panel provided in the Input tab of activities. This panel allows you to map transport-specific information. Using this you can send the information as part of the Undescribed header in a SOAP Request message to the Service. The mapping panel appears only when a Context resource is specified in the Context field.
inputMessage	The root class for the input of the SOAP Request Reply activity. This class contains all input items for the activity. If this is a document request, the input is named inputMessage. If the request is an RPC, the input is the name of the operation.
Transport Properties - HTTP
Headers
Accept	This field specifies media types that are acceptable for response messages for the incoming request. For example, text/*, text/html. Media types are described in the HTTP specification. If no Accept header field is present, then it is assumed that the client accepts all media types.
Accept-Charset	This field specifies the character sets that are acceptable for response messages for the incoming request. For example, iso-8859-5, unicode-1-1. Character sets are described in the HTTP specification. If no Accpet-Charset header is present, then it is assumed that the client accepts any character set.
Accept-Encoding	This field specifies the content-coding values that are acceptable for response messages. For example compress, gzip. See the HTTP specification for more information about this header field.
Cookie	See the HTTP specification for more information about this field.
Pragma	This field is used to include implementation-specific directives that might apply to the receiver. See the HTTP specification for more information about using this field.
undescribed Headers
Authentication Credentials
user name	Username for logging into the HTTP server. This overrides the value specified in the Identity resource. Note: You can override the user name only if the activity is configured for Basic or NTLM authentication.
password	Password for logging into the HTTP server. This overrides the value specified in the Identity resource. Note: You can override the password only if the activity is configured for Basic or NTLM authentication.
domain	Domain for logging into the HTTP server. This overrides the value specified in the configuration. Note: You can override the domain name only if the activity is configured for NTLM authentication.

Output Context

The Output Context tab allows you to specify a Context Resource that contains data the process definition implementing the operation has provided. The data can then be mapped to Undescribed Headers of the output message returned to the client.

The Output Context tab has the following fields.

Field	Description
Shared Context	The Context Resource that specifies the schema you want to use. The schema of this resource should include elements for each data element you want to provide to the output Undescribed Headers for the message.
Expose Security Checkbox	Selecting this check box meant for Security Context Propagation and Security Context, makes it available as a transport data in the mapping panel.
Mapping Panel	The mapping panel is similar to the mapping panel provided in the Input tab of activities. This panel allows you to map Input Context data provided by the implementation of the operation to the transport-specific Undescribed headers of the reply message sent to the client. The mapping panel appears only when a Context resource is specified in the Context field.
outputMessage	The root class for the output of the SOAP Request Reply activity. This class contains all output items for the activity. If this is a document request, the output is names outputMessages. If the request is an RPC, the output is the name of the operation with "Response" appended.
mimeEnvelopeElement	This element contains the reply message attachments when mime attachments are used. This element contains a repeating element named mimePart that contains each mime attachment.
mimeHeaders	This element contains the mime header for each mimePart. Mime headers can contain the following information: • content-disposition • content-type • content-transfer-encoding • content-id • other mime header information Note: When the content type is specified as "text/*" (for example, "text/xml"), the attachment content is expected to be in either the textContent input element or the file name storing the attachment is expected to be in the fileName input element. When the content type is anything other than "text/*", the attachment content is expected to be in either the binaryContent input element or the file name storing the attachment is expected to be in the fileName input element.
binaryContent |textContent |fileName	This element contains the mime attachment. The element can be one of the following: • binaryContent — content of the attachment when the attachment is binary data. • textContent — content of the attachment when the attachment is text data. • fileName — the file name of the attachment when the Write to File field is checked on the Input Attachment Bindings sub-tab of the Advanced tab.
Transport Properties - HTTP
Headers
Allow	This field lists the set of methods supported by the resource identified by Request URI.
Content-Type	This field indicates the media type of the entity body for the outgoing message and the incoming response. Media types are described in the HTTP specification. An example of the media type is text/html; charset=ISO-8850-4.
Content-Length	This field indicates the size of the entity body (in decimal number of OCTETs) of the response message.
Content-Encoding	This field is used as a modifier to the content-type. When present, its value indicates what additional content encodings have been applied to the entity-body, and thus what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type header field. Content-Encoding is primarily used to allow a document to be compressed without losing the identity of its underlying media type. See the HTTP specification for more information about this field.
Date	The date and time when the response message was sent.
Location	This field is used to redirect the receiver to a location other than the Request-URI for completion of the request or for identification of a new resource.
Set-Cookie	See the HTTP specification for more information about this field.
Pragma	This field is used to include implementation-specific directives that might apply to the receiver. See the HTTP the HTTP Specification for more information about using this field.

Fault Context

The Fault Context tab allows you to select a shared Context Resource that is set with SOAP fault attributes. The data can then be mapped to Fault elements of the Fault message returned to the client.

The Fault Context tab has the following fields.

Field	Description
Context	The Context Resource that specifies the SOAP fault schema you want to use. The schema of this resource should include elements for each data element you want to provide the Fault elements for the fault message. Note: For Fault Context propagation you must map Fault elements to the Context data.
Expose Security Context	Selecting this check box meant for Security Context Propagation and Security Context, makes it available as a transport data in the mapping panel.
Mapping Panel	The mapping panel is similar to the mapping panel provided in the Input Context tab of activities. This panel allows you to map data provided by the implementation of the operation to the transport-specific Undescribed headers of the reply message sent to the client. The mapping panel appears only when a Context resource is specified in the Shared Context field. The Transport Data shows the Global Variables and the Context Data shows the Context resource element.

 

Copyright © Cloud Software Group, Inc. All Rights Reserved