Source fields in flows

The following describes the fields when SecureTransport is used as the source in a flow. See SecureTransport as source in flows for an example of SecureTransport as the source in a flow.

Receive properties

The following are the receive properties when SecureTransport is the source in a flow.

Storage type

From the drop-down list, select the type of storage to use:

The fields that display depend on the installation on the SecureTransport.

For SecureTransport corresponding fields, see: Storage for SecureTransport as source in flow and Storage for SecureTransport as target in flow.

For concepts, see: SecureTransport as source in flows  and SecureTransport as target in flows.

Folder monitoring

The following fields specify how SecureTransport scans the application directory.

Directory to scan

The absolute path for the directory where the application puts files for SecureTransport.

File filter

The method for filtering the files in the directory to scan.

Regular expression uses a regular expression for the filter. See regular expressions topics in the SecureTransport Administrator Guide for details. For example, if you specify *\.(txt|xml), all TXT and XML files are filtered.

File globbing uses wildcard characters to specify a pattern. For instance, ? matches any single character and * matches any number of characters. For example, if you specify *.xml, all XML files are filtered.

Scan sub-directories

Specify whether files in subdirectories of the directory to scan are filtered.

Directory depth

When scan sub-directories is enabled, specifies the depth of subdirectories to scan.

Sub-directory filter

Specifies the names of subdirectories to scan. You can use regular expressions or file globbing.

Regular expression uses a regular expression for the filter. See regular expressions topics in the SecureTransport Administrator Guide for details. For example, if you specify (ORDERS|INVOICES), only ORDERS and INVOICES directories are scanned.

File globbing uses wildcard characters to specify a pattern. For instance, ? matches any single character and * matches any number of characters. For example, if you specify *PART*, all directories containing PART are scanned.

Scheduler

You can specify a schedule for retrieving files from the application directory. If not enabled, folder monitoring is triggered according to a global set of properties that is set externally and not in Central Governance.

When enabled, you can set a one-time or recurring schedule for monitoring files. You can specify a frequency ranging from daily to annually and set specific times of day. You also can define a validity period by setting start and end dates. Lastly, you can use the Specific time(s) field to expressly define an exact time (hour and minutes) for the scheduled file retrieval.

SMB

Central Governance supports SMB versions 1.0 and 1.2.

SMB

Disable DFS

Select this option to disable DFS referrals. Disabling can be important in non-domain environments where domain-based DFS referrals (that normally run when SecureTransport first tries to resolve a path) can timeout, causing a significant startup delay.

Host

The SMB address, IP, or host for transfers. You can enter the port value in the format host: port.

Download settings

Download advanced expression

Select to use expression language in the Download folder value.

Example

To specify that only the files contained in a directory name that ends with the current date should be downloaded, enter folder_$(date(“yyyMMdd”)).

Download folder

The absolute path to the directory where the application puts files for SecureTransport.

Pattern advanced expression

Check this option if you want to use an expression language for Download pattern.

Example

When the transfer site is being executed, you might want to only download the files that have the current date appended to the name of the file. To do so, set this field to *_$(date(“yyyMMdd”)).txt . If the current date is 20180719, only the files ending with _20180719.txt are downloaded.

Download pattern

The pattern used to filter the files to be downloaded.

Receive file as

Name of the files scanned when files are retrieved from an application folder and moved on the SecureTransport side. The value is relative to the generic SecureTransport account home directory. You can use a limited expression language to specify the file name.

Example

file_$(random())

Login credentials

User name

The name of the SMB account used to log on the SMB connector. When empty, the SMB login is anonymous, and is used for sharing a folder.

Password

The SMB account password.

S3

Site settings

Bucket

Endpoint URL of the web service

Autocreate bucket on upload if it doesn't exist

Enables creating bucket when uploading an S3 bucket if it does not exist.

Network zone

The network zone that defines the proxy to use for transfers through the site. Possible values: "none", "any", "Default", and custom Network Zone names.

Site credentials

Access Key ID

If no credentials are specified, the AWS default credential provider chain is used (Amazon AWS mechanism for fetching Amazon S3 credentials from the environment, for example environment variables, EC2 instance profiles and containers).

