Sign in
< Back to Top

Command Reference

 

You can add commands for AS2, FTP, SFTP, S3, AzureBlob, Email, and OFTP Endpoints to be executed when the Data Flow runs. Commands are valid for both source and destination FTP and SFTP Endpoints, but commands are only valid for AS2 destination Endpoints. No commands are available for AS2 when it is the source because AS2 is a push-only protocol (that is, inbound data for AS2 is pushed by your trading partner). Some commands are valid across all Endpoint types while others vary per Endpoint as described below.
 
Use the links below to navigate directly to command categories.

For examples of how you might use these commands, see Command Examples.

Common commands

The following commands are available across all supported Endpoints.

Comment

# text...

Lines starting with a # character are considered comments and will be ignored when the dataflow executes. Lines starting with # are generally used for documentation purposes.

SET

Change a property value. The new value only affects the commands that follow the SET.

SET property=value
property = value 
Property and new value
  • The property name must have no embedded spaces.
  • The value specified remains in effect until it is set again or until the end of the dataflow.  
  • To reset the property back to default value, specify 
    SET property

    or

    SET property=

Valid properties for SET command are as follows:

host.Path.PUT=xxx
Valid only for AS2 Endpoints. 
Use this property to override the resource path in the Endpoint's Partner URL when multiple resource paths are used for the same partner.
PostGetCommand
PostPutCommand
Valid only for FTP and SFTP Endpoints. 
Use these properties to specify commands to be executed only after a successful GET or PUT, respectively. 
If multiple commands are needed after the GET or PUT, set this property to all of the commands separated by semicolons (;).  If a specific FTP command needs to contain a semicolon, enclose that specific FTP command in quotes (").  The use of macro variables is supported.  See Using Macro Variables in CIC (Post/Pre Command context) for a list of the applicable macros. 
PreGetCommand
PrePutCommand
Valid only for FTP and SFTP Endpoints. 
Use these properties to specify commands to be executed before a GET or PUT, respectively.  This has the benefit of keeping the log results relative to just GETs and PUTs. In addition, for the PUT, it avoids connecting and logging into the server when there are no files to send.  
If multiple FTP commands are needed prior to the GET or PUT, set this property to all of the commands separated by semicolons (;).  If a specific command needs to contain a semicolon, enclose that specific command in quotes (").  The use of macro variables is supported.  See Using Macro Variables in CIC (Post/Pre Command context) for a list of the applicable macros.
PrePutCommandForFirstFileOnly
Valid only for FTP and SFTP Endpoints
Use this property to specify commands to execute before a PUT only before the first file transfer. 
RetrieveDirectorySort
Valid only for FTP and SFTP Endpoints
Use this property to control the order in which files are downloaded from the server. Possible values include:
  • Alphabetical (ascending)
  • Alphabetical (descending)
  • Date/Time Modified (ascending)
  • Date/Time Modified (descending)
  • Size (ascending)
  • Size (descending)

WAIT

Pause execution.

WAIT seconds
Seconds
Number of seconds to pause.
 

AS2 Endpoint commands

The following commands are available for AS2 Endpoints.

CLEAR

Clear a property string value. The cleared value only affects the commands that follow the CLEAR.

CLEARproperty
property  
Property name with no embedded spaces.

PUT

Send one or more files to the host.

PUT "source" "destination"
source
  • Source is a filename.
  • You can use * and ?, or a regular expression when you specify a filename. See Using Wildcards and Regular Expressions in CIC for additional information.
  • You can use macro variables. See Using Macro Variables in CIC (Source context) for a list of the applicable macros.
  • If the source contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
destination

Remote destination filename. If the destination contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("..."). The use of macro variables is supported.  See Using Macro Variables in CIC (Destination context) for a list of the applicable macros. 

SET

Override the resource path in the Endpoint's Partner URL when multiple resource paths are used for the same partner

SET host.Path.PUT=xxx

 

FTP Endpoint commands

 The following commands are available for FTP Endpoints.

CD

Changes the current working directory on the host.

CD "directory"
directory 
The new working directory.

CLEAR

Clear a property string value. The cleared value only affects the commands that follow the CLEAR.

CLEARproperty
property  
Property name with no embedded spaces.

DIR

Get a directory listing of available files from the host

DIR "source"
source

Remote source directory path

GET

Receive one or more files from the host

GET [-ASC|-BIN] [-REC] [-DEL] "source" "destination"
ASC
Transfer file in ASCII format.
BIN
Transfer file in Binary format.
REC
Recursively retrieve nested subdirectories. 
When you use the REC option in conjunction with the DEL option, the retrieved files are deleted from the server, but the subdirectories remain.
DEL
If GET is successful, delete remote file.
source

Remote source path

destination

CIC destination. The use of macro variables is supported.  See Using Macro Variables in CIC (Destination context) for a list of the applicable macros.

  • Path can be to a filename or to a directory.
  • The use of macro variables is supported.  See Using Macro Variables in CIC (Destination context) for a list of the applicable macros.

PUT

Send one or more files to the host.

PUT [-ASC|-BIN][-UNI|-APE] "source" "destination"
ASC
Transfer file in ASCII format
BIN
Transfer file in Binary format
UNI
Ensure remote filename unique
APE
Append to the existing destination file 
source

Source path 

destination

Remote destination path. The use of macro variables is supported.  See Using Macro Variables in CIC (Destination context) for a list of the applicable macros.

QUOTE

Send a raw command to the FTP server

QUOTE "command"
command 
Command to be sent to the server. (Example: PWD, CWD, DELE)  See the FTP RFC 959 for more details on specific FTP commands.

SITE 

Sends a site-specific command to the server.

SITE "command"
command
Site specific command with any arguments

TYPE

Set the default data type for file transfers.

TYPE "data type"
data type 
ASCII or Binary

 

SFTP Endpoint commands

CD

Changes the current working directory on the host.

CD "directory"
directory 
The new working directory.

CHGRP

Changes the group ID of the file or directory on the host.

QUOTE CHGRP group "path"
group
The numeric group id for the new group.
path 
The path to the remote file/directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

CHMOD

Changes the access permissions or modes of the file or directory on the host.

QUOTE CHMOD permissions "path"
permissions 
The absolute mode of the file/directory. Absolute modes are octal numbers specifying the complete list of attributes for the files; you specify attributes by OR'ing together these bits.
  • 0400 - Individual read
  • 0200 - Individual write
  • 0100 - Individual execute (or list directory)
  • 0040 - Group read
  • 0020 - Group write
  • 0010 - Group execute
  • 0004 - Other read
  • 0002 - Other write
  • 0001 - Other execute
path 
The path to the remote file/directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

CHOWN

Changes the user ID of the file or directory on the host.

QUOTE CHOWN owner "path"
owner
The numeric user id for the new owner.
path 
The path to the remote file/directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

CLEAR

Clear a property string value. The cleared value only affects the commands that follow the CLEAR.

CLEARproperty
property  
Property name with no embedded spaces.

DIR

Get a directory listing of available files from the host.

DIR "source"
source 
Remote source directory path. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

GET

Receive one or more files from the host

GET -REC –DEL "source" "destination"
REC
Recursively retrieve nested subdirectories.
  • If used in conjunction with –DEL, the retrieved files, but not subdirectories, are deleted on the server.
DEL 
If the GET is successful, delete the remote file.
source 
Remote source path. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
destination
CIC destination path.
  • Path can be to a filename or to a directory.
  • You can use macro variables. See Using Macro Variables in CIC (Source context) for a list of the applicable macros.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

PUT

Send one or more files to the host.

 PUT -APE "source" "destination"
APE
Append copied file to an existing destination file.
source
CIC source path
  • Path can be to a filename or to a directory
  • You can use * and ?, or a regular expression when you specify a filename. See Using Wildcards and Regular Expressions in CIC for additional information.
  • You can use macro variables. See Using Macro Variables in CIC (Source context) for a list of the applicable macros.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
destination 
Remote destination path.
  • You can use macro variables. See Using Macro Variables in CIC (Destination context) for a list of the applicable macros.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

MKDIR

Creates a new directory on the host.

QUOTE MKDIR "directory"
directory 
The name of the new directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

MKDIRS

Creates new directories on the host.

QUOTE MKDIRS "path"
path 
The path of directories to create. Subdirectories are created using the / delimiter. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").  

PWD

Returns the name of the current working directory on the host.

QUOTE PWD

RENAME

Renames a file or directory on the host.

QUOTE RENAME "source" "destination"
source 
The source file/directory to rename. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").  
destination
The destination file/directory name. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").  

RM

Removes a file on the host.

QUOTE RM "path"
path 
The path of the file to remove. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").  

RMDIR

Removes a directory on the host.

QUOTE RMDIR "path"
path 
The path of the directory to remove. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").   

S3 Endpoint Commands

CLEAR

Clear a property string value. The cleared value only affects the commands that follow the CLEAR.

CLEARproperty
property  
Property name with no embedded spaces.

DIR

Get a directory listing of available files from the host

DIR "source"
source

Remote source directory path

GET

Receive one or more files from the host

GET-REC –DEL "source" "destination"
REC
Recursively retrieve nested subdirectories.
  • If used in conjunction with –DEL, the retrieved files, but not subdirectories, are deleted on the server.
DEL 
If the GET is successful, delete the remote file.
source 
Remote source path. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
destination
CIC destination path.
  • Path can be to a filename or to a directory.
  • You can use macro variables. See Using Macro Variables in CIC (Source context) for a list of the applicable macros.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

PUT

Send one or more files to the host.

PUT "source" "destination"
source
  • Source is a filename.
  • You can use * and ?, or a regular expression when you specify a filename. See Using Wildcards and Regular Expressions in CIC for additional information.
  • You can use macro variables. See Using Macro Variables in CIC (Source context) for a list of the applicable macros.
  • If the source contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
destination

Remote destination filename. If the destination contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("..."). The use of macro variables is supported.  See Using Macro Variables in CIC (Destination context) for a list of the applicable macros. 

SET

Change a property value. The new value only affects the commands that follow the SET.

SET property=value
property = value 
Property and new value
  • The property name must have no embedded spaces.
  • The value specified remains in effect until it is set again or until the end of the dataflow.  
  • To reset the property back to default value, specify 
    SETproperty

    or

    SETproperty=

Valid properties for SET command are as follows:

RetrieveDirectorySort
Use this property to control the order in which files are downloaded from the server. Possible values include:
  • Alphabetical (ascending)
  • Alphabetical (descending)
  • Date/Time Modified (ascending)
  • Date/Time Modified (descending)
  • Size (ascending)
  • Size (descending)

AzureBlob Endpoint Commands

CLEAR

Clear a property string value. The cleared value only affects the commands that follow the CLEAR.

CLEARproperty
property  
Property name with no embedded spaces.

DIR

Get a directory listing of available files from the host

DIR "source"
source

Remote source directory path

GET

Receive one or more files from the host

GET -REC –DEL "source" "destination"
REC
Recursively retrieve nested subdirectories.
  • If used in conjunction with –DEL, the retrieved files, but not subdirectories, are deleted on the server.
DEL 
If the GET is successful, delete the remote file.
source 
Remote source path. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
destination
CIC destination path.
  • Path can be to a filename or to a directory.
  • You can use macro variables. See Using Macro Variables in CIC (Source context) for a list of the applicable macros.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

PUT

Send one or more files to the host.

PUT "source" "destination"
source
  • Source is a filename.
  • You can use * and ?, or a regular expression when you specify a filename. See Using Wildcards and Regular Expressions in CIC for additional information.
  • You can use macro variables. See Using Macro Variables in CIC (Source context) for a list of the applicable macros.
  • If the source contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
destination

Remote destination filename. If the destination contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("..."). The use of macro variables is supported.  See Using Macro Variables in CIC (Destination context) for a list of the applicable macros. 

SET

Change a property value. The new value only affects the commands that follow the SET.

SET property=value
property = value 
Property and new value
  • The property name must have no embedded spaces.
  • The value specified remains in effect until it is set again or until the end of the dataflow.  
  • To reset the property back to default value, specify 
    SETproperty

    or

    SETproperty=

Valid properties for SET command are as follows:

RetrieveDirectorySort
Use this property to control the order in which files are downloaded from the server. Possible values include:
  • Alphabetical (ascending)
  • Alphabetical (descending)
  • Date/Time Modified (ascending)
  • Date/Time Modified (descending)
  • Size (ascending)
  • Size (descending)

Email Endpoint Commands

GET

Receive one or more files from the host

GET -DEL "source" "destination"
DEL 
If the GET is successful, delete the remote file.
source 
Remote source path. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
destination
CIC destination path.
  • Path can be to a filename or to a directory.
  • You can use macro variables. See Using Macro Variables in CIC (Source context) for a list of the applicable macros.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

PUT

Send one or more files to the host.

PUT "source" "destination"
source
  • Source is a filename.
  • You can use * and ?, or a regular expression when you specify a filename. See Using Wildcards and Regular Expressions in CIC for additional information.
  • You can use macro variables. See Using Macro Variables in CIC (Source context) for a list of the applicable macros.
  • If the source contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
destination

Remote destination filename. If the destination contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("..."). The use of macro variables is supported.  See Using Macro Variables in CIC (Destination context) for a list of the applicable macros. 

OFTP Endpoint Commands

GET

Receive one or more files or receipts from the host

GET

The GET command has no options for two reasons:

  • Whether files or receipts (EERP) are received cannot be controlled.
  • In OFTP, files and receipts can be received either solicited or unsolicited.

PUT

Send one or more files to the host

PUT –TEX|-UNS|-FIX|-VAR "source" "destination"
–TEX
Transfer file in OFTP text format:
There are several other parameters available for this format:
  • TranslateToEBCDIC= - Optional
  • FileDescription= - Optional
-UNS
Transfer file in OFTP unstructured format:
There are several other parameters available for this format:
  • TranslateToEBCDIC= - Optional
  • FileDescription= - Optional
-FIX
Transfer file in OFTP fixed format.
There are several other parameters available for this format:
  • RecordDelimiter= - Optional
  • StripDelimiter= - Optional
  • PadCharacter= - Optional
  • TranslateToEBCDIC= - Optional
  • FileDescription= - Optional
-VAR
Transfer file in OFTP variable format.
There are several other parameters available for this format:
  • RecordDelimiter= - Required
  • StripDelimiter= - Optional
  • TranslateToEBCDIC= - Optional
  • FileDescription= - Optional
"source"

Source path

"destination"

Remote destination path. The use of macro variables is supported.  See Using Macro Variables in CIC (Destination context) for a list of the applicable macros.

If no destination is specified, the command uses Default Virtual Filename under the OFTP Endpoint's Advanced Tab. If the Default Virtual Filename also not specified, the command uses the source filename.

Command Examples

SET with PostGetCommand example

The following SFTP-specific example shows how to use the SET command to set the PostGetCommand property, which specifies a command to be executed only after a successful GET. In this case, the PostGetCommand property specifies a QUOTE command, which in this case sends a raw RENAME command to FTP to move the file to the HISTORY directory.

SET PostGetCommand=QUOTE RENAME ${sourcefile} HISTORY\${sourcefilebase}${sourcefileext}
 CD order
 GET *.ord

So when these commands run, we CD to the order directory, GET files with the .ord extension, and if the GET is successful, we move each file to the HISTORY directory and the retrieved file content is passed to the destination of the Data Flow.

PUT command example

The following example of the PUT command sends files to multiple directories on one Endpoint. 

PUT *855* POAckSell/
 PUT *997* FA/

When these commands run, files with names that contain 885 are put in the POAckSell directory and files with names that contain 997 are put in the FA directory.

Related articles