Access Token for MongoDB

Configure an access token to connect to MongoDB.

Figure: MongoDB Access Token Configuration screen

MongoDB Access Token Configuration screen

Background and Setup

Prerequisites

Good to Know

  • In most cases, you can use a global access token or an application level access token:
    • Global access tokens are shared across all users and applications. If you want all process designers and form 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 form users for a particular application should access an external system — for example, a Google Drive account that is only used to share files within a small team.
  • Documentation for Integrations with Third-Party, External, or Open Source Technologies

    The highest priority for AgilePoint NX Product Documentation is accuracy. Whenever feasible, AgilePoint provides input details, business rules, or example values for third-party integrations. These can include any technology that is not native to AgilePoint NX, such as Salesforce, Active Directory, or REST. However this information is subject to change without notice to AgilePoint. Because we can not guarantee the accuracy of this information, the details provided for third-party product input values, as well as examples for third-party product integrations, are limited in the AgilePoint documentation. It is the responsibility of third-party vendors to provide documentation related to these aspects of their software and services.

    For examples of use case implementations or configuration field input values for third-party products, AgilePoint recommends these resources:

    • AgilePoint Community Forums - An AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
    • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
    • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.
    • Third-Party Vendor Documentation - Whenever feasible, AgilePoint provides links to third-party vendor documentation.

      This does not include technology standards or protocols, such as JavaScript, REST, or FTP. Resources for these technical standards are publicly available on the Internet.

Fields

Field Name Definition

Token Name

Function:
Specifies the unique name for your connection to MongoDB.
Accepted Values:
A text string that can have letters, numbers, and spaces
Default Value:
None

Description

Function:
A description for your access token.
Accepted Values:
More than one line of text.
Default Value:
None
Example:
Refer to:

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 MongoDBs.
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:
  1. 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:
  1. 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:
  1. 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