Outbound
These MAD parameters allow you to define messaging actions for outbound messages. For an example of how the parameters appear in the ePM user interface for ebXML Protocol Manager.
The initial set of parameters (before Service Type; see Service Type) are eXchange settings common to all protocol managers. See the eXchange Integrator User’s Guide for information on how to set them, including how to set up messaging actions as either inbound or outbound.
Service Type
Description
Use this parameter when the parties sending and receiving the message know how to interpret the value of the Service element. The two parties may use the value of the Type attribute to assist the interpretation.
Values
A valid string supplied by the user; not required.
Default
None
Host Role in Transaction
Description
Associates the B2B host with a specific role in the business Collaboration, such as a “buyer.”
Values
A valid string supplied by the user; not required.
Default
None
Partner Role in Transaction
Description
Associates a TP with a specific role in the business Collaboration, such as a “seller.”
Values
A valid string supplied by the user; not required.
Default
None
HostPartyID Value
Description
The PartyID element provides an identifier for the B2B host. The value of the PartyID element is any string that provides a unique identifier. If this value is not a URN, the HostPartyID type must be provided.
Values
A valid string supplied by the user; required.
Default
None
HostPartyID Type
Description
The PartyID element provides an identifier for the B2B host. The type of the PartyID element provides a scope or namespace for the content of the PartyID element.
Values
A valid string supplied by the user; not required.
Default
None
PartnerPartyID Value
Description
The PartyId element provides an identifier for a TP. The value of the PartyID element is any string that provides a unique identifier. If this value is not a URN, the PartnerPartyID type must be provided.
Values
A valid string supplied by the user; required.
Default
None
PartnerPartyID Type
Description
The PartyId element provides an identifier for a TP. The type of the PartyID element provides a scope or namespace for the content of the PartyID element.
Values
A valid string supplied by the user; not required.
Default
None
Sequence Number
Description
Not yet implemented; the parameter is reserved for future use and is ignored in the current release.
Note –
This parameter is part of a planned Message Sequencing feature and indicates the sequence with which a receiving MSH must process the message. The value entered is the start number for sequencing messages.
Values
A valid string supplied by the user; not required.
Default
None
Envelope ContentID
Description
Used to specify a unique, identifying label for each envelope, referred to as the content ID. This parameter is mandatory and must be a global universal identification (GUID).
For details, see the request for comments (RFC) document 2392, Section 2, on the following Web site:
http://www.ietf.org/rfc/rfc2392.txt
Values
A valid GUID identifying the content ID; required.
Default
Envelope
Envelope ContentLocation
Description
A URI designating the content-location of the MIME body part of an envelope object. Specify this parameter (URI) when the content/payload is not a package along with the message, but instead is referenced using the URI location.
Values
A valid string supplied by the user; not required.
Default
None
Envelope TransferEncoding
Description
Specifies the transfer encoding, for example, base64, to be used for the SOAP envelope. It is recommended that you set this value.
If the message is in a different character format than the one you specify, or if transfer encoding is not specified, the message may become corrupted during data transport. See RFC 2045, Section 6.1, on the following Web site:
http://www.ietf.org/rfc/rfc2045.txt
If an entity is the type “multipart” the content transfer encoding is not permitted to have any value other than 7bit, 8bit, or binary. See RFC 2045, Section 6.4, on the previous Web site.
The output of base64 encoding confirms to the charset US-ASCII. See RFC 2045, Section 6.2, on the previous Web site.
Values
Valid values are 7bit, 8bit, binary, quoted-printable, base64, ietf-token, and x-token, and the parameter entries are not case-sensitive; not required.
Note –
Although this parameter is not required, it is recommended.
Default
7bit
Envelope MIME Parameters
Description
Allows for the specification of additional MIME parameters for the envelope, which are in conformance with the MIME (RFC 2045) specification.
See RFC 2045 on the following Web site:
http://www.ietf.org/rfc/rfc2045.txt
Note –
Implementations may ignore any MIME header not defined in the ebXML Message Service Specification, version 2.0 (see the ebXML Web site). For example, an implementation could include content-length in a message. However, a recipient of a message with content-length could ignore it.
Values
A valid string supplied by the user; not required.
Default
boundary=MIME_boundary, type=text/xml, start=Envelope
Envelope ContentType
Description
Specifies the MIME content type to be used for the envelope.
Values
Must either be text/xml or application/xml; required
Default
text/xml
Envelope Role
Description
Identifies whether the role of the party sending and/or receiving the message is authorized.
Values
fromAuthorizedRole or toAuthorizedRole; not required.
Default
None
Envelope SignFlag
Description
When set to true, specifies that the envelope is digitally signed.
Values
true or false; required.
Default
None
Envelope Sign Transforms1 Algorithm
Description
Specifies the URI that designates the algorithm to be performed when creating or validating a signature.
You must enter the following value:
http://www.w3.org/2000/09/xmldsig#enveloped-signature |
For more information see the ebXML Message Service Specification, version 2.0, Section 4.1.3 (see the ebXML Web site).
Value
http://www.w3.org/2000/09/xmldsig#enveloped-signature; required.
Default
Same as above
Envelope Sign Transforms2 Algorithm
Description
Enter this parameter value for use in conjunction with the Sign Transforms XPath value, to exclude other elements within the SOAP envelope.
You must enter the following value:
http://www.w3.org/TR/1999/REC-xpath-19991116 |
For more information see the ebXML Message Service Specification, version 2.0, Section 4.1.3 (see the ebXML Web site).
Value
http://www.w3.org/TR/1999/REC-xpath-19991116; required.
Default
Same as above
Envelope Sign Transforms XPath
Description
Specifies the XPath expression to be used with the transform element.
You must enter this value as shown below:
not(ancestor-or-self::node()[@soap:actor=’urn:oasis:names:tc:ebxml- msg:actor:nextMSH’] | ancestor-or-self::node()[@soap:actor=’http:// schemas.xmlsoap.org/soap/actor/next’] ) |
For more information see the ebXML Message Service Specification, version 2.0, Section 4.1.3 (see the ebXML Web site).
Values
not(ancestor-or-self::node()[@soap:actor=’urn:oasis:names:tc:ebxml-msg:actor:nextMSH’] | ancestor-or-self::node()[@soap:actor=’http://schemas.xmlsoap.org/soap/actor/next’] ); required.
Default
Same as above
Envelope Sign Transforms3 Algorithm
Description
Specifies the URI that designates the algorithm to be performed when canonicalizing the payload’s XML (if necessary).
When used, you must enter this value as shown below:
http://www.w3.org/TR/2001/REC-xml-c14n-20010315 |
Value
http://www.w3.org/TR/2001/REC-xml-c14n-20010315; not required
Default
None
Payload1 ContentID
Description
Allows you to specify a unique, identifying name for each payload. For more information, see Envelope ContentID.
Values
A valid string supplied by the user; not required.
Default
None
Payload1 ContentLocation
Description
A URI designating the content-location of the MIME body part of the payload object.
Values
A valid URI supplied by the user; not required.
Default
None
Payload1 TransferEncoding
Description
Specifies the transfer encoding, for example, base64, to be used for the payload.
If the message is in a different character format than the one you specify, or if transfer encoding is not specified, the message may become corrupted during data transport. See RFC 2045, Section 6.1, on the following Web site:
http://www.ietf.org/rfc/rfc2045.txt
If an entity is the type “multipart” the content transfer encoding is not permitted to have any value other than 7bit, 8bit, or binary. See RFC 2045, Section 6.4, on the previous Web site.
The output of base64 encoding confirms to the charset US-ASCII. See RFC 2045, Section 6.2, on the previous Web site.
Values
Valid values are 7bit, 8bit, binary, quoted-printable, base64, ietf-token, and x-token, and the parameter entries are not case-sensitive; not required.
Default
None
Payload1 MIME Parameters
Description
Allows for the specification of additional MIME parameters for the payload, which are in conformity with the MIME (RFC 2045) specifications.
Note –
Implementations may ignore any MIME header not defined in the ebXML Message Service Specification, version 2.0 (see the ebXML Web site). For example, an implementation could include content-length in a message. However, a recipient of a message with content-length could ignore it.
Values
A valid string supplied by the user; not required.
Default
None
Payload1 ContentType
Description
Specifies the MIME content-type to be used for the payload.
Values
A valid string supplied by the user; not required.
Default
None
Payload1 Role
Description
Identifies whether the role of the party sending and/or receiving the message is authorized.
Values
fromAuthorizedRole or toAuthorizedRole; not required.
Default
None
Payload1 SignFlag
Description
When set to true, specifies that the payload is digitally signed.
Values
true or false; not required.
Default
false
Payload1 Sign Transforms1 Algorithm
Description
Specifies the URI that designates the algorithm to be performed when creating or validating a signature.
Values
A valid URI string supplied by the user; not required.
Default
None
Payload1 Sign Transforms1 XPath
Description
Used in conjunction with the Sign Transforms XPath parameter to exclude elements within the payload.
Values
A valid string supplied by the user; not required.
Default
None
Payload1 EncryptFlag
Description
Specifies whether the current payload is encrypted.
Values
true or false; not required.
Default
false
Payload1 Encrypt Transforms1 Algorithm
Description
Allows you to specify transformations you want to be executed on the current payload, before encryption is applied to it. This parameter only applies to XML types of payloads.
Values
A valid XML string supplied by the user; not required.
Default
None
Payload1 Encrypt Transforms1 XPath
Description
Allows you to specify the XPath to be executed on the current payload.
Values
A valid XPath expression supplied by the user; not required.
Default
None
Note –
The parameters for any additional payloads ( Payload2 , Payload3 , and so on), if present, are the same as those for Payload1 , and their values are set in the same way.
- © 2010, Oracle Corporation and/or its affiliates