Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This contract describes all the properties available in the Sending PMode. The required data fields are marked as mandatory; default values are provided. Some values of the Sending PMode can be overridden by a SubmitMessage. This definition is available as XSD.

...

HTML

...

*

...

Description

...

Id

...

M

...

PMode Unique Id

...

AllowOverride

...

O

...

Boolean indication whether a SubmitMessage may override already configured values within the sending PMode.

Default: false

...

MEP

...

M

...

Message Exchange Pattern

Enumeration:

  • OneWay
  • TwoWay

...

MEPBinding

...

M

...

Message Exchange Pattern Binding

Enumeration:

    • push
    • pull

PushConfiguration

   Protocol

      URL

      UseChunking

      UseHTTPCompression

   TLSConfiguration

      IsEnabled

      TLSVersion

     
ClientCertificateReference

      ClientCertificateFindType

ClientCertificateFindValue

O

M

M

O

O

O

M

M

...

M

M

Element must be present when MEPBinding is set to push

 

URL of the receiving MSH

Default: false (true > not implemented)

Default: false (true > not implemented)

Default: false

Enumeration:

    • SSL 3.0
    • TLS 1.0
    • TLS 1.1
    • TLS 1.2

...

DynamicDiscovery

    SmlScheme

    SmpServerDomainName

    DocumentIdentifier

    DocumentIdentifierScheme

...

O

O

M

O

O

Used to build the SML Uri. Default: iso6523-actorid-upis

Domain name that must be used in the Uri

Used to retrieve the correct DocumentIdentifier

Default: busbox-docid-qns

...

Reliability

   ReceptionAwareness

      IsEnabled

      RetryCount

      RetryInterval

...

O

O

O

O

O

Default: false

Default: 5

Default: 00:01:00 (HH:mm:ss)

...

ReceiptHandling

   NotifyMessageProducer

   NotifyMethod

      Type

      Parameters

         Parameter

            Name

            Value

...

O

O

M

M

M

M

M

M

Default: false

Type of the Notify Agent

Required parameters for the specified agent

Name of the parameter

Value of the parameter

...

ErrorHandling

   NotifyMessageProducer

   NotifyMethod

      Type

      Parameters

         Parameter

            Name

            Value

...

O

O

M

M

M

M

M

M

Default: false

Type of the Notify Agent

Required parameters for the specified agent

Name of the parameter

Value of the parameter

...

ExceptionHandling

   NotifyMessageProducer

   NotifyMethod

      Type

      Parameters

         Parameter

            Name

            Value

...

O

O

M

M

M

M

M

M

Default: false

Type of the Notify Agent

Required parameters for the specified agent

Name of the parameter

Value of the parameter

Security

   Signing

      IsEnabled

      CertificateFindCriteria

          CertificateFindType

          CertificateFindValue

      KeyReferenceMethod

      Algorithm

      HashFunction

   Encryption

      IsEnabled

      PublicKeyCertificate

          Certificate

      CertificateFindCriteria

          CertificateFindType

         

...

      AlgorithmKeySize

      KeyTransport

        TransportAlgorithm

        DigestAlgorithm

        MgfAlgorithm

O

O

O

O

M

M

M

M

M

O

O

O

M

O

M

M

O

O

O

O

O

Default: false

 

Enumeration:

  • FindByThumbprint
  • FindBySubjectName
  • FindBySubjectDistinguishedName
  • FindByIssuerName
  • FindByIssuerDistinguishedName
  • FindBySerialNumber
  • FindByTimeValid
  • FindByTimeNotValid
  • FindByTimeNotYetValid
  • FindByTimeExpired
  • FindByTemplateName
  • FindByApplicationPolicy
  • FindByCertificatePolicy
  • FindByExtension
  • FindByKeyUsage
  • FindBySubjectKeyIdentifier

 

Enumeration:

  • BSTReference
  • IssuerSerial
  • KeyIdentifier

Default: false

PublicKeyCertificate or CertificateFindCriteria must be specified

Base64 representation of the certificate that must be used

PublicKeyCertificate or CertificateFindCriteria must be specified

Enumeration:

  • FindByThumbprint
  • FindBySubjectName
  • FindBySubjectDistinguishedName
  • FindByIssuerName
  • FindByIssuerDistinguishedName
  • FindBySerialNumber
  • FindByTimeValid
  • FindByTimeNotValid
  • FindByTimeNotYetValid
  • FindByTimeExpired
  • FindByTemplateName
  • FindByApplicationPolicy
  • FindByCertificatePolicy
  • FindByExtension
  • FindByKeyUsage
  • FindBySubjectKeyIdentifier

...

Supported values: 128, 192, 256.  Default is 128

Supported values:

Supported values:

...

Supported values:

