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. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the Box tab.

    Open Box tab
  3. On the Box tab, drag the Get File Info activity onto your process.

    Drag Get File Info activity

General Configuration

Specifies the basic settings for the Get File Info activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

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

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 NameDefinition

Box

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

Create 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

Description:
Specifies the Box file. The activity uses this file ID at runtime.
Allowed 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 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?

Store the Response in Custom Attribute or Schema - File Path

Description:
Specifies a process data variable that stores the path of the file.
Allowed Values:
A variable.

Format:

  • String

Accepted:

  • Numbers
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?

Store the Response in Custom Attribute or Schema - File Name

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

Store the Response in Custom Attribute or Schema - Shared Link

Description:
Specifies the process data variable that stores the download link of the file.
Allowed Values:
A variable.

Format:

  • String

Accepted:

  • URL
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?

Description

Description:
Specifies an optional description for your file or folder.
Allowed Values:
Default Value:
None
Accepts Variables:
Yes