GISB Adapter

The GISB Component adds GISB send and receive capabilities to BizTalk Server.

Remarks

The GISB Adapter adds GISB send and receive capabilities to BizTalk Server. Built on top of the IP*Works! EDI / GISB Engine, the adapter allows you to easily incorporate secure EDI (EDI-INT) exchange into your current e-Business process architecture.

GISB Receive Adapter

The GISB Receive Adapter implements a fully-functional GISB server that can communicate with your BizTalk Server. In order to use the GISB Receiver, you must set the GISBSiteURL where your GISB server is hosted, as well as the TradingPartner and ReceivingPartner GISB identifiers. The GISB 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.

If your messages require security, you must set the PGPProvider and PGPParams properties.

Once the incoming GISB 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 response to your trading partner.

The GISB 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.

GISB Send Adapter

The GISB Send Adapter adds a complete GISB client within your BizTalk Server. In order to use it, you must set a minimum of three required properties: DataTo, DataFrom and URL. It is also recommended that you set PGPProvider, PGPParams, EncryptData, and SignData in order to ensure security, reliability, and non-repudiation.

The GISB Send Adapter has support for SSL transport layer security. This may be enabled by setting the SSLCert and SSLAcceptServerCert to appropriate values.

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.


ErrorThreshold	The maximum number of errors before the component shuts down.
GISBSiteURL	The path to the website hosting the GISB component.
LogDirectory	The path to a directory for logging.
MaxThreads	The maximum number of threads that the component may consume.
Other	Defines a set of configuration settings to be used by the component.
PGPParams	Sets the parameters in the OpenPGP provider.
ReceivingPartner	The identity of GISB 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.
ServerId	The ID of your server.
Timeout	A timeout for the component.
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.

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.


DataFrom	The identity of the sending system.
DataTo	The identity of the receiving system.
EDIType	The type of the data to be sent.
EncryptData	Whether or not to encrypt the data.
Firewall	A set of properties related to firewall access.
GISBVersion	The version of GISB/NAESB being used.
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.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LogDirectory	The path to a directory for logging.
MaxThreads	The maximum number of threads that the component may consume.
MaxTransmissionBatchSize	The maximum number of messages that can be sent in a single batch.
Other	Defines a set of configuration settings to be used by the component.
PGPParams	Sets the parameters in the OpenPGP provider.
ReceiptSecurity	[1.6] Used to indicate the security options requested for the receipt.
ReceiptSigningProtocol	[1.6] Indicates the protocol used to sign the receipt.
ReceiptTo	[1.6] Used to request a receipt.
ReceiptType	[1.6] The type of receipt requested.
ReplyHeaders	The HTTP headers provided for the Response .
RequestStatus	The status of the request.
ResponseContent	The response returned from the server.
SignData	Whether or not to sign the data.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to use for client authentication during the SSL handshake.
Subject	The subject of the message.
Timeout	A timeout for the component.
TransmitBatchMode	How the transmitter processes batches.
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.
URL	The URL to post to.
UserAgent	Information about the user agent.

Config Settings

The following is a list of config settings for the Adapter with short descriptions. Click on the links for further details.


AllowOldPacketType	Whether to allow the older encrypted packet type.
AuthScheme	The authorization scheme to be used when server authorization is to be performed.
DataElementName[i]	The name of an additional data element.
DataElementValue[i]	The value of an additional data element.
ForceV3Signature	Whether to use v3 signatures.
PGPProvider	The OpenPGP provider provides an interface to the OpenPGP cryptography software.
PGPProviderType	Which PGP implementation to use.
SendResponseBeforeSubmit	Whether to send the response before submitting the message to BizTalk.
TransactionSet	The transaction-set to send in the request.
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.

GISB Receiver

How to Configure a GISB Receive Location with the BizTalk Server Administration Console

To configure the receive location by using the BizTalk Server Administration console, use the following procedure:

NOTE: Before completing the following procedure you must have already added a one-way receive port. For more information, see How to Create a Receive Port.

To configure receive location variables for a GISB receive location:

In the BizTalk Server Administration console, expand BizTalk Server Administration, expand BizTalk Group, expand Applications, and then expand the application you want to create a receive location in.
In the left pane, click the Receive Port node. Then in the right pane, right-click the receive port that is associated with an existing receive location or that you want to associate with a new receive location, and then click Properties.
In the left pane of the Receive Port Properties dialog box, select Receive Locations, and in the right pane double-click an existing receive location or click New to create a new receive location.
In the Receive Location Properties dialog box, in the Transport section next to Type, select nsoftware.GISB 2022 from the drop-down list, and then click Configure to configure the transport properties for the receive location.

In the nsoftware.GISB 2022 Transport Properties dialog box, you will find the following properties:


ErrorThreshold	The maximum number of errors before the component shuts down. Type: xs:int Default Value: 5
GISBSiteURL	The path to the website hosting the GISB component. Type: xs:string Default Value: "" NOTE: This property must have a value.
LogDirectory	The path to a directory for logging. Type: xs:string Default Value: ""
MaxThreads	The maximum number of threads that the component may consume. Type: xs:int Default Value: 20
Other	Defines a set of configuration settings to be used by the component. Type: xs:string Default Value: ""
PGPParams	Sets the parameters in the OpenPGP provider. Type: xs:string Default Value: ""
ReceivingPartner	The identity of GISB receiving entity. Type: xs:string Default Value: "" NOTE: This property must have a value.
RegisterIsolatedReceiverTimeout	This setting specifies the number of seconds the isolated receive adapter will search for a corresponding receive location. Type: xs:int Default Value: 15
RequeueEndpoints	Whether to requeue receive endpoints if the polling interval has not been reached. Type: bool Default Value: false
ServerId	The ID of your server. Type: xs:string Default Value: ""
Timeout	A timeout for the component. Type: xs:int Default Value: 60
TradingPartner	The trading partner that will be communicating with this receive location. Type: xs:string Default Value: "" NOTE: This property must have a value.
TransportLog	Tells the component where and how to report information about its operations. Type: Log Default Value: null
URI	The Uniform Resource Identifier (URI) of the send port or receive location. Type: xs:string Default Value: ""

