/n software BizTalk Adapters V4 - Online Help
Available for:
/n software BizTalk Adapters V4
Questions / Feedback?

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

S3 Configuration Settings

DeleteOnSuspend:   Specifies whether files may be deleted from server when message is suspended.

If true, the file on the server will be deleted in accordance with the option selected in DeleteMode even if the message is suspended.

The default value is False.

IgnoreBucketRestrictions:   Allows the user to ignore Amazon-defined bucket name restrictions.

Bucket name restrictions are enforced by default. This configuration settings allows you to override the adapter's validation, and set the Bucket property with any arbitrary string. The following restrictions are enforced:

  • Bucket names can contain lowercase letters, numbers, periods, underscores, and dashes.
  • Bucket names must start with a number or letter.
  • Bucket names must be between 3 and 63 characters long.
  • Bucket names should not end with a dash.
  • Bucket names cannot contain two adjacent periods.
  • Bucket names cannot contain dashes next to periods.
  • Bucket names must not be formatted as an IP address (eg:
ObjectDelimiter:   A delimiter that can be used to roll up a bunch of keys.

Used by the ListObjects operation. The keys that contain the same string between the ObjectPrefix and the first occurrence of ObjectDelimiter will be rolled up into a single result element.

ObjectMarker:   A marker for the object(s).

Used by the ListObjects operation. When set, only the objects that are lexically after the marker are listed. This option, in conjunction with the MaxObjects option can be used for pagination.

ObjectPrefix:   A prefix for the object(s).

Used by the ListObjects operation to filter the list of returned objects. This can be set to a prefix for the objects to be returned within the specified Bucket.

MaxObjects:   The maximum number of objects for the server to return.

The maximum number of objects to be returned by the ListObjects operation. The default value is -1, which does not send the server a limit on the amount to return.

StorageClass:   Specify the storage class to be used for the uploaded object.

Setting this option on the adapter allows you to control the storage class of an uploaded object. Valid options are:

1Standard storage (default)
2Reduced Redundancy storage

URL:   If set, the default URL will be overridden by this value.

By default, the adapter uses the Amazon URL for the service. Setting this config will override this value.

UseServerSideEncryption:   If true, use server side encryption.

By default, this config is set to false. At the time of object creation, that is, when you are uploading a new object or making a copy of an existing object, you can specify if you want Amazon S3 to encrypt your data with AES256.

SSL Configuration Settings

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 240). 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.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30)
SSL2 12 (Hex 0C)

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

General Configuration 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.

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

UseManagedSecurityAPI:   Tells the adapter whether or not to use the system security libraries or a managed implementation.

By default the adapter will use the system security libraries to perform cryptographic functions. This means 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 to True tells the adapter to use the internal managed implementation instead of using the system's security API.

Note that when this value is set the product's system dll is no longer required as a reference, as all unmanaged code is stored in this 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.

Copyright (c) 2017 /n software inc. - All rights reserved.
Build 4.0.6240.0