AS4Web Adapter
Properties Configuration Settings
The AS4Web Component 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.
AS4Web 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 your 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 if SendReceipt is true.
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 component. |
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. |
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 component 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 component may consume. |
Other | Defines a set of configuration settings to be used by the component. |
Profile | The AS4 profile. |
ReceivedFileName | The name of the file received by the AS4 component. |
ReceivingPartner | The identity of AS4 receiving entity. |
RegisterIsolatedReceiverTimeout | This setting specifies the number of seconds the isolated receive adapter will search for a corresponding receive location. |
RequeueEndpoints | Whether to requeue receive endpoints if the polling interval has not been reached. |
RuntimeLicense | Specifies the component runtime license key. |
SendReceipt | Whether to send a receipt. |
SignatureAlgorithm | Signature algorithm to be used in the message. |
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 component processes it. |
Timeout | A timeout for the component. |
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 component 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. |
ContentTransferEncoding | The content encoding of the payload data. |
DetectDuplicates | Whether to detect duplicate messages when receiving. |
EncryptionSecurityTokenFormat | The format to use for the security token when encryption. |
FilenameProperty | Defines a part property to hold the filename. |
ForceSigningCert | Whether to force only the SigningCert to be used for signing. |
FromId[i] | The Id of the party specified by AS4From. |
FromIdCount | The number of Ids for the party specified by AS4From. |
FromIdType[i] | The Id type of the party specified by AS4From. |
KeyEncryptionAlgorithm | The algorithm used to encrypt the key. |
LogLevel | The level of information to log. |
LogOptions | The information to be written to log files. |
OAEPMGF1HashAlgorithm | The MGF1 hash algorithm used when encrypting a key. |
OAEPParams | The hex encoded OAEP parameters to be used when encrypting a key. |
OAEPRSAHashAlgorithm | The RSA hash algorithm used when encrypting a key. |
ReceiptURL | The URL to which receipts are sent. |
ReferenceHashAlgorithm | The hash algorithm used to has the data specified in the reference of a signature. |
RequireEncryption | Whether encryption is required when processing received messages. |
RequireSignature | Whether a signature is required when processing received messages. |
SignerCACert | The CA certificates that issued the signer certificate. |
SigningSecurityTokenFormat | The format to use for the security token when signing. |
TempPath | Where temporary files are optionally written. |
ToId[i] | The Id of the party specified by AS4To. |
ToIdCount | The number of Ids for the party specified by AS4To. |
ToIdType[i] | The Id type of the party specified by AS4To. |
TokenPasswordType | The password type used in UsernameToken authentication. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLSecurityFlags | Flags that control certificate verification. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
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. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |