AS4Web Adapter
Properties Configuration Settings
The AS4Web Adapter adds AS4 receive functionality to BizTalk Server.
Remarks
The AS4Web Adapter supports receiving files into BizTalk. Using a simple application-like design, the adapter allows you to easily incorporate secure EDI (EDI-INT) exchange into your current e-Business process architecture.
AS4Wbe Receive Adapter
The AS4Web Receive Adapter implements an AS4 server that can communicate with your BizTalk Server. This accepts files sent by your partner to you (handling incoming push requests).
In order to use the AS4Web Receiver, you must set the AS4SiteURL where your AS4 server is hosted, as well as the TradingPartner and ReceivingPartner AS4 identifiers. The AS4Web Receiver will read all incoming requests and check them against these values to ensure that the request comes from a known sender and is actually intended for the receiving entity.
To decrypt incoming messages set DecryptionCert to you private key. To verify the signature of incoming message set SignerCert to your partner's public certificate. To sign receipts sent back to you partner set SigningCert. If a receipt should be sent, set SendReceipt to Yes.
Once the incoming AS4 request has been parsed and verified, the contents are submitted to your BizTalk Server to be processed. Upon successful submission, the adapter will generate and send a receipt to your trading partner.
The AS4Web Receiver is an isolated adapter, meaning that it is hosted by a separate application outside of the BizTalk Server. The adapter uses the incoming HTTP POST URL as the key for storing and retrieving its property set within BizTalk's database. Thus a single page can host multiple trading partner configurations.
Receiver Property List
The following is the full list of the properties of the receiver adapter with short descriptions. Click on the links for further details.
AgreementRef | The agreement reference. |
AS4FromId | The Id of the party. This value is required. |
AS4FromIdType | The optional type of the Id. If specified this value should be the domain to which the Id belongs. |
AS4FromRole | This field specifies the role of the party. This may be any value agreed upon by the trading partners. |
AS4SiteURL | The path to the website hosting the AS4 adapter. |
AS4ToId | The Id of the party. This value is required. |
AS4ToIdType | The optional type of the Id. If specified this value should be the domain to which the Id belongs. |
AS4ToRole | This field specifies the role of the party. This may be any value agreed upon by the trading partners. |
ConversationId | The Conversation Id of the message. |
DecryptionCert | The certificate with private key used to decrypt. |
EDIProperties | A collection of file properties. |
EDIType | The Content-Type of the EDI message. |
ErrorThreshold | The maximum number of errors before the adapter shuts down. |
Firewall | A set of properties related to firewall access. |
HTTPProxy | A set of properties related to proxy access. |
LogDirectory | The path to a directory for logging. |
LogFile | The log file written. |
MaxThreads | The maximum number of threads that the adapter may consume. |
MessageId | The unique Id of the message. |
MessageProperties | A collection of message properties. |
Other | Defines a set of configuration settings to be used by the adapter. |
Profile | The AS4 profile. |
ReceiptContent | The content of the receipt. |
ReceiptRefToMessageId | The Message Id to which this receipt applies. |
ReceivedFileName | The name of the file received by the AS4 adapter. |
ReceivingPartner | The identity of AS4 receiving entity. |
RequeueEndpoints | Whether to requeue receive endpoints if the polling interval has not been reached. |
RuntimeLicense | Specifies the adapter runtime license key. |
SendReceipt | Whether to send a receipt. |
Service | The service which acts on the message. |
ServiceAction | The action within a service that acts on the message. |
ServiceType | The type of service. |
SignerCert | The public signing certificate of the partner. |
SigningCert | The certificate used to sign the outgoing AS4 message. |
SSLAcceptServerCert | For sending HTTPS requests, a server certificate to unconditionally accept. |
SSLCert | The certificate to use for client authentication during the SSL handshake. |
TempPath | A temporary local directory where data can be stored before the adapter processes it. |
Timeout | A timeout for the adapter. |
TokenPassword | The password used in UsernameToken authentication. |
TokenUser | The user used in UsernameToken authentication. |
TradingPartner | The trading partner that will be communicating with this receive location. |
TransportLog | Tells the adapter where and how to report information about its operations. |
URI | The Uniform Resource Identifier (URI) of the send port or receive location. |
Configuration Settings
The following is a list of configuration settings for the adapter with short descriptions. Click on the links for further details.
AllowWarnings | Whether warnings are interpreted as fatal errors. |
DetectDuplicates | Whether to detect duplicate messages when receiving. |
EDIDataPartId[i] | Specified the part Id at the given index. |
EncryptionSecurityTokenFormat | The format to use for the security token when encryption. |
SigningSecurityTokenFormat | The format to use for the security token when signing. |
FilenameProperty | Defines a part property to hold the filename. |
FromIdCount | The number of Ids for the party specified by AS4From. |
FromId[i] | The Id of the party specified by AS4From. |
FromIdType[i] | The Id type of the party specified by AS4From. |
LogLevel | The level of information to log. |
LogOptions | The information to be written to log files. |
MGF1HashAlgorithm | The MGF1 hash algorithm used when encrypting a key. |
RequireEncryption | Whether encryption is required when processing received messages. |
RequireSignature | Whether a signature is required when processing received messages. |
RSAHashAlgorithm | The RSA hash algorithm used when encrypting a key. |
OAEPParams | The hex encoded OAEP parameters to be used when encrypting a key. |
ToIdCount | The number of Ids for the party specified by AS4To. |
ToId[i] | The Id of the party specified by AS4To. |
ToIdType[i] | The Id type of the party specified by AS4To. |
TokenPasswordType | The password type used in UsernameToken authentication. |
ReceiptURL | The URL to which receipts are sent. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseManagedSecurityAPI | Tells the adapter whether or not to use the system security libraries or a managed implementation. |