Managing Oracle WebLogic Integration Solutions

Trading Partner Management Schema

This section describes the schema for Trading Partner Management (TPM) data that you can exchange with the TPM repository using:

TPM Overview

The TPM schema allows you to configure Oracle WebLogic Integration to share information among trading partners by defining the following:

A trading partner can have one or more service bindings that use different transport protocols for the exchange of documents. Each transport can use a variety of security authentication options, for client, server, signing, and messaging roles. The TPM schema allows you define the complete set of communication and configuration options for all trading partners.

Architecture: Trading Partners and Services

The root element of the TPM schema is the trading-partner-management element. The element provides logging and messaging options, and contains the two essential child elements for any configuration:

The service element is rather simple and contains the following elements:

The trading-partner element is far more complex. The following illustrations present the entity relationships among its elements.

Protocols and Security

The TPM schema provide configuration options for communication using the following service protocols:

The TPM schema provide settings for the authentication of trading partners as they send messages using these protocols at runtime for:

You configure these security and authentication options using:

The individual binding elements for each of the protocol services support non-repudiation by digitally signing outbound messages and acknowledgements based on the attributes that require signatures on messages and acknowledgement receipts. You can securely log message information as well.

The TPM schema supports the use of password aliases so you can refer to the password aliases in the Oracle WebLogic Integration password store. To learn more about password security, see Password Aliases and the Password Store section in Using Oracle WebLogic Integration Administration Console .

Extensibility

You can include custom information unique to your business needs using extended property sets. The extended-property-set allows any XML elements and attributes to be specified as child nodes of the extended-property-set element. To learn more about extending TPM schema, see extended-property-set Element.

Test Mode

You can deploy your TPM options in a development environment without the need to specify explicit service profiles between trading partners. The test mode attribute on the trading-partner-management element allows you to test and deploy TPM business settings using the default bindings for your trading partners. This mode does not require separate service profiles to be set up for each pair of partners that exchange business messages.

To learn more about using test mode, see trading-partner-management Element.

Related Topics

Refer to Trading Partner Management section in Using Oracle WebLogic Integration Administration Console to learn more about using the Oracle WebLogic Integration Administration Console for TPM.

For more information about trading partner integration controls, see TPM Control, RosettaNet Control, and ebXML Control in Using Oracle WebLogic Integration Controls.

For more information about using the Bulk Loader, see Using the Trading Partner Bulk Loader.

For more information aboutXML, see the W3C Recommendation, XML-Signature Syntax and Processing at the Web site of the W3C.

To learn more about the ebXML protocol, see the ebXML Collaboration-Protocol Profile and Agreement Specification - Version 2.0 at the Oasis Web site.

For more information about:

Address Element

This element defines the external business address for a trading partner.

Syntax

<address>partnerMailAddress</address>

Attributes

None

Type

xs:string

References

To

Children

Hierarchy

Used By

Children

Authentication Element

This element specifies the authentication properties for a remote client that connects to the parent transport endpoint.

Syntax

<authentication>
	client-partner-name="tradingPartnerReference"
	client-authentication=				"BASIC
					|NONE
					|SSL_CERT_MUTUAL"
	username="loginName"
	password-alias="clientPassword"
	client-certificate-name="certificateReference"
	server-authentication=				"NONE
					|SSL_CERT"
	server-certificate-name="certificateReference"/>

Attributes

References

To

From

Hierarchy

Used By

Children

client-certificate Element

This element defines a digital certificate of a trading partner for client authentication access to a Oracle WebLogic Integration communication end point.

Syntax

<client-certificate 
	name="certificateName" 
	password-alias="keystoreEntryPasswordAlias">
	<ds:KeyInfo
	.
	.
	.
	</ds:KeyInfo>
</client-certificate>

Attributes

References

To

From

Hierarchy

Used By

Children

ebxml-binding Element

This element defines the ebXML business protocol specific bindings of the parent trading partner.

The ebXML protocol supports non-repudiation by digitally signing outbound messages and acknowledgements based on the attributes is-signature-required and is-receipt-signature-required.

Syntax

<ebxml-binding
	business-protocol-name="protocolName"
	business-protocol-version="versionNo"
	delivery-semantics=	"	[BESTEFFORT
				|ONCEANDONLYONCE
				|ATLEASTONCE
				|ATMOSTONCE]"
	is-default="[true|false]"
	is-receipt-signature-require="[true|false]"
	is-signature-required="[true|false]"
	name="bindingName"
	persist-duration="intervalNo"
	retries="retriesNo"
	retry-interval="retryIntervalNo"
	signature-certificate-name="signatureCertificate">
	<signature-transforms
	.
	.
	.
	/>
	<transport
	.
	.
	.
	/>
