Set Metadata activity

An activity that sets metadata for a file in Amazon S3.

Configure the Set Metadata activity

Examples

(External) AgilePoint NX Connector For Amazon S3
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.

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v9.0 or higher.

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.
In Process Builder, in the Activity Library, open the Amazon S3 tab.
On the Amazon S3 tab, drag the Set Metadata activity onto your process.

General Configuration

Specifies the basic settings for the Set Metadata activity.

Good to Know

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

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

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:

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

Set Metadata Configuration > File Path tab

Specifies the information about a file to set metadata in Amazon S3.

Fields

Field Name	Definition
Amazon Web Services	Description: Specifies the access token that connects to your Amazon Web Services. Allowed Values: A list of access tokens configured for your environment. Default Value: None Accepts Variables: No
Create	Opens this Screen: Access Token for Amazon Web Services Function of this Screen: Configure an access token to connect to Amazon Web Services.
File Path	Description: Specifies the path of the file in Amazon S3. The activity uses the path of the specified file when the process runs. Allowed Values: Choose File Path - Specifies an absolute path for the file. Dynamic File Path - Specifies a variable that stores the path for the file. Default Value: Dynamic File Path 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?

Set Metadata Configuration > Set Metadata tab

Configures user-defined metadata to the file in a key-value pair.

Fields

Field Name	Definition
Amazon Web Services	Description: Specifies the access token that connects to your Amazon Web Services. Allowed Values: A list of access tokens configured for your environment. Default Value: None Accepts Variables: No
Create	Opens this Screen: Access Token for Amazon Web Services Function of this Screen: Configure an access token to connect to Amazon Web Services.
Key	Description: Specifies the name of the key to add as metadata to the file in a key-value pair. Allowed Values: One line of text (a string). Accepted: Letters Numbers Special characters Not Accepted: 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?
Value	Description: Specifies the value for the key in a key-value pair. Allowed Values: A number or a text string that can contain 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?
Create	Function: Adds a row for the Key and Value fields.
Delete	Function: Deletes the selected row.