AgilePoint Configuration List for SharePoint (Microsoft 365, Classic)

When you add the Dashboard App Part or Web Part, a new SharePoint list is added called the AgilePoint Configuration List, which stores the configuration settings for the Dashboard. To create a new AgilePoint Configuration List item in the Classic Work Center view in SharePoint for Microsoft 365, do the procedure in this topic.

Background And Setup

Prerequisites

Good to Know

  • You must change the values in the list items before you can use SharePoint Integration.
  • 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. Open a SharePoint site collection where the AgilePoint App Part or Web Part is installed.
  2. Click Settings Settings icon > Site Contents.
  3. 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:
None
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:
None
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

Authentication

Configures the authentication to connect from SharePoint to AgilePoint NX.

Fields

Field NameDefinition

AuthenticationType
Description:
Specifies the type of authentication to connect from SharePoint to AgilePoint.

If you select Salesforce, Windows Azure, or Microsoft 365, you can use single sign-on for AgilePoint, which works through the third-party authentication service. For these options, your authentication credentials are not visible to either AgilePoint or SharePoint.

If you use your AgilePoint ID, you must enter your AgilePoint authentication credentials as list items in the configuration list.

Allowed Values:
Default Value:
  • Microsoft 365 integration - Microsoft 365
  • SharePoint on premises integration - Active Directory

Task Behavior Configuration

Configures how tasks open when users click the task name.

Fields

Field NameDefinition

OpenTaskByClick
Description:
Specifies whether to open a task form when the user clicks the task name.
Allowed Values:
  • True - Opens the task form.
  • False - Does not open the task form.
Default Value:
True

OpenTasksInNewWindow
Description:
Specifies whether tasks open in a new browser window or tab, or the same window or tab.
Allowed Values:
  • True - Tasks open in a new window or tab.
  • False - Tasks open in the same window or tab.
Default Value:
True

Process Display Configuration

Configures how processes open when users click the task name.

Fields

Field NameDefinition

OpenProcessViewerInNewWindow
Description:
Specifies whether to show the process in the Process Viewer in a new tab.
Allowed Values:
  • True - Shows the process in the Process Viewer in a new tab.
  • False - Shows the process in the Process Viewer in a pop-up, or overlay.
Default Value:
True

ProcessViewerDefaultZoom
Description:
Specifies the default zoom setting for the Process Viewer.
Allowed Values:
An integer.

Range

  • 1-100

Represents

  • A percentage
Default Value:
100

Task Tabs Configuration

Configures menu options or columns to show or hide on the task tabs.

Fields

Field NameDefinition

ShowActivityNameInTaskList
Description:
Specifies whether to show the activity display name or the form name.
Allowed Values:
  • True - Shows the activity display name.
  • False - Shows the form name.
Default Value:
False

HideContextMenu
Description:
Specifies menu items to hide for tasks in the My Tasks 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

HideTaskView
Description:
Specifies menu items to hide for a task in the View list.
Allowed Values:
One or more menu option names, separated by semicolons (;).
  • All Tasks
  • My Tasks
  • My Direct Team
  • My Department
  • My Team And Sub
  • My Groups
  • My Group Peers
  • Application I Own
Default Value:
None
Example:
All Tasks;My Team And Sub;My Groups

ReadOnlyTaskView
Description:
Specifies the tasks to make read-only in the View list. For the items you specify, only the View Process option shows. For example, if you enter My Department, for any tasks related to your department, you can only view the process for that task. You can not do other actions, such as open or reassign the task.
Allowed Values:
One or more menu option names, separated by semicolons (;).
  • All Tasks
  • My Tasks
  • My Direct Team
  • My Department
  • My Team And Sub
  • My Groups
  • My Group Peers
  • Application I Own
Default Value:
None
Example:
My Department;My Groups

ShowTaskFilter
Description:
Specifies whether to show the tasks for the apps or processes in the tasks tab.
Allowed Values:
  • True - Shows the tasks specified in the HiddenTaskFilter field.
  • False - Does not show the tasks specified in the HiddenTaskFilter field.
Default Value:
True

HiddenTaskFilter
Description:
Specifies the tasks to show on the tasks tabs.
Allowed Values:
A list of valid application or process display names, separated by semicolons (;)
Default Value:
None
Example:
Budget Request;Deal Review;Leave Request

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

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

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

ShowStatusColumn
Description:
Specifies if you want to show the task status in the task tabs.
Allowed Values:
  • True - Shows the Status column.
  • False - Does not show the Status column.