Click OK.
Enter the appropriate values in the Receive Location Properties dialog box to complete the configuration of the receive location and click OK to save settings. For information about the Receive Locations Properties dialog box, see How to Create a Receive Location.

GISB Transmitter

Setting the GISB Adapter Configuration Properties for a Dynamic Send Port

A dynamic send port does not provide any transport configuration options in BizTalk Explorer because it is expected that these properties will be provided with the context properties associated with the message. These properties can be set in a custom pipeline or in an orchestration. To set message configuration properties in an orchestration you can do the following:

Add a Construct Message shape to your orchestration.
Configure the Construct Message shape to construct a new message. (for example Message_2)
Add a Message Assignment shape to the Construct Message shape.
Add code to the Message Assignment shape to initialize the message that you constructed and to set the appropriate configuration properties for the message.

Configuring the GISB Send Port with the BizTalk Server Administration Console

To configure the send port by using the BizTalk Server Administration console, use the following procedure:

To configure variables for a GISB send port:

In the BizTalk Server Administration console, create a new send port or double-click an existing send port to modify it. For more information, see How to Create a Send Port. Configure all of the send port options and specify nsoftware.GISB 2022 for the Type option in the Transport section of the General tab.
On the General tab, in the Transport section, click the Configure button next to Type.

In the nsoftware.GISB 2022 Transport Properties dialog box, use the following properties to:


DataFrom	The identity of the sending system. Type: xs:string Default Value: "" NOTE: This property must be specified.
DataTo	The identity of the receiving system. Type: xs:string Default Value: "" NOTE: This property must be specified.
EDIType	The type of the data to be sent. Type: xs:string Default Value: "X12"
EncryptData	Whether or not to encrypt the data. Type: bool Default Value: false
Firewall	A set of properties related to firewall access. Type: Firewall Default Value: null
GISBVersion	The version of GISB/NAESB being used. Type: xs:string Default Value: "1.4"
HTTPPassword	A password if authentication is to be used. Type: baf:Password Default Value: ""
HTTPProxy	A set of properties related to proxy access. Type: Proxy Default Value: null
HTTPUser	A user name if authentication is to be used. Type: xs:string Default Value: ""
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted. Type: xs:string Default Value: ""
LogDirectory	The path to a directory for logging. Type: xs:string Default Value: ""
MaxThreads	The maximum number of threads that the component may consume. Type: xs:int Default Value: 20
MaxTransmissionBatchSize	The maximum number of messages that can be sent in a single batch. Type: xs:int Default Value: 1
Other	Defines a set of configuration settings to be used by the component. Type: xs:string Default Value: ""
PGPParams	Sets the parameters in the OpenPGP provider. Type: xs:string Default Value: ""
ReceiptSecurity	[1.6] Used to indicate the security options requested for the receipt. Type: xs:string Default Value: "signed-receipt-protocol=optional, pgp-signature; signed-receipt-micalg=optional, sha1, md5"
ReceiptSigningProtocol	[1.6] Indicates the protocol used to sign the receipt. Type: xs:string Default Value: ""
ReceiptTo	[1.6] Used to request a receipt. Type: xs:string Default Value: ""
ReceiptType	[1.6] The type of receipt requested. Type: xs:string Default Value: "gisb-acknowledgement-receipt"
ReplyHeaders	The HTTP headers provided for the Response . Type: xs:string Default Value: ""
RequestStatus	The status of the request. Type: xs:string Default Value: "ok"
ResponseContent	The response returned from the server. Type: xs:string Default Value: ""
SignData	Whether or not to sign the data. Type: bool Default Value: false
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. Type: Certificate Default Value: null
SSLCert	The certificate to use for client authentication during the SSL handshake. Type: Certificate Default Value: null NOTE: The digital id must have a private key associated with it.
Subject	The subject of the message. Type: xs:string Default Value: ""
Timeout	A timeout for the component. Type: xs:int Default Value: 60
TransmitBatchMode	How the transmitter processes batches. Type: xs:int Default Value: 0
TransportLog	Tells the component where and how to report information about its operations. Type: Log Default Value: null
URI	The Uniform Resource Identifier (URI) of the send port or receive location. Type: xs:string Default Value: ""
URL	The URL to post to. Type: xs:string Default Value: "" NOTE: This property must be specified.
UserAgent	Information about the user agent. Type: xs:string Default Value: "/n Software GISB BizTalk Adapter - www.nsoftware.com"

Click OK and OK again to save settings.

DataFrom Property (GISB Adapter)

The identity of the sending system.

Data Type

String

Default Value

Remarks

Will generally be the DUNS number of the sending trading partner. Required.

This property is not available in the Receiver.

DataTo Property (GISB Adapter)

The identity of the receiving system.

Data Type

String

Default Value

Remarks

Will generally be the DUNS number of the receiving trading partner. Required.

This property is not available in the Receiver.

EDIType Property (GISB Adapter)

The type of the data to be sent.

Data Type

String

Default Value

"X12"

Remarks

The type of the data to be sent, generally "X12". You can also use the adapter to send error notifications; in this case set EDIType to "error" and set the data to be send as a description.

This property is not available in the Receiver.

EncryptData Property (GISB Adapter)

Whether or not to encrypt the data.

Data Type

Boolean

Default Value

false

Remarks

If true, then the data will be encrypted before sending to the server.

This property is not available in the Receiver.

ErrorThreshold Property (GISB Adapter)

The maximum number of errors before the component shuts down.

Data Type

Integer

Default Value

Remarks

This property limits the number of errors that the adapter can incur before it shuts down and stops processing messages.

If set to 0 the adapter will never shutdown.

Note that if the operation completes successfully the current error count will be reset.

This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Sender.

Firewall Property (GISB Adapter)

A set of properties related to firewall access.

Data Type

Firewall

Remarks

