Skip navigation.

Managing WebLogic Integration Solutions

  Previous Next vertical dots separating previous/next from contents/index/pdf Contents View as PDF   Get Adobe Reader

TPM 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 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 WebLogic Integration password store. To learn more about password security, see Password Aliases and the Password Store.

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

To learn more about using the WebLogic Integration Administration Console for TPM, see Trading Partner Management.

To learn more about Workshop trading partner integration controls, see TPM Control, RosettaNet Control, and ebXML Control in Building Integration Applications in the WebLogic Workshop help.

To learn more about using the Bulk Loader, see Using the Trading Partner Bulk Loader.

To learn more about XML, 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.

To learn more about ebXML in general, visit the ebXML Web site.

To learn about the RosettaNet protocol, visit the RosettaNet Web site.

 


address Element

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

Syntax

<address>partnerMailAddress</address>

Attributes

none

Type

xs:string

References

To

none

Children

none

Hierarchy

Used By

trading-partner Element

Children

none

 


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

Attribute

client-authentication

Description

Specifies whether to use client authentication, and if so, what kind.

Allowable Values

BASIC—username and password

NONE—no authentication

SSL_CERT_MUTUAL—mutual SSL certificates

Use

optional

Type

xs:NMTOKEN

Default Value

none

client-certificate-name

Description

A reference to the name of the client certificate for mutual SSL authentication.

Allowable Values

any

Use

optional

Type

reference

Default Value

none

client-partner-name

Description

The name of the trading partner in the TPM repository to which the authentication applies.

Allowable Values

any

Use

required

Type

reference

Default Value

none

password-alias

Description

This is a reference to the password alias in the WebLogic Integration password store. The password is retrieved from the password store and is required when BASIC authentication nis used.

Allowable Values

any

Use

optional

Type

xs:string

Default Value

none

server-authentication

Description

Specifies whether to use server authentication, and if so, what kind.

Allowable Values

NONE—no authentication

SSL_CERT—SSL certificate authentication

Use

optional

Type

xs:NMTOKEN

Default Value

no default value

server-certificate-name

Description

A reference to the name of the server certificate for SSL authentication.

Allowable Values

any

Use

optional

Type

reference

Default Value

none

username

Description

The user name for basic client authentication.

Allowable Values

any

Use

optional

Type

xs:string

Default Value

none


 

References

To

client-certificate Element

server-certificate Element

trading-partner Element

From

none

Hierarchy

Used By

transport Element

Children

none

 


client-certificate Element


 

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

Syntax

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

Attributes

Attribute

name

Description

The name for the client certificate in the TPM repository. The name is also the entry name in the local keystore.

Allowable Values

any

Use

required

Type

xs:string

Default Value

none

password-alias

Description

This is a reference to the entry in the WebLogic Integration password store for the encrypted password. The encrypted password is used for accessing the password-protected keystore entry.

Allowable Values

any

Use

required

Type

xs:string

Default Value

none


 

References

To

none

From

authentication Element

Hierarchy

Used By

trading-partner Element

Children

ds:KeyInfo

 


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

Attribute

name

Description

The name for the binding in the TPM repository. A trading partner may have multiple ebxml-binding elements, so the name must be unique to the parent trading-partner element.

Allowable Values

any

Use

required

Type

xs:string

Default Value

none

business-protocol-name

Description

Identifies the business protocol for message exchange.

Allowable Values

ebXML

Use

optional

Type

xs:string

Default Value

none

business-protocol-version

Description

Identifies the version of the business-protocol name.

Allowable Values

any

Note: Currently 1.0 and 2.0 are supported.

Use

optional

Type

xs:string

Default Value

none

delivery-semantics

Description

This attribute specifies reliable messaging behavior.

Allowable Values

BESTEFFORT—best effort attempt to deliver messages. No reliable messaging.

ONCEANDONLYONCE—Once and only once reliable messaging. Select this option for messaging that requires acknowledgement.

ATLEASTONCE—at least once reliable messaging. Select this option for messaging that requires acknowledgement, but not duplicate elimination.

ATMOSTONCE—at most once reliable messaging. Select this option for messaging that requires duplicate elimination, but not acknowledgement.

For ebXML 1.0, only BESTEFFORT or ONCEANDONLYONCE are valid. For ebXML 2.0, all values are valid.

Use

optional

Type

xs:NMTOKEN

Default Value

false

is-default

Description

Identifies the default ebxml-binding for a trading partner in the event it has more than one.