Default Value:
True

ProcessStatus
Description:
Specifies the processes to show in your process lists.
Allowed Values:
One or more menu option names, separated by semicolons (;).
  • Running - The process instance is active and running.
  • Initiated - The process instance has been initiated, but is not yet running.
  • Suspended - The process instance is active, but it is paused, or suspended.
  • Cancelled - The process instance has been cancelled, and is no longer active.
  • Completed - The process instance is no longer active because it has been completed.
Default Value:
Running
Example:
Running;Completed;Suspended

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

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

Process Tabs Configuration

Configures menu options or columns to show or hide the process tabs.

Fields

Field NameDefinition

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

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

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

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

HideProcessView
Description:
Specifies menu items to hide for a process in the View list.
Allowed Values:
One or more menu option names, separated by semicolon (;).
  • My Processes
  • My Direct Team
  • My Department
  • My Team And Sub
  • My Groups
  • My Group Peers
  • Application I Own
Default Value:
None
Example:
My Processes;My Team And Sub;My Groups

ViewProcessType
Description:
Specifies the default view in the View list.
Allowed Values:
  • My Processes
  • My Direct Team
  • My Department
  • My Team And Sub
  • My Groups
  • My Group Peers
  • Application I Own
Default Value:
My Processes
Example:
My Department

ReadOnlyProcessView
Description:
Specifies the processes to make read-only in the View list. For the items you specify, only the View Process option shows. For example, if you enter My Department, for any processes related to your department, you can only view the process for that task. You can not do other actions, such as open or reassign the task.
Allowed Values:
One or more menu option names, separated by semicolon (;).
  • My Processes
  • My Direct Team
  • My Department
  • My Team And Sub
  • My Groups
  • My Group Peers
  • Application I Own
Default Value:
None
Example:
My Department;My Groups

Task and Process List Configuration

Configures the names of columns on the task lists or process lists.

Fields

Field NameDefinition

PriorityColumnName
Description:
Specifies a different name for the Priority column on the task and process tabs.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Priority

ProcessColumnName
Description:
Specifies a different name for the Process column on the task and process tabs.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Process

StatusColumnName
Description:
Specifies a different name for the Status column on the task and process tabs.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Status

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

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Due Date

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

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
User

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

Accepted:

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

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

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Started Date

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

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Initiator

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

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Assigned Date

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

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Department

Tab Names Configuration

Configures the names of tabs to show on the AgilePoint App Part or Web Part.

Fields

Field NameDefinition

HeaderOverviewTab
Description:
Specifies a different name for the Overview tab on the Dashboard.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Overview

HeaderMyTaskTab
Description:
Specifies a different name for the My Tasks tab on the AgilePoint NX Dashboard.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
My Tasks

HeaderInQueueTab
Description:
Specifies a different name for the In Queue tab on the AgilePoint NX Dashboard.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
In Queue

HeaderProcessStartedTab
Description:
Specifies a different name for the Processes I Started tab on the AgilePoint NX Dashboard.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Processes I Started

HeaderProcessIWorkedTab
Description:
Specifies a different name for the Process I've Worked tab on the AgilePoint NX Dashboard.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Processes I've Worked

HeaderDelegationsTab
Description:
Specifies a different name for the Delegations tab on the AgilePoint NX Dashboard.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Delegations

HeaderMyAPPTab
Description:
Specifies a different name for the My Apps tab on the AgilePoint NX Dashboard.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
My Apps

Display Tabs Configuration

Configures the tabs to show or hide on the AgilePoint App Part or Web Part.

Fields

Field NameDefinition

ShowDelegationTab
Description:
Specifies whether to show the Delegations tab in the AgilePoint NX Dashboard.
Allowed Values:
  • True - Shows the Delegations tab.
  • False - Does not show the Delegations tab.
Default Value:
True

ShowOverviewTab
Description:
Specifies whether to show the Overview tab in the AgilePoint NX Dashboard.
Allowed Values:
  • True - Shows the Overview tab.
  • False - Does not show the Overview tab.
Default Value:
True

ShowInQueueTab
Description:
Specifies whether to show the In Queue tab in the AgilePoint NX Dashboard.
Allowed Values:
  • True - Shows the In Queue tab.
  • False - Does not show the In Queue tab.
Default Value:
True

ShowMyTasksTab
Description:
Specifies whether to show the My Tasks tab in the AgilePoint NX Dashboard.
Allowed Values:
  • True - Shows the My Tasks tab.
  • False - Does not show the My Tasks tab.
