File processing properties in flows

The following are the file processing properties when SecureTransport is in the flow. The fields are the same regardless of direction or protocol.

Note All of the following fields provide a Description field, where you can optionally enter information about the field.

If a flow has multiple senders and receivers, the user interface displays a table that enables you to configure the file processing properties for each sender-receiver pair by clicking Edit next to the pair's names. The Status column in the table indicates whether the properties for each pair are configured properly.

Condition

Represents, when configured, a set of comparison expressions, functions and logical operations for defining the files to route to the receiver. When no value is set, the trigger condition is always used. When a value is defined, the trigger condition is based on the entered expression. Use expression languageClosedSecureTransport uses an expression language (EL) based on the Sun JSP Expression Language. See the SecureTransport documentation for details. The following SecureTransport features can use EL: transfer site post-transmission actions, subscription post-transmission actions, PGP, account templates. to define the route trigger condition.

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

Example 1. Files uploaded only through a specific protocol:

${extension(transfer.target) eq '.txt'}

Example 2. Files uploaded from specific partner over PeSIT:

${pesit.pi.senderID.toLowerCase() eq 'partner'}

Processing type

Select a processing type and see the fields and descriptions for the type. You can enter a description for the selected processing type.

PGP encryption

Enable to encrypt or sign files, or both, with PGP keys. The matching PGP keys for encrypting or signing are detected at runtime. The keys must exist on SecureTransport or transfers fail. Only keys in non-delimited ASCII (ASC) file format are supported.

You can import PGP keyrings that contain one master DSA or RSA key and a set of sub-keys, where each PGP keyring must have at least one sub-key. This mandatory sub-key must be RSA for an RSA master key, and Elgamal for a DSA master key.

Note See the Access and Security Guide for more information.

File filter

Select the method for filtering the files to process.

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

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

Operations

Select the encryption and signature settings.

Encrypt and sign means all files are encrypted and signed.

Encrypt only means all files are encrypted but not signed.

Sign only means all files are signed but not encrypted.

Encryption key

Specifies the SecureTransport public PGP key for encrypting files to partners, applications, unmanaged products or other relays.

You can select the alias of an existing public PGP key or upload a new key. For a new key, upload the key in an ASC file and specify an alias. The user interface warns if you try to add a duplicate alias. All aliases are unique on SecureTransport.

Signing key

Specifies the SecureTransport private PGP key for signing files to partners, applications, unmanaged products or other relays.

Once you provide a password, you can select the alias of an existing private PGP key or upload a new key. For a new key, upload the key in an ASC file and specify an alias. The user interface warns if you try to add a duplicate alias. All aliases are unique on SecureTransport.

Compression

Specifies the type of compression.

Use preferred uses recipient's PGP key to determine the compression method. If the data compression method you choose is not one of the recipient’s preferred methods, the recipient cannot access the data.

Compression level

Specifies the level of compression. Fast to Best represent the compression ratio. As compression file size decreases, the time to compress increases.

Encode using ASCII armor

Specifies whether ASCII armor encoding is used. ASCII armor refers to using binary-to-text encoding for plain text data.

PGP decryption

Enable this option to decrypt files that were encrypted with PGP keys or verify signatures of files signed with PGP keys. You also can specify whether transfers fail if files are not encrypted and signed. The matching PGP keys for decryption and signature verification are detected at runtime. The keys must exist on SecureTransport or transfers fail. Only keys in non-delimited ASCII (ASC) file format are supported.

File filter

Select the method for filtering the files to process.

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

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

Decryption

Specifies when to decrypt files.

Always means all files are expected to be PGP-encrypted and will be decrypted. Transfers fail when SecureTransport receives or pulls unencrypted files.

Only if encrypted means only PGP-encrypted files are decrypted. Unencrypted files are processed normally.

Decryption key

Specifies the SecureTransport private PGP key for decrypting files from partners, applications, unmanaged products or other relays or picked up from an application via folder monitoring.

Once you provide a password, you can select the alias of an existing private PGP key or upload a new key. For a new key, upload the key in an ASC file and specify an alias. The user interface warns if you try to add a duplicate alias. All aliases are unique on SecureTransport.

Signature verification

Specifies when to verify signed files.

Always means all files are expected to be PGP-signed and will be verified. Transfers fail when SecureTransport receives or pulls files not signed with a trusted PGP key.

Only if signed means only PGP-signed files are verified. Unsigned files are processed normally.

Verification key

Specifies the public key for validating PGP signatures of files SecureTransport receives or pulls from a participant.

You can select the alias of an existing public PGP key or upload a new key. For a new key, upload the key in an ASC file and specify an alias. The user interface warns if you try to add a duplicate alias. Aliases are unique at the participant level.

