Access Token for Microsoft Cognitive Services

Examples

• (Example) How to Get the Access Token Credentials from Microsoft Cognitive Services

Prerequisites

• One of these account types:
  • Microsoft Azure Business
  • Microsoft Azure Enterprise
  • Microsoft Azure Personal

Good to Know

• In most cases, you can use a global access token or an app level access token:
  • Global access tokens are shared across all users and apps. If you want all process designers and runtime app users in your AgilePoint NX tenant to be able to connect to an external data source, use a global access token. An example is a SharePoint site on an intranet that all employees in a company can access.
  • Application level access tokens are shared with all processes in a process-based app, or restricted to use within a form-based app. Use application level access tokens if only process designers or runtime app users for a particular application should access an external system — for example, a Box account that is only used to share files within a small team.
• Access tokens are collections of credentials that are used to authenticate communication directly between AgilePoint NX and an external system. Because it is the AgilePoint NX system that uses these credentials, rather than an app, there is no difference between design time and runtime access tokens. Access tokens are never checked in or published, and they do not use version control. If you change an access token in the App Builder or Manage Center, the access token changes immediately everywhere the access token is used. Changes to app level access tokens apply to all versions of an app, including running application instances. Changes to global access tokens apply everywhere they are used in AgilePoint NX. You can not roll back an access token to a previous version.

  For more information, refer to What Data Is Deleted When I Delete an App or Application Resource?

• OAuth 2.0 access tokens require a 2-way exchange of credentials between AgilePoint NX and the external service. This means that you must get the credentials from the third-party service to paste in the AgilePoint NX access token, and get the redirect URI from AgilePoint NX to paste in the external service. This requires you to open both the AgilePoint NX access token and the third-party service at the same time, so you can copy and paste from one screen to the other.

  This topic shows the suggested procedure for Microsoft Cognitive Services. The exact procedure for your access token depends on whether you already have a connection (usually called an app) configured in the external service.

  (Example) How to Get the Access Token Credentials from Microsoft Cognitive Services.

• This screen may look different in different places. The UI varies for this screen depending upon how you open it. However, the fields for this screen are the same in all places.
• Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Global (Manage Center)

You can use a global access token in any app in your AgilePoint NX tenant. Use a global access token if you want any user in your environment to be able to connect to the same external system.

1. Click Manage.

   
   
   

2. Click App Builder > Global Access Tokens.

   
   
   

3. On the Global Access Tokens screen, click Add Token.

   
   
   

4. On the Add Global Access Tokens screen, select MS Cognitive Services.

   
   
   

5. Click Next.

App Level (Process-Based App, Modern Add an App Experience)

Create an access token to use in any process activity or form control in a process-based app you create in the Modern Add an App Experience.

1. In App Builder, in the Modern Add an App Experience, create a process-based app.

   For more information, refer to:

   • Process-Based App with an Existing Entity in AgilePoint NX Data Entities as the Data Source (Modern)
   • Process-Based App with Database as the Data Source (Modern)
   • Process-Based App with Salesforce as the Data Source (Modern)
   • Process-Based App with SharePoint as the Data Source (Modern)
   • Process-Based App with Microsoft Excel Table as the Data Source (Modern)
2. On the Anything else right now? screen, in the Access Tokens field, click Create.

   
   
   

3. On the What service do you want your app to access? screen, select MS Cognitive Services.

   
   
   

4. Click Next.

App Level (Form-Based App, Modern Add an App Experience)

Create an access token to use in any form control in a form-based app you create in the Modern Add an App Experience.

1. In App Builder, in the Modern Add an App Experience, create a form-based app.

   For more information, refer to:

   • Form-Based App with an Existing AgilePoint Data Entity as the Data Source (Modern)
   • Form-Based App with a Database as the Data Source (Modern)
   • Form-Based App with Salesforce as the Data Source (Modern)
   • Form-Based App with SharePoint as the Data Source (Modern)
   • Form-Based App with Microsoft Excel as the Data Source (Modern)
2. On the Anything else right now? screen, in the Access Tokens field, click Create.

   
   
   

3. On the What service do you want your app to access? screen, select MS Cognitive Services.

   
   
   

4. Click Next.

App Level (App Explorer)

Create an access token to use in any process activity or form control in a specified app.

1. Click App Builder.

   
   
   

2. In the Application Explorer, on the My Apps pane, click [App Name] > Shared Resources > Access Tokens.

   
   
   

3. Click New.

   
   
   

4. On the New Access Token screen, select MS Cognitive Services.

   
   
   

5. Click Next.

Process Activities and Form Controls

Different access token types can be created in context and used in different process activities, form controls, or apps. The App Builder shows shortcut buttons in any place you can create an access token.

You can create an app level access token for MS Cognitive Services here:

• Process Builder
  • Any activity on the MS Cognitive Services tab