This is a Firewall type property which contains fields describing the firewall through which the adapter will attempt to connect.

This property is not available in the Receiver.

GISBSiteURL Property (GISB Adapter)

The path to the website hosting the GISB component.

Data Type

String

Default Value

Remarks

This is the virtual path of the application that will host the instance of the GISB adapter. It is not necessary to include the schema ("http") or host information: the adapter will ignore everything other than the path information. For example, if the URL you would post to is "http://localhost/GISBReceiver/GISBServer.aspx", you only need to set "/GISBReceiver/GISBServer.aspx".

This property is not available in the Sender.

GISBVersion Property (GISB Adapter)

The version of GISB/NAESB being used.

Data Type

String

Default Value

"1.4"

Remarks

The version of the GISB/NAESB EDM being used. Supported values are "1.4", "1.6", "2.0", and "2.1". Note that requesting a receipt is only supported in version 1.6 and up.

This property is not available in the Receiver.

HTTPPassword Property (GISB Adapter)

A password if authentication is to be used.

Data Type

Password

Default Value

Remarks

This property holds the password used for HTTP authentication.

This property is not available in the Receiver.

HTTPProxy Property (GISB Adapter)

A set of properties related to proxy access.

Data Type

Proxy

Remarks

This is a Proxy type property which contains fields describing the proxy through which the adapter will attempt to connect.

This property is not available in the Receiver.

HTTPUser Property (GISB Adapter)

A user name if authentication is to be used.

Data Type

String

Default Value

Remarks

This property holds the user used for HTTP authentication.

This property is not available in the Receiver.

LocalHost Property (GISB Adapter)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Data Type

String

Default Value

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the adapter initiate connections (or accept in the case of server adapters) only through that interface.

If the adapter is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

This property is not available in the Receiver.

LogDirectory Property (GISB Adapter)

The path to a directory for logging.

Data Type

String

Default Value

Remarks

Setting LogDirectory will instruct the component to log the details of each transmission to unique files in the specified directory. For each request processed, the adapter will log the original EDI data, the complete text of the outgoing request and the incoming response.

The adapter will write a single file for each transmission, with extension ".log". In case of error an additional file will be written with extension ".err", and the error will be reported in both files.

The filenames will be chosen automatically by the adapter. Each filename will be the system time, in the format YYYY-MM-DD-HH-MM-SS-MMMM, with extensions "-2", "-3", used in case files of those names already exist. After each transaction is processed LogFile will contain the name of the files just written, minus the extension ".log" or ".err".

If logs cannot be written an exception will be thrown.

MaxThreads Property (GISB Adapter)

The maximum number of threads that the component may consume.

Data Type

Integer

Default Value

Remarks

This property limits the number of concurrent threads that the adapter may consume while completing its work.

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

MaxTransmissionBatchSize Property (GISB Adapter)

The maximum number of messages that can be sent in a single batch.

Data Type

Integer

Default Value

Remarks

This property controls the maximum size of an outbound message batch.

Note: be careful when modifying this property as it directly effects the efficiency of the transmit adapter. Setting MaxTransmissionBatchSize to a low value in an environment that requires transmission of large quantities of data will result in the adapter accumulating several small batches. If TransmitBatchMode is set to Parallel, this will result in the adapter transmitting many small batches at once and can put a heavy load on the processor.

Conversely, if TransmitBatchMode is set to Serial, setting MaxTransmissionBatchSize to a large value may result in long transmission delays as the adapter will wait on existing work to complete before accepting new messages from the BizTalk Message Engine. This is especially true when the adapter is transmitting large data.

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Receiver.

Other Property (GISB Adapter)

Defines a set of configuration settings to be used by the component.

Data Type

String

Default Value

Remarks

The adapter accepts one or more configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the adapter, access to these internal properties is provided through the Other property.

The Other property may be set to one or more configuration settings (name/value pairs). Set one setting per line. For example: configname1=value1 configname2=value2

PGPParams Property (GISB Adapter)

Sets the parameters in the OpenPGP provider.

Data Type

String

Default Value

Remarks

This contains a list of all the parameters of your OpenPGP provider. Please refer to the documentation provided with the OpenPGP provider for the parameters required.

Each parameter should be listed on a separate line by itself. The parameters exist in name/value pairs separated by an '=' sign.

The following is an example of several OpenPGP parameters that may exist for this property:

gpg-path=C:\Program Files\GNU\GnuPg\gpg.exe homedir=C:\myhomedir passphrase=testpgp

ReceiptSecurity Property (GISB Adapter)

[1.6] Used to indicate the security options requested for the receipt.

Data Type

String

Default Value

"signed-receipt-protocol=optional, pgp-signature; signed-receipt-micalg=optional, sha1, md5"

Remarks

Only supported for Version 1.6.

By default, the adapter will request that the receipt be signed with an OpenPGP signature over an SHA1 or MD5 hash (if these algorithms are supported by the server).

Set ReceiptSecurity to an empty string to request an unsigned receipt.

The string format is that of the Disposition-notification-options HTTP header, as specified in RFC 3335.

This property is not available in the Receiver.

ReceiptSigningProtocol Property (GISB Adapter)

[1.6] Indicates the protocol used to sign the receipt.

Data Type

String

Default Value

Remarks

Only supported for Version 1.6.

This property will be populated after a receipt is received from the server and validated. It will contain the MIME type of the signature used, if any (i.e., "application/pgp-signature"). It will contain an empty string if the receipt is unsigned.

This property is not available in the Receiver.

ReceiptTo Property (GISB Adapter)

[1.6] Used to request a receipt.

Data Type

String

Default Value

Remarks

Only supported for Version 1.6.

If this property is set, a Receipt-Notification-To form variable will be added to the request, and a receipt will be requested. Generally this should be the same as DataFrom.

By default, the adapter will request a GISB-Acknowledgement-Receipt, signed with PGP and delivered synchronously in the HTTP reply. You may set ReceiptSecurity to request a different type of signature, or no signature at all.

