Copies a file from the source SFTP server to target SFTP server.

Fields

Field Description
Connections
Source Connection Type of connection to use to connect to the source SFTP server.
  • Define Connection Inline: Define connection information within the action step.
  • Use Connection Alias: Define connection information using the Connection Alias table. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using an action in multiple environments. Likewise, if the connection information changes, you don't need to update your custom action.

To learn more about connections and credentials, see Introduction to credentials, connections, and aliases.
Source Connection Alias Connection & Credential alias record that the system uses to run the action step. Users with the flow_designer or admin role can create or select an associated Connection record. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using an action in multiple environments. Likewise, if the connection information changes, you don't need to update your custom action. To learn more about connections and credentials, see credentials, connections, and aliases. The credential value is displayed as a Password (2 Way Encrypted) data pill on the data panel. This field is available when Use Connection Alias is selected from the Source Connection list.
Target Connection Type of connection to use to connect to the target SFTP server.
  • Define Connection Inline: Define connection information within the action step.
  • Use Connection Alias: Define connection information using the Connection Alias table. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using an action in multiple environments. Likewise, if the connection information changes, you don't need to update your custom action.

To learn more about connections and credentials, see Introduction to credentials, connections, and aliases.
Target Connection Alias Connection & Credential alias record that the system uses to run the action step. Users with the flow_designer or admin role can create or select an associated Connection record. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using an action in multiple environments. Likewise, if the connection information changes, you don't need to update your custom action. To learn more about connections and credentials, see credentials, connections, and aliases.
Source Credential alias Credential alias that the system uses to run the action step. Users with the flow_designer or admin role can create or select an associated Connection record. Using an alias eliminates the need to configure multiple credentials when using an action in multiple environments. Likewise, if the credential information changes, you don't need to update your custom action. To learn more about connections and credentials, see credentials, connections, and aliases. The credential value is displayed as a Password (2 Way Encrypted) data pill on the data panel. This field is available when Define Connection Inline is selected from the Source Connection list.
Note: The SFTP step requires a credential record that supports either SSH private key credentials or SSH credentials. This step does not support Windows credentials where the Use MID Server service account option is selected.
Host Name or IP address of the SFTP server that contains the files you wish to copy.
Port Port number to communicate with the server.
MID Selection Option to select a specific MID Server or MID Cluster. Choose any one of the following options.
  • Auto-Select MID Server: Your ServiceNow instance selects the MID Server without manual input.
  • Specific MID Server: Your ServiceNow instance uses MID Server that you specify.
  • Specific MID Cluster: Your ServiceNow instance uses the MID Cluster that you specify.

    A MID Cluster is a group of MID Servers that enables your ServiceNow instance to handle multiple integrations, and improve integration speed. For more information, see Configure a MID Server cluster.

This field is available when Define Connection Inline is selected from the Source Connection list.
MID Application Option to use a MID Server to run the SFTP step. This field is available when Define Connection Inline is selected from the Source Connection list and Auto-Select MID Server is selected from the MID Selection list.
Capabilities Capability of the MID Server. Select SSH. This field is available when Define Connection Inline is selected from the Source Connection list and Auto-Select MID Server is selected from the MID Selection list.
MID Server Data pill of the required MID Server. This field is available when Define Connection Inline is selected from the Source Connection list and Specific MID Server is selected from the MID Selection list.
MID Cluster Data pill for the MID Cluster you want to use. This field is available when Define Connection Inline is selected from the Source Connection list, and Specific MID Cluster is selected from the MID Selection list.
Command Details
Source Path Full path to the file in the source server you wish to copy. For example, /root/doc/tempwsdl.rtf.
Target Path Full path to the file in the target server you wish to copy the contents. For example, /root/doc/attribute.rtf. In this case, the contents of the tempwsdl.rtf are copied to the file, attribute.rtf.
Retry Policy
Enable Retry Policy Option to enable the retry policy. For more information, see Retry policy.
Override Default Policy for Alias Option to override the default retry policy. This option is not applicable when Define Connection Inline is selected from the Connection list.
Retry Policy Default retry policy associated with Connection Alias. If Override Default Policy for Alias is selected, you can override the default retry policy and select another existing retry policy based on your requirement.

Action error evaluation

If this step fails
Data type: Choice

Option to continue running the next step or go to error evaluation. To use the step status code or message for a custom action error condition, see Action error evaluation.