Data architects use the Settings tab to apply systemwide settings and manage API tokens for external business intelligence systems and applications.

Default Report

The default report appears when a user opens the dashboard for the first time. The default report continues to appear until the user selects their own default report.

Fiscal Year

The month that starts the fiscal year is used in formulas to calculate the financial data in dashboard reports and forms.

API Tokens

API tokens provide access to your dashboard data from external business intelligence systems and applications. When you create an API token in Engage, your business intelligence system or application can include your dashboard data, along with data from other internal groups and systems, for a consolidated big-picture view of your organization's overall status.

Only data architects can create and revoke API tokens. However, anyone with a token has access to all dashboard data. Therefore, you should treat API tokens like you would a password.

Create a token

To create a token, complete the following steps.
  1. Click the Settings tab.
  2. (Optional) Set an expiration date for the token. Choose a date between tomorrow and 1 year from today.
    Note

    If you do not set an expiration date, the token will expire 1 year from the date it is created. All data architects receive an email notification 7 days prior to the token's expiration date and again after the token expires.

  3. Under API Tokens, click Add New Token.
  4. In the Success! Token Created dialog box, click Copy Password. This is your one and only chance to copy the password.
  5. After you receive confirmation that the password was copied to the clipboard, click Close. All data architects receive an email notification that the token was created.
  6. Make note of or copy the API URL. You will need this URL to set up the external system or application to pull data from Engage.
    Note

    To ensure that the API URL can be referenced without issue, any special character, such as #$%^!&*(&@, used in the display name of a dashboard data category or property is replaced by an underscore.

After you create a token, it cannot be edited.

Revoke a token

Only active tokens can be revoked. Any data architect can revoke a token, even if they did not create it.

To revoke a token, complete the following steps.
  1. Click the Settings tab.
  2. Under API Tokens, in the row of the token to revoke, click the Revoke Token icon . All data architects receive an email notification that the token was revoked.

After you revoke a token, it cannot be undone.

By using this site you agree to the use of cookies for analytics and personalized content.  Read our policy