This property is not available in the Receiver.

ReceiptType Property (GISB Adapter)

[1.6] The type of receipt requested.

Data Type

String

Default Value

"gisb-acknowledgement-receipt"

Remarks

Only supported for Version 1.6.

If ReceiptTo is set, the adapter will request a receipt of the indicated type. Note that the only type of receipt readable by the adapter is a gisb-acknowledgement-receipt, and only if using version 1.6 of the GISB/NAESB protocol.

The security settings for the receipt (signed or unsigned) may be configured by setting ReceiptSecurity.

This property is not available in the Receiver.

ReceivingPartner Property (GISB Adapter)

The identity of GISB receiving entity.

Data Type

String

Default Value

Remarks

This is the name of the trading partner that will be receiving GISB transmissions for this receive location. When data is received, this will value will be checked against the value supplied by the sending entity to ensure that the document received is intended for this receiver.

This property is not available in the Sender.

RegisterIsolatedReceiverTimeout Property (GISB Adapter)

This setting specifies the number of seconds the isolated receive adapter will search for a corresponding receive location.

Data Type

Integer

Default Value

Remarks

When processing an incoming request from the HTTP endpoints the adapter will look for the URI of a receive location which matches the incoming request. This process communicates with BizTalk and in high load scenarios this operation may require additional time to complete. The default value is 15 seconds. If an intermittent "Timeout while waiting for endpoint configuration" error is seen, set this to a larger value.

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Sender.

ReplyHeaders Property (GISB Adapter)

The HTTP headers provided for the Response .

Data Type

String

Default Value

Remarks

The HTTP headers provided for the Response.

This property is not available in the Receiver.

RequestStatus Property (GISB Adapter)

The status of the request.

Data Type

String

Default Value

"ok"

Remarks

RequestStatus will be determined from the server response after posting the data. If the request status is anything other than "ok" the adapter will throw an exception. Note that servers are not required to process data immediately, and a RequestStatus of "ok" is not a guarantee that the server was able to process your data.

The following is the complete list of error codes defined by the GISB 1.4 and NAESB 1.6 specifications.

The following is the complete list of error codes defined by the GISB 1.4 and NAESB 1.6 specification. Error codes only defined in version 1.6 are notated with "1.6" below, and errors that will be detected and reported automatically by the GISBReceiver adapter are indicated with an asterisk.

The following is the complete list of error codes defined by the GISB 1.4 specification.

EEDM100*: Missing From Common Code Identifier Code

EEDM101*: Missing To Common Code Identifier Code

EEDM102*: Missing Input Format

EEDM103*: Missing Data File

EEDM104: Missing Transaction Set

EEDM105: Invalid From Common Code Identifier

EEDM106: Invalid To Common Code Identifier

EEDM107: Invalid Input Format

EEDM108: Invalid Transaction Set

EEDM109: No Parameters Supplied

EEDM110: (1.6) Invalid "version"

EEDM111: (1.6) Missing "version"

EEDM112: (1.6) "receipt-security-selection" not mutually agreed

EEDM113*: (1.6) Invalid "receipt-security-selection"

EEDM114: (1.6) Missing "receipt-disposition-to"

EEDM115: (1.6) Invalid "receipt-disposition-to"

EEDM116: (1.6) Missing "receipt-report-type"

EEDM117: (1.6) Invalid "receipt-report-type"

EEDM118: (1.6) Missing "receipt-security-selection"

EEDM119: (1.6) Mutually agreed element, refnum, not present

EEDM601: Public Key Invalid

EEDM602: File Not Encrypted

EEDM603: Encrypted File Truncated

EEDM604*: Encrypted File Not Signed Or Signature Not Matched

EEDM699: Decryption Error

EEDM701: EDM Party Not Associated With EDI Party

EEDM702: Data Structure Error

EEDM703: Data Set Exchange Not Established For Trading Partner

EEDM999: System Error

WEDM100: Transaction Set Sent Not Mutually Agreed

WEDM102: (1.6) "receipt-security-selection" not mutually agreed

WEDM103: (1.6) Missing "receipt-security-selection"

WEDM104: (1.6) Element refnum received; not mutually agreed; ignored

This property is not available in the Receiver.

RequeueEndpoints Property (GISB Adapter)

Whether to requeue receive endpoints if the polling interval has not been reached.

Data Type

Boolean

Default Value

false

Remarks

This setting controls whether receive endpoints are requeued for later processing if the polling interval has not yet been reached. When this setting is set to No (default) each thread will block until the polling interval for the corresponding receive location is reached. If there exist more active receive locations than MaxThreads it is possible for some threads to block the execution of others since they may be waiting for a polling interval.

When this setting is set to Yes if the polling interval has not been reached the thread will not block until the polling interval is reached, and instead the endpoint will be requeued to be processed later. This lets subsequent endpoints in the queue to be processed.

If MaxThreads is set to a low value and there are a larger number of receive locations setting this to Yes will help assure that polling intervals are respected and receive locations poll in a timely manner.

The default value is No.

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Sender.

ResponseContent Property (GISB Adapter)

The response returned from the server.

Data Type

String

Default Value

Remarks

This property will be populated after a response is received from the server. If a receipt was requested this property will contain the receipt; otherwise this property will contain at least a small bit of HTML describing whether or not the transmission succeeded.

In case the receipt was signed, ResponseContent will contain the unsigned receipt, together with its MIME headers.

Note that if a signature was requested but an unsigned receipt is received the adapter will throw an exception.

This property is not available in the Receiver.

ServerId Property (GISB Adapter)

The ID of your server.

Data Type

String

Default Value

Remarks

The ID of your server, as it will be described in the response. If you do not specify ServerId the adapter will attempt to determine it when it generates the response.

This property is not available in the Sender.

SignData Property (GISB Adapter)

Whether or not to sign the data.

Data Type

Boolean

Default Value

false

Remarks

If true, then the data will be signed before sending to the server.

This property is not available in the Receiver.

SSLAcceptServerCert Property (GISB Adapter)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Data Type

