Access Token for OData

Configure an access token to connect to an OData service.

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 the OData service.
Accepted Values:
A text string that can include letters, numbers, and spaces
Default Value:
None

Description

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

Root Service URL

Function:
Specifies the root URL of your OData service.
Accepted Values:
An alphanumeric string in URL format.
Default Value:
None
Accepts Process Data Variables:
No

Request Headers

Function:
Specifies custom headers, if necessary, for your OData service.

Request headers contain application-specific information in the SOAP header. Request headers are usually used to give security information, such as authentication credentials.

Accepted Values:
  • Header
  • Value

Use the Add Header button to add the Header and Value for the OData.

Default Value:
None

Add Header

Function:
Adds the row for Header and Value fields.

Update

Function:
Changes the information in the Header and Value fields.

Cancel

Function:
Deletes the row with Header and Value fields.

Test Connection

Function:
Makes sure the specified OData service account 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