AgilePoint Configuration List for SharePoint (Microsoft 365)

When you add the AgilePoint Work Center web part, a new SharePoint list is added called the AgilePoint Configuration List, which stores the configuration settings for the AgilePoint Intelligent Process Automation app. To create a new AgilePoint Configuration List item in the Modern Work Center view in SharePoint for Microsoft 365, do the procedure in this topic.

Background And Setup

Prerequisites

Good to Know

  • When the AgilePoint Configuration List is added to Microsoft 365 because it is created within the AgilePoint NX Portal, the main configuration values, such as Server Instance URL, and Tenant Name, are configured by default.
  • Some of these options do not show by default. You must add these yourself.
  • For all AgilePoint Configuration List settings, the following values apply:
    • Application - This value must be AgilePoint.
    • Encrypted - If you select this option, data associated with this setting is encrypted to and from SharePoint. This setting is optional except in these conditions:

How to Start

  1. In SharePoint for Microsoft 365, open the web part you added to the SharePoint site.

    Shows AgilePoint Nx Portal
  2. In the left pane, click Site contents.

    Click Site contents
  3. Click AgilePoint Configuration.

    Click AgilePoint Configuration

AgilePoint NX Tenant Information

Configures your AgilePoint NX tenant information.

Fields

Field NameDefinition

ServerInstanceUrl
Description:
Specifies the REST URL for your virtual AgilePoint server.

For more information, refer to Find your AgilePoint Server Instance REST URL.

Allowed Values:
A valid REST URL in the following format:

https://[virtual AgilePoint Server instance host name]:[REST port]/AgilePointServer

Note: If your AgilePoint Server instance uses HTTPS, to use on-premises SharePoint, the web application for your SharePoint site must be configured to use HTTPS.
Default Value:
The REST URL for your AgilePoint Server instance.
Example:
https://sunres.com:1451/AgilePointServer

PortalInstanceUrl
Description:
Specifies the URL for the AgilePoint NX service in the following format:

https://[AgilePoint NX portal host name]

For more information, refer to Find your AgilePoint Server Instance REST URL.

Allowed Values:
A valid AgilePoint NX service URL.
Note: If your AgilePoint Server instance uses HTTPS, to use on-premises SharePoint, the web application for your SharePoint site must be configured to use HTTPS.
Default Value:
The URL for your AgilePoint NX Portal instance.
Example:
https://sunresportal.com

TenantName
Description:
Specifies the name of your AgilePoint NX tenant.

For more information, refer to Find your AgilePoint Server Instance REST URL.

Allowed Values:
A valid AgilePoint NX tenant name.
Default Value:
None

General Configuration

Configures the basic settings for the AgilePoint Intelligent Process Automation app.

Fields

Field NameDefinition

ShowDelegation
Description:
Specifies whether to show the Delegations tab in Modern Work Center.
Allowed Values:
  • True - Shows the Delegations tab.
  • False - Does not show the Delegations tab.
Default Value:
True

ShowUserDashboard
Description:
Specifies whether to show the User Statistics tab in the Work Center.
Allowed Values:
  • True - Shows the User Statistics tab.
  • False - Hides the User Statistics tab.
Default Value:
True

ShowExternalApps
Description:
Specifies whether to show the External Apps tab in Modern Work Center.
Allowed Values:
  • True - Shows the External Apps tab.
  • False - Hides the External Apps tab.
Default Value:
True

DurationforMyRecentTasksInHours
Function:
Specifies the time duration in hours to show the tasks assigned to the runtime app user in the last specified hours on the My Recent Tasks widget on the Overview screen.

For more information, refer to My Recent Tasks widget.

Allowed Values:
  • 24 - Shows the tasks assigned to the runtime app user in the last 24 hours.
  • 48 - Shows the tasks assigned to the runtime app user in the last 48 hours.
  • 72 - Shows the tasks assigned to the runtime app user in the last 72 hours.
Default Value:
24

DurationforMyRecentRequestsInDays
Function:
Specifies the time duration in days to show the processes the runtime app user started in the last specified days on the My Recent Requests widget on the Overview screen.

For more information, refer to My Recent Requests widget.

Allowed Values:
An integer.
Default Value:
7

ShowTaskPlanner
Function:
Specifies whether the Overview screen shows the My Planned Tasks widget in Work Center. This widget lets the user add tasks or appointments to the planner.
Allowed Values:
  • True - Shows the My Planned Tasks widget on the Overview screen, and the user can add tasks or appointments to the planner.
  • False - The Overview screen does not show the My Planned Tasks widget, and the user can not add tasks or appointments to the planner.
Default Value:
True

