AS4 Adapter
Properties Configuration Settings
The AS4 Adapter adds AS4 send and receive capabilities to BizTalk Server.
Remarks
The AS4 Adapter adds AS4 send and receive capabilities to BizTalk Server. 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.
Sending AS4 Messages
Outgoing AS4 messages are managed with a Send adapter. To send a file via AS4 specify AS4FromId and AS4ToId. SigningCert and RecipientCert should be specified to enable signing and encrypting. URL must be set to the URL to which the file will be sent.
Additional optional properties such as EDIFileName, EDIType, Profile, and more may also be set.
The AS4 Send adapter is a Solicit-Response adapter and the resulting message will contain the receipt returned by the server if RequireReceipt is True (default).
Received receipts will be automatically verified by the adapter using the certificate specified by SignerCert.
Receiving AS4 Messages
The AS4 Receive adapter will establish a connection to a server and request messages to download from the specified MPC. If SendReceipt is True (default) the adapter will automatically generate a receipt and send it with the next request.
During each polling interval the adapter will attempt to download all files present in a MPC. Each file will be submitted individually to BizTalk.
Set DecryptionCert to decrypt the received files. SignerCert specifies the public certificate used to verify the signature of received files. Receipts will be signed using the certificate specified by SigningCert.
Please refer to the section on adapter configuration for a description of how to configure receive locations and send ports for this adapter.
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. |
| 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. |
| MaxBatchSize | The maximum size, in MB, of the current batch (0 indicates no limit). |
| MaxFileCount | The maximum number of files in the current batch (0 indicates no limit). |
| MaxFileSize | The maximum size, in MB, of a file in the current batch (0 indicates no limit). |
| MaxThreads | The maximum number of threads that the adapter may consume. |
| MessageId | The unique Id of the message. |
| MessageProperties | A collection of message properties. |
| MPC | The MPC (Message Partition Channel) from which to receive files. |
| Other | Defines a set of configuration settings to be used by the adapter. |
| PollingInterval | The amount of time, in seconds, between download attempts. |
| 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. |
| 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. |
| 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. |
| URL | The URL to which the request is made. |
Sender Property List
The following is the full list of the properties of the sender 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. |
| 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. |
| CompressionFormat | The compression format (if any) to use. |
| ConversationId | The Conversation Id of the message. |
| EDIFileName | The file name to be used in outbound request. |
| EDIProperties | A collection of file properties. |
| EDIType | The Content-Type of the EDI message. |
| EncryptionAlgorithm | The algorithm, if any, used to encrypt the EDI data. |
| Firewall | A set of properties related to firewall access. |
| HTTPPassword | A password if authentication is to be used. |
| HTTPProxy | A set of properties related to proxy access. |
| HTTPUser | A user name if authentication is to be used. |
| LogDirectory | The path to a directory for logging. |
| LogFile | The log file written. |
| MaxPersistentConnections | The maximum number of simultaneous persistent connections when sending. |
| MaxThreads | The maximum number of threads that the adapter may consume. |
| MaxTransmissionBatchSize | The maximum number of messages that can be sent in a single batch. |
| 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. |
| RecipientCert | The public certificate used to encrypt files when sending. |
| RefToMessageId | Specifies the RefToMessageId in the message. |
| RequireReceipt | Whether to require a receipt. |
| RuntimeLicense | Specifies the adapter runtime license key. |
| Service | The service which acts on the message. |
| ServiceAction | The action within a service that acts on the message. |
| ServiceType | The type of service. |
| 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. |
| Timeout | A timeout for the adapter. |
| TransmitBatchMode | How the transmitter processes batches. |
| 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. |
| URL | The URL to which the request is made. |
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. |
| MaxDownloads | The maximum number of downloads to perform in each polling interval. |
| 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. |