Install and Configure the AgilePoint Intelligent Process Automation App for Microsoft 365

To install and configure the AgilePoint Intelligent Process Automation app for Microsoft 365, do the procedure in this topic.

Background and Setup

Examples

Prerequisites

  • The AgilePoint Intelligent Process Automation app.
  • SharePoint for Microsoft 365.
  • AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v9.0 Software Update 1 or higher.
  • To add the AgilePoint Intelligent Process Automation app to a site collection, you must be signed in to SharePoint as a Global Administrator.
  • To add the AgilePoint Work Center web part to a SharePoint site, you must be signed in to SharePoint as a Site Collection Administrator.
  • The AgilePoint Work Center web part requires the following permissions to run:
    • Create or delete document libraries or lists in the site collection.
    • Full control of the site.
    • Share permissions with other users.
    • Access basic information about site users.
  • In SharePoint for Microsoft 365, the web part does not support the Safari web browser.
  • This Documentation is for Modern Work Center in SharePoint for Microsoft 365. For information about earlier versions of the SharePoint app, refer to Microsoft 365 SharePoint Integration for AgilePoint NX v8.0.

Good to Know

  • The AgilePoint Work Center web part for SharePoint can be added to a SharePoint web part page or wiki page in any supported version of SharePoint. The AgilePoint Work Center web part can be added to modern pages in SharePoint for Microsoft 365, but not in on-premises SharePoint.
  • The AgilePoint Work Center web part communicates with one or more servers — for example, AgilePoint, SharePoint, and/or database servers — whenever they are viewed or refreshed. This interaction is necessary and unavoidable in most cases, and is part of the AgilePoint system's expected usage patterns.
  • In some environments, the location in which the AgilePoint Work Center web part is placed may have unintended effects on the system's performance. For example, in an environment where there are many thousands of SharePoint users, but only a fraction of those users interact with AgilePoint, placing the AgilePoint Work Center web part on an entry or top level site page that is frequently accessed by the entire group of SharePoint users may place additional unnecessary load on the AgilePoint system when the page is accessed by users that don't need access to the web part.

    In this situation, it can be better to place the web part on a sub site location that is only accessed by a more appropriate group of AgilePoint users or that is only accessed when necessary.

Step 1: (Optional) Enable the Microsoft Entra ID for AgilePoint NX

To enable the Microsoft Entra ID account authentication for AgilePoint NX, do the procedure in this topic.

Prerequisites

Good to Know

Procedure

  1. Click Settings.

    Settings
  2. Click Administration.

    Click Administration
  3. On the Adminstration screen, in the Supported Authentications section, click Microsoft Entra ID.

    Click Microsoft Entra ID
  4. On the information screen, click Ok.

    Click Ok
  5. On the Sign in screen, enter the Microsoft account credentials.

    Enter Email Address
  6. In the Enter Password field, enter the password.

    Enter Password screen
  7. On the Permission Requested screen, click Accept

    Click Accept
  8. On the Pick an account screen, select the signed in account.

    Select Account
  9. On the Permissions requested screen, click Next

    Click Next
  10. Click Accept.

    Click Accept

    The Microsoft Entra ID authentication is enabled.


    Click Accept

Step 2: Sign In to AgilePoint NX with Microsoft Entra ID

To sign in to AgilePoint NX with a Microsoft Entra ID account, do the procedure in this topic.

Prerequisites

How to Start

  1. Click https://login.nxone.com/login.

Procedure

  1. On the Welcome back screen, click Sign In with Microsoft Entra ID.

    AgilePoint Sign In with Salesforce screen
  2. On the Pick an account screen, select the Microsoft Entra ID account.

    Select Account

    AgilePoint NX Portal opens with the Microsoft Entra ID account.


    AgilePoint NX Portal Open

Step 3: Add the AgilePoint Intelligent Process Automation App to Your SharePoint Site Collection

To add the AgilePoint Intelligent Process Automation app to your SharePoint site in Microsoft 365, ​do the procedure in this topic.

