Document Transfer activity

An activity that moves files and folders from one storage location to a different location.


Document Transfer activity

Configure the Document Transfer activity

To configure the Document Transfer activity, do the procedure in this topic.

Examples

Good to Know

  • In most text fields, you can use process data variables as an alternative to literal data values.
  • You can configure whether this activity waits for other activities before it runs.

    For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?

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

Procedure

  1. Complete the fields on the General Configuration screen.

    For more information, refer to Configure General Options for a System Activity.

  2. Click Source Configuration Source Configuration icon.
  3. On the Source Repository screen, select the source location for your file.
  4. Click Target Configuration Target Configuration icon.
  5. On the Target Repository screen, select the target location for your file.
  6. (Optional) Click Advanced Advanced icon > E-mail Notifications E-mail Notifications icon.

    For more information, refer to Configure E-mail Notifications for Any Activity.

General Configuration

Specifies the basic settings for the Document Transfer activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field Name Definition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Source Repository

Specifies the original, or source, location type for your files.

Figure: Source Repository screen

Source Repository screen

Fields

Field Name Definition

Amazon S3 Amazon S3 icon

Function:
Specifies that Amazon S3 is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Amazon S3) - Document Transfer.

Box Box icon

Function:
Specifies that Box is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Box) - Document Transfer.

Example:
Refer to:

Dropbox Dropbox icon

Function:
Specifies that Dropbox is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Dropbox) - Document Transfer.

File System File System icon

Function:
Specifies that the file system on the AgilePoint Server machine is the data source for the file.

To select your file in the source location, complete the fields on Source Repository Configuration (File System) - Document Transfer.

FTP FTP icon

Function:
Specifies that FTP is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (FTP) - Document Transfer.

Google Drive Google Drive icon

Function:
Specifies that Google Drive is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Google Drive) - Document Transfer.

NetSuite NetSuite icon

Function:
Specifies that NetSuite is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (NetSuite) - Document Transfer.

OneDrive OneDrive icon

Function:
Specifies that OneDrive is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (OneDrive) - Document Transfer.

OneDrive For Business OneDrive For Business icon

Function:
Specifies that OneDrive for Business is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (OneDrive For Business) - Document Transfer.

Salesforce Salesforce icon

Function:
Specifies that Salesforce is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Salesforce) - Document Transfer.

SFTP SFTP icon

Function:
Specifies that SFTP is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (SFTP) - Document Transfer.

SharePoint SharePoint icon

Function:
Specifies that SharePoint is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (SharePoint) - Document Transfer.

Target Repository

Selects the target storage repository type for your files.

Figure: Target Repository screen

Target Repository screen

Fields

Field Name Definition

Amazon S3 Amazon S3 icon

Function:
Specifies that Amazon S3 is your document target location.

To configure the target location for your file, complete the fields in Target Repository Configuration (Amazon S3) - Document Transfer.

Box Box icon

Function:
Specifies that Box is your document target location.

To configure the target location for your file, complete the fields in Target Repository Configuration (Box) - Document Transfer.

Dropbox Dropbox icon

Function:
Specifies that Dropbox is your document target location.

To configure the target location for your file, complete the fields in Target Repository Configuration (Dropbox) - Document Transfer.

Example:
Refer to:

File System File System icon

Function:
Specifies that the file system on the AgilePoint Server machine is the target data source location for the file.

To select your file in the source location, complete the fields on Target Repository Configuration (File System) - Document Transfer.

FTP FTP icon

Function:
Specifies that FTP is your document target location.

To configure the target location for your file, complete the fields in Target Repository Configuration (FTP) - Document Transfer.

Google Drive Google Drive icon

Function:
Specifies that Google Drive is your document target location.

To configure the target location for your file, complete the fields in Target Repository Configuration (Google Drive) - Document Transfer.

NetSuite NetSuite icon

Function:
Specifies that NetSuite is your document target location.

To configure the target location for your file, complete the fields in Target Repository Configuration (NetSuite) - Document Transfer.

OneDrive OneDrive icon

Function:
Specifies that OneDrive is your document target location.

To configure the target location for your file, complete the fields in Target Repository Configuration (OneDrive) - Document Transfer.

OneDrive For Business OneDrive For Business icon

Function:
Specifies that OneDrive for Business is your document target location.

To configure the target location for your file, complete the fields in Target Repository Configuration (OneDrive For Business) - Document Transfer.

Salesforce Salesforce icon

Function:
Specifies that Salesforce is your document target location.

To configure the target location for your file, complete the fields in Target Repository Configuration (Salesforce) - Document Transfer.

SFTP SFTP icon

Function:
Specifies that SFTP is your document target location.

To configure the target location for your file, complete the fields in Target Repository Configuration (SFTP) - Document Transfer.

SharePoint SharePoint icon

Function:
Specifies that SharePoint is your document target location.

To configure the target location for your file, complete the fields in Target Repository Configuration (SharePoint) - Document Transfer.