Target Repository Configuration (SFTP) - Document Transfer

Specifies the target location for your files on SFTP in the Document Transfer activity.

Figure: Target Repository Configuration screen (SFTP)

Target Repository Configuration screen SFTP

Good to Know

  • Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

How to Start

  1. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library, open the Document Document icon tab.
      2. On the Document Document icon tab, drag the Document Transfer Document Transfer icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.
  3. On the Target Repository screen, select your target location as SFTP SFTP icon.
  4. Click Target Detail Configuration Target Detail Configuration icon.

Fields

Field Name Definition

SFTP
Function:
Specifies the access token that connects to your SFTP server.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Process Data Variables:
No

Add Token Add Token icon
Opens this Screen:
Access Token for SFTP
Function of this Screen:
Configure an access token to connect to an SFTP service.

Choose Folder Path
Function:
Specifies the name of the target folder.
Accepted Values:
The name of a folder in your repository.
Default Value:
None
Example:

Existing Folder ID

Function:
Specifies the ID of the folder the activity uses when the process runs.
Accepted Values:
A valid folder ID.
Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Create New Folder
Function:
Specifies that a new folder is created for the file by the process.
Accepted Values:
  • Deselected - The activity does not create a new folder.
  • Selected - The activity creates a new folder.
Default Value:
Deselected
Accepts Process Data Variables:
No
Example:

Create New Folder Name
Function:
Specifies the name the process gives to the folder the process creates.
Accepted Values:
Default Value:
None
Accepts Process Data Variables:
Yes
Example:
Refer to:

Overwrite If File Exists
Function:
Specifies if the activity replaces the file if it already exist with the same name at the specified target location.
Accepted Values:
  • Selected - The activity replaces the file if it exists with the same name at the target location.
  • Deselected - The activity saves the file with a different name.
Default Value:
Selected

Store the Response ID in this Variable
Function:
Specifies the process data variable that contains the response ID for the document transfer.
Accepted Values:
A process data variable that accepts an alphanumeric string with no spaces or special characters.
Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?