Default Value:
True

ShowProcessIStartedTab
Description:
Specifies whether to show the Process I Started tab in the AgilePoint NX Dashboard.
Allowed Values:
  • True - Shows the Process I Started tab.
  • False - Does not show the Process I Started tab.
Default Value:
True

ShowProcessIWorkedTab
Description:
Specifies whether to show the Process I Worked tab in the AgilePoint NX Dashboard.
Allowed Values:
  • True - Shows the Process I Worked tab.
  • False - Does not show the Process I Worked tab.
Default Value:
True

ShowMyAppsTab
Description:
Specifies whether to show the My Apps tab in the AgilePoint NX Dashboard.
Allowed Values:
  • True - Shows the My Apps tab.
  • False - Does not show the My Apps tab.
Default Value:
True

Item Display Configuration

Configures the items to show on a page.

Fields

Field NameDefinition

ItemPerPage
Description:
Specifies the number of items to show on one page in the task list and process lists.
Allowed Values:
An integer.
Default Value:
10

ChartItemPerPage
Description:
Specifies the number of items to show on the Overview page in the AgilePoint App Part or Web Part.
Allowed Values:
An integer.
Default Value:
10

RowCount
Description:
Specifies the number of rows to show on one page in the AgilePoint NX Dashboard.
Allowed Values:
An integer.
Default Value:
10

Colors For Tasks Tabs Configuration

Configures colors for the tasks tabs.

Fields

Field NameDefinition

ShowPoolTaskInColor
Description:
Specifies if the AgilePoint task lists show tasks assigned to a participant pool in a different color than tasks assigned to one participant.
Allowed Values:
  • True - Shows the pool tasks and tasks assigned to a single participant in different colors.
  • False - Shows the pool tasks and tasks assigned to one participant in the same color.
Default Value:
False

ColorForPoolTask
Description:
Specifies the background color for tasks that are assigned to a pool.

This setting is applicable only if ShowPoolTaskInColor is set to True.

Allowed Values:
The color you want.
Default Value:
LightYellow

ShowOverdueTaskInColor
Description:
Specifies if the AgilePoint NX Dashboard shows Overdue tasks in a different color.
Allowed Values:
  • True - Shows the overdue task in color.
  • False - Does not show the overdue task in color.
Default Value:
False

ColorForOverdueTasks
Description:
Specifies the color for overdue tasks.

This setting is applicable only if ShowOverdueTaskInColor is set to True.

Allowed Values:
The color you want.
Default Value:
Red

App Display Configuration

Configures the apps to show or hide on the My Apps tab.

Fields

Field NameDefinition

ShowApplicationFilter
Description:
Specifies whether to show the apps or process models in the My Apps tab of the Dashboard.
Allowed Values:
  • True - Shows the app or process model specified in the HiddenProcessFilter field.
  • False - Hides the apps or process models specified in the HiddenProcessFilter field.

    If the field is empty it shows all the apps or process models for the user.

Default Value:
True

HiddenProcessFilter
Description:
Specifies the apps or process models to show in the My Apps tab of the Dashboard.
Allowed Values:
A list of application or process names, separated by semicolons (;)
Default Value:
None

Custom CSS Configuration

Configures how the SharePoint Dashboard looks.

Fields

Field NameDefinition

ApplyExternalCss
Description:
Lets you add custom CSS to change how the SharePoint Dashboard looks.
Allowed Values:
  • A CSS code snippet.
  • False - Uses the default AgilePoint CSS.
Default Value:
False

eForm Background Options Configuration

Configures the eForm background to show or hide when open in the SharePoint Dashboard.

Fields

Field NameDefinition

HideBackGround
Description:
Specifies whether to show the eForm container background at runtime.

If a SharePoint form-based app is associated with a SharePoint list, you must click Reset to reset the workflow association on AgilePoint List Form Association screen (Microsoft 365).

Allowed Values:
  • true - Shows the eForm container background.
  • false - The eForm page size expands to the page borders, and the eForm container background does not show.
Default Value:
true

External Web Applications Configuration

Configures the connection to show the tasks from external web applications in the SharePoint Dashboard.

Fields

Field NameDefinition

RemoteWebUrl
Description:
Specifies the URL of a web service whose tasks you want to show in the AgilePoint App Part or Web Part task lists.

For more information, refer to Show External Web Application Tasks in SharePoint.

Allowed Values:
A valid web service URL for your web application.
Default Value:
None