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.
Receive PMode | * | Description |
---|---|---|
Id | M | PMode Unique Id |
Reliability DuplicateElimination IsEnabled |
O O O |
Default: false |
ReplyHandling ReplyPattern ResponseConfiguration Protocol URL UseChunking UseHTTPCompression TLSConfiguration IsEnabled TLSVersion ClientCertificateReference ClientCertificateFindType ClientCertificateFindValue ResponseSigning IsEnabled CertificateFindCriteria CertificateFindType CertificateFindValue KeyReferenceMethod Algorithm HashFunction SigningVerification Signature AllowUnknownRootCertificate ReceiptHandling UseNRRFormat ErrorHandling UseSOAPFault ResponseHttpCode PiggyBackReliability IsEnabled RetryCount RetryInterval |
M M O M M O O O O M M M M O O O O M M M M O O M O O O O O O O M O O |
Enumeration:
This element is required when the ReplyPattern = Callback URL of the receiving MSH Default: false (true > not implemented) Default: false (true > not implemented) Default: false Enumeration:
Information on how to retrieve the SSL certificate Default: false Enumeration:
Enumeration:
Enumeration
Indicates whether certificates with an unknown root authority are trusted. (Default false) Specifies if NonRepudationInfo must be included in receipt Default: false Default: false HTTP Status Code in case of reply = response. Default: 200 Indicates whether or not the bundling of PiggyBacked SignalMessages must be retried Amount of retry cycles the bundling must be retried Default: 4 Interval between each retry cycle during the bundling Default: 0:00:01:00 (1 min) |
ExceptionHandling NotifyMessageConsumer NotifyMethod Type Parameters Parameter Name Value Reliability IsEnabled RetryCount RetryInterval |
O O M M M M M M O M O O |
Default: false Type of the Notify Agent Required
parameters for the specified agent
Name of the parameter Value of the parameter Indicates whether or not the Delivery must be retried Amount of retry cycles the Delivery must be retried Default: 4 Interval between each retry cycle during the Delivery Default: 0:00:01:00 (1 min) |
Security SigningVerification Signature AllowUnknownRootCertificate Decryption Encryption CertificateFindCriteria CertificateFindType CertificateFindValue |
O O M O O O O M M |
Enumeration
Indicates whether certificates with an
unknown root authority are trusted. (Default false)
Enumeration:
Enumeration:
|
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 Reliability IsEnabled RetryCount RetryInterval Forward SendingPMode |
M O M M M M M M M M M M M M M M M O O 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 Indicates whether or not the Delivery must be retried Amount of retry cycles the Delivery must be retried Default: 4 Interval between each retry cycle during the Delivery Default: 0:00:01:00 (1 min) 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 theFileNameFormat
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)