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

Zip Configuration Settings

Append: Specifies whether to append files.

If set to True the adapter will append files to the archive specified by ArchiveFile. ArchiveFile must be set to the location of an archive on disk. If the file does not exist it will be automatically created. The default value is False.

Note: TempPath is not applicable when this is set to True.

ArchiveFile: The location of the archive file on disk.

This setting specifies the location of an archive file on disk. This is only applicable when Append is set to True.

CompressionMethod: Used to set the method of compression.

This is used to specify different compression methods. By default the adapter uses the Deflate compression method (a value of 0). Supported values are:


Value	Method
0	Deflate (default)
1	PPMd
2	bzip2

PlainPassword: Allows you to specify a password stored in plaintext.

By default the Password value will be encrypted with a machine specific key. This secures the password, however the pipeline must be compiled and deployed on the same machine so the same key can be used to decrypt the value. In certain cases you may wish to store the password value in plaintext so decryption is not required at runtime. This setting would be used to specify this like so:

PlainPassword=yourpassword

In this case you would not specify any value for Password.

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

The pipeline component can be configured to retrieve the password 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 password 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.