Prerequisites

  • To add the AgilePoint Intelligent Process Automation app to a site collection, you must be signed in to SharePoint as a Global Administrator.

How to Start

  1. In SharePoint for Microsoft 365, open the SharePoint site where you want to add the AgilePoint Intelligent Process Automation app.

    Open SharePoint Site

Procedure

  1. On the SharePoint site, click Settings > Add an app.

    Click Add an app
  2. On the My Apps screen, click Find more apps in SharePoint Store.

    Click Find more apps in SharePoint Store
  3. On the SharePoint Store screen, in the search box, enter AgilePoint.

    Enter AgilePoint
  4. Click AgilePoint Intelligent Process Automation.

    Click AgilePoint Intelligent Process Automation
  5. On the AgilePoint Intelligent Process Automation app, click Add to Apps site.

    Click Add to Apps site
  6. On the Confirm data access screen, select Enable this app and add it to all sites.

    Select Enable this app and add it to all sites
  7. Click Add.

    Click Add
  8. On the App requires permissions approval screen, click OK.

    Click Add
  9. On the AgilePoint Intelligent Process Automation app, in the top-left, click App launcher.

    Click App launcher
  10. Click Admin.

    Click Admin

    The Microsoft 365 admin center screen opens in a new tab.

  11. On the Microsoft 365 admin center screen, click Show all.

    Click Show all
  12. Click SharePoint.

    Click SharePoint

    The SharePoint admin center screen opens in a new tab.

  13. On the SharePoint admin center screen, click Advanced > API access.

    Click API Access
  14. On the API access screen, in the Pending requests section, select AgilePoint NX.

    Select AgilePoint NX
  15. Click Approve.

    Click Approve
  16. On the Approve access screen, click Approve.

    Click Approve screen
    The API access screen shows the AgilePoint NX API in the Approved requests section.

    API access screen

Step 4: Create an Access Token for SharePoint

To connect the AgilePoint Intelligent Process Automation app to AgilePoint NX, an access token is required. You must create an access token for SharePoint.

Prerequisites

Good to Know

Figure: SharePoint Access Token Configuration screen

SharePoint Access Token Configuration screen

Step 5: Add the AgilePoint Configuration List to the SharePoint Site

To add the SharePoint site to AgilePoint NX, ​do the procedure in this topic. When you add the SharePoint site, it creates the AgilePoint Configuration List on your SharePoint site.

Good to Know

  • You can add the AgilePoint Work Center web part to a SharePoint site before or after you add the Configuration List in AgilePoint NX. However, the web part will not work until the Configuration List is added to the site in AgilePoint NX. It is recommended to add the Configuration List first, but this is not required.

How to Start

  1. Click Settings.

    Settings
  2. Click SharePoint Online App.

    Click SharePoint Online App

Procedure

  1. On the SharePoint Online Sites screen, click Add.

    Click Add
  2. On the Site Configuration screen, in the Site URL field, enter the URL for the SharePoint site that uses the AgilePoint Intelligent Process Automation app.

    Enter Site URL
  3. In the Access Tokens field, select the access token you created to connect the AgilePoint Intelligent Process Automation app to AgilePoint NX.

    For more information, refer to Step 2: Create an Access Token for SharePoint.


    Select Access Token
  4. Click Validate.

    Click Validate

    If there are no errors in the connection, the message Access token validated successfully shows.

  5. Click Add.

    Site Configuration screen Click Add button
    The SharePoint Online Sites screen shows the SharePoint site.

    Updated Online Sites screen

Step 6: (Optional) Configure the AgilePoint Configuration List

When you add the SharePoint site to AgilePoint NX, a new SharePoint list is created called the AgilePoint Configuration List, which configures the settings for the AgilePoint Intelligent Process Automation app for Microsoft 365.

To configure the AgilePoint Configuration List, refer to AgilePoint Configuration List for SharePoint (Microsoft 365, Modern).

