Update Metadata activity

An activity that changes metadata in SharePoint.



Configure the Update Metadata activity

To configure the Update Metadata activity, do the procedure in this topic.

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?

  • Documentation for Integrations with Third-Party, External, or Open Source Technologies

    The highest priority for AgilePoint NX Product Documentation is accuracy. Whenever feasible, AgilePoint provides input details, business rules, or example values for third-party integrations. These can include any technology that is not native to AgilePoint NX, such as Salesforce, Active Directory, or REST. However this information is subject to change without notice to AgilePoint. Because we can not guarantee the accuracy of this information, the details provided for third-party product input values, as well as examples for third-party product integrations, are limited in the AgilePoint documentation. It is the responsibility of third-party vendors to provide documentation related to these aspects of their software and services.

    For examples of use case implementations or configuration field input values for third-party products, AgilePoint recommends these resources:

    • AgilePoint Community Forums - An AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
    • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
    • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.
    • Third-Party Vendor Documentation - Whenever feasible, AgilePoint provides links to third-party vendor documentation.

      This does not include technology standards or protocols, such as JavaScript, REST, or FTP. Resources for these technical standards are publicly available on the Internet.

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, go to the Activity Library, and open the SharePoint SharePoint icon tab.
      2. On the SharePoint SharePoint icon tab, drag the Update Metadata Update Metadata 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 Update Metadata Configuration Update Metadata Configuration icon.
  3. On the Update Metadata Configuration screen, do this procedure.
    1. Complete the fields on the Configuration tab.
    2. Complete the fields on the SharePoint List tab.

    For more information, refer to Change Fields in a SharePoint Library or List.

  4. (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 common information for a system activity.

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:
Refer to:

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

Update Metadata Configuration > Configuration

Specifies a value for a field to update in a SharePoint library and folder.



Fields

Field Name Definition

SharePoint

Function:
Specifies the access token that connects to your SharePoint site.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None

Add Token Add Token icon

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

Site

Function:
Specifies the URL for the SharePoint library that contains the process data variable.
Accepted Values:
A valid SharePoint site URL.
Default Value:
None
Accepts Process Data Variables:
Yes

List

Function:
Specifies the name of your SharePoint list.
Accepted Values:
The name of your SharePoint list.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:
Refer to:

Folder

Function:
Specifies the name of your SharePoint folder.

The folder contains the process data variables to change.

Accepted Values:
The name of your SharePoint folder
Default Value:
None
Accepts Process Data Variables:
No

Field

Function:
Specifies the name of the SharePoint column to use to limit the change in the process data variable's value.
Accepted Values:
The name of your SharePoint list column.
Default Value:
"ID", the list column that specifies the unique list item ID.
Accepts Process Data Variables:
No

Field Value

Function:
Specifies the SharePoint column's value.

This will limit the change of the process data variable to the value specified.

Accepted Values:

The list column's value.

Note the following:

  • If you want to clear a value, specify NULL.
  • If you leave the Field Value property empty, the activity updates all records in the SharePoint library.
Default Value:
${ListItemID}
Accepts Process Data Variables:
Yes

Update Metadata Configuration > SharePoint List

Specifies a value for a field to update in a SharePoint library and folder.

Screen



Fields

Field Name Definition

Display Name

Function:
Specifies the name of the SharePoint library column.
Accepted Values:
Read only.

Value

Function:
Specifies the value of the SharePoint list column.
Accepted Values:
Read only.

Field Display Name

Function:
Specifies the SharePoint column names for your list or library.
Accepted Values:
Read only.

The values show when you select a list item.

Field Internal Value

Function:
Specifies the internal names of the SharePoint columns for your list or library.
Accepted Values:
Read only.

The values show when you select a list item

Meta Data Name

Function:
The name of the process data variable to store the list item field values. The values can be changed to a process attribute, an XML schema element, or SharePoint variable.
Accepted Values:
  • A process attribute.
  • An XPath to a schema element.

    To add XML metadata associated with the process model, click the button in the MetaData Name field.

  • SharePoint metadata.
  • The URI for one or more files.

    You can attach one or more files separated by semicolon (;) using:

    • Local file path - c:\[path]\[file name]
    • URL - http://[URL]/[file name]
Default Value:
None.

When you add a field, the Meta Data Name column shows the internal name of the SharePoint column.

Accepts Process Data Variables:
Yes

Filter Filter icon

Function:
Shows the items in the list based on the values you enter.
  1. Click Filter Filter icon.
  2. On the filter screen, select your operator.
  3. Enter the values to show in your list.
Accepted Values:
  • Is equal to
  • Is not equal to
  • Starts with
  • Contains
  • Does not contain
  • Ends with
Default Value:
Is equal to