Versions Compared

Key

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

...

The folders send/receive-pmodes are the folders which configured the pmodes PModes (respectively send/receive). Samples of this pmodes these PModes can be found in the Samples folder.
The settings.xml file contains the global configuration of the component and is explained herebelow (2.2).

1.1.2   Database Folder

Default SQLite is used as database. The .db file which contains the SQLite database is stored in this folder.
Regardless of the database that is being used, this folder will by default also contain the following folder structure:

...

Inside the schemas folder the .xsd files are located of the pmodes PModes and messages. In the root of this folder, documentation is added.

...

Each folder contains the respectively the samples of send/receive-pmodes PModes and messages. Inside the certificates folder, you find sample certificates that can be used for sending (signing/encrypting) and receiving (verifying) messages.

...

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.


Sending PMode

*

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





O

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


Information on how to retrieve the SSL certificate

DynamicDiscovery

   SmlScheme

   SmpServerDomainName

   DocumentIdentifier

   DocumentIdentifierScheme

O

O

M

O

O

This element is only present when SMP/SML is required

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:busdox-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











         


CertificateFindValueAlgorithm  






      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:

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


Supported values:

Supported values:

Supported values:

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

...

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.

Receive PMode

*

Description

Id

M

PMode Unique Id

Reliability

   DuplicateElimination

      IsEnabled

O

O

O



Default: false

ReplyHandling

   ReplyPattern



   SendingPMode

   ReceiptHandling

      UseNRRFormat

   ErrorHandling

      UseSOAPFault

      ResponseHttpCode

M

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

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




   Decryption

      Encryption




      CertificateFindCriteria

          CertificateFindType












      CertificateFindValue

O

O

M




O

O




O

M












M



Enumeration

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

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

...