Good to Know

Step 7: Add the AgilePoint Work Center Web Part To The SharePoint Site

To add the AgilePoint Work Center web part to the SharePoint site, ​do the procedure in this topic.

Prerequisites

  • To add the AgilePoint Work Center web part to a SharePoint site, you must be signed in to SharePoint as a Site Collection Administrator.

How to Start

  1. In SharePoint for Microsoft 365, open the SharePoint site where you want to add the web part.

    Open SharePoint Site

Procedure

  1. On the SharePoint site, click New > Page.

    Click Add New Page
  2. On the Page templates, click Apps.

    Click Apps
  3. Click AgilePoint Work Center.

    Click AgilePoint Work Center
  4. Click Create Page.

    Click Create Page
  5. On the App page details screen, in the Title field, enter the name for the SharePoint web page.

    Click Create Page
  6. Click Save.

    Click Save

    The SharePoint site shows the AgilePoint Work Center web part.


    Shows AgilePoint Nx Portal

Step 8: (Optional) Associate a Workflow with an AgilePoint NX App (Process-Based App)

To use a process-based app in SharePoint, you must associate the app with a SharePoint list. To associate the app with a SharePoint list, do the procedure in this topic.

Examples

Good to Know

How to Start

  1. In SharePoint for Microsoft 365, open the SharePoint site to associate a process-based app with a SharePoint list.

    Open SharePoint Site
  2. In the left pane, click Documents.

    Click Documents
  3. On the Documents tab, click AgilePoint.

    Click AgilePoint

Procedure

  1. On the Manage Workflow and eForm Associations screen, in Workflow Association, click Add New Workflow Association Add New Workflow Association Icon.

    Click Add
  2. In the Workflow Status Column Name field, enter the name of the SharePoint workflow to create on your site.

    SharePoint uses this workflow to connect the AgilePoint NX app to the associated SharePoint list.


    Entry Column Name
  3. In the Start Option section, select the events in the SharePoint list that will to start an instance of the AgilePoint NX app.
    • Creating a new item will start this workflow
    • Changing an item will start this workflow
    .

    Select Start Option
  4. In the AgilePoint Process Model field, select a process model from the list.

    Select Process Model
  5. In the AgilePoint Process Model Version field, select the process model version to use for your SharePoint workflow.

    Select Process Model Version
  6. Click Submit.

    The Manage Workflow and eForm Associations screen shows a confirmation message.


    Show Associate Workflow

Step 9: (Optional) Associate a Workflow with an AgilePoint NX App (Form-Based App)

To use a form-based app in SharePoint, you must associate the app with a SharePoint list. To associate the app with a SharePoint list, do the procedure in this topic.

Prerequisites

  • A SharePoint list.

Examples

Good to Know

How to Start

  1. In SharePoint for Microsoft 365, open the SharePoint list to associate a form-based app.

    Click Documents
  2. On the SharePoint list, click AgilePoint.

    Click AgilePoint

Procedure

  1. On the Manage Workflow and eForm Associations screen, in ListForm Association, click Add New Listflow Association Add New Listflow Association Icon.

    Click Add
  2. In the Content Type field, select the content type for the SharePoint list to organize, manage, and control the content across your SharePoint sites.

    Select Content Type
  3. In the AgilePoint Form-Based App field, select the form-based app to associate with the SharePoint list and use in place of the default SharePoint list form.

    Select Form Based App
    When you select the form-based app in the Agilepoint eForms App field, these fields are populated with these read-only values:
    • The New Item Form Page field shows with the New form associated with the form-based app that replaces the default SharePoint list form to create a new list item.
    • The Edit Item Form Page field shows with the Update form associated with the form-based app that replaces the default, editable SharePoint list form.
    • The Display Item Form Page field shows with the View form associated with the form-based app that replaces the default SharePoint list form.

    These Field Shows
  4. Click Submit.

    The Manage Workflow and eForm Associations screen shows a confirmation message.


    Show Associate eForms