ShowWatchlist
Function:
Specifies whether the Overview screen shows the Watchlist widget in Work Center. This widget lets the user add the running processes to the watchlist.
Allowed Values:
  • True - Shows the Watchlist widget on the Overview screen, and the user can add the running processes to the watchlist.
  • False - The Overview screen does not show the Watchlist widget, and the user can not add the running processes to the watchlist.
Default Value:
True

EnableCloneRequest
Description:
Specifies whether to show the Clone Request option on the My Recent Tasks widget on the Overview screen.

For more information, refer to My Recent Tasks widget.

Allowed Values:
  • True - Shows the Clone Request option on the My Recent Tasks widget.
  • False - Hides the Clone Request option from the My Recent Tasks widget.
Default Value:
True

Tasks Tab Configuration

Configures the basic settings for the Tasks tab.

Fields

Field NameDefinition

ViewTaskType
Description:
Specifies the default view for the tasks to show on the Tasks screen.
Allowed Values:
  • All Tasks
  • My Tasks
  • My Direct Team
  • My Department
  • My Team And Sub
  • My Group
  • My Group Peers
Default Value:
My Tasks

ShowActivityNameInTaskList
Description:
Specifies whether to show the activity display name or the form name in a task list on the Tasks screen.
Allowed Values:
  • True - Shows the activity display name.
  • False - Shows the form name.
Default Value:
True

HideContextMenu
Description:
Specifies menu items to hide for tasks in the task list.
Allowed Values:
One or more menu option names, separated by semicolons (;).
  • View Process
  • Open Task
  • Reassign Task
  • Rework
  • Create Linked Work Item
  • Change Priority
  • Cancel Process Cancel Process icon
  • View Description
Default Value:
None
Example:
View Process;Cancel Process

GroupTasksBy
Function:
Specifies how to group the tasks on the Tasks screen.
Allowed Values:
  • Status - Groups the tasks based on the status.
  • Priority - Groups the tasks based on importance.
  • Process - Groups the tasks based on their associated processes.
  • User (Grid View) - Groups the tasks in a grid view based on the user name.
  • Default (Grid View) - Groups the tasks in a grid view based on the release date.
Default Value:
Status

ShowAnonymousTasks
Function:
Specifies whether the Tasks screen shows tasks that use anonymous forms in the task list.
Allowed Values:
  • True - Shows tasks that use anonymous forms in the task list.
  • False - Hides tasks that use anonymous forms in the task list.
Default Value:
False

ShowDynamicGroupsRoleTask
Description:
Specifies whether to show tasks for the dynamic groups or roles on the Tasks tab.
Allowed Values:
  • True - Shows the tasks for the dynamic groups or roles on the Tasks tab.
  • False - Hides the tasks for the dynamic groups or roles on the Tasks tab.
Default Value:
False

ShowCardTaskName
Description:
Specifies whether to show the task name on the task card on the Tasks tab.
Allowed Values:
  • True - Shows the task name on the Tasks tab.
  • False - Hides the task name on the Tasks tab.
Default Value:
True

CardTaskNameOrder
Description:
Specifies the order to show the task name on the task card on the Tasks tab.
Allowed Values:
An integer.

Range:

  • 1-3
Default Value:
1

ShowCardProcessInstanceName
Description:
Specifies whether to show the process instance name on the task card on the Tasks tab.
Allowed Values:
  • True - Shows the process instance name on the Tasks tab.
  • False - Hides the process instance name on the Tasks tab.
Default Value:
True

CardProcessInstanceNameOrder
Description:
Specifies the order to show the process instance name on the task card on the Tasks tab.
Allowed Values:
An integer.

Range:

  • 1-3
Default Value:
2

ShowCardInitiator
Description:
Specifies whether to show the process initiator on the task card on the Tasks tab.
Allowed Values:
  • True - Shows the process initiator on the Tasks tab.
  • False - Hides the process initiator on the Tasks tab.
Default Value:
False

CardInitiatorOrder
Description:
Specifies the order to show the process initiator on the task card on the Tasks tab.
Allowed Values:
An integer.

Range:

  • 1-3
Default Value:
3

Processes Tab Configuration

Configures the settings for the Processes tab.

Fields

Field NameDefinition

ViewProcessType
Description:
Specifies the default view for the processes to show on the Processes screen.
Allowed Values:
  • My Processes
  • My Direct Team
  • My Department
  • My Team And Sub
  • My Group
  • My Group Peers
Default Value:
My Processes
Example:
My Department

ShowSubprocess
Function:
Specifies whether the Processes screen shows subprocesses in the process list.
Allowed Values:
  • True - Subprocesses show in the process list.

    For more information, refer to Subprocess activity.

  • False - Only parent processes show in the process list.
Default Value:
True

