Get File Info (Box) activity

An activity that gets information about a file from Box to store in process data variables.


Get File Info activity

Configure the Get File Info activity

To configure the Get File Info activity, do the procedure in this topic.

Examples

Good to Know

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 Box Box icon tab.
      2. On the Box Box icon tab, drag the Get File Info Get File Info icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

General Configuration

Specifies the basic settings for the Get File Info 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

Get File in Box Configuration

Specifies information about a file to get from Box and store in a process data variable.

Figure: Get File Information in Box Configuration screen

Get File Information in Box Configuration screen

Fields

Field Name Definition

Box

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

Add Token Add Token icon

Opens this Screen:
Access Token for Box
Function of this Screen:
Configure an access token to connect to Box.
Example:
Refer to:

File Path

Function:
Specifies the Box file. The activity uses this file ID at runtime.
Accepted Values:
  • Choose File Path - Specifies an absolute path for the file.
  • Dynamic File ID - Specifies a process data variable that stores the ID of the file.
Default Value:
Dynamic File ID
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?

Store the Response in Custom Attribute or Schema - File Path

Function:
Specifies a process data variable that stores the path of the file.
Accepted Values:
A process data variable that accepts a numeric 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?

Store the Response in Custom Attribute or Schema - File Name

Function:
Specifies the process data variable that stores the name of the file.
Accepted Values:
A process data variable that accepts an alphanumeric string that can have spaces.
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?

Store the Response in Custom Attribute or Schema - Shared Link

Function:
Specifies the process data variable that stores the download link of the file.
Accepted Values:
A process data variable that accepts a URL.
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?

Description

Function:
Specifies an optional description for your file or folder.
Accepted Values:
Default Value:
None
Accepts Process Data Variables:
Yes