Skip to content
D
Documentation

New report setting

reference
9 min readUpdated

A new report setting brings report tabs, widgets, and time-frame choices together for later use in the reports area. A tab is a named report area; a widget is a report component placed in that area. You assemble the tabs and their contents, then save the setting.

New report setting

Use this page to create a report setting rather than change one that is already saved. Create tabs, add widgets to the active tab, import tabs from another role dashboard, and choose the time frame used by a report.

If you need to…Go to
Open a new report-setting editorFind the new report-setting page
Read the editor before changing itUnderstand the report-setting screen
Add, rename, delete, or populate tabsConfigure report tabs and options
Copy tabs from another dashboardHandle import and conditional report-setting branches
Save the setting and review its historySave and review the report setting
Resolve a blocked or uncertain actionWhen saving or navigation goes wrong
Change a setting that already existsThe existing report-setting edit page
Use the configured reportsThe Reports area

Open the new setting from the report-settings configuration page. The companion Edit report setting page handles later changes to a saved setting, while the Reports area consumes its tabs and widgets. Start with the prerequisites below.

Prerequisites

You need access to the report-setting configuration area. The report library is available when the subscription includes it and the tab is not hidden. In Edit mode, the page provides Editable prev. months, Time Frame, Widget, the tab menu, Save, Save and Close, and the close action.

Before you begin, have the information needed for the setting ready:

Have or confirm…Why it matters
Access to the report-setting configuration areaThe new editor is the place where the setting is assembled.
The report library in your subscription and visible in its tabThe report-library area supplies tab and widget actions.
The dashboard and tab names you intend to useA new tab requires a value in New Tab, and imported tabs are checked against existing names.
The previous-months and time-frame choicesThese choices control the report periods available in the setting.

The saved-record history area is available for a saved report setting. Enter the dashboard and tab names before saving. To import tabs, choose a dashboard and submit the import dialog. When these preparations are complete, find the new report-setting page.

Find the new report-setting page

The new report-setting editor is the page where you assemble a setting before saving it.

Prerequisites

  • You have access to the configuration reports area.

Steps

  1. Open the report-settings configuration page.
  2. Open the new report-setting editor.
  3. Confirm that the page title reads Configuration Reports.
The new report-setting page and its Configuration Reports title

Result: The new report-setting editor is open.

The open editor is described next so you can identify the controls before configuring the setting.

Understand the report-setting screen

A report setting is made of report tabs and the widgets placed in those tabs. The main editor shows Editable prev. months and Time Frame as readouts, then provides the report-library area for Widget, Tab, and the tab-specific controls. The page also provides Save and Save and Close.

Area or controlWhat you use it for
Editable prev. monthsReview the previous-months setting shown by the editor.
Time FrameReview the time-frame setting shown by the editor.
WidgetOpen the widget-selection workflow for the active tab.
TabOpen the active tab's menu.
SaveSave the report setting and remain on the page.
Save and CloseSave the report setting and request that the page be left.
Last ModificationsReview modification history when the saved-record history area is available.

The tab menu exposes Blank Tab for a new tab and Import From for importing tabs. The relevant tab workflows use the following choices and fields:

WorkflowReader-facing choices or fields
Add a tabNew Tab in the add-new-tab dialog
Select a widgetSearch for widget
Choose a time frameThis year, Definite year, or last 12 months
Change an existing tabRename tab or Delete tab
Review the history areaLast Modifications

Note: Editable prev. months and Time Frame are readouts on this editor; use the relevant dialog when you need to change those choices.

The editor readouts, report-library area, and save controls

After identifying the editor controls, configure its tabs and options.

Configure report tabs and options

Build the tabs directly when you do not need to import them from another dashboard.

Prerequisites

  • The report library is available to the subscription and its tab is visible.
  • The new report-setting editor is open.

Steps

  1. Open the Tab menu.
  2. Select Blank Tab.
  3. Enter the tab name in New Tab.
  4. Select OK.
  5. In the active tab, select Widget.
  6. Use Search for widget to locate the widget you need.
  7. Select the widget to add it to the active tab.
  8. Open the time-frame choices for the active widget.
  9. Select one option from the table.

Result: The active tab contains the widget and the time-frame choice you selected.

If the report covers…Choose
The current yearThis year
One specific yearDefinite year, then enter a year from 2024 through the current year
The previous twelve monthslast 12 months

Rename a tab

Rename the active tab when its current name no longer identifies its contents.

Prerequisites

  • The tab you want to rename is active.

Steps

  1. Open the Tab menu.
  2. Select Rename tab.
  3. Enter the new value in New Tab.
  4. Select OK.

Result: The active tab has the new name when the value is valid and not already in use.