Process Viewer Configuration

Configures the settings for the Process Viewer.

Fields

Field NameDefinition

AllowChangeFlowFor
Function:
Specifies the type of users to whom to show the Change Flow option on the Process Viewer screen.
Allowed Values:
  • Anyone With Change Flow Permissions - Shows the Change Flow option for users who have the Rollback A Process access right.
  • App Owners And Administrators With Change Flow Permissions - Shows the Change Flow option for users who are App Owners or a member of the Administrators role.
  • None - Hides the Change Flow option on the Process Viewer screen.
Default Value:
App Owners And Administrators With Change Flow Permissions

ShowActivityTimeframe
Function:
Specifies whether the Process Viewer screen shows the total time taken to complete an activity.
Allowed Values:
  • True - Shows the total time taken to complete an activity.
  • False - The Process Viewer screen does not show the time taken to complete an activity.
Default Value:
False

ShowActivityTooltip
Function:
Specifies whether to show the information about an activity when a runtime app user hovers over the activity on the Process Viewer screen.
Allowed Values:
  • True - Shows the information about an activity when a runtime app user hovers over the activity.
  • False - Hides the text when a runtime app user hovers over the activity.
Default Value:
True

Column Configuration

Configures the columns that show on the task lists or process lists.

Fields

Field NameDefinition

ShowPriorityColumn
Description:
Specifies if you want to show the Priority column on the Tasks tab.
Allowed Values:
  • True - Shows the priority column.
  • False - Does not show the priority column.
Default Value:
True

PriorityColumnName
Description:
Specifies a different name for the Priority column on the Tasks tab.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Priority

PriorityColumnIndex
Description:
Specifies the order to show the Priority column on the Tasks tab.
Allowed Values:
An integer.

Range:

  • 1-20
Default Value:
1

TaskColumnName
Description:
Specifies a different name for the Task Name column on the Tasks tab.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Task Name

TaskColumnIndex
Description:
Specifies the order to show the Task Name column on the Tasks tab.
Allowed Values:
An integer.

Range:

  • 1-20
Default Value:
2

ShowProcessNameColumn
Description:
Specifies whether to show the process model name on the Tasks and Processes tab.
Allowed Values:
  • True - Shows the Process Name column.
  • False - Does not show the Process Name column.
Default Value:
True

ProcessColumnName
Description:
Specifies a different name for the Process column on the Tasks and Processes tab.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Process

ProcessColumnIndex
Description:
Specifies the order to show the Process Model Name column on the Tasks and Processes tab.
Allowed Values:
An integer.

Range:

  • 1-20
Default Value:
3

ShowStatusColumn
Description:
Specifies if you want to show the task status on the Tasks and Processes tab.
Allowed Values:
  • True - Shows the Status column.
  • False - Does not show the Status column.
Default Value:
True

StatusColumnName
Description:
Specifies a different name for the Status column on the Tasks and Processes tab.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Status

StatusColumnIndex
Description:
Specifies the order to show the Status column on the Tasks and Processes tab.
Allowed Values:
An integer.

Range:

  • 1-20
Default Value:
4

ShowDueDateColumn
Description:
Specifies if you want to show the Due Date column for the task on the Tasks tab.
Allowed Values:
  • True - Shows the Due Date column.
  • False - Does not show the Due Date column.
Default Value:
True

DueDateColumnName
Description:
Specifies a different name for the Due Date column on the Tasks tab.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Due Date

DueDateColumnIndex
Description:
Specifies the order to show the Due Date column on the Tasks tab.
Allowed Values:
An integer.

Range:

  • 1-20
Default Value:
5

ShowUserIdColumn
Description:
Specifies if you want to show the assigned user on the Tasks tab.
Allowed Values:
  • True - Shows the User column.
  • False - Does not show the User column.
Default Value:
True

UserIDColumnName
Description:
Specifies a different name for the User column on the Tasks tab.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
User

UserIDColumnIndex
Description:
Specifies the order to show the User column on the Tasks tab.
Allowed Values:
An integer.

Range:

  • 1-20
Default Value:
6

ShowProcessInstColumn
Description:
Specifies whether to show the process instance name and drop-down option list on the Tasks and Processes tab.
Allowed Values:
  • True - Shows the Process Instance Name column.
  • False - Does not show the Process Instance Name column.
Default Value:
True

ProcessInstColumnName
Description:
Specifies a different name for the Process Instance Name column on the Tasks and Processes tab.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Process Instance Name

ProcessInstanceColumnIndex
Description:
Specifies the order to show the Process Instance Name column on the Tasks and Processes tab.
Allowed Values:
An integer.

Range:

  • 1-20
Default Value:
7

