Skip to content
D
Documentation

Edit report setting

reference
7 min readUpdated

A report setting is the saved dashboard configuration assigned to a role. Use this page to review its tabs, widgets, time-frame choices, and editable-month setting, then save a change or review its modification history.

If you need to…Go to
Understand the setting and its available fieldsUnderstand the report-setting screen
Find a saved report settingFind a report setting
Change tabs, widgets, or time-frame choicesChange and save report settings
Resolve a validation or save messageWhen saving or leaving goes wrong
Review the list of report settingsReports settings
Create a report settingNew report setting
Understand reports available to readersReports hub

Before you start

Prepare the saved configuration from the Reports settings list. The edit surface uses the record's edit mode for its header actions, and the route for a saved record is /configuration/reports-settings/edit/:ID.

Prerequisites

  • You know which saved configuration you need to review.
  • You can reach the record from the Reports settings list.
  • The record is in edit mode before you use its editable controls.
  • If your access is read-only, review the setting without submitting a change.

Find a report setting

A report-setting record is a role's saved collection of report tabs and widgets. The list helps you select the role record before its setting details are opened.

Prerequisites

  • You are at /configuration/reports-settings.

Steps

  1. Review the list by the headers Role, Tabs, Widgets, Users, and Last modified.
  2. Select the list-level Settings action.
  3. Select the saved report-setting record you need to review.
Identify a report-setting record from the list headers and modification column.

Result: The selected report-setting record opens for review or editing.

Understand the report-setting screen

The report-setting screen groups dashboard choices behind popup states and tab actions. Each field appears only in the popup or screen state described in the following conditions.

Fields and conditions

FieldTypeRequiredAppears whenLimits or note
Another role dashboardsSelectNoThe import-dashboard popup is openSelects another role dashboard source.
Select tab(s)CheckboxNoA source dashboard is selected and has tabsSelects all available imported tabs.
Tab selection checkboxCheckboxNoA source dashboard is selected and has tabsThe visible text is the tab title.
number of editable Prev. monthsNumberNoThe previous-months popup is openMinimum 1; maximum 11.
Search for widgetTextNoThe active tab has widgetsFilters the widgets in the active tab.
New TabTextYesThe add-tab popup is openThe form requires a value.
New TabTextYesThe edit-tab popup is openThe form requires a value.
Time-frame yearNumberYesDefinite year is selected in the time-frame popupMinimum 2024; maximum is the current year.

The edit screen also has the following conditional areas:

Reader action or areaWhat it opens or displaysCondition
Editable prev. monthsThe editable-months fieldThe previous-months popup is open.
Time FrameTime-frame choicesThe time-frame popup is open.
WidgetThe add-widget preparation actionThe dashboard has at least one tab.
Blank TabBlank-tab preparationThe dashboard tab actions are available.
Import FromDashboard-import fieldsThe import-dashboard popup is open.
Last ModificationsThe log-history areaThe report dashboard record has an identifier.

The time-frame popup provides This year, Definite year, last 12 months, and From / To choices. The time-frame year appears for Definite year. The edit surface also contains widget contents rather than a separate report grid; use the child widget's own content when reviewing a widget.

Review the list-level settings action before opening a report-setting record.

Change and save report settings

Changing a report setting updates the dashboard arrangement assigned to the selected role. Use the popup that matches the change you need, then use the save action that matches whether you want to remain on the record.

Prerequisites

  • You have opened a saved report-setting record in edit mode.
  • You know whether you are changing the editable-month count, time frame, tabs, or widgets.

Steps

  1. Select Editable prev. months to open the previous-months field.

  2. Enter a number from 1 through 11 in number of editable Prev. months.

  3. Select Time Frame to open the time-frame choices.

  4. Choose one time-frame option from the following table.

    If you need to…Choose
    Use the current yearThis year
    Use one specified yearDefinite year
    Use the preceding twelve monthslast 12 months
    Set a start and end dateFrom / To
  5. If you choose Definite year, enter a year from 2024 through the current year in the time-frame year field.

  6. Select one tab action from the following table.

    If you need to…Select
    Add a widgetWidget
    Add an empty tabBlank Tab
    Import tabs from another dashboardImport From
    Rename the active tabRename tab
    Remove the active tab and its contentsDelete tab
    Close all open widgetsCollapse all
    Remove or manage a widget in the active tabRemove widget from tab
  7. If you selected Import From, choose a source in Another role dashboards.

  8. If imported tabs are available, select Select tab(s) or an individual tab-selection checkbox.

  9. If you selected Blank Tab or Rename tab, enter the tab name in New Tab.

  10. If you need to locate a widget, enter text in Search for widget.

  11. Choose how to save the dashboard settings.

    If you need to…Choose
    Keep the record openSave
    Request page exitSave and Close

Result: The dashboard settings are submitted, and a successful save displays Your request was completed successfully.

Handle screen variations

The controls available on this screen depend on the record state and the popup you open. Use the conditions below to choose the applicable surface rather than looking for every field at once.

When this is trueWhat changes
The record is in edit modeHeader actions and editable report controls are available.
The report dashboard record has an identifierThe Last Modifications area is available.
The import-dashboard popup is openAnother role dashboards and its import choices appear.
A source dashboard has one or more tabsSelect tab(s) and individual tab-selection checkboxes appear.
The previous-months popup is opennumber of editable Prev. months appears.
The add-tab popup is openRequired New Tab appears.
The edit-tab popup is openRequired New Tab appears for the existing tab name.
The time-frame popup is openThe time-frame choices appear.
Definite year is selectedThe required time-frame year appears.

The Sales report and Eagle View choices do not form part of the available tab choices.

When saving or leaving goes wrong

Use the exact message on screen to choose the appropriate response.

MessageMeaningWhat to do
This Field Is RequiredA required field has no value.Return to the required field and enter a value.
RequiredThe time-frame year requires a value when Definite year is selected.Enter the year before continuing.
Are you sure you want to ultimately delete this tab and all it's content ?The delete-tab action asks for confirmation before removing the tab and its contents.Review the message before continuing.
Your request was completed successfullyThe save request completed successfully.Continue with the saved record or open Last Modifications.
An error occurred while processing your requestThe save request returned an error.Review the values and try the save action again.
You already have this tab in this dashboardThe import would add a tab already present in the dashboard.Choose a different tab or review the existing tab.

Note: Deleting a tab removes the tab and all its content after the confirmation step.

Leaving a record with changes opens the exit popup. Leaving without changes calls the page-leave service. Review the exit choice before leaving so that you do not discard a change unintentionally.

Review the result and continue

The modification history is the record's follow-up view after a save. It lets you review the latest changes recorded for the dashboard setting.

Prerequisites

  • You have finished reviewing or changing the report setting.

Steps

  1. Choose how to save the setting.

    If you need to…Choose
    Remain on the record after savingSave
    Save the setting and request page exitSave and Close
  2. Open Last Modifications to review the record's modification history.

  3. Continue with Reports settings to review the list or New report setting to create another setting.

Result: The saved dashboard setting remains available from the Reports settings list, and its recorded changes are available under Last Modifications.

Was this page helpful?

Download as PDF
Edit report setting — PAMS Fresh Generation