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

Prerequisites

  • The AgilePoint Intelligent Process Automation app.
  • SharePoint for Microsoft 365.
  • 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 Classic Work Center, 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: 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.

Procedure

  1. Click SharePoint Store in the left pane menu.
  2. In the search box, enter AgilePoint.
  3. Click the AgilePoint Intelligent Process Automation app.
  4. On the Enable app screen, select Enable this app and add it to all sites.

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

    Click Enable app
  6. On the Approve access so this app works as designed screen, click Go to API access page.

    Click Go to API access page
  7. On the API access screen, in the Pending requests section, select AgilePoint NX.

    Select AgilePoint NX
  8. Click Approve.

    Click Approve
  9. 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 2: 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

  • The authentication credentials for the SharePoint access token must have Site Collection Administrator or Full Control privileges.

Good to Know

Figure: SharePoint Access Token Configuration screen

SharePoint Access Token Configuration screen

Step 3: 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. Sign in with an AgilePoint NX account that has the Administrators role.
  2. Click Settings.

    Settings
  3. 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 5: 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 Edit.

    Click Edit
  2. Click Add a new section.

    Click Add New Section
  3. Click One Column.

    Click Add One Column
  4. Click Add a new web part in column one.

    Click Add New Web Part
  5. In the web parts list, click AgilePoint Work Center.

    Click AgilePoint Work Center
  6. Click Republish.

    Click Republish

    The SharePoint site shows the AgilePoint Work Center web part.


    Shows AgilePoint Nx Portal

Step 6: (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.

Good to Know

How to Start

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

    For more information, refer to Step 5: Add the AgilePoint Work Center Web Part To The SharePoint Site.


    Shows AgilePoint Nx Portal
  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 eForms Associations screen shows the associated workflows.


    Show Associate Workflow

Step 7: (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.

Good to Know

How to Start

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

    For more information, refer to Step 5: Add the AgilePoint Work Center Web Part To The SharePoint Site.


    Shows AgilePoint Nx Portal
  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 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 Create 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 the associated eforms.


    Show Associate eForms