Update Metadata activity

An activity that changes metadata in SharePoint.


Update Metadata activity

Configure the Update Metadata activity

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

Video: eForms with SharePoint - Part 4

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, and open the SharePoint tab.

    Open SharePoint tab
  3. On the SharePoint tab, drag the Update Metadata activity onto your process.

    Drag Update Metadata activity

General Configuration

Specifies the basic settings for the Update Metadata 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

Update Metadata Configuration > Configuration tab

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

Figure: Update Metadata Configuration > Configuration tab

Update Metadata Configuration Configuration tab

Fields

Field NameDefinition

SharePoint
Description:
Specifies the access token that connects to your SharePoint site.
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 SharePoint
Function of this Screen:
Configure an access token to connect to SharePoint.
Example:
Refer to:

Site
Description:
Specifies the URL for your SharePoint site.
Allowed Values:
A valid SharePoint site URL.
Default Value:
None
Accepts Variables:
Yes
Example:

  • http://[machine name]:[port]/sites/[site name]

    Note: You must include the /sites in the Site URL for the site to be created successfully.

Also refer to:

List
Description:
Specifies the name of your SharePoint list.
Allowed Values:
The name of your SharePoint list.
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:

Folder
Description:
Specifies the name of your SharePoint folder.

The folder contains the process data variables to change.

Allowed Values:
The name of your SharePoint folder
Default Value:
None
Accepts Variables:
No

Field
Description:
Specifies the name of the SharePoint column to use to limit the change in the process data variable's value.
Allowed Values:
The name of your SharePoint list column.
Default Value:
"ID", the list column that specifies the unique list item ID.
Accepts Variables:
No
Example:
Refer to:

Field Value
Description:
Specifies the SharePoint column's value.

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

Allowed 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 Variables:
Yes
Example:
Refer to:
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?

Update Metadata Configuration > SharePoint List tab

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

Figure: Update Metadata Configuration > SharePoint List tab

Update Metadata Configuration SharePoint List tab

Fields

Field NameDefinition

Display Name
Description:
Specifies the name of the SharePoint library column.
Allowed Values:
Read only.
Example:
Refer to:

Value
Description:
Specifies the value of the SharePoint list column.
Allowed Values:
Read only.
Example:
Refer to:

Field Display Name
Description:
Specifies the SharePoint column names for your list or library.
Allowed Values:
Read only.

The values show when you select a list item.

Field Internal Value
Description:
Specifies the internal names of the SharePoint columns for your list or library.
Allowed Values:
Read only.

The values show when you select a list item

Meta Data Name
Description:
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.
Allowed 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 semicolons (;) 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 Variables:
Yes
Example:
Refer to:

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

Update Metadata Configuration > Item Ownership tab

Specifies the owner of a metadata you changed in SharePoint .

Figure: Update Metadata Configuration > Item Ownership tab

Item Ownership tab

Fields

Field NameDefinition

Item Ownership
Description:
Specifies the owner of a metadata you changed in SharePoint .
Allowed Values:
Default Value:
Service Account used in Access Token