Certificate

Remarks

If it finds any issues with the certificate presented by the server, the adapter will normally terminate the connection with an error. You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

This property is used to set a Public Key Certificate.

Ordinarily, the system will attempt to locate the public key in trusted certificate stores in the system registry. If a match is found, the certificate is trusted, and the process proceeds without error. If the certificate is not trusted, the adapter will report an error.

You may explicitly set a public key, either to accept a key that is not installed on the system, or to ensure that a specific key is presented. Public key certificates may be loaded from the machine registry or from file. If you click on the ellipses, a certificate selection dialog will open. To select a public key from the system registry, select the System Store tab or the User Store tab, and highlight the appropriate registry store. The list of available certificates will be shown below.

Alternatively, you may specify a public key on file. Select the PEM or Certificate File tabs to load a public key from file. You can use the browse button to examine the file system for the certificate that you wish to use. Public keys typically are stored in .CER, .DER, or .PEM files, but other formats may be used. You can click on the Open button to examine the contents of the certificate. Or, if you have a certificate stored in memory, you can write the contents of the certificate into the text box provided. Note that if you are loading a certificate from memory, the certificate must be Base-64 encoded, or the string representation of the certificate may become corrupted and uninterpretable.

Regardless of how you selected the certificate, once you hit the OK button, the adapter will attempt to verify that certificate selection. If successful, the subject of the certificate will be displayed in the property field. If the adapter was not able to verify the selection, a dialog box will appear instead detailing the verification error.

Note: You may also set the Accept Any field to Yes without opening the certificate selection dialog to force the adapter to unilaterally authenticate any server during the security handshake. It is strongly recommended that you use this only for testing purposes. Set the LogMode to Info to cause the adapter to report the server's credentials to Location.

This property is not available in the Receiver.

SSLCert Property (GISB Adapter)

The certificate to use for client authentication during the SSL handshake.

Data Type

Certificate

Remarks

This property is used to assign a specific certificate for SSL client authentication.

This field is used to set a Private Key Certificate.

Private key certificates may be loaded from the registry, from files in PKCS#12 format, or from a PEM file format. If you click on the ellipses, a certificate selection dialog will open. To select a private key from the system registry, select the System Store tab or the User Store tab, and highlight the appropriate registry store. The list of certificates which have private keys will be shown below.

To select a private key certificate from a file in PKCS#12 format, select the PFX Store tab. The browse button can be used to examine the file system for PKCS#12 (.pfx or .p12) certificates. If you wish to examine the certificate, provide the password in the field provided and click on the Open button to examine the file store for certificates present. To load a certificate from PEM files, select the PEM tab. Like the PFX file selection, you can specify the password and click the Open button to examine the certificates in the PEM store, or you may paste any PEM data stored in memory.

This property is not available in the Receiver.

Subject Property (GISB Adapter)

The subject of the message.

Data Type

String

Default Value

Remarks

The optional human-readable subject of the message.

This property is not available in the Receiver.

Timeout Property (GISB Adapter)

A timeout for the component.

Data Type

Integer

Default Value

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion, or an error condition is encountered.

If Timeout is set to a positive value, the adapter will wait for the operation to complete before returning control.

If Timeout expires, and the operation is not yet complete, the adapter fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when data is successfully sent or received.

Optionally, the behavior of the adapter may be changed to absolute timeouts, i.e. the adapter will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by the AbsoluteTimeout configuration setting.

The default value for the Timeout property is 60 (seconds).

TradingPartner Property (GISB Adapter)

The trading partner that will be communicating with this receive location.

Data Type

String

Default Value

Remarks

This is the name of the trading partner that will be communicating with this instance of the GISB adapter.

This property is not available in the Sender.

TransmitBatchMode Property (GISB Adapter)

How the transmitter processes batches.

Data Type

Enumeration

Possible Values

Parallel (0)
Serial (1)

Default Value

Remarks

This property controls how the transmitter processes message batches:


Parallel	The adapter will process however many batches the BizTalk Message Engine sends it. The number of maximum concurrent batches may be controlled by the MaxThreads property.
Serial	The adapter will queue batches from the BizTalk Message Engine and process them one at a time.

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Receiver.

TransportLog Property (GISB Adapter)

Tells the component where and how to report information about its operations.

Data Type

Log

Remarks

This is a Log type property which contains fields describing how and where the adapter will record information about its execution.

This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.

URI Property (GISB Adapter)

The Uniform Resource Identifier (URI) of the send port or receive location.

Data Type

String

Default Value

Remarks

This property specifies a URI for the send port or receive location. Setting this property is optional.

By default the adapter will automatically generate a URI. You may choose to specify your own value here to be used in place of the generated URI.

If this value is specified it must begin with the correct prefix, as seen in the default value.

URL Property (GISB Adapter)

The URL to post to.

Data Type

String

Default Value

Remarks

SSL will be used if and only if the URL scheme is "https". Note that generally signed, unencrypted messages would be sent using SSL, as encrypting the message would be redundant.

This property is not available in the Receiver.

UserAgent Property (GISB Adapter)

Information about the user agent.

Data Type

String

Default Value

"/n Software GISB BizTalk Adapter - www.nsoftware.com"

Remarks

Override the default with the name and version of your software.

This property is not available in the Receiver.

Certificate Type

The digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Store
String
Default Value: "MY"

The name of the certificate store for the client certificate.

The StoreType field specifies the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field in order to specify client certificates. If Store has a value, and Subject is set, a search for a certificate is initiated. Please refer to the Subject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.
SPC	Software publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

If the provider is OpenSSL, the certificate store is a file containing a certificate and a private key. This property must be set to the name of the file.

StorePassword
String
Default Value: ""

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

StoreType
CertStoreTypes
Default Value: 0

The type of certificate store for this certificate.

The adapter supports both public and private keys in a variety of formats. When the cstAuto value is used, the adapter will automatically determine the type. This field can take one of the following values:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CERTMGR adapter. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Subject
String
Default Value: ""

