Data architects use the Settings page 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.

Default to Include Projects in Dashboard

By default, non-workflow projects are excluded from the dashboard, and only administrators, data managers, and data architects can access the setting to include them. The Default to Include Projects in Dashboard setting allows data architects to determine whether the Include in dashboard option is checked or unchecked in the desktop app for administrators, data managers, or data architects who create or edit non-workflow projects.
Note

This setting only applies to new non-workflow projects. It does not apply to existing non-workflow projects, workflow projects, or tools-only projects.

Adjust the setting

  1. Select Settings.
  2. Under Default to Include Projects in Dashboard, choose one of the following settings.
    Exclude by default
    Shows the Include in dashboard option for new non-workflow projects as unchecked when administrators, data managers, or data architects save a project for the first time.
    Include by default
    Shows the Include in dashboard option for new non-workflow projects as checked when administrators, data managers, or data architects save a project for the first time.

Allow Non-Workflow Projects

Adjust this system setting to determine whether users can create non-workflow projects. By default, when workflow is on, users can select from a list of non-workflow project templates. To prevent users from creating non-workflow projects when workflow is on, data architects can hide non-workflow project templates, which forces all new projects through the established workflow approval process.

Adjust the setting

The Allow Non-Workflow Projects setting affects the user’s view of the New tab in the desktop app; however, the setting does not affect the data architect’s view. Data architects always see the non-workflow project templates so they can create non-workflow projects at any time.

After a data architect changes this setting, the new setting does not take effect until users close and reopen the Engage desktop app.

  1. Select Settings.
  2. Under Allow Non-Workflow Projects, choose one of the following settings.
    Allow
    Allows users to create non-workflow projects by showing non-workflow project templates when they choose File > New.
    Disallow
    Prevents users from creating non-workflow projects by hiding non-workflow project templates when they choose File > New.

API Tokens

API tokens provide access to all Engage data (except Counts) from external business intelligence systems and applications. When you create an API token in Engage, your business intelligence system or application can include your Engage 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 your Engage data. Therefore, you should treat API tokens like you would a password.

Create a token

To create a token, complete the following steps.
  1. Select Settings.
  2. Under API Tokens, 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. Select Add New Token.
  4. Select Copy Password. This is your only chance to copy the password.
  5. After you receive confirmation that the password was copied to the clipboard, select 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. Select Settings.
  2. Under API Tokens, in the row of the token to revoke, select the Revoke Token icon .
  3. In the Revoke Token dialog box, select Revoke. All data architects receive an email notification that the token was revoked.

After you revoke a token, it cannot be undone.