PGP public keys used for signature verification belong to any of the following types of participants that send files or put files in SecureTransport: partners, applications, unmanaged products and products acting as relays.

A new PGP public key is linked to its owner when uploaded. You can use the same key in other flows where the key owner is involved.

Decompression

Enable to decompress ZIP, JAR, GZIP or TAR files. Then select a filter method and specify the name of the decompressed files.

File filter

When decompression is enabled, select the method for filtering the files to decompress.

Regular expression uses a regular expression for the filter. See regular expressions topics in the SecureTransport documentation for details. For example, if you specify *\.(zip|tar), all ZIP and TAR files are decompressed.

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 *.zip, all ZIP files are decompressed.

Use archive password

Specifies whether a password is required to decompress the archive. Enter the password in the provided fields.

Compression

Enable to compress files as ZIP, JAR, GZIP or TAR files. Then select a filter method and specify the name of the compressed files.

File filter

When compression is enabled, select the method for filtering the files to compress.

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

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

Algorithm

Specifies the algorithm to use for compression.

Level

Specifies the speed of the compression. For ZIP, JAR and GZIP the following compression levels are available: Store (level 0), Fast (level 1), Normal (level 3), Good (level 5), Best (level 6). TAR supports only Store.

Use archive password

Specifies whether a password is required to decompress the archive. Enter the password in the provided field.

Archives

Specifies whether to compress files singly or together in one archive.

Line ending

Enable to change line endings in files. Then select a filter method and specify the end of record characters in files.

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 documentation 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, ? matches any single character and * matches any number of characters. For example, if you specify *.xml, all XML files are processed.

Source and Target

Specify line ending characters and encoding for source and target files.

The available line-ending formats are CRLF, LF and custom.

If custom, specify the hex encoded value of the line ending character. This is any character \n, \r, and the combination of both. The custom line ending char in Unicode notation:

Windows: \u000d\u000a

*nix, MacOS: \u000a

Mainframe: \u0025

Select the file encoding format from the available formats in the drop-down list.

Character replacement

Enable to replace one or more sequences of characters in files. Then select a filter method and specify the encoding and transcoding of the files.

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 documentation 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, ? matches any single character and * matches any number of characters. For example, if you specify *.xml, all XML files are processed.

Find lines with

Specify a single or multiple sequences of characters to find in files, separated by commas.

Characters in ASCII and Unicode \uXXXX format are supported.

Delete found lines

Specify whether the lines with the found characters must be deleted in the file.

Yes means found lines are removed.

No means found lines are replaced with specific characters.

Replace with

Replace with one string or comma-separated strings in same respective order as find, in ASCII or Unicode \uXXXX format.

Example 1. Find is a,b,c. If replace is 123 and found text is axbxxc, after the file the file is processed, the text becomes 123x123xx123.

Example 2. Find is aaa,bbb,ccc. If replace is 123,456,789 and found text is aaaxbbbxxccc, after the file is processed, the text becomes 123x456xx789.

Source and Target encoding

Select the file encoding format from the available formats in the drop-down list for the source and target.

Line truncating

Enable truncating lines to a given line width. Then select a filter method and specify the encoding and transcoding of the files.

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 documentation 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, ? matches any single character and * matches any number of characters. For example, if you specify *.xml, all XML files are processed.

Truncate length

Specify the maximum length to which lines are truncated.

Source and Target encoding

Select the file encoding format from the available formats in the drop-down list for the source and target.

Line padding

Enable padding lines to a given line width. Then select a filter method and specify the encoding and transcoding of the files.

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 documentation 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, ? matches any single character and * matches any number of characters. For example, if you specify *.xml, all XML files are processed.

Line length

Specify the maximum length that lines must be padded to.

Padding character

Specify the Unicode character format \uXXXX used for padding lines.

Source and Target encoding

Select the file encoding format from the available formats in the drop-down list for the source and target.

External script

Enable and manage external script execution as part of a SecureTransport flow.

Execution phase

For each file transfer, specify whether to execute the defined script before or after routing. Options include:

  • Pre-routing (default): The external script step occurs in SecureTransport prior to the SendToPartner or PublishToAccount routing step.
  • Post-routing: The external script step occurs in SecureTransport after the SendToPartner or PublishToAccount routing step.

Filename

Enter an absolute path to the script. You can use regular expressions.

  • Linux example: /usr/bin/env bash -c $(FILEDRIVEHOME)/bin/agents/example.sh
  • Windows example: cmd \c $(FILEDRIVEHOME)\bin\agents\example.bat

Redirect output to server log

Select Yes to send the script output to the sever log.

 

Central Governance | Document Directory

Related Links