Allowable Values

false

true

Use

optional

Type

xs:boolean

Default Value

none

is-receipt-signature-
required

Description

This setting, if true, specifies that the party who receives the ebXML messages from this trading partner through this binding must acknowledge them using the digitally signed receipt messages. The receipt messages must use the certificate of the acknowledging party.

You can control the archival of signed receipts in a secure audit log by the global attribute secure-audit-logging in the root element trading-partner-management.

Allowable Values

false

true

Use

optional

Type

xs:boolean

Default Value

none

is-signature-required

Description

This setting, if true, specifies that parties must digitally sign messages they send to the trading partner though this binding.

You can control the archival of signed messages in a secure audit log by the global attribute secure-audit-logging in the root element trading-partner-management.

Allowable Values

false

true

Use

optional

Type

xs:boolean

Default Value

none

persist-duration

Description

Specifies the duration for which messages have to be stored persistently for the purpose of duplicate elimination.

Allowable Values

any

Use

optional

Type

xs:string

Default Value

none

retries

Description

Specifies the maximum number of times to attempt to send a reliably delivered message.

Allowable Values

Any positive Integer

Use

optional

Type

xs:nonNegativeInteger

Default Value

3

retry-interval

Description

This attribute defines the time interval between attempts to send a reliably delivered message. The interval begins after the timeout period for message acknowledgement expires.

Allowable Values

time duration string

Use

optional

Type

xs:string

Default Value

none

signature-certificate
-name

Description

References the name of the certificate for digitally signing messages.

Allowable Values

any

Use

optional

This setting is required if the is-signature-required or is-signature-receipt-required attributes are true.

Type

reference

Default Value

none


 

Reference

To

signature-certificate Element

From

service-profile Element

Hierarchy

Used By

trading-partner Element

Children

signature-transforms Element

transport Element

 


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

Attribute

name

Description

The name of the encryption certificate in the TPM repository. This name is also the entry name in the local keystore.

Allowable Values

any

Use

required

Type

xs:string

Default Value

none

password-alias

Description

This is a reference to the entry in the WebLogic Integration password store for the encrypted password. The encrypted password is used for accessing the password-protected keystore entry.

Allowable Values

any

Use

optional

Type

xs:string

Default Value

none


 

References

To

none

From

rosettanet-binding Element

Hierarchy

Used By

trading-partner Element

Children

ds:KeyInfo

 


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

Attribute

name

Description

The name of the property set.

Allowable Values

any

Use

required

Type

xs:string

Default Value

none

description

Description

A text description of the property set that appears in the WebLogic Integration Administration Console.

Allowable Values

any

Use

optional

Type

xs:string

Default Value

none

notes

Description

Text notes or documentation for the property set.

Allowable Values

any

Use

optional

Type

xs:string

Default Value

none


 

References

To

none

From

none

Hierarchy

Used By

trading-partner Element

Children

any

 


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

Attribute

trading-partner-name

Description

The name of the trading partner in the TPM repository that should receive RosettaNet failure notification.

Allowable Values

any

Use

required

Type

reference

Default Value

none

binding-name

Description

References the name of the service binding in the TPM repository for the provider.

Allowable Values

any

Use

optional

Type

reference

Default Value

none


 

References

To

rosettanet-binding Element

trading-partner Element

From

none

Hierarchy

Used By

rosettanet-binding Element

Children

none

 


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

Attribute

trading-partner-name

Description

The name of the trading partner in the TPM repository that should receive RosettaNet failure notification.

Allowable Values

any

Use

required

Type

reference

Default Value

none

binding-name

Description

The name of the binding in the TPM repository for the provider.

Allowable Values

any

Use

optional

Type

reference

Default Value

none


 

References

To

rosettanet-binding Element

trading-partner Element

From

none

Hierarchy

Used By

rosettanet-binding Element

Children

none

 


reference simpleType

This references another element in the TPM repository.

Syntax

<reference>referenceName</reference>

Attributes

none

Type

xs:string

Hierarchy

Used By

authentication Element

ebxml-binding Element

failure-notifier Element

failure-report-administrator Element

rosettanet-binding Element

service-profile Element

Children

none

 


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

Attribute

name

Description

The name for the binding in the TPM repository. A trading partner may have multiple rosettanet-binding elements, so the name must be unique to the parent trading-partner element.

Allowable Values

any

Use

required

Type

xs:string

Default Value

none

business-protocol-name

