When you add the AgilePoint Dashboard App Part or Web Part, a new SharePoint list is added called the AgilePoint Configuration list.
Prerequisites
- AgilePoint Dashboard is installed For more information, refer to Add the AgilePoint App to a SharePoint Site.
- These instructions are for SharePoint with Office 365. For on-premises SharePoint, refer to Set the AgilePoint Configuration List for SharePoint Integration On Premises.
Good to Know
- You must change the values in the list items before you can use SharePoint Integration.
- For all AgilePoint Configuration List settings, the following values apply:
- Application - This value must be AgilePoint.
- Encrypted - If you select this option, data will be encrypted to and from SharePoint whenever applicable. This setting is important for configuration list items related to URLs and authentication.
How to Start
- Open a SharePoint site collection where the AgilePoint App Part or Web Part is installed.
- Click Settings
> Site Contents. - Click AgilePoint Configuration.
Procedure
- Set your AgilePoint tenant information.
Title AP Setting Value ServerInstanceUrl - Function:
- Specifies the REST URL for your virtual AgilePoint server.
For more information, refer to Find Your Service URLs for AgilePoint NX.
- Accepted Values:
- A valid REST URL in the following format:
http://[virtual AgilePoint Server instance host name]:[REST port]/AgilePointServer
- Default Value:
- None
- Example:
- http://sunres.com:1451/AgilePointServer
PortalInstanceUrl - Function:
- Specifies the URL for the AgilePoint NX service in the following format:
http://[AgilePoint NX portal host name]
For more information, refer to Find Your Service URLs for AgilePoint NX.
- Accepted Values:
- A valid AgilePoint NX service URL.
- Default Value:
- None
- Example:
- http://sunresportal.com
TenantName - Function:
- Specifies the name of your AgilePoint NX tenant.
For more information, refer to Find Your Service URLs for AgilePoint NX.
- Accepted Values:
- A valid AgilePoint NX tenant name.
- Default Value:
- None
- Configure how you want to connect from SharePoint to AgilePoint.
Title AP Setting Value AuthenticationType - Function:
- Specifies the type of authentication to connect from SharePoint to AgilePoint.
If you select Salesforce, Windows Azure, or Office 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.
- Accepted Values:
-
- AgilePointID - Uses the credentials for your AgilePoint SharePoint Impersonator account to connect to the AgilePoint system. Usually the SharePoint Impersonator account is the same as your AgilePoint Service account.
For more information, refer to User Accounts for AgilePoint Components.
- Office365 - SharePoint Integration for Office 365 only. Uses your Microsoft Office 365 credentials to connect to the AgilePoint system.
- ActiveDirectory - SharePoint Integration on premises only. Uses your Active Directory credentials to connect to the AgilePoint system.
- AgilePointID - Uses the credentials for your AgilePoint SharePoint Impersonator account to connect to the AgilePoint system. Usually the SharePoint Impersonator account is the same as your AgilePoint Service account.
- Default Value:
- Office 365 integration - Office 365
- SharePoint on premises integration - ActiveDirectory
ImpersonatorDomain
- Function:
- The domain name for the SharePoint impersonator account.
You must add this entry if AuthenticationType is set to AgilePoint ID. However, for other authentication types this setting is not required.
- Accepted Values:
- A valid domain name for your AgilePoint SharePoint Impersonator account.
- Default Value:
- None
ImpersonatorUser
- Function:
- The user name for the SharePoint impersonator account.
You must add this entry if AuthenticationType is set to AgilePoint ID. However, for other authentication types this setting is not required.
- Accepted Values:
- A valid user name.
- Default Value:
- None
ImpersonatorPass
- Function:
- The password for the SharePoint impersonator account.. Optionally, you can
select Encrypted to encrypt the value of this
setting.
You must add this entry if AuthenticationType is set to AgilePoint ID. However, for other authentication types this setting is not required.
- Accepted Values:
- A valid password.
- Default Value:
- None
- (Optional) Configure what happens when users click the task name.
Title AP Setting Value OpenTaskByClick - Function:
- Specifies whether to open a task form when the user clicks the task name.
- Accepted Values:
-
- True - Opens the task form.
- False - Does not open the task form
- Default Value:
- True
OpenTasksInNewWindow - Function:
- Specifies whether tasks open in a new browser window or tab, or the same window or tab.
- Accepted Values:
-
- True - Tasks open in a new window or tab.
- False - Tasks open in the same window or tab.
- Default Value:
- True
- (Optional) To show tasks from an external web application, configure the connection.
Title AP Setting Value RemoteWebUrl - Function:
- 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.
- Accepted Values:
- A valid web service URL for your web application.
- Default Value:
- None
- (Optional) Configure menu options or columns to show or hide on the task tabs.
Title AP Setting Value ShowActivityNameInTaskList - Function:
- Specifies whether to show the activity display name or the form name. .
- Accepted Values:
-
- True - Shows the activity display name.
- False - Shows the form name.
- Default Value:
- False
HideContextMenu - Function:
- Specifies if you want to hide menu options for a task in the My Tasks list.
- Accepted Values:
- One or more menu option names, separated by semicolons (;).
- View Process
- Open Task
- Reassign Task
- Task Rework
- Create Linked Task
- Change Priority
- View Description
- Default Value:
- None
- Example:
- View Process;Cancel Process
ShowDueDateColumn - Function:
- Specifies if you want to show the Due Date column for the task in the task tabs.
- Accepted Values:
-
- True - Shows the Due Date column.
- False - Does not show the Due Date column.
- Default Value:
- True
ShowAssignedDateColumnName - Function:
- Specifies if you want to show the date a task was assigned in the task lists tabs.
- Accepted Values:
-
- True - Shows the Assigned Date column.
- False - Does not show the Assigned Date column.
- Default Value:
- True
ShowPriorityColumn - Function:
- Specifies if you want to show the Priority column in the task tabs.
- Accepted Values:
-
- True - Shows the priority column.
- False - Does not show the priority column.
- Default Value:
- True
ShowStatusColumn - Function:
- Specifies if you want to show the task status in the task tabs.
- Accepted Values:
-
- True - Shows the Status column.
- False - Does not show the Status column.
- Default Value:
- True
ProcessStatus - Function:
- Specifies the processes to show in your process lists.
- Accepted 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 - Function:
- Specifies if you want to show the assigned user in the task tabs.
- Accepted Values:
-
- True - Shows the User column.
- False - Does not show the User column.
- Default Value:
- True
ShowDepartmentColumnName - Function:
- Specifies if you want to show the assigned user's department on the task tabs.
- Accepted Values:
-
- True - Shows the Department column.
- False - Does not show the Department column.
- Default Value:
- True
- (Optional) Configure menu options or columns to show or hide on the process tabs.
Title AP Setting Value ShowProcessInstColumn - Function:
- Specifies whether to show the process instance name and drop-down option list on the process tabs.
- Accepted Values:
-
- True - Shows the PROC INST NAME column.
- False - Does not show the PROC INST NAME column.
- Default Value:
- True
ShowStartedDateColumn - Function:
- Specifies whether to show the date the process started on the process tabs.
- Accepted Values:
-
- True - Shows the Started Date column.
- False - Does not show the Started Date column.
- Default Value:
- True
ShowProcessInitiatorName - Function:
- Specifies whether to show the process initiator on the process tabs.
- Accepted Values:
-
- True - Shows the Initiator column.
- False - Does not show the Initiator column.
- Default Value:
- True
ShowProcessNameColumn - Function:
- Specifies whether to show the process model name on the process tabs.
- Accepted Values:
-
- True - Shows the Process Name column.
- False - Does not show the Process Name column.
- Default Value:
- True
FilteredProcess
- Function:
- Limits the processes displayed on the WFAssociation page (where you associate an AgilePoint process with a SharePoint workflow), so that only the specified process models show.
- Accepted Values:
- A semicolon-delimited list of process model names.
- Default Value:
- None
- Example:
MyProcess1;MyProcess2
- (Optional) Configure the names of columns on the AgilePoint task or process lists.
Title AP Setting Value PriorityColumnName - Function:
- Specifies a different name for the Priority column on the task and process tabs.
- Accepted Values:
- One line of text that can have spaces.
- Default Value:
- Priority
ProcessColumnName - Function:
- Specifies a different name for the Process column on the task and process tabs.
- Accepted Values:
- One line of text that can have spaces.
- Default Value:
- Process
StatusColumnName - Function:
- Specifies a different name for the Status column on the task and process tabs.
- Accepted Values:
- One line of text that can have spaces.
- Default Value:
- Status
DueDateColumnName - Function:
- Specifies a different name for the Due Date column on the task tabs.
- Accepted Values:
- One line of text that can have spaces.
- Default Value:
- Due Date
UserIDColumnName - Function:
- Specifies a different name for the User column on the task tabs.
- Accepted Values:
- One line of text that can have spaces.
- Default Value:
- User
ProcessInstColumnName - Function:
- Specifies a different name for the PROC INST NAME column on the task tabs.
- Accepted Values:
- One line of text that can have spaces.
- Default Value:
- PROC INST NAME
SatrtedDateColumnName - Function:
- Specifies a different name for the Started Date column on the process tabs.
- Accepted Values:
- One line of text that can have spaces.
- Default Value:
- Started Date
ProcessInitiatorColumnName - Function:
- Specifies a different name for the Initiator column on the process tabs.
- Accepted Values:
- One line of text that can have spaces.
- Default Value:
- Initiator
AssignedDateColumnName - Function:
- Specifies a different name for the Assigned Date column on the task tabs.
- Accepted Values:
- One line of text that can have spaces.
- Default Value:
- Assigned Date
DepartmentColumnName - Function:
- Specifies a different name for the Department column on the task tabs.
- Accepted Values:
- One line of text that can have spaces.
- Default Value:
- Department
- (Optional) Configure the names of tabs on the AgilePoint App Part or Web Part.
Title AP Setting Value HeaderOverview - Function:
- Specifies a different name for the Overview tab on the AgilePoint Dashboard.
- Accepted Values:
- One line of text that can have spaces.
- Default Value:
- Overview
HeaderMyTask - Function:
- Specifies a different name for the My Tasks tab on the AgilePoint Dashboard.
- Accepted Values:
- One line of text that can have spaces.
- Default Value:
- My Tasks
HeaderInQueue - Function:
- Specifies a different name for the In Queue tab on the AgilePoint Dashboard.
- Accepted Values:
- One line of text that can have spaces.
- Default Value:
- In Queue
HeaderProcessStarted - Function:
- Specifies a different name for the Processes I Started tab on the AgilePoint Dashboard.
- Accepted Values:
- One line of text that can have spaces.
- Default Value:
- Processes I Started
HeaderProcessIWorked - Function:
- Specifies a different name for the Process I've Worked tab on the AgilePoint Dashboard.
- Accepted Values:
- One line of text that can have spaces.
- Default Value:
- Processes I've Worked
HeaderMyAPP - Function:
- Specifies a different name for the My Apps tab on the AgilePoint Dashboard.
- Accepted Values:
- One line of text that can have spaces.
- Default Value:
- My Apps
- (Optional) Configure the items that show on a page.
Title AP Setting Value ItemPerPage - Function:
- Specifies the number of items to show on one page in the AgilePoint task and process lists.
- Accepted Values:
- An integer.
- Default Value:
- 10
ChartItemPerPage RowCount - Function:
- Specifies the number of rows to show on one page in the AgilePoint Dashboard.
- Accepted Values:
- An integer.
- Default Value:
- 10
- (Optional) Configure colors for the tasks tabs.
Title AP Setting Value ShowPoolTaskInColor - Function:
- Specifies if the AgilePoint task lists show tasks assigned to a participant pool in a different color than tasks assigned to one participant.
- Accepted Values:
-
- True - Shows pool tasks and tasks assigned to a single participant in different colors.
- False - Show the pool tasks and tasks assigned to a single participant in the same color.
- Default Value:
- False
ColorForPoolTask - Function:
- Specifies the background color for tasks that are assigned to a pool.
This setting is applicable only if ShowPoolTaskInColor is set to True.
- Accepted Values:
- The color you want.
- Default Value:
- LightYellow
ShowOverdueTaskInColor - Function:
- Specifies if the AgilePoint Dashboard shows overdue tasks in a different color.
- Accepted Values:
-
- True - Shows the overdue task in color.
- False - Does not show the overdue task in color.
- Default Value:
- False
ColorForOverdueTasks - Function:
- Specifies the color for overdue tasks.
This setting is applicable only if ShowOverdueTaskInColor is set to True.
- Accepted Values:
- The color you want.
- Default Value:
- Red
