Send properties in flows

The following are the send 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 receivers

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

Protocol after SecureTransport is SFTP, FTP or HTTP

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

Protocol after SecureTransport is PeSIT

If the protocol after SecureTransport in the flow is PeSIT, the send properties, with one exception, are the same for all receivers, according to the flow direction set after SecureTransport. The file filter is the only property configured for each receiver.

If the receiver is a group of applications, a file filter is configured for each application in the group.

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

The following are the send 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. The following field 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

Remote directory

Represents the directory on the receiver where SecureTransport pushes files.

The directory value cannot contain:

\ * " < > |

File name sent

You can use the expression language to specify the criteria you want to match. The expression uses the criteria provided to create a new file name from the original file name.

If the field is not used, the name of the received file is unchanged when the file is sent.

See regular expressions topics in the SecureTransport Administrator Guide for details.

Example 1. New file name based on the current file name (since the transformation might have changed it):

${basename(currentfulltarget)}.sent

Example 2. New file name based on the original filename with a timestamp:

${basename(transfer.target)}..${timestamp}.${extension(transfer.target)}

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.

Post-sending actions – Post-routing (local)

The post-routing actions are deployed in the subscription. Actions are applied to files that have triggered a route package.

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 subfolder in the subscription folder where the file is moved, or how to rename the file according to the file name expression.

On success

Specifies the action to take when a transfer is successful. HID may 2018, conflicting updates

Post-sending actions – Post-transmission (remote)

The post-transmission settings are deployed to the Transfer site.

Rename file as

Specifies a value to send the file with a different name, which can be an expression.

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 from:

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 a value to rename the remote file after transmission, or moves the file to a different remote folder. You can use an expression to specify a file name/folder. Applies to SFTP and FTP.

On success

Specifies the action to take when transfers are successful. Applies to SFTP and FTP.

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.

Move/Rename File To specifies a value to rename the remote file after transmission, or moves the file to a different remote folder. You can use an expression to specify a file name/folder.

Allow Overwrite Existing File deletes the target file and repeats the rename process. This occurs if the rename operation failed because the target exists. Applies only to SFTP.

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

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

Access Level

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

Business unit

Sets the business unit value for the new account on SecureTransport.

UID

Sets the numeric User ID of the new account on SecureTransport.

GID

Sets the numeric Group ID of the new 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.

Transfer properties

File exists

Detects duplicate transfers on the remote directory. Actions you can specify for duplicates are:

Cancel refuses the transfer.

Overwrite replaces an existing file by overwriting it.

Rename allows the transfer but renames the existing file.

Rename transferred file leaves the existing file name as-is but renames the transferred file.

Append renames the transferred file by appending it. The name is derived from the name specified in the Publish file as field. For example:

If file name is myFile.txt, the file is renamed myFile (new copy 1).txt.

However, if this file already exists, the file is renamed myFile (new copy 2).txt.

If the file does not have an extension, the name transformation is the same but without the extension. For example, myFile (new copy 1).

File properties

Directory

The directory where SecureTransport makes available files for the receiver to pull. The directory value cannot contain the following characters:

\ * " < > |

Publish file as

Represents the name of the published file. If this field is not used, the name used is the name of the file SecureTransport received from the sender.

You can use the regular expression language to specify creating a file name. See regular expressions topics in the SecureTransport Administrator Guide for details.

Example 1. New file name based on the current filename (since the transformation might have changed it):

${basename(currentfulltarget)}.sent

Example 2. New file name based on the original filename with a timestamp:

${basename(transfer.target)}..${timestamp}.${extension(transfer.target)}

File filter

Represents, when set, the filter on files SecureTransport publishes to the receiver. 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.

Post-sending actions – Post-routing (local)

The post-routing actions are deployed on the subscription, and are applied to the files that triggered the route package.

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 are successful. The actions are the same as for On failure.

Post-sending actions - post-transmission (remote)

Deploys the post-transmission settings to the transfer site.

Rename file as

Specify a value to send the file using a different name. You can use an expression value to specify the file name.

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 for a rename. You can use an expression to specify a file name/folder. Applies to SFTP and FTP.

On success

Specifies the action to take when the transfer is successful. Applies to SFTP and FTP.

No Action leaves the files in the original location. If another file with the same name is transferred to this location, the original file is overwritten.

Move/Rename File To specifies a value to rename the remote file after transmission or move it to a different remote folder. An expression language can be used to specify a file name/folder.

Allow Overwrite Existing File – deletes the target file and repeats the rename process when enabled and if the rename operation fails because the target already exists. Applies only to SFTP.

Post-download actions

On success

Specifies the action to take after files are downloaded.

No Action specifies nothing is done.

no actions take place on the downloaded files.

Delete removes the file from the directory where SecureTransport received the it.

PeSIT: Send properties, sender pushes file

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

