Receive properties in flows

The following are the receive properties fields for all protocols in flows using SecureTransport. Fields are described when the direction is sender pushes file and receiver pulls file. Default values are provided in the user interface. Change values to meet your needs.

Prerequisites

  • The flow is open in add or edit mode in the user interface.
  • SecureTransport is in the flow as a source, target or relay.

Multiple senders

If a flow has multiple senders, the user interface for receive properties behaves differently depending on the protocol.

Protocol preceding SecureTransport is SFTP, FTP or HTTP

If the protocol preceding SecureTransport in the flow is SFTP, FTP or HTTP, the UI displays a table that enables you to edit the receive properties for each sender by clicking Edit next to the sender's name. The Status column in the table indicates whether the properties for each sender are configured properly.

Protocol preceding SecureTransport is PeSIT

If the protocol preceding SecureTransport in the flow is PeSIT, the receive properties are the same for all senders, according to the flow direction set before SecureTransport.

SFTP, FTP, HTTP: Receive properties, sender pushes file

The following are the receive properties for SFTP, FTP and HTTP when SecureTransport is in the flow and the direction is sender pushes file.

Access Level

A transfer site's access level determines if other accounts can reuse this transfer site. For the following fields, the values are set when SecureTransport registers and are the default values.

Business unit

Sets the business unit value for the account on SecureTransport.

UID

Sets the numeric User ID of the account on SecureTransport.

GID

Sets the numeric Group ID of the account on SecureTransport.

Note When an account is created at flow deployment, the Home Folder Access Level for that account is set to Business Unit. Additionally, if Central Governance creates a Transfer site for an account when deploying a flow, then Business Unit is the Home Folder Access Level value. For more information, see SecureTransport Business Units.

File properties

Directory

The directory represents the path where the sender can push files to SecureTransport. Files received in this directory are handled as defined in Receive properties in flows and processed for sending as defined in Receive properties in flows.

The directory value is relative to the home folder of the sender account 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:

/ * ? " < > |

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. You can select:

No Action causes 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 To specifies the path to the subscription subfolder in the case of a move, or renames the file according to the file name expression.

SFTP, FTP, HTTP: Receive properties, receiver pulls file

The following are the receive properties for SFTP, FTP and HTTP when SecureTransport is in the flow and the direction is receiver pulls file.

Access Level

Business Unit

Sets the business unit value on SecureTransport for the account. The value set at SecureTransport registration is used by default.

UID

Sets the numeric User ID on SecureTransport for the account. The value set at SecureTransport registration is used by default.

GID

Sets the numeric Group ID on SecureTransport for the account. The value set at SecureTransport registration is used by default.

Note When an account is created at flow deployment, the Home Folder Access Level for that account is set to Business Unit. Also, when at flow deployment Central Governance creates a Transfer site in an account, it has Home Folder Access Level set to Business Unit. For more information about Business Unit use case scenarios check SecureTransport Business Units.

File properties

Remote directory

Represents the folder on the sender where SecureTransport pulls files. The directory value cannot contain:

\ * " < > |

File filter

Represents, when set, the filter on files SecureTransport pulls from the remote directory. You can select:

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 *\.(xml|txt), all XML and TXT files are downloaded.

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

If you do not use the field, all files in the remote directory are downloaded.

Directory

The directory represents the path where the sender can push files to SecureTransport. Files received in this directory are handled as defined in Receive properties in flows and processed for sending as defined in Receive properties in flows.

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

.. or .

Also, the name cannot contain:

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

It also 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:

/ * ? " < > |

Scheduler

You can specify a schedule for retrieving files from the sender. If not enabled, files are pulled according to a definition that is set externally and not in Central Governance.

When enabled, you can set a one-time or recurring schedule for pulling 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 for a schedule.

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. You can select:

No Action causes 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 To specifies the path to the subscription subfolder in the case of a move, or renames the file according to the file name expression.

On success

Specifies the action to take when transfers succeed. You can select:

No Action causes the files to stay in the original location. If the receiver re-triggers the transfer, the original file is pulled again.

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. This option is available only for SFTP and FTP.

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()}

PeSIT: Receive properties, sender pushes file

The following are the receive properties for PeSIT when SecureTransport is in the flow and the direction is sender pushes file.

Receive properties in flows control the behavior of a transfer when files are pushed over PeSIT to SecureTransport. You can define receive properties when SecureTransport is used as relay.

Access Level

Business Unit

Sets the business unit on SecureTransport for the account. The value set at SecureTransport registration is used by default.

UID

Sets the numeric User ID on SecureTransport for the account. The value set at SecureTransport registration is used by default.

GID

Sets the numeric Group ID on SecureTransport for the account. The value set at SecureTransport registration is used by default.

Note When an account is created at flow deployment, the Home Folder Access Level for that account is set to Public for PeSIT login accounts, and to Business unit for the other accounts. Additionally, Central Governance creates a Transfer Site in an account at flow deployment, which has its Home Folder Access Level set to Public for PeSIT login accounts and to Business unit for the other accounts. For more information, see SecureTransport Business units.