The subject of the certificate used for client authentication.

When this property is set, a search is performed in the current certificate store certificate with matching subject.

If an exact match is not found, the store is searched for subjects containing the value of the property.

When setting the property to a partial subject, CN= should be omitted. For example, the following code would find the certificate with subject CN=Test Certificate, OU=People, C=US

Example (Searching with partial subject)

Control.CertSubject = "Test"

If a match is not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

If a matching certificate is found, Subject is set to the full subject of the matching certificate.

Thumbprint
String (read-only)
Default Value: ""

The thumbprint of the certificate.

This field is used to specify the thumbprint of the certificate. When there are multiple certificates in the store that have the same subject, the thumbprint will be used to distinguish between them.

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public Certificate();

Creates a Certificate instance whose properties can be set.

public Certificate(string certificateFile);

Opens CertificateFile and reads out the contents as an X509 public key.

public Certificate(byte[] certificateData);

Parses CertificateData as an X509 public key.

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall such as the firewall Host and the FirewallType.

Fields

AutoDetect
Boolean
Default Value: False

Tells the adapter whether or not to automatically detect and use firewall system settings, if available.

FirewallType
FirewallTypes
Default Value: 0

Determines the type of firewall to connect through. The applicable values are the following:


fwNone (0)	No firewall (default setting).
fwTunnel (1)	Connect through a tunneling proxy. Port is set to 80.
fwSOCKS4 (2)	Connect through a SOCKS4 Proxy. Port is set to 1080.
fwSOCKS5 (3)	Connect through a SOCKS5 Proxy. Port is set to 1080.

Host
String
Default Value: ""

Name or IP address of firewall (optional). If a Host is given, requested connections will be authenticated through the specified firewall when connecting.

If the Host field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the Host field is set to the corresponding address. If the search is not successful, an error is returned.

Password
String
Default Value: ""

A password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.

Port
Integer
Default Value: 0

The TCP port for the firewall Host. See the description of the Host field for details.

Note that the Port is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.

User
String
Default Value: ""

A user name if authentication is to be used connecting through a firewall. If the Host is specified, the User and Password fields are used to connect and authenticate to the given Firewall. If the authentication fails, a trappable error is fired.

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public Firewall();

Log Type

A log where the component will record information about its operations.

Remarks

This describes how and where the adapter will record information describing its execution.

Fields

Location
String
Default Value: "Application"

This field describes the location where the logging information is to be written.

If the EventLog LogType has been chosen, this field must contain the name of the Event Log to which the information should be written. The default value for this field is "Application". If a value other than "Application" is set the computer must be restarted for the change to take effect. Note that the same event log must be used for all send ports and receive locations that use the same adapter.

If the File LogType has been chosen, this field must contain the location of the file to write logging information to on the file system.

The adapter also supports logging to files based on the current date and time. This allows for log files to be organized by days, months, or other intervals as specified. When specifying a log filename include a valid .NET date and time format string within the < and > characters. For instance C:\logs\sftp_<yyyyMMdd>.log or C:\logs\as2_<yyyyMMdd>T<hhmm>.log.

LogMode
LogModes
Default Value: 3

This field controls what information the adapter logs. The possible values have the following affect on the adapter's behavior:


Verbose	The adapter will report all information regarding the transport.
Info	The adapter will report all major operations, as well as all warnings and errors.
Warning	The adapter will report any conditions that could result in unpredictable behavior as well as errors.
Error	The adapter will report all errors that prevent normal operations from completing.
Fatal	The adapter will report only serious errors that cause the adapter to completely stop functioning.

LogType
LogTypes
Default Value: 1

This property controls where the adapter will log the information. The possible values have the following affect on the adapter's behavior:


None	The adapter will not report any logging information.
EventLog	The adapter will report all logging information to the event log. The specific event log must be defined in the Location field when this type is selected.
File	The adapter will report all logging information to a file. The desired file must be specified in the Location field when this type has been selected.

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public Log();

public Log(LogTypes logType, string location, LogModes logMode);

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy such as the Server and the AuthScheme.

Fields

AuthScheme
ProxyAuthSchemes
Default Value: 0

Use the AuthScheme field to tell the adapter which type of authorization to perform when connecting to the proxy. This is only used when the User and Password fields are set.

AuthScheme should be set to authNone (3) when no authentication is expected.

By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication. If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the adapter. Look at the configuration file for the adapter being used to find more information about manually setting this token.

If AuthScheme is set to authNtlm (4), NTLM authentication will be used. This option is only available in the SSL package.

For security reasons, setting this property will clear the values of User and Password.

AutoDetect
Boolean
Default Value: False

Tells the adapter whether or not to automatically detect and use proxy system settings, if available.

Password
String
Default Value: ""

A password if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]".

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Port
Integer
Default Value: 80

The TCP port for the proxy Server (default 80). See the description of the Server field for details.

Server
String
Default Value: ""

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the Server field is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the Server field is set to the corresponding address. If the search is not successful, an error is returned.

SSL
ProxySSLTypes
Default Value: 0

Determines when to use SSL for the connection to the proxy. The applicable values are the following:


psAutomatic (0)	Default setting. The connection to the Server is SSL-enabled for 'https' URL-s, and non SSL-enabled for other URL-s.
psAlways (1)	The connection is always SSL-enabled.
psNever (2)	The connection is not SSL-enabled.
psTunnel (3)	The connection is through a tunneling (HTTP) proxy.

User
String
Default Value: ""

A user name, if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]".

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public Proxy();

public Proxy(string server, int port);

public Proxy(string server, int port, string user, string password);

Config Settings (GISB Adapter)

The adapter accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the adapter, access to these internal properties is provided through the Other property.

GISB Config Settings

AllowOldPacketType: Whether to allow the older encrypted packet type.

By default the adapter will only encrypt data using the newer and more secure integrity protected data packet type. Old implementations such as PGP 6.5.8 may require the older less secure data packet type.

