OpenPGP Configuration

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.

OpenPGP Configuration Settings

RecursiveDecryptMode: Whether the encrypted data should be decrypted recursively.

In some instances data will be encrypted multiple times. This configuration option determines how the adapter will handle this situation. Options are:


0	Automatic - If the PGP message contains the special header version "PGP Command Line" then recursive decryption will be attempted. (Default)
1	Always attempt recursive decryption.
2	Never attempt recursive decryption.

LogDebugData: Whether to include debug information in the log.

This setting may be set to True to include detailed debug information in the log. The log mode should also be set to Verbose when using this setting. This may be helpful for troubleshooting purposes. The default value is False.

PublicKeyringFile: The name of the public keyring file.

This setting may be used to specify an alternative public keyring file. By default the adapter will look for the file "pubring.gpg" in the homedir. Specify this setting to provide an alternative filename. This may be set to a filename without path such as "pubring.pkr" in which case the adapter will search for this file in the homedir. This may also be set to a full path such as "C:\keyring\pubring.pkr".

SecretKeyringFile: The name of the secret keyring file.

This setting may be used to specify an alternative secret keyring file. By default the adapter will look for the file "secring.gpg" in the homedir. Specify this setting to provide an alternative filename. This may be set to a filename without path such as "secring.skr" in which case the adapter will search for this file in the homedir. This may also be set to a full path such as "C:\keyring\secring.skr".

SSOPassword: Specifies the key name in the SSO configuration that holds the key passphrase value.

The pipeline component can be configured to retrieve the key passphrase value from a key in an SSO application configuration. To use this approach you must first create a configuration for the application. To do this you can use the SSO Configuration Application MMC Snap-In. After installation follow these steps.

Create an application named "nsoftware.BizTalk".
Add a new key/value pair. The value should hold the password.
Set SSOPassword to the key name.

This approach allows the key passphrase to be managed by SSO, and the pipeline component to retrieve the value referenced by the key supplied here.

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%.


Temp	This is resolved to the full path to the system's temporary directory.
MessageID	Globally unique identifier (GUID) of the message in BizTalk Server.
SourceFileName	The original file name. This includes the extension and excludes the file path, for example, Sample.xml
SourceFileNameNoExt	The original file name without the extension or file path, for example, Sample
RemoteFileName	The 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.
DestinationParty	Name of the destination party.
DestinationPartyQualifier	Qualifier of the destination party.
SourceParty	Name of the source party.
SourcePartyQualifier	Qualifier of the source party.
DateTime:CustomFormat	This special value allows you to specify your own custom time format. For instance DateTime:yyyy would be resolved to the 4 digit year.
Date	The date format yyyy-MM-dd.
DateTime	The date format yyyy-MM-ddThhmmss.
Time	The date format hhmmss.
DateTime_BTS2000	The date format yyyyMMddhhmmssf.
DateTime.TZ	The date format yyyy-MM-ddThhmmsszzz.
Time.TZ	The date format hhmmsszzz.