File properties

Receive file as

Name pf the files received when files are transferred to SecureTransport. The value is relative to the sender’s account home directory. It can contain any valid expression, including PeSIT expressions. The suggested default value is:

${basename(pesit.fileLabel)}-${timestamp}-${pesit.transferID}${extension(pesit.fileLabel)}

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()}

File encoding file type

Specifies the file type. Select Binary to send a mix of file types and ensure there is no custom encoding or transcoding required for the text files. Select EBCDIC (native) for files that use EBCDIC LF as the end-of-line character.

Note The EBCDIC LF depends on the local code page.

Overrides the predefined data encoding (PI16) in the transfer profile.

If you select Custom, you must enter a string. To preserve the PeSIT PI values transmitted by the source when sending to the target, enter the expression ${pesit.pi.dataEncoding}.

This field corresponds to the FCODE parameter in Transfer CFT.

Record format record type

Indicates whether the records in the file are fixed or variable length.

Overrides the predefined record format (PI31) in the transfer profile.

If you select Custom, you must enter a string. Enter the expression ${pesit.pi.recordFormat}to preserve the PeSIT PI values transmitted by the source when sending to the target.

This field corresponds to the FRECFM parameter in Transfer CFT.

Maximum record length

Specifies in bytes the maximum length of the records.

Overrides the predefined record length (PI32) in the transfer profile.

If you select Custom, you must enter a string. Enter the expression ${pesit.pi.recordLength} to preserve PeSIT PI values transmitted by the source when sending to the target.

This field corresponds to the FRECL parameter in Transfer CFT.

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. You can select:

No Action causes 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 To specifies the path to the subscription subfolder in the case of a move, or renames the file according to the file name expression.

PeSIT: Receive properties, receiver pulls file

The following are the receive properties for PeSIT when SecureTransport is in the flow and the direction is receiver pulls file.

Receive properties in flows control the behavior of a transfer when SecureTransport pulls files from the sender over PeSIT. You can define receive properties when SecureTransport is used as relay.

Access Level

Business Unit

Sets the business unit on SecureTransport for the account. The value set at SecureTransport registration is used by default.

UID

Sets the numeric User ID on SecureTransport for the account. The value set at SecureTransport registration is used by default.

GID

Sets the numeric Group ID on SecureTransport for the account. The value set at SecureTransport registration is used by default.

Note When an account is created at flow deployment, the Home Folder Access Level for that account is set to Public for PeSIT login accounts, and to Business unit for the other accounts. Additionally, Central Governance creates a Transfer Site in an account at flow deployment, which has its Home Folder Access Level set to Public for PeSIT login accounts and to Business unit for the other accounts. For more information, see SecureTransport Business units.

File properties

Receive file as

Name pf the files received when files are transferred to SecureTransport. The value is relative to the sender’s account home directory. It can contain any valid expression, including PeSIT expressions. The suggested default value is:

${basename(pesit.fileLabel)}-${timestamp}-${pesit.transferID}${extension(pesit.fileLabel)}

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()}

Files to receive

Indicates whether SecureTransport receives one file or multiple files.

One file means SecureTransport gets the first available file.

Multiple files mean SecureTransport gets all available files.

File encoding file type

Specifies the file type. Select Binary to send a mix of file types and ensure there is no custom encoding or transcoding required for the text files. Select EBCDIC (native) for files that use EBCDIC LF as the end-of-line character.

Note The EBCDIC LF depends on the local code page.

Overrides the predefined data encoding (PI16) in the transfer profile.

If you select Custom, you must enter a string. To preserve the PeSIT PI values transmitted by the source when sending to the target, enter the expression ${pesit.pi.dataEncoding}.

This field corresponds to the FCODE parameter in Transfer CFT.

Record format record type

Indicates whether the records in the file are fixed or variable length.

Overrides the predefined record format (PI31) in the transfer profile.

If you select Custom, you must enter a string. Enter the expression ${pesit.pi.recordFormat}to preserve the PeSIT PI values transmitted by the source when sending to the target.

This field corresponds to the FRECFM parameter in Transfer CFT.

Maximum record length

Specifies in bytes the maximum length of the records.

Overrides the predefined record length (PI32) in the transfer profile.

If you select Custom, you must enter a string. Enter the expression ${pesit.pi.recordLength} to preserve PeSIT PI values transmitted by the source when sending to the target.

This field corresponds to the FRECL parameter in Transfer CFT.

Scheduler

You can specify a schedule for retrieving files from the sender. If not enabled, files are pulled according to a definition that is set externally and not in Central Governance.

When enabled, you can set a one-time or recurring schedule for pulling 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 for a schedule.

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. You can select:

No Action causes 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 To specifies the path to the subscription subfolder in the case of a move, or renames the file according to the file name expression.

 

Central Governance | Document Directory

Related Links