Access Token for Web Service

Configure an access token to connect to a web service.

Figure: Web Service Access Token Configuration screen

Web Service Access Token Configuration screen

Background and Setup

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.
  • 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 application level access tokens apply to all versions of an application, 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?.

  • Documentation for Integrations with Third-Party, External, or Open Source Technologies

    For examples of use case implementations or configuration field input values for third-party products, AgilePoint recommends these resources.For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

    • 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 web service.
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:

Service URL

Function:
Specifies the URL of your web service.
Accepted Values:
A valid web service URL.
Default Value:
None
Accepts Process Data Variables:
No

Credentials

Function:
Lets you enter authentication credentials.
Accepted Values:
  • Selected - The domain, username, and password fields are enabled.
  • Deselected - The domain, username, and password fields are disabled.
Default Value:
Deselected

Domain

Function:
The authentication domain for the web service.
To Open this Field:
  1. Click Credentials.
Accepted Values:
A valid domain.
Default Value:
None

User Name

Function:
Specifies the user name for the web service.
To Open this Field:
  1. Click Credentials.
Accepted Values:
A valid user name.
Default Value:
None

Password

Function:
The password for the authentication account.
To Open this Field:
  1. Click Credentials.
Accepted Values:
An alphanumeric string that represents a password.
Default Value:
None

Client Certificates

Function:
Manages the client certificate for web service authentication.
Accepted Values:
  • Selected - Manages client certificates for web service authentication..
  • Deselected - Does not manage client certificates for web service authentication.
Default Value:
Deselected

Add Certificates

Function:
Adds a certificate file from your machine. Browse to find the necessary file.
To Open this Field:
  1. Select Client Certificates.

Issued By

Function:
Specifies the name of the issuer of the certificate - the certificate issuing authority.
To Open this Field:
  1. Select Client Certificates.
Accepted Values:
Read only.

The values show when you add a client certificate.

Issued To

Function:
Specifies the domain name the certificate has been issued.
To Open this Field:
  1. Select Client Certificates.
Accepted Values:
Read only.

The values show when you add a client certificate.

Verified

Function:
Specifies whether the client certificate is validated:
  • Selected - The client certificate is validated.
  • Deselected - The client certificate is not validated.
To Open this Field:
  1. Select Client Certificates.
Accepted Values:
Read only.

The values show when you add a client certificate.

Remove

Function:
Deletes the selected row from the Client Certificates list.

Add SOAP Header

Function:
Determines whether other SOAP headers are to be added.
Accepted Values:
  • Deselected - Other SOAP headers are not added.
  • Selected - Other SOAP headers are added.

    When you select the option, the text box becomes available allowing you to specify the required SOAP headers.

Default Value:
Deselected

Test Connection

Function:
Makes sure the specified web service account is 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 PrivateCloud 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.