| \n\n**Command**\n\n | \n\nType of activity to create. The choices are:- Copy file\n- Create directory\n- Get file list\n- Remove file or directory\n- Rename file or directory\n- Set file attributes\n **Note:** The fields that display on the form depend on the command you select.\n\n |
| \n\n**Source host**\n\n | \n\nName or IP address of the server containing the files targeted by the activity.\n\n |
| \n\n**Source port**\n\n | \n\nPort number to use to communicate with the source server. The default port number is **22**.\n\n |
| \n\n**Source file path**\n\n | \n\nFull path to a file \\(`/temp/test_data_file.txt`\\) or directory \\(/`temp/test_dir`\\) on a source host depending on the selected command. Field available on following commands: - Copy file\n- Remove file or directory\n- Set file attributes\n\n\n |
| \n\n**Source directory**\n\n | \n\nPath to the directory where the source files are located. Field available on following commands: - Create directory\n- Get file list\n\n\n |
| \n\n**Source files**\n\n | \n\nNames of specific source files to include in the file transfer. Separate the file names with semi-colons. This field supports a semi-colon separated list of wild-card patterns. For example: `*.txt; a?cd.pdf.` If this field is blank, all files are included. Field available on following command: Get file list**Note:** For information about how the values in this field affect options in other fields, see the logic explanation which follows.\n\n |
| \n\n**Is a directory**\n\n | \n\nIf checked, specifies the file path is a directory. Field available on following command: Remove file or directory\n\n |
| \n\n**Credential tag for source**\n\n | \n\nSpecific credential tag this activity must use to run SFTP commands on the source host.\n\n |
| \n\n**Credential tag for target**\n\n | \n\nSpecific credential tag this activity must use to run SFTP commands on the target host. Field available on following command: Copy file\n\n |
| \n\n**Excluded files**\n\n | \n\nNames of specific source files to exclude from the file transfer. The activity acts on all other files found in the source directory or subfolders. Separate the file names with commas. This field supports comma-separated list of wild-card patterns. For example: `*.txt, a?cd.pdf.`. Field available on following command: Get file list **Note:** For information about how the values in this field affect options in other fields, see the logic explanation which follows.\n\n |
| \n\n**Include subfolders**\n\n | \n\nIf checked, includes the files from subfolders in the source directory. Field available on following command: Get file list **Note:** For information about how your selection affects other fields in the form, see the logic explanation which follows.\n\n |
| \n\n**Target host**\n\n | \n\nName or IP address of the server to which the files are being transferred. Field available on following command: Copy file\n\n |
| \n\n**Target port**\n\n | \n\nPort number to use to communicate with the target host. The default port number is **22**. Field available on following command: Copy file\n\n |
| \n\n**Target file path**\n\n | \n\nFull path to a file on a target host. Field available on following commands: - Copy file\n- Rename file or directory\n\n\n |
| \n\n**Suffix for temporary file**\n\n | \n\nIf a file exists on a target host, this command enables a temporary suffix to use for a file name. If this field contains a value, the activity first copies the source file to a temporary file on the target host using **targetFilePath + tempFileSuffix** as the name. Upon completion, the activity renames the file to the actual target file name. If this field is blank, the activity copies the source file directly to the target file and overwrites it, if it exists. Field available on following command: Copy file\n\n |
| \n\n**UID**\n\n | \n\nUser ID attribute to apply to a file or directory. The UID and GID values must be set together as a pair or they are ignored. The UID and GID numbers are internal values returned by the Get File List activity. Typically, you first use the Get File List activity to return a list of files and their attributes. Then you can move a file from a source host to a target host and set the source file attributes on the target file. This flow is demonstrated in the [SFTP File Transfer workflow](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/orchestration/r_SFTPWorkflow.md). Field available on following command: Set file attributes\n\n |
| \n\n**GID**\n\n | \n\nGroup ID attribute to apply to a file or directory. The UID and GID values must be set together as a pair or they are ignored. The UID and GID numbers are internal values returned by the Get File List activity. Typically, you first use the Get File List activity to return a list of files and their attributes. Then you can move a file from a source host to a target host and set the source file attributes on the target file. This flow is demonstrated in the [SFTP File Transfer workflow](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/orchestration/r_SFTPWorkflow.md). Field available on following command: Set file attributes\n\n |
| \n\n**Permissions**\n\n | \n\nFile or directory permissions to set for the user and group specified. This value must be expressed as an integer, such as **16877**, which defines these permissions: **rwxr-xr-x**. The permissions numbers are internal values returned by the Get File List activity. Typically, you first use the Get File List activity to return a list of files and their attributes. Then you can move a file from a source host to a target host and set the source file attributes on the target file. This flow is demonstrated in the [SFTP File Transfer workflow](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/orchestration/r_SFTPWorkflow.md). Field available on following command: Set file attributes\n\n |
| \n\n**Access timestamp**\n\n | \n\nOverride the timestamp when the file or directory was last accessed. The access and modification timestamps must be set together as a pair. Field available on following command: Set file attributes\n\n |
| \n\n**Modification timestamp**\n\n | \n\nOverride the timestamp when the file or directory was last modified. The access and modification timestamps must be set together as a pair. Field available on following command: Set file attributes\n\n |
| \n\n**Size in bytes**\n\n | \n\nSize of a file, expressed in bytes. Field available on following command: Set file attributes\n\n |
| \n\n**Required MID Server capabilities**\n\n | \n\nMID Server with the appropriate [MID Server capabilities](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/t_ConfigureCapabilities.md) for connecting to the source and target servers.\n\n |
| \n\nName\n\n | \n\nVariable\n\n | \n\nType\n\n | \n\nUsage\n\n |
|---|---|---|---|
| \n\nCommand\n\n | \n\ncommand\n\n | \n\nString\n\n | \n\nIdentifies the function of this activity. The possible commands are: - Copy file\n- Create directory\n- Get file list\n- Remove file or directory\n- Rename file or directory\n- Set file attributes\n\n |
| \n\nSource\n\n | \n\nsource\n\n | \n\nString\n\n | \n\nIdentifies the source host.\n\n |
| \n\nSource port\n\n | \n\nsource\\_port\n\n | \n\nInteger\n\n | \n\nIdentifies the port used to communicate with the source host.\n\n |
| \n\nSource directory\n\n | \n\nsource\\_directory\n\n | \n\nString\n\n | \n\nPath to the source directory of the files to be moved.\n\n |
| \n\nSource files\n\n | \n\nsource\\_files\n\n | \n\nString\n\n | \n\nNames of the files on the source to be moved.\n\n |
| \n\nExcluded files\n\n | \n\nexcluded\\_files\n\n | \n\nString\n\n | \n\nLists the files excluded from the operation.\n\n |
| \n\nSource file path\n\n | \n\nsource\\_file\\_path\n\n | \n\nString\n\n | \n\nPath to the source files to be moved.\n\n |
| \n\nTarget host\n\n | \n\ntarget\\_host\n\n | \n\nString\n\n | \n\nIdentifies the target host.\n\n |
| \n\nTarget port\n\n | \n\ntarget\\_port\n\n | \n\nInteger\n\n | \n\nIdentifies the port used to communicate with the target host.\n\n |
| \n\nTarget directory\n\n | \n\ntarget\\_directory\n\n | \n\nString\n\n | \n\nFull path to the target directory on the target host.\n\n |
| \n\nTarget file path\n\n | \n\ntarget\\_file\\_path\n\n | \n\nString\n\n | \n\nFull path to a file or directory on the source host or on the target host. For example, this value is used in the [Rename File or Directory](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/orchestration/r_RenameFileOrDirectoryActivity.md) activity in the activity pack.\n\n |
| \n\nTemp file postfix\n\n | \n\ntemp\\_file\\_postfix\n\n | \n\nString\n\n | \n\nTemporary file name extension used by the Copy File activity when moving a file. If this field contains an extension, the source file is copied to a temporary file using **target file name + temp\\_file\\_postfix**, before being renamed to the actual target file. If this field is blank, the source file is copied directly to the target file.\n\n |
| \n\nIs directory\n\n | \n\nis\\_directory\n\n | \n\nBoolean\n\n | \n\nIndicates whether the given file path is a directory.\n\n |
| \n\nInclude subfolders\n\n | \n\ninclude\\_subfolders\n\n | \n\nBoolean\n\n | \n\nIndicates whether the system looks into subfolders of the source directory for files to include and exclude.\n\n |
| \n\nFile attribute uid\n\n | \n\nfile\\_attribute\\_uid\n\n | \n\nInteger\n\n | \n\nUser ID associated with a file or directory.\n\n |
| \n\nFile attribute gid\n\n | \n\nfile\\_attribute\\_gid\n\n | \n\nInteger\n\n | \n\nGroup ID associated with a file or directory.\n\n |
| \n\nFile attribute permissions\n\n | \n\nfile\\_attribute\\_permissions\n\n | \n\nInteger\n\n | \n\nFile or directory permissions for the user and group specified.\n\n |
| \n\nFile attribute atime\n\n | \n\nfile\\_attribute\\_atime\n\n | \n\nInteger\n\n | \n\nAccess time stamp from the file attributes.\n\n |
| \n\nFile attribute mtime\n\n | \n\nfile\\_attribute\\_mtime\n\n | \n\nInteger\n\n | \n\nModification time stamp from the file attributes.\n\n |
| \n\nFile attribute size\n\n | \n\nfile\\_attribute\\_size\n\n | \n\nInteger\n\n | \n\nSize of the file, in bytes.\n\n |
| \n\nSource credential tag\n\n | \n\nsource\\_credential\\_tag\n\n | \n\nString\n\n | \n\n[Credential aliases for Orchestration activities](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-security/c_AssignCredsOrchActivities.md) used to run the command on the source host.\n\n |
| \n\nTarget credential tag\n\n | \n\ntarget\\_credential\\_tag\n\n | \n\nString\n\n | \n\nCredential tag used to run the command on the target host.\n\n |
| \n\nMidCapabilities\n\n | \n\nmidCapabilities\n\n | \n\nString \\(comma separated\\)\n\n | \n\nList of required MID Server capabilities.\n\n |
| \n\nName\n\n | \n\nVariable\n\n | \n\nType\n\n | \n\nUsage\n\n |
|---|---|---|---|
| \n\nOutput\n\n | \n\noutput\n\n | \n\nString\n\n | \n\nContains output data returned by the query.\n\n |
| \n\nEccSysId\n\n | \n\neccSysId\n\n | \n\nString\n\n | \n\nContains the Reference ID associated with the ECC Queue input message.\n\n |
| \n\nErrorMessages\n\n | \n\nerrorMessages\n\n | \n\nString\n\n | \n\nContains the error messages returned from the query. If no error messages are returned, this value is null.\n\n |
| \n\nTags\n\n | \n\ntags\n\n | \n\nHashmap of tag values returned from the SSH command\n\n | \n\nContains the tags used to extract output using the SSH commands. The tag output is delimited by double percentage signs, as in `%%tagname%% … %%`. Set up the command using the following format:```\n%%tagname1%%\noutput1 line 1\noutput1 line 2\n…\n%%\n\n%%tagname2%%\noutput2 line 1\noutput2 line 2\n…\n%%\n```\n\nThe tags returned are JavaScript hashmap objects in which each key is prefixed with `tag` appended with the tagname.```\n{\"__text__\": \"\", \n\"tagtagname1\":\"output1 line1\\noutput1 line2\\n\", \n\"tagtagname2\":\"output2 line1\\noutput2 line2\\n\"}\n```\n\n |
| \n\nField\n\n | \n\nDescription\n\n | \n\nCommand\n\n |
|---|---|---|
| \n\nCommand\n\n | \n\nType of activity to create. The choices are:- Copy file\n- Create directory\n- Get file list\n- Remove file or directory\n- Rename file or directory\n- Set file attributes\n **Note:** The fields displayed on the form depend on the command selected.\n\n | \n\nAll\n\n |
| \n\nSource host\n\n | \n\nName or IP address of the server containing the files targeted by the activity.\n\n | \n\nAll\n\n |
| \n\nSource port\n\n | \n\nPort number to use to communicate with the source server. The default port number is **22**.\n\n | \n\nAll\n\n |
| \n\nSource file path\n\n | \n\nFull path to a file on a source host.\n\n | \n\n- Copy file\n- Remove file or directory\n- Set file attributes\n\n\n |
| \n\nSource directory\n\n | \n\nPath to the directory where the source files are located.\n\n | \n\n- Create directory\n- Get file list\n\n\n |
| \n\nSource files\n\n | \n\nNames of specific source files to include in the management action. Separate the file names in this list with semi-colons. This field supports the use of wild cards. If this field is blank, all files are included. For information about how the values in this field are affected by options in other fields, see the section below the table.\n\n | \n\nGet file list\n\n |
| \n\nIs a directory\n\n | \n\nCheck box that determines if the specified file path is a directory.\n\n | \n\nRemove file or directory\n\n |
| \n\nCredential tag for source\n\n | \n\nSpecific [Credential aliases for Orchestration activities](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-security/c_AssignCredsOrchActivities.md) this activity must use to run SFTP commands on the source host.\n\n | \n\nAll\n\n |
| \n\nCredential tag for target\n\n | \n\nSpecific credential tag this activity must use to run SFTP commands on the target host.\n\n | \n\nCopy file\n\n |
| \n\nExcluded files\n\n | \n\nNames of specific source files to exclude from the management action. The activity acts on all other files found in the source directory or subfolders. Separate the file names in this list with semi-colons. This field supports the use of wild cards. For information about how the values in this field are affected by options in other fields, see the section below the table.\n\n | \n\nGet file list\n\n |
| \n\nInclude subfolders\n\n | \n\nCheck box to manage the files from subfolders in the source directory. For information about how your selection affects other fields in the form, see the section below the table.\n\n | \n\nGet file list\n\n |
| \n\nTarget host\n\n | \n\nName or IP address of the server to which the files are being transferred.\n\n | \n\nCopy file\n\n |
| \n\nTarget port\n\n | \n\nPort number to use to communicate with the target host. The default port number is **22**.\n\n | \n\nCopy file\n\n |
| \n\nTarget file path\n\n | \n\nFull path to a file on a target host.\n\n | \n\n- Copy file\n- Rename file or directory\n\n\n |
| \n\nSuffix for temporary file\n\n | \n\nTemporary suffix to use for a file name if the file already exists on a target host. If this field contains a value, the activity deletes the duplicate target file if it exists, and then copies the source file to a temporary file using **targetFilePath + tempFileSuffix** as the name. Upon completion, the activity renames the file to the actual target file name. If this field is blank, the activity copies the source file directly to the target file and overwrites it, if it already exists.\n\n | \n\nCopy file\n\n |
| \n\nUID\n\n | \n\nUser ID attribute to apply to a file or directory. The UID and GID values must be set together as a pair or they are ignored.\n\n | \n\nSet file attributes\n\n |
| \n\nGID\n\n | \n\nGroup ID attribute to apply to a file or directory. The UID and GID values must be set together as a pair or they are ignored.\n\n | \n\nSet file attributes\n\n |
| \n\nPermissions\n\n | \n\nFile or directory permissions to set for the user and group specified. This value must be expressed as an integer, such as **16877**, which defines these permissions: **rwxr-xr-x**. The permissions number is an internal value returned by the Get File List activity. Typically, you first use the Get File List activity to return a list of files and their attributes. Then you can move a file from a source host to a target host and set the source file attributes on the target file. This is demonstrated in the [SFTP File Transfer workflow](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/orchestration/r_SFTPWorkflow.md).\n\n | \n\nSet file attributes\n\n |
| \n\nAccess timestamp\n\n | \n\nOverride the timestamp when the file or directory was last accessed. The access and modification timestamps must be set together as a pair.\n\n | \n\nSet file attributes\n\n |
| \n\nModification timestamp\n\n | \n\nOverride the timestamp when the file or directory was last modified. The access and modification timestamps must be set together as a pair.\n\n | \n\nSet file attributes\n\n |
| \n\nSize in bytes\n\n | \n\nSize of a file, expressed in bytes.\n\n | \n\nSet file attributes\n\n |
| \n\nRequired MID Server capabilities\n\n | \n\nMID Server with the appropriate [MID Server capabilities](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/t_ConfigureCapabilities.md) for connecting to the source and target servers. By default, the system selects an SSH MID Server.\n\n | \n\nAll\n\n |