script^sending-pmode.html
height10000

 (

Note that the Mgf Algorithm cannot be specified when the TransportAlgorithm is not set to  http://www.w3.org/2009/xmlenc11#rsa-oaep

...

Message Packaging

   Mpc

  UseAS4Compression

   IsMultiHop

   IncludePModeId

   PartyInfo

      FromParty

         PartyIds

            PartyId

               Id

               Type

         Role

      ToParty

         PartyIds

            PartyId

               Id

               Type

         Role

   CollaborationInfo

      AgreementRef

         Value

         Type

      Service

         Value

         Type

      Action

   MessageProperties

      MessageProperty

         Name

         Type

         Value

...

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

Default: http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/defaultMPC

Default: false

Default: false

Default: false

Id of the sending party

Type of Id of the sending party

Role of the sending party

Id of the receiving party

Type of Id of the receiving party

Role of the receiving party

Information about the partner agreement

Type of the agreement reference

The name of the service that is consumed

Type of the service

The service operation that is consumed

Name of the message property

Type of the message property

Value of the message property

 (*): M = Mandatory | O = Optional | R = Recommended

 

...

Receiving Processing Mode

This contract describes all the properties available in the Receiving PMode.  The required data fields are marked as mandatory; default values are provided.  This definition is available as XSD.

...

HTML

...

*

...

Description

...

Id

...

M

...

PMode Unique Id

...

Reliability

   DuplicateElimination

      IsEnabled

...

O

O

O

Default: false

ReplyHandling

   ReplyPattern

   SendingPMode

   ReceiptHandling

      UseNRRFormat

   ErrorHandling

      UseSOAPFault

      ResponseHttpCode

M

M

...

O

M

O

O

O

Enumeration:

    • Response: sync response (default)
    • Callback: async response

Reference to the Sending PMode

Specifies if NonRepudationInfo must be included in receipt.  Default: false

Default: false

HTTP Status Code in case of reply = response.  Default: 200

script^receiving-pmode.html


...

ExceptionHandling

   NotifyMessageConsumer

   NotifyMethod

      Type

      Parameters

         Parameter

            Name

            Value

...

O

O

M

M

M

M

M

M

Default: false

Type of the Notify Agent

Required parameters for the specified agent

Name of the parameter

Value of the parameter

Security

   SigningVerification

      Signature

...

      Encryption

      CertificateFindCriteria

          CertificateFindType

      CertificateFindValue

O

O

M

...

O

O

M

M

Enumeration

...

Enumeration

    • Allowed (default)
    • Not allowed
    • Required
    • Ignored

Enumeration:

    • FindByThumbprint
    • FindBySubjectName
    • FindBySubjectDistinguishedName
    • FindByIssuerName
    • FindByIssuerDistinguishedName
    • FindBySerialNumber
    • FindByTimeValid
    • FindByTimeNotValid
    • FindByTimeNotYetValid
    • FindByTimeExpired
    • FindByTemplateName
    • FindByApplicationPolicy
    • FindByCertificatePolicy
    • FindByExtension
    • FindByKeyUsage
    • FindBySubjectKeyIdentifier

...

Message Packaging

   PartyInfo

      FromParty

         PartyIds

            PartyId

               Id

               Type

         Role

      ToParty

         PartyIds

            PartyId

               Id

               Type

         Role

   CollaborationInfo

      AgreementRef

         Value

         Type

      Service

         Value

         Type

      Action

...

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

O

Id of the sending party

Type of Id of the sending party

Role of the sending party

Id of the receiving party

Type of Id of the receiving party

Role of the receiving party

Information about the partner agreement

Type of the agreement reference

The name of the service that is consumed

Type of the service

The service operation that is consumed

MessageHandling

  Deliver

      Deliver

        IsEnabled

        PayloadReferenceMethod

            Type

            Parameters

               Parameter

                  Name

                  Value

        DeliverMethod

             Type

             Parameters

                Parameter

                  Name

                  Value

  Forward

     SendingPMode

M

O

M

M

M

M

M

M

M

M

M

M

M

M

M

O

M

Describes how a received ebMS Message must be handled

Deliver or Forward must be specified, not both

True or false

Payload Deliver method (HTTP, FILE(**)…)

Required parameters

Name of the parameter

Value of the parameter

Type of the Deliver method (HTTP, FILE,..)

Name of the parameter

Value of the parameter

Deliver or Forward must be specified, not both

The name of the PMode that must be used to forward the received Message.

 (*): M = Mandatory | O = Optional | R = Recommended

...

(**) When the received payloads must be delivered to the FileSystem, the following parameters available:

  • Location:

...

  • The location on the filesystem (directory) where the payloads must be delivered.

  • FileNameFormat:

...

  • Defines how the filename of the delivered payloads must look like. There are two macro's available that can be used to define this pattern:

    • {MessageId} : inserts the ebMS MessageId in the filename
    • {AttachmentId} : inserts the AttachmentId in the filename

...

    • It is possible to combine the macro's which means that it is possible to

...

    • use {MessageId}_{AttachmentId}.


      When the FileNameFormat parameter is not defined, the AttachmentId of the payload will be used as the filename

...

    • When the FileNameFormat parameter is defined, but it contains none of the above defined parameters, then _{AttachmentId} will be appended.

      > (The FileNameFormat parameter is available as from AS4.NET v2.0.1)

  • AllowOverwrite:

...

  • Defines whether files with the same name can be overwritten when delivering a payload.

...

  • Possible values are True and False, the default-value is false.

(The AllowOverwrite parameter is available as from AS4.NET v2.0.1)





Custom settings to configure the IDynamicDiscoveryProfile.

This contract describes all the properties available in the Receiving PMode. The required data fields are marked as mandatory; default values are provided. This definition is available as XSD.