When set to True the adapter will read the features from the recipient key to determine if the older packet type is required. If the key does require the old packet type, then the older packet type will be used. If the key does not require the old packet type, then the new integrity protected packet type will still be used.

By default this value is False. This means under no conditions is the older less secure packet type used. The newer integrity protected packet type is always used.

Only enable this setting if you have a requirement to do so.

AuthScheme: The authorization scheme to be used when server authorization is to be performed.

Use the AuthScheme property to tell the component which type of authorization to perform when the HTTPUser and HTTPPassword properties are set. Possible values are:


0 (default)	Basic
1	Digest
2	Proprietary
3	None
4	NTLM
5	Negotiate
6	OAuth

DataElementName[i]: The name of an additional data element.

This setting may be used in conjunction with DataElementValue to specify additional fields in the request. For instance: DataElementName[0]=MyElement DataElementValue[0]=MyValue DataElementName[1]=AnotherElement DataElementValue[1]=AnotherValue This setting is only applicable to the send adapter.

DataElementValue[i]: The value of an additional data element.

This setting may be used in conjunction with DataElementName to specify additional fields in the request. This setting is only applicable to the send adapter.

ForceV3Signature: Whether to use v3 signatures.

This setting is used to force v3 signatures for compatibility with older PGP implementations (versions 5 through 7).

The default value is False. This setting is only applicable to the send adapter.

PGPProvider: The OpenPGP provider provides an interface to the OpenPGP cryptography software.

This setting is only required when PGPProviderType is set to 0 (External). Specify the absolute path of the .NET class library (.dll) which implements the interface described below. The provider will be loaded and called by the adapter at runtime.

When PGPProviderType is set to 0 (External) the GISB adapter does not by itself implement PGP, instead it uses the provider pattern to interface with external cryptography libraries. Am OpenPGP provider is a simple module that allows the adapter to offload OpenPGP operations to the OpenPGP software of your choice. The interface is designed to be generic in its ability to include various OpenPGP software and is limited to only the bare minimum capabilities required for a GISB message exchange. We include an OpenPGP provider implementation for GnuPG which may be used as a reference to implement other providers.

An OpenPGP provider is simply a class called "nsoftwarePGPProvider" that should have the following methods. The adapter uses reflection to access the methods of the provider. public void SetParam(string name,string value); public byte[] Encrypt(byte[] data); public byte[] Decrypt(byte[] data); public byte[] Sign(byte[] data); public bool VerifySignature(byte[] signature,byte[] signedData); The PGPParams property is used to specify the parameters required by the OpenPGP provider to perform the OpenPGP operation. Although the parameters needed may vary in different providers, we expect the following set to be necessary. The reference GnuPG provider interprets the following parameters.


1 (gpg-path)	The path to the OpenPGP executable for the desired implementation.
2 (homedir)	The directory containing the public keyring, secret keyring and trust database. Please note this defaults to the application preferences directory of the user, hence if the GNUPG provider is being used from a ASP.NET application, homedir should be specified.
3 (passphrase)	The passphrase to access the secret keys in the secret-keyring.
4 (userid)	The identifier used to identify a secret key within the secret-keyring.
5 (recipient-userid)	The identifier used to identify a public key within the public keyring.

The adapter expects the encryption to return an ASCII armored output and the signing to compute a detached signature. Note: GnuPG is the Free Software Foundation's implementation of OpenPGP. It is free software and is recommended by NAESB (in version 1.6 of the EDM specification) for use in GISB/NAESB applications.

GnuPG is not included with this package, so you should download the latest version from http://www.gnupg.org. You might use GnuPG (or other software) to import your trading partners' public keys, and to import or generate a private key for yourself. These operations are outside the scope of this software, so please see the GnuPG documentation for details.

PGPProviderType: Which PGP implementation to use.

This setting specifies which PGP provider is used. Possible values are:


0 (External)	An external provider such as GnuPG.
1 (Internal - default)	The adapter's own implementation.

By default all cryptographic operations will be performed by the adapter directly using an internal implementation. In this case PGPProvider is not used. When set to 1 (Internal) only the following parameters are applicable when setting PGPParams:

homedir
passphrase
userid
recipient-userid

When set to 0 (External) the adapter will rely on an external provider such as GnuPG which is accessed through the interface dll specified by PGPProvider.

SendResponseBeforeSubmit: Whether to send the response before submitting the message to BizTalk.

This setting applies to the receive adapter. The default value is True. By default, when receiving a message the adapter will process it and return a response to the sender before submitting the message to BizTalk. If this value is set to False, the message will be submitted to BizTalk and a custom pipeline may be used to further validate the message before sending a response. This is useful when additional verification is required. Set the "GISBRequestStatus" context property within the custom pipeline to specify a different value in the response.

TransactionSet: The transaction-set to send in the request.

This setting optionally specifies the transaction-set value to send in the request. This setting is only applicable to the send adapter.

SSL Config Settings

ReuseSSLSession: Determines if the SSL session is reused.

If set to true, the adapter will reuse the context if and only if the following criteria are met:

The target host name is the same.
The system cache entry has not expired (default timeout is 10 hours).
The application process that calls the function is the same.
The logon session is the same.
The instance of the adapter is the same.

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

SSLEnabledCipherSuites: The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the adapter will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when UseInternalSecurityAPI is False (default): // The "Other" property could contain ONE of the following lines: SSLEnabledCipherSuites=* SSLEnabledCipherSuites=CALG_AES_256 SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES Possible values when UseInternalSecurityAPI is False (default) include:

