Download Document activity

An activity that downloads a document from Salesforce to the local file system on your AgilePoint Server machine.

Configure the Download Document activity

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

Examples

(Example) How to Get the Access Token Credentials from Salesforce

Good to Know

To send an email notification, click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).
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?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use 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, or 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

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
Do one of these:
- Add an activity:
  1. In Process Builder, in the Activity Library, open the Salesforce tab.
  2. On the Salesforce tab, drag the Download Document activity onto your process.
- Change an activity:
  1. In your process, double-click your activity.

General Configuration

Specifies the basic information for a CRM activity.

Screen

Fields

Field Name	Definition
Display Name	Description: Specifies the activity name that shows in your process. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Default Value: None Accepts 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	Description: Specifies an optional text description for your activity. Allowed Values: More than one line of text. Default Value: None Accepts Variables: No
Connection Timeout (Seconds)	Description: Specifies the number of seconds permitted to complete an action before the connection stops. Allowed Values: An integer. Represents A number of seconds Default Value: 600 Accepts Variables: No

Download Document Configuration

Specifies information about your document to download.

Fields

Field Name	Definition
Salesforce	Description: Specifies the access token that connects to your Salesforce application. Allowed Values: A list of access tokens configured for your environment. Default Value: None Accepts Variables: No Example: Refer to: (Example) How to Get the Access Token Credentials from Salesforce
Create	Opens this Screen: Access Token for Salesforce Function of this Screen: Configure an access token to connect to Salesforce. Example: Refer to: (Example) How to Get the Access Token Credentials from Salesforce
Document ID	Description: Specifies the ID of your document. The document ID is supplied by Salesforce. The document ID is an identifier used to track a uploaded document. Allowed Values: A valid document ID. Default Value: None Accepts Variables: Yes Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use 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, or 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?
Local Path	Description: Specifies the location of the file system folder on the local computer where the activity does an action, such as uploading or downloading files. This setting gives the source location for the files to be uploaded and the target location for the files to be downloaded. Allowed Values: A file path relative to the AgilePoint Server application's root directory. Default Value: None Accepts Variables: Yes Example: If AgilePoint Server is installed at: c:\Inetpub\wwwroot\AgilePointServer\ And, the file once downloaded is to be located at: c:\Inetpub\wwwroot\AgilePointServer\files\MyFile.txt Then, the LocalPath property must be set to the following value: files If AgilePoint Server is installed at: c:\Inetpub\wwwroot\AgilePointServer\ And, the file once downloaded is to be located at: c:\Inetpub\wwwroot\AgilePointServer\files\temp\MyFile.txt Then, the LocalPath property must be set to the following value: files\temp
Store the Document ID in Schema Node	Description: Specifies the process data variable that contains the document ID. Allowed Values: A process data variable that accepts an alphanumeric string with no spaces or special characters. Default Value: None Accepts Variables: Yes Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use 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, or 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?