AgilePoint Configuration List for SharePoint (On-Premises)

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 for SharePoint on-premises, 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.
  • 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 On-premises SharePoint, on the SharePoint site, click Site contents.
  2. On the Site contents screen, click AgilePoint Configuration.
  3. On the AgilePoint Configuration list, click New Item.
  4. In the Title field, enter the title of the configuration list item to create.
  5. In the AP Setting Value field, enter the value of the configuration list item to create.
  6. (Optional) In the Description field, enter a description or comments.

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

HostingMechanism
Description:
Specifies your AgilePoint installation type.
Allowed Values:
  • WCF –  A Windows service installation.
Default Value:
None

HostingType
Description:
Specifies your AgilePoint hosting type.
Allowed Values:
  • OnDemand – Connect to AgilePoint NX in a public cloud environment.
  • OnPremises – Connect to AgilePoint BPMS in an on-premises environment.
  • Private Cloud – Connect to AgilePoint NX in a private cloud environment.
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

ImpersonatorDomain
Description:
The domain name for the SharePoint impersonator account.
Allowed Values:
A valid domain name for your AgilePoint SharePoint Impersonator account.
Default Value:
None

ImpersonatorUser
Description:
The user name for the SharePoint impersonator account.
Allowed Values:
A valid user name.
Default Value:
None

ImpersonatorPass
Description:
The password for the SharePoint impersonator account..

You must select Encrypted to True to encrypt the value of this setting if you are using AgilePoint NX OnPremises or AgilePoint NX PrivateCloud, and your AgilePoint Server instance is configured to use HTTP or HTTPS.

Allowed Values:
An alphanumeric string that represents a password.
Default Value:
None

Active Directory Authentication Configuration

Configures the JSON Web Token (JWT) for Active Directory authentication in SharePoint Integration.

Fields

Field NameDefinition

UseADJWTToken
Description:
Specifies whether to use JSON Web Token (JWT) for Active Directory authentication to call AgilePoint REST API from SharePoint Dashboard Web Part, workflow status page, and form rendering within SharePoint.
Allowed Values:
  • True - Uses JWT authentication for Active Directory.
  • False - Uses basic authentication for Active Directory.
Default Value:
False
Limitations:

The UseADJWTToken is available in these releases:

AudienceUrl
Description:
Specifies the audience that you configured for the key ADAuthToJwt_AllowedAudiences in the file Ascentn.AgilePoint.WCFService.exe.config for the JSON Web Token (JWT).
Allowed Values:
The value of the key ADAuthToJwt_AllowedAudiences from the file Ascentn.AgilePoint.WCFService.exe.config.

For more information, refer to Enable Active Directory JWT Authentication.

Default Value:
None
Example:
  • https://mynxportal:443
Limitations:

The AudienceUrl is available in these releases:

SharePoint Integration Log

Configures the SharePoint Integration logs.

For more information, refer to Where Are the AgilePoint NX OnPremises Logs?.

Fields

Field NameDefinition

Log
Description:
Gives the location of the SharePoint Integration log file.
Allowed Values:
A valid location for the log file.

You can give an FTP location if the impersonator user has write permission on the FTP server.

Default Value:
None
Example:
  • C:\NewSPLog
  • ftp://myserver/AgilePontSharePoint/Log

LogSwitch
Description:
Configures your log options.
Allowed Values:
  • All - Writes all messages in the log.
  • Info - Writes information messages in the log.
  • Debug - Writes all messages in the log.
  • Error - Writes error message in the logs.
  • None - Does not write any messages in the log.

You can give multiple options separate by a commas (,).

Default Value:
All
Example:

Debug, Error, Info

Classic Work Center Configuration

Configuration keys that apply only to Classic Work Center.

Fields

Field NameDefinition

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

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

OpenTasksInFullScreen
Description:
Specifies whether SharePoint List Form tasks that are opened from the Task List Web Part in a new window are opened in full screen mode, or in a smaller window.

If OpenTasksInFullScreen is set to False, this setting has no effect.

Allowed Values:
  • True - Tasks open in full screen mode.
  • False - Tasks open in a smaller window.
Default Value:
True
CheckConcurrentAccess
Description:
If more than one person opens the same InfoPath form at the same time, SharePoint allows the first participant who submits the form to submit his or her changes. However, the second submitter receives the following error message:

Your changes conflict with those made concurrently by another user. Your form would be reloaded. If you want your changes to be applied, resubmit your changes after filling the form.

Allowed Values:
  • True - Checks for concurrency.
  • False - Does not check for concurrency.
Default Value:
True

Workflow Association Configuration

Configures the AgilePoint Configuration List item for apps that start based on actions in SharePoint lists or emails, such as adding a document or creating a list item.

Fields

Field NameDefinition

AdminBindingUsed
Description:
Specifies the type of binding used to connect to AgilePoint for administration.
Allowed Values:
  • WS HTTP - WSHttpBinding_IWCFAdminService
  • Basic HTTP - BasicHttpBinding_IWCFAdminService
  • TCP -  NetTcpBinding_IWCFAdminService
Default Value:
TCP

WorkflowBindingUsed
Description:
Specifies the type of binding that is used to connect to AgilePoint to send and receive workflow, or process, information.
Allowed Values:
  • WS HTTP - WSHttpBinding_IWCFWorkflowService
  • Basic HTTP - BasicHttpBinding_IWCFWorkflowService
  • TCP -  NetTcpBinding_IWCFWorkflowService
Default Value:
TCP

TakeAssignment
Description:
This setting enables a process participant to complete a task from an e-mail without taking assignment first. The participant simply clicks the e-mail link to complete the task, even though the task is assigned to an AgilePoint group. This has the same effect as the Take Assignment and Complete action in the Task List Web Part.
Allowed Values:
  • True - A process participant can complete the task from an e-mail without taking assignment.
  • False - A process participant must take assignment for a task before he can complete it.
Default Value:
False
FilteredProcess
Description:
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.
Allowed Values:
A semicolon-delimited list of process model names.
Default Value:
None
Example:
MyProcess1;MyProcess2

CheckFileUpload
Description:
This setting helps to deal with a SharePoint issue: If a SharePoint document library is set up to automatically start an AgilePoint process when a document is uploaded, it is possible to receive an error similar to the following: "The file xxx has been modified by SHAREPOINT\system on xxx." This error is caused by a race condition where the process attempts to start before the document upload is complete.

This setting determines whether SharePoint waits to confirm that SharePoint metadata has been added to the file before starting the process.

Allowed Values:
  • True - SharePoint waits to confirm the metadata before starting the process.
  • False - SharePoint does not wait to confirm the metadata before starting the process.
Default Value:
True

ExcludeLibraryFromFileUploadCheck
Description:
Enables you to specify exceptions to CheckFileUpload=True. In other words, it enables you to effectively set CheckFileUpload=False only on a specified list of document libraries.
Allowed Values:
A semicolon (;) delimited list of URLs for the documentation libraries that you do not want to wait to confirm metadata before starting the process.
Default Value:
None