/n software Adapters for BizTalk
/n software Adapters for BizTalk
Questions / Feedback?

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.

AgreementRefThe agreement reference.
AS4FromIdThe Id of the party. This value is required.
AS4FromIdTypeThe optional type of the Id. If specified this value should be the domain to which the Id belongs.
AS4FromRoleThis field specifies the role of the party. This may be any value agreed upon by the trading partners.
AS4ToIdThe Id of the party. This value is required.
AS4ToIdTypeThe optional type of the Id. If specified this value should be the domain to which the Id belongs.
AS4ToRoleThis field specifies the role of the party. This may be any value agreed upon by the trading partners.
ConversationIdThe Conversation Id of the message.
DecryptionCertThe certificate with private key used to decrypt.
EDIPropertiesA collection of file properties.
EDITypeThe Content-Type of the EDI message.
ErrorThresholdThe maximum number of errors before the adapter shuts down.
FirewallA set of properties related to firewall access.
HTTPProxyA set of properties related to proxy access.
LogDirectoryThe path to a directory for logging.
LogFileThe log file written.
MaxBatchSizeThe maximum size, in MB, of the current batch (0 indicates no limit).
MaxFileCountThe maximum number of files in the current batch (0 indicates no limit).
MaxFileSizeThe maximum size, in MB, of a file in the current batch (0 indicates no limit).
MaxThreadsThe maximum number of threads that the adapter may consume.
MessageIdThe unique Id of the message.
MessagePropertiesA collection of message properties.
MPCThe MPC (Message Partition Channel) from which to receive files.
OtherDefines a set of configuration settings to be used by the adapter.
PollingIntervalThe amount of time, in seconds, between download attempts.
ProfileThe AS4 profile.
ReceiptContentThe content of the receipt.
ReceiptRefToMessageIdThe Message Id to which this receipt applies.
ReceivedFileNameThe name of the file received by the AS4 adapter.
RequeueEndpointsWhether to requeue receive endpoints if the polling interval has not been reached.
SendReceiptWhether to send a receipt.
ServiceThe service which acts on the message.
ServiceActionThe action within a service that acts on the message.
ServiceTypeThe type of service.
SignatureAlgorithmSignature algorithm to be used in the message.
SignerCertThe public signing certificate of the partner.
SigningCertThe certificate used to sign the outgoing AS4 message.
SSLAcceptServerCertFor sending HTTPS requests, a server certificate to unconditionally accept.
SSLCertThe certificate to use for client authentication during the SSL handshake.
TempPathA temporary local directory where data can be stored before the adapter processes it.
TimeoutA timeout for the adapter.
TokenPasswordThe password used in UsernameToken authentication.
TokenUserThe user used in UsernameToken authentication.
TransportLogTells the adapter where and how to report information about its operations.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
URLThe 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.

AgreementRefThe agreement reference.
AS4FromIdThe Id of the party. This value is required.
AS4FromIdTypeThe optional type of the Id. If specified this value should be the domain to which the Id belongs.
AS4FromRoleThis field specifies the role of the party. This may be any value agreed upon by the trading partners.
AS4ToIdThe Id of the party. This value is required.
AS4ToIdTypeThe optional type of the Id. If specified this value should be the domain to which the Id belongs.
AS4ToRoleThis field specifies the role of the party. This may be any value agreed upon by the trading partners.
CompressionFormatThe compression format (if any) to use.
ConversationIdThe Conversation Id of the message.
EDIFileNameThe file name to be used in outbound request.
EDIPropertiesA collection of file properties.
EDITypeThe Content-Type of the EDI message.
EncryptionAlgorithmThe algorithm, if any, used to encrypt the EDI data.
FirewallA set of properties related to firewall access.
HTTPPasswordA password if authentication is to be used.
HTTPProxyA set of properties related to proxy access.
HTTPUserA user name if authentication is to be used.
LogDirectoryThe path to a directory for logging.
LogFileThe log file written.
MaxPersistentConnectionsThe maximum number of simultaneous persistent connections when sending.
MaxThreadsThe maximum number of threads that the adapter may consume.
MaxTransmissionBatchSizeThe maximum number of messages that can be sent in a single batch.
MessageIdThe unique Id of the message.
MessagePropertiesA collection of message properties.
OtherDefines a set of configuration settings to be used by the adapter.
ProfileThe AS4 profile.
ReceiptContentThe content of the receipt.
ReceiptRefToMessageIdThe Message Id to which this receipt applies.
RecipientCertThe public certificate used to encrypt files when sending.
RefToMessageIdSpecifies the RefToMessageId in the message.
RequireReceiptWhether to require a receipt.
ServiceThe service which acts on the message.
ServiceActionThe action within a service that acts on the message.
ServiceTypeThe type of service.
SignatureAlgorithmSignature algorithm to be used in the message.
SignerCertThe public signing certificate of the partner.
SigningCertThe certificate used to sign the outgoing AS4 message.
SSLAcceptServerCertFor sending HTTPS requests, a server certificate to unconditionally accept.
SSLCertThe certificate to use for client authentication during the SSL handshake.
TimeoutA timeout for the adapter.
TransmitBatchModeHow the transmitter processes batches.
TransportLogTells the adapter where and how to report information about its operations.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
URLThe 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.

AllowWarningsWhether warnings are interpreted as fatal errors.
DetectDuplicatesWhether to detect duplicate messages when receiving.
EncryptionSecurityTokenFormatThe format to use for the security token when encryption.
SigningSecurityTokenFormatThe format to use for the security token when signing.
FilenamePropertyDefines a part property to hold the filename.
FromIdCountThe 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.
KeyEncryptionAlgorithmThe algorithm used to encrypt the key.
LogLevelThe level of information to log.
LogOptionsThe information to be written to log files.
RequireEncryptionWhether encryption is required when processing received messages.
RequireSignatureWhether a signature is required when processing received messages.
ReferenceHashAlgorithmThe hash algorithm used to has the data specified in the reference of a signature.
OAEPMGF1HashAlgorithmThe MGF1 hash algorithm used when encrypting a key.
OAEPRSAHashAlgorithmThe RSA hash algorithm used when encrypting a key.
OAEPParamsThe hex encoded OAEP parameters to be used when encrypting a key.
ToIdCountThe 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.
MaxDownloadsThe maximum number of downloads to perform in each polling interval.
TokenPasswordTypeThe password type used in UsernameToken authentication.
ReceiptURLThe URL to which receipts are sent.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlagsFlags that control certificate verification.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLSNamedGroupsThe supported (EC)DHE groups.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the adapter whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
/n software Adapters for BizTalk - Version 16.0 [Build 6659]