Minitab Engage®  Support

System settings

Learn more about Minitab Engage
Data architects use the Settings page to apply systemwide settings and manage API tokens for external business intelligence systems and applications.

In This Topic

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

You can use the Engage API to perform the following operations.

  • Send project ideas to Engage.
  • Pull dashboard data from Engage.

To set up external systems or applications to perform these operations, follow these high-level steps.

  1. Create a token.
  2. Configure your external system or application to use the token. Each system or application is different, so consult its documentation for detailed instructions.
Note

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

Create a token

All data architects receive an email notification when a token is created.
  1. Select Settings.
  2. In the API section under Tokens, select Add New Token.
  3. Enter a name for the token.
  4. Set an expiration date for the token. Choose a date between tomorrow and 1 year from today.
    Note

    By default, 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.

  5. Under Permissions, select which operation to include in the token. A token can include more than one operation.
    Read dashboard data
    Pulls dashboard data from Engage.
    Create ideas
    Sends project ideas to Engage. Only data fields that are shared to the idea form are included in the request. To see the list of valid data fields and category names available for sharing, select Download Data Field Reference.
  6. Select Create.
  7. Select Copy Password. This is your only chance to copy the password.
  8. After you receive confirmation that the password was copied to the clipboard, select Close.
  9. Make note of or copy the Endpoint URL. You will need the password you copied to the clipboard and the endpoint URL to complete the setup.
  10. Go to Use the Engage API for detailed information about the expected request and response structures used by the Engage API.

Edit a token

You can specify and edit token names, token expiration dates, and token permissions without creating a new token. All data architects receive an email notification when a token is edited.
  1. Select Settings.
  2. In the API section under Tokens, in the row of the token to edit, select Edit Token .
  3. In the Edit Token dialog, change the token name, expiration date, or permissions.

Revoke a token

Only active tokens can be revoked. Any data architect can revoke a token, even if they did not create it. All data architects receive an email notification when a token is revoked.
Note

Revoking a token cannot be undone.

  1. Select Settings.
  2. In the API section, under Tokens, in the row of the token to revoke, select Revoke Token .
Copyright © 2025 Minitab, LLC. All rights Reserved.