</ebxml-binding>

Attributes

Reference

To

From

Hierarchy

Used By

Children

encryption-certificate Element

This element defines a digital certificate for a trading partner for encrypting and decrypting exchanged messages.

Syntax

<encryption-certificate 
	name="certificateName" 
	password-alias="keystoreEntryPasswordAlias">
	<ds:KeyInfo
		.
		.
		.
	</ds:KeyInfo>
</encryption-certificate>

Attributes

References

To

From

Hierarchy

Used By

Children

extended-property-set Element

The extended-property-set element allows you to add custom XML nodes to your TPM configuration for your business needs.

The child elements are displayed within the repository as sub trees within an XML document, and can be nested.

<trading-partner name="ACMECORP" type="REMOTE" business-id="ACME-id">
	.
	.
	.
	<extended-property-set 
		name="ACME Corp Extension" 
		description="Contact Info" 
		notes="the number format is important"/>
		<business-contact>Joe Smith</business-contact>
		<phone type="work">+1 123 456 7654</phone>
		<phone type="cell">+1 321 654 4567</phone>
		<city>Anytown</city>
		<state>California</state>
	</extended-property-set>
</trading-partner>

Syntax

<extended-property-set
	name="propertyName"
	description="propertyDescription"
	notes="propertyNotes">
	<xmlElement
	.
	.
	.
	</xmlElement>

</extended-property-set>

Attributes

References

To

From

Hierarchy

Used By

Children

failure-notifier Element

This element represents the RosettaNet PIP failure notifier. It sends notification of failure (PIP0A1) messages to the appropriate trading partner and binding.

Syntax

<failure-notifier
	trading-partner-name="tradingPartnerReference"
	binding-name="bindingNameReference""/>

Attributes

References

To

From

Hierarchy

Used By

Children

failure-report-administrator Element

This element represents the RosettaNet PIP failure report administrator. It sends notification of failure (PIP0A1) messages to the appropriate trading partner and binding.

Syntax

<failure-report-administrator 
	trading-partner-name="tradingPartnerReference" 
	binding-name="bindingReference"/>

Attributes

References

To

From

Hierarchy

Used By

Children

reference simpleType

This references another element in the TPM repository.

Syntax

<reference>referenceName</reference>

Attributes

None

Type

xs:string

Hierarchy

Used By

Children

rosettanet-binding Element

This element defines the RosettaNet business protocol specific bindings for the parent trading partner.

The RosettaNet protocol supports non-repudiation by digitally signing outbound messages and acknowledgements based on the is-signature-required and is-receipt-signature-required attributes.

Syntax

<rosettanet-binding
	name="bindingName"
	business-protocol-name="businessProtocolName"
	business-protocol-version="businessProtocolVersion"
	is-default="[true|false]"
	encryption-certificate-name="encryptionCertificateName"	
	cipher-algorithm="[NONE|RC5|DES|TRIPLE_DES|RC2]"
	encryption-level="[NONE|PAYLOAD|ENTIRE_PAYLOAD]"
	is-signature-required="[true|false]"
	is-receipt-signature-required="[true|false]"
	signature-digest-algorithm="[SHA-1|MD5|None]"
	signature-certificate-name="signatureCertificateName"
	retries="noOfRetries"
	retry-interval="retryIntervalNo"
	process-timeout="processTimeoutNo">
	<failure-report-administrator/>
	<failure-notifier
	.
	.
	.
	/>
	<transport
	.
	.
	.
	/>
	</rosettanet-binding>

Attributes

References

To

From

Hierarchy

Used By

Children

rosettanet-service-defaults Element

This element specifies RosettaNet protocol-specific configuration attributes for a service.

Syntax

<rosettanet-service-defaults
	service-content-schema="schemaFilePath"
	use-dtd-validation="[true|false]"
	validate-service-content="[true|false]"
	validate-service-header="[true|false]"/>

Attributes

References

To

From

Hierarchy

Used By

Children

server-certificate Element

This element defines a digital certificate for a trading partner to authenticate the identity of a target server for an outbound connection.

Syntax

<server-certificate
	name="serverCertificateName"
	password-alias="password-alias_1">
	<KeyInfo
	.
	.
	.
	</KeyInfo>
	</server-certificate>

Attributes

References

To

From

Hierarchy

Used By

Children

service Element

This element represents a business process that a trading partner offers.

Syntax