Description

Identifies the business protocol for message exchange.

Allowable Values

RosettaNet

Use

optional

Type

xs:string

Default Value

none

business-protocol-version

Description

Identifies the version of the business-protocol name.

Allowable Values

1.1

2.0

Use

optional

Type

xs:string

Default Value

none

is-default

Description

Identifies the default rosettanet-binding for a trading partner in the event it has more than one.

Allowable Values

false

true

Use

optional

Type

xs:boolean

Default Value

false

encryption-certificate-name

Description

The name of the encryption certificate for the encryption and decryption of messages.

Allowable Values

any

Use

optional

Type

reference

Default Value

none

cipher-algorithm

Description

The cipher algorithm for encrypting messages.

Allowable Values

NONE

RC5

DES

TRIPLE_DES

RC2

Use

optional

Type

xs:NMTOKEN

Default Value

none

encryption-level

Description

This attribute determines how much of a message to encrypt.

Allowable Values

NONE

PAYLOAD

ENTIRE_PAYLOAD

Use

optional

Type

xs:NMTOKEN

Default Value

none

is-signature-required

Description

This setting, if true, specifies that parties must digitally sign messages they send to the trading partner though this binding.

You can control the archival of signed messages in a secure audit log by the global attribute secure-audit-logging in the root element trading-partner-management.

Allowable Values

false

true

Use

optional

Type

xs:boolean

Default Value

false

is-receipt-signature
-required

Description

This setting, if true, specifies that the party who receives the RosettaNet messages from this trading partner through this binding must acknowledge them using the digitally receipt messages. The receipt messages must use the certificate of acknowledging party.

You can control the archival of signed receipts in a secure audit log by the global attribute secure-audit-logging in the root element trading-partner-management.

Allowable Values

false

true

Use

optional

Type

xs:boolean

Default Value

false

signature-digest-algorithm

Description

This setting specifies the message digest algorith used for the digital signature.

Allowable Values

SHA-1
MD5
None

If the vaule is SHA-1, None, or null, the Secure Hash Algorithm 1 (SHA-1), which produces a 160-bit hash, is used.

If the value is MD5, the Message Digest 5 (MD5) message hash algorithm, which produces a 128-bit hash, is used.

Use

optional

Type

xs:NMTOKEN

Default Value

NONE

signature-certificate
-name

Description

References the name of the certificate for digitally signing messages.

Allowable Values

any

Use

optional

This setting is required if the is-signature-required or is-signature-receipt-required attributes are true.

Type

reference

Default Value

none

retries

Description

Specifies the maximum number of times to attempt to send a reliably delivered message.

Allowable Values

Any positive Integer

Use

optional

Type

xs:nonNegativeInteger

Default Value

3

retry-interval

Description

This attribute defines the time interval between attempts to send a reliably delivered message. The interval begins after the time-out period for message acknowledgement expires.

Allowable Values

time duration string

Use

optional

Type

xs:string

Default Value

none

process-timeout

Description

The amount of time a PIP can be active before timing out.

Allowable Values

time duration string

Use

optional

Type

xs:string

Default Value

none


 

References

To

encryption-certificate Element

signature-certificate Element

From

failure-notifier Element

failure-report-administrator Element

service-profile Element

Hierarchy

Used By

trading-partner Element

Children

failure-report-administrator Element

failure-notifier Element

transport Element

 


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

Attribute

service-content-schema

Description

The XML schema for content validation.

The service uses this schema only if use-dtd-validation is false and validate-service-content is true.

Allowable Values

any

Use

optional

Type

xs:string

Default Value

none

use-dtd-validation

Description

Specifies the kind of XML validation to perform. If true, the validation is from a DTD; if false, from XML schema.

Allowable Values

false

true

Use

optional

Type

xs:boolean

Default Value

false

validate-service-content

Description

Determines whether to validate the service content of all messages.

Allowable Values

false

true

Use

optional

Type

xs:boolean

Default Value

false

validate-service-header

Description

Determines whether to validate the service header for all messages.

Allowable Values

false

true

Use

optional

Type

xs:boolean

Default Value

false


 

References

To

none

From

none

Hierarchy

Used By

service Element

Children

none

 


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

Attribute

name

Description

The name of the server certificate in the TPM repository. The name is also the entry name in the local keystore.

Allowable Values

any

Use

required

Type

xs:string

Default Value

none

password-alias

Description

