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.
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
- Select Settings.
- 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.
- Select Add New Token.
- Select Copy Password. This is your only chance to copy the password.
- 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.
- 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.
- Select Settings.
- Under API Tokens, in the row of the token to revoke,
select the Revoke Token icon
. - 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.