<service
	name="serviceName"
	description="serviceDescription"
	notes="serviceNotes"
	service-type="[WEBSERVICE|PROCESS|SERVICECONTROL]"	
	business-protocol="[WEBSERVICE|EBXML|ROSETTANET]">
	<service-profile
	.
	.
	.
	/>
	<rosettanet-service-defaults
	.
	.
	.
	/>
</service>

Attributes

References

To

From

Hierarchy

Used By

Children

service-profile Element

This element defines the interactions that two B2B trading partners agree to carry out, along with a specification for the business protocol implementation details such as messaging characteristics, security constraints, transport mechanisms, and workflow processes. Links to appropriate bindings for each trading partner specify these characteristics.

Syntax

<service-profile 
	local-trading-partner="localTradingPartner"
	local-binding="localBinding"
	external-trading-partner="externalTradingPartner"
	external-binding="externalBinding"
	status="[ENABLED|DISABLED]"
	message-tracking="[NONE|DEFAULT|METADATA|ALL]"/>

Attributes

References

To

From

Hierarchy

Used By

Children

signature-certificate Element

This element identifies a digital certificate for a trading partner and digitally signs messages for the associated trading partner.

Syntax

<signature-certificate
	name="signatureCertificateName"
	password-alias="certificatePasswordAlias">
	<KeyInfo
	.
	.
	.

	/>

Attributes

References

To

From

Hierarchy

Used By

Children

signature-transforms Element

This element defines a sequence of optional XML data transformations for a digitally signed message, before Oracle WebLogic Integration signs the message. Oracle WebLogic Integration computes the message digest after performing transforms on the message.

Syntax

<signature-transforms>
	<xpath>xpath_expression-1</xpath>
	<xpath>xpath_expression-2</xpath>
	<xpath>xpath_expression-3</xpath>
</signature-transforms>

Attributes

None

References

To

From

Hierarchy

Used By

Children

trading-partner Element

A trading partner is a business entity with authorization to send and receive business messages in a conversation.

Syntax

<trading-partner
	name="tradingPartnerName"
	description="tradingPartnerDescription"
	notes="tradingPartnerNotes"
	status="[enabled|ENABLED|disabled|DISABLED]"
	type="[LOCAL|REMOTE]"
	is-default="[true|false]"
	business-id-type="businessIdType"
	business-id="businessId"
	email="emailAddress"
	phone="phoneNumber"
	fax="faxNumber"
	username="username">
	<address>partnerAddress</address>
	<extended-property-set>
	.
	.
	.
	</extended-property-set>
	<client-certificate>
	.
	.
	.
	</client-certificate>
	<server-certificate>
	.
	.
	.
	</server-certificate>
	<encryption-certificate>
	.
	.
	.
	</encryption-certificate>
	<signature-certificate>
	.
	.
	.
	</signature-certificate>
	<ebxml-binding>
	.
	.
	.
	</ebxml-binding>
	<rosettanet-binding>
	.
	.
	.
	</rosettanet-binding>
	<web-service-binding>
	.
	.
	.
	</web-service-binding>
</trading-partner>

Attributes

References

To

From

Hierarchy

Used By

Children

trading-partner-management Element

This element is the document root for TPM. It serves as the parent element for all the major elements in the TPM repository.

Syntax

<trading-partner-management 
	test-mode="[true|false]"
	message-tracking-default="[NONE|METADATA|ALL]"
	message-trace="[true|false]"
	message-trace-directory="directoryLocation" 
	secure-audit-logging="[true|false]">
</trading-partner-management>

Attributes

References

To

From

Hierarchy

Used By

Children

transport Element

This element specifies the transport level properties and receiving endpoint for a binding.

Syntax

<transport
	protocol="[http|HTTP|https|HTTPS|jms|JMS]"
	protocol-version="[1.1|none]"
	endpoint="URL"
	timeout="timeoutNo">
	<authentication
	.
	.
	.
	/>
</transport>

Attributes

References

To

From

Hierarchy

Used By

Children

web-service-binding Element

This element and its child elements provide messaging properties such as transport endpoints, and authentication parameters for trading partners hosting or calling Web services.

Syntax

<web-service-binding>
	<transport
	.
	.
	.
	/>
</web-service-binding>

Attributes

References

To

From

Hierarchy

Used By

Children

xpath Element

This element defines an Xpath expression that may be one of a sequence of optional XML data transformations on a message that it is to be digitally signed. The message digest is computed after any transforms are performed on the message.

Syntax

<xpath>xpath-expression</xpath>

Attributes

None

References

To

From

Hierarchy

Used By

Children