Delete a tab

Remove the active tab when you no longer need its reports.

Prerequisites

  • The tab you want to remove is active.

Steps

  1. Open the Tab menu.
  2. Select Delete tab.
  3. Select Ultimate delete when the permanent-delete branch opens.
  4. Select Delete.

Result: The selected tab is removed. Select Cancel instead of Delete to close the permanent-delete branch without removing it.

The previous-months value accepts a minimum of 1 and a maximum of 11. The definite year value accepts a minimum of 2024 and a maximum of the current year.

The tab menu with Blank Tab and Import From
The Add new tab dialog with the New Tab field

Handle import and conditional report-setting branches

Importing is the branch for copying tabs from another role dashboard. Another role dashboards has no fixed labels; it is populated with available dashboard names. The current dashboard and dashboards without usable content are excluded from those choices. The workflow then exposes Select tab(s) for choosing what to copy.

After you select a dashboard, Select tab(s) is populated with that dashboard's available tabs.

If you need to…Use this branch
Copy selected tabsSelect the required entries in Select tab(s).
Replace the existing tabs with all tabs from the sourceSelect All (Replace existing tabs).
Change the previous-months valueUse the number of editable Prev. months field; enter 1 through 11.
Choose the current year, a specific year, or the previous twelve monthsUse This year, Definite year, or last 12 months.
Enter a specific yearSelect Definite year first, then enter a year from 2024 through the current year.

Prerequisites

  • The report library is available to the subscription and its tab is visible.
  • A dashboard with usable tabs is available in Another role dashboards.

Steps

  1. Open the Tab menu.
  2. Select Import From.
  3. Select a dashboard in Another role dashboards. The list contains dashboard names from returned dashboard records: each displayed name is its DashboardName; the matching Id identifies the selected dashboard, and records with empty DashboardJson are excluded.
  4. Select the tabs to copy in Select tab(s).
  5. Select All (Replace existing tabs) when the source dashboard's complete tab set must replace the current tabs.
  6. Confirm the import in the dialog.

Selected tabs are copied into the setting. Selecting All (Replace existing tabs) replaces the existing tabs with the source dashboard's tabs. Choose from dashboards prepared for your roles. Sales Report and Eagle View add-tab actions are not available on this page.

Result: The selected tabs are added to the report setting, or the existing tabs are replaced when All (Replace existing tabs) was selected.

Save and review the report setting

Saving records the dashboard assembled from the setting's tabs and widgets. Save keeps the editor open, while Save and Close uses the same save operation and also requests that the page be left.

Prerequisites

  • The tabs and widgets are in the state you want to save.
  • Any required New Tab value has been entered before saving.

Steps

  1. Select one save action from the table.
  2. Confirm that the success message reads Your request was completed successfully.
  3. Review Last Modifications when the saved report setting has a modification-history area.
If you want to…Select
Save the report setting and remain in the editorSave
Save the report setting and leave the pageSave and Close

The save operation counts the tabs and widgets, serializes the dashboard, saves it, and records modification history. The success message appears after the dashboard save and modification logging complete. Continue with the recovery table if the save or navigation does not complete.

Result: Save keeps the editor open. Save and Close requests leaving the page. After a successful save, review Last Modifications when it is available.

When saving or navigation goes wrong

Use the message on screen to choose the recovery action. A duplicate tab name blocks the create or rename operation; a duplicate imported tab blocks that tab from being copied. The New Tab field is required when creating or renaming a tab.

What you seeWhat it meansWhat to do
RequiredNew Tab has no value.Enter a tab name in New Tab, then confirm the dialog again.
You already have a tab with the same nameThe new or renamed tab duplicates an existing tab name.Enter a different value in New Tab, then confirm again.
You already have this tab in this dashboardAn imported tab already exists in the current dashboard.Select a different tab to import, or continue with the existing tab.
An error occurred while processing your requestLoading or saving the setting encountered an error.Check the values and connection, then retry the affected action.

Result: You have either corrected the tab value, avoided a duplicate, or retried a load or save action after the displayed error.

Continue after saving

After saving, use the report setting in the reports area. Report tabs can be selected, and the active tab provides content and Search for widget for working with its reports. Administrator-prepared role dashboards appear in the role-dashboard menu and can provide source tabs for later imports.

If you want to…Action
Change the saved settingOpen the existing report-setting edit page.
Use the configured reportsOpen the Reports area.
Select a reportSelect the required report tab.

The Save and Close action requests leaving the new-setting page. The report-setting editor remains the place to assemble tabs and widgets; the saved-setting edit page is the companion page for changing an existing setting.

Was this page helpful?

Need help using the product?