Secret Access Key

Secret key for S3 authentication.

Transfer settings

Use HTTPS

A flag indicating if the connection should be secured.

Verify certificate for this Site

A flag indicating if there should be verification that the remote system is trusted. This verification applies only when `ghttpSecureHttpEnabled` is set to true.

Enable FIPS Transfer Mode

Specify if the FIPS Transfer Mode is enabled or disabled.

Download settings

Download object key/folder

If the specified object ID represents an S3 folder (ends with a / character), all files from that folder are downloaded.

If the field is left empty, no objects are downloaded.

Recursive Download

If this is enabled, all sub-folders of the specified download folder is scanned and the download is performed recursively. Additionally, the folder structure is preserved.

User defined download metadata

User defined download metadata is evaluated using expression language.

Pattern settings

Pattern type

Pattern matching expression supports Regular Expression or File Globbing ('regex' or glob' respectively).

Download pattern

When  "File Globbing" is selected, the String representation of the filename is matched using a limited pattern language that resembles regular expressions, but with a simpler syntax.

Post actions

Enable Receive File As

Enables receiving file with different name.

Receive File As

Specify a value to receive the file with a different name. A limited expression language can be used to specify a file name.

Available environment variable: ${ts.target} - the original file name

Examples

  • file_${random()}
  • ${ts.target}

On failure

On Failure Action

On transfer failure, you can choose to take no action, move the file to a given directory or delete the source file.

Move To

Specify a full path value to rename the remote file on transmission failure or move it to a different remote folder. A limited expression language can be used to specify a file name/folder.

Do not start the Move/Rename File on Failure value with a forward slash /.

Example

Use current date as a file name: ${date('yyyyddMMHHmmss')}

On success

On Success Action

On transfer success, you can choose to take no action, move the file to a given directory or delete the source file.

Move To

Specify a full path value to rename the remote file on transmission failure or move it to a different remote folder. A limited expression language can be used to specify a file name/folder.

Do not start the Move/Rename File on Failure value with a forward slash /.

Example

Use current date as a file name: ${date('yyyyddMMHHmmss')}

Advanced settings

Cipher suites

The cipher suites to be used for SSL connection. The cipher suites must be comma separated.

Enabled SSL protocols

The enabled SSL protocols. The protocols must be comma separated. The default value is TLSv1.2.

Enable Verbose Logging

You can disable Jclouds logging for performance reasons.

Syncplicity

Central Governance supports Syncplicity versions 1.0 and 1.5.

Site settings

App Key

The Syncplicity consumer key of the application.

App Secret

The Syncplicity consumer secret key of the application.

Application Token

The Syncplicity admin application token.

Server settings

Network Zone

The network zone that defines the proxy to use for transfers through the site.

User settings

User email

The user email address on whose behalf the operations are executed. The user email can be evaluated using expression language.

Transfer settings

Verify certificate for this site

A flag indicating if there should be verification that the remote system is trusted.

Enable FIPS Transfer Mode

A flag indicating if FIPS mode is enabled. If enabled - restrict SecureTransport to use only FIPS 140-2 Level 1 certified cryptographic libraries.

Advanced settings

Note The Cipher suites field is not deployed on SecureTransport from Central Governance.

Enable SSL protocols

The enabled SSL protocols. The protocols must be comma separated. The default value is TLSv1.2.

Note Central Governance cannot deploy a protocol if its name contains the ’_’ character.

Receive timeout

The socket timeout in seconds. A non-zero timeout blocks the input stream associated with the socket with this amount of time. A timeout of zero is interpreted as an infinite timeout. The default value is 25 seconds.

Connect timeout

The connection timeout in seconds. A timeout of zero is interpreted as an infinite timeout. The connection then blocks until it is reestablished or an error occurs. The default value is 25 seconds.

Retries number

How many retries to be executed in case of status code 429. The default value is 3.

Number of files returned in list

Maximum number of items to be loaded per service call. The default value is 1000 items.

Download settings

Advanced Expression

When set to true, the download folder is evaluated using expression language.

Download folder

The SyncPoint name to which files are transferred. The first folder in the path is considered as a SyncPoint.

Download Pattern Type

The download file pattern type. Pattern matching expression supports "glob" and "regexp" syntaxes.

Download Pattern

When "File Globbing" is selected, the String representation of the filename is matched using a limited pattern language that resembles regular expressions, but with a simpler syntax.

Send options

Send File As

Specify a value to send the file with a different name. An expression language can be used to specify a file name.

On Success

Share a SyncPoint with one or more Syncplicity users or user groups after successful upload.

Default is No Action

The On Success field can be either "No Action" and "Share Folder". If you choose "Share Folder", the following three fields display.

Set Read permissions

Available when On Success is set to Share Folder. User or group permission for a SyncPoint. The user emails or group names of the participants are comma-separated.

Set Read/Write permissions

Available when On Success is set to Share Folder. User or group permission for a SyncPoint. The user emails or group names of the participants are comma-separated.

Send notifications

Available when On Success is set to Share Folder. Send email notifications for upload folder sharing to participants emails.

Note You cannot deploy a flow with the Share Folder option without setting Set read permissions, Set Read/Write permissions, or both.

Shared Links Access Policy

This policy allows you to restrict the access to the shared link. By default the shared link will be accessible by specific recipients, inside or outside your company account, only after they have authenticated themselves. Alternatively, you may configure this policy to only allow users inside your company account to access the shared links after they have authenticated themselves. Third option is to allow anyone to access the shared link.

Share Link Users

Users or user groups to share the file link with. The user emails or group names of the participants are comma-separated.

Shared Link Password

The shared file link protection password at least 6 characters long. The password should be communicated separately.

Shared Link Expiration

The shared file link expiration in days.

Share Link Message

Message sent in the email.

Receive options

Receive File As

Specify a value to receive the file with a different name. An expression language can be used to specify a file name.

On Success

The Post Transmission action on success download to be executed.

Scheduler

You can specify a schedule for retrieving files from the application directory. If not enabled, folder monitoring is triggered according to a global set of properties that is set externally and not in Central Governance.

When enabled, you can set a one-time or recurring schedule for monitoring files. You can specify a frequency ranging from daily to annually, and set specific times of day. You also can define a validity period by setting start and end dates. Lastly, you can use the Specific time(s) field to expressly define an exact time (hour and minutes) for the scheduled file retrieval.

File properties

Directory

The path of the directory where files retrieved via folder monitoring are moved. These files are processed for sending as defined in send properties.

The directory value is relative to the home folder of the generic account for monitoring application folders defined in SecureTransport.

For SecureTransport on Linux, the directory name cannot be equal to:

.. or .

The name also cannot contain:

/../ or /./ or // or : * ? " < > |

It cannot start with:

../ or ./ or ~

And it cannot end with:

/.. or /.

For SecureTransport on Windows, the directory name cannot contain drive letters or the following characters:

/ * ? " < > |

Receive file as

Name of the files scanned when files are retrieved form an application folder and moved on the SecureTransport side. The value is relative to the generic SecureTransport account home directory. It can contain any valid expression.

If a file name expression begins with /, the transformed file is put in the subfolder indicated by this file name expression relative to the subscription folder. Otherwise, the transformed file is put in the subfolder indicated by this file name expression relative to the source file folder.

Example 1. Append current date to the target file name:

${stenv['target']}_${date('yyyyddMMHHmmss')}

Example 2. Append a random ID to the file name:

${stenv['target']}_${random()}

Post-reception actions

On failure

Specifies the action to take when transfers fail. A failure occurs when the transfer is incomplete and all retry attempts have failed. Options:

  • No Action Keeps the files to stay in the original location. If another file with the same name is transferred to this location, the original file is overwritten.
  • Delete Removes the files from the original location.
  • Move/Rename File Requires you to specify a directory to move the files and an expression for renaming the files.

Azure

Central Governance supports Azure version 1.3.

Site Settings

Connection Type

The Azure storage connection type. Supported connection types include:

  • Connection string (CS)
  • Shared Access Signature (SAS)
  • Public storage container reference (PSCR)

Account Name

The Azure storage account name. Only displays when Connection string is selected.

Account Key

The Azure storage account key. Only displays when Connection string is selected.

Endpoint Suffix

The Azure endpoint suffix. Only displays when Connection string is selected.

Storage Resource URI

The Azure storage Resource URI, which must start with HTTP or HTTPS. Only displays when Shared Access Signature is selected.

SAS Parameters

The Azure storage SAS parameters. Only displays when Shared Access Signature is selected.

SAS Signature

The Azure storage SAS signature. Only displays when Shared Access Signature is selected.

URL

Only displays when Public storage container reference is selected.

Container Name

The Azure Blob container name.

Create Container

Create new Blob container if a container with the specified name does not exist.

Blob Type

The Blob type of the files uploaded via this transfer site.

  • Block blobs store text and binary data.
  • Append blobs are optimized for append operations. Append blobs are ideal for scenarios such as logging data from virtual machines.
  • Page blobs store random access files.

Append Zero Padding

Append zero-byte padding to files to align their size with Page Blob size. Only available when Page is selected as type.

Network Zone

The network zone that defines the proxy to use for transfers through the site.

HTTPS Enabled

Use secure connection.

Verify Certificate

A flag indicating if there should be verification that the remote system is trusted.

NoteIf HTTPS is used, the Microsoft Azure certificate is trusted by default on SecureTransport and is not provided via Central Governance.

Download Settings

Download Folder

The folder name (blob prefix) of the Azure Blob container to download files from. This property is expression language enabled.

Download Recursively

A flag indicating if there should be verification that the remote system is trusted.

Preserve Folder Structure

A flag indicating if the Blob container folder structure should be copied in SecureTransport for downloaded blobs.

Download Pattern Type

The download file pattern type.

  • Regular expression
  • Glob

Download Pattern

The download file pattern. This property is expression language enabled.

Download Metadata

Key-value pairs that describe what metadata should be added in ST flow attributes for the downloaded blob, in the following format <ST flow attribute name>=<value>. This property is expression language enabled, so the values can specify azure blob metadata properties. Each key-value pair must be on a new line.

Upload Settings

Upload Folder

Flag to define whether the upload folder can be modified by the Send To Partner routing step.

NoteWhen SecureTransport is source, the Upload Folder is not used and should be set to a forward slash (/).

Advanced Settings

SSL Cipher Suites

The enabled SSL protocols. The protocols must be comma separated. The default value is `TLSv1.2`

Enabled SSL protocols

The enabled SSL protocols. The protocols must be comma separated. The default value is `TLSv1.2`

Receive Timeout

The socket timeout in seconds. Any non-zero time out will block the input stream associated with the socket with this amount of time. A timeout of zero is interpreted as an infinite timeout. The default value is 25 seconds.

Connect Timeout

The connection timeout in seconds. A timeout of zero is interpreted as an infinite timeout. The connection will then block until established or an error occurs. The default value is 25 seconds.

Receive Options

Enable Receive File As

Flag to define if sending file with different name is enabled.

On Receive Success

The Post Transmission action to be executed on successful download.

On Success Rename To

Indicates where to move or rename the blob on successful download. This property is expression language enabled.

Delete Snapshots On Success

Flag to define if existing blob snapshots should be deleted by delete/move/rename PTA.

On Success Overwrite Existing

Flag to define if an existing blob can be overwritten by move/rename PTA.

Enable Scheduler

Event

Configure specific scheduler or disable scheduler to use the global monitoring settings. Values are yes/no (default).

You can specify a schedule for retrieving files. If not enabled, folder monitoring is triggered according to a global set of properties that is set externally and not in Central Governance.

When enabled, you can set a one-time or recurring schedule for monitoring files. You can specify a frequency ranging from daily to annually and set specific times of day. You also can define a validity period by setting start and end dates. Lastly, you can use the Specific time(s) field to expressly define an exact time (hour and minutes) for the scheduled file retrieval.

File processing

See File processing properties in flows.

Send properties

The send properties depend on the flow direction and the protocol between SecureTransport and the next participant in the flow. See Send properties in flows.

 

Central Governance | Document Directory

Related Links