Access Token for MongoDB

Configure an access token to connect to MongoDB.

Figure: MongoDB Access Token Configuration screen

Background and Setup

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX Private Cloud or AgilePoint NX OnPremises v7.0 or higher.

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?
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?

How to Start

There are several ways to create an access token for MongoDB. How to create the access token depends on where you want to use it.

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.

Click Manage.
Click App Builder > Global Access Tokens.
On the Global Access Tokens screen, click Add Token.
On the Add Global Access Tokens screen, select MongoDB.
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.

In App Builder, in the Modern Add an App Experience, create a process-based app.
For more information, refer to:
On the Anything else right now? screen, in the Access Tokens field, click Create.
On the What service do you want your app to access? screen, select MongoDB.
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.

In App Builder, in the Modern Add an App Experience, create a form-based app.
For more information, refer to:
On the Anything else right now? screen, in the Access Tokens field, click Create.
On the What service do you want your app to access? screen, select MongoDB.
Click Next.

App Level (App Explorer)

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

Click App Builder.
In the Application Explorer, on the My Apps pane, click [App Name] > Shared Resources > Access Tokens.
Click New.
On the New Access Token screen, select MongoDB.
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 MongoDB here:

Process Builder
- Any activity on the MongoDB tab

Fields

Field Name	Definition
Token Name	Function: Specifies the unique name for your connection to MongoDB. Accepted Values: One line of text (a string). Accepted: Letters Numbers Spaces Default Value: None Example: This is a common configuration field that is used in many examples. Refer to: Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.
Description	Function: A description for your access token. Accepted Values: More than one line of text. Default Value: None Example: This is a common configuration field that is used in many examples. Refer to: Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.
Hostname	Function: Specifies the host name of the machine where the MongoDB instance runs. Accepted Values: A valid host name of your MongoDB. Default Value: None
Port	Function: Specifies the port number for MongoDB. Accepted Values: A valid port number. Default Value: None
Authentication	Function: Specifies the authentication type for MongoDB. Accepted Values: None - Connects to MongoDB that runs on your local machine without authentication. UserName/Password - Connects to MongoDB that runs on your local machine or MongoDB Atlas (cloud) with authentication credentials. Default Value: Authentication
User Name	Function: The user name for your MongoDB credentials. To Open this Field: In the Authentication list, select UserName/Password. Accepted Values: A valid user name. Default Value: None
Password	Function: The password for the authentication account. To Open this Field: In the Authentication list, select UserName/Password. Accepted Values: An alphanumeric string that represents a password. Default Value: None
Authentication Database	Function: Specifies the name of the MongoDB database to which to authenticate. To Open this Field: In the Authentication list, select UserName/Password. Accepted Values: A valid MongoDB database name. Default Value: None
Replica Set Name	Function: Specifies the name of the MongoDB replica set to which to connect. Accepted Values: The name of the replica set you created in MongoDB that accepts an alphanumeric string with no spaces or special characters. Default Value: None Example: Cluster0-shard-0
Read Preference	Function: Specifies how MongoDB Compass directs read operations to the members of a replica set. For more information, refer to Read Preference documentation from MongoDB. Accepted Values: Primary - All operations read from the primary members of the current replica set. Primary Preferred - Operations read from primary members but if no primary members are available, operations read from secondary members. Secondary - All operations read from the secondary members of the replica set. Secondary Preferred - Operations read from secondary members but if no secondary members are available, operations read from the primary. Nearest - Operations read from member of the replica set with the least network latency, irrespective of the member's type. Default Value: Primary
Use System CA / Atlas Deployment	Function: Specifies to connect to MongoDB that runs on MongoDB Atlas (cloud). Accepted Values: Selected - Connects to MongoDB Atlas. Deselected - Connects to MongoDB that runs on the localhost. Default Value: Deselected
Test Connection	Function: Makes sure the specified MongoDB credentials are correct.
Encrypt	Function: Stores the access token in the AgilePoint database as encrypted data. Note: AgilePoint recommends you to store this access token in the database in encrypted format. Accepted Values: Deselected - The access token is in plain text in the database. Selected - The access token is encrypted in the database. Default Value: Selected Limitations: This field was removed from the UI in AgilePoint NX OnPremises and Private Cloud v7.0 Software Update 2. Access token credentials are encrypted by default. If you want to store credentials in unencrypted format, contact AgilePoint Customer Support.