Standard List Form activity

An activity that, when the process runs, shows a form made with SharePoint list.



Configure the Standard List Form activity

To configure the Standard List Form activity, do the procedure in this topic.

Video: Using SharePoint List Forms with AgilePoint

Examples

Prerequisites

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 Standard List Form (Legacy) activity onto your process.

    Drag Standard List Form Legacy activity

List Form Configuration

Specifies if the fields on a SharePoint List Form are editable, read-only, or hidden.

Figure: List Form Configuration screen

List Form Configuration screen

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:
Limitations:
  • OAuth 2.0 authentication is not supported for this activity.

Site URL

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

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:

Show All Fields

Description:
Specifies whether to show only the column display names from your SharePoint list in the Customize List Form Interface table.
Allowed Values:
  • Deselected - Shows only the column display names.
  • Selected - Shows the SharePoint internal column names and the columns display names.
Default Value:
Deselected

Field Name

Description:
Specifies the names of the SharePoint list form fields.
Allowed Values:
Read only.

This column shows the columns in your SharePoint list.

Field Type

Description:
Specifies the data types of the SharePoint list form fields.
Allowed Values:
Read only.

Editable

Function:
Specifies that the runtime app user can change the value in the field.

Read Only

Function:
Specifies that the selected SharePoint list form field is read-only.

Hidden

Function:
Specifies that the selected SharePoint list form field is hidden.

General Configuration

Specifies the basic settings for the Standard List Form activity.

Figure: General Configuration screen

General Configuration screen

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

Time To Complete

Description:
Specifies the maximum amount of time that should be allowed for the completion of the task associated with this activity before it is considered Overdue. This is a combination of a number of minutes, hours, days, or weeks.
Allowed Values:
A number of minutes, hours, days, or weeks.
Default Value:
1 Day
Accepts Variables:
Yes

Priority

Description:
Specifies the importance of a task.
Allowed Values:
  • High - Specifies a high priority task. A high priority task shows High High icon icon.
  • Normal - Specifies a normal priority task. A normal priority task shows Normal Normal icon icon.
  • Low - Specifies a low priority task. A low priority task shows Low Low icon icon.
Default Value:
Normal
Accepts Variables:
Yes

Participants

Specifies the people, groups, or roles assigned to a human task.

Figure: Participants screen

Participants screen

Fields

Field NameDefinition

Details

Description:
Shows participants for the task.
Allowed Values:
  • Any user, group, or role - You can add users, groups, or roles as participants, as long as ProcessInitiator is also included in the list.
  • A process data variable.
  • ProcessInitiator - This is a process data variable for that represents a participant who completes a form to start a process instance. This value is required for start tasks.
Default Value:
  • ProcessInitiator - For start tasks.
  • None - For other tasks.
Accepts Variables:
Yes
Example:
Refer to:

Add Roles, Groups and Users

Description:
Specifies a category of participants to add to the task. The list of participants of the type you select shows.
Allowed Values:
  • Groups - Shows your AgilePoint groups.

    To create a group, refer to Groups.

  • Roles - Shows your AgilePoint roles.

    To create a role, refer to Roles.

  • Users - Shows your AgilePoint users.

    To add a new user, refer to Users.

Default Value:
Roles
Accepts Variables:
No
Example:
Refer to:

Search

Function:
Does a search based on the specified criteria.

The maximum number of participants to complete this task

Description:
Specifies the number of group members who need to be assigned as participants for a task.
Allowed Values:
  • An integer that specifies a number of participants within a group required to complete a task.
  • Unlimited Participants - Specifies that all members of a group are required to participate.
Default Value:
1
Example:
If the participant is set to a group of users, and Max number of people to complete this task is 2, then 2 members of the group actually are required to participate in the task.

Assign task to the same participants each time activity runs

Description:
Specifies if, when a activity runs more than one time during a process, the same participants must complete the task each time.
Allowed Values:
  • Selected - If an activity is runs more than one time, the same participants who took assignment the first time are also assigned the task each time after.
  • Deselected - If an activity is runs more than one time, any participants can take assignment each time.
Default Value:
Selected
Example:
Ann is part of a group, and takes assignment for a task. She rejects the task. If this field is selected, the next time the process starts this task, the same user, Ann is assigned the task. If this field is deselected, the task goes back into the pool, and anyone in the group can take assignment.

Also refer to:

User Defined Properties

Specifies ClientData process data variable values that are associated with a human task activity when a process runs. You can specify a set of variables as name/value pairs that are sent to your web forms. This is an alternative to sending data with URL parameters.

Figure: User Defined Properties screen

User Defined Properties screen

Fields

Field NameDefinition

Name

Description:
Specifies the name for the ClientData.

The ClientData property stores data related to the human task activity. This is like defining a process data variable to store specific values.

Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • 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:
The value for the ClientData variable.
Allowed Values:
A number or a text string that can contain spaces.

You can set the value for the process data variable by using an XML value.

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?

Type

Description:
Determines the data type for the ClientData variable.
Allowed Values:
  • string
  • int
  • bool
  • decimal
Default Value:
string

Create Create icon

Function:
Creates a row where you can specify a ClientData property.

Delete Delete icon

Function:
Deletes the selected row from the user defined properties list.