Configuration for Retrieving ListItem Fields Window

Determines how to retrieve list item field values to update custom attributes, schema metadata, or SharePoint metadata.



After the Source Site is configured, the configuration window will look similar to below.



The MetaData Name column is used to specify a custom attribute, schema metadata, or SharePoint metadata where the value from the list field that is retrieved will be updated to.

Note: In order to update the XML metadata with the retrieved field values, the AgilePoint Envision process template type must be either Microsoft InfoPath or Generic.

The MetaData Name can be configured as follows:

  1. Use the Add button to select a SharePoint metadata item.
  2. Input a custom attribute name (e.g. Company1).
  3. Click the button at the right side of the field to select a schema metadata.

Navigation

  1. In AgilePoint Envision, open a process template.
  2. Navigate to the SharePoint stencil.
  3. On the SharePoint stencil, drag the Retrieve List Item AgileShape, and drop it on the process template.
  4. To view the entire list of properties, in the Design Tasks pane, click Show Properties.
  5. On the ItemValues field, click the Ellipses button.

Field Definitions

Field Name Definition

List URL

Definition:
Specifies the SharePoint list URL you want.
Allowed Values:
A valid SharePoint list URL.
Note: If you use a library URL, such as a document library URL or form library URL, instead of a list URL, an error occurs during execution.
Default Value:
${DocUrl}
Custom Attributes:
Yes
Example:
  • http://[machine name]:[port]/sites/[site name]

  • $\{DocUrl\}

ListItem Field Name

Definition:
Specifies the name of a SharePoint list column.
Allowed Values:
Read only.

"ID", the list column that specifies the unique list item ID.

ListItem Field Value

Definition:
Specifies the SharePoint list column's value.

This value can be used as a filter to limit the scope of the action.

Allowed Values:

The list column's value.

Default Value:
${ListItemID}
Custom Attributes:
Yes
Example:
  • $\{ListItemID\} or $\{SubListItemID\}
  • A list item ID such as 9

Add

Opens the Following Window:
Select SharePoint Library Column Window
Purpose of this Window:
Specifies a SharePoint library column.

MetaData Name

Definition:
The name of the process variable you want to store the retrieved list item field values. The retrieved metadata values can be updated to a custom attribute, an XML schema element, or SharePoint metadata.
Allowed Values:
  • A custom attribute
  • An XPath to a schema element

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

    Note: In order to update the XML metadata with the retrieved field values, the AgilePoint Envision process template type must be either Microsoft InfoPath or Generic.
  • A SharePoint metadata
Default Value:
None

However, when you add a field using the Add button, the MetaData Name is populated with the internal name of the SharePoint column.

For example, Author1, where Author is the internal name of the SharePonit column named Author.

Custom Attributes:
Yes

Field DisplayName

Definition:
Specifies the SharePoint column names for the specified list or library.
Allowed Values:
Read only.

The values are populated when you click Add, and then select a list item on the Select SharePoint Library Column Window.

Field InternalName

Definition:
Specifies the internal names of the SharePoint columns for the specified list or library.
Allowed Values:
Read only.

The values are populated when you click Add, and then select a list item on the Select SharePoint Library Column Window.

Remove

Function:
Deletes the selected row from the list.

Common Configuration Tasks