/n software Workflow Activities V4 - Online Help
Available for:
/n software Workflow Activities V4
Questions / Feedback?

FTP Configuration

The activity 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 activity, access to these internal properties is provided through the Other property.

FTP Configuration Settings

DirEntryPattern:   Allows the use of regular expressions to parse non-standard directory entry formats.

In some cases, the server may return a directory entry format that can not be automatically parsed by the adapter. In this case the full entry format can be seen You can then use this property to define a regular expression to parse the entry. The value of this setting is specified in the following format:


A,B,C,X=Y|RegEx
A,B,C, and X represent integer values that correspond to the capturing groups of the regular expression in the following order:
  • FileName
  • FileSize
  • FileTime
  • IsDir

Since group X represents the IsDir value, the user must specify Y to indicate what value that group must have in order for IsDir to be true.

Take for instance a simple entry in this format:

22 Test.txt
In this example "22" is the FileSize and "Test.txt" is the FileName. In order to parse this entry we will define the DirEntryPattern as:
2,1,-1,-1|([0-9]+)\s(.*)
The first value "2" indicates that the first field (FileName) corresponds to the second capturing group in the regular expression. The second value "1" indicates that the second field (FileSize) corresponds to the first capturing group in the regular expression. The capturing group is the regular expression in parenthesis. In the above example, the first capturing group is ([0-9]+) and the second capturing group is (.*).

As seen in the above example -1 can also be specified as the integer value. When this is specified that field is ignored.

CheckFileExists:   Whether to check if the remote file exists before uploading.

If set to "FALSE" the adapter will not perform a directory listing to check for the presence of the file on the server before uploading the file.

NOTE: This setting is only applicable to the FTP Transmitter.

PortRange:   Allows the specification of a port range the activity listens to.

When set to use active mode (Passive = False), the activity uses any available port to listen to incoming connections from the server. You can override this behavior by setting PortRange to a value containing the range of ports the activity will be listening to.

The range is provided as start-end, for instance: "1024-" stands for anything higher than 1024, "1024-2048" stands for ports between 1024 and 2048 inclusive, "4000-4010, 50000-50010" stands for ports between 4000 and 40010 or between 50000 and 50010.

RenameTo:   A filename to which RemoteFile will be renamed.

After downloading a file, the file on the server may be renamed using this setting. This rename action will take place after the batch submission to BizTalk. If you need to perform actions on a file before this, use the AfterGet property. This setting is used in conjunction with RenameMode to conditionally rename a file. For instance, to rename a file after it has been successfully submitted to BizTalk set the Other property of the activity like so:

RenameTo=%SourceFileName%.done
Macros such as %SourceFileName% are supported as in the given example. A full list of supported macros can be found at the bottom of this section.
RenameMode:   The condition under which RenameTo is used.

This setting controls when the value specified by RenameTo is used. If RenameTo is not specified, this setting has no impact. By default, downloaded files are only renamed after being successfully submitted to BizTalk (a value of 1). Possible values are:

1 (OnSuccess - default)The file is renamed using the value in RenameTo only after the message is successfully submitted to BizTalk.
2 (OnFailure)The file is renamed using the value in RenameTo only after the message submission to BizTalk fails.
3 (Always) The file is renamed using the value in RenameTo regardless of the message submission result.

TemporaryDownloadExtension:   An extension to be appended during download.

During download, it may be necessary for the file on the server to be renamed. After the download is complete the file will be renamed back to the original name.

TemporaryUploadExtension:   An extension to be appended during upload.

During upload, it may be necessary for the RemoteFile to be written to a temporary file name. For example, some business process may be set up to expect a specific file extension. Using this setting will allow the activity to upload the file without the remainder of the process attempting to pick up the incomplete file.

ReuseSSLSessionInDI:   Whether the SSL session will be reused for the DI connection.

When set to True (default), the activity will ask the server to reuse the existing DI SSL session. When set to False, a new SSL session will always be created for the DI connection.

ReusePISSLSessionInDI:   Whether the PI SSL session will be reused for the DI connection.

When set to True, the activity will reuse the PI SSL session when creating the DI connection. The default value for this configuration setting is False, in which case, the activity will create a separate SSL session for the DI connection.

UseClearCommandChannel:   Allows for the Clear Command Channel (CCC) command.

When set, the activity will send the CCC command to the server requesting a clear (unprotected) command channel.

UseClearDataChannel:   Allows for the PROT C command.

When this is set, the activity will use a clear (unprotected) data channel by sending the PROT C command to the server.

UseFSwitch:   Specifies whether or not the -F parameter is used when listing directory contents.

This is only applicable when UseSimpleDirList is set to true. When UseSimpleDirList is true, the activity issues the command "NLST -F <filemask>". The -F parameter tells the server to omit folder names from the response. Some server do not support the -F parameter. To disable the use of the -F parameter set UseFSwitch to False. The default value is True.

UseMLSD:   Uses listings for machine processing.

When this is set to True the activity will list files in the directory using the MLSD command. This command is an extension to the protocol which defines a more standardized and reliable directory listing format. Not all servers support this command. The default value is False.

UseProtWhenImplicit:   Sends PROT P to the server.

The task/adapter will send the PROT P command to the server explicitly indicating that the data channel will be protected when this is set. This only applies when the SSLStartMode is set to sslImplicit.

UseRemoteHostAddressForPassive:   Instructs the activity to use the FTPServer in passive mode.

This setting is only used when Passive is true. When this is set to false (default), the activity parses the remote host to send replies to from the previous response from the server. If this is true, the activity uses the value at FTPServer instead.

UseModeZ:   Allows compression to be used when transferring data.

The default value is false. When set to true the activity will issue the "MODE Z" command to the FTP server. This will enable deflate compression so all data transferred is first compressed either by the server (when downloading) or by the activity (when uploading). Note that not all servers support this feature.

ModeZCompressionLevel:   Used to specify the level of compression used.

The default value is 7. Valid values are from 0 to 9. A higher value indicates a higher compression level is used. This is only valid when UseModeZ is set to True.

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 activity initiate connections (or accept in the case of server activitys) only through that interface.

If the activity 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 activity whether or not to use the system security libraries or a managed implementation.

By default the activity 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 activity 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.

Connections Configuration Settings

PersistedConnectionTimeout:   How long to leave a persisted connection alive.

If persisted connections are enabled and PersistedConnectionTimeout is set to a positive value, the connection will be kept alive for that number of minutes after a message transmission. If no other messages are sent over that connection during the timeout period, the activity will disconnect from that server.

Note: the default value is 0. This value means that the connection will be kept alive unless the server disconnects it due to idling.

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