Start List Form activity

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

Accepts Process Data Variables:

No

Example:

Refer to:

• (Example) Configure a Create List Item Activity to Put the Leave Information in the SharePoint List
• Form Based Applications – SharePoint Data Source
• (Example) Create a SharePoint Access Token

Limitations:

• OAuth 2.0 authentication is not supported for this activity.

Site URL

Function:

Specifies the URL for your SharePoint site.

Accepted Values:

A valid SharePoint site URL.

Default Value:

None

Accepts Process Data Variables:

No

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.
• Form Based Applications – SharePoint Data Source

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:

• (Example) Configure a Create List Item Activity to Put the Leave Information in the SharePoint List

Show All Fields

Function:

Specifies whether to show only the column display names from your SharePoint list in the Customize List Form Interface table.

Accepted 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

Function:

Specifies the names of the SharePoint list form fields.

Accepted Values:

Read only.

This column shows the columns in your SharePoint list.

Field Type

Function:

Specifies the data types of the SharePoint list form fields.

Accepted 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.

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:

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

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

Time to Complete

Function:

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.

Accepted Values:

A number of minutes, hours, days, or weeks.

Default Value:

1 Day

Accepts Process Data Variables:

Yes

Priority

Function:

Specifies the importance of a task.

Accepted Values:

• High - Specifies a high priority task. A high priority task shows High icon.
• Normal - Specifies a normal priority task. A normal priority task shows Normal icon.
• Low - Specifies a low priority task. A low priority task shows Low icon.

Default Value:

Normal

Accepts Process Data Variables:

Yes

Details

Function:

Shows participants for the task.

Accepted 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 Process Data Variables:

Yes

Example:

Refer to:

• (Example) Configure Dynamic Task Pool Activity and Load Balancing Activity

Participant Type list

Function:

Specifies a category of participants to add to the task. The list of participants of the type you select shows.

Accepted Values:

• Groups - Shows your AgilePoint groups.

  To create a group, refer to Create a Group.

• Roles - Shows your AgilePoint roles.

  To create a role, refer to create a role.

• Users - Shows your AgilePoint users.

  To add a new user, refer to Add a New User.

Default Value:

Groups

Accepts Process Data Variables:

No

Example:

Refer to:

• (Example) Configure Dynamic Task Pool Activity and Load Balancing Activity

Search

Function:

Does a search based on the specified criteria.

The maximum number of participants to complete this task

Function:

Specifies the number of group members who need to be assigned as participants for a task.

Accepted 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

Function:

Specifies if, when a activity runs more than one time during a process, the same participants must complete the task each time.

Accepted 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:

• (Example) Configure Dynamic Task Pool Activity and Load Balancing Activity

Name

Function:

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.

Accepted Values:

One line of text that can have spaces.

Default Value:

None

Accepts Process Data Variables:

Yes

Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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

Function:

The value for the ClientData variable.

Accepted 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 Process Data Variables:

Yes

Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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

Function:

Determines the data type for the ClientData variable.

Accepted Values:

• string
• int
• bool
• decimal

Default Value:

string

Add

Function:

Creates a row where you can specify a ClientData property.

Delete

Function:

Deletes the selected row from the user defined properties list.