Transfer properties

User message

Overrides the predefined user message (PI99) in the PeSIT transfer site. To preserve the predefined user message, leave the field blank. To preserve PeSIT PI values transmitted by the source when sending to the target, enter the expression ${pesit.pi.serviceParam}.

This field corresponds to the PARM in Transfer CFT.

Access Level

When a flow is deployed, Central Governance creates accounts and Transfer site(s) in the account. A Transfer Site's access level determines if other accounts can reuse this transfer site.

Business unit

Sets the business unit value for the new account on SecureTransport.

UID

Sets the numeric User ID of the new account on SecureTransport.

GID

Sets the numeric Group ID of the new account on SecureTransport.

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 other accounts. Additionally, Central Governance creates a Transfer site for an account when a flow is deployed, which has Home Folder Access Level set to Public for PeSIT login accounts and to Business unit for other accounts. For more information about Business unit use cases, see SecureTransport Business units.

File properties

Send properties > File properties can accept SecureTransport expressions if either:

  • A source is sending to a SecureTransport relay via PeSIT, and then sends via PeSIT
  • A SecureTransport is pulling files from a source via PeSIT, and then sends via PeSIT

File name sent

Overrides the file label (PI37) predefined in the transfer profile. If you select Custom, you must enter a string. Enter the expression ${pesit.pi.fileLabel} to preserve PeSIT PI values transmitted by the source when sending to the target.

This field corresponds to the NFNAMEClosedIn Transfer CFT, the name of the physical file at the receiver partner site. in Transfer CFT.

File filter

Select the method for filtering the files.

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

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

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.

Archive files

On failure

Specifies if files that are transferred unsuccessfully are archived.

If you select Default, the flow archiving setting inherits the account archiving setting. For flows deployed on Central Governance, the account and business units have the archiving set to Default. This means that flows inherit the global archiving setting: Setup > File archiving.
If you set Setup > File archiving to:

Disabled: The archive fields deployed from Central Governance are hidden in SecureTransport.

Enabled:  And additionally you set On failure to Default in Central Governance, the actual value at the time of a file transfer is the value of the Global archiving policy. If you set On failure to Disabled, archiving is disabled at the time of the file transfer, regardless of the Global archiving policy setting.

The Setup > File archiving > Archive folder and Delete files older than options specify the location where the file is archived and the duration of the archiving, respectively.

On success

Specifies if files that are transferred successfully are to be archived. Possible actions are the same as for On failure.

For more information, please see Flow and transfer monitoring.

Post-sending 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 are successful. The actions are the same as for on failure.

PeSIT: Send properties, receiver pulls file

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

Transfer properties

File exists

Detects duplicate transfers on the remote directory. Actions you can specify for duplicates are:

Cancel refuses the transfer.

Overwrite replaces an existing file by overwriting it.

Rename allows the transfer but renames the existing file. For example, if the file is named myFile.txt, it is renamed myFile(old copy 1).txt. But if that file already exists, the new name is myFile (old copy 2).txt.

Rename transferred file leaves the existing file name as-is, but renames the transferred file. The name is derived from the name specified in the Publish file as field. If file name is myFile.txt, it is renamed myFile (new copy 1).txt. But if this file already exists, the file is renamed myFile (new copy 2).txt. If the file does not have an extension, the name transformation is the same but without the extension. For example, myFile (new copy 1).

Append renames the transferred file by appending it.

File properties

When a receiver pulls files from SecureTransport, the SecureTransport Send properties > File properties section does not support SecureTransport expressions. Preserving the File properties PeSIT PI values only applies when SecureTransport is the sender.

File name sent

Overrides the file label (PI37) predefined in the transfer profile. If you select Custom, you must enter a string. Enter the expression ${pesit.pi.fileLabel} to preserve PeSIT PI values transmitted by the source when sending to the target.

This field corresponds to the NFNAMEClosedIn Transfer CFT, the name of the physical file at the receiver partner site. in Transfer CFT.

Files to send

Indicates whether one or multiple files are transferred.

File filter

Select the method for filtering the files.

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

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

Publish file as

Represents the name of the published file. If this field is not used, the name used is the name of the file SecureTransport received from the sender.

You can use the regular expression language to specify creating a file name. See regular expressions topics in the SecureTransport Administrator Guide for details.

Example 1. New file name based on the current filename (since the transformation might have changed it):

${basename(currentfulltarget)}.sent

Example 2. New file name based on the original filename with a timestamp:

${basename(transfer.target)}..${timestamp}.${extension(transfer.target)}

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-sending 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 are successful. The actions are the same as for on failure.

Post-download actions

On success

Specifies the action to take after files are downloaded.

No Action specifies nothing is done.

no actions take place on the downloaded files.

Delete removes the file from the directory where SecureTransport received the it.

 

Central Governance | Document Directory

Related Links