ShowStartedDateColumn
Description:
Specifies whether to show the date the process started on the Processes tab.
Allowed Values:
  • True - Shows the Started Date column.
  • False - Does not show the Started Date column.
Default Value:
True

StartedDateColumnName
Description:
Specifies a different name for the Started Date column on the Processes tab.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Started Date

StartedDateColumnIndex
Description:
Specifies the order to show the Started Date column on the Processes tab.
Allowed Values:
An integer.

Range:

  • 1-20
Default Value:
8

ShowProcessInitiatorName
Description:
Specifies whether to show the process initiator on the Processes tab.
Allowed Values:
  • True - Shows the Initiator column.
  • False - Does not show the Initiator column.
Default Value:
True

ProcessInitiatorColumnName
Description:
Specifies a different name for the Initiator column on the Processes tab.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Initiator

ProcessInitiatorColumnIndex
Description:
Specifies the order to show the Process Intiator column on the Processes tab.
Allowed Values:
An integer.

Range:

  • 1-20
Default Value:
9

ShowAssignedDateColumnName
Description:
Specifies if you want to show the date a task was assigned on the Tasks tab.
Allowed Values:
  • True - Shows the Assigned Date column.
  • False - Does not show the Assigned Date column.
Default Value:
True

AssignedDateColumnName
Description:
Specifies a different name for the Assigned Date column on the Tasks tab.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Assigned Date

AssignedDateColumnIndex
Description:
Specifies the order to show the Assigned Date column on the Tasks tab.
Allowed Values:
An integer.

Range:

  • 1-20
Default Value:
10

ShowDepartmentColumnName
Description:
Specifies if you want to show the assigned user's department on the Tasks tab.
Allowed Values:
  • True - Shows the Department column.
  • False - Does not show the Department column.
Default Value:
True

DepartmentColumnName
Description:
Specifies a different name for the Department column on the Tasks tab.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Department

DepartmentColumnIndex
Description:
Specifies the order to show the Department column on the Tasks tab.
Allowed Values:
An integer.

Range:

  • 1-20
Default Value:
11

ShowCategoryColumn
Description:
Specifies whether to show the Category column on the Processes tab.
Allowed Values:
  • True - Shows the Category column on the Processes tab.
  • False - Hides the Category column on the Processes tab.
Default Value:
True

CategoryColumnName
Description:
Specifies a different name for the Category column on the Processes tab.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Category

CategoryColumnIndex
Description:
Specifies the order to show the Category column on the Processes tab.
Allowed Values:
An integer.

Range:

  • 1-20
Default Value:
12

My Apps Tab Configuration

Configures the settings for the My Apps tab.

Fields

Field NameDefinition

GroupAppsByCategory
Function:
Specifies whether to organize the published apps in a category on the My Apps screen.
Allowed Values:
  • True - Groups the published apps by their categories.
  • False - Groups the published apps by the release date.
Default Value:
False

ShowProcessNameOnAppTile
Function:
Specifies whether the My Apps screen shows the process instance name on the app tile.
Allowed Values:
  • True - The App tile shows both the app name and the process instance name on the My Apps screen.
  • False - The App tile shows only the app name on the My Apps screen.
Default Value:
False

MyAppsSortByReleaseDate
Description:
Specifies whether to sort the apps or process models by release data to show on the My Apps screen in Work Center.
Allowed Values:
  • True - Sorts the apps or process models by release date.
  • False - Sorts the apps or process models by app name in decending order.
Default Value:
True

MaximumNumberOfFrequentlyUsedApps
Description:
Specifies the maximum number of published apps to show in the Frequently Used Apps widget on the Overview screen and the My Apps screen.
Allowed Values:
An integer.
Default Value:
5

Item Display Configuration

Configures the items to show on a page.

Fields

Field NameDefinition

RowCount
Description:
Specifies the number of items to show in the task list and process lists.
Allowed Values:
An integer.
Default Value:
100

Navigation Bar Color Configuration

Configures colors for the navigation bar.

Fields

Field NameDefinition

NavBarBackgroundColor
Description:
Specifies the background color for the navigation bar.
Allowed Values:
A color value using a hex code.
Default Value:
#484644

NavBarHoverColor
Description:
Specifies the background color for a tab in the navigation bar when a runtime app user hovers over the tab.
Allowed Values:
A color value using a hex code.
Default Value:
#CCCCCC

NavBarHoverTextColor
Description:
Specifies the text color for a tab in the navigation bar when a runtime app user hovers over the tab.
Allowed Values:
A color value using a hex code.
Default Value:
#000000

NavBarTextColor
Description:
Specifies the text color for the tab names in the navigation bar.
Allowed Values:
A color value using a hex code.
Default Value:
#FFFFFF