This is a reference to the entry in the WebLogic Integration password store for the encrypted password. The encrypted password is used for accessing the password-protected keystore entry.

Allowable Values

any

Use

optional

Type

xs:string

Default Value

none


 

References

To

none

From

authentication Element

Hierarchy

Used By

trading-partner Element

Children

ds:KeyInfo

 


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

Attribute

name

Description

The name of the service in the TPM repository. The name corresponds to the name of a component on the local domain.

Allowable Values

any

Use

required

Type

xs:string

Default Value

none

description

Description

A text description of the service that appears in the WebLogic Integration Administration Console.

Allowable Values

any

Use

optional

Type

xs:string

Default Value

none

notes

Description

Text documentation of the service element.

Allowable Values

any

Use

optional

Type

xs:string

Default Value

none

service-type

Description

The kind of service the element represents

Allowable Values

WEBSERVICE—a JWS file

PROCESSS—a JPD file

SERVICECONTROL—a service control (JCX file)

Use

optional

Type

xs:NMTOKEN

Default Value

none

business-protocol

Description

The business protocol for the service, which determines the child service profile bindings.

Allowable Values

WEBSERVICE

EBXML

ROSETTANET

Use

optional

Type

xs:NMTOKEN

Default Value

none


 

References

To

none

From

none

Hierarchy

Used By

trading-partner-management Element

Children

rosettanet-service-defaults Element

service-profile Element

 


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

Attribute

local-trading-partner

Description

This attributes references either:

  • the name of a local trading partner that hosts a JWS or JPD

  • the name of a local trading partner that uses a control to send messages to an external partner

If you do not provide a value in the repository for this attribute, at runtime the value for this property comes from the is-default attribute.

Allowable Values

any

Use

optional

Type

reference

Default Value

none

local-binding

Description

References the name of the binding for the corresponding local trading partner.

If you do not provide a value for this attribute, at runtime the value property comes from the binding with the is-default value of true.

Allowable Values

any

Use

optional

Type

reference

Default Value

none

external-trading-partner

Description

References the name of the trading partner with which the local trading partner interacts.

This attribute can describe:

  • Remote trading partners

  • Collocated local trading partners

Allowable Values

none

Use

required

Type

reference

Default Value

none

external-binding

Description

References the binding name for the corresponding external-external-trading partner.

Allowable Values

any

Use

optional

Type

reference

Default Value

none

status

Description

The deployed state of the service profile.

Allowable Values

ENABLED

DISABLED

Use

optional

Type

xs:NMTOKEN

Default Value

DIASABLED

message-tracking

Description

Determines whether to track messages, and if so, at what level.

Allowable Values

NONE—no message tracking

DEFAULT—default message tracking options

METADATA—track message metadata

ALL—track all message data

Use

optional

Type

xs:NMTOKEN

Default Value

DEFAULT


 

References

To

ebxml-binding Element

rosettanet-binding Element

trading-partner Element

web-service-binding Element

From

none

Hierarchy

Used By

service Element

Children

none

 


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

Attribute

name

Description

The name of the signature certificate in the TPM repository. This name is also the entry name in the local keystore.

Allowable Values

any

Use

required

Type

xs:string

Default Value

none

password-alias

Description

This is a reference to the entry in the WebLogic Integration password store for the encrypted password. The encrypted password is used for accessing the password-protected keystore entry.

Allowable Values

any

Use

optional

Type

xs:string

Default Value

none


 

References

To

none

From

ebxml-binding Element

rosettanet-binding Element

Hierarchy

Used By

trading-partner Element

Children

ds:KeyInfo

 


signature-transforms Element


 

This element defines a sequence of optional XML data transformations for a digitally signed message, before WebLogic Integration signs the message. 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

none

From

none

Hierarchy

Used By

ebxml-binding Element

Children

xpath Element

 


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

Attribute

name

Description

Name for the trading partner in the repository.

Allowable Values

any

Use

required

Type

xs:string

Default Value

none

description

Description

A short text description of the trading partner that appears in the WebLogic Integration Administration Console.

Allowable Values

any

Use

optional

Type

xs:string

Default Value

none

notes

Description

Text notes or documentation of the trading partner.

Allowable Values

any

Use

optional

Type

xs:string

Default Value

none

status

Description

A string that determines whether the trading partner is enabled to send and receive messages.

Allowable Values

enabled

ENABLED

disabled

DISABLED

Use

optional

Type

xs:NMTOKEN

Default Value

ENABLED

type

Description

Specifies whether the trading partner resides locally within WebLogic Integration domain or at an external remote location.

Allowable Values

LOCAL—the trading partner resides within the domain

REMOTE—the trading partner resides outside the domain

Use

optional

Type

xs:NMTOKEN

Default Value

REMOTE

is-default

Description

This setting indicates whether or not the trading partner is the default trading partner for sending and receiving messages for the local host system.

This attribute can be set to true for trading partners with a type attribute of LOCAL only. Only one LOCAL type trading partner can have this value set to true.

Allowable Values

false

true

Use

optional

Type

xs:boolean

Default Value

false

business-id-type

Description

Identifies the type for naming convention for the associated business-id attribute. For example, a trading partner that is registered with Dun and Bradstreet might use a value of "DUNS".

Allowable Values

any

Use

optional

Type

xs:string

Default Value

none

business-id

Description

Uniquely identifies the trading partner in message exchanges according to the business-id-type.

Allowable Values

any

Use

optional

Type

xs:string

Default Value

none

email

Description

An email address for the trading partner.

Allowable Values

any

Use

optional

Type

xs:string

Default Value

none

phone

Description

A telephone number for the trading partner.

Allowable Values

any

Use

optional

Type

xs:string

Default Value

none

fax

Description

A fax telephone number for a trading partner.

Allowable Values

any

Use

optional

Type

xs:string

Default Value

none

username

Description

The username in the WebLogic Integration security configuration that represents the trading partner.

Allowable Values

any

Use

optional

Type

xs:string

Default Value

none


 

References

To

none

From

authentication Element

failure-notifier Element

failure-report-administrator Element

service-profile Element

Hierarchy

Used By

trading-partner-management Element

Children

address Element

extended-property-set Element

client-certificate Element

server-certificate Element

encryption-certificate Element

signature-certificate Element

ebxml-binding Element

rosettanet-binding Element

web-service-binding Element

 


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

Attribute

message-tracking-default

Description

The default global setting for the message tracking level. The message tracking attribute of the service-profile element overrides this attribute.

Allowable Values

NONE—no tracking

METADATA—tracking message metadata

ALL—all message data

Use

optional

Type

xs:NMTOKEN

Default Value

NONE

message-trace

Description

Toggles message tracing on and off.

Allowable Values

false

true

Use

optional

Type

xs:boolean

Default Value

false

message-trace-directory

Description

The directory location where messages logs reside.

Allowable Values

false

true

Use

optional

Type

xs:boolean

Default Value

none

secure-audit-logging

Description

Specifies whether signed messages reside in a secured audit log.

Allowable Values

true, false

Use

optional

Type

xs:boolean

Default Value

false

test-mode

Description

Specifies whether the repository is running in a test or production environment. In test-mode, you can send and recieve messages between collocated trading partners without using service profiles.

Allowable Values

false

true

Use

optional

Type

xs:boolean

Default Value

true


 

References

To

none

From

none

Hierarchy

Used By

none

Children

trading-partner Element

service Element

 


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

Attribute

protocol

Description

The protocol for sending and recieving messages.

A value of JMS/jms is possible only when the transport is a child of the web-service-binding element.

Allowable Values

http

HTTP

https

HTTPS

jms

JMS

Use

required

Type

xs:NMTOKEN

Default Value

none

protocol-version

Description

The version of the transport protocol.

This attribute is required for only HTTP/HTTPS protocols. The only supported version is 1.1.

Allowable Values

"1.1" or no value

Use

optional

Type

xs:string

Default Value

none

endpoint

Description

The URL of the transport endpoint

Allowable Values

any

Use

optional

Type

xs:anyURI

Default Value

none

timeout

Description

The period that the transport waits until indicating that the transport of a message failed.

Allowable Values

time duration string

Use

optional

Type

xs:string

Default Value

none


 

References

To

none

From

none

Hierarchy

Used By

ebxml-binding Element

rosettanet-binding Element

web-service-binding Element

Children

authentication Element

 


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

Attribute

name

Description

The name for the binding in the TPM repository. A trading partner may have multiple web-service-binding elements, so the name must be unique to the parent trading-partner element.

Allowable Values

any

Use

required

Type

xs:string

Default Value

none


 

References

To

none

From

service-profile Element

Hierarchy

Used By

trading-partner Element

Children

transport Element

 


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

none

From

none

Hierarchy

Used By

signature-transforms Element

Children

none

 

Back to Top Previous Next