CALG_3DES
CALG_3DES_112
CALG_AES
CALG_AES_128
CALG_AES_192
CALG_AES_256
CALG_AGREEDKEY_ANY
CALG_CYLINK_MEK
CALG_DES
CALG_DESX
CALG_DH_EPHEM
CALG_DH_SF
CALG_DSS_SIGN
CALG_ECDH
CALG_ECDH_EPHEM
CALG_ECDSA
CALG_ECMQV
CALG_HASH_REPLACE_OWF
CALG_HUGHES_MD5
CALG_HMAC
CALG_KEA_KEYX
CALG_MAC
CALG_MD2
CALG_MD4
CALG_MD5
CALG_NO_SIGN
CALG_OID_INFO_CNG_ONLY
CALG_OID_INFO_PARAMETERS
CALG_PCT1_MASTER
CALG_RC2
CALG_RC4
CALG_RC5
CALG_RSA_KEYX
CALG_RSA_SIGN
CALG_SCHANNEL_ENC_KEY
CALG_SCHANNEL_MAC_KEY
CALG_SCHANNEL_MASTER_HASH
CALG_SEAL
CALG_SHA
CALG_SHA1
CALG_SHA_256
CALG_SHA_384
CALG_SHA_512
CALG_SKIPJACK
CALG_SSL2_MASTER
CALG_SSL3_MASTER
CALG_SSL3_SHAMD5
CALG_TEK
CALG_TLS1_MASTER
CALG_TLS1PRF

Example values when UseInternalSecurityAPI is True:

// The "Other" property could contain ONE of the following lines:
SSLEnabledCipherSuites=*
SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA
SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA

Possible values when UseInternalSecurityAPI is True include:

TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

If SSLEnabledProtocols is configured to use TLS 1.3 the following values are supported:

TLS_AES_128_GCM_SHA256
TLS_AES_256_GCM_SHA384

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols: Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:


TLS1.3	12288 (Hex 3000) (Experimental)
TLS1.2	3072 (Hex C00) (Default)
TLS1.1	768 (Hex 300) (Default)
TLS1	192 (Hex C0) (Default)
SSL3	48 (Hex 30)
SSL2	12 (Hex 0C)

Note: TLS 1.1 and TLS1.2 support are only available starting with Windows 7.

Note: Enabling TLS 1.3 will automatically set UseInternalSecurityAPI to True.

SSLIncludeCertChain: Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the transport log contains the full certificate chain. By default this value is False and only the leaf certificate will be present.

If set to True all certificates returned by the server will be present in the transport log. This includes the leaf certificate, any intermediate certificate, and the root certificate.

Note: When UseInternalSecurityAPI is set to True this value is automatically set to True. This is needed for proper validation when using the internal provider.

SSLSecurityFlags: Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:


0x00000001	Ignore time validity status of certificate.
0x00000002	Ignore time validity status of CTL.
0x00000004	Ignore non-nested certificate times.
0x00000010	Allow unknown Certificate Authority.
0x00000020	Ignore wrong certificate usage.
0x00000100	Ignore unknown certificate revocation status.
0x00000200	Ignore unknown CTL signer revocation status.
0x00000400	Ignore unknown Certificate Authority revocation status.
0x00000800	Ignore unknown Root revocation status.
0x00008000	Allow test Root certificate.
0x00004000	Trust test Root certificate.
0x80000000	Ignore non-matching CN (certificate CN not-matching server name).

TLS12SignatureAlgorithms: Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.

This setting specifies the allowed server certificate signature algorithms when UseInternalSecurityAPI is True and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the adapter will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the adapter will fail with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: // The "Other" could contain ALL of these lines: UseInternalSecurityAPI=true SSLEnabledProtocols=3072 TLS12SignatureAlgorithms=sha1-rsa,sha1-dsa,sha256-rsa,sha256-dsa The default value for this setting is "sha1-rsa,sha1-dsa,sha224-rsa,sha224-dsa,sha256-rsa,sha256-dsa,sha384-rsa,sha384-dsa,sha512-rsa,sha512-dsa".

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups: The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and UseInternalSecurityAPI is set to True, the values refer to the supported groups for ECC. The following values are supported:

"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448"
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1"
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096"
"ffdhe_6144"
"ffdhe_8192"

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

"rsa_pkcs1_sha256" (default)
"rsa_pkcs1_sha384" (default)
"rsa_pkcs1_sha512" (default)

The default value is rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448" (default)
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096" (default)
"ffdhe_6144" (default)
"ffdhe_8192" (default)

General Config Settings

AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

LocalHost: The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

The LocalHost configuration contains the name of the local host as obtained by the Gethostname() system call, or if the user has assigned an IP address, the value of that address.

If the adapter is connected, the LocalHost configuration shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

TcpNoDelay: Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to False, the adapter will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to True.

Setting this configuration setting to True tells the adapter to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.

If using the .NET Standard Library, this setting will be True on all platforms. The .NET Standard library does not support using the system security libraries.

Note: This setting is static. The value set is applicable to all adapters used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.

Supported Macros

The adapter also supports the following Macros. These values are not case sensitive and would be supplied to a property in the form %MacroName%.

TempThis is resolved to the full path to the system's temporary directory. MessageIDGlobally unique identifier (GUID) of the message in BizTalk Server. SourceFileNameThe original file name. This includes the extension and excludes the file path, for example, Sample.xml SourceFileNameNoExtThe original file name without the extension or file path, for example, Sample RemoteFileNameThe name of the file as it was uploaded to the remote server. This includes the extension and excludes the file path, for example, Sample.xml. Valid only for AS3, FTP, and SFTP Send Adapters. DestinationPartyName of the destination party. DestinationPartyQualifierQualifier of the destination party. SourcePartyName of the source party. SourcePartyQualifierQualifier of the source party. DateTime:CustomFormatThis special value allows you to specify your own custom time format. For instance DateTime:yyyy would be resolved to the 4 digit year. DateThe date format yyyy-MM-dd. DateTimeThe date format yyyy-MM-ddThhmmss. TimeThe date format hhmmss. DateTime_BTS2000The date format yyyyMMddhhmmssf. DateTime.TZThe date format yyyy-MM-ddThhmmsszzz. Time.TZThe date format hhmmsszzz. Property#<Schema>#<Name>This special value allows you to include a property from the incoming message. For instance "PROPERTY#http://schemas.microsoft.com/BizTalk/2003/system-properties#ReceivePortName" would resolve to the ReceivePortName property of the message.