1 RICOH Supervisor
1.1 Overview of RICOH Supervisor
RICOH Supervisor is a cloud-based application that helps you monitor, understand, and improve your print production environment through visual representations. You can easily monitor data sources, view collected data, and set alerts to keep you aware of important changes.
- Key features
-
- Monitor device status and view usage statistics.
- Set performance targets by day or by week.
- Create dashboards with different layout and graphical options for displaying collected data.
- Drill down dashboards to focus on specific data and identify potential bottlenecks.
- Download reports at any time.
- View tasks from every printer together on one screen.
- Configure notifications to stay well-informed and react quickly to problems.
1.1.1 What's New?
- February 13, 2025
- Various security fixes including CVE-2024-21538.
- Minor bug fixes.
- January 31, 2025
- Various security updates.
- Minor bug fixes.
- January 23, 2025
- Various security fixes including CVE-2024-47535 and CVE-2024-52798.
- Minor bug fixes.
- December 31, 2024
- Various security updates.
- Minor bug fixes.
- December 20, 2024
- Enhanced the dashboard features. A new dashboard tab with improved data analysis functions is available. For more information, see Working with Dashboards [New].
- Added the option to analyze and visualize your data in an analysis. You can create a new analysis and customize it according to your needs by editing, renaming or deleting it. For more information, see Creating an Analysis.
- Added the option to publish the analysis as a read-only dashboard that can be accessed from the Dashboards tab. For more information, see Publishing an Analysis.
- Included a wide variety of visuals that you can add to an analysis, with different types of charts and custom elements. For more information, see Creating Visuals.
- Improved the format and style of data visualizations. For more information, see Formatting Visuals.
- Improved the data filtering options. For more information, see Working with Filters.
- Improved the downloading of visuals and analyses when you want to share your data or create reports and presentations. For more information, see Downloading Data and Creating Reports.
- Added a series of video presentations of the enhanced dashboard features. For more information, see Ricoh How-to Videos.
- Various security updates.
- Minor bug fixes.
- December 5, 2024
- Various security updates.
- Minor bug fixes.
- November 21, 2024
- Various security updates.
- Minor bug fixes.
- October 31, 2024
- Added information related to the new dashboards features. For more information, see Frequently Asked Questions: New Dashboard Capabilities.
- Various security fixes including CVE-2023-4039.
- Minor bug fixes.
- October 10, 2024
- Added data collected from the printer, by adding the new Printer model attribute to the widget library. You cannot change the printer model, it is populated automatically. For more information, see Data Fields. (Requires the new version of RICOH Supervisor Data Collector)
- Various security updates.
- Minor bug fixes.
- September 19, 2024
- Various security fixes including CVE-2024-45490, CVE-2024-45491, CVE-2024-45492, and CVE-2024-6119.
- Minor bug fixes.
- August 29, 2024
- Added the Shift Performance (Last Week) default dashboard. The Shift Performance (Last Week) dashboard displays information on shift productivity. This dashboard includes several new default widgets that are also available in the Widget library panel.
- Modified the ERROR DURATION (HOURS) PER PRINTER ENGINE widget from the Printer Utilization dashboard to display a breakdown per printer and printer engine of the total error duration.
- Added the minimum supported code version for continuous form printers. For more information, see the RICOH Supervisor Data Collector documentation. (Requires the new version of RICOH Supervisor Data Collector)
- Various security fixes including CVE-2024-7264, CVE-2024-37370, CVE-2024-37371, CVE-2024-42459, CVE-2024-42460, and CVE-2024-42461.
- Minor bug fixes.
- August 8, 2024
- Various security updates.
- Minor bug fixes.
- July 31, 2024
- Removed the top 20 filter for the INK USAGE PER JOB (MILLILITER) default widget.
- Various security updates.
- Minor bug fixes.
- July 18, 2024
- Improved the information about the following ports: Port 80, Port 443, and Port 53. For more information, see the RICOH Supervisor Data Collector documentation. (Requires the new version of RICOH Supervisor Data Collector)
- Various security fixes including CVE-2024-28834, CVE-2024-28835, CVE-2024-37890, CVE-2023-50387, and CVE-2023-50868.
- Minor bug fixes.
- June 27, 2024
- Various security updates.
- Minor bug fixes.
- June 17, 2024
- Various security updates.
- Minor bug fixes.
- June 6, 2024
- Various security updates.
- Minor bug fixes.
- May 28, 2024
- Various security updates.
- Minor bug fixes.
- May 21, 2024
- Various security updates.
- Minor bug fixes.
- May 16, 2024
- Various security updates.
- Minor bug fixes.
- April 25, 2024
- Various security fixes including CVE-2024-21490, CVE-2024-28849, and CVE-2024-29041.
- Minor bug fixes.
- April 4, 2024
- Updated the guidelines for allowing third-party cookies in Google Chrome. For more information, see If You Encounter a Problem.
- Updated the list of allowed URLs and domains for installing RICOH Supervisor Data Collector. For more information, see the RICOH Supervisor Data Collector documentation. (Requires the new version of RICOH Supervisor Data Collector)
- Various security fixes including CVE-2024-22201, CVE-2022-3715, CVE-2023-52425, CVE-2024-28757, and CVE-2023-42282.
- Minor bug fixes.
- March 14, 2024
- Improved the guidelines for installing RICOH Supervisor Data Collector for Windows and Linux. For more information, see Downloading and Installing RICOH Supervisor Data Collector .
- Various security updates.
- Minor bug fixes.
- February 29, 2024
- Various security updates.
- Minor bug fixes.
- February 22, 2024
- Added guidelines in the Troubleshooting and Support section for allowing third-party cookies in Google Chrome. For more information, see If You Encounter a Problem and Computer Requirements.
- Added the port number that allows RICOH Supervisor to access the data stored in the RICOH ProcessDirector reports database. For more information, see Configuring the RICOH ProcessDirector Software Connector.
- Various security fixes including CVE-2023-5678, CVE-2023-6129, CVE-2023-6237, CVE-2024-0727, and CVE-2023-52428.
- Minor bug fixes.
- February 1, 2024
- Added support for Pro VC80000 TotalFlow Print Server and RICOH ProC7500 printers. For more information, see the RICOH Supervisor Data Collector documentation. (Requires the new version of RICOH Supervisor Data Collector)
- Added data collected from Avanti Slingshot, by adding new Avanti Slingshot attributes to the widget library. For more information, see Data Fields from Avanti Slingshot.
- Various security fixes including CVE-2024-21634.
- Minor bug fixes.
- January 11, 2024
- Various security fixes including CVE-2023-46218, CVE-2021-44879, CVE-2023-25775, CVE-2023-34324, CVE-2023-35827, CVE-2023-45863, CVE-2023-46813, CVE-2023-46862, CVE-2023-5178, CVE-2023-51780, CVE-2023-46233, CVE-2023-45857, CVE-2023-51385, and CVE-2023-4586.
- Minor bug fixes.
- December 21, 2023
- Added data collected from Avanti Slingshot, by adding new Avanti Slingshot attributes to the widget library. For more information, see Data Fields from Avanti Slingshot.
- Enable the RICOH API for Fiery feature for RICOH Pro9500 printers. For more information, see the RICOH Supervisor Data Collector documentation. (Requires the new version of RICOH Supervisor Data Collector)
- Various security fixes including CVE-2022-48522, CVE-2023-47038, CVE-2023-44487, CVE-2023-3576, CVE-2023-40745, and CVE-2023-41175.
- Minor bug fixes.
- November 29, 2023
- Various security fixes including CVE-2023-35116, CVE-2023-44487, CVE-2023-4586, and CVE-2023-36054.
- Minor bug fixes.
- November 9, 2023
- Updated the list of supported operating systems. Removed support for Windows Server 2012. For more information, see the RICOH Supervisor Data Collector documentation. (Requires the new version of RICOH Supervisor Data Collector)
- Updated the supported web browser versions to Google Chrome 116 or later, Mozilla Firefox 116 or later and Microsoft Edge 116 or later. For more information, see the RICOH Supervisor Data Collector documentation. (Requires the new version of RICOH Supervisor Data Collector)
- Added information about the length limit for job names for each printer type. For more information, see the RICOH Supervisor Data Collector documentation. (Requires the new version of RICOH Supervisor Data Collector)
- Various security updates.
- Minor bug fixes.
- October 18, 2023
- Improved the widget information displayed in the Dashboards tab. The printer states and the state categories are displayed in the widget information.
- Improved the printer card information from the Real Time Display tab. The printer cards now display the printer states. For more information, see Printer Status.
- Various security updates.
- Minor bug fixes.
- October 5, 2023
- Various security updates.
- Minor bug fixes.
- September 28, 2023
- Improved the error information displayed on the printer cards from the Real Time Display tab. Only error messages are displayed, while warning messages are ignored. For more information, see Printer Status. (Requires the new version of RICOH Supervisor Data Collector)
- Improved the accuracy of up time, down time, and idle time reporting in historical data.
- Various security fixes including CVE-2020-36130,CVE-2020-36131,CVE-2020-36133,CVE-2020-36135,CVE-2021-30473,CVE-2021-30474,CVE-2021-30475,CVE-2022-48554,CVE-2023-26048, and CVE-2023-26049.
- Minor bug fixes.
- September 7, 2023
- Improved the job metrics for the jobs that are partially printed on RICOH Pro VC printers. For more information, see Data Fields from RICOH Supervisor Data Collector . (Requires the new version of RICOH Supervisor Data Collector)
- Various security updates.
- Minor bug fixes.
- August 17, 2023
- Various security fixes including CVE-2023-3610, CVE-2023-3390, CVE-2023-20593, CVE-2023-35116, and CVE-2023-34462.
- Minor bug fixes.
- July 27, 2023
- Improved the data collected from Fiery printers, by adding new RICOH API for Fiery attributes to the widget library. For Fiery printers, RICOH Supervisor Data Collector starts collecting the following job data through RICOH API for Fiery:
- Black & white printed pages
- Color printed pages
- Blank printed pages
- Tabs printed
- Rip duration (Seconds)
- Added the Widget Style section in the Widget Editor Design panel, that allows visual customization for widgets.
- Fixed styling issues in the Widget Editor Design panel from the Dashboards tab.
- Various security updates.
- Minor bug fixes.
- Improved the data collected from Fiery printers, by adding new RICOH API for Fiery attributes to the widget library. For Fiery printers, RICOH Supervisor Data Collector starts collecting the following job data through RICOH API for Fiery:
- July 6, 2023
- Added the Ink Consumption (Inkjet printers only) in the Sample Dashboards tab. The Ink Consumption (Inkjet printers only) default dashboard displays information for ink consumption by tracking the monthly and daily ink usage and the ink consumption per printer and per job. For more information, see Ink Consumption (Inkjet printers only) Dashboard . (Requires the new version of RICOH Supervisor Data Collector).
- Improved the accuracy of ink metrics for RICOH Pro VC printers.
- Various security fixes including CVE-2023-2603, CVE-2023-2602, CVE-2023-32695, CVE-2023-31125, CVE-2022-24434, and CVE-2022-25896.
- Minor bug fixes.
- June 15, 2023
- Added guidelines for installing RICOH Supervisor Data Collector on Linux. For more information, see the RICOH Supervisor Data Collector documentation. (Requires the new version of RICOH Supervisor Data Collector).
- Added guidelines for moving RICOH Supervisor Data Collector on a new server. For more information, see the RICOH Supervisor Data Collector documentation. (Requires the new version of RICOH Supervisor Data Collector).
- Added support for configuring account settings in the Settings tab. You can define your fiscal year, by selecting a different calendar month with which your fiscal year starts.
- Various security updates.
- Minor bug fixes.
- May 18, 2023
- Added support for enabling and disabling the feature number 5565 on the physical printer. For more information, see the RICOH Supervisor Data Collector documentation. (Requires the new version of RICOH Supervisor Data Collector).
- Various security fixes including CVE-2023-2251, CVE-2022-3996, CVE-2023-0464, and CVE-2023-0466.
- Minor bug fixes.
- April 27, 2023
- Added guidelines in the Troubleshooting and Support section about how to manually uninstall RICOH Supervisor Data Collector. For more information, see the RICOH Supervisor Data Collector documentation. (Requires the new version of RICOH Supervisor Data Collector).
- Various security fixes including CVE-2023-0842, CVE-2023-24998, CVE-2023-24538, CVE-2023-28484, and CVE-2023-29469.
- Minor bug fixes.
- April 6, 2023
- Fixed styling issues in the Dashboards tab.
- Added information that shifts apply only to printers that are currently registered in RICOH Supervisor Data Collector. For more information, see Configuring Shifts.
- Various security fixes including CVE-2022-25881 and CVE-2022-41946.
- Minor bug fixes.
- March 23, 2023
- Various security fixes.
- Minor bug fixes.
- March 16, 2023
- Various security fixes including CVE-2022-25147, CVE-2023-0804, CVE-2022-24963, CVE-2023-23916, CVE-2023-0361, CVE-2022-48303, CVE-2022-45873, and CVE-2023-23916.
- Minor bug fixes.
- February 23, 2023
- Added guidelines in the Troubleshooting and Support section for the case when printer cards metrics are displayed with delays. For more information, see If You Encounter a Problem.
- Various security updates.
- Minor bug fixes.
- February 16, 2023
- Various security fixes including CVE-2022-23529, CVE-2022-25881, CVE-2022-23539, CVE-2022-23540, CVE-2022-23541, CVE-2022-24999.
- Minor bug fixes.
- February 2, 2023
- Added guidelines for displaying dashboards in Incognito mode in the Troubleshooting and Support section. For more information, see If You Encounter a Problem.
- Updated the supported web browser versions to Google Chrome 108 or later, Mozilla Firefox 108 or later and Microsoft Edge 108 or later. For more information, see the RICOH Supervisor Data Collector documentation. (Requires the new version of RICOH Supervisor Data Collector)
- Updated the list of supported operating systems for RICOH Supervisor Data Collector. Added support for CentOS Stream 8, openSUSE Leap Desktop 15.4 or higher and removed support for Windows 8.1. For more information, see the RICOH Supervisor Data Collector documentation. (Requires the new version of RICOH Supervisor Data Collector)
- Various security updates.
- Minor bug fixes.
- January 31, 2023
- Various security updates.
- Minor bug fixes.
- January 13, 2023
- Added the RICOH Pro Scanner option for RICOH Pro VC 60000 and 70000 printers, that provides data about print head cleaning, quality control, and collected logs.
- Various security updates.
- Minor bug fixes.
- December 22, 2022
- Added information about how to address issues with Blocked URLs in the Troubleshooting and Support section.
- Various security fixes including CVE-2022-41940, CVE-2022-2421, CVE-2022-42003, CVE-2022-42004, CVE-2022-31159, CVE-2022-41940, and CVE-2021-28168.
- Minor bug fixes.
- November 17, 2022
-
- Added guidelines for generating the HAR and logs files in the Troubleshooting and Support section. For more information, see If You Encounter a Problem.
- Various security fixes including CVE-2022-32221, CVE-2022-42916, CVE-2022-42915, CVE-2022-35260, CVE-2022-42004, CVE-2022-42003, CVE-2022-3786, CVE-2022-3602, CVE-2022-3358, CVE-2022-2880 and CVE-2022-31159.
- Minor bug fixes.
- October 27, 2022
- Improved the dashboard sharing function. Added the SEND ME A REPORT NOW button, that allows users to receive a report on demand.
- Various security updates.
- Minor bug fixes.
- October 6, 2022
- Improved the dashboard sharing function. When you share a dashboard, the dashboard recipients will receive a notification email. Added the Schedule report delivery function, where you can select the users that will receive a schedule report, the type of report that you want to send, set the time zone for sending the email reports and select the frequency for sending email notifications.
- Various security fixes including CVE-2022-1587, CVE-2022-1586, CVE-2022-31197, and CVE-2022-40674.
- Minor bug fixes.
- September 15, 2022
- Added the command line installation option for RICOH Supervisor Data Collector. For more information, see Installing RICOH Supervisor Data Collector with Command Line.
- Added the command line option for uninstalling RICOH Supervisor Data Collector. For more information, see Uninstalling RICOH Supervisor Data Collector with Command Line.
- Added the command line option for updating RICOH Supervisor Data Collector. For more information, see Upgrading RICOH Supervisor Data Collector with Command Line.
- Changed the default behavior for printer and data collectors notifications. By default, all printers and data collectors are selected. When all printers and data collectors are selected, new printers and data collectors will also be selected automatically. For more information, see Editing Notifications
- Various security fixes including CVE-2022-37434 and CVE-2021-30560.
- Minor bug fixes.
- August 25, 2022
- Various security fixes including CVE-2021-22945, CVE-2022-32207, CVE-2022-27782, CVE-2022-27781, CVE-2021-22946, CVE-2022-27775, CVE-2022-22576, CVE-2022-32205, CVE-2022-32208, CVE-2021-22947, CVE-2022-32206, CVE-2022-27774, CVE-2022-27776, CVE-2021-22898, CVE-2021-22924, CVE-2022-2191, CVE-2021-46828, CVE-2022-36946, CVE-2022-29901, CVE-2022-29900, CVE-2022-36879, CVE-2022-2585, CVE-2022-21505, CVE-2022-2586, CVE-2022-26373, and CVE-2022-2588.
- Minor bug fixes.
- August 4, 2022
-
- Various security fixes including CVE-2022-30636, CVE-2022-27404, CVE-2022-27406, CVE-2022-32981, CVE-2022-27405, CVE-2022-21166, CVE-2022-21123, CVE-2022-21125, CVE-2022-32296, CVE-2022-25309, CVE-2021-4209, CVE-2022-1184, CVE-2022-25308, CVE-2022-31129, CVE-2022-34903, CVE-2022-25310, and CVE-2022-31159.
- Minor bug fixes.
- July 14, 2022
-
- Grouped the notifications into categories: Connectivity Status, Printer Status and Software Updates.
- Added a new connectivity notification when a printer stops sending data to the data collector. For more information, see Editing Notifications and Enabling and Disabling Notifications.
- Various security fixes including CVE-2022-33987, CVE-2022-2068, and CVE-2022-24823.
- Minor bug fixes.
- June 23, 2022
- Updated the list of supported operating systems for RICOH Supervisor Data Collector. Added support for Windows 11 and Windows Server 2022. For more information, see the RICOH Supervisor Data Collector documentation. (Requires the new version of RICOH Supervisor Data Collector)
- Updated the supported web browser versions to Google Chrome 99 or later, Mozilla Firefox 99 or later and Microsoft Edge 99 or later. For more information, see the RICOH Supervisor Data Collector documentation. (Requires the new version of RICOH Supervisor Data Collector)
- Various security fixes including CVE-2019-3902 and CVE-2022-1552.
- Minor bug fixes.
- June 2, 2022
- Improved the accuracy of job data collected through RICOH API for Fiery on Fiery printers.
- Added Milliseconds (Ms) at the end of the duration data fields.
- Various security fixes including CVE-2020-28469.
- Minor bug fixes.
- May 16, 2022
- Various security fixes including CVE-2021-43138.
- Minor bug fixes.
- April 21, 2022
-
- Added the right-click option for creating, duplicating, and deleting dashboards.
- Various security fixes including CVE-2020-36518.
- Minor bug fixes.
- April 14, 2022
-
- Various security fixes including CVE-2022-21724, CVE-2020-15250, CVE-2020-36048 and CVE-2022-0536.
- Minor bug fixes.
- March 10, 2022
-
- Various security fixes.
- Minor bug fixes.
- February 17, 2022
-
- RICOH ProcessDirector software connector allows multiple data transmitters. In the SOFTWARE CONNECTORS section, you can now view information about multiple data transmitters configured in RICOH ProcessDirector. (Requires the RICOH ProcessDirector version 3.10 or later).
- Various security fixes including CVE-2022-23806.
- Minor bug fixes.
- February 10, 2022
-
- Various security fixes including CVE-2022-0235.
- Minor bug fixes.
- January 27, 2022
-
- Grouped the dashboards into categories. Sample Dashboards include the Capacity Planning (Impressions) dashboard, the Job Insights dashboard, the Printer Utilization dashboard and the RICOH ProcessDirector dashboard. The dashboards created by the user are included in My Dashboards category.
- Various security fixes including CVE-2021-43797.
- Minor bug fixes.
- January 6, 2022
-
- Mitigated critical Apache Log4j security vulnerability issues. (Also requires installation of the new version of RICOH Supervisor Data Collector.)
- Various security fixes including CVE-2021-44228 and CVE-2021-44832.
- Minor bug fixes.
- December 16 & 17, 2021
-
- Grouped the widgets into categories.
- Mitigated critical Apache Log4j security vulnerability issues. (Also requires installation of the new version of RICOH Supervisor Data Collector.)
- Various security updates.
- Minor bug fixes.
- November 18, 2021
-
- Added software connectors in the Data Collectors tab. Software connectors let you collect and display data from other applications. For more information, see Configuring the RICOH ProcessDirector Software Connector. (Requires the RICOH ProcessDirector version 3.10 or later).
- Added the option of viewing information about the data transmitter configured in RICOH ProcessDirector, including the communication status, the total amount of data received, the next scheduled update, and the data tables. For more information, see Viewing RICOH ProcessDirector Data Transmitters. (Requires the RICOH ProcessDirector version 3.10 or later).
- Added the RICOH ProcessDirector default dashboard. The RICOH ProcessDirector default dashboard displays information collected from RICOH ProcessDirector. For more information, see RICOH ProcessDirector Dashboard. (Requires the RICOH ProcessDirector 3.10 or later).
- Added default widgets available for data from RICOH ProcessDirector. (Requires the RICOH ProcessDirector version 3.10 or later).
- Various security updates.
- Minor bug fixes.
- November 11, 2021
-
- Fixed issues related to locations and shifts configuration.
- Various security updates.
- Minor bug fixes.
- November 4, 2021
-
- Various security updates.
- Minor bug fixes.
- October 14, 2021
-
- Improved the preset and operator data collected from continuous form printers. The
Operator Name, Logged Activity Type, Operator Login Duration (ms), Preset Name, and Preset Action Type data fields are now available. For more information, see Data Fields. (Requires the new version of RICOH Supervisor Data Collector)
For printers that are already registered in the system, RICOH Supervisor Data Collector starts collecting operator data the next time an operator logs in to the printer.
- Various security updates.
- Minor bug fixes.
- Improved the preset and operator data collected from continuous form printers. The
Operator Name, Logged Activity Type, Operator Login Duration (ms), Preset Name, and Preset Action Type data fields are now available. For more information, see Data Fields. (Requires the new version of RICOH Supervisor Data Collector)
- September 24, 2021
-
- Various security updates.
- Minor bug fixes.
- September 10, 2021
-
- Video resources are now available for RICOH Supervisor in the Ricoh Software Information Center. You can learn more about RICOH Supervisor functions and how to use them.
- September 2, 2021
-
- Added the funnel chart to the list of available widget types.
- Improved the sorting function available in pivot tables.
- Improved the upload diagnostic data function from RICOH Supervisor Data Collector. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed issues with dashboards that were not always exported in the correct language.
- Fixed issues with exporting widgets to an Excel file.
- Fixed styling issues in the Dashboards tab.
- Various security updates.
- Minor bug fixes.
- August 12, 2021
-
- Improved data privacy and security for the logs collected in RICOH Supervisor Data Collector. (Requires the new version of RICOH Supervisor Data Collector)
- Improved the deployment of software updates. Only certain functions, such as adding, editing, and deleting shifts and locations, uploading ink files, and deleting data collectors, are now disabled during the maintenance period.
- Various security updates.
- Minor bug fixes.
- July 22, 2021
-
- Improved the printer click data collected from RICOH TotalFlow Print Server printers. Data for black-and-white, full-color, and fifth station printer clicks is now available through JMF communication. (Requires the new version of RICOH Supervisor Data Collector)
- Improved the job event handling for TotalFlow Print Server printers. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed program shortcut issues that occurred when the RICOH Supervisor Data Collector installation language was Spanish. (Requires the new version of RICOH Supervisor Data Collector)
- Added messages that inform you that newly added shifts and locations are available in the Dashboards tab only after the next data refresh.
- Various security updates.
- Minor bug fixes.
- July 8, 2021
-
- Improved the authentication process for increased security.
If you encounter issues while accessing the application, clear the web browser cache and reload the page. See the web browser documentation for instructions on how to clear the cache and reload a page.
- Various security updates.
- Minor bug fixes.
- Improved the authentication process for increased security.
- July 1, 2021
-
- Improved the upload diagnostic data function. For increased security, you can now use this function only after you sign in to RICOH Supervisor Data Collector. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed data collection issues caused by restarting the RICOH Supervisor Data Collector service while RICOH Supervisor was under maintenance. (Requires the new version of RICOH Supervisor Data Collector)
- Improved overall connectivity for TotalFlow Print Server printers. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed incorrect time zone values displayed for InfoPrint 5000 printers in the Data Collectors tab after ink data uploads.
- Various security updates.
- Minor bug fixes.
- June 10, 2021
-
- Added support for tracking fifth station printer clicks from cut sheet printers. For more information, see Data Fields. (Requires the new version of RICOH Supervisor Data Collector)
- Added support for tracking scanner and copier clicks from cut sheet printers. For more information, see Data Fields. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed issues with sudden and incorrect increases in printer click values. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed issue where the Dashboards tab was not correctly displayed after closing the Widget Designer without saving the changes.
- Various security updates.
- Minor bug fixes.
- May 20, 2021
-
- Added the Serial Number setting. RICOH Supervisor Data Collector identifies the printer serial number based on the IP address or host name.
If a data source with that serial number was previously registered in the system, you can either create a new instance or resume tracking the previous data source and append future data to the existing historical data. (Requires the new version of RICOH Supervisor Data Collector)
- Improved the data available for printer errors and the jobs that were running when the errors occurred. The correlation between jobs and printer errors is currently available only for RICOH Fiery and RICOH GW cut sheet printers. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed issues with the timestamp provided in email notifications.
- Improved the styling of the information that is displayed when you hover over widget data.
- Various security updates.
- Minor bug fixes.
- Added the Serial Number setting. RICOH Supervisor Data Collector identifies the printer serial number based on the IP address or host name.
- April 29, 2021
-
- Improved the error information displayed on the printer cards from the Real Time Display tab. When several error codes are received from the printer at the same time, only the main error is displayed on the printer card. For more information, see Printer Status. (Requires RICOH Supervisor Data Collector version 1.1.0.701 or later)
- Applied the Continuous Timeline option in the default widgets that show data over time. Any missing dates are automatically added to the widget to create a continuous data flow and the data is sorted chronologically.
- Added Microsoft Edge based on Chromium 87 or later to the list of supported browsers. Updated the supported Google Chrome version to 87 or later and the Mozilla Firefox version to 83 or later.
- Improved the printer time zone identification. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed issue with negative values displayed for the error duration. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed issue with TotalFlow Print Server printers that did not automatically reconnect through JMF after they were restarted. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed issue with serial numbers that were not correctly retrieved from the printer. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed issue where the printer cards were not always visible after logging in to RICOH Supervisor Data Collector. (Requires the new version of RICOH Supervisor Data Collector)
- Various security updates.
- Minor bug fixes.
- April 8, 2021
-
- Added the Preset Name and Operator Name data fields for continuous form printers. For more information, see Data Fields. (Requires the new version of RICOH Supervisor Data Collector)
For printers that are already registered in the system, RICOH Supervisor Data Collector starts collecting preset data the next time there is a preset update and operator data the next time an operator logs in to the printer.
- Added the printer model and serial number in the Data Collectors tab.
- Fixed issues with printer character set values detected on the printer but not available in the default list from RICOH Supervisor Data Collector. The new values are now saved in the list. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed styling issues in the Filters panel from the Dashboards tab.
- Various security updates.
- Minor bug fixes.
- Added the Preset Name and Operator Name data fields for continuous form printers. For more information, see Data Fields. (Requires the new version of RICOH Supervisor Data Collector)
- March 18, 2021
-
- Added the Printer Error Sequence data field to improve error data accuracy when the printer sends multiple error codes
at the same time. For more information, see Data Fields. (Requires the new version of RICOH Supervisor Data Collector)
A Printer Error Sequence filter is now applied to the default widgets that show error data. When the printer sends several error codes at the same time, only the main error is included in the widget. This filter is especially useful when a main error state generates a sequence of other error states. For example, the
serviceRequestedandofflineerror codes are often received alongside the main error. The filter excludes theserviceRequestedandofflineerror codes when they overlap with the main error.All the errors collected with a RICOH Supervisor Data Collector version older than 1.1.0.669 are automatically assigned to the N\A error sequence value. Make sure that you include this value in the Printer Error Sequence filter if you want to view older data.
- Added support for adjusting the printer time zone based on daylight saving time. (Requires
the new version of RICOH Supervisor Data Collector)
After you install the latest version of RICOH Supervisor Data Collector, make sure that all the printers registered in the system have the correct time zone specified.
When you upgrade or restore printers from an older version of RICOH Supervisor Data Collector, the time zone of the data collector is automatically applied to all the printers that did not have a time zone specified. If necessary, you can edit the printer properties and select a different time zone.
- Improved the order of the values from the Printer Character Set list. The values are now ordered based on the character set code. (Requires the new version of RICOH Supervisor Data Collector)
- Various security updates.
- Minor bug fixes.
- Added the Printer Error Sequence data field to improve error data accuracy when the printer sends multiple error codes
at the same time. For more information, see Data Fields. (Requires the new version of RICOH Supervisor Data Collector)
- February 25, 2021
-
- Replaced the filters from the default dashboards with the Date Range filter. By default, the data displayed in the dashboards is now limited to the current quarter.
- Added support for uploading diagnostic data that can help troubleshoot problems in RICOH Supervisor Data Collector. (Requires the new version of RICOH Supervisor Data Collector)
- Added the Printer Character Set option for printers that use the Generic SNMP Printer, RICOH GW Cut Sheet Printer, or RICOH EFI Cut Sheet Printer configuration. RICOH Supervisor Data Collector uses the character set to process and display printer data and job data correctly.
(Requires the new version of RICOH Supervisor Data Collector)
After you upgrade or restore printers from an older version of RICOH Supervisor Data Collector, the Printer Character Set option is automatically set to Default - ISO-8859-1 - Western Alphabet for all the migrated printers, regardless of the printer settings. If necessary, you can edit the printer properties and select a different value.
- Improved the region selection in the RICOH Supervisor Data Collector installer. Troubleshooting information is now included for unreachable regions. (Requires the new version of RICOH Supervisor Data Collector)
- Ended support for RICOH Supervisor Data Collector version 1.0. Make sure that you upgrade to the latest available version. (Requires the new version of RICOH Supervisor Data Collector)
- Removed the Edit Widget View option that was available for dashboard viewers.
- Fixed styling issues in the Dashboards tab.
- Various security updates.
- Minor bug fixes.
- February 4, 2021
-
- Removed the Maintenance Window dialog box. From now on, a notification message will be displayed on the top banner before a software update that requires maintenance mode and is likely to cause service interruptions.
-
Replaced the Production Analytics dashboard with three new default dashboards: Capacity Planning (Impressions), Job Insights, and Printer Utilization. These dashboards include several new default widgets and filters. The new widgets are also available in the Widget library panel.
For more information, see Using the Sample Dashboards and Filters.
- Added the Analyze It option for widgets that show data over time. You can use this function to analyze trends in your data.
- Updated the dashboard sharing function. The Everyone group is no longer available. To share a dashboard with all the users registered on the company account, you can now enter the tenant ID displayed under .
- Removed the Hours option from time frame filters. Make sure that you recreate any filters that contain this option.
- Improved the RICOH Supervisor Data Collector logging mechanism. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed issue with the status displayed for TotalFlow Print Server cut sheet printers when the JMF communication was not working properly. The printer card now displays the Partial data transfer status when the printer is connected through SNMP but no JMF data is received. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed user permission issues when adding dashboard recipients in the Share dialog box.
- Fixed issue with missing historical data for users that changed the email address associated to their account.
- Fixed issue with assigned locations that were not immediately displayed in the list of printers from the Add Location and Edit Location dialog boxes.
- Improved the keyboard responsiveness in the Add Location and Edit Location dialog boxes.
- Various security updates.
- Minor bug fixes.
- January 14, 2021
-
- Improved the labels used for the dashboard sharing function. The available share options are now Share, Share Again, and Share Updates.
- Fixed disk space issues caused by large RICOH Supervisor Data Collector log files. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed issues with the error message displayed in printer notifications. When the printer does not provide an error message, the notification now displays "Unknown error". (Requires the new version of RICOH Supervisor Data Collector)
- Fixed data source and login issues that occurred when RICOH Supervisor Data Collector was installed on a virtual machine and the virtual machine was restarted or an older preset was restored. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed styling issues in the Filters panel from the Dashboards tab.
- Various security updates.
- Minor bug fixes.
- December 17, 2020
-
- Added a link to the list of new functions and fixes in the notification email for RICOH Supervisor Data Collector software updates.
- Improved the accuracy of data metrics collected when groups of jobs are submitted to a TotalFlow Print Server cut sheet printer. (Requires the new version of RICOH Supervisor Data Collector)
- Improved the processing and storing of printer events. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed issue with simplex printers that were sometimes incorrectly displayed as duplex after the RICOH Supervisor Data Collector service was restarted. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed widget alignment and styling issues in the Dashboards tab.
- Various security updates.
- Minor bug fixes.
- December 3, 2020
-
- Improved overall performance when working with dashboards, widgets, and filters.
- Added a setting that lets you distribute widgets evenly in a dashboard row.
- Included new configuration options for pie charts. You can now specify whether to group smaller slices into the Others slice or to display them individually. You can also specify whether to order the slices clockwise or counter clockwise based on category percentages or clockwise based on category name.
- Fixed issue with the column setting not being applied to a dashboard unless other layout changes were also applied.
- Fixed focus issues in dialog boxes across the user interface.
- Various security updates.
- Minor bug fixes.
- November 5, 2020
-
- Improved the upload function for InfoPrint 5000 ink data. For printers with simplex or dual-simplex configuration, you can now specify the engine the data is collected from.
- Improved the organization and processing of ink data fields for color continuous form
printers.
Make sure that you edit or recreate your custom widgets to include the new version of the data fields.
- Updated the list of supported operating systems for RICOH Supervisor Data Collector. Added support for Windows 8.1 and Windows Server 2019 and removed support for Windows 7 and Windows 8. For more information, see the RICOH Supervisor Data Collector documentation. (Requires the new version of RICOH Supervisor Data Collector)
- Improved the accuracy of data metrics for aborted jobs on continuous form printers. (Requires the new version of RICOH Supervisor Data Collector)
- Improved the accuracy of data metrics for jobs that were suspended and resumed on EFI Fiery printers. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed tracking issues for jobs that were submitted using the process and hold option on EFI Fiery printers. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed issues with the printer cards displayed for dual-simplex printers that were migrated from an older version of RICOH Supervisor Data Collector.
- Various security updates.
- Minor bug fixes.
- October 15, 2020
-
- Added support for collecting data from all the printer engines. For printers with
dual-simplex configuration, a separate printer card is displayed for each engine in
the Real Time Display tab. (Requires the new version of RICOH Supervisor Data Collector)
After you upgrade to the latest version of RICOH Supervisor Data Collector, in the Real Time Display tab from RICOH Supervisor, the printer cards for all existing dual-simplex printers are separated into two cards, one for each engine. All the initial data is displayed on the card for engine 1, while 0 is displayed on the card for engine 2 for all the data metrics. New data collected after the upgrade is tracked and displayed per engine.
- Added the Lifetime Printer Clicks data field for cut sheet printers. You can now track the total number of clicks registered
since the first use of the printer. (Requires the new version of RICOH Supervisor Data Collector)
After you upgrade to the latest version of RICOH Supervisor Data Collector, the Lifetime Printer Clicks value for existing printers is initially 0 and updates to the correct value only after the next click is registered on the printer.
- Updated the supported web browser versions to Mozilla Firefox 77 or later and Google Chrome 83 or later.
- Improved the accuracy of printed impressions data for continuous form printers. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed issues with missing historical data after changing the email address associated with the user account.
- Fixed issues with the message displayed when a new version of RICOH Supervisor Data Collector is available. (Requires the new version of RICOH Supervisor Data Collector)
- Various security updates.
- Minor bug fixes.
- Added support for collecting data from all the printer engines. For printers with
dual-simplex configuration, a separate printer card is displayed for each engine in
the Real Time Display tab. (Requires the new version of RICOH Supervisor Data Collector)
- September 24, 2020
-
- Fixed printer status issues that occurred after the RICOH Supervisor Data Collector service was stopped and restarted. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed connectivity issues with TotalFlow Print Server printers when HTTPS was enabled for RICOH Supervisor Data Collector. (Requires the new version of RICOH Supervisor Data Collector)
- Various security updates.
- Minor bug fixes.
- September 3, 2020
-
- Added direct links to the full list of computer requirements on the pages that let you download RICOH Supervisor Data Collector.
- Added support for enabling HTTPS to secure the communication between the RICOH Supervisor Data Collector server and the web browser user interface. For more information, see the RICOH Supervisor Data Collector documentation. (Requires the new version of RICOH Supervisor Data Collector)
- Improved the user experience for associating shifts with locations.
- Fixed issue with scroll bar that was not always visible when viewing the widgets in a dashboard.
- Fixed display issues for job names with special characters. (Requires the new version of RICOH Supervisor Data Collector)
- Various security updates.
- Minor bug fixes.
- August 13, 2020
-
- Added support for several printers. For more information, see the RICOH Supervisor Data Collector documentation. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed issue with duplicated jobs in widgets that also included printing side information.
- Fixed incorrect paper length values in downloaded dashboard reports.
- Fixed issue with time filters that automatically switched to calendar filters when they were edited.
- Various security updates.
- Minor bug fixes.
- July 30, 2020
-
- Improved the ink usage data retrieved from RICOH Pro VC printers. Ink data is now also available for engine 2. (Requires the new version of RICOH Supervisor Data Collector)
- Improved the measurement unit conversion for paper length. In widgets, the measurement unit used for data metrics based on the length of paper printed, such as throughput for continuous form printers, is now updated automatically based on the Length unit option specified under .
- Improved the accuracy of printed copies data for continuous form printers. (Requires the new version of RICOH Supervisor Data Collector)
- Improved the sorting function across all user interface areas.
- Fixed styling issues for focused input fields on Google Chrome.
- Various security updates.
- Minor bug fixes.
- July 2, 2020
-
- Added the Printer Engine data field for error tracking. You can now view errors by printer engine.
- Fixed loading and styling issues for calendar widgets.
- Fixed display issues for the Toggle widgets and Toggle filters buttons on the Dashboards tab.
- Fixed filter issues for duplicated dashboards.
- Fixed issue with the first data collector created on an account being visible in RICOH Supervisor only after the web browser page was refreshed.
- Various security updates.
- Minor bug fixes.
- June 11, 2020
-
- Improved the shift configuration function. You can now create shifts that extend to the following day.
- Improved the validation of the time interval set for a shift.
- Fixed issues with reporting shift data on Sundays.
- Fixed sorting and styling issues in the Add Location and Edit Location dialog boxes.
- Improved filtering precision when searching for events in logs. (Requires the new version of RICOH Supervisor Data Collector)
- More information is displayed on the printer cards. Now you can see the printer type on each printer card from the Printers page. (Requires the new version of RICOH Supervisor Data Collector)
- Various security updates.
- Minor bug fixes.
- May 21, 2020
-
- Added support for configuring locations. You can group your printers by location in the Settings tab and use the locations for filtering data.
- Added support for configuring shifts. Record your shifts in the Settings tab and then use them for comparisons and data filtering.
- Improved the processing and presentation of time-related data. All the time-related data from the Dashboards tab is now displayed in the printer time zone set in RICOH Supervisor Data Collector. For time intervals, such as today or this week, the data is selected based on the time zone of the web browser that accesses RICOH Supervisor.
- Fixed styling issues for pivot tables displayed on multiple pages.
- Added information about how to reach technical support in the Troubleshooting and Support section.
- You can now reset your user account password from the RICOH Supervisor Data Collector sign-in page. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed issues with data for reprinted jobs. (Requires the new version of RICOH Supervisor Data Collector)
- Various security updates.
- Minor bug fixes.
- April 30, 2020
-
- Improved the data provided for job metrics. All the job metrics, including copies, impressions, pages, paper length, and sheets, now display printed values.
- Included label updates for most data fields and data field sections to make it easier to create and filter widgets. For the current list of data fields, see Data Fields.
- Added the Job Start Time and Job End Time data fields.
- Added the Not Available printing side value for printers that do not provide accurate printing side information, such as TotalFlow Print Server cut sheet printers.
- Updated the names of the default widgets for ink usage per job and ink usage per printer to JOB INK USAGE - THIS WEEK (TOP 1000) and PRINTER INK USAGE - THIS MONTH (TOP 30), so they are more descriptive.
- Improved the information about event time. Event logs now contain a timestamp corresponding to the printer time zone. This update applies to both cut sheet and continuous form printers. (Requires the new version of RICOH Supervisor Data Collector)
- Improved the login experience in RICOH Supervisor Data Collector. The email field is no longer case-sensitive. (Requires the new version of RICOH Supervisor Data Collector)
- Various security updates.
- Minor bug fixes.
- April 9, 2020
-
- Introduced a new version of the help system with design and functionality improvements. For easier access, the RICOH Supervisor Data Collector documentation is now also available directly from the RICOH Supervisor help page.
- Improved the caching mechanism to ensure that the user interface always displays the latest updates.
- Improved the upload function for InfoPrint 5000 ink data to support files with special characters.
- Improved styling in the Widget Designer.
- Improved the accuracy of the job information collected from cut sheet printers. The data collectors can now receive accurate information about jobs, sheets, and impressions when groups of jobs are submitted. (Requires the new version of RICOH Supervisor Data Collector)
- Improved communication between RICOH Supervisor Data Collector and printers with TotalFlow Print Server controller. RICOH Supervisor Data Collector now displays a warning message when the registration on the printer fails. (Requires the new version of RICOH Supervisor Data Collector)
- March 19, 2020
-
- Added support for tracking ink usage for InfoPrint 5000 continuous form printers. Simply upload ink data for each printer on the Data Collectors tab. (Requires the new version of RICOH Supervisor Data Collector)
- Included new default widgets and data fields for tracking ink usage for InfoPrint 5000 and RICOH Pro VC printers.
- Fixed issues with disconnected data sources after the RICOH Supervisor Data Collector service was stopped and restarted. (Requires the new version of RICOH Supervisor Data Collector)
- Enhanced the connection between RICOH Supervisor Data Collector and the data recipients by improving the communication routine of the data collectors. (Requires the new version of RICOH Supervisor Data Collector)
- Improved interface communication by replacing the messages received from SNMP with custom messages that match with the RICOH Productivity Tracker messages. (Requires the new version of RICOH Supervisor Data Collector)
- Improved the accuracy of the job information collected from cut sheet printers. The data collectors can now receive accurate information about total sheets, total pages, and total impressions for aborted jobs. (Requires the new version of RICOH Supervisor Data Collector)
- February 27, 2020
-
- Added the time zone setting for data sources. After the time zone is set in RICOH Supervisor Data Collector, it is displayed on the Data Collectors tab. (Requires the new version of RICOH Supervisor Data Collector)
- Added another printer type in RICOH Supervisor Data Collector. You can now collect job data from cut sheet printers with TotalFlow Print Server controller. (Requires the new version of RICOH Supervisor Data Collector)
- Improved the scanning for printers function in RICOH Supervisor Data Collector. You can now see which printers are already registered in the system for the specified IP range. (Requires the new version of RICOH Supervisor Data Collector)
- Fixed issues with notifications for available software updates.
- Fixed issues with dashboard filters that were sometimes removed after the web browser page was refreshed.
- Fixed issues with the data collector delete function during the maintenance period.
- February 6, 2020
-
- Improved the status information from the Data Collectors tab so it correctly displays the last time a connection was established with a data source.
- Fixed issues with truncated dialog boxes in the Widget Designer.
- Fixed issues with duplicated widgets in the Widget library panel.
- Improved the accuracy of printed jobs information for printers that use RICOH GW controllers. The events for the first job printed after the printer is restarted are now captured correctly. (Requires the new version of RICOH Supervisor Data Collector)
- January 16, 2020
-
- Added an easy way for providing direct feedback. You can now submit your own ideas for improving the application directly from the RICOH Supervisor menu bar.
- Improved the accuracy of click data from printers with EFI Fiery controllers.
- Improved the appearance of data on the real-time printer cards.
- Enhanced security for database communication and data transfer.
- Fixed issues with incorrect data in the JOBS PRINTED TODAY widget.
- Fixed issues with incorrect job names displayed on the real-time printer cards. (Requires the new version of RICOH Supervisor Data Collector)
For common problems and possible solutions, see Troubleshooting and Support.
1.1.2 Frequently Asked Questions: New Dashboard Capabilities
Dashboards
- What are the new dashboards?
- You can access the sample dashboards from the Dashboards tab. In the sample dashboards you can export the visuals to CSV, view summary data or apply filters.
- With the Self-Service feature, you can create new dashboards. To create a dashboard, you must first create a data analysis with all the visuals and configurations that you want to include. You can then publish the analysis as a read-only dashboard that can be accessed from the Dashboards tab.
- What are analyses?
- A data analysis is the basic workspace for creating data visualizations, which are graphical representations of your data. Each analysis is a collection of visuals that you arrange and customize.
- You analyze and visualize your data in an analysis. You can create a new analysis and customize it according to your needs by editing, renaming or deleting it.
- An analysis can contain multiple sheets. A sheet is a set of visuals that are viewed together in a single page.
- You can publish analyses as read-only dashboards that you can access from the Dashboards tab.
Features and Functionality
- What are the key features?
- You analyze and visualize your data in an analysis. You can create a new analysis and customize it according to your needs by editing, renaming or deleting it.
- You can then publish the analysis as a read-only dashboard that can be accessed from the Dashboards tab.
- You can choose from a variety of options to format and style your data visualizations.
- A visual is a graphical representation of your data. You can add a wide variety of visuals to an analysis, using different types of charts and custom elements.
- To create the visual, you can select the data fields and use AutoGraph to automatically determine the most appropriate visual type. Or you can select a specific visual type and choose fields to populate it.
- You can sort an axis ascending or descending by a data field within a visual.
- You can embed custom content, such as images, online forms, webpages, and online videos, in an analysis.
- You can display the visuals in full-screen view.
- You can create analyses and dashboards with multiple sheets and set up drill-downs. A sheet is a set of visuals that are viewed together in a single page.
- You can add more filtering and other parameters to allow viewers of the dashboard to customize and interact more with their view.
- When will the new features be available?
- The new features will be available end of 2024.
- How do the new dashboards differ from the current ones?
- In the sample dashboards you can export data to CSV, view summary data or apply filters.
- The new dashboards can no longer be edited with the Self-Service feature. To create or edit a dashboard, you must first create or edit a data analysis and publish it.
- You can duplicate and rename existing dashboards.
- How do I use the new features?
- In the sample dashboards you can export data, view summary data or apply filters directly from the Dashboards tab.
- All the dashboards that you created and the dashboards that were shared with you are displayed in the Dashboards list on the Dashboards tab. You can select a dashboard in the list to view it in the workspace.
- To create a new analysis, you can add a wide variety of visuals to an analysis, using different types of charts and custom elements.
- You can create a range of visual types to help you explore and better understand your data. You select the chart type, specify the data that you want to include in the visual, and customize its appearance.
- Where can I find tutorials or guides for the new features?
- You will be able to read about the new features in RICOH Supervisor documentation.
- A series of video presentations of the new functions will be available end of 2024.
1.1.3 RICOH Supervisor User Interface
You can access the user interface from a supported web browser. For information on the supported web browsers and the minimum requirements, see Computer Requirements.
The user interface consists of these areas:
-
Banner for account and user management, notifications, and help access.
-
Dashboards tab for filtering, viewing, and downloading collected data.
-
Dashboards tab [New] for viewing and analyzing the data provided by your data collectors and software connectors.
-
Real Time Display tab for monitoring printer status and performance.
-
Data Collectors tab for configuring data collectors and software connectors.
-
Settings tab for configuring user preferences, notifications, locations, and shifts.
1.1.3.1 Banner
Click the banner items to open the list of available options.
1.1.3.2 Dashboards Tab [New]
Dashboards are a collection of visuals, which are graphical representations for the data provided by your data sources. To create a dashboard, you must first create a data analysis with all the visuals and configurations that you want to include. You can then publish the analysis as a read-only dashboard that can be accessed from the Dashboards tab.
You can retrieve data directly from your printers using RICOH Supervisor Data Collector. If you have the RICOH ProcessDirector™ feature, you can also receive data from RICOH ProcessDirector through data transmitters. To purchase the RICOH ProcessDirector feature, contact your Ricoh representative.
1.1.3.3 Real Time Display Tab
The information is displayed on individual printer cards. You can group the printer cards and specify how the data is displayed.
A full-screen mode is also available.
The data displayed in the Real Time Display tab is updated every 1 to 2 minutes.
1.1.3.4 Data Collectors Tab
The data collectors provide usage statistics and status information for your printers. The collected data is then displayed on the printer cards from the Real Time Display tab and on the Dashboards tab, based on your filters and display options.
If you have the RICOH ProcessDirector feature, you can also view information on available RICOH ProcessDirector data transmitters. To purchase the RICOH ProcessDirector feature, contact your Ricoh representative.
The data received from the RICOH ProcessDirector data transmitters is available on the Dashboards tab.
1.1.3.5 Settings Tab
In the User Preferences panel, you can set preferences for your user.
In the Notifications panel, you can set notifications for data collectors, software updates, low printer consumables, printer errors, and idle status.
In the Locations panel, you can group your printers by location. You can then use the locations for filtering data.
In the Shifts panel, you can record your work shifts. Shifts are useful for performance comparisons and for setting target metrics.
1.1.4 Notices
1.1.4.1 Important
To the maximum extent permitted by applicable laws, in no event will the manufacturer be liable for any damages whatsoever arising out of failures of this product, losses of documents or data, or the use of this product and operation manuals provided with it.
Make sure that you always copy or have backups of important documents or data. Documents or data might be erased due to your operational errors or malfunctions of the machine. Also, you are responsible for taking protective measures against computer viruses, worms, and other harmful software.
In no event will the manufacturer be responsible for any documents created by you using this product or any results from the data executed by you.
Do not remove or insert any disk while operating this application.
1.1.4.2 Cautions Regarding This Guide
- Some illustrations or explanations in this guide may differ from your application due to improvement or change in the application.
- The contents of this document are subject to change without notice.
- No part of this document may be duplicated, replicated, reproduced in any form, modified or quoted without prior consent of the manufacturer.
1.1.4.3 Trademarks
RICOH Supervisor is a trademark of Ricoh Company, Ltd. in the United States, other countries, or both.
The EFI logo, Electronics For Imaging, Fiery, and the Fiery logo are registered trademarks of Electronics for Imaging, Inc. in the U.S. and/or certain other countries. EFI is a trademark of Electronics for Imaging, Inc. in the U.S. and/or certain other countries.
Google Chrome and Chromium are trademarks of Google LLC.
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
JavaScript is a trademark of Oracle Corporation in the United States.
Linux is the registered trademark of Linus Torvalds in the U.S. and other countries.
Microsoft, Windows, Windows Server, Microsoft Edge, and Excel are registered trademarks of Microsoft Corporation in the United States and/or other countries.
Mozilla and Firefox are trademarks of the Mozilla Foundation in the U.S. and other countries.
openSUSE is a registered trademark of SUSE LLC in the United States and other countries.
Red Hat, Red Hat Enterprise Linux, and Fedora are registered trademarks of Red Hat, Inc. or its subsidiaries in the United States and other countries.
RICOH ProcessDirector is a trademark of Ricoh Company, Ltd. in the United States, other countries, or both.
Ubuntu is a registered trademark of Canonical Ltd.
Other product names used herein are for identification purposes only and might be trademarks of their respective companies. We disclaim any and all rights to those marks.
1.2 Getting Started with RICOH Supervisor
1.2.1 Computer Requirements
| Item | Requirements |
|---|---|
| Web browser |
|
| Display | 1024 x 768 pixels or higher |
| Network | Access to the target server by referring to the IP address or DNS host name. |
| Supported languages | Dutch, English, French, German, Italian, Japanese, Spanish |
1.2.2 Signing In
- Open a web browser window.
- Enter this URL in the address bar:
- For the United States: https://supervisor.app-ricohsoftware.com
- For Europe: https://supervisor.app-ricohsoftware.eu
- On the sign-in page, enter your email address and password and click Sign in.
The password is case-sensitive.
Note: If you forgot your password, click Forgot password and follow the required steps. After you provide the email address for your account, you receive a verification code for resetting the password.
1.2.3 Downloading and Installing RICOH Supervisor Data Collector
- On the Install Data Collector to Get Printer Data page, prepare to install RICOH Supervisor Data Collector to connect to your printer and click Next.
- Check the computer requirements and click Next.
- Check the ports that you need to open and click Next.
- Check the URLs that need to be whitelisted from your firewall in order to be accessible
for the data collector. Click Next.
- On the Download & Install Data Collector page, click Download Data Collector for Windows or click here for Linux.
- Save the installation file to your computer.The procedure for saving the file depends on the web browser.
- Launch the installer as an administrator on a Windows system or as root on a Linux system.
- When the installer is displayed, select a language and click OK.
- In the Welcome dialog box, click Next.
- In the License Agreement dialog box:
- Read the license agreement.
- Click I accept the terms of the License Agreement.
- Click Next.
- In the Install Folder dialog box:
- If you want to change the default installation folder, click Choose.... Go to the folder where you want to install RICOH Supervisor Data Collector and click OK.
- Click Next.
- Note:
- If you want to restore the default installation folder, click Restore Default Folder.
- Make sure that the installation path for RICOH Supervisor Data Collector contains only characters from the same code page as the operating system.
- Make sure that the specified installation location contains the recommended disk space for installing and running RICOH Supervisor Data Collector.
- On Linux, the default installation location,
/opt/RICOH/DataCollector, cannot be changed.
- In the Shortcut Folder dialog box:
- Specify where you want to create the product icons.
- Click Next.
- In the Proxy Settings dialog box:
- Review and update the information, if necessary. The installer attempts to detect automatically your system proxy configuration.
- Click Next.
- In the Choose Region dialog box:
- Select the region where the data gets stored.If your region is unreachable, make sure that the proxy or firewall settings do not block access to the region URL:
- United States:
https://datacollector.app-ricohsoftware.com/account-details.json - Europe:
https://datacollector.app-ricohsoftware.eu/account-details.json
- United States:
- Click Next.
- Select the region where the data gets stored.
- In the Configure ports dialog box:
- Enter the port numbers for the RICOH Supervisor Data Collector web server and the database server. You can change the default port number if you are already using the port.
- Click Next.
- In the Summary dialog box:
- Review the information you provided.
- To go back and edit the information you provided, click Previous.
- To proceed, click Install.
- After the installation is complete, select the Open RICOH Supervisor Data Collector check box to open the application.
- Click Done to close the installer.
1.2.4 Downloading and Installing RICOH Supervisor Data Collector with Command Line
- On the Install Data Collector to Get Printer Data page, prepare to install RICOH Supervisor Data Collector to connect to your printer and click Next.
- Check the computer requirements and click Next.
- Check the ports that you need to open and click Next.
- Check the URLs that need to be whitelisted from your firewall in order to be accessible
for the data collector. Click Next.
- On the Download & Install Data Collector page, click Download Data Collector for Windows or click here for Linux.
- Save the installation file to your computer.The procedure for saving the file depends on the web browser.
- Open a command prompt.
- Launch the installer as an administrator on a Windows system or as root on a Linux
system, using the command line option:
INSTALLER -i silent -DC_REGION={USA|Europe} [-DC_PROXY_ADDR=<proxyAddress> -DC_PROXY_PORT=<proxyPort> -DC_PROXY_USER=<proxyUser> -DC_PROXY_PWD=<proxyPassword>] [-DC_SERVER_PORT=<serverPort>] [-DC_DB_PORT=<dbPort>] [-DC_RESTART_SYSTEM={true|false}] [-DUSER_SHORTCUTS=<userShortcuts>]Command Line Options
Command Line Options Mandatory Optional Details Values Default Values -DC_REGION Yes No Available regions USA/Europe N/A -DC_PROXY_ADDR No Yes Proxy server N/A System proxy settings -DC_PROXY_PORT No Yes Proxy port N/A System proxy settings -DC_PROXY_USER No Yes Proxy username N/A N/A -DC_PROXY_PWD No Yes Proxy password N/A N/A -DC_SERVER_PORT No Yes Web server port N/A 19280 -DC_DB_PORT No Yes Database server port N/A 19293 -DUSER_SHORTCUTS No Yes Shortcuts location N/A Desktop (Windows)
Home directory (Linux)
-DC_RESTART_SYSTEM No Yes Restart system after installation true/false false - Note:
- The commands do not prompt for input when run from the command line.
- After the command line installation, it takes approximately 2 minutes for RICOH Supervisor Data Collector to become functional.
- If you use the sudo command when launching the installer on a Linux system, the proxy settings (if not specified)
default to the system proxy settings only if the -E option is specified:
sudo INSTALLER -E -i silent -DC_REGION={USA|Europe} [-DC_PROXY_ADDR=<proxyAddress> -DC_PROXY_PORT=<proxyPort> -DC_PROXY_USER=<proxyUser> -DC_PROXY_PWD=<proxyPassword>] [-DC_SERVER_PORT=<serverPort>] [-DC_DB_PORT=<dbPort>] [-DC_RESTART_SYSTEM={true|false}] [-DUSER_SHORTCUTS=<userShortcuts>]
1.2.5 Signing Out
- On the banner, click
, the Account button. - Click Sign out.
1.3 Configuration
Important: The configuration options you see on the user interface and the actions that you can perform depend on your user role. Roles can restrict access to certain user interface areas or limit the available actions.
For more information, see Users and Roles.
1.3.1 Configuring Account and User Settings
- On the banner, click , the Account button.
- Select one of the available account management options:
- To view or edit your account details, click Account details.
- To view information about your subscription, click Subscription.
- To manage users and user settings, click Users.
- In RICOH Account Administration, view and update the settings as necessary.
1.3.2 Configuring Profile Settings
- On the banner, click , the Account button.
- Click Profile Settings.
- In the Profile Settings panel, update your profile information, password, or preferences as necessary:
- To edit your user profile information, click DETAILS. Make the required changes and click Update details.
- To change your password, click PASSWORD. Enter your current password, enter and confirm the new password, and then click
Change password.
The new password must meet all the security requirements.
- To edit your user preferences, click PREFERENCES. Make the required changes and click Update settings.
For details about a specific setting, click the
button to display the on-screen field help.
1.3.3 Configuring Data Collectors
1.3.3.1 Downloading Data Collectors
- Click
, the Data Collectors tab. - Click
, the Download Data Collector button, next to Data Collectors.
- In the Welcome to RICOH Supervisor dialog box, click Download Data Collector in the section that corresponds to your operating system.
Note: Make sure that you have one of the supported operating system versions. - Save the installation file to your computer.The procedure for saving the file depends on the web browser.
- To launch the installer, run the downloaded installation file.
- Follow the required installation steps.
1.3.3.2 Viewing Data Collector Information
- Click , the Data Collectors tab.
- Select the data collector that you want to view in the Data Collectors list.
- Look at the information displayed in the panel on the right.
The following information is available:
- IP Address
- The IP address of the data collector. Click the link to open RICOH Supervisor Data Collector and access the data collector page.
- Communication Status
- The communication status between the data collector and the cloud.
- Connected: The data collector can communicate with the cloud.
- Not connected: The data collector cannot communicate with the cloud. Verify the network settings and fix any connectivity issues.
- Current Version/ Update
- The installed software version and the updates available for download.
- Total Data Sources
- The total number of data sources.
The data source table lists the data sources configured for the data collector and includes the following information:
- Data Source
- The name set for the data source in RICOH Supervisor Data Collector.
- Connection Status
- The connection status of the data source.
- Connected: All the communication channels are gathering and transferring data.
- Partial data transfer: One or more configured communication channels are not transferring data.
- Waiting for data: The connection with the communication channels is being established and there is no data transfer yet. Wait for the connection to be established or go to the data collector and make sure that there are no connectivity issues.
- Not configured: No communication channels are configured for the data source. Go to the data collector and configure at least one supported communication channel.
- Not connected: The communication channels cannot communicate with the data source and there is no data transfer. Go to the data collector, verify the data source settings and the network settings, and fix any connectivity issues.
- Not available: Cannot communicate with the data collector to retrieve data source information. Verify the network settings and fix any connectivity issues.
- Last Connection
- The last time a connection was established with the data source.
- Serial Number
- The serial number of the printer registered as a data source.
- Model
- The model of the printer registered as a data source.
- Data Source Time Zone
- The time zone of the data source based on the time zone and daylight saving adjustment
settings configured in RICOH Supervisor Data Collector.
If the Data Source Time Zone setting is displayed as Not set, go to RICOH Supervisor Data Collector and specify a time zone for the data source. Make sure that the latest version of RICOH Supervisor Data Collector is installed.
Note: To sort the list of data sources in ascending or descending order according to a column, click the column heading.
1.3.3.3 Updating Data Collectors
- Click , the Data Collectors tab.
- Select the data collector that you want to update in the Data Collectors list.
- In the data collector information panel, click
, the Download Data Collector button, under Update.
The Download Data Collector button is active only when a software update is available.
- Save the installation file to your computer.The procedure for saving the file depends on the web browser.
- To launch the installer, run the downloaded installation file on the system where RICOH Supervisor Data Collector is installed.
- Follow the required installation steps.
1.3.3.4 Changing Data Collector Settings
- Click , the Data Collectors tab.
- In the Data Collectors list, select the data collector that you want to edit.
- In the data collector information panel, click the IP address of the data collector to open RICOH Supervisor Data Collector and access the data collector page.
- In RICOH Supervisor Data Collector, change the data collector settings as necessary.For more information, see the RICOH Supervisor Data Collector documentation.
1.3.3.5 Deleting Data Collectors
- Click , the Data Collectors tab.
- Select the data collector that you want to delete in the Data Collectors list.
- In the data collector information panel, click Delete....
Note: You can delete only data collectors that are not connected. - In the confirmation dialog box, enter the name of the data collector that you want
to delete and click OK.When you delete a data collector, all the associated data sources are also deleted. If you only want to delete individual data sources, you must use RICOH Supervisor Data Collector. For more information, see the RICOH Supervisor Data Collector documentation.
1.3.3.6 Uploading Ink Data for InfoPrint 5000 Printers
- On the InfoPrint 5000 printer, export the ink usage data as a CSV file.For more information on exporting ink data, see the printer documentation.
- In RICOH Supervisor, click , the Data Collectors tab.
- Select the data collector where the printer is registered in the Data Collectors list.
- Find the printer in the data source list and click
, the Upload CSV Ink File... button.
The Upload CSV Ink File... button is active for all printer states.
- In the file upload dialog box, upload the CSV file with ink data exported from the
printer.The procedure for uploading the file depends on the web browser.
- In the Confirm File Upload dialog box, click Continue to confirm the data upload.Important: Make sure that you select the correct ink data file. Once the file is uploaded, you cannot delete the data or undo the upload action.
- If you are uploading an ink data file from a printer with simplex or dual-simplex
configuration, specify the engine the file is collected from in the Select Engine dialog box and click Continue.
For better accuracy in tracking ink data, make sure that you select the correct engine based on the printer configuration.
- Verify the result of the data upload and validation:
- If the upload and validation were successful, the upload complete icon
is displayed, along with the name of the uploaded file and the date and time of submission. - If the upload and validation failed, the upload failed icon
is displayed, along with the name of the selected file, the date and time of submission,
and the error message.
Fix the issues reported in the error message and try uploading the file again. If the file does not correspond to the format and structure requirements, try exporting it again from the printer.
- If the upload and validation were successful, the upload complete icon
After the ink data file is uploaded successfully, it might take up to 30 minutes for the data to be available in your dashboards.
You can repeat the procedure as often as necessary to upload new ink data exported from the printer. To avoid losing data, make sure that you export the ink data file periodically. Once the maximum number of records is reached, the printer overrides older data. The maximum number of records depends on the printer usage but we recommend exporting a new ink data file at least every 5000 jobs.
1.3.4 Configuring Software Connectors
1.3.4.1 Configuring the RICOH ProcessDirector Software Connector
- Note:
- This function is only available with the RICOH ProcessDirector feature. If you want to purchase this feature, contact your Ricoh representative.
In your firewall, you must open Port 443 on the computer that RICOH ProcessDirector is installed on. This will allow RICOH Supervisor to access the data stored in the RICOH ProcessDirector reports database.
To check the latest port number, see the RICOH ProcessDirector documentation, RICOH ProcessDirector Configuring to use Reports.
To configure the RICOH ProcessDirector software connector, see the RICOH ProcessDirector documentation, RICOH ProcessDirector Configuring to use Reports.1.3.4.2 Viewing RICOH ProcessDirector Data Transmitters
- Note:
- This function is only available with the RICOH ProcessDirector feature. If you want to purchase this feature, contact your Ricoh representative.
- Click , the Data Collectors tab.
- Select the software connector that you want to view in the SOFTWARE CONNECTORS list.
- Look at the information displayed in the panel on the right.
The following information is available:
- Transmitter Status
- The communication status of the data transmitter.
- The data transmitter is ready to send data at the next scheduled time.
- The data transmitter is not ready to send data.
- Next scheduled update
- The date and time scheduled for the next update.
- Total data received
- The total size of data received.
The data table for the software connectors includes the following information:
- Tables
- The names of the RICOH ProcessDirector database tables that send data through this transmitter.
- Last upload size
- The size of the last data upload.
- Last data received
- The date and time of the last successful data upload.
- Status description
- The status of the RICOH ProcessDirector data upload.
- On schedule: The most recent transmission arrived on schedule.
- Schedule missed: The most recent transmission did not arrive on schedule.
- Inactive: A table that was previously sent by this transmitter is not being uploaded anymore.
- No data received: No data was received in the last transmission. The data collector for the table is disabled or the data table is not selected to be sent in the RICOH ProcessDirector transmitter.
1.3.5 Configuring Account Settings
- Click
, the Settings tab. - On the Settings tab, click Account Settings.
- In the Account Settings panel, configure the available settings.
- Note:
- Usually, a fiscal year runs from January 1 to December 31, but you can also opt to use a different 12-month period. (Example: FY2024 may run from April 1, 2023, to March 30, 2024.)
- To define your fiscal year, select a different calendar month with which your fiscal year starts.
For details about a specific setting, click the
button to display the on-screen field help.
1.3.6 Configuring User Preferences
- Note:
- User preferences are available only when data is received from RICOH Supervisor Data Collector.
- Click , the Settings tab.
- On the Settings tab, click User Preferences.
- In the User Preferences panel, configure the available settings.
For details about a specific setting, click the
button to display the on-screen field help.
1.3.7 Configuring Notifications
- Note:
- Notifications are available only when RICOH Supervisor Data Collector is installed. For printer notifications, printers must also be registered in RICOH Supervisor Data Collector
- Important:
- The notifications for low printer consumables are supported only for cut sheet printers.
The specific toner, ink, or paper levels included in the notification messages are based on the information available from the printer.
- The notifications for available RICOH Supervisor Data Collector software updates are sent when at least one of your data collectors has a version that is older than the latest version.
1.3.7.1 Viewing Notifications
- Note:
- Only notifications that are set to be viewed in the application are displayed. Notifications that are only sent to an email address can be accessed from the associated email inbox. For more information on notification settings, see Editing Notifications.
- Only the notifications configured for the current user are displayed.
- On the banner, click
, the Notifications button. - Look at the list of events in the Notifications panel.
- To dismiss all the notifications, click Dismiss all.The notifications are still kept in the log and can be viewed in the Notifications History panel.
- To view older notifications, click
, the Notifications History button.
The Notifications History table lists the notifications in reverse chronological order and includes this information:
- Notification: The text of the message.
- Date & Time: The date and time when the notification was sent.
- Type: The type of notification. For example, the notification can contain information about data collector connectivity, printer connectivity and status, printer consumables, or software updates.
- Specific devices: The specific device that prompted the notification.
The notifications are kept in the log for 1 year.
1.3.7.2 Editing Notifications
- Click , the Settings tab.
- On the Settings tab, click Notifications.
- In the Notifications panel, click
, the Edit button, next to the notification that you want to edit.
Note: You can also click the notification name to start editing it. - Modify the notification settings in the Edit Notification dialog box.
The available options depend on the notification type.
For details about a specific setting, click the
button to display the on-screen field help. - Click OK.
1.3.7.3 Enabling and Disabling Notifications
- Click , the Settings tab.
- On the Settings tab, click Notifications.
- In the Notifications panel, turn the switch on or off to enable or disable a notification.
- Note:
- Click the switch to turn it on and off.
- The switch is on when the circle is positioned to the right and the background is green. The switch is off when the circle is to the left and the background is gray.
1.3.8 Configuring Locations
- Note:
- Locations are available only when RICOH Supervisor Data Collector is installed and has registered printers.
1.3.8.1 Adding Locations
- Click , the Settings tab.
- On the Settings tab, click Locations.
- In the Locations panel, click Add Location.
- Specify the location settings in the Add Location dialog box.
Specify the location name and select the printers that you want to associate with the location. You can select multiple printers for the location but a printer can belong to only one location.
You can also add a description with useful information about the location.
For details about a specific setting, click the
button to display the on-screen field help. - Click Save & close.If you want to add a new location immediately, click Save & add more.
Newly added locations are available in the Dashboards tab after the next data refresh.
A location is displayed in visuals and filters only if it contains at least one printer and if data is available from the printers assigned to the location. If the location is associated with a shift, data must be available for the time interval covered by the shift.
1.3.8.2 Editing Locations
- Click , the Settings tab.
- On the Settings tab, click Locations.
- In the Locations panel, click
, the Options button, next to the location that you want to edit and select Edit.
Note: You can also click the location name to start editing it. - Modify the location settings in the Edit Location dialog box.
For details about a specific setting, click the
button to display the on-screen field help. - Click OK.
1.3.8.3 Deleting Locations
- Click , the Settings tab.
- On the Settings tab, click Locations.
- In the Locations panel, click , the Options button, next to the location that you want to remove and select Delete.
- In the confirmation dialog box, click Delete.
When you delete a location, the location is removed from the database and is no longer available for visuals and filters. Make sure that you remove or recreate any visuals or filters that included the deleted location.
1.3.9 Configuring Shifts
- Important:
-
Data is assigned to a shift based on the printers included in the shift location and the printer time zone set in RICOH Supervisor Data Collector. If a shift does not have a location specified, it applies to all the printers available in the system.
-
All the job data collected in the time interval covered by a shift is assigned to that shift, even if the job started printing or finished printing outside the shift interval.
-
Shifts apply only to printers that are currently registered in RICOH Supervisor Data Collector.
-
To display your data correctly in dashboards and analyses, shifts for a given location must not overlap.
1.3.9.1 Adding Shifts
- Click , the Settings tab.
- On the Settings tab, click Shifts.
- In the Shifts panel, click Add Shift.
- Specify the shift settings in the Add Shift dialog box.
Specify the shift name and locations.
Then, select the days of the week covered by the shift and set the times when the shift starts and ends. To apply the settings set for the first day of the week to all the following days, click Apply to all.
- Note:
- Shifts can extend to the following day but cannot cover more than 24 hours.
- A shift cannot include overlapping time periods.
- To display your data correctly in dashboards and analyses, shifts for a given location must not overlap.
For details about a specific setting, click the
button to display the on-screen field help. - Click Save & close.
If you want to add a new shift immediately, click Save & add more.
Once a shift is created, it is listed in the Shifts panel along with the days and hours it covers and the associated locations. For shifts that extend to the following day, the day displayed in the Shifts panel represents the day when the shift starts.
Newly added shifts are available in the Dashboards tab after the next data refresh.
A shift is displayed in visuals and filters only if data is available for the time interval covered by the shift. If the shift is associated with a location, data must be available from the printers assigned to that location.
1.3.9.2 Editing Shifts
- Click , the Settings tab.
- On the Settings tab, click Shifts.
- In the Shifts panel, click , the Options button, next to the shift that you want to edit and select Edit.
Note: You can also click the shift name to start editing it. - Modify the shift settings in the Edit Shift dialog box.
For details about a specific setting, click the
button to display the on-screen field help. - Click OK.
1.3.9.3 Deleting Shifts
- Click , the Settings tab.
- On the Settings tab, click Shifts.
- In the Shifts panel, click , the Options button, next to the shift that you want to remove and select Delete.
- In the confirmation dialog box, click Delete.
When you delete a shift, the shift is removed from the database and is no longer available for visuals and filters. Make sure that you remove or recreate any visuals or filters that included the deleted shift.
1.4 Working with Dashboards [New]
- Important:
-
The options you see in the Dashboards tab and the actions that you can perform depend on your user role. Roles can restrict access to certain user interface areas or limit the available actions.
For more information, see Users and Roles.
-
All the time-related data from the Dashboards tab is displayed in the printer time zone set in RICOH Supervisor Data Collector.
1.4.1 Creating and Managing Dashboards
1.4.1.1 Creating an Analysis
- Click
, the Dashboards tab. - Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis.
- On the analysis page, create a visual. You can add a wide variety of visuals to an
analysis, using different types of charts and custom elements. For more information
about creating visuals, see Creating Visuals.
You can choose to publish an analysis, and that analysis becomes a dashboard that can be shared with other users. For more information about publishing an analysis, see Publishing an Analysis.
1.4.1.1.1 Adding Sheets
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click
, the Options button, next to an analysis and select Edit. - To add a new sheet, click the
, the Add button, to the right of the sheet tabs.Note: You can also add a new sheet from the analysis menu, by choosing Insert and Add Sheet. - To change the default settings of a sheet, select one of these options available in
the menu:
- To rename a sheet, choose the name of the sheet and start typing. You can also choose Rename from the sheet menu.
- To duplicate a sheet, choose the name of the sheet, then choose Duplicate from the sheet menu. You can only duplicate a sheet if Autosave is turned on.
- To delete a sheet, choose the name of the sheet, then choose Delete from the sheet menu.
- To change the order of the sheets, choose the name of the sheet and drag it to a new position.
- To copy a visual to a new sheet, choose Duplicate visual to from the on-visual menu. Then choose the target sheet. Filters exist only on the sheet that you create them on. To duplicate filters, recreate them on the target sheet.
1.4.1.1.2 Changing the Analysis Themes
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, open the analysis.
- From the menu bar, select Edit and Themes.
- Choose one of the available theme or create a custom one.Note: An analysis can have only one theme applied. To explore and save color options without applying them, avoid editing and saving the applied theme.
1.4.1.1.3 Customizing Layouts
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- Open the analysis from the Analysis list.
- Choose Sheets, and then Layout Settings.
There are three layout designs you can choose from:
- Tiled layout
- Visuals in a Tiled layout snap to a grid with standard spacing and alignment.
- You can make visuals any size and place them wherever you want, but visuals cannot overlap.
- You can optimize Tiled layouts for viewing at specific resolutions, with the default being 1,600 pixels.
- Free-form layout
- Visuals in a Free-form layout can be placed anywhere in your dashboard using precise coordinates. You can drag a visual to the exact place you want, or you can enter the coordinates of the visual’s location.
- You can optimize Free-form layouts for viewing at specific resolutions, with the default being 1,600 pixels.
- Classic layout
- Visuals in a Classic layout snap to a grid with standard spacing and alignment. Dashboards hide data or change formatting to fit smaller screen sizes. For example, if you change a visual to make it considerably smaller, the on-visual menu and editors are hidden so that the chart elements have more room to display. Bar chart visuals can also display fewer data points.
- You can optimize Classic layouts for viewing at specific resolutions, with the default being 1,600 pixels. You can also fit an entire dashboard to a browser's window by choosing Fit to window for View in the top-right corner.
1.4.1.1.3.1 Customizing Visuals in Analyses With Free-Form Layout
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit to open the analysis page.
- On the menu bar, go to , then select Free-form under Sheet Layout and click Apply.
- Select the visual that you want to work with.
- To move the visual, hover over one of its borders until
, the move cursor, is displayed, then drag the visual to the new position.The visuals can overlap.You can also set specific coordinates for the position of the visuals. Click
, the Format visual icon, in the top-right corner of the visual to display the Properties panel. Expand the Display Settings section and enter values in the X and Y fields under Size and position. - To resize the visual, hover over one of its anchor points until
, the resize cursor, is displayed, then drag the anchor point to adjust the size of
the visual.The visuals can overlap.You can also set specific size values for visuals. Click
, the Format visual icon, in the top-right corner of the visual to display the Properties panel. Expand the Display Settings section and enter values in the W and H fields under Size and position. - To customize the visual background, border, or selection frame and set loading animations:
- Click , the Format visual icon, in the top-right corner of the visual to display the Properties panel.
- Expand the Display Settings section.
- To remove or display the background, border, or selection frame, click
, the Click to hide icon, or 
, the Click to show icon, next to Background, Border, or Selection. - To change the color of the background, border, or selection frame, select a different color and adjust the opacity percentage for Background, Border, or Selection.
- To display an animation while the visual is loading, enable the Loading animation option.
- Click
- To customize the visual menus:
- Click , the Format visual icon, in the top-right corner of the visual to display the Properties panel.
- Select the Interactions tab and expand the General section.
- To remove or display the context menu that appears when you right-click an element
from the visual, click , the Hide context menu icon, or , the Show context menu icon, next to Context menu.
- To remove or display the on-visual menu that appears on the top-right side of the
visual, click , the Hide on-visual menu icon, or , the Show on-visual menu icon, next to On-visual menu.
These settings are only visible after you publish the analysis to a dashboard. - Click
1.4.1.1.3.2 Using Conditional Rules
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit to open the analysis page.
- On the menu bar, go to , then select Free-form under Sheet Layout and click Apply.
- Select the visual that you want to work with.
- Click , the Format visual icon, in the top-right corner of the visual to display the Properties panel.
- Select the Interactions tab and expand the Rules section.
- To hide or display the visual by default, enable or disable the Hide this visual by default option.Hidden visuals do not appear in published dashboards. In analyses, an overlay with the message Hidden based on rule is displayed over hidden visuals.Note: You cannot create conditional rules that hide visuals that are already hidden by default or that show visuals that already appear by default. If you change the default visibility of a visual, any existing rules that contradict the new default setting are disabled.
- To create a rule, click the ADD RULE button and configure the settings from the Add new rule panel:
- Under Parameter, select a string or number parameter.
- Under Condition, select a condition.For string parameters, the supported conditions are Equals, Starts with, Ends with, Contains, and Does not equal. For number parameters, the supported conditions are Equals, Less than, Greater than, and Between.
- Under Value, enter the comparison value.Values are case-sensitive.
- Under Action, select Hide this visual or Show this visual.
- Click ADD.
The rule that you created is displayed in the list of rules from the Interactions panel. To edit or delete a rule, click
, the Open menu icon, next to the rule and select Edit or Delete.
You can also move a parameter control inside the sheet. Click 
, the Options icon, next to the control, and select Move inside this sheet. This setting is useful when you want to place a parameter control next to the associated
visual or when you want to add a conditional rule to the control so it appears only
when specific conditions are met.
1.4.1.1.4 Configuring Analysis Settings
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- Open the analysis from the Analysis list.
- To access the Analysis Settings menu, choose Edit, and then choose Analysis Settings.
The following settings can be configured in the Analysis Settings menu:
- Refresh Settings
- Reload visuals every time I switch sheets: Use this setting to reload every visual in an analysis whenever you switch to a different sheet in the analysis.
- Update visuals manually: Use this setting to only update applicable visuals in an analysis when you apply the changes.
- Date and Time Settings
- Convert time zone: Use this setting to convert all date field related visualizations, filters, and parameters to reflect the chosen time zone.
- Start of the week: Use this setting to choose the week start day for an analysis.
1.4.1.1.5 Using Parameters
For example, a dashboard user can use a list to select a value. That value sets a parameter that in turn sets a filter, calculation, or URL action to the chosen value. Then the visuals in the dashboard change based on the choices of the user.
To make the parameters accessible to the dashboard viewer, you can add a parameter control. A control can appear as a list of options, a slider, or a text entry area. You can also set up cascading controls, so that a selection in one control filters the options that display in another control. If you do not create a control, you can still pass a value to your parameter in the dashboard URL.
Parameters must be connected to an element in your analysis, regardless of whether they have a related control. You can reference parameters in calculated fields, filters, dashboard and analysis URLs, custom actions, and titles and descriptions throughout an analysis.
For example, if you use a calculation with a parameter, you can transform the data that is shown in an analysis. If you add a control with a filter to an analysis you are publishing, the dashboard users can filter the data without creating their own filters. Using controls and custom actions, you can let dashboard users set values for the URL actions.
1.4.1.1.5.1 Creating Parameters
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, click
, the Parameters button, on the toolbar to display the Parameters panel. - In the Parameters panel, click the + ADD button.
- In the Create new parameter dialog, enter a name for the parameter.
- Under Data type, select String, Integer, Number, or Datetime.
- If you selected String, Integer, or Number for the data type, set the parameter values:
- Under Values, select Single value for parameters that can contain only one value or Multiple values for parameters that can contain one or more values.Parameters with multiple values do not support dynamic default values.
- For Static default value or Static multiple default values, enter one or more values.The static values are used during the first page load if a dynamic default value or URL parameter is not provided.
- To show the default value for multivalue lists as blank, enable the Show as blank by default option.
- Under Values, select Single value for parameters that can contain only one value or Multiple values for parameters that can contain one or more values.
- If you selected Datetime for the data type, set the time granularity and default date:
- Under Time granularity, select Day, Hour, Minute, or Second.
- For Default date, select Fixed date or Relative date.
- Optional: To set a default value that changes for each user, click Set a dynamic default.A dynamic default value creates a personalized view for each user. To configure parameters that display different defaults to each user, the dataset must contain a mapping between users or groups and the specific default values that you want them to see.
Calculated fields cannot be used as dynamic defaults.
- Optional: Under Advanced settings, set a reserved value that determines the value for Select all.The reserved value of a parameter is the value that is assigned to a parameter when you choose Select all as its value. When you set up a specific reserved value for your parameter, that value is no longer considered a valid parameter value in the dataset.
You can use the recommended value for the data type, null, or a custom value for the reserved value.
You can set reserved values only for string, integer, and number parameters.
- Click Create.
- Select one of the shortcuts from the Parameter added dialog to use the parameter that you created in a filter, control, calculated field,
or custom action or click Close.For more information, see Adding Controls for Parameters and Connecting to Parameters.
The parameter that you created is displayed in the list of parameters from the Parameters panel. To edit or delete a parameter, hover over the parameter, then click , the Options icon, and select Edit parameter or Delete parameter.
1.4.1.1.5.2 Adding Controls for Parameters
- Note:
- Multiselect list controls are compatible with analysis URLs, dashboard URLs, custom actions, and custom filters. The filters must be either equal or not equal to the values provided. No other comparisons are supported.
- Lists display up to 1,000 values in alphabetical order. If there are more than 1,000 distinct values, a search box appears so that you can filter the list. Wildcard search is supported. For more information, see Searching for Specific Values.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, click , the Parameters button, on the toolbar to display the Parameters panel.
- In the Parameters panel, hover over a parameter, then click , the Options icon, and select Add control.
- In the Add control dialog, enter a name for the control.
The specified name is used as the control label that is displayed at the top of the sheet in the analysis and in the published dashboard.
You can include a parameter in the name of the control.
- Under Style, select one of the available control types:
- Text field: Lets you type a custom value in the control. This option is available for numbers and strings.
- Text field - multiline: Lets you type multiple custom values in the control. This option is available for numbers and strings.
- Dropdown: Lets you select a single value from a drop-down list. This option is available for numbers and strings.
- Dropdown - multiselect: Lets you select multiple values from a drop-down list. This option is available for numbers and strings.
- List: Lets you select a single value from a list. This option is available for numbers and strings.
- List - multiselect: Lets you select multiple values from a list. This option is available for numbers and strings.
- Slider: Lets you select a numeric value by sliding the control from one end of the bar to another. This option is available for numbers.
- Date-picker: Lets you select a date from a calendar control. This option is available for dates.
The available options depend on the data type of the parameter and whether the parameter has a single value or multiple values.
- For Text field and Text field - multiline controls, enable the Show helper text in control option to include instructions for using the control.
- For Text field - multiline controls, specify whether to separate the values you enter in the parameter control by a line break, comma, pipe (|), or semicolon under Separate values by.
- For Slider controls, enter values for the slider range and step size under Minimum value, Maximum value, and Step size.
- For Date-picker controls, enter the date format that you want to use under Date format.For more information on the supported date formats, see Custom Date and Time Formats.
- For Dropdown, Dropdown - multiselect, List, and List - multiselect controls:
- Under Values, specify a list of values or use a field from the dataset.
- To create a list of specific values, select Specific values and enter the values one per line, with no separating spaces or commas. The values that you enter are displayed alphabetically in the control.
- To link to a field, select Link to a dataset field and select the dataset and the field. Calculated fields are not supported.
To limit the values displayed in the control based on the values selected in other controls, enable the Show relevant values only option. Then, select the controls that determine what values are available for selection.
The values that you specify for the control in the Values section are combined with the static default values from the parameter settings. If you change the default values in the parameter, click
, the Options icon, next to the control on the sheet and select Reset to display the new values from the parameter. - To remove the option to select all the items in the control, enable the Hide Select all option from the control values if the parameter has a default configured option. Make sure that the parameter has a static default configured.
- For List and List - multiselect controls, enable the Hide search bar when control is on sheet option to hide the search bar from the control.
- For Dropdown - multiselect, enable the Show an apply button option to include an Apply button in the control and pause immediate updates on new selections.
- Under Values, specify a list of values or use a field from the dataset.
- Click Add.
The controls that you create are displayed at the top of the sheet inside a bar. To
interact with a control, expand the controls bar, click , the Options icon, next to the control, and select one of the options available in the menu:
- To move the control inside the sheet, select Move inside this sheet.
- To reset the control to the default values, select Reset.
- To refresh the values retrieved from the dataset, select Refresh. This option is available only for controls that are linked to a field in the dataset.
- To edit the control, select Edit and update the settings from the Format control panel on the right.
- To remove a control, select Delete.
1.4.1.1.5.3 Connecting to Parameters
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit to open the analysis page.
- To connect a parameter to a filter:
- Select a visual and click
, the Filter button, on the toolbar. - In the Filters panel, click the + ADD button and select the field that you want to use in the filter.
- Select the added filter to configure it.
- Add a parameter based on the field type selected for the filter:
- For numeric fields, enable the Use parameters option and select a parameter from the list.
- For text fields, first select Custom Filter for Filter type, and then enable the Use parameters option and select a parameter from the list.
- For date fields, enable the Use parameters option and select a parameter under Start date parameter and End date parameter.
Note: Parameters that can have multiple values must use Equals or Does not equal as the comparison type.
For more information on filters, see Working with Filters. - Select a visual and click
- To include a parameter in a calculated field:
- Click
, the Datasets button, on the toolbar to display the Data panel. - In the Data panel, click the + CALCULATED FIELD button.
- In the Add calculated field dialog, create a calculation.
- To include a parameter in the calculation, expand the Parameters section and double-click one of the available parameters.Parameters without a default value cannot be included in calculated fields.
For more information on calculated fields, see Using Formulas. - Click
- To connect a parameter to a custom action:
- Select a visual and click , the Format visual icon, in the top-right corner of the visual.
- In the Properties panel on the right, select the Interactions tab.
- Expand the Actions section and click the ADD ACTION button.
- To include a parameter in the action name, click
, the Insert parameter icon, next to Action name and select a parameter from the list. - To create a navigation action with a parameter, select Navigation action under Action type, then click
, the Add icon, next to Parameters and select a parameter and a parameter value. - To create a URL action with a parameter, select URL action under Action type, then click , the Insert parameter icon, next to URL and select a parameter.
For more information on custom actions, see Using Custom Actions. - Select a visual and click
- To include a parameter in sheet titles and descriptions:
- On the menu bar, go to or .
- At the top of the sheet, enter a sheet title or description.
- To include a parameter in the title or description, click
, the Insert parameter icon, and select a parameter from the list.
- To include a parameter in visual titles and subtitles:
- Select a visual and click , the Format visual icon, in the top-right corner of the visual.
- In the Properties panel on the right, expand the Display Settings section.
- Click
, the Edit icon, next to Edit title or Edit subtitle. - In the Edit title or Edit subtitle dialog, enter a title or subtitle for the visual.
- To add a parameter, select a parameter from the Parameters list on the right.
- Select a visual and click
- To include a parameter in the titles of visual axes:
- Select a visual and click , the Format visual icon, in the top-right corner of the visual.
- In the Properties panel on the right, expand the section for the axis that you want to format.
- Under Title, enter a custom axis title in the text box.
- To include a parameter in the title, click
, the Insert parameter icon, and select a parameter.
- Select a visual and click
- To include a parameter in visual legends:
- Select a visual and click , the Format visual icon, in the top-right corner of the visual.
- In the Properties panel on the right, turn on the Legend switch.
- Expand the Legend section.
- Under Legend title, enter a title for the legend.
- To include a parameter in the title, click , the Add parameter icon, and select a parameter.
- Select a visual and click
1.4.1.1.6 Using Custom Actions
You create one action for each task that you want to add to a visual. There are several types of actions that you can use:
| Type of action | Task |
|---|---|
| Filter action | Add an interactive filter action, including one-click filters. |
| Navigation action | Open another sheet in the same dashboard. |
| URL action |
Open a sheet in a different dashboard. Open a URL ( Send an email ( |
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, select a visual and click , the Format visual icon, in the top-right corner of the visual.
- In the Properties panel on the right, select the Interactions tab.
- Expand the Actions section and click the ADD ACTION button.
- In the New action panel, enter a name for the custom action.For custom actions that are activated from the right-click menu, the action name is also used as the name of the menu option.
You can include a field name or a parameter in the action name. Click
, the Insert parameter icon, next to Action name and select a field or a parameter from the list. - Under Activation, specify how the custom action is activated.
- Under Action type, select a type of custom action.
- To create an interactive filter action that cascades from one visual to the other
visuals on the sheet, select Filter action.
Specify the fields that you want to filter on and the visuals that you want the filtering to apply to.
When you click a data point in the visual, such as a bar in a bar chart or a segment in a pie chart, you instantly filter using the specified fields on all the specified visuals on that sheet.
- To create a navigation action that lets you navigate to a different sheet in the same
analysis or dashboard, select Navigation action and select the target sheet.
To also send a parameter value to the target sheet, click
, the Add icon, next to Parameters and select a parameter and a parameter value. - To create a URL action that lets open a sheet in a different analysis or dashboard,
open a URL, or send an email, select URL action.
Enter the target URL under URL. Valid URL schemes include
https,http, andmailto.To also send a parameter to the target URL, click
, the Insert parameter icon, next to URL and select a parameter.You can also specify whether the URL opens in a new browser tab, in the same browser tab, or in a new browser window.
- To create an interactive filter action that cascades from one visual to the other
visuals on the sheet, select Filter action.
- Click Save.
The custom action that you created is displayed in the Actions panel. To enable or disable a custom action, select or clear the check box next to
the custom action. To edit or delete a custom action, click 
, the Open menu icon, next to the custom action and select Edit or Delete.
For a custom action to work, every field and parameter it references must be active in the source visual. If a field is missing from the source visual, or if a parameter is missing from the analysis, the action for that field or parameter becomes unavailable. Make sure that you also remove or reconfigure the custom actions when you delete a field or a parameter.
1.4.1.2 Editing an Analysis
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an existing analysis and select Edit.
1.4.1.3 Duplicating an Analysis
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an existing analysis and select Duplicate.
You can also open the analysis that you want to duplicate. In the analysis, choose Save as analysis in the application bar.
1.4.1.4 Renaming an Analysis
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an existing analysis and select Rename.
1.4.1.5 Deleting an Analysis
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an existing analysis and select Delete.
1.4.1.6 Sharing an Analysis
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit to open the analysis page.
- On the menu bar, go to .
- On the Share analysis dialog, enter a user email address in the search box.
Any active users that match your query appear in a list below the search box. Select one of the users from the list.
- Repeat the previous step to add more users.
- Under Permission, select a role to assign to each user.The role determines the permission level that is granted to the user.
- Click Share.The users that have access to the analysis can see the shared analysis on the Analyses dialog.
, the Remove user icon, next to a user.1.4.1.7 Publishing an Analysis
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- Open the analysis that you want to use.
- Click the Publish button, in the top-right corner.
- Do one of the following:
- To create a new dashboard, choose Publish new dashboard as, and then type a dashboard name.
- To replace an existing dashboard, do one of the following. Replacing a dashboard updates
it without altering security or emailed report settings.
- To update it with your changes, choose Replace an existing dashboard and then choose a dashboard from the list.
- To rename it, choose Replace an existing dashboard, choose a dashboard from the list, and then choose Rename. Enter a new name to rename the existing dashboard. When you rename a dashboard, it also saves any changes you made to the analysis.
- Choose Publish dashboard.If you renamed the existing dashboard, the top of the screen refreshes to show the new name.
Choose the sheets that you want to publish in the SHEETS dropdown. When you select sheets to add to the new dashboard, the dropdown shows how many sheets are selected for publishing. The default option is ALL SHEETS SELECTED.
1.4.1.8 Viewing Dashboards
Important: The dashboards are not displayed in Incognito mode. For more information, see If You Encounter a Problem.
- Click , the Dashboards tab.
- Select the dashboard that you want to view in the Dashboards list.The dashboards are grouped into categories:
- The Sample Dashboards list includes the Capacity Planning (Impressions), Ink Consumption (Inkjet printers only), Job Insights, Printer Utilization, Shift Performance (Previous Week), and RICOH ProcessDirector dashboards.
- The dashboards that you created are listed under My Dashboards.
- The dashboards that are shared with you are listed under Shared with me.
1.4.1.8.1 Viewing Visual Details
- Click , the Dashboards tab, and select a dashboard from the list.
- On the dashboard, go to the visual that you want to view.
- Hover over the elements of the visual to see more details about the data they represent.
For example, when you hover over a single bar on a bar chart, information about that specific bar displays in a tooltip.
- If the content is larger than the size of the visual, use the scroll bar to reduce
the data that is displayed or scroll through it.
- To reduce the length of the scroll bar and change the size of the data, hover over one end of the bar and drag the cursor to adjust the size.
- To scroll through the data, click and hold the scroll bar and slide it toward the end that you want to see.
- To expand the visual and view it in a larger size, click
, the Maximize button, in the corner of the visual.
1.4.1.8.2 Excluding and Focusing on Visual Elements
- Click , the Dashboards tab, and select a dashboard from the list.
- On the dashboard, select a visual, then right-click an element, such as a bar, a data
point, or a row or column header, and select an option from the menu:
- To exclude the element, select Exclude.
- To focus on the element, select Focus only on.
When you exclude or focus on specific data, a filter is created to hide or to show only the data that you selected.
To remove the filter, disable or delete the filter from the Filters panel on the right.
If the visual has a legend, you can also click the values in the legend and select Exclude or Focus only on to exclude or focus on specific data.
1.4.1.8.3 Drilling down in Visuals
- Click , the Dashboards tab, and select a dashboard from the list.
- On the dashboard, select a visual, then right-click an element, such as a bar, a data
point, or a data segment, and select a drill option from the menu:
- To drill down to see data at a lower level of the hierarchy, select Drill down to lower level.
- To drill up to see data at a higher level of the hierarchy, select Drill up to higher level.
Depending on the visual configuration, you can also use the toolbar to drill down and up into the data. Hover over the visual and click one of the drill icons from the toolbar:
- To drill down one level, click
, the Drill down icon. - To drill up one level, click
, the Drill up icon. - To drill all the way to the top of the hierarchy, click
, the Drill up to top icon.
1.4.1.8.4 Analyzing Contributions in Visuals
- Click , the Dashboards tab, and select a dashboard from the list.
- On the dashboard, select a visual, then right-click a data element, such as a bar
or a data point, and select Analyze contributions from the menu.
- In the Top contributors panel, choose up to 4 dimension fields to analyze what contributed the most to the selected data metric.
- Under Select time frame to analyze, set a start and an end date and time.
- Click Analyze.
- Look at the information displayed in the Contributors panel.
- At the top of the panel, you can see a summary that describes any changes in the data metrics.
- Under Top Contributors, you can see the results of the top contributor analysis for the specified time frame.
Hover over the entries to see more details.
To change the sort method applied to the results, select one of the options available under Sort by. You can select Absolute difference, Contribution percentage, Deviation from expected, or Percentage difference.
1.4.1.8.5 Viewing Summary Data in Visuals
- Click , the Dashboards tab, and select a dashboard from the list.
- On the dashboard, hover over the visual that you want to view.
- Click
, the Menu options button, in the corner of the visual, and select View summary data.
- On the View summary data dialog, use the arrows to navigate through the data.You can also sort the entries by clicking the column headings and set the number of rows per page.
1.4.1.9 Duplicating Dashboards
- Click , the Dashboards tab.
- Right-click the dashboard that you want to duplicate and select Duplicate.
1.4.1.10 Renaming Dashboards
1.4.1.11 Deleting Dashboards
- Click , the Dashboards tab.
- Right-click the dashboard that you want to delete and select Delete.
1.4.1.12 Sharing Dashboards
- Important:
- This function is only available with the Self-Service feature. If you want to purchase this feature, contact your Ricoh representative.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- Open the analysis that you want to use.
- Publish the analysis. For more information, see Publishing an Analysis.
- Click
, the Share dashboard button. 
- Click Share dashboard.
- Specify the required settings in the Share dashboard dialog box:
- For Invite users and groups to dashboard, enter a user email addresses or group name in the search box. Any users or groups that match your query appear in a list below the search box. Only active users and groups appear in the list.
- To change the permission level for a user, choose the permission level menu in the
Permissions column and select a permission.
The available permissions for each role are as follows:
- Readers: The recipients can only be granted Viewer access to dashboards. They can view, export, and print the dashboard, but they cannot save the dashboard as an analysis. They can view, filter, and sort the dashboard data. They can also use any controls or custom actions that are on the dashboard. Any changes that they make to the dashboard exist only while they are viewing it, and are not saved after they close the dashboard.
- Co-owner: The recipients can be granted Viewer or Co-owner access to dashboards.
- Authors with Viewer access can view, export, and print the dashboard. They can view, filter, and sort the dashboard data. They can also use any controls or custom actions that are on the dashboard. Any changes that they make to the dashboard exist only while they are viewing it, and are not saved after they close the dashboard. However, they can save the dashboard as an analysis, unless the dashboard owner specifies otherwise. This privilege grants them read-only access to the datasets so that they can create new analyses from them. The owner has the option to provide them with the same permissions to the analysis. If the owner wants them also to edit and share the datasets, the owner can set that up inside the analysis.
- Authors with Co-owner access can view, export, and print the dashboard. They can also edit, share, and delete it. They can also save the dashboard as an analysis, unless the dashboard owner specifies otherwise. This privilege grants them read-only access to the datasets so that they can create new analyses from them. The owner has the option to provide them with the same permissions to the analysis. If the owner wants them to also edit and share the datasets, the owner can set that up inside the analysis.
As a dashboard owner, you can stop sharing a dashboard at any time by removing all the recipients from the Share dashboard dialog box.
1.4.1.13 Scheduling Reports
- Important:
- This function is only available with the Self-Service feature. If you want to purchase this feature, contact your Ricoh representative.
- To set up or change the schedule sent from a dashboard, make sure that you're an owner or co-owner of the dashboard.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- Open the analysis that you want to use.
- Publish the analysis. For more information, see Publishing an Analysis.
- Click
, the Scheduling button. - Click ADD.
- You can customize the title of the report, the optional description, and the body text. You can also email a report from any sheet in a dashboard.
- Scheduling options that are available for an email report include the following:
- Once (Does not repeat)
Sends the report only once at the date and time that you choose.
- Daily
Repeats daily at the time that you choose.
- Weekly
Repeats each week on the same day or days at the time that you choose.
You can also use this option to send reports in weekly intervals, such as every other week or every three weeks.
- Monthly
Repeats each month on the same day of the month at the time that you choose.
You can also use this option to send reports on specific days of the month.
- Yearly
Repeats each year on the same day of the month or months selected at the time that you choose.
You can also use this option to send reports on specific days or sets of days in selected months.
- Custom
Configure your own scheduled report that best fits your needs.
- Once (Does not repeat)
- Click OK.
1.4.2 Creating and Managing Visuals
After you create a visual, you can edit it at any time to change the chart type, select different data fields, and update the formatting and presentation of the data.
You can also duplicate visuals to the same sheet or to a different sheet or delete them from the analysis.
1.4.2.1 Creating Visuals
To create the visual, you can select the data fields and use AutoGraph to automatically determine the most appropriate visual type. Or you can select a specific visual type and choose fields to populate it.
You usually need a combination of dimension and measure fields to create a visual, for example the number of impressions (a measure) by week (a dimension).
- Dimension or category fields
Descriptive fields with alphanumeric strings that you can use to label and categorize
data, such as printer names, printer types, and job states. 
Date fields with dates and time intervals. You can use date fields to organize your
data into hierarchies according to year, quarter, and month or into units of time
such as hours or minutes.- Measure fields
Numeric fields with quantified data that you can aggregate or calculate, such as
number of impressions, number of copies, and event duration.
You cannot use the same field for more than one dimension field well in a visual.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click
, the Add visual button, on the toolbar.
- Use one of these methods to create the visual:
- Use the AutoGraph function:
- In the list of visual types, click the AutoGraph icon.
- Add data to the visual by dragging fields from the Data panel to the Add a dimension or measure field well in the Visuals panel.
The AutoGraph function automatically creates a type of visual based on the selected data and makes adjustments as you add more fields.
If you have a long list of fields in the Data panel, you can use the search function to find a specific field. Enter a search term in the search box at the top of the panel. Search is case-insensitive and wildcards are not supported.
- In the list of visual types, click the AutoGraph icon.
- Select a visual type, and then choose the fields that you want to include:
- In the list of visual types, click the icon for the visual type that you want to create.
- Add data to the visual by dragging fields from the Data panel to the appropriate field wells in the Visuals panel. Or just select fields in the Data panel if you want RICOH Supervisor to automatically place them in appropriate field wells.
Use dimension or measure fields according to the color of the target field well. Orange field wells expect a measure field and blue field wells expect a dimension field. If you use a dimension field to populate a Value field well, the Count aggregate function is automatically applied to it to create a numeric value.
In some types of visuals, you can also drag fields directly to the drop targets displayed in the visuals. Green drop targets expect a measure field and blue drop targets expect a dimension field.
- Use the AutoGraph function:
- Configure sorting, aggregation, granularity, and formatting settings for the fields
that you added to the visual by clicking
, the Options button, next to a field in the Visuals panel.In visuals that display field labels, you can also configure field settings directly from the visual. Click
, the Options button, next to a field label. - Customize the appearance of the visual in the Properties panel on the right.
You can add more visuals to the analysis by using the Add visual option from the toolbar. You can then resize the visuals and drag them to rearrange them.
RICOH Supervisor supports up to 30 visuals in a single sheet and up to 20 sheets per analysis.
1.4.2.1.1 Using AutoGraph
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the AutoGraph icon.
- Add data to the visual by dragging fields from the Data panel to the Add a dimension or measure field well in the Visuals panel.The AutoGraph function automatically creates a type of visual based on the selected data and makes adjustments as you add more fields.
- Customize the appearance of the visual in the Properties panel on the right.
1.4.2.1.2 Using Bar Charts
Several types of bar charts are available:
- Single-measure bar chart
- A single-measure bar chart shows values for a single measure for a dimension. For example, the number of jobs per printer.
- Multi-measure bar chart
- A multi-measure bar chart shows values for multiple measures for a dimension. For example, the number of jobs and number of impressions per printer.
- Clustered bar chart
- A clustered bar chart shows values for a single measure for a dimension, grouped by another dimension. For example, the number of jobs for each printer per location.
- Stacked bar chart
- A stacked bar chart is similar to a clustered bar chart in that it displays a measure for two dimensions. However, instead of clustering bars for each child dimension by the parent dimension, it displays one bar per parent dimension. It uses color blocks within the bars to show the relative values of each item in the child dimension. The color blocks reflect the value of each item in the child dimension relative to the total for the measure. A stacked bar chart uses a scale based on the maximum value for the selected measure.
- Stacked 100 percent bar chart
- A stacked 100 percent bar chart is similar to a stacked bar chart. However, in a stacked 100 percent bar chart, the color blocks reflect the percentage of each item in the child dimension, out of 100 percent.
Bar charts show up to 10,000 data points on the axis for visuals that do not use group or color. Visuals that use group or color show up to 50 data points on the axis and up to 50 data points for group or color.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the icon for the type of bar chart that you want to create.
- To create a single-measure, multi-measure, or clustered bar chart, click the Horizontal bar chart or Vertical bar chart icon.
- To create a stacked bar chart, click the Horizontal stacked bar chart or Vertical stacked bar chart icon.
- To create a stacked 100 percent bar chart, click the Horizontal stacked 100 percent bar chart or Vertical stacked 100 percent bar chart icon.
- To create a single-measure, multi-measure, or clustered bar chart, click the Horizontal bar chart or Vertical bar chart icon.
- Add data to the visual by dragging fields from the Data panel to the appropriate field wells in the Visuals panel.
- To create a single-measure bar chart, drag a dimension to the X axis or Y axis field well and one measure to the Value field well.
- To create a multi-measure bar chart, drag a dimension to the X axis or Y axis field well and two or more measures to the Value field well.
- To create a clustered bar chart, drag a dimension to the X axis or Y axis field well, a measure to the Value field well, and a dimension to the Group/Color field well.
- To create a stacked bar chart, drag a dimension to the X axis or Y axis field well, a measure to the Value field well, and a dimension to the Group/Color field well.
- To create a stacked 100 percent bar chart, drag a dimension to the X axis or Y axis field well and two or more measures to the Value field well.
To add drill-down layers, drag at least one more field to the X axis, Y axis, or Group/Color field wells. - Optional: To divide the visual into several smaller visuals, each with a different view of the
same data, drag a dimension from the Data panel to the Small Multiples field well.Each copy of the visual shows a different data view based on the selected dimension. This function is useful when you want to display multiple comparative visuals side by side. For example, you can create a set of visuals that show a different data view for every location.This function is not available for clustered and stacked bar charts or for horizontal layouts.
- Customize the appearance of the visual in the Properties panel on the right.
- Under Display Settings, format the title and subtitle.For more information, see Formatting Titles and Subtitles in Visuals.
- If you added fields to the Small Multiples field well to display multiple visuals side by side, configure the formatting settings
available under Multiples Options.
- Under Layout, set the number of rows and columns that are visible without scrolling and the maximum number of panels.
- To specify whether the visuals use shared or independent axes, select Shared or Independent under X-axis and Y-axis.
If the visuals use an independent x-axis, only the values that are relevant to each panel are shown on the axis. For example, if the panels display data per shift, each panel shows only the data for a specific shift. If the visuals use an independent y-axis, each panel has its own y-axis scale that depends on the range of the data it contains.
- To set the label position for shared axes, select Outside or Inside under X-axis labels and Y-axis labels.
- To display panel titles, enable the Panel title option and set the title size, color, style, and alignment.
- To display panel borders, enable the Panel border option and set the border thickness, type, and color.
- To display panel gutters, enable the Panel gutter option and set the spacing.
- To set a background color for the panels, enable the Panel background option and select a color.
- Under X-axis and Y-axis, configure the axes, the grid lines, and the range and scale.You can enter the maximum number of data points to display in the chart in the Number of data points to show field under X-axis or Y-axis, depending on the chart orientation. The remaining data is grouped under the Other category. To hide the Other category from the chart, click
, the Menu options button, in the corner of the visual, and select Hide "other" categories.
For information on the other available settings, see Formatting Axes and Grid Lines in Visuals and Configuring Range and Scale in Visuals.
- Under Group/Color, enter the maximum number of bar groups or segments to display.The remaining data is grouped under the Other category. To hide the Other category from the chart, click, the Menu options button, in the corner of the visual, and select Hide "other" categories.
- Under Reference lines, add reference lines if there are other values that you want to display along with
the chart data.For more information, see Adding Reference Lines to Visuals.
- Under Legend, format the legend.For more information, see Formatting Legends in Visuals.
- Under Data labels, format the labels.For more information, see Formatting Data Labels in Visuals.
The settings available in the Properties panel depend on the bar chart type and configuration. - Under Display Settings, format the title and subtitle.
1.4.2.1.3 Using Box Plots
Box plots detail information in quarters:
- Minimum – The lowest data point excluding outliers.
- Maximum – The highest data point excluding outliers.
- Median – The middle value of the dataset.
- First Quartile – The middle value between the smallest number and the median of the dataset. The first quartile does not include the minimum or the median.
- Third Quartile – The middle value between the largest number and the median of the dataset. The third quartile does not include the maximum or the median.
Outliers are extreme data points that are not included in the calculation of the key values in a box plot. Because outliers are calculated separately, their data points do not appear immediately after a box plot is created.
Box plots can display up to 10,000 data points.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the Box plot icon.
- Add data to the visual by dragging fields from the Data panel to the appropriate field wells in the Visuals panel:
- Drag at least one measure to the Value field well.
- Drag a dimension to the Group by field well.
- Add drill-down layers by dragging one or more additional fields to the Group by field well.
- Customize the appearance of the visual in the Properties panel on the right.
- Under Display Settings, format the title and subtitle.For more information, see Formatting Titles and Subtitles in Visuals.
- Under Box plot, specify whether to fill the boxes with color, include outliers, or display all the data points.
- Under X-axis and Y-axis, configure the axes, the grid lines, and the range and scale.For more information, see Formatting Axes and Grid Lines in Visuals and Configuring Range and Scale in Visuals.
- Under Reference lines, add reference lines if there are other values that you want to display along with
the chart data.For more information, see Adding Reference Lines to Visuals.
- Under Legend, format the legend.For more information, see Formatting Legends in Visuals.
- Under Display Settings, format the title and subtitle.
1.4.2.1.4 Using Combo Charts
These types of combo charts are available:
- Clustered bar combo chart
- Displays sets of single-color bars. Each set represents a parent dimension and each
bar represents a child dimension.
This type of chart helps you determine values for each bar more easily.
- Stacked bar combo chart
- Displays multi-color bars. Each bar represents a parent dimension and each color represents
a child dimension.
This type of chart helps you understand the relationships between child dimensions within a parent dimension. It shows the total value for the parent dimension and how each child adds to the total value. To determine the value for each child dimension, you compare the size of the color section to the data labels for the axis.
Use a combo chart only if you want to show a relationship between the bars and the lines. Make sure that the data in the bars directly relates to the data in the lines.
- Note:
- The data points in each series render on different scales. Combo charts use a scale based on the maximum value for the selected measure.
- The distance between the numbers on the axis does not match between the lines and bars, even if you select the same scale for each chart type.
- For clarity, try to use different units for the measure in each data series.
Bars and lines show up to 2,500 data points on the axis for visuals that do not use group or color. For visuals that use group or color, bars show up to 50 data points on the axis and up to 50 data points for group or color. Lines show up to 200 data points on the axis and up to 25 data points for group or color.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the icon for the type of combo chart that you want to create.
Clustered bar combo chart
Stacked bar combo chart
- Add data to the visual by dragging fields from the Data panel to the appropriate field wells in the Visuals panel:
- Drag a dimension to the X axis field well.This dimension is typically a text field that is related to the measure and can be used to segment it to see more detailed information.
- Drag at least one measure to the Bars field well.Each bar in the chart represents a measure value for an item in the dimension that you added.
- Drag at least one measure to the Lines field well.Make sure that the data for the bars directly relates to the data for the lines.
- Drag a measure to the Group/Color for bars field well.If you use this field well, you can have only one measure in the Bars field well.
- Add drill-down layers by dragging one or more additional fields to the X axis or Group/Color for bars field well.
- Drag a dimension to the X axis field well.
- Customize the appearance of the visual in the Properties panel on the right.
- Under Display Settings, format the title and subtitle.For more information, see Formatting Titles and Subtitles in Visuals.
- Under X-axis, Bars, and Lines, configure the axes, the grid lines, and the range and scale.
- Under X-axis, enter the maximum number of data points in the Number of data points to show field. The remaining data is grouped under the Other category. To hide the Other category from the chart, click , the Menu options button, in the corner of the visual, and select Hide "other" categories.
- To combine the bars and lines into a single y-axis, enable the Single Y-axis option under Bars or Lines.
For information on the other available settings, see Formatting Axes and Grid Lines in Visuals and Configuring Range and Scale in Visuals.
- Under X-axis, enter the maximum number of data points in the Number of data points to show field. The remaining data is grouped under the Other category. To hide the Other category from the chart, click
- Under Group/Color, enter the maximum number of bar groups to display.The remaining data is grouped under the Other category. To hide the Other category from the chart, click, the Menu options button, in the corner of the visual, and select Hide "other" categories.
- Under Reference lines, add reference lines if there are other values that you want to display along with
the chart data.For more information, see Adding Reference Lines to Visuals.
- Under Legend, format the legend.For more information, see Formatting Legends in Visuals.
- Under Data labels, format the labels.For more information, see Formatting Data Labels in Visuals.
The settings available in the Properties panel depend on the combo chart type and configuration. - Under Display Settings, format the title and subtitle.
1.4.2.1.5 Using Custom Visual Content
These requirements and limitations apply to custom visual content:
- The web content that you want to embed must be from a source that supports viewing or opening the content in an HTML iframe.
- You must enable all the cookies that are required to view the content in the web browser. If the web browser blocks third-party cookies, the images do not load.
- Only HTTPS URL schemes are supported.
- Custom visual content is not supported in email reports.
- Images and websites that use hotlink protection do not load in visuals.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the Custom visual content icon.
- Add content to the visual from the Properties panel on the right.
- Expand the Custom Content section.
- Enter the URL of the image, online video, webpage, or online form in the URL field.
- Click Apply.
- For images, enable the Show as image option and select a size setting from the Image sizing options list.Make sure that the URL you added links directly to an image. Open the image that you want to embed in a separate browser tab or choose an embeddable URL for the image.
It is best to use embeddable URLs, especially for videos, online forms, spreadsheets, and documents. Embeddable URLs create a better experience for the users of your dashboard and make interacting with the content easier. You can usually find the embeddable URL when you choose to share the content from the source website.
1.4.2.1.6 Using Donut Charts
Each wedge in a donut chart shows one value in a dimension. The wedge size is proportional
to the quantity that it represents.
To create a donut chart, use one dimension in the Group/Color field well. With only one field, the chart displays the division of values by row count. To display the division of dimension values by a metric value, you can add a metric field to the Value field well.
Donut charts show up to 20 data points for group or color.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the Donut chart icon.
- Add data to the visual by dragging fields from the Data panel to the appropriate field wells in the Visuals panel:
- Drag a dimension to the Group/Color field well.
- Drag a measure to the Value field well.
- Add drill-down layers by dragging one or more additional fields to the Group/Color field well.
- Customize the appearance of the visual in the Properties panel on the right.
- Under Display Settings, format the title and subtitle.For more information, see Formatting Titles and Subtitles in Visuals.
- Under Donut chart, set the size of the ring and specify whether to display the total value.
- Under Value, format the value field.
- To remove or display the field title, click , the Hide axis title icon, or , the Show axis title icon, next to Title.
You can also enter a custom title in the text box. To include a parameter in the title, click
, the Insert parameter icon. - To remove or display the quick sort icon, click , the Hide quick sort icon icon, or , the Show quick sort icon icon, next to Sort.
- To remove or display the field title, click
- Under Group/Color, format the group or color field.
- To remove or display the field title, click , the Hide axis title icon, or , the Show axis title icon, next to Title.
You can also enter a custom title in the text box. To include a parameter in the title, click
, the Insert parameter icon. - To remove or display the quick sort icon, click , the Hide quick sort icon icon, or , the Show quick sort icon icon, next to Sort.
- Under Number of slices displayed, enter the maximum number of slices to include in the donut chart.
The remaining smaller slices are grouped into the Other slice. To hide the Other slice from the donut chart, click
, the Menu options button, in the corner of the visual, and select Hide "other" categories.
- To remove or display the field title, click
- Under Legend, format the legend.For more information, see Formatting Legends in Visuals.
- Under Data labels, format the labels.For more information, see Formatting Data Labels in Visuals.
- Under Display Settings, format the title and subtitle.
1.4.2.1.7 Using Funnel Charts
For example, funnel charts are often useful to identify trends or potential problem areas and bottlenecks in each stage of a process.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the Funnel chart icon.
- Add data to the visual by dragging fields from the Data panel to the appropriate field wells in the Visuals panel:
- Drag a dimension to the Group by field well.
- Drag a measure to the Value field well.
- Add drill-down layers by dragging one or more additional fields to the Group by field well.
- Customize the appearance of the visual in the Properties panel on the right.
- Under Display Settings, format the title and subtitle.For more information, see Formatting Titles and Subtitles in Visuals.
- Under Value, format the value field.
- To remove or display the field title, click , the Hide axis title icon, or , the Show axis title icon, next to Title.
You can also enter a custom title in the text box. To include a parameter in the title, click
, the Insert parameter icon. - To remove or display the quick sort icon, click , the Hide quick sort icon icon, or , the Show quick sort icon icon, next to Sort.
- To remove or display the field title, click
- Under Group by, format the group by field.
- To remove or display the field title, click , the Hide axis title icon, or , the Show axis title icon, next to Title.
You can also enter a custom title in the text box. To include a parameter in the title, click
, the Insert parameter icon. - To remove or display the quick sort icon, click , the Hide quick sort icon icon, or , the Show quick sort icon icon, next to Sort.
- Under Number of stages displayed, enter the maximum number of stages to include in the funnel chart.
The remaining smaller stages are grouped into the Other stage. To hide the Other stage from the funnel chart, click
, the Menu options button, in the corner of the visual, and select Hide "other" categories.
- To remove or display the field title, click
- Under Data labels, format the labels.For more information, see Formatting Data Labels in Visuals.
- Under Display Settings, format the title and subtitle.
1.4.2.1.8 Using Gauge Charts
To create a gauge chart, you need to use at least one measure in the Value field well. If you want to compare two measures, add the additional measure in the Target value field well. If you want to compare a single measure to a target value that is not in your dataset, you can use a calculated field that contains a fixed value.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the Gauge chart icon.
- Add data to the visual by dragging fields from the Data panel to the appropriate field wells in the Visuals panel:
- Drag a measure to the Value field well.
- To add a comparison value, drag a different measure to the Target value field well.
- Customize the appearance of the visual in the Properties panel on the right.
- Under Display Settings, format the title and subtitle.For more information, see Formatting Titles and Subtitles in Visuals.
- Under Gauge options, specify formatting settings for the values, the axis, and the arc of the gauge chart.
- Under Value displayed, specify whether to hide the value, display the primary value, or display a comparison between the primary value and the target value. When you display a comparison, you must also select the comparison method. You can compare the values as a percent, show the actual difference between the values, or show the difference as a percent.
- Under Axis, set the minimum and maximum values for the range displayed in the gauge chart and enter a value for the reserve padding that is added to the top of the range.
- Under Arc style and Thickness, set the length and the thickness of the arc.
- Under Primary value font size, select a font size option.
- Under Data labels, format the labels.For more information, see Formatting Data Labels in Visuals.
- Under Display Settings, format the title and subtitle.
1.4.2.1.9 Using Heat Maps
Each rectangle on a heat map represents the value of the specified measure for the intersection of the selected dimensions. The color of the rectangle shows where the value falls within the range for the measure. Darker colors indicate higher values and lighter colors indicate lower values.
Heat maps and pivot tables display data in a similar tabular fashion. Use a heat map if you want to identify trends and outliers, because the use of color makes them easier to notice. Use a pivot table if you want to further analyze the data in the visual, for example by changing the column sort order or by applying aggregate functions.
To create a heat map, you must choose at least two fields of any data type. The rectangle values are populated with the count of the x-axis value for the intersecting y-axis value. Usually, you choose a measure and two dimensions. For example, you can create a heat map to compare the number of printed copies in each location, over a period of several months.
Heat maps show up to 50 data points for rows and up to 50 data points for columns.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the Heat map icon.
- Add data to the visual by dragging fields from the Data panel to the appropriate field wells in the Visuals panel:
- Drag a dimension to the Rows field well.
- Drag a dimension to the Columns field well.
- Drag a measure to the Values field well.
- Add drill-down layers by dragging one or more additional fields to the Rows or Columns field well.
- Customize the appearance of the visual in the Properties panel on the right.
- Under Display Settings, format the title and subtitle.For more information, see Formatting Titles and Subtitles in Visuals.
- Under Rows and Columns, set formatting settings for the rows and columns.
- To remove or display titles, click , the Hide axis title icon, or , the Show axis title icon, next to Title.
You can also enter a custom title in the text box. To include a parameter in the title, click
, the Insert parameter icon. - To remove or display the quick sort icon, click , the Hide quick sort icon icon, or , the Show quick sort icon icon, next to Sort.
- Under Label size, set the size of the label.
- Under Number of rows to show and Number of columns to show, enter the maximum number of rows and columns to include in the heat map.
- To remove or display titles, click
- Under Color, configure color settings for the values displayed in the heat map.
- Under Gradient color, select the colors that you want to use for the highest value and the lowest value.
- To add a third color, enable the Enable 3 colors option. You can enter the value that defines the midpoint between the two main gradient colors in the Point of divergence field.
- To limit the visual to the colors that you specified instead of using a gradient, enable the Enable steps option.
- Under Color for Null Value, select the color that you want to use for null values.
- Under Legend, format the legend.For more information, see Formatting Legends in Visuals.
- Under Data labels, format the labels.For more information, see Formatting Data Labels in Visuals.
- Under Display Settings, format the title and subtitle.
1.4.2.1.10 Using Highcharts
- These JSON values are not supported in the Chart code editor: functions, dates, and undefined values.
- Links to GeoJSON files or other images are not supported.
- You cannot set field colors in Highcharts visuals. The default theme colors are always applied.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the Highcharts visual icon.
- In the Properties panel on the right, configure the visual.
- Under Display Settings, format the title and subtitle.For more information, see Formatting Titles and Subtitles in Visuals.
- Under Data point limit, enter the maximum number of data points that you want the visual to display in the
Number of data points to show field.Highcharts visuals can show up to 10,000 data points.
- Under Chart code, enter a JSON schema into the code editor and click Apply code.The editor provides contextual assistance and real-time validation to ensure that your input JSON is configured properly. You can see any identified errors or warnings in the Errors section.Note: For more information and code samples, see the resources available in the Reference section.
- Under Display Settings, format the title and subtitle.
- Add data to the visual by dragging fields from the Data panel on the left to the appropriate field wells in the Visuals panel:
- Drag dimensions to the Group by field well.
- Drag measures to the Value field well.
You can pull data from the fields added in the field wells by using thegetColumnexpression in the chart code. For more information, see JSON Expression Language for Highcharts.
1.4.2.1.10.1 JSON Expression Language for Highcharts
With the JSON expression language, expressions are represented as arrays, where the
first element specifies the operation and the subsequent elements are the arguments.
For example, ["unique", [1, 2, 2]] applies the unique operation to the array [1, 2, 2], resulting in [1, 2].
Nested expressions are also supported. Nested expressions are expressions that contain
other expressions as arguments. For example, ["split", ["toUpper", "sample text"], " "] first converts the string sample text to uppercase, then splits it into an array of words, resulting in ["SAMPLE", "TEXT"].
Supported Arithmetic Expressions
You can use these arithmetic expressions with the JSON expression language:
| Operation | Expression | Input | Output |
|---|---|---|---|
| Addition | ["+", operand1, operand2] | { sum: ["+", 2, 4] } | { sum: 6 } |
| Subtraction | ["-", operand1, operand2] | { difference: ["-", 10, 3] } | { difference: 7 } |
| Multiplication | ["*", operand1, operand2] | { product: ["*", 5, 6] } | { product: 30 } |
| Division | ["/", operand1, operand2] | { quotient: ["/", 20, 4] } | { quotient: 5 } |
| Modulo | ["%", operand1, operand2] | { remainder: ["%", 15, 4] } | { remainder: 3 } |
| Exponentiation | ["**", base, exponent] | { power: ["**", 2, 3] } | { power: 8 } |
| Absolute Value | ["abs", operand] | { absolute: ["abs", -5] } | { absolute: 5 } |
| Square Root | ["sqrt", operand] | { sqroot: ["sqrt", 16] } | { sqroot: 4 } |
| Logarithm (base 10) | ["log10", operand] | { log: ["log10", 100] } | { log: 2 } |
| Natural Logarithm | ["ln", operand] | { ln: ["ln", Math.E] } | { ln: 1 } |
| Round | ["round", operand] | { rounded: ["round", 3.7] } | { rounded: 4 } |
| Floor | ["floor", operand] | { floor: ["floor", 3.7] } | { floor: 3 } |
| Ceiling | ["ceil", operand] | { ceiling: ["ceil", 3.2] } | { ceiling: 4 } |
| Sine | ["sin", operand] | { sine: ["sin", 0] } | { sine: 0 } |
| Cosine | ["cos", operand] | { cosine: ["cos", 0] } | { cosine: 1 } |
| Tangent | ["tan", operand] | { tangent: ["tan", Math.PI] } | { tangent: 0 } |
Supported Array Operations
map- Applies a mapping function to each element of an array and returns a new array with the transformed values.For example,
["map", [1, 2, 3], ["*", ["item"], 2]]maps each element of the array[1, 2, 3]by multiplying it by 2.filter– Filters an array based on a given condition and returns a new array containing only the elements that satisfy the condition.For example,
["filter", [1, 2, 3, 4, 5], ["==", ["%", ["item"], 2], 0]]filters the array[1, 2, 3, 4, 5]to include only the even numbers.reduce– Reduces an array to a single value by applying a reducer function to each element and accumulating the result.For example,
["reduce", [1, 2, 3, 4, 5], ["+", ["acc"], ["item"]], 0]reduces the array[1, 2, 3, 4, 5]to the sum of its elements.get– Retrieves a value from an object or an array by specifying a key or index.For example,
["get", ["item"], "name"]retrieves the value of the"name"property from the current item.unique– Returns only unique items inside an array.For example,
["unique", [1, 2, 2]]returns[1, 2].
Custom Expressions
You can use custom expressions to enhance the functionality of Highcharts visuals.
- getColumn
- Use the
getColumnexpression to return values from specified column indices. For example, this table shows a list of locations and their printer throughput:Location name Printer throughput Location A 100 Location B 50 Location C 75 This
getColumnquery generates an array that shows all location names alongside their printer throughput:{ location name: ["getColumn", 0], printer throughput: ["getColumn", 1] }{ location name: ["Location A", "Location B", "Location C"], printer throughput: [100, 50, 75] }You can also pass multiple columns at once to generate an array of arrays, as shown in this example:
{ values: ["getColumn", 0, 1] }{ values: [["Location A", 100], ["Location B", 50], ["Location C", 75]] }Similar to
getColumn, these expressions can be used to return column values from field wells or themes:getColumnFromGroupByreturns columns from the Group by field. The second argument is the index of the column to return. For example,["getColumnFromGroupBy", 0]returns the values of the first field as an array. You can pass multiple indices to get an array of arrays where each element corresponds to the field in the Group by field well.getColumnFromValuereturns columns from the Value field well. You can pass multiple indices to get an array of arrays where each element corresponds to the field in the Value field well.getColorThemereturns the current color palette of a theme, as shown in this example:{ "color": ["getColorTheme"] }
- formatValue
- Use the
formatValueexpression to apply formatting to your values. For example, this expression formats the x-axis label with the format value that is specified in the first field from the field wells:"xAxis": { "categories": ["getColumn", 0], "labels": { "formatter": ["formatValue", "value", 0] } }
1.4.2.1.11 Using Histograms
To create a histogram, you use one measure. A new histogram initially displays 10 bins across the x-axis. The bins appear as bars on the chart and you can customize them to suit your data. The y-axis displays the absolute count of the values in each bin.
Make sure that you adjust the format settings so that you have a clearly identifiable shape. If your data contains outliers, you usually notice one or more values off to the side of the x-axis.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the Histogram icon.
- Add data to the visual by dragging a measure from the Data panel to the Value field well in the Visuals panel.
The x-axis displays 10 bins by default, representing the intervals in the measure that you added, such as 1–10, 10–20, 20–30, and so on. When you hover over the bins, you see the interval that they represent. A square bracket next to a number indicates that the number is included, while a parenthesis indicates that the number is excluded. For example, in the interval [1, 10), the number 1 is included in the interval and the number 10 is excluded.
The y-axis displays the absolute count of individual values in each bin. The sum of all bins equals exactly 100% of the values in the selected data.
- Customize the appearance of the visual in the Properties panel on the right.
- Under Display Settings, format the title and subtitle.For more information, see Formatting Titles and Subtitles in Visuals.
- Under Histogram, format the bins either by count or width and enter the starting value.
- To use the bin count for the format, select Bin count and enter the number of bins to display on the x-axis.
- To use the bin width for the format, select Bin width and enter the width, or length, of each interval. This setting controls the number of items or events to include in each bin. For example, if your data is in minutes, you can enter 10 to show 10-minute intervals.
- Under Bins start at, enter the starting value for the bins.
- Under X-axis and Y-axis, configure the axes, the grid lines, and the range and scale.
- Under X-axis, enter the maximum number of bins in the Number of data points to show field.
- Under Y-axis, enable the Logarithmic Scale option to avoid misleading results. For example, if the shape is skewed so far to the right that you cannot interpret it properly, you can apply a logarithmic scale to reduce the skew.
For information on the other available settings, see Formatting Axes and Grid Lines in Visuals and Configuring Range and Scale in Visuals.
- Under Data labels, format the labels.For more information, see Formatting Data Labels in Visuals.
- Under Display Settings, format the title and subtitle.
1.4.2.1.12 Using Image Components
- .bmp
- .jpg/.jpeg
- .png
- .tiff
- .webp
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click
, the Add Image button, on the toolbar. - In the file browser dialog, select the image that you want to upload and click Open.The procedure for uploading the file depends on your web browser. The maximum supported file size is 1 MB.
- Customize the appearance of the image component in the Properties panel on the right.
- Under Display Settings, enter an alternative text for the image.
- Under Image, select a scaling option.
1.4.2.1.13 Using Key Performance Indicators
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the KPI icon.
- Add data to the visual by dragging fields from the Data panel to the appropriate field wells in the Visuals panel:
- Drag a measure to the Value field well.
- To add a comparison value, drag a different measure to the Target value field well.
- To add trend data, drag a dimension to the Trend group field well.You can either add a trend group or a target value to a KPI, not both.
- Add drill-down layers by dragging one or more additional fields to the Trend group field well.
- Hover over the visual and click
, the KPI Layouts button, in the top-right corner to open the KPI Layouts panel, and then select one of the available layouts. - Customize the appearance of the visual in the Properties panel on the right.
- Under Display Settings, format the title and subtitle.For more information, see Formatting Titles and Subtitles in Visuals.
- Under KPI options, specify formatting settings for the values and the visualization displayed in the
KPI.
- Under Primary value, set the font color and size for the primary value and specify whether to display the actual primary value or a comparison between the primary value and the target value or trend group value.
- To display the target value or trend group value along with the primary value, enable the Secondary value option. Then, set a font color and size.
- If the KPI includes a target value or a trend group value, select a comparison method
and set the formatting for the comparison value in the Comparison section. You can show the actual difference between the values, compare the values
as a percent, or show the difference as a percent.
In KPIs with a trend group value, you can show or hide the trend direction icon by clicking
, the Show icon, or , the Hide icon, next to Trend direction. - To include a visualization in the KPI, enable the Visual option and select a visualization type. If the KPI includes a target value, you can add a progress bar. If the KPI includes a trend value, you can add a progress bar, a sparkline, or an area sparkline.
- Under Display Settings, format the title and subtitle.
1.4.2.1.14 Using Layer Maps
Layer map visuals only support polygon shapes. Line and point geometries are not supported.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the Layer map icon.
- Inside the visual, click Add shape layer.
- In the Layer properties panel on the right, enter a name for the layer under Layer options.
- Under Shape source, click Upload shape file.
- In the file browser dialog, select the GeoJSON file that you want to use and click
Open.The procedure for uploading the file depends on your web browser. The maximum supported file size is 100 MB.
- Under Data, select fields for the visual.
- From the Shape file key field list, select the field that you want the shape to visualize from the fields available in the uploaded shape file.
- From the Dataset key field list, select the dataset field that you want the shape to visualize.
- To assign color to the shapes, select a field under Color.If the color field is a measure, the shape uses gradient coloring. If the color field is a dimension, the shape uses categorical coloring. If a color field is not assigned to the shape, you can use the fill color option in the Styling section to set a common color for all shapes.
- Under Styling, set the fill color and opacity and the border color, thickness, and opacity.If you did not assign a color field to the shape, you can use the fill color option to set a common color for all shapes.
- Click , the Format visual icon, in the top-right corner of the visual.
- In the Properties panel, customize the appearance of the visual.
- Under Display Settings, format the title and subtitle.For more information, see Formatting Titles and Subtitles in Visuals.
- Under Map options, select the type of the base map that appears beneath the data.For example, you can use a gray canvas, a street view, or a satellite view.
- To enable panning and zooming for the map, enable the Allow panning and zooming option.
- Under Map layers, click
, the Open menu icon, next to a map layer and select Edit to update the layer settings.
- Under Display Settings, format the title and subtitle.
1.4.2.1.15 Using Line Charts
For example, you can use line charts in one of these scenarios:
- To display one measure over a time period, such as printer throughput by month.
- To display multiple measures over a time period, such as printer throughput and ink consumption by month.
- To display one measure for a dimension over a time period, such as the number of errors for each printer by day.
Several types of line charts are available:
- Line chart
- Regular line charts show the individual values of a set of measures or dimensions against the range displayed by the y-axis. Each value is represented as a line.
- Area line chart
- In area line charts, each value is represented as a colored area instead of just a line, to make it easier to compare item values. The area between the line and the x-axis is filled with color.
- Stacked area line chart
- In stacked area line charts, the area between the line and the x-axis is filled with color and the individual lines are layered to show the relationships between them more clearly. The values on the y-axis show the scale of the differences between data points. Use stacked area line charts to compare changes in values for one or more groups of measures or dimensions over a time period.
Line charts show up to 10,000 data points on the x-axis when no color field is selected. When a color field is included, line charts show up to 400 data points on the x-axis and up to 25 data points for color.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the icon for the type of line chart that you want to create.
Line chart
Area line chart
Stacked area line chart
- Add data to the visual by dragging fields from the Data panel to the appropriate field wells in the Visuals panel.
- To create a single-measure line chart, drag a dimension to the X axis field well and one measure to the Value field well.
- To create a multi-measure line chart, drag a dimension to the X axis field well and two or more measures to the Value field well.
When you add more than one measure in the Value field well, each item is represented as a separate line in the chart and is automatically added to the chart legend. If one of the fields uses a considerably different scale, you can display it on the right axis. Click
, the Options button, next to the field and select Show on: Right Y-axis. - To create a multi-dimension line chart, drag a dimension to the X axis field well, one measure to the Value field well, and one dimension to the Color field well.
To add drill-down layers, drag at least one more field to the X axis or Color field wells. - Optional: To divide the visual into several smaller visuals, each with a different view of the
same data, drag a dimension from the Data panel to the Small Multiples field well.Each copy of the visual shows a different data view based on the selected dimension. This function is useful when you want to display multiple comparative visuals side by side. For example, you can create a set of visuals that show a different data view for every location.This function is not available for area line charts.
- Customize the appearance of the visual in the Properties panel on the right.
- Under Display Settings, format the title and subtitle.For more information, see Formatting Titles and Subtitles in Visuals.
- If you added fields to the Small Multiples field well to display multiple visuals side by side, configure the formatting settings
available under Multiples Options.
- Under Layout, set the number of rows and columns that are visible without scrolling and the maximum number of panels.
- To specify whether the visuals use shared or independent axes, select Shared or Independent under X-axis and Y-axis.
If the visuals use an independent x-axis, only the values that are relevant to each panel are shown on the axis. For example, if the panels display data per shift, each panel shows only the data for a specific shift. If the visuals use an independent y-axis, each panel has its own y-axis scale that depends on the range of the data it contains.
- To set the label position for shared axes, select Outside or Inside under X-axis labels and Y-axis labels.
- To display panel titles, enable the Panel title option and set the title size, color, style, and alignment.
- To display panel borders, enable the Panel border option and set the border thickness, type, and color.
- To display panel gutters, enable the Panel gutter option and set the spacing.
- To set a background color for the panels, enable the Panel background option and select a color.
- Under Data series, specify formatting settings for the data series.
- In regular line charts, to change the base style used for all the data series, click
Base style. In the Edit base style panel, you can hide or display the lines and markers and set their size, color, and
style. You can also specify whether to show the data on the left or on the right y-axis.
To customize the format of a specific data series, click Select series to style and select a field from the list.
- In area charts, all the data series are displayed in a list and you can specify whether to show the data on the left or on the right y-axis.
You can also select a data series directly in the visual and use the options from the menu to apply styling and color settings.
- In regular line charts, to change the base style used for all the data series, click
Base style. In the Edit base style panel, you can hide or display the lines and markers and set their size, color, and
style. You can also specify whether to show the data on the left or on the right y-axis.
- Under X-axis and Y-axis, configure the axes, the grid lines, and the range and scale.
- Under X-axis, enter the maximum number of data points in the Number of data points to show field and enable the Show date gaps option if you want to include date gaps in the chart.
- Under Y-axis, specify how missing data points are displayed in the chart by selecting one of the
options available for Missing data.
To display a continuous line by skipping over the missing data point and connecting the line to the next available data point in the series, select Continuous line. The Show date gaps option under X-axis must be disabled.
To display a disjointed line that breaks when a data point is missing, select Broken line.
To set the value of the missing data point to zero, select Show as zero.
- If the chart has two y-axes, you can format each y-axis separately under Left Y-axis and Right Y-axis. You can also combine the y-axes into a single axis by enabling the Single Y-axis option.
For information on the other available settings, see Formatting Axes and Grid Lines in Visuals and Configuring Range and Scale in Visuals.
- Under Group/Color, enter the maximum number of lines to display.The remaining data is grouped under the Other category. To hide the Other category from the chart, click, the Menu options button, in the corner of the visual, and select Hide "other" categories.
- Under Reference lines, add reference lines if there are other values that you want to display along with
the chart data.For more information, see Adding Reference Lines to Visuals.
- Under Legend, format the legend.For more information, see Formatting Legends in Visuals.
- Under Data labels, format the labels.For more information, see Formatting Data Labels in Visuals.
The settings available in the Properties panel depend on the line chart type and configuration. - Under Display Settings, format the title and subtitle.
1.4.2.1.16 Using Map Charts
These types of map charts are available:
- Point map
- Shows the difference between data values for each location by size.
Each point on the map corresponds to a geographic location in your data, such as a country, state or province, or city. The size of the points represents the magnitude of the field in the Size field well, in relation to other values in the same field. The color of the points represents the values in the Color field well.
- Filled map
- Shows the difference between data values for each location by varying shades of color.
Each location in your data is filled in with color based on the number of times that it appears in the dataset. If you add a measure to the Color field well, each location updates to show the sum of the measure.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the icon for the type of map chart that you want to create.
Points on map
Filled map
- Add data to the visual by dragging fields from the Data panel to the appropriate field wells in the Visuals panel.
- To create a point map, drag a dimension to the Geospatial field well, a measure to the Size field well, and, optionally, a dimension to the Color field well.
- To create a filled map, drag a dimension to the Location field well and, optionally, a measure to the Color field well.
To add drill-down layers, drag at least one more field to the Geospatial or Color field wells in a point map or to the Location field well in a filled map. - Customize the appearance of the visual in the Properties panel on the right.
- Under Display Settings, format the title and subtitle.For more information, see Formatting Titles and Subtitles in Visuals.
- For point maps, select a style option under Points.
- Basic points - Uses the default display setting for map points.
- Cluster points - Clusters map points together when there are too many markers close together in one area. You can use marker clustering to improve the readability of collocated points on a map.
- Heatmap - Displays concentrations of data points using a colored overlay that highlights the intensity or concentration of the markers in the visual. You can use geospatial heatmaps to reveal patterns of marker concentration. Set the color that you want to use for the high density and low density values under Heatmap gradient.
- Under Base map, select the type of the base map that appears beneath the data.For example, you can use a gray canvas, a street view, or a satellite view.
- Under Legend, format the legend.For more information, see Formatting Legends in Visuals.
- Under Display Settings, format the title and subtitle.
1.4.2.1.17 Using Pie Charts
Each wedge in a pie chart shows one item in the dimension. The wedge size is proportional
to the quantity that it represents. 
To create a pie chart, use one dimension in the Group/Color field well. With only one field, the chart displays the division of values by row count. To display the division of dimension values by a metric value, you can add a metric field to the Value field well.
Pie charts show up to 20 data points for group or color.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the Pie chart icon.
- Add data to the visual by dragging fields from the Data panel to the appropriate field wells in the Visuals panel:
- Drag a dimension to the Group/Color field well.
- Drag a measure to the Value field well.
- Add drill-down layers by dragging one or more additional fields to the Group/Color field well.
- Optional: To divide the visual into several smaller visuals, each with a different view of the
same data, drag a dimension from the Data panel to the Small Multiples field well.Each copy of the visual shows a different data view based on the selected dimension. This function is useful when you want to display multiple comparative visuals side by side. For example, you can create a set of visuals that show a different data view for every location.
- Customize the appearance of the visual in the Properties panel on the right.
- Under Display Settings, format the title and subtitle.For more information, see Formatting Titles and Subtitles in Visuals.
- If you added fields to the Small Multiples field well to display multiple visuals side by side, configure the formatting settings
available under Multiples Options.
- Under Layout, set the number of rows and columns that are visible without scrolling and the maximum number of panels.
- To display panel titles, enable the Panel title option and set the title size, color, style, and alignment.
- To display panel borders, enable the Panel border option and set the border thickness, type, and color.
- To display panel gutters, enable the Panel gutter option and set the spacing.
- To set a background color for the panels, enable the Panel background option and select a color.
- Under Value, format the value field.
- To remove or display the field title, click , the Hide axis title icon, or , the Show axis title icon, next to Title.
You can also enter a custom title in the text box. To include a parameter in the title, click
, the Insert parameter icon. - To remove or display the quick sort icon, click , the Hide quick sort icon icon, or , the Show quick sort icon icon, next to Sort.
- To remove or display the field title, click
- Under Group/Color, format the group or color field.
- To remove or display the field title, click , the Hide axis title icon, or , the Show axis title icon, next to Title.
You can also enter a custom title in the text box. To include a parameter in the title, click
, the Insert parameter icon. - To remove or display the quick sort icon, click , the Hide quick sort icon icon, or , the Show quick sort icon icon, next to Sort.
- Under Number of slices displayed, enter the maximum number of slices to include in the pie chart.
The remaining smaller slices are grouped into the Other slice. To hide the Other slice from the pie chart, click
, the Menu options button, in the corner of the visual, and select Hide "other" categories.
- To remove or display the field title, click
- Under Legend, format the legend.For more information, see Formatting Legends in Visuals.
- Under Data labels, format the labels.For more information, see Formatting Data Labels in Visuals.
- Under Display Settings, format the title and subtitle.
1.4.2.1.18 Using Pivot Tables
Pivot tables and heat maps display data in a similar tabular fashion. Use a pivot table if you want to further analyze the data in the visual, for example by changing the column sort order or by applying aggregate functions. Use a heat map if you want to identify trends and outliers, because the use of color makes them easier to notice.
To create a pivot table, choose at least one field of any data type. Usually, you add a measure and two related dimensions.
You can add up to 20 fields as rows and 20 fields as columns. Up to 500,000 records are supported.
Pivot tables provide several useful functions:
- Specify multiple measures to populate the cell values of the table so that you can see a range of data.
- Cluster columns and rows to show values for subcategories grouped by a related dimension.
- Sort values in rows or columns.
- Apply statistical functions.
- Add totals and subtotals to rows and columns.
- Use infinite scroll.
- Create custom total aggregations.
To reduce the level of complexity and keep the pivot table easy to use and understand, try to include a minimal set of rows, columns, metrics, and table calculations.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the Pivot table icon.
- Add data to the visual by dragging fields from the Data panel to the appropriate field wells in the Visuals panel:
- To create a single-measure pivot table, drag a dimension to the Rows field well, a dimension to the Columns field well, and a measure to the Values field well.
- To create a multi-measure pivot table, drag a dimension to the Rows field well, a dimension to the Columns field well, and two or more measures to the Values field well.
- To create a clustered pivot table, drag two or more dimensions to the Rows field well, two or more dimensions to the Columns field well, and a measure to the Values field well.
You can also select multiple fields for all the pivot table field wells to combine the multi-measure and clustered approaches.Note: To view roll-ups for calculated fields, make sure that you use aggregates. For example, a calculated field withfield-1 / field-2does not display a summary when rolled up. However,sum(field-1) / sum(field-2)does display a roll-up summary. - To collapse a group of rows or columns in a clustered pivot table, click
, the Collapse icon, next to a field name.You can expand a collapsed group by clicking
, the Expand icon. - To hide rows, columns, and values from a pivot table, click , the Options button, next to a field in the Visuals panel and select Hide from the menu.You can show all the hidden fields by clicking, the Options button, next to any field and selecting Show all hidden fields.
- To change columns to rows and rows to columns, click
, the Swap rows and columns icon, in the top-right corner of the pivot table. - To adjust the row height, hover over the horizontal lines between rows until the resize cursor appears, and then drag the lines to a new position.
- To adjust the column width, hover over the vertical lines between columns until the resize cursor appears, and then drag the lines to a new position.
- Customize the appearance of the visual in the Properties panel on the right.
- Under Display Settings, format the title and subtitle.For more information, see Formatting Titles and Subtitles in Visuals.
- Under Pivot options, set the layout of the pivot table.
- Under Layout, select Hierarchy or Tabular. In hierarchical pivot tables, all row fields are displayed in a single column labeled Rows. In tabular pivot tables, each field in the Rows field well has a separate title cell.
- Under Values position, select Columns or Rows. By default, pivot tables have a columnar format. When you change to a row-based format, a column with the value name is added to the right of the row header column.
- To hide the collapse and expand icons from the pivot table, click , the Hide +/– buttons icon, next to +/– buttons.
- To hide the columns that only have a single metric value, click , the Hide single metric icon, next to Single metric.
- To automatically hide all collapsed columns in a tabular pivot table, click , the Hide collapsed columns icon, next to Collapsed columns.
- Under Headers, format the row and column headers.
- For row headers in a hierarchical pivot table, to hide or display the rows label,
click , the Hide icon, or , the Show icon, next to Rows label. You can also enter a custom label and enable the Style rows label option if you want to also apply the formatting settings to the rows label.
- For row headers in a tabular pivot table, you can enable the Style field names option if you want to also apply the formatting settings to the field names.
- For column headers, to hide or display the column names, click , the Hide icon, or , the Show icon, next to Column field names. You can also enter the height of the header rows in pixels under Row height (pixels). Enter a whole number from 8 through 500.
- Customize the text color, size, and alignment, the background color, and the border settings.
- For row headers in a hierarchical pivot table, to hide or display the rows label,
click
- Under Cells, format the pivot table cells.
- Under Row height (pixels), enter the height of the pivot table rows in pixels. You can enter a whole number from 8 through 500.
- Under Column width (pixels), enter the width of the pivot table columns in pixels. You can enter a whole number from 25 through 1000.
- To expand the pivot table so it fills the current view, click Expand to view.
- Under Background, set the color of the background. You can enable the Alternate row colors option to set different colors for odd rows and even rows.
- Customize the text color, size, and alignment and the border settings.
- Under Total and Subtotal, format row and column totals and subtotals.For more information, see Adding Totals and Subtotals to Pivot Tables.
- Under Row names, Column names, and Value names, customize the names of the rows, columns, and values.Enter a custom name in the text box. To include a parameter in the name, click, the Insert parameter icon.
- Under Display Settings, format the title and subtitle.
- You can add any combination of row and column field values, up to a total of 40. For example, if you have 10 row field values, then you can add up to 30 column field values.
- You can use pivot table calculations only for non-aggregated values. For example, you cannot add a pivot table calculation to a calculated field that is a sum of a measure.
- If you are sorting by a custom metric, you cannot add a table calculation until you remove the custom metric sort. If you are using a table calculation and then add a custom metric, you cannot sort by the custom metric.
- Totals and subtotals are blank for table calculations on metrics aggregated by distinct count.
1.4.2.1.18.1 Adding Totals and Subtotals to Pivot Tables
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, select a pivot table.
- To display totals, click , the Menu options button, in the top-right corner of the pivot table and select Show totals for rows or Show totals for columns.You can remove the totals by selecting Hide totals for rows or Hide totals for columns from the menu.
- To display subtotals, click , the Menu options button and select Show subtotals for rows or Show subtotals for columns.You can remove the subtotals by selecting Hide subtotals for rows or Hide subtotals for columns from the menu.
- To unpin the row with the totals so that it moves along with the other rows when you
scroll, click , the Menu options button and select Unpin totals for rows.
- To change the default aggregation method for the totals, click , the Options button, next to a field from the Values field well in the Visuals panel, then select Totals and one of the available aggregate functions:
Default– Uses the same aggregation as the metric field.Sum– Calculates the sum of the data.Average– Calculates the average of the data.Min– Calculates the minimum value of the data.Max– Calculates the maximum value of the data.None (Hide)– The totals are not calculated and the total cells are left blank.
These limitations apply to custom totals:
- Conditional formatting is not supported for custom totals.
- Total aggregations, such as
Min,Max,Sum, andAverage, are not supported for string columns. - The
AverageandSumtotal aggregation functions are not supported for date and time columns.
- Click , the Format visual icon, in the top-right corner of the pivot table to open the Properties panel and configure the formatting settings from the Total and Subtotal sections.
- To format row and column totals, expand the Total section and customize the label, the position, the background color, the text color
and size, and the border settings under Rows and Columns.To also apply the formatting to all the cells in the same row or column as the totals, enable the Apply styling to cells option.
- To format row and column subtotals, expand the Subtotal section and configure the settings available under Rows and Columns.
- Under Level, specify whether to show only the subtotal of the last field in the chart hierarchy, to show subtotals for every field, or to show subtotals only for specific fields.
- Customize the label, the background color, the text color and size, and the border
settings.
For tabular pivot tables, you can also add group names to row subtotals. Enter a group name in the Label field or add a group name parameter.
- For row subtotals, select an option under Apply styling to to specify whether to apply the formatting only to headers, only to cells, or to both headers and cells .
- For column subtotals, enable the Apply styling to cells option if you want to also apply the formatting to all the cells in the same column as the subtotals.
- To format row and column totals, expand the Total section and customize the label, the position, the background color, the text color
and size, and the border settings under Rows and Columns.
1.4.2.1.18.2 Adding Table Calculations in Pivot Tables
The data type of the cell value automatically changes according to the calculation.
For example, if you apply the Rank function to a currency field, the values display as integers rather than currency.
Similarly, if you apply the Percent difference function, the cell values display as percentages.
You cannot run Total, Difference, and Percent Difference table calculations on a pivot table that is sorted by a measure. You must remove
the sorting option and then add the calculation.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, select a pivot table.
- In the Visuals panel, click , the Options button, next to a field from the Values field well.
- Select Add table calculation and choose a function from the list:
- Running total – Calculates the sum of a cell value and the values of all the cells before it. This
sum is calculated as
Cell1=Cell1,Cell2=Cell1+Cell2,Cell3=Cell1+Cell2+Cell3, and so on. - Difference – Calculates the difference between a cell value and the value of the cell before
it. This difference is calculated as
Cell1=Cell1-null,Cell2=Cell2-Cell1,Cell3=Cell3-Cell2, and so on. BecauseCell1-null=null, theCell1value is always empty. - Percentage difference – Calculates the percent difference between a cell value and the value of the cell
before it, divided by the value of the cell before it. This value is calculated as
Cell1=(Cell1-null)/null,Cell2=(Cell2-Cell1)/Cell1,Cell3=(Cell3-Cell2)/Cell2, and so on. Because(Cell1-null)/null=null, theCell1value is always empty. - Percent of total – Calculates the percentage that a cell represents out of the sum of all the cells
included in the calculation. This percentage is calculated as
Cell1=Cell1/(sum of all cells),Cell2=Cell2/(sum of all cells), and so on. - Rank – Calculates the rank of a cell value compared to the values of the other cells included
in the calculation. Rank always shows the highest value equal to 1 and the lowest
value equal to the count of cells included in the calculation.
If there are two or more cells with equal values, they receive the same rank but they each occupy a spot in the ranking. As a result, the next highest value moves down in rank by the number of cells at the rank above it, minus 1. For example, if you rank the values 5,3,3,4,3,2, their ranks are 1,3,3,2,3,6.
- Percentile – Calculates the percent of the values of the cells included in the calculation that
are at or below the value for a given cell. This percent is calculated as
percentile rank(x) = 100 * B / N, whereB = number of scores below xandN = number of scores.
- Running total – Calculates the sum of a cell value and the values of all the cells before it. This
sum is calculated as
- To change how the calculation is applied, click , the Options button, next to a field with a calculation, then select Calculate as and choose an option from the list:
- Table across – Applies the calculation across the rows, regardless of any grouping.
- Table down – Applies the calculation down the columns, regardless of any grouping.
- Table across down – Applies the calculation across the rows, and then takes the results and reapplies the calculation down the columns.
- Table down across – Applies the calculation down the columns, and then takes the results and reapplies the calculation across the rows.
- Group across – Applies the calculation across the rows within group boundaries, as determined
by the second level of grouping applied to the columns.
For example, if you group by field-2 and then by field-1, grouping is applied at the field-2 level. If you group by field-3, field-2, and field-1, grouping is again applied at the field-2 level.
- Group down – Applies the calculation down the columns within group boundaries, as determined
by the second level of grouping applied to the rows.
For example, if you group by field-2 and then by field-1, grouping is applied at the field-2 level. If you group by field-3, field-2, and field-1, grouping is again applied at the field-2 level.
- Group across down – Applies the calculation across the rows within group boundaries, as determined
by the second level of grouping applied to the columns. Then the function takes the
results and reapplies the calculation down the columns within group boundaries, as
determined by the second level of grouping applied to the rows.
For example, if you group a row or column by field-2 and then by field-1, grouping is applied at the field-2 level. If you group by field-3, field-2, and field-1, grouping is again applied at the field-2 level.
- Group down across – Applies the calculation down the columns within group boundaries, as determined
by the second level of grouping applied to the rows. Then the function takes the results
and reapplies the calculation across the rows within group boundaries, as determined
by the second level of grouping applied to the columns.
For example, if you group a row or column by field-2 and then by field-1, grouping is applied at the field-2 level. If you group by field-3, field-2, and field-1, grouping is again applied at the field-2 level.
, the Options button, next to a field with a calculation and selecting Remove calculation.1.4.2.1.18.3 Sorting Data in Pivot Tables
- Note:
- When you have multiple clusters in a pivot table, sorting is applied to each cluster independently. The sort starts over for each cluster.
- When you apply multiple sorts to a pivot table, sorting is applied from the outside dimension to the inside dimension.
- You cannot run
Total,Difference, andPercent Differencetable calculations on a pivot table that is sorted by a measure.
The available methods of sorting the data depend on whether the pivot table has a tabular or a hierarchical format. In tabular pivot tables, each field in the Rows field well has a separate title cell. For hierarchical pivot tables, all row fields are displayed in a single column labeled Rows.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, select a pivot table.
- To sort data using row or column headers, click a row or column header, then select
a field to sort by and the sort order.You can sort dimension fields alphabetically or you can sort them by a measure in ascending or descending order.
- To sort data using value headers, click the value header that you want to sort and
select Sort ascending or Sort descending.Sorting by value headers in a pivot table also works on subtotals.
- To sort by a field that is not included in the pivot table:
- In the Visuals panel, click , the Options button, next to the field that you want to sort.
- Select .
- On the Off-visual field panel, select the field that you want to sort by and the aggregation method, set the sort order, and click Apply.
- In the Visuals panel, click
- To sort the row fields in a hierarchical pivot table, click the Rows header, then set the field to sort by and the sort order for each row field in the list.
1.4.2.1.19 Using Radar Charts
You can organize a radar chart along its category, value, or color axes by dragging fields to the Category, Value, and Color field wells. The way you distribute fields among the field wells determines the axis that the data is plotted on.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the Radar chart icon.
- Add data to the visual by dragging fields from the Data panel to the appropriate field wells in the Visuals panel.The way that you place fields in the different field wells determines the axis that a radar chart is organized around:
- To create a radar chart that uses a value axis, drag one dimension to the Color field well and at least one measure to the Value field well.
In this type of radar chart, the dimension values are shown as lines and the axes represent value fields.
- To create a radar chart that uses a dimension axis, drag one dimension to the Category field well and at least one measure to the Value field well.
In this type of radar chart, group dimension values are shown as axes and value fields are shown as lines. All axes share a range and scale.
- To create a radar chart that uses a dimension-color axis, drag one dimension to the
Category field well, one measure to the Value field well, and one dimension to the Color field well.
In this type of radar chart, group dimension values are shown as axes and color dimension values are shown as lines. All axes share a range and scale.
To add drill-down layers, drag at least one more field to the Category or Color field wells. - To create a radar chart that uses a value axis, drag one dimension to the Color field well and at least one measure to the Value field well.
- Customize the appearance of the visual in the Properties panel on the right.
- Under Display Settings, format the title and subtitle.For more information, see Formatting Titles and Subtitles in Visuals.
- Under Radar Chart, set the grid shape, the series style, and the start angle.
- Under Axis, configure the axes, the grid lines, and the range and scale.
- To remove or display axis lines, click , the Hide axis line icon, or , the Show axis line icon, next to Axis line.
- To show axis labels, enable the Show axis labels option and set the label size.
- To show labels for the values in the chart, enable the Show value labels option and set the label size.
- To fill the space between the grid lines with color, enable the Fill grid lines option. You can set alternate fill colors for the grid lines.
- Under Range, set the range for the axes.
If you select Auto (starting at 0), the range starts at 0 and ends around the highest value for the measure being displayed. If you select Auto (based on data range), the range starts at the lowest value and ends around the highest value for the measure being displayed. You can also select Custom to specify custom start and end values in the Min and Max fields.
- Under Axis behavior, specify whether to use an independent or shared scale for the axes. The Shared option is useful for comparisons across category axes. You can select the Auto option to automatically determine the optimal scale based on the chart configuration.
- To customize the number of values to show on the axes, enter a custom value under Axis step count. You can enter a value from 1 through 50.
- To remove or display axis lines, click
- Under Legend, format the legend.For more information, see Formatting Legends in Visuals.
- Under Display Settings, format the title and subtitle.
1.4.2.1.20 Using Sankey Diagrams
In this sample Sankey diagram, the source node A on the left links to the destination
nodes W, Y, and X on the right. The width of each link between the nodes depends on
the measure added to the Weight field well. The nodes are automatically ordered.
In this multilevel Sankey diagram, the A node on the left links to the W, Y, and X
nodes in the middle, which then link to the Z node on the right.
When your data contains cycles, the nodes in each cycle are repeated in the diagram.
For example, this cyclical Sankey diagram displays the flow A-E-A-B-A-E-A.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the Sankey diagram icon.
- Add data to the visual by dragging fields from the Data panel to the appropriate field wells in the Visuals panel:
- Drag a dimension to the Source field well.
- Drag a dimension to the Destination field well.
- Drag a measure to the Weight field well.
- Customize the appearance of the visual in the Properties panel on the right.
- Under Display Settings, format the title and subtitle.For more information, see Formatting Titles and Subtitles in Visuals.
- Under Source, enter the maximum number of source nodes in the Number of nodes displayed field.
- Under Destination, enter the maximum number of destination nodes per source node in the Number of nodes displayed field.The nodes in the diagram update based on your settings. The top nodes are automatically shown and all the other nodes are placed in the Other category. To remove the Other category from the diagram, select it in the visual and choose Hide "other" categories from the menu.
- Under Data labels, format the labels.For more information, see Formatting Data Labels in Visuals.
- Under Display Settings, format the title and subtitle.
1.4.2.1.21 Using Scatter Plots
Each dot on the scatter plot represents one or two dimension values. The x and y axes represent two different measures that apply to the dimension. A dot appears on the chart at the point where the values for the two measures for an item in the dimension intersect. Optionally, you can also use an additional measure to determine the size of the dots.
For example, a scatter plot can display the number of errors and error duration for jobs that encountered a printer error. Each job is represented by a dot and the size of the dots depends on the error duration.
Scatter plots show up to 2500 data points regardless of whether a color or label dimension is used in the visual.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the Scatter plot icon.
- Add data to the visual by dragging fields from the Data panel to the appropriate field wells in the Visuals panel:
- Drag a measure to the X Axis field well.
- Drag a measure to the Y Axis field well.
- Drag a dimension to the Color field well.
- Drag a dimension to the Label field well.
- Drag a measure to the Size field well.
- Add drill-down layers by dragging one or more additional fields to the Color or Label field wells.
- Customize the appearance of the visual in the Properties panel on the right.
- Under Display Settings, format the title and subtitle.For more information, see Formatting Titles and Subtitles in Visuals.
- Under X-axis and Y-axis, configure the axes, the grid lines, and the range and scale.For more information, see Formatting Axes and Grid Lines in Visuals and Configuring Range and Scale in Visuals.
- Under Legend, format the legend.For more information, see Formatting Legends in Visuals.
- Under Data labels, format the labels.For more information, see Formatting Data Labels in Visuals.
- Under Data point limit, enter the maximum number of data points to include in the scatter plot.
- Under Display Settings, format the title and subtitle.
1.4.2.1.22 Using Tables
To create a table, you choose at least one field of any data type. You can add up to 200 columns to a table. You can also group the data, add calculated columns, and include totals.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the Table icon.
- Add data to the visual by dragging fields from the Data panel to the appropriate field wells in the Visuals panel:
- Drag at least one measure to the Value field well.You can also add calculated columns by clicking the + Calculated Field button in the Data panel.
- To create an aggregated view of the data, drag at least one dimension to the Group by field well.
- Drag at least one measure to the Value field well.
- To hide a column from the table, click the column header and select Hide from the menu.You can show all the hidden columns by clicking any column header and selecting Show all hidden fields.
- To change columns to rows and rows to columns, click , the Swap rows and columns icon, in the top-right corner of the table.
- To freeze columns, click a column header and select one of these options from the
menu:
- To freeze only that column, select Freeze column. The column moves to the farthest-left position available.
- To freeze that column and all the columns to its left, select Freeze up to this column.
- To unfreeze columns, click a column header and select one of these options from the
menu:
- To unfreeze that column only, select Unfreeze column.
- To unfreeze all frozen columns, select Unfreeze all columns.
- To rearrange the columns in the table, reorder the data fields in the Visuals panel or click a column header, and then click one of the arrows next to the Move option from the menu.
- To adjust the row height, hover over the horizontal lines between rows until the resize cursor appears, and then drag the lines to a new position.
- To adjust the column width, hover over the vertical lines between columns until the resize cursor appears, and then drag the lines to a new position.
- Customize the appearance of the visual in the Properties panel on the right.
- Under Display Settings, format the title and subtitle.For more information, see Formatting Titles and Subtitles in Visuals.
- Under Headers, format the headers of the table.
- To hide or display the headers, click , the Hide icon, or , the Show icon, next to Show headers.
- Under Row height (pixels), enter the height of the header row in pixels. You can enter a whole number from 8 through 500.
- Customize the text color, size, and alignment, the background color, and the border settings.
- To hide or display the headers, click
- Under Cells, format the table cells.
- Under Row height (pixels), enter the height of the table rows in pixels. You can enter a whole number from 8 through 500.
- Under Background, set the color of the background. You can enable the Alternate row colors option to set different colors for odd rows and even rows.
- Customize the text color, size, and alignment and the border settings.
- Under Totals, format the row with the totals.For more information, see Adding Totals to Tables.
- Under Visuals, specify whether to display data bars for the values in the table.To display data bars, click Add data bars, then select a value field and set the color for positive and negative values.
Data bars can help you visualize and compare data in a range of fields. You can only apply data bars to the fields from the Values field well. You can create up to 200 different data bar configurations for a single table.
- Under Field styling, specify formatting settings for URLs.
- Under Select field to style, select a field from the list.
- To display the URLs as hyperlinks, select Make URLs hyperlinks under URL options. Then, specify whether the links open in a new tab, a new window, or in the same tab and select a styling option.
- To display the URLs as images, select Show URLs as images under URL options. Then, specify whether you want to fit the images to the cell height or width. You can set any URLs in your table that point to an image to render as images.
You can add up to 500 rows of links for each page in a table. Only
httpsandmailtohyperlinks are supported. - Under Group-by column names and Value column names, customize the names of the group-by columns and value columns.Enter a custom name in the text box. To include a parameter in the name, click, the Insert parameter icon.
- Under Display Settings, format the title and subtitle.
1.4.2.1.22.1 Adding Totals to Tables
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, select a table.
- Click , the Menu options button, in the top-right corner of the table and select Show totals.You can remove the totals by selecting Hide totals from the menu.
- To unpin the row with the totals so that it moves along with the other rows when you
scroll, click , the Menu options button and select Unpin totals.
- To change the default aggregation method for the totals, click , the Options button, next to a field from the Value field well in the Visuals panel, then select Total and one of the available aggregate functions:
Default– Uses the same aggregation as the metric field.Sum– Calculates the sum of the data.Average– Calculates the average of the data.Min– Calculates the minimum value of the data.Max– Calculates the maximum value of the data.None (Hide)– The totals are not calculated and the total cells are left blank.
These limitations apply to custom totals:
- Conditional formatting is not supported for custom totals.
- Total aggregations, such as
Min,Max,Sum, andAverage, are not supported for string columns. - The
AverageandSumtotal aggregation functions are not supported for date and time columns.
- Click , the Format visual icon, in the top-right corner of the table to open the Properties panel and configure the formatting settings from the Totals section.You can customize the position, the label, the background color, the text color and size, and the border settings for the row with the totals.
1.4.2.1.22.2 Sorting Data in Tables
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, select a table.
- To sort by a single column:
- Click the header of the column that you want to sort.
- Under Sort by, set the sorting order and select the field that you want to sort by.
- To sort by multiple columns:
- Click
, the Sort visual icon, in the top-right corner of the table. - In the Sort visual dialog, select the first field that you want to sort by from the Sort by list and set the sort order.
- Click Add sort and select the second field that you want to sort by from the Then by list and set the sort order.You can add up to ten sorts to a table.
- Click Apply.
- Click
- To sort by a field that is not included in the table:
- Click the header of the column that you want to sort.
- Select .
- On the Off-visual field panel, select the field that you want to sort by and the aggregation method, set the sort order, and click Apply.
You can configure only one off-visual sort in a table. If you add an off-visual sort to a table that already has a single or multi-column sort, the off-visual sort overrides all other sorts.
, the Sort visual icon, in the top-right corner of the table, and then click Reset in the Sort visual dialog.1.4.2.1.23 Using Text Boxes
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click
, the Add text box button, on the toolbar. - Click inside the text box and enter text.
- Use the formatting menu to change the font type, style, color, size, spacing, apply text highlights, set the alignment, or add hyperlinks.
1.4.2.1.24 Using Tree Maps
Tree maps let you visualize one or two measures for a dimension. Each rectangle on the tree map represents one item in the dimension and the rectangle size is proportional to the value it represents. You can also use rectangle color to represent another measure for the item and show where the value of the item falls within the range for the measure. Darker colors indicate higher values and lighter colors indicate lower values.
Tree maps show up to 100 data points for the Group by field.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the Tree map icon.
- Add data to the visual by dragging fields from the Data panel to the appropriate field wells in the Visuals panel:
- Drag a dimension to the Group by field well.
- Drag a measure to the Size field well.
- Drag a different measure to the Color field well.
- Add drill-down layers by dragging one or more additional fields to the Group by field well.
- Customize the appearance of the visual in the Properties panel on the right.
- Under Display Settings, format the title and subtitle.For more information, see Formatting Titles and Subtitles in Visuals.
- Under Group by, format the group by field.
- To remove or display the field title, click , the Hide axis title icon, or , the Show axis title icon, next to Title.
You can also enter a custom title in the text box. To include a parameter in the title, click
, the Insert parameter icon. - Under Number of squares to show, enter the maximum number of squares to include in the tree map.
The remaining smaller squares are grouped into the Other square. To hide the Other square from the tree map, click
, the Menu options button, in the corner of the visual, and select Hide "other" categories.
- To remove or display the field title, click
- Under Size, format the size field.To remove or display the field title, click, the Hide axis title icon, or , the Show axis title icon, next to Title.
You can also enter a custom title in the text box. To include a parameter in the title, click
, the Insert parameter icon. - Under Color, format the color field.
- To remove or display the field title, click , the Hide axis title icon, or , the Show axis title icon, next to Title.
You can also enter a custom title in the text box. To include a parameter in the title, click
, the Insert parameter icon. - Under Gradient color, select the colors that you want to use for the highest value and the lowest value.
- To add a third color, enable the Enable 3 colors option. You can enter the value that defines the midpoint between the two main gradient colors in the Point of divergence field.
- To limit the visual to the colors that you specified instead of using a gradient, enable the Enable steps option.
- To remove or display the field title, click
- Under Legend, format the legend.For more information, see Formatting Legends in Visuals.
- Under Data labels, format the labels.For more information, see Formatting Data Labels in Visuals.
- Under Display Settings, format the title and subtitle.
1.4.2.1.25 Using Waterfall Charts
For example, waterfall charts are often used to show change within one time period or from one time period to another and to identify the factors responsible for this change.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the Waterfall chart icon.
- Add data to the visual by dragging fields from the Data panel to the appropriate field wells in the Visuals panel:
- Drag at least one field to the Category or the Value field well.
- Drag a dimension to the Breakdown field well.
- Add drill-down layers by dragging one or more additional fields to the Category or the Breakdown field well.
- Customize the appearance of the visual in the Properties panel on the right.
- Under Display Settings, format the title and subtitle.For more information, see Formatting Titles and Subtitles in Visuals.
- Under Waterfall chart, set the label displayed for totals.
- Under X-axis and Y-axis, configure the axes, the grid lines, and the range and scale.For more information, see Formatting Axes and Grid Lines in Visuals and Configuring Range and Scale in Visuals.
- Under Breakdown, enter the maximum number of bar groups to include in the waterfall chart.
- Under Legend, format the legend.For more information, see Formatting Legends in Visuals.
- Under Data labels, format the labels.For more information, see Formatting Data Labels in Visuals.
- Under Display Settings, format the title and subtitle.
1.4.2.1.26 Using Word Clouds
Each word in a word cloud represents one or more values in a dimension. The size of the word represents the frequency of a value in a selected dimension, in proportion to the occurrences of other values in the same dimension.
To create a word cloud, use one dimension in the Group by field well. Optionally, you can add a metric to the Size field well.
Word clouds usually look better with 20–100 words or phrases, but the format settings offer a wide range of flexibility. If you choose too many words, they can become too small to be legible, depending on the size of your display. By default, word clouds display 100 distinct words. To show more, change the format setting for Number of words in the Properties panel.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click , the Add visual button, on the toolbar.
- Click the Word cloud icon.
- Add data to the visual by dragging fields from the Data panel to the appropriate field wells in the Visuals panel:
- Drag a dimension to the Group by field well.Word clouds are limited to 500 unique values for Group by. To avoid displaying the word Other, click, the Menu options button, in the corner of the visual, and select Hide "other" categories.
- Drag a measure to the Size field well.
- Add drill-down layers by dragging one or more additional fields to the Group by field well.
- Drag a dimension to the Group by field well.
- Customize the appearance of the visual in the Properties panel on the right.
- Under Display Settings, format the title and subtitle.For more information, see Formatting Titles and Subtitles in Visuals.
- Under Word cloud, customize the layout of the word cloud and specify whether to include vertical words and whether to use lowercase. You can also set the size of the padding and the maximum string length.
- Under Group by, configure sorting options and set the word limit.
- Under Display Settings, format the title and subtitle.
1.4.2.2 Formatting Visuals
, the Properties button, on the toolbar or click , the Format visual icon, in the top-right corner of the visual. Then, configure the options available
for the type of visual in the Properties panel.1.4.2.2.1 Formatting Titles and Subtitles in Visuals
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, select a visual.
- Click , the Format visual icon, in the top-right corner of the visual.
- In the Properties panel on the right, expand the Display Settings section.
- To edit the title or subtitle:
- Click , the Edit icon, next to Edit title or Edit subtitle.
- In the Edit title or Edit subtitle dialog, enter the text that you want to display in the title or subtitle of the visual.Titles can be up to 120 characters long, including spaces. Subtitles can be up to 500 characters long.
- Select a font type and size.
- Use the icons on the toolbar to set the font style and color, add lists, set the text
alignment, or add a hyperlink.For hyperlinks, you can enter the URL and the display text, add a computation, parameter, or function to the URL, and specify whether the link opens in the same browser tab or in a different tab.
- To add a parameter, select a parameter from the Parameters list on the right.
- Click Save.
- Click
- To hide the title or subtitle, click , the Hide icon next to Edit title or Edit subtitle.
1.4.2.2.2 Formatting Axes and Grid Lines in Visuals
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, select a visual.
- Click , the Format visual icon, in the top-right corner of the visual.
- In the Properties panel on the right, expand the section for the axis that you want to format.The available axis settings depend on the type of visual.
- To remove or display the axis title, click , the Hide axis title icon, or , the Show axis title icon, next to Title.You can also enter a custom axis title in the text box. To include a parameter in the title, click, the Insert parameter icon.
- To remove or display the sort icon, click , the Hide quick sort icon icon, or , the Show quick sort icon icon, next to Sort.If you remove the sort icon, the sort icon is no longer displayed on the axis but the sorting options applied to the visual are not affected.
- To remove or display the data zoom bar, click , the Hide data zoom icon, or , the Show data zoom icon, next to Data zoom.
The data zoom bar appears automatically on charts with an x-axis that contain more than one data point. You can adjust the size of the bar to zoom to specific data points in the chart.
If you zoom in or out using the data zoom bar, and then hide the data zoom bar, the zoom position is not maintained and the visual displays all the data points. When you enable the data zoom again, the visual returns to its previous state.
- To remove or display the axis line, click , the Hide axis line icon, or , the Show axis line icon, next to Axis line.
- To hide or show axis labels, turn the Label switch off or on.You can set the label size and orientation.
- To remove or display the grid lines, click , the Hide grid lines icon, or , the Show grid lines icon, next to Grid lines.
1.4.2.2.3 Configuring Range and Scale in Visuals
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, select a visual.
- Click , the Format visual icon, in the top-right corner of the visual.
- In the Properties panel on the right, expand the section for the axis that you want to format.For horizontal bar charts, expand the X-axis section and for vertical bar charts, line charts, and scatter plots, expand the Y-axis section. For combo charts, expand the Bars and Lines sections.
- To set the range for the axis, select one of the options available under Range:
- Auto (starting at 0) - The range starts at 0 and ends around the highest value for the measure being displayed.
- Auto (based on data range) - The range starts at the lowest value for the measure being displayed and ends around the highest value for the measure being displayed.
- Custom - The range starts and ends at the values that you specify.
Enter the start and end values in the Min and Max fields. Typically, you use integers for the range values. For stacked 100 percent bar charts, use a decimal value to indicate the percentage. For example, if you want the range to be 0–30 percent instead of 0–100 percent, enter 0 for the start value and .3 for the end value.
- To use a logarithmic scale instead of the default linear scale, enable the Logarithmic Scale option.
On a linear scale, the axis labels are evenly spaced to show the arithmetical difference between them. The labels display the numbers in sets like {1000, 2000, 3000…} or {0, 50 million, 100 million…}, but not {10 thousand, 1 million, 1 billion…}. Use a linear scale in these cases:
- All the values that display on the chart are in the same order of magnitude.
- You want the axis labels to be evenly spaced.
- The axis values have a similar number of digits, for example 100, 200, 300, and so on.
- The rate of change between values is relatively slow and steady and the trend line is never close to being vertical.
On a logarithmic scale, the axis values are spaced to show the orders of magnitude as a way of comparing them. The logarithmic scale is often used to display large ranges of values or percentages, or to show exponential growth. Use a logarithmic scale in these cases:
- The values that display on the chart are not in the same order of magnitude.
- You want the axis labels to be flexibly spaced to reflect the wide range of values. For example, the axis values might have a different number of digits, such as 10, 100, 1000, and so on, or the axis labels might be unevenly spaced.
- The rate of change between values is growing exponentially or is too large to display in a meaningful way.
- To customize the number of values to show on the axis labels, select either Step size or Step count under Axis step count and enter a custom value.When you use a logarithmic scale, the axis step count is always determined automatically.
1.4.2.2.4 Adding Reference Lines to Visuals
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, select a visual.
- Click , the Format visual icon, in the top-right corner of the visual.
- In the Properties panel on the right, expand the Reference lines section.
- Click Add new line to open the New reference line panel.
- Under Data, set the reference line type.
- To create a constant line based on a single value that you enter, select Constant line under Type and enter the value that you want to use under Value.
The specified value determines the location of the line on the visual.
- To create a calculated line based on a field, select Calculated line under Type.
Select the column that you want to use for the reference line, the aggregation that you want to apply to the selected column, and the calculation that you want to apply to the aggregation. If you select Percentile, also enter a percentile value from 1 through 100.
- To create a constant line based on a single value that you enter, select Constant line under Type and enter the value that you want to use under Value.
- Under Line style, specify whether the reference line is solid, dashed, or dotted and set the line color.
- Under Label, configure the reference line label.
- Under Type, specify whether to display a label and whether the label includes only the value, a custom text, or both.
- Under Position, set the position of the label.
- Under Value format, specify whether to format the label as a number, as currency, or as a percent.
By default, the label uses the format of the field that is represented on the axis.
- Set the font size and color of the label.
- Click Done.
, the Open menu icon, next to a reference line and select Disable, Edit, or Delete from the menu.1.4.2.2.5 Formatting Legends in Visuals
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, select a visual.
- Click , the Format visual icon, in the top-right corner of the visual.
- In the Properties panel on the right, turn the Legend switch on or off to display or hide the legend.
- To format the legend:
- Expand the Legend section.
- Under Legend title, enter a title for the legend.
To include a parameter in the title, click
, the Add parameter icon.You can hide the title by clicking
, the Hide legend title icon. - Under Position, set the position of the legend.By default, the legend is displayed to the right of the visual.
1.4.2.2.6 Formatting Data Labels in Visuals
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, select a visual.
- Click , the Format visual icon, in the top-right corner of the visual.
- In the Properties panel on the right, turn the Data labels switch on or off to display or hide the data labels.
- To format the data labels:
- Expand the Data labels section.
- Set the position of the data labels.For example, for line charts you can display the labels above the lines, to the left or right of the points on the lines, or below the lines.
- Set the text color and size.
- Select a label pattern to specify how the data is labeled.For example, for bar charts, combo charts, and scatter charts, you can show labels for all the elements or only for the groups or colors. For line charts, you can show labels only for line ends or for maximum and minimum values. For pie charts, you can specify whether to show the metric label as a value or percent.
- Specify whether the data labels can overlap.
The available formatting options depend on the type of the visual. - To change the text of a data label, click the label in the visual and select Rename from the menu.To revert to the default name, delete the custom text that you entered.
1.4.2.2.7 Formatting Tooltips in Visuals
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, select a visual.
- Click , the Format visual icon, in the top-right corner of the visual.
- In the Properties panel on the right, select the Interactions tab.
- Turn the Tooltip switch on or off to display or hide tooltips.
- To format the tooltips:
- Expand the Tooltip section.
- Under Type, select Detailed tooltip.
- To hide or show the title of the tooltip, click , the Hide primary value as title icon, or , the Show primary value as title icon, next to Primary value as title.
- To hide or show aggregations for the fields in the tooltip, click , the Hide aggregations icon, or , the Show aggregations icon, next to Aggregations.
- To add a field to the tooltip, click Add field.In the Add field to tooltip panel, select the field that you want to add to the tooltip, specify a label for the field, set the aggregation method for measure fields, and click Save.
You can add up to 10 fields to a tooltip.
- To edit a field, click , the Open menu icon, next to a field and select Edit.Change the settings available in the Edit tooltip field panel and click Save.
- To change the order of the fields in the tooltip, click , the Open menu icon, next to a field and select Move up or Move down.
- To hide a field from the tooltip, click , the Open menu icon, next to a field and select Hide.
- To remove a field from the tooltip, click , the Open menu icon, next to a field that you added and select Delete.
1.4.2.2.8 Setting Colors in Visuals
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, select a visual.
- Click an element from the visual, such as a bar, a data point, a line, or a section,
and then select a color option from the menu:
- To set the color for all the elements in the chart, select Chart Color and choose the color that you want to use.
- To set the color only for the selected element, select Color and choose the color that you want to use.
To reset the color settings for the chart or the chart elements, click Reset to default in the color selection panel.
1.4.2.2.9 Applying Conditional Formatting in Visuals
1.4.2.2.9.1 Applying Conditional Formatting in Key Performance Indicators and Gauge Charts
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, select a KPI or a gauge chart.
- Click , the Menu options button, in the top-right corner of the visual and select Conditional formatting.
- In the Conditional formatting panel on the right, go to the element that you want to format.
- To set the text color, click Add text color, and configure conditions and formatting settings in the New text color panel:
- Under Format field based on, select the field or item to evaluate when applying the format.
- Under Aggregation, select the aggregation method to use if you selected a dimension field.
- Under Condition, select a comparison operator, such as Equals, Greater than, or Between.
- Under Value, enter the value to use for the comparison.
- Under Color, set the text color to use when the data meets the condition.
- Click Add condition to configure another condition.To change the order of the conditions or remove a condition, click, the Open menu icon, next to a condition and select Move up, Move down, or Delete.
- Click Apply.
- Click Close to return to the Conditional formatting panel.If you want to reset all the configured settings and conditions, click Clear.
- To add an icon or icon set, click Add icon, and configure conditions and icon settings in the New icon panel:
- Under Format field based on, select the field or item to evaluate when adding the icon.
- Under Aggregation, select the aggregation method to use if you selected a dimension field.
- Under Icon set, select a set of icons.
- Under Condition #1, select a comparison operator, such as Equals, Greater than, or Between.
- Under Value, enter the value to use for the comparison.
- Under Icon, select the icon to display when the data meets the condition.You can select one of the available icons or click Use custom Unicode icon to add a custom Unicode glyph.
- Under Color, set the color of the icon.
- Configure the rest of the conditions.The number of conditions depends on the number of icons in the set. You can also click Add condition to configure more conditions and icon settings.
To change the order of the conditions or remove a condition, click
, the Open menu icon, next to a condition and select Move up, Move down, or Delete. - Click Apply.
- Click Close to return to the Conditional formatting panel.If you want to reset all the configured settings and conditions, click Clear.
- To set the foreground color, click Add foreground color, and configure conditions and formatting settings in the New foreground color panel:
- Under Format field based on, select the field or item to evaluate when applying the format.
- Under Aggregation, select the aggregation method to use if you selected a dimension field.
- Under Condition, select a comparison operator, such as Equals, Greater than, or Between.
- Under Value, enter the value to use for the comparison.
- Under Color, set the foreground color to use when the data meets the condition.
- Click Add condition to configure another condition.To change the order of the conditions or remove a condition, click, the Open menu icon, next to a condition and select Move up, Move down, or Delete.
- Click Apply.
- Click Close to return to the Conditional formatting panel.If you want to reset all the configured settings and conditions, click Clear.
- To edit a conditional formatting setting, click , the Open menu icon, next to a formatting setting and select Edit.
- To delete a conditional formatting setting, click , the Open menu icon, next to a formatting setting and select Delete.
1.4.2.2.9.2 Applying Conditional Formatting in Tables and Pivot Tables
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, select a table or a pivot table.
- Click , the Menu options button, in the top-right corner of the visual and select Conditional formatting.
- In the Conditional formatting panel on the right, select the field that you want to format under Column.
- For pivot tables, you can set conditional formatting to any of the fields from the Values field well.
- For tables, you can set conditional formatting to any of the fields from the table or to an entire row. When you format an entire row, you can enable the Apply on top option to apply the row formatting in addition to the formatting added by other conditions.
- To set the background color, click Add background color, and configure conditions and formatting settings in the New background color panel:
- Specify the type of background color that you want to apply:
- To use a solid color for the background, select Solid under Fill type and configure these settings:
- Under Format field based on, select the field to evaluate when applying the format.
- Under Aggregation, select the aggregation method to use for the selected field.
- Under Condition, select a comparison operator, such as Equals, Greater than, or Between.
You can click
, the Open menu icon, to specify whether the condition applies to values, subtotals, or totals. - Under Value, enter the value to use for the comparison.
- Under Color, set the background color to use when the data meets the condition.
- Click Add condition to configure another condition.
To change the order of the conditions or remove a condition, click
, the Open menu icon, next to a condition and select Move up, Move down, or Delete.
- To use a gradient for the background color, select Gradient under Fill type and configure these settings:
- Under Format field based on, select the field to evaluate when applying the format.
- Under Aggregation, select the aggregation method to use for the selected field.
- Under Gradient color, select a gradient scale.
- Under Min value, enter the minimum value for the gradient scale and select the color to use.
- Under Max value, enter the maximum value for the gradient scale and select the color to use.
- To use a solid color for the background, select Solid under Fill type and configure these settings:
- Click Apply.
- Click Close to return to the Conditional formatting panel.If you want to reset all the configured settings and conditions, click Clear.
- Specify the type of background color that you want to apply:
- To set the text color, click Add text color, and configure conditions and formatting settings in the New text color panel:
- Specify the type of text color that you want to apply:
- To use a solid color for the text, select Solid under Fill type and configure these settings:
- Under Format field based on, select the field to evaluate when applying the format.
- Under Aggregation, select the aggregation method to use for the selected field.
- Under Condition, select a comparison operator, such as Equals, Greater than, or Between.
You can click
, the Open menu icon, to specify whether the condition applies to values, subtotals, or totals. - Under Value, enter the value to use for the comparison.
- Under Color, set the text color to use when the data meets the condition.
- Click Add condition to configure another condition.
To change the order of the conditions or remove a condition, click
, the Open menu icon, next to a condition and select Move up, Move down, or Delete.
- To use a gradient for the text color, select Gradient under Fill type and configure these settings:
- Under Format field based on, select the field to evaluate when applying the format.
- Under Aggregation, select the aggregation method to use for the selected field.
- Under Gradient color, select a gradient scale.
- Under Min value, enter the minimum value for the gradient scale and select the color to use.
- Under Max value, enter the maximum value for the gradient scale and select the color to use.
- To use a solid color for the text, select Solid under Fill type and configure these settings:
- Click Apply.
- Click Close to return to the Conditional formatting panel.If you want to reset all the configured settings and conditions, click Clear.
- Specify the type of text color that you want to apply:
- To add an icon or icon set, click Add icon, and configure conditions and icon settings in the New icon panel:
- Under Format field based on, select the field to evaluate when adding the icon.
- Under Aggregation, select the aggregation method to use for the selected field.
- Under Icon set, select a set of icons.
- Under Condition #1, select a comparison operator, such as Equals, Greater than, or Between.You can click, the Open menu icon, to specify whether the condition applies to values, subtotals, or totals.
- Under Value, enter the value to use for the comparison.
- Under Icon, select the icon to display when the data meets the condition.You can select one of the available icons or click Use custom Unicode icon to add a custom Unicode glyph.
- Under Color, set the color of the icon.
- To replace the value with the icon, enable the Show icon only option.
- Configure the rest of the conditions.The number of conditions depends on the number of icons in the set. You can also click Add condition to configure more conditions and icon settings.
To change the order of the conditions or remove a condition, click
, the Open menu icon, next to a condition and select Move up, Move down, or Delete. - Click Apply.
- Click Close to return to the Conditional formatting panel.If you want to reset all the configured settings and conditions, click Clear.
- To edit a conditional formatting setting, click , the Open menu icon, next to a field and select Edit.
- To delete a conditional formatting setting, click , the Open menu icon, next to a field and select Delete.
1.4.2.3 Customizing Data Presentation
1.4.2.3.1 Replacing or Removing Fields
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, select a visual.
- Click
, the Visualize button, on the toolbar to display the Visuals panel. - In the Visuals panel, use the Options menu to replace or remove fields.
- To replace a field, click , the Options button, next to the field and select Replace. Then, choose a new field from the list.
You can also select a different field from the Data panel on the left and drag it over the field that you want to replace.
- To remove a field, click , the Options button, next to the field and select Remove.
- To replace a field, click
1.4.2.3.2 Changing Field Aggregation
All the aggregate functions can be applied to numeric fields. You cannot apply aggregate functions to fields in dimension field wells.
By default, the Count function is automatically applied to a dimension if you choose to use it in a field
well that expects a measure. You can apply one of the other aggregate functions instead.
These aggregate functions are available:
Average– Calculates the average value for the selected field.Count– Provides a count of the number of records containing the selected measure for a given dimension.Distinct Count– Provides a count of how many different values are in the selected measure, for the selected dimension or dimensions.Max– Calculates the maximum value for the selected field.Min– Calculates the minimum value for the selected field.Median– Calculates the median value of the specified measure, grouped by the chosen dimension or dimensions.Sum– Totals all of the values for the selected field.Standard Deviation– Calculates the standard deviation of the set of numbers in the specified measure, grouped by the chosen dimension or dimensions, based on a sample or on a biased population.Variance– Calculates the variance of the set of numbers in the specified measure, grouped by the chosen dimension or dimensions, based on a sample or on a biased population.Percentile– Computes the nth percentile of the specified measure, grouped by the chosen dimension or dimensions.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, select a visual.
- Click , the Visualize button, on the toolbar to display the Visuals panel.
- In the Visuals panel, click , the Options button, next to a field, then select Aggregate and one of the available aggregate functions.The visual elements that support aggregated fields depend on the visual type.
, the Options button, next to a field label and select an option from the menu.1.4.2.3.3 Changing the Granularity of Date and Time Fields
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, select a visual.
- Click , the Visualize button, on the toolbar to display the Visuals panel.
- In the Visuals panel, click , the Options button, next to a date field, then select Aggregate and a level of granularity.The available values are Year, Quarter, Month, Week, Day, Hour, Minute, and Second. Hour, Minute, and Second are available only if the field contains time data.
, the Options button, next to a field label and select an option from the menu.1.4.2.3.4 Formatting Fields
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, select a visual.
- Click , the Visualize button, on the toolbar to display the Visuals panel.
- In the Visuals panel, click , the Options button, next to a field, then select Show as and one of the available display options.The list of options varies based on the data type. For numeric fields, you can select Number, Currency, or Percent. If the field contains non-numeric data, you can change the count format, which is the formatting used when the field is counted.
- Click , the Options button, again and select .You can also select one of the common formatting options available directly from the Format list.
- In the Format data panel, configure the available formatting settings.To set the format based on the language setting, click Apply language format at the bottom of the panel.
In visuals that display field labels, you can also configure field settings directly
from the visual. Click , the Options button, next to a field label and select an option from the menu.
The formatting settings specified for a field using the Options menu from the Visuals panel or the field labels only apply to the selected visual. To specify formatting
settings that apply to all the visuals that you add to the analysis, you must configure
them from the Data panel on the left. Click , the Options button, next to a field from the Data panel, select , and then configure the settings available in the Format data panel.
1.4.2.3.4.1 Formatting Currency Fields
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, select a visual.
- Click , the Visualize button, on the toolbar to display the Visuals panel.
- In the Visuals panel, click , the Options button, next to a currency field and make sure that the display option for the field
is .
- Click , the Options button, again and select .You can also select one of the common formatting options available directly from the Format list.
- In the Format data panel, configure formatting settings for currency symbols, separators, decimal places,
units, negative values, and null values.
- Expand the Symbols section and select a currency symbol.
- Expand the Separators section and configure the available options:
- Under Decimal, specify whether to use a dot or a comma for the decimal separator.
- Under Thousands, select the Enabled check box if you want to use a thousands separator and specify whether to use a comma, dot, or space for the separator. Make sure that you choose a different separator than the one used for decimals.
- Expand the Decimal Places section and select Auto to automatically determine the appropriate number of decimal places or Custom to specify the number of decimal places.Field values are rounded to the decimal places specified. For example, if you specify two decimal places, the value 6.728 is rounded to 6.73.
- Expand the Units section and select a unit for large numbers.The unit is added as a suffix to the value. For example, if you choose Thousands, a field value of 1234 displays as 1.234K.
You can also add a custom prefix or suffix in the Prefix or Suffix box. For example, you can use a custom suffix to specify a currency symbol that is not available by default.
- Expand the Negatives section and specify whether to display negative values by using a minus sign or by enclosing them in parentheses.
- Expand the Null values section and specify whether to display null values as null or as a custom value.In tables and pivot tables, null values only display for fields that are placed in the Rows, Columns, or Group by field wells. Null values for fields in the Values field well appear empty.
You can preview all your settings in the preview area at the top of the panel.To set the format based on the language setting, click Apply language format at the bottom of the Format data panel.
1.4.2.3.4.2 Formatting Date and Time Fields
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, select a visual.
- Click , the Visualize button, on the toolbar to display the Visuals panel.
- In the Visuals panel, click , the Options button, next to a date field and select .You can also select one of the common formatting options available directly from the Format list.
- In the Format data panel, configure formatting settings for displaying date, time, and null values.
- Expand the Date section and select a date format.If you select Custom, you must specify a format pattern in the Custom section lower down in the Format data panel. If you use Custom for the date format, you must also use Custom for the time format.
- Expand the Time section and select a time format.If you select Custom, you must specify a format pattern in the Custom section lower down in the Format data panel. If you use Custom for the time format, you must also use Custom for the date format.
- If you selected Custom in the Date and Time sections, expand the Custom section and specify the format pattern that you want to use.The default format pattern is MMM D, YYYY h:mma, for example Sep 20, 2024 5:30pm.
If you selected one of the predefined formats in the Date and Time sections, the Custom section displays the format pattern that matches your selection. For example, if you chose Jun 21, 2024 in the Date section and 17:00:00pm in the Time section, the Custom section shows the format pattern MMM D, YYYY H:mm:ssa.
- Expand the Null values section and specify whether to display null values as null or as a custom value.
To set the format based on the language setting, click Apply language format at the bottom of the Format data panel. - Expand the Date section and select a date format.
1.4.2.3.4.2.1 Custom Date and Time Formats
Supported Tokens for Formatting Dates
| Example | Description | Token |
|---|---|---|
| 0–6 | Numeric representation of a particular day of the week. 0 is Sunday and 6 is Saturday. | d |
| Mo–Su | A 2-character textual representation of a particular day of the week. | dd |
| Mon–Sun | A 3-character textual representation of a particular day of the week. | ddd |
| Monday–Sunday | A textual representation of a particular day of the week. | dddd |
| 99 or 24 | A 2-digit representation of a year. | YY |
| 1999 or 2024 | A full, 4-digit numeric representation of a year. | YYYY |
| 1–12 | Number of a month without leading zeros. | M |
| 1st, 2nd, to 12th | Number of a month without leading zeros and with an ordinal suffix. | Mo |
| 01–12 | Number of a month with leading zeros. | MM |
| Jan–Dec | A 3-digit textual representation of a month. | MMM |
| January–December | A full textual representation of a month. | MMMM |
| 1–4 | A numeric representation of a quarter. | Q |
| 1st–4th | A numeric representation of a quarter with an ordinal suffix. | Qo |
| 1–31 | Day of the month without leading zeros. | D |
| 1st, 2nd, to 31st | Day of the month without leading zeros and with an ordinal suffix. | Do |
| 01–31 | A 2-digit day of the month with leading zeros. | DD |
| 1–365 | Day of the year without leading zeros. | DDD |
| 001–365 | Day of the year with leading zeros. | DDDD |
| 1–53 | Week of the year without leading zeros. | w |
| 1st–53rd | Week of the year without leading zeros and with an ordinal suffix. | wo |
| 01–53 | Week of the year with leading zeros. | ww |
| 1–23 | Hours, in a 24-hour format, without leading zeros. | H |
| 01–23 | Hours, in a 24-hour format, with leading zeros. | HH |
| 1–12 | Hours, in a 12-hour format, without leading zeros. | h |
| 01–12 | Hours, in a 12-hour format, with leading zeros. | hh |
| 0–59 | Minutes without leading zeros. | m |
| 00–59 | Minutes with leading zeros. | mm |
| 0–59 | Seconds without leading zeros. | s |
| 00–59 | Seconds with leading zeros. | ss |
| am or pm | am/pm | a |
| AM or PM | AM/PM | A |
| 1632184215 | Unix timestamp. | X |
| 1632184215000 | Millisecond Unix timestamp. | x |
| Z | Zero UTC offset. | Z |
Examples of Common Date Formats
| Example | Token Format |
|---|---|
| Sep 20, 2024 | MMM DD, YYYY |
| 20-09-24 5pm | DD-MM-YY ha |
| Monday, September 20, 2024 17:30:15 | dddd, MMMM DD, YYYY HH:mm:ss |
These formats are not supported:
- Time zones offset with a colon. For example, +07:00.
- Time zones offset without a colon. For example, +0730.
To quickly customize dates and times, you can use one of the available preset tokens.
Preset Date Formats
| Example | Token |
|---|---|
| 8:30 PM | LT |
| 8:30:25 PM | LTS |
| August 2 2024 | LL |
| Aug 2 2024 | ll |
| August 2 2024 08:30 PM | LLL |
| Aug 2 2024 08:30 PM | lll |
| Thursday, August 2 2024 08:30 PM | LLLL |
| Thu, Aug 2 2024 08:30 PM | llll |
You can also include words in date formats by entering backslashes (\) before each character in the word. For example, for the format 20th of Sep, 2024 use Do \o\f MMM, YYYY.
1.4.2.3.4.3 Formatting Number Fields
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, select a visual.
- Click , the Visualize button, on the toolbar to display the Visuals panel.
- In the Visuals panel, click , the Options button, next to a number field and make sure that the display option for the field
is .
- Click , the Options button, again and select .You can also select one of the common formatting options available directly from the Format list.
- In the Format data panel, configure formatting settings for separators, decimal places, units, negative
values, and null values.
- Expand the Separators section and configure the available options:
- Under Decimal, specify whether to use a dot or a comma for the decimal separator.
- Under Thousands, select the Enabled check box if you want to use a thousands separator and specify whether to use a comma, dot, or space for the separator. Make sure that you choose a different separator than the one used for decimals.
- Expand the Decimal Places section and select Auto to automatically determine the appropriate number of decimal places or Custom to specify the number of decimal places.Field values are rounded to the decimal places specified. For example, if you specify two decimal places, the value 6.728 is rounded to 6.73.
- Expand the Units section and select a unit for large numbers.The unit is added as a suffix to the value. For example, if you choose Thousands, a field value of 1234 displays as 1.234K.
You can also add a custom prefix or suffix in the Prefix or Suffix box.
- Expand the Negatives section and specify whether to display negative values by using a minus sign or by enclosing them in parentheses.
- Expand the Null values section and specify whether to display null values as null or as a custom value.In tables and pivot tables, null values only display for fields that are placed in the Rows, Columns, or Group by field wells. Null values for fields in the Values field well appear empty.
You can preview all your settings in the preview area at the top of the panel.
To set the format based on the language setting, click Apply language format at the bottom of the Format data panel.
- Expand the Separators section and configure the available options:
1.4.2.3.4.4 Formatting Percent Fields
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, select a visual.
- Click , the Visualize button, on the toolbar to display the Visuals panel.
- In the Visuals panel, click , the Options button, next to a percent field and make sure that the display option for the field
is .
- Click , the Options button, again and select .You can also select one of the common formatting options available directly from the Format list.
- In the Format data panel, configure formatting settings for separators, decimal places, negative values,
and null values.
- Expand the Separators section and configure the available options:
- Under Decimal, specify whether to use a dot or a comma for the decimal separator.
- Under Thousands, select the Enabled check box if you want to use a thousands separator and specify whether to use a comma, dot, or space for the separator. Make sure that you choose a different separator than the one used for decimals.
- Expand the Decimal Places section and select Auto to automatically determine the appropriate number of decimal places or Custom to specify the number of decimal places.Field values are rounded to the decimal places specified. For example, if you specify two decimal places, the value 6.728 is rounded to 6.73.
- Expand the Negatives section and specify whether to display negative values by using a minus sign or by enclosing them in parentheses.
- Expand the Null values section and specify whether to display null values as null or as a custom value.In tables and pivot tables, null values only display for fields that are placed in the Rows, Columns, or Group by field wells. Null values for fields in the Values field well appear empty.
You can preview all your settings in the preview area at the top of the panel.
To set the format based on the language setting, click Apply language format at the bottom of the Format data panel.
- Expand the Separators section and configure the available options:
1.4.2.3.4.5 Formatting Text Fields
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, select a visual.
- Click , the Visualize button, on the toolbar to display the Visuals panel.
- In the Visuals panel, click , the Options button, next to a text field and select .
- In the Format data panel, expand the Null values section and specify whether to display null values as null or as a custom value.
1.4.2.3.4.6 Restoring the Default Formatting Settings for a Field
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, select a visual.
- Click , the Visualize button, on the toolbar to display the Visuals panel.
- In the Visuals panel, click , the Options button, next to a field and select .
- At the bottom of the Format data panel, click Reset to defaults.
1.4.2.3.5 Sorting Data in Visuals
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, select a visual.
- Click , the Visualize button, on the toolbar to display the Visuals panel.
- In the Visuals panel, use the Options menu next to a field to sort data.
- To sort the values in a field in ascending or descending order, click , the Options button, next to the field, then select Sort order and Ascending or Descending.
- To sort data based on another field from the visual, click , the Options button, next to a field, then select Sort by and choose one of the fields from the list.
- To sort data based on a field that is not included in the visual, click , the Options button, next to a field, then select .
On the Off-visual field panel, select the field that you want to sort by and the aggregation method, set the sort order, and click Apply.
- To sort the values in a field in ascending or descending order, click
, the Options button, and select a sorting option from the menu.1.4.2.3.6 Adding Drill-Down Layers to Visuals
| Visual type | Field well |
|---|---|
| Bar chart | X axis or Y axis and Group/Color |
| Combo chart | X axis and Group/Color for bars |
| Line chart | X axis and Color |
| Point map | Geospatial and Color |
| Filled map | Location |
| Heat map | Rows and Columns |
| Key performance indicator | Trend group |
| Radar chart | Category or Color |
| Waterfall chart | Category and Breakdown |
| Scatter plot | Color and Label |
| Pie chart, donut chart | Group/Color |
| Tree map, box plot, funnel chart | Group by |
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, select a visual.
- To add a drill-down layer, drag a field from the Data panel to a field well in the Visuals panel that already includes other fields.Make sure that the Add drill-down layer label is displayed when you drag the field.
- Continue until you add fields for all the levels of the drill hierarchy that you want
to create.Position the dragged fields above or below existing fields based on where you want them to be in the drill hierarchy. For example, you can create a drill hierarchy that goes from printer type to printer model and, finally, to printer name.
To remove a field from the hierarchy, click
, the Options button, next to the field and select Remove.
1.4.2.3.7 Setting Field Colors in Analyses
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, click , the Datasets button, on the toolbar to display the Data panel.
- In the Data panel, click , the Options button, next to a dimension field.
- Select Edit field colors....
- In the Edit field colors panel, select the field value that you want to assign a color to and select the color
that you want to use.
You can enter the name of a value in the Search values field to search for specific values. Or you can click
, the Filter icon, to specify whether to display all the values or only the values with edited
colors.To reset the color for a field value, click
, the Reset color icon. - Click Apply.You can reset all the color settings that you configured for the field values by clicking Reset colors.
1.4.2.3.8 Changing the Field Data Type in Analyses
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, click , the Datasets button, on the toolbar to display the Data panel.
- In the Data panel, click , the Options button, next to a field and select Convert to dimension or Convert to measure.
1.4.2.4 Interacting with Visuals in Analyses
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, select the visual that you want to work with.
- To display additional details, hover over the data in the visual.For example, when you hover over a single bar on a bar chart, information about that specific bar displays in a tooltip.
- If the content is larger than the size of the visual, use the scroll bar to reduce
the data that is displayed or scroll through it.
- To reduce the length of the scroll bar and change the size of the data, hover over one end of the bar and drag the cursor to adjust the size.
- To scroll through the data, click and hold the scroll bar and slide it toward the end that you want to see.
- To exclude or focus on visual elements, right-click an element, such as a bar, a data
point, or a data segment, and select Exclude or Focus only on.
When you exclude or focus on specific data, a filter is created to hide or to show only the data that you selected. To remove the filter, disable or delete the filter from the Filters panel.
If the visual has a legend, you can also click the values in the legend and select Exclude or Focus only on to exclude or focus on specific data.
- To drill down into the data and get an in-depth view of a selected value, right-click
an element from the visual, such as a bar, a data point, or a data segment, and select
a drill option:
- To drill down to see data at a lower level of the drill hierarchy, select Drill down to lower level.
- To drill up to see data at a higher level of the drill hierarchy, select Drill up to higher level.
Depending on the visual configuration, you can also use the toolbar to drill down and up into the data. Click one of the drill icons from the toolbar:
- To drill down one level, click
, the Drill down icon. - To drill up one level, click
, the Drill up icon. - To drill all the way to the top of the hierarchy, click
, the Drill up to top icon.
- To view a summary of the data in the visual, click , the Menu options button, in the corner of the visual, and select View summary data.On the View summary data dialog, use the arrows to navigate through the data. You can also sort the entries by clicking the column headings and set the number of rows per page.
- To export the data from the visual , click , the Menu options button, in the corner of the visual, and select one of the available export options:
- To export to a CSV file, select Export to CSV.
- To export to a Microsoft Excel file, select Export to Excel. This option is available only for pivot tables and table charts.
- Note:
- Exported files can return information directly from the dataset import. As a result, the exported files can be vulnerable to CSV injection if the imported data contains formulas or commands and can prompt security warnings. To avoid malicious activity, turn off links and macros when you read the files.
- The export contains only the data that is currently visible in the visual. Any data that is filtered out is excluded from the exported file.
- The default limit for exports to CSV is 500 MB or 1 million rows.
- The default limit for exports to Excel is 400.000 cells or 50.000 rows for pivot tables and 800.000 cells or 100.000 rows for table charts.
1.4.2.5 Using Insights, Anomaly Detection, and Forecasts
The built-in machine learning algorithm that is used for anomaly detection and forecasting continuously analyzes your data to identify outliers, to determine patterns and trends, and to reliably predict changes for key data metrics.
To begin using the machine learning capabilities, the dataset must meet these requirements:
- The dataset must include at least one metric, such as printed jobs, printer throughput,
or ink usage data, and at least one category dimension, such as printer names, locations,
or operator names. Categories with NULL values are ignored.
If you want to analyze anomalies or forecasts, you also need at least one date dimension.
- Anomaly detection requires a minimum of 15 data points for training. For example, if the grain of your data is daily, you need at least 15 days of data. If the grain is monthly, you need at least 15 months of data.
- Forecasting works best with more data. Make sure that your dataset has enough historical
data for optimal results. For example, if the grain of your data is daily, you need
at least 38 days of data. If the grain is monthly, you need at least 43 months of
data. These are the requirements for each time grain:
- Years: 32 data points
- Quarters: 35 data points
- Months: 43 data points
- Weeks: 35 data points
- Days: 38 data points
- Hours: 39 data points
- Minutes: 46 data points
- Seconds: 46 data points
1.4.2.5.1 Using Insights
There are two types of insights that you can add to your analyses:
- Suggested insights
- A list of suggested insights is available based on the data included in your visuals. The list changes based on context. You can see different suggestions depending on the fields that you add to your visuals and the type of the visuals. For example, if you have a time-series visualization, the suggested insights can include period-over-period changes, anomalies, and forecasts. As you add more visuals to your analysis, you generate more suggested insights.
- Custom insights
- Custom insights let you create your own computation, using your own words to give context to the fields that appear in the visual. When you create a custom insight, you add it to the analysis, and then choose the type of calculation that you want to use. You can also add more fields, calculations, and parameters, and customize the text and formatting.
1.4.2.5.1.1 Adding Suggested Insights
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, click
, the Insights button, on the toolbar.The Suggested Insights panel is displayed and you can see all the available suggested insights. - To customize a suggested insight, select the insight, click
, the Options button, and select one of the available options:- Aggregate: Lets you change the time series aggregation to year, quarter, month, week, day, hour, minute, second, or millisecond.
- Analyze contributions: Lets you see the top contributors to a data metric in a specified time frame.
- Show all anomalies: Lets you browse anomalies in the analyzed time frame.
- Edit forecast: Lets you set the forecast length, prediction interval, and seasonality.
- Focus only on or Exclude: Lets you zoom in or zoom out on dimensional data.
- Show details: Displays more information about a recent anomaly (outlier).
The available options depend on the type of insight.
- To add a suggested insight to the analysis, select the insight, and click
, the Add insight button. - To customize the content of the insight, click , the Menu options button, in the corner of the insight and select Customize narrative.In the Edit narrative dialog, you can edit the insight computation or add more computations, use parameters, and add functions. You can also configure the text formatting and alignment and add images or hyperlinks. For more information, see Customizing the Insight Narrative.
- To change the anomaly detection settings for insights that show anomalies, click , the Menu options button, in the corner of the insight and select Configure anomaly.For more information, see Configuring Anomaly Detection.
1.4.2.5.1.2 Adding Custom Insights
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, go to .A container for the new insight is added to the analysis and the Computation dialog is displayed.
- On the Computation dialog, select the computation that you want to use for the text of the insight and
click Select.
The insight container displays information about the data fields that are required for the selected type of computation.
You can also close the Computation dialog without selecting a computation and configure the insight manually. Click the Customize insight button inside the insight container and customize the insight settings in the Edit narrative dialog.
- Add data to the insight by dragging fields from the Data panel to the appropriate field wells in the Visuals panel:
- Drag a date field to the Time field well.
- Drag one or more measures to the Values field well.
- Drag one or more dimensions to the Categories field well.You can either add multiple values or multiple categories.
Look at the information displayed inside the insight container to see what data fields are required. After you add the required fields, you can add any other fields that you want to include in the insight. - To customize the content of the insight, click , the Menu options button, in the corner of the insight and select Customize narrative.In the Edit narrative dialog, you can edit the insight computation or add more computations, use parameters, and add functions. You can also configure the text formatting and alignment and add images or hyperlinks. For more information, see Customizing the Insight Narrative.
- To change the anomaly detection settings for insights that show anomalies, click , the Menu options button, in the corner of the insight and select Configure anomaly.For more information, see Configuring Anomaly Detection.
To create a custom insight, you can also click , the Add visual button, on the toolbar, and then click the Insight icon.
1.4.2.5.1.3 Customizing the Insight Narrative
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, add a suggested insight or a custom insight.For more information, see Adding Suggested Insights or Adding Custom Insights.
- To customize the content of the insight, click , the Menu options button, in the corner of the insight and select Customize narrative.
- In the Edit narrative dialog, configure the computations, add parameters and functions, add custom text,
configure the text formatting and alignment, or add images and hyperlinks.
- To add a computation, click the Add computation button, then select a type of computation, configure the computation properties in
the Configure dialog, and click Add.The available configuration options depend on the type of the computation.Note: The computation names that you specify are unique within the insight. You can reference multiple computations of the same type in your narrative template. For example, if you have two metrics, you can create growth rate computations for each metric, each with a different name.
The computation that you configured is added to the narrative. You can see the list of output parameters available for the computation in the Computations section. Click a parameter to add it to the narrative.
For more information on computations, see Supported Computations for Insights.
- To edit a computation, expand the Computations section and click
, the Edit icon, next to a computation.Edit the computation properties in the Configure dialog and click Save. The available options depend on the type of the computation. - To remove a computation, expand the Computations section, click , the Edit icon, next to a computation, and click Delete in the Configure dialog.
- To add the current value of an analysis parameter, expand the Parameters section and click one of the available parameters.For more information on parameters, see Creating Parameters.
- To add a function, expand the Functions section and click the function that you want to use.For more information on the supported functions, see Supported Functions.
- To add a code expression, expand the Insert code menu from the toolbar, select one of the options from the list, enter the code in
the code box, and click Save.You can use these code expressions in the narrative:
- Expression: Lets you create your own code expression.
- Inline IF: Adds an
IFstatement that includes an expression after evaluating a condition. The statement displays inline, in a sentence. - Inline FOR: Adds a
FORstatement that loops through values. The statement displays inline, in a sentence. - Block IF: Adds an
IFstatement that includes an expression after evaluating a condition. The statement displays in a separate block of text. - Block FOR: Adds a
FORstatement that loops through values. The statement displays in a separate block of text.
- To modify the text that is displayed in the narrative, enter or edit text directly in the workspace.
- To customize the text alignment, size, style, and color, select the text in the workspace and use the formatting options available on the toolbar.
- To add an image, click the Image icon on the toolbar and enter a valid URL that links directly to an image.You can resize the image. You can also display an image based on a condition by adding the image inside an IF block.
- To add a static or dynamic URL, click the URL icon on the toolbar and enter a valid URL.You can also set the display text, add computation parameters, analysis parameters, or functions to the URL, and specify whether the link opens in the same browser tab or in a different tab.
A static URL is a link that does not change. For example, you can add a link to another sheet in the same analysis.
A dynamic URL is a link that changes based on the expressions or parameters that you provide when you set it up. It is built with dynamically evaluated expressions or parameters. For example, you can use a dynamic link to search a website with a query or to update a parameter.
- To search a website with a query, create a URL with this link:
https://google.com?q=<<formatDate(now(),'yyyy-MM-dd')>>
The link sends a query to Google with search text that is evaluated as:formatDate(now(), 'yyyy-MM-dd')
If the value ofnow()is 02/02/2024, then the link in your narrative containshttps://google.com?q=2024-02-02. - To create a link that updates a parameter, enter the URL to the current dashboard
or analysis and add the expression that sets the parameter value at the end, for example
dashboardURL#p.myParameter=12345.
- To search a website with a query, create a URL with this link:
You can see a preview of the narrative at the bottom of the Edit narrative dialog. If there are errors in your narrative, the preview displays an error message. Check the narrative for alerts and use the provided information to fix the errors.To see a preview of insights that use machine learning, such as anomaly detection or forecasting, run the insight calculation at least once before customizing the narrative.
- To add a computation, click the Add computation button, then select a type of computation, configure the computation properties in
the Configure dialog, and click Add.
- Click Save.
1.4.2.5.1.4 Supported Computations for Insights
When you add or edit a computation, you can specify several parameters.
Each computation also generates a set of output parameters. You can add these output parameters to the narrative to customize what it displays. To see the output parameters available for a computation, expand the Computations tab on the right of the Edit narrative dialog. The names of the computations come from the name that you specified when you created the insight.
Anomaly Detection
The ML-powered Anomaly detection computation searches your data for outliers. For example, you can detect the top 3 outliers for total printed jobs on December 3, 2024. If you enable contribution analysis, you can also detect the key drivers for each outlier. For more information about configuring anomaly detection, see Configuring Anomaly Detection.
To use this function, you need at least one dimension in the Time field well, at least one measure in the Values field well, and at least one dimension in the Categories field well.
- Computation outputs
-
Note: The items displayed in
bold monospace fontcan be included in the narrative.timeField– From the Time field well.name– The formatted display name of the field.timeGranularity– The time field granularity ( DAY, YEAR, and so on).
categoryFields– From the Categories field well.name– The formatted display name of the field.
metricField– From the Values field well.name– The formatted display name of the field.aggregationFunction– The aggregation used for the metric (SUM,AVG, and so on).
itemsCount– The number of items included in this computation.items– Anomalous items.timeValue– The values in the date dimension.value– The date/time field at the point of the anomaly or outlier.formattedValue– The formatted value in the date/time field at the point of the anomaly or outlier.
categoryName– The actual name of the category.direction– The direction on the x-axis or y-axis that is identified as anomalous: HIGH or LOW. HIGH means higher than expected and LOW means lower than expected. When iterating on items,AnomalyDetection.items[index].directioncan contain eitherHIGHorLOW. For example,AnomalyDetection.items[index].direction='HIGH'orAnomalyDetection.items[index].direction='LOW'. AnomalyDetection.directioncan have an empty string forALL. An example isAnomalyDetection.direction=''.actualValue– The actual value of the data metric at the point of the anomaly or outlier.value– The raw value.formattedValue– The value formatted by the metric field.formattedAbsoluteValue– The absolute value formatted by the metric field.
expectedValue– The expected value of the data metric at the point of the anomaly or outlier.value– The raw value.formattedValue– The value formatted by the metric field.formattedAbsoluteValue– The absolute value formatted by the metric field.
Bottom Movers and Top Movers
The Bottom movers computation counts the requested number of categories by date that rank in the bottom of the dataset. For example, you can create a computation to find the bottom 3 printers based on printed impressions for a specific time period.
The Top movers computation counts the requested number of categories by date that rank in the top of the dataset. For example, you can create a computation to find the top 3 printers based on printed impressions for a specific time period.
To use these functions, you need at least one dimension in the Time field well and at least one dimension in the Categories field well.
- Parameters
- Computation name - A unique descriptive name for the computation. You can use the default name or add a custom name.
- Date - The date dimension that you want to analyze.
- Category - The category dimension that you want to rank.
- Value - The aggregated measure that the computation is based on.
- Number of movers - The number of ranked results that you want to display.
- Order by - The order that you want to use, percent difference or absolute difference.
- Computation outputs
-
Note: The items displayed in
bold monospace fontcan be included in the narrative.timeField– From the Time field well.name– The formatted display name of the field.timeGranularity– The time field granularity ( DAY, YEAR, and so on).
categoryField– From the Categories field well.name– The formatted display name of the field.
metricField– From the Values field well.name– The formatted display name of the field.aggregationFunction– The aggregation used for the metric (SUM,AVG, and so on).
startTimeValue– The value in the date dimension.value– The raw value.formattedValue– The value formatted by the date/time field.
endTimeValue– The value in the date dimension.value– The raw value.formattedValue– The value formatted by the date/time field.
itemsCount– The number of items included in this computation.items– Bottom moving or top moving items.categoryValue– The category value.value– The value of the category field.formattedValue– The formatted value of the category field. If the field is null, this parameter displays 'NULL'. If the field is empty, it displays '(empty)'.
currentMetricValue- The current value for the metric field.value– The raw value.formattedValue– The value formatted by the metric field.formattedAbsoluteValue– The absolute value formatted by the metric field.
previousMetricValue- The previous value for the metric field.value– The raw value.formattedValue– The value formatted by the metric field.formattedAbsoluteValue– The absolute value formatted by the metric field.
percentDifference– The percent difference between the current and previous values of the metric field.value– The raw value of the calculation of the percent difference.formattedValue– The formatted value of the percent difference (for example, -42%).formattedAbsoluteValue– The formatted absolute value of the percent difference (for example, 42%).
absoluteDifference– The absolute difference between the current and previous values of the metric field.value– The raw value of the calculation of the absolute difference.formattedValue– The absolute difference formatted based on the formatting preferences specified for the metric field.formattedAbsoluteValue– The absolute value of the difference formatted by the metric field.
Bottom Ranked and Top Ranked
The Bottom ranked computation finds the dimensions that rank in the bottom of the dataset. For example, you can create a computation to find the bottom 3 locations by printer throughput.
The Top ranked computation finds the dimensions that rank in the top of the dataset. For example, you can create a computation to find the top 3 locations by printer throughput.
To use these functions, you need at least one dimension in the Categories field well.
- Parameters
- Computation name - A unique descriptive name for the computation. You can use the default name or add a custom name.
- Category - The category dimension that you want to rank.
- Value - The aggregated measure that the computation is based on.
- Number of results - The number of ranked results that you want to display.
- Computation outputs
-
Note: The items displayed in
bold monospace fontcan be included in the narrative.categoryField– From the Categories field well.name– The formatted display name of the field.
metricField– From the Values field well.name– The formatted display name of the field.aggregationFunction– The aggregation used for the metric (SUM,AVG, and so on).
itemsCount– The number of items included in this computation.items– Bottom ranked or top ranked items.categoryValue– The category value.value– The value of the category field.formattedValue– The formatted value of the category field. If the field is null, this parameter displays 'NULL'. If the field is empty, it displays '(empty)'.
metricValue- The value for the metric field.value– The raw value.formattedValue– The value formatted by the metric field.formattedAbsoluteValue– The absolute value formatted by the metric field.
Forecast
The Forecast computation uses machine learning to forecast future metrics based on patterns of previous metrics by seasonality. For example, you can create a computation to forecast total printer throughput for the next six months.
To use this function, you need at least one dimension in the Time field well.
- Parameters
- Computation name - A unique descriptive name for the computation. You can use the default name or add a custom name.
- Date - The date dimension that you want to analyze.
- Value - The aggregated measure that the computation is based on.
- Periods forward - The number of time periods in the future that you want to forecast. The supported values range from 1 to 1,000.
- Periods backward - The number of time periods in the past that you want to base your forecast on. The supported values range from 1 to 1,000.
- Prediction interval - An estimate of an interval in which future observations can fall, with a certain probability, based on what has already been observed.
- Seasonality - The number of time periods involved in the predictable seasonal pattern of data during a calendar year. Ranges from 1 to 180. The default setting automatically detects the data seasonality.
- Forecast boundaries - The boundaries that prevent forecast values from going above or below a specified threshold.
- Computation outputs
-
Note: The items displayed in
bold monospace fontcan be included in the narrative.timeField– From the Time field well.name– The formatted display name of the field.timeGranularity– The time field granularity ( DAY, YEAR, and so on).
metricField– From the Values field well.name– The formatted display name of the field.aggregationFunction– The aggregation used for the metric (SUM,AVG, and so on).
metricValue– The value for the metric field.value– The raw value.formattedValue– The value formatted by the metric field.formattedAbsoluteValue– The absolute value formatted by the metric field.
timeValue– The value in the date dimension.value– The raw value.formattedValue– The value formatted by the date field.
relativePeriodsToForecast– The relative number of periods between the latest date/time record and the last forecast record.
Growth Rate
The Growth rate computation compares values over time periods. For example, you can create a computation to find the 3-month compounded growth rate for printed impressions, expressed as a percentage.
To use this function, you need at least one dimension in the Time field well.
- Parameters
- Computation name - A unique descriptive name for the computation. You can use the default name or add a custom name.
- Date - The date dimension that you want to analyze.
- Value - The aggregated measure that the computation is based on.
- Number of periods - The number of time periods in the future that you want to use to compute the growth rate.
- Computation outputs
-
Note: The items displayed in
bold monospace fontcan be included in the narrative.timeField– From the Time field well.name– The formatted display name of the field.timeGranularity– The time field granularity ( DAY, YEAR, and so on).
metricField– From the Values field well.name– The formatted display name of the field.aggregationFunction– The aggregation used for the metric (SUM,AVG, and so on).
previousMetricValue- The previous value for the metric field.value– The raw value.formattedValue– The value formatted by the metric field.formattedAbsoluteValue– The absolute value formatted by the metric field.
previousTimeValue– The previous value in the date/time dimension.value– The raw value.formattedValue– The value formatted by the date/time field.
currentMetricValue- The current value for the metric field.value– The raw value.formattedValue– The value formatted by the metric field.formattedAbsoluteValue– The absolute value formatted by the metric field.
currentTimeValue– The current value in the date/time dimension.value– The raw value.formattedValue– The value formatted by the date/time field.
timePeriods– The number of periods set in the computation properties.compoundedGrowthRate– The percent difference between the current and previous values of the metric field.value– The raw value of the calculation of the percent difference.formattedValue– The formatted value of the percent difference (for example, -42%).formattedAbsoluteValue– The formatted absolute value of the percent difference (for example, 42%).
absoluteDifference– The absolute difference between the current and previous values of the metric field.value– The raw value of the calculation of the absolute difference.formattedValue– The absolute difference formatted based on the formatting preferences specified for the metric field.formattedAbsoluteValue– The absolute value of the difference formatted by the metric field.
Maximum and Minimum
The Maximum computation finds the maximum dimension by value. For example, you can create a computation to find the month with the highest printer throughput.
The Minimum computation finds the minimum dimension by value. For example, you can create a computation to find the month with the lowest printer throughput.
To use these functions, you need at least one dimension in the Time field well.
- Parameters
- Computation name - A unique descriptive name for the computation. You can use the default name or add a custom name.
- Date - The date dimension that you want to analyze.
- Value - The aggregated measure that the computation is based on.
- Computation outputs
-
Note: The items displayed in
bold monospace fontcan be included in the narrative.timeField– From the Time field well.name– The formatted display name of the field.timeGranularity– The time field granularity ( DAY, YEAR, and so on).
metricField– From the Values field well.name– The formatted display name of the field.aggregationFunction– The aggregation used for the metric (SUM,AVG, and so on).
metricValue- The value for the metric field.value– The raw value.formattedValue– The value formatted by the metric field.formattedAbsoluteValue– The absolute value formatted by the metric field.
timeValue– The value in the date/time dimension.value– The raw value.formattedValue– The value formatted by the date/time field.
Metric Comparison
The Metric comparison computation compares values in different measures. For example, you can create a computation to compare two values, such as the actual printer throughput and the target throughput value.
To use this function, you need at least one dimension in the Time field well and at least two measures in the Values field well.
- Parameters
- Computation name - A unique descriptive name for the computation. You can use the default name or add a custom name.
- Date - The date dimension that you want to analyze.
- From value - The measure that you want to compare.
- Target value - The measure that you want to use as the comparison target.
- Computation outputs
-
Note: The items displayed in
bold monospace fontcan be included in the narrative.timeField– From the Time field well.name– The formatted display name of the field.timeGranularity– The time field granularity ( DAY, YEAR, and so on).
fromMetricField– From the Values field well.name– The formatted display name of the field.aggregationFunction– The aggregation used for the metric (SUM,AVG, and so on).
fromMetricValue– The value for the metric field that you want to compare.value– The raw value.formattedValue– The value formatted by the metric field.formattedAbsoluteValue– The absolute value formatted by the metric field.
toMetricField– From the Values field well.name– The formatted display name of the field.aggregationFunction– The aggregation used for the metric (SUM,AVG, and so on).
toMetricValue– The value for the target metric field.value– The raw value.formattedValue– The value formatted by the metric field.formattedAbsoluteValue– The absolute value formatted by the metric field.
timeValue– The value in the date/time dimension.value– The raw value.formattedValue– The value formatted by the date/time field.
percentDifference– The percent difference between the values of the compared metric fields.value– The raw value of the calculation of the percent difference.formattedValue– The formatted value of the percent difference (for example, -42%).formattedAbsoluteValue– The formatted absolute value of the percent difference (for example, 42%).
absoluteDifference– The absolute difference between the values of the compared metric fields.value– The raw value of the calculation of the absolute difference.formattedValue– The absolute difference formatted based on the formatting preferences specified for the metric field.formattedAbsoluteValue– The absolute value of the difference formatted by the metric field.
Period Over Period
The Period over period computation compares values from two different time periods. For example, you can create a computation to see how much printer throughput increased or decreased since the previous time period.
To use this function, you need at least one dimension in the Time field well.
- Parameters
- Computation name - A unique descriptive name for the computation. You can use the default name or add a custom name.
- Date - The date dimension that you want to analyze.
- Value - The aggregated measure that the computation is based on.
- Computation outputs
-
Note: The items displayed in
bold monospace fontcan be included in the narrative.timeField– From the Time field well.name– The formatted display name of the field.timeGranularity– The time field granularity ( DAY, YEAR, and so on).
metricField– From the Values field well.name– The formatted display name of the field.aggregationFunction– The aggregation used for the metric (SUM,AVG, and so on).
previousMetricValue- The previous value for the metric field.value– The raw value.formattedValue– The value formatted by the metric field.formattedAbsoluteValue– The absolute value formatted by the metric field.
previousTimeValue– The previous value in the date/time dimension.value– The raw value.formattedValue– The value formatted by the date/time field.
currentMetricValue- The current value for the metric field.value– The raw value.formattedValue– The value formatted by the metric field.formattedAbsoluteValue– The absolute value formatted by the metric field.
currentTimeValue– The current value in the date/time dimension.value– The raw value.formattedValue– The value formatted by the date/time field.
percentDifference– The percent difference between the current and previous values of the metric field.value– The raw value of the calculation of the percent difference.formattedValue– The formatted value of the percent difference (for example, -42%).formattedAbsoluteValue– The formatted absolute value of the percent difference (for example, 42%).
absoluteDifference– The absolute difference between the current and previous values of the metric field.value– The raw value of the calculation of the absolute difference.formattedValue– The absolute difference formatted based on the formatting preferences specified for the metric field.formattedAbsoluteValue– The absolute value of the difference formatted by the metric field.
Period to Date
The Period to date computation evaluates values for a specified period to date. For example, you can create a computation to find the year-to-date printed impressions.
To use this function, you need at least one dimension in the Time field well.
- Parameters
- Computation name - A unique descriptive name for the computation. You can use the default name or add a custom name.
- Date - The date dimension that you want to analyze.
- Value - The aggregated measure that the computation is based on.
- Time granularity - The date granularity that you want to use for the computation, such as year to date.
- Computation outputs
-
Note: The items displayed in
bold monospace fontcan be included in the narrative.timeField– From the Time field well.name– The formatted display name of the field.timeGranularity– The time field granularity ( DAY, YEAR, and so on).
metricField– From the Values field well.name– The formatted display name of the field.aggregationFunction– The aggregation used for the metric (SUM,AVG, and so on).
previousMetricValue- The previous value for the metric field.value– The raw value.formattedValue– The value formatted by the metric field.formattedAbsoluteValue– The absolute value formatted by the metric field.
previousTimeValue– The previous value in the date/time dimension.value– The raw value.formattedValue– The value formatted by the date/time field.
currentMetricValue- The current value for the metric field.value– The raw value.formattedValue– The value formatted by the metric field.formattedAbsoluteValue– The absolute value formatted by the metric field.
currentTimeValue– The current value in the date/time dimension.value– The raw value.formattedValue– The value formatted by the date/time field.
periodGranularity– The period granularity for this computation (MONTH, YEAR, and so on).percentDifference– The percent difference between the current and previous values of the metric field.value– The raw value of the calculation of the percent difference.formattedValue– The formatted value of the percent difference (for example, -42%).formattedAbsoluteValue– The formatted absolute value of the percent difference (for example, 42%).
absoluteDifference– The absolute difference between the current and previous values of the metric field.value– The raw value of the calculation of the absolute difference.formattedValue– The absolute difference formatted based on the formatting preferences specified for the metric field.formattedAbsoluteValue– The absolute value of the difference formatted by the metric field.
Total Aggregation
The Total aggregation computation creates a grand total of the value. For example, you can create a computation to find the total number of printed impressions.
To use this function, you need at least one dimension in the Time field well and at least one measure in the Values field well.
- Parameters
- Computation name - A unique descriptive name for the computation. You can use the default name or add a custom name.
- Value - The aggregated measure that the computation is based on.
- Computation outputs
-
Note: The items displayed in
bold monospace fontcan be included in the narrative.metricField– From the Values field well.name– The formatted display name of the field.aggregationFunction– The aggregation used for the metric (SUM,AVG, and so on).
totalAggregate– The total value of the metric aggregation.value– The raw value.formattedValue– The value formatted by the metric field.formattedAbsoluteValue– The absolute value formatted by the metric field.
Unique Values
The Unique values computation counts the unique values in a category field. For example, you can create a computation to count the number of unique values in a dimension, such as the number of locations.
To use this function, you need at least one dimension in the Categories field well.
1.4.2.5.2 Configuring Anomaly Detection
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click New analysis or click , the Options button, next to an existing analysis and select Edit.
- On the analysis page, add a suggested or a custom anomaly detection insight.
Add at least one date, one measure, and one dimension to the insight. You can add up to five dimension fields that are not calculated fields in the Categories field well.
For more information on creating insights, see Adding Suggested Insights or Adding Custom Insights.
Note: You can also add an anomaly detection insight by clicking
, the ML-powered insight notification button, that is displayed for visuals where an anomaly or key drivers
analysis opportunity is identified. Follow the prompts to set up anomaly detection
based on the data from the visual. - To configure the anomaly detection settings, click , the Menu options button, in the corner of the insight and select Configure anomaly.
- In the Set up anomaly detection dialog, configure the anomaly detection settings.
- For Combinations to be analyzed, select the method for analyzing the hierarchical field combinations for the Categories field well:
- Hierarchical: Analyzes the fields hierarchically. For example, if you chose a date (
T), a measure (N), and three dimension categories (C1,C2, andC3), the fields are analyzed as:T-N, T-C1-N, T-C1-C2-N, T-C1-C2-C3-N
- Exact: Analyzes only the exact combination of fields in the Categories field well, in the order that they are listed. For example, if you chose a date (
T), a measure (N), and three dimension categories (C1,C2, andC3), the fields are analyzed as:T-C1-C2-C3-N
- All: Analyzes all the field combinations in the Categories field well. For example, if you chose a date (
T), a measure (N), and three dimension categories (C1,C2, andC3), the fields are analyzed as:T-N, T-C1-N, T-C1-C2-N, T-C1-C2-C3-N, T-C1-C3-N, T-C2-N, T-C2-C3-N, T-C3-N
If you chose only a date and a measure, the fields are analyzed by date and then by measure. The Fields to be analyzed section displays the list of fields from the field wells, for reference. - Hierarchical: Analyzes the fields hierarchically. For example, if you chose a date (
- For Name, enter a descriptive alphanumeric name with no spaces.This name is used as the name of the computation. If you edit the narrative that automatically displays in the insight, you can use the specified name to identify this computation.
- In the Display options section, customize what is displayed in the insight.These options are available:
- Maximum number of anomalies to show: The number of outliers that you want to display in the insight.
- Severity: The minimum level of severity for anomalies that you want to display in the insight.
A level of severity is a range of anomaly scores that is characterized by the lowest actual anomaly score included in the range. All anomalies that score higher are included in the range. If you set the severity to Low and above, the insight displays all the anomalies that rank between low and very high. If you set the severity to Very high, the insight displays only the anomalies that have the highest anomaly scores.
- Direction: The direction on the x-axis or y-axis that you want to identify as anomalous.
The default option, [ALL], identifies all anomalous values, high and low. You can select Higher than expected or Lower than expected to identify only higher values or only lower values as anomalies.
- Delta: The minimum deviation used to identify anomalies. Any amount higher than the threshold
value counts as an anomaly.
You can set an absolute value as the threshold. For example, if you enter 48, values are identified as anomalous when the difference between the value and the expected value is greater than 48. You can also set a percentage threshold. For example, if you enter 12.5%, values are identified as anomalous when the difference between the value and the expected value is greater than 12.5%.
- Sort by: The sort method applied to the anomaly detection results.
- Weighted anomaly score: The anomaly score multiplied by the logarithm of the absolute value of the difference between the actual value and the expected value. This score is always a positive number.
- Anomaly score: The actual anomaly score assigned to this data point.
- Weighted difference from expected value: The anomaly score multiplied by the difference between the actual value and the expected value. This is the default option.
- Difference from expected value: The actual difference between the actual value and the expected value.
- Actual value: The actual value with no formula applied.
Note: You can still explore all the results, regardless of what the insight displays. - In the Schedule and alert options section, set the schedule for automatically running the insight recalculation.The schedule runs only for published dashboards. In the analysis, you can run it manually as needed.
- Occurrence: How often the recalculation is run. You can set it to run every hour, every day, every week, or every month.
- Start schedule on: The date and time to start running this schedule.
- Timezone: The time zone that the schedule runs in. To view the list of time zones, delete the current entry.
- In the Top contributors section, configure settings for analyzing the key drivers when an anomaly, or outlier,
is detected.For example, you can see the top locations that contributed to a spike in printer throughput.
Select the fields for the contribution analysis under Select fields. You can select up to four dimensions from your dataset, including dimensions that are not added to the field wells of the insight.
- For Combinations to be analyzed, select the method for analyzing the hierarchical field combinations for the Categories field well:
- Click Save.
- To run the anomaly detection, click the Run now button inside the insight.The amount of time the anomaly detection takes to complete varies depending on how many unique data points you are analyzing. The process can take a few minutes to up to a few hours. While processing is running in the background, you can still work with the analysis.
Make sure that you wait for the processing to complete before you change the configuration, edit the narrative, or open the Explore anomalies page for the insight. The anomaly detection needs to run at least once before you can see results. If you think the status might be out of date, try refreshing the web browser page.
Anomaly detection insights display different options or messages depending on the processing status:
Option or message Status Run now button The job has not started yet. Analyzing for anomalies... message The job is currently running. Narrative about the detected anomalies The job has run successfully. The message also says when the insight calculation was last updated. Alert icon with an exclamation point (!) There was an error during the last run. If the narrative is still displayed, you can still click Explore anomalies to use data from the previous successful run.
1.4.2.5.2.1 Exploring Anomalies
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, select an anomaly detection insight.Make sure that the detection process ran successfully and that the insight displays the identified anomalies and the last time the results were updated. For more information, see Configuring Anomaly Detection.
- Click , the Menu options button, in the corner of the insight and select Explore anomalies.
- On the Insights page, expand the Controls bar at the top and configure the settings available for exploring anomalies.
- Severity: The level of sensitivity for detecting anomalies.
For example, you see more anomalies when the threshold is set to Low and above and fewer anomalies when the threshold is set to High and above. This sensitivity is determined based on standard deviations of the anomaly score generated by the machine learning algorithm.
- Direction: The direction on the x-axis or y-axis that you want to identify as anomalous.
The default option, [ALL], identifies all anomalous values, high and low. You can select Higher than expected or Lower than expected to identify only higher values or only lower values as anomalies.
- Minimum delta - absolute value: The absolute threshold to identify anomalies. Any amount higher than the threshold value counts as an anomaly.
- Minimum delta - percentage: The percentage threshold to identify anomalies. Any amount higher than the threshold value counts as an anomaly.
- Sort by: The sort method applied to the results.
- Weighted anomaly score: The anomaly score multiplied by the logarithm of the absolute value of the difference between the actual value and the expected value. This score is always a positive number.
- Anomaly score: The actual anomaly score assigned to this data point.
- Weighted difference from expected value: The anomaly score multiplied by the difference between the actual value and the expected value. This is the default option.
- Difference from expected value: The actual difference between the actual value and the expected value.
- Actual value: The actual value with no formula applied.
- Categories: One category setting is displayed for each category field that you added to the Categories field well. You can use the category settings to filter the data.
A list of anomaly charts is displayed on the Insights page based on your configurations. Each category or dimension has a separate chart that uses the field name as the chart title.
- Severity: The level of sensitivity for detecting anomalies.
- To display or hide the Number of anomalies chart that shows anomalies detected over time, click the Show anomalies by date or Hide anomalies by date option.Hover over a bar in the chart to view the number of anomalies for that point in time. Click one of the bars to display a chart that shows the values for the analyzed data metric before and after the anomaly.
- To see information about key drivers, look at the Contributors panel at the left of the page.
At the top of the panel, you can see a summary that describes any changes in the data metrics.
Under Top Contributors, you can see the results of the top contributor analysis for the specified time frame. Hover over the entries to see more details.
To change the sort method applied to the results, select one of the options available under Sort by. You can select Absolute difference, Contribution percentage, Deviation from expected, or Percentage difference.
Note: The Contributors panel is displayed only if the anomaly detection is configured to also analyze key drivers.
1.4.2.5.3 Adding Forecasts in Visuals
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, click , the Menu options button, in the corner of a visual that displays data over time and select Add forecast.The machine learning algorithm automatically analyzes the historical data and displays a graphical forecast for the next 14 periods. Forecast properties apply to all the data metrics in the visual.
You can add forecasts only in visuals that use a single date field and up to three measure fields.
- In the Forecast properties panel, customize the forecast settings.
- Under Forecast length, set the number of periods forward to forecast or the number of periods backward to analyze for patterns.
- Under Prediction interval, set the estimated range for the forecast to change how wide the band of possibility
is around the predicted line.The prediction interval is an estimate of an interval in which future observations can fall, with a certain probability, based on what has already been observed.
- Under Seasonality, set the number of time periods involved in the predictable seasonal pattern of data.Seasonality is a characteristic of a time series in which the data experiences regular and predictable changes that recur every calendar year.
- Under Forecast boundaries, set a minimum and maximum forecast value to prevent forecast values from going above or below a specified threshold. For example, you can stop the forecasted values from ever going below zero.
- Click Apply.If your forecast contains multiple data metrics, you can isolate one of the forecasts by clicking anywhere inside the forecast band. Click the isolated forecast band again to display all the forecasts.
- To analyze what-if scenarios, right-click a forecasted data point from the forecast
band and select What-if analysis from the menu.The What-if analysis option is only available for visuals that contain only one data metric.
- Customize the settings from the What-if analysis panel.
- Under Scenario, specify if you want to set a target for a date or set a target for a time range.
- Under Date, enter the target date or the start and end dates of the target time range.
- Under Target, set a target value for the data metric.
- Click Apply.A new forecast adjusted for the target is displayed alongside the original forecast. The what-if analysis is represented on the visual as a dot on the data metric line. You can hover over the data points on the forecasting line to see the details.
To interact with or remove a what-if analysis, click the dot on the data metric line. To create other what-if scenarios, close the what-if analysis before choosing a new point on the line.
Note: What-if scenarios are only supported in analyses. They are not available in published dashboards.
To edit or remove a forecast, click , the Menu options button, in the top-corner of the visual and select Edit forecast. Update the forecast settings or click Remove to remove the forecast.
1.4.2.6 Importing Visuals to an Analysis
When you import a visual, any configured parameters, calculated fields, filters, visual properties, and conditional formatting settings are also imported.
- You can only import visuals to analyses that you have ownership privileges over.
- Custom visual content, highcharts visuals, visuals with image components, insights, layered maps, text boxes, and filter controls cannot be imported.
- Certain chart features, including reference lines and conditional rendering rules based on parameters and calculated fields, are not supported in the destination analysis.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, click
, the Import button, on the toolbar. - On the Find source to insert from dialog, select one of the available dashboards or analyses and click Load.
- On the Select visuals to import dialog, select the visuals that you want to import and click Import.If the analysis or dashboard contains multiple sheets, you must first select a sheet. You cannot import visuals from multiple sheets at a time.
The imported visuals are added at the bottom of the destination analysis. They retain their original properties but inherit the theme-level properties from the destination analysis.
1.4.2.7 Editing Visuals
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, go to the visual that you want to edit and select it.You can change the content and settings of a visual from the Data, Visuals, and Properties panels. Click the buttons on the toolbar to display or hide a panel.
- To change the type of visual, click , the Visualize button, on the toolbar to display the Visuals panel, and then select a different chart type under Change visual type.
- To change the data included in the visual, click , the Datasets button, on the toolbar to display the Data panel, and then drag different data fields to the field wells in the Visuals panel.To replace or remove a field, you can also use the Options menu from the Visuals panel. Click, the Options button, next to a field and select Replace or Remove.
- To change the settings of the fields included in the visual, click , the Options button, next to a field from the Visuals panel and select one of the available aggregation, formatting, or sorting options.In visuals that display field labels, you can also configure field settings directly from the visual. Click, the Options button, next to a field label and select an option from the menu.
- To customize the appearance of the visual, click , the Properties button, on the toolbar to display the Properties panel, and then configure the available formatting settings.
1.4.2.8 Moving and Resizing Visuals
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, select the visual that you want to work with.
- To move the visual, hover over one of its borders until , the move cursor, is displayed, then drag the visual to the new position.In analysis with a tiled layout or a classic layout, the visuals snap to grid with standard spacing and alignment. In analyses with a free-form layout, the visuals can overlap.
In analyses with a free-form layout, you can also set specific coordinates for the position of the visuals. Click
, the Format visual icon, in the top-right corner of a visual to display the Properties panel. Expand the Display Settings section and enter values in the X and Y fields under Size and position. - To resize the visual, hover over one of its anchor points until , the resize cursor, is displayed, then drag the anchor point to adjust the size of
the visual.In analysis with a tiled layout or a classic layout, the other visuals reposition to preserve the spacing and alignment. In analyses with a free-form layout, the visuals can overlap.
In analyses with a free-form layout, you can also set specific size values for visuals. Click
, the Format visual icon, in the top-right corner of a visual to display the Properties panel. Expand the Display Settings section and enter values in the W and H fields under Size and position. - To expand the visual to the size of the view area, click
, the Maximize button, in the corner of the visual. - To reposition the visual when it overlaps with other visuals in analyses with a free-form
layout, click , the Menu options button, in the corner of the visual and select Send to back, Send backward, Bring forward, or Bring to front.
1.4.2.9 Duplicating Visuals
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, go to the visual that you want to duplicate.
- Click , the Menu options button, in the corner of the visual and select Duplicate visual.
If the analysis has multiple sheets, select the Duplicate visual to... option and choose the sheet where you want the visual to appear.
Duplicated visuals keep the filters and settings of the source visual. However, if you duplicate a visual onto a different sheet, all of its copied filters apply to the duplicate only. All copied filters are scoped down to apply only to that visual. If you want the filters to apply to more visuals on the new sheet, edit the filter and change the setting.
Parameters and controls apply to all sheets. For parameter controls to work with a visual that you duplicate to a different sheet, add filters on the target sheet and connect them to the parameter. Use Custom filter as the filter type.
1.4.2.10 Renaming Visuals
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, go to the visual that you want to rename.
- Double-click the name of the visual.
- In the Edit title dialog, enter the new title, update the text formatting, and click Save.
- Double-click the subtitle of the visual.
- In the Edit subtitle dialog, enter the new subtitle, update the text formatting, and click Save.
1.4.2.11 Refreshing Visuals
You can change the default behavior and configure the visuals in an analysis to always refresh when you switch sheets, regardless of a change.
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, go to .
- In the Analysis Settings panel, enable the Reload visuals each time I switch sheets option under Refresh.
- Click Apply.
1.4.2.12 Deleting Visuals
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, go to the visual that you want to delete.
- Click , the Menu options button, in the corner of the visual, and select Delete.
1.4.2.13 Searching for Specific Values
You can search for specific values or all values that contain a specific search query. For example, searching for al in a list of U.S. states returns Alabama, Alaska, and California.
You can also use wildcard search to search for all values that match a specific character pattern. For example, you can search for all U.S. states that end with the letters ia and narrow the results down to California, Georgia, Pennsylvania, Virginia, and West Virginia.
These wildcard characters can be used to find values in filters, lists, and anomaly previews:
- * - Use an asterisk symbol to search for values that match zero to many characters in a specific position.
- ? - Use a question mark to match a single character in a specific position.
- \ - Use a backslash to escape the *, ?, or \ wildcard characters and search for them in your query. For example, you can search for phrases that end with a question mark.
Examples of how supported wildcard characters can be used in a search query:
- al - This query searches for all values with al and returns Alabama, Alaska, and California in a list of U.S. states.
- al* - This query searches for all values that begin with al and end with zero to multiple characters. It returns Alabama, and Alaska.
- *ia - This query searches for all values that begin with zero to multiple characters and end with ia. It returns California, Georgia, Pennsylvania, Virginia, and West Virginia.
- *al* - This query searches for all values with zero to multiple characters before and after the letters al. It returns Alabama, Alaska, and California.
- a?a?a?a - This query searches for all values with a single character in the exact positions between the a letters. It returns Alabama.
- a?a*a - This query searches for all values with a single character between the first two a letters and multiple characters between the second two a letters. It returns Alabama and Alaska.
- How*\? - This query searches for values that begin with How, followed by zero to multiple characters, and end with a question mark. The backslash (\) in this query is used to search for question marks in each value, rather than use the question mark symbol as a wildcard character.
- \** - This query searches for values that begin with an asterisk and are followed by zero to multiple characters. The backslash (\) in this query is used to search for an actual asterisk in the values, rather than use the asterisk symbol as a wildcard character.
- \\* - This query searches for values with a backslash, followed by zero to multiple characters. The first backslash (\) in this query is used to search for the second backslash (\) in each value, rather than use the backslash symbol as a wildcard character.
- ??? - This query searches for values that contain three characters.
1.4.3 Using the Sample Dashboards and Filters
- Click , the Dashboards tab.
- In the Dashboards list, select one of the dashboards available under Sample Dashboards.
- Capacity Planning (Impressions) dashboard
-
Provides information for capacity planning and load balancing by tracking the annual, monthly, and daily volume, the printer performance, and the peak production days and hours based on the number of printed impressions.
For more information, see Capacity Planning (Impressions) Dashboard.
- Ink Consumption (Inkjet printers only) dashboard
-
Provides information for ink consumption by tracking the monthly and daily ink usage and the ink consumption per printer and per job.
For more information, see Ink Consumption (Inkjet printers only) Dashboard .
- Job Insights dashboard
-
Displays job information, including the number of jobs printed, the number of pages printed, the average job size, and the average job duration. It also provides information about printer interventions and intervention duration to help you find the jobs that caused the most issues.
For more information, see Job Insights Dashboard.
- Printer Utilization dashboard
-
Helps you understand how individual printers are utilized based on printer up time, down time, and idle time, the number of printed impressions per hour, the number of printed impressions relative to up time, and printer intervention durations and intervention types.
For more information, see Printer Utilization Dashboard.
- Shift Performance (Previous week) dashboard
-
Provides information for shift productivity by tracking the total, daily, and hourly volume based on the number of printed impressions per shift.
For more information, see Shift Performance (Previous Week) Dashboard.
- RICOH ProcessDirector dashboard
-
Displays information collected from RICOH ProcessDirector.
For more information, see RICOH ProcessDirector Sample Dashboard.
- To interact with the visuals from the sample dashboards:
- To display additional details, hover over the data in the visuals. If the content
is larger than the size of the visual, use the visual scroll bar to reduce the data
that is displayed or scroll through it.
For more information, see Viewing Visual Details.
- To exclude or focus on visual elements, select a visual, then right-click an element,
such as a bar, a data point, or a data segment, and select Exclude or Focus only on.
For more information, see Excluding and Focusing on Visual Elements.
- To drill down into the data and get an in-depth view of a selected value, select a
visual, then right-click an element, such as a bar, a data point, or a data segment,
and select a drill option.
For more information, see Drilling down in Visuals.
- To analyze contributions for a data metric, select a visual, then right-click a data
element, such as a bar or a data point, and select Analyze contributions.
For more information, see Analyzing Contributions in Visuals.
- To select data in a visual and filter the dashboard according to the selected data, click an item in the visual.
- To sort data in ascending or descending order, select a visual, then hover over an axis label and click the sort icon.
- To expand a visual and view it in a larger size, click , the Maximize button, in the corner of the visual.
- To export the data from a visual as a CSV file, click , the Options button, in the corner of the visual, and select Export to CSV.
For more information, see Exporting Data from Visuals.
- To view a summary of the data in a visual, click , the Options button, in the corner of the visual, and select View summary data.
For more information, see Viewing Summary Data in Visuals.
The available options depend on the type and configuration of the visual.
- To display additional details, hover over the data in the visuals. If the content
is larger than the size of the visual, use the visual scroll bar to reduce the data
that is displayed or scroll through it.
- To filter the data in the visuals:
- To display the Filters panel, click
, the Applied filters button, in the corner of a visual and select View dashboard filters.
For more information on using filters, see Working with Filters. For more information on the filters defined for each sample dashboard, see Shift Performance (Previous Week) Dashboard, Capacity Planning (Impressions) Dashboard, Ink Consumption (Inkjet printers only) Dashboard , Job Insights Dashboard, or Printer Utilization Dashboard. - To display the Filters panel, click
- To duplicate a sample dashboard, right-click the dashboard name and select Duplicate.For more information, see Duplicating Dashboards.
1.4.3.1 Capacity Planning (Impressions) Dashboard
- Note:
- This dashboard requires data from RICOH Supervisor Data Collector.
All the time-related data from the Capacity Planning (Impressions) dashboard is displayed in the printer time zone set in RICOH Supervisor Data Collector.
The following visuals are included in the Capacity Planning (Impressions) dashboard:
- ANNUAL VOLUME
- Visual type: Radar chart
- Displays the total number of printed impressions per year. Includes data from both cut sheet and continuous form printers.
- MONTHLY VOLUME
- Visual type: Bar chart
- Displays the total number of printed impressions per month. Includes data from both cut sheet and continuous form printers.
- PRINTERS WITH HIGHEST VOLUME FOR SELECTED DATES
- Visual type: Bar chart
-
Displays the printers with the highest number of printed impressions for the time period specified in the Filters panel. Includes data for both cut sheet and continuous form printers.
You can use the slider to focus on a specific range of data.
- PEAK PRODUCTION DAYS
- Visual type: Area line chart
-
Displays the peak production days based on the total number of printed impressions. Includes data from both cut sheet and continuous form printers.
You can use the slider to focus on a specific range of data.
- PEAK PRODUCTION HOURS BY AVERAGE IMPRESSIONS
- Visual type: Line chart
- Displays the overall peak production hours based on the average number of printed impressions. Includes data from both cut sheet and continuous form printers.
These filter controls are defined for the Capacity Planning (Impressions) dashboard:
- Date
- Lets you filter the data based on a specific data collecting period. By default, the data in the dashboard is limited to the last 2 quarters.
-
When you edit the filter, choose one of the following options:
- Relative date
Choose how you want the filter to relate to the time frame. You can choose to report on previous quarter, this quarter, quarter to date, last number of quarters or next number of quarters.
You also have the option to exclude time periods.
- Absolute date range
Choose the date range from the calendar.
The data is selected based on the time zone of the web browser that accesses RICOH Supervisor.
- Relative date
- Location Name
- Lets you display data only for specific locations.
To view data per location, you must first group your printers by location in the Locations panel on the Settings tab.
Only the printers that are currently registered in RICOH Supervisor Data Collector can be associated with a location.
A location is displayed in visuals and filters only if it contains at least one printer and if data is available from the printers assigned to the location. If the location is associated with a shift, data must be available for the time interval covered by the shift.
- Printer Name
- Lets you display data only for specific printers in the locations selected for the
Location Name filter.
Only the printers that have already sent job or status information are available in the list.
- Shift Name
- Lets you display data only for specific shifts associated with the locations and printers
selected for the Location Name and Printer Name filters.
To view data per shift, you must first record your shifts in the Shifts panel on the Settings tab.
Shifts apply only to printers that are currently registered in RICOH Supervisor Data Collector.
Data is assigned to a shift based on the printers included in the shift location and the printer time zone set in RICOH Supervisor Data Collector. If a shift does not have a location specified, it applies to all the printers available in the system.
All the job data collected in the time interval covered by a shift is assigned to that shift, even if the job started printing or finished printing outside the shift interval.
A shift is displayed in visuals and filters only if data is available for the time interval covered by the shift. If the shift is associated with a location, data must be available from the printers assigned to that location.
1.4.3.2 Ink Consumption (Inkjet printers only) Dashboard
All the time-related data from the Ink Consumption (Inkjet printers only) sample dashboard is displayed in the printer time zone set in RICOH Supervisor Data Collector.
The ink consumption reported by RICOH Supervisor Data Collector includes all ink usage, including ink used to flush the printheads.
The following visuals are included in the Ink Consumption (Inkjet printers only) sample dashboard:
- MONTHLY INK USAGE - ALL PRINTERS (LITER)
- Visual type: Stacked area line chart
- Displays the total ink usage per month, measured in liters. Includes data from all inkjet printers.
- INK USAGE PER PRINTER (LITER)
- Visual type: Stacked bar chart
-
Displays the total ink usage per printer, measured in liters. Includes data from all inkjet printers.
You can use the slider to focus on a specific range of data.
- INK USAGE PER JOB (MILLILITER)
- Visual type: Stacked bar chart
-
Displays the peak ink usage per job, measured in milliliters. Includes data from all inkjet printers.
You can use the slider to focus on a specific range of data.
This filter control is defined for the Ink Consumption (Inkjet printers only) sample dashboard:
- Date
- Lets you filter the data based on a specific data collecting period. By default, the data in the dashboard is limited to the last 2 quarters.
-
When you edit the filter, choose one of the following options:
- Relative date
Choose how you want the filter to relate to the time frame. You can choose to report on previous quarter, this quarter, quarter to date, last number of quarters or next number of quarters.
You also have the option to exclude time periods.
- Absolute date range
Choose the date range from the calendar.
The data is selected based on the time zone of the web browser that accesses RICOH Supervisor.
- Relative date
1.4.3.3 Job Insights Dashboard
- Note:
- This dashboard requires data from RICOH Supervisor Data Collector.
All the time-related data from the Job Insights dashboard is displayed in the printer time zone set in RICOH Supervisor Data Collector.
The following visuals are included in the Job Insights dashboard:
- PAGES PRINTED FOR SELECTED DATES
- Visual type: Key performance indicator
- Displays the total number of pages printed in the time period specified in the Filters panel and the best daily result. Includes data from both cut sheet and continuous form printers.
- JOBS PRINTED FOR SELECTED DATES
- Visual type: Key performance indicator
- Displays the total number of jobs printed in the time period specified in the Filters panel and the best daily result. Includes data from both cut sheet and continuous form printers.
- AVERAGE JOB SIZE
- Visual type: Key performance indicator
- Displays the average job size based on the number of printed pages. Includes data from both cut sheet and continuous form printers.
- AVERAGE JOB DURATION
- Visual type: Key performance indicator
- Displays the average job duration in minutes based on data collected in the last 180 days. Includes data from both cut sheet and continuous form printers.
- PAGES PRINTED TODAY
- Visual type: Key performance indicator
- Displays the number of printed pages for the current day and the daily average from the beginning of the current year. Includes data from both cut sheet and continuous form printers.
- JOBS PRINTED TODAY
- Visual type: Key performance indicator
- Displays the number of printed jobs for the current day and the daily average from the beginning of the current year. Includes data from both cut sheet and continuous form printers.
- JOBS BY NUMBER OF INTERVENTIONS VERSUS INTERVENTION DURATION
- Visual type: Scatter plot
-
Displays the number of printer interventions and the intervention duration for jobs that encountered a printer intervention. Includes data from both cut sheet and continuous form printers.
Each job is represented by a dot in the chart. The size of the dots depends on the printer intervention duration.
For increased accuracy, a Printer Intervention Sequence filter is applied to the visual. When the printer sends several intervention codes at the same time, only the main intervention is included in the visual.
This filter is especially useful when a main printer intervention generates a sequence of other interventions. For example, the
serviceRequestedandofflineintervention codes are often received alongside the main intervention. The filter excludes theserviceRequestedandofflineintervention codes when they overlap with the main intervention.The filter also applies when several independent printer interventions, such as
paperJamandmediaLow, occur at the same time.For more information on the Printer Intervention Sequence field and on how RICOH Supervisor orders simultaneous interventions and determines the main intervention, see Data Fields from RICOH Supervisor Data Collector .
All the printer intervention data collected with a RICOH Supervisor Data Collector version older than 1.1.0.669 is automatically assigned to the N\A intervention sequence value. Make sure that you include this value in the Printer Intervention Sequence filter if you want to view older data.
- INTERVENTIONS BY DURATION FOR SELECTED JOBS
- Visual type: Bar chart
-
Displays the printer interventions with the highest duration for the jobs selected in the Filters panel. Includes data from both cut sheet and continuous form printers.
You can use the slider to focus on a specific range of data.
For increased accuracy, a Printer Intervention Sequence filter is applied to the visual. When the printer sends several intervention codes at the same time, only the main intervention is included in the visual.
This filter is especially useful when a main printer intervention generates a sequence of other interventions. For example, the
serviceRequestedandofflineintervention codes are often received alongside the main intervention. The filter excludes theserviceRequestedandofflineintervention codes when they overlap with the main intervention.The filter also applies when several independent printer interventions, such as
paperJamandmediaLow, occur at the same time.For more information on the Printer Intervention Sequence field and on how RICOH Supervisor orders simultaneous interventions and determines the main intervention, see Data Fields from RICOH Supervisor Data Collector .
All the printer intervention data collected with a RICOH Supervisor Data Collector version older than 1.1.0.669 is automatically assigned to the N\A intervention sequence value. Make sure that you include this value in the Printer Intervention Sequence filter if you want to view older data.
These filter controls are defined for the Job Insights dashboard:
- Date
- Lets you filter the data based on a specific data collecting period. By default, the data in the dashboard is limited to the last 2 quarters.
-
When you edit the filter, choose one of the following options:
- Relative date
Choose how you want the filter to relate to the time frame. You can choose to report on previous quarter, this quarter, quarter to date, last number of quarters or next number of quarters.
You also have the option to exclude time periods.
- Absolute date range
Choose the date range from the calendar.
The data is selected based on the time zone of the web browser that accesses RICOH Supervisor.
- Relative date
- Job Name
- Lets you display data only for specific jobs.
By default, all jobs are included.
- Location Name
- Lets you display data only for specific locations.
To view data per location, you must first group your printers by location in the Locations panel on the Settings tab.
Only the printers that are currently registered in RICOH Supervisor Data Collector can be associated with a location.
A location is displayed in visuals and filters only if it contains at least one printer and if data is available from the printers assigned to the location. If the location is associated with a shift, data must be available for the time interval covered by the shift.
- Printer Name
- Lets you display data only for specific printers in the locations selected for the
Location Name filter.
Only the printers that have already sent job or status information are available in the list.
- Shift Name
- Lets you display data only for specific shifts associated with the locations and printers
selected for the Location Name and Printer Name filters.
To view data per shift, you must first record your shifts in the Shifts panel on the Settings tab.
Shifts apply only to printers that are currently registered in RICOH Supervisor Data Collector.
Data is assigned to a shift based on the printers included in the shift location and the printer time zone set in RICOH Supervisor Data Collector. If a shift does not have a location specified, it applies to all the printers available in the system.
All the job data collected in the time interval covered by a shift is assigned to that shift, even if the job started printing or finished printing outside the shift interval.
A shift is displayed in visuals and filters only if data is available for the time interval covered by the shift. If the shift is associated with a location, data must be available from the printers assigned to that location.
1.4.3.4 Printer Utilization Dashboard
- Note:
- This dashboard requires data from RICOH Supervisor Data Collector.
All the time-related data from the Printer Utilization dashboard is displayed in the printer time zone set in RICOH Supervisor Data Collector.
The following visuals are included in the Printer Utilization dashboard:
- DAILY UTILIZATION
- Visual type: Line chart
-
Displays the overall printer up time, idle time, and down time per day. Includes data from both cut sheet and continuous form printers.
The up time, down time, and idle time values are retrieved from the printers in milliseconds. In the visual, these values are converted into a number of hours expressed as a decimal value. For example, a duration of 1 hour and 30 minutes is displayed as 1.5 hours in the visual.
You can use the slider to focus on a specific range of data.
- PRINTER UTILIZATION FOR SELECTED DATES
- Visual type: Stacked 100% bar chart
-
Displays the up time, idle time, and down time percentages per printer for the time period specified in the Filters panel. Includes data for both cut sheet and continuous form printers.
The up time, down time, and idle time values are retrieved from the printers in milliseconds. In the visual, these values are converted into a number of hours expressed as a decimal value. For example, a duration of 1 hour and 30 minutes is displayed as 1.5 hours in the visual.
You can use the slider to focus on a specific range of data.
- IMPRESSIONS PER HOUR FOR SELECTED DATES
- Visual type: Bar chart
-
Displays the average number of impressions printed in an hour per printer for the time period specified in the Filters panel. Includes data for both cut sheet and continuous form printers.
Idle time and down time are excluded from the calculation.
You can use the slider to focus on a specific range of data.
- IMPRESSIONS RELATIVE TO UP TIME FOR SELECTED DATES
- Visual type: Clustered bar combo chart
-
Displays the total number of printed impressions compared to up time per printer for the time period specified in the Filters panel. Includes data for both cut sheet and continuous form printers.
You can use the slider to focus on a specific range of data.
- INTERVENTION DURATION (HOURS) PER PRINTER ENGINE
- Visual type: Bar chart
-
Displays the total printer intervention duration per printer and printer engine, measured in hours, for the time period specified in the Filters panel. Includes data for both cut sheet and continuous form printers.
You can use the slider to focus on a specific range of data.
For increased accuracy, a Printer Intervention Sequence filter is applied to the visual. When the printer sends several intervention codes at the same time, only the main intervention is included in the visual.
This filter is especially useful when a main printer intervention generates a sequence of other interventions. For example, the
serviceRequestedandofflineintervention codes are often received alongside the main intervention. The filter excludes theserviceRequestedandofflineintervention codes when they overlap with the main intervention.The filter also applies when several independent printer interventions, such as
paperJamandmediaLow, occur at the same time.For more information on the Printer Intervention Sequence field and on how RICOH Supervisor orders simultaneous interventions and determines the main intervention, see Data Fields from RICOH Supervisor Data Collector .
All the printer intervention data collected with a RICOH Supervisor Data Collector version older than 1.1.0.669 is automatically assigned to the N\A intervention sequence value. Make sure that you include this value in the Printer Intervention Sequence filter if you want to view older data.
- INTERVENTION TYPE DURATION TREEMAP FOR SELECTED PRINTERS AND DATES
- Visual type: Tree map
-
Displays the distribution of printer intervention types for the printers and the time period specified in the Filters panel. Includes data from both cut sheet and continuous form printers.
Each printer intervention message is represented by a rectangle. The size of the rectangles depends on the intervention duration. The color of the rectangles ranges from orange to red also based on the intervention duration, with red being used for the highest value.
For increased accuracy, a Printer Intervention Sequence filter is applied to the visual. When the printer sends several intervention codes at the same time, only the main intervention is included in the visual.
This filter is especially useful when a main printer intervention generates a sequence of other interventions. For example, the
serviceRequestedandofflineintervention codes are often received alongside the main intervention. The filter excludes theserviceRequestedandofflineintervention codes when they overlap with the main intervention.The filter also applies when several independent printer interventions, such as
paperJamandmediaLow, occur at the same time.For more information on the Printer Intervention Sequence field and on how RICOH Supervisor orders simultaneous interventions and determines the main intervention, see Data Fields from RICOH Supervisor Data Collector .
All the printer intervention data collected with a RICOH Supervisor Data Collector version older than 1.1.0.669 is automatically assigned to the N\A intervention sequence value. Make sure that you include this value in the Printer Intervention Sequence filter if you want to view older data.
These filter controls are defined for the Printer Utilization dashboard:
- Date
- Lets you filter the data based on a specific data collecting period. By default, the data in the dashboard is limited to the last two quarters.
-
When you edit the filter, choose one of the following options:
- Relative date
Choose how you want the filter to relate to the time frame. You can choose to report on previous quarter, this quarter, quarter to date, last number of quarters or next number of quarters.
You also have the option to exclude time periods.
- Absolute date range
Choose the date range from the calendar.
The data is selected based on the time zone of the web browser that accesses RICOH Supervisor.
- Relative date
- Location Name
- Lets you display data only for specific locations.
To view data per location, you must first group your printers by location in the Locations panel on the Settings tab.
Only the printers that are currently registered in RICOH Supervisor Data Collector can be associated with a location.
A location is displayed in visuals and filters only if it contains at least one printer and if data is available from the printers assigned to the location. If the location is associated with a shift, data must be available for the time interval covered by the shift.
- Printer Name
- Lets you display data only for specific printers in the locations selected for the
Location Name filter.
Only the printers that have already sent job or status information are available in the list.
- Shift Name
- Lets you display data only for specific shifts associated with the locations and printers
selected for the Location Name and Printer Name filters.
To view data per shift, you must first record your shifts in the Shifts panel on the Settings tab.
Shifts apply only to printers that are currently registered in RICOH Supervisor Data Collector.
Data is assigned to a shift based on the printers included in the shift location and the printer time zone set in RICOH Supervisor Data Collector. If a shift does not have a location specified, it applies to all the printers available in the system.
All the job data collected in the time interval covered by a shift is assigned to that shift, even if the job started printing or finished printing outside the shift interval.
A shift is displayed in visuals and filters only if data is available for the time interval covered by the shift. If the shift is associated with a location, data must be available from the printers assigned to that location.
1.4.3.5 Shift Performance (Previous Week) Dashboard
- Note:
- This dashboard requires data from RICOH Supervisor Data Collector.
- This dashboard displays a breakdown of productivity per shift. Define shifts in the Settings tab for this dashboard to work.
All the time-related data from the Shift Performance (Previous week) dashboard is displayed in the printer time zone set in RICOH Supervisor Data Collector.
The following visuals are included in the Shift Performance (Previous week) dashboard:
- HOURLY SHIFT THROUGHPUT FOR SELECTED DATES
- Visual type: Line chart
- Displays a breakdown per hour and shift of the number of printed impressions for a selected date. Includes data from both cut sheet and continuous form printers.
- THROUGHPUT PER SHIFT - TOTALS
- Visual type: Donut chart
- Displays the total number of printed impressions per shift. Includes data from both cut sheet and continuous form printers.
- DAILY PRODUCTION PER SHIFT
- Visual type: Stacked bar chart
-
Displays the daily number of printed impressions per shift. Includes data from both cut sheet and continuous form printers.
These filter controls are defined for the Shift Performance (Previous week) dashboard:
- Date
- Lets you filter the data based on a specific data collecting period. By default, the data in the dashboard is limited to the previous week.
-
When you edit the filter, choose one of the following options:
- Relative date
Choose how you want the filter to relate to the time frame. You can choose to report on previous quarter, this quarter, quarter to date, last number of quarters or next number of quarters.
You also have the option to exclude time periods.
- Absolute date range
Choose the date range from the calendar.
The data is selected based on the time zone of the web browser that accesses RICOH Supervisor.
- Relative date
- Shift Name
- Lets you display data only for specific shifts associated with the locations and printers
selected for the Location Name and Printer Name filters.
To view data per shift, you must first record your shifts in the Shifts panel on the Settings tab.
Shifts apply only to printers that are currently registered in RICOH Supervisor Data Collector.
Data is assigned to a shift based on the printers included in the shift location and the printer time zone set in RICOH Supervisor Data Collector. If a shift does not have a location specified, it applies to all the printers available in the system.
All the job data collected in the time interval covered by a shift is assigned to that shift, even if the job started printing or finished printing outside the shift interval.
A shift is displayed in visuals and filters only if data is available for the time interval covered by the shift. If the shift is associated with a location, data must be available from the printers assigned to that location.
1.4.3.6 RICOH ProcessDirector Sample Dashboard
All the time-related data from the RICOH ProcessDirector dashboard is displayed in the time zone of your browser.
- Note:
- This dashboard requires an active RICOH ProcessDirector data transmitter. For more information on receiving data from RICOH ProcessDirector, see Configuring RICOH ProcessDirector Software Connectors.
These visuals are included in the RICOH ProcessDirector sample dashboard:
- Total print volume
- Visual type: Line chart
- Shows the total number of printed sheets and pages per day.
- Volume by printer
- Visual type: Bar chart
- Shows the total number of printed sheets and pages for each printer.
- Volume by customer
- Visual type: Bar chart
- Shows the total number of sheets and pages printed for each customer.
- Volume by location
- Visual type: Bar chart
-
Shows the total number of sheets and pages printed at each location.
- Volume by printer operator
- Visual type: Bar chart
-
Shows the total number of sheets and pages scheduled for printing by each user.
1.4.4 Downloading Data and Creating Reports
1.4.4.1 Exporting Data from Visuals
- Click , the Dashboards tab, and select a dashboard from the list.
- On the dashboard, hover over the visual that you want to export.
- Click , the Menu options button, in the corner of the visual, and select one of the available export options:
- To export to a CSV file, select Export to CSV.
- To export to a Microsoft Excel file, select Export to Excel. This option is available only for pivot tables and table charts.
- Save the exported file to your computer.The procedure for saving the file depends on the web browser.
1.4.4.2 Exporting Data From Analyses
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit to open the analysis page.
- If the analysis contains multiple sheets, select the sheet that you want to export.
- On the menu bar, go to .
- When the PDF file is ready to download, click Download in the message box from the top-right corner of the analysis page.
- Save the exported file to your computer.The procedure for saving the file depends on the web browser.
1.4.5 Working with Filters
1.4.5.1 Creating Analysis Filters
- On the Analyses dialog, open the analysis.
- In the analysis, choose the Filter icon to open the Filters pane, and then choose ADD.
- Choose the new filter in the pane to configure it. Or you can choose the three dots to the right of the new filter and choose Edit.
- In the Edit filter pane, for Applied to, choose one of the following options:
- Single visualThe filter applies to the selected item only.
- Single sheetThe filter applies to a single sheet.
- Cross sheetThe filter applies to multiple sheets.
- Single visual
1.4.5.1.1 Creating a Text Filter
- To filter text field values by a list:In analyses, you can filter a text field by selecting values to include or exclude from a list of all value in the field.
- Create a new filter using a text field. For more information about creating filters, see Creating Analysis Filters.
- In the Filters panel, choose the new filter to expand it.
- For Filter type, choose Filter list.
- For Filter condition, choose Include or Exclude.
- Choose the field values that you want to filter on. To do this, select the check box
in front of each value.If there are too many values to choose from, enter a search term into the box above the checklist and choose Search. Search terms are case-insensitive. Any field value that contains the search term is returned. For example, searching on L returns al, AL, la, and LA. The values display alphabetically in the control, unless there are more than 1,000 distinct values. Then the control displays a search box instead. Each time that you search for the value that you want to use, it starts a new query. If the results contain more than 1,000 values, you can scroll through the values with pagination.
- When finished, choose Apply.
- To filter text field values by a custom list:You can specify one or more field values to filter on, and whether you want to include or exclude records that contain those values. The specified value and actual field value must match exactly for the filter to be applied to a given record.
- Create a new filter using a text field. For more information about creating filters, see Creating Analysis Filters.
- In the Filters panel, choose the new filter to expand it.
- For Filter type , choose Custom filter list.
- For Filter condition, choose Include or Exclude.
- For List, enter a value in the text box. The value must match an existing field value exactly.
- For Null options choose Exclude nulls, Include nulls, or Nulls only.
- When finished, choose Apply.
- To filter a single text field value:With the Custom filter filter type, you specify a single value that the field value must equal or not equal, or must match partially. If you choose an equal comparison, the specified value and actual field value must match exactly for the filter to be applied to a given record.
- Create a new filter using a text field. For more information about creating filters, see Creating Analysis Filters.
- In the Filters panel, choose the new filter to expand it.
- For Filter type , choose Custom filter.
- For Filter condition, choose one of the following:
- Equals - When you choose this option, the values included or excluded in the field must match the value that you enter exactly.
- Does not equal – When you choose this option, the values included or excluded in the field must match the value that you enter exactly.
- Starts with – When you choose this option, the values included or excluded in the field must start with the value that you enter.
- Ends with – When you choose this option, the values included or excluded in the field must start with the value that you enter.
- Contains – When you choose this option, the values included or excluded in the field must contain the whole value that you enter.
- Does not contain – When you choose this option, the values included or excluded in the field must not contain any part of the value that you enter.
Note: Comparison types are case-sensitive. - Do one of the following:
- For List, enter a value in the text box. The value must match an existing field value exactly.
- For Null options choose Exclude nulls, Include nulls, or Nulls only.
- When finished, choose Apply.
- To filter text field values by a top or bottom value:You can use a Top and bottom filter to show the top or bottom n value of one field ranked by the values in another field.
- Create a new filter using a text field. For more information about creating filters, see Creating Analysis Filters.
- In the Filters panel, choose the new filter to expand it.
- For Filter type , choose Top and bottom filter.
- Choose Top or Bottom.
- For Show top integer (or Show bottom integer), enter the number of top or bottom items to show.
- For By choose a field to base the ranking on.
- When finished, choose Apply.
1.4.5.1.2 Creating Numeric Filters
- Create a new filter using a text field. For more information about creating filters, see Creating Analysis Filters.
- In the Filters panel, choose the new filter to expand it.
- For Filter condition, choose a comparison type.
- Do one of the following:
- If you chose a comparison type of Between, enter the beginning of the value range in Minimum value and the end of the value range in Maximum value.
- If you chose a comparison type other than Between, enter a comparison value.
- To use an existing parameter, enable Use parameters, then choose your parameter from the list.For parameters to appear in this list, create your parameters first.
- For Null options choose Exclude nulls, Include nulls, or Nulls only.
- When finished, choose Apply.
You can create filters on numeric fields by specifying a comparison type and a comparison value or values as appropriate to the comparison type. You can use the following comparison types in numeric filters:- Equals
- Does not equal
- Greater than
- Greater than or equal to
- Less than
- Less than or equal to
- Between
Note: Comparison values must be positive integers and cannot contain commas.
1.4.5.1.3 Creating Date Filters
- Create a new filter on the text field that you want to filter on. For more information about creating filters, see Creating Analysis Filters.
- In the Filters panel, choose the new filter to expand it.
- For Filter type, choose Date & time range.
- For Condition, choose a comparison type: Between, After, Before, or Equals.
- For Time granularity, choose Day, Hour, Minute, or Second.
- For Null options choose Exclude nulls, Include nulls, or Nulls only.
- When finished, choose Apply.
1.4.5.1.4 Creating Nested Filters
- On the Analyses dialog, choose the analysis that you want to add a nested filter to.
- Create a new filter on the text field that you want to filter on. For more information about creating filters, see Creating Analysis Filters.
- Locate the new filter in the Filters pane. Choose the ellipsis (three dots) next to the new filter, and then choose Edit filter. You can also choose the filter entity in the Filters pane to open the Edit filter pane.
- Open the Filter type dropdown menu, navigate to the Avanced filter section, and then choose Nested filter.
- For Qualifying condition, choose Include or Exclude.The qualifying condition allows you to run a not in the set query on the data in your analysis.
- For Nested field, choose the text field that you want to filter data with. The nested field cannot be the same as the primary field selected in step 2.Category fields are the only supported field type for the inner filter.
- For Nested filter type, choose the filter type that you want.
1.4.5.2 Editing Analysis Filters
- On the Analyses dialog, open the analysis.
- In the analysis, choose the Filter icon to open the Filters pane.
- Choose the filter that you want to edit.
- When finished editing, choose Apply.
1.4.5.3 Enabling and Disabling Analysis Filters
- On the Analyses dialog, open the analysis.
- In the analysis, choose the Filter icon to open the Filters pane.
- Choose the filter that you want to edit.
- In the Filters pane that opens, choose the three dots to the right of the filter that you want to disable, and then choose Disable. To enable a filter that was disabled, choose Enable.
1.4.6 Using Formulas
You can see information on all the available functions directly in the Add calculated field dialog when you click a function in the list.
1.4.6.1 Adding Calculated Fields to Analyses
- Click , the Dashboards tab.
- Click Dashboard Designer, in the bottom-left corner.
- On the Analyses dialog, click , the Options button, next to an analysis and select Edit.
- On the analysis page, click , the Datasets button, on the toolbar to display the Data panel.
- In the Data panel, click the + CALCULATED FIELD button.
- In the Add calculated field dialog, create a calculation using the available data fields, parameters, operators,
and functions.
- To add a function, expand the Functions section and double-click the function that you want to use.The available functions are grouped into categories: All, Aggregate, Conditional, Date, Numeric, String, and Table Calculation. You can click a function in the list to see the function description and the required syntax.
- To add a data field, expand the Fields section and double-click the field that you want to include in the formula.
- To add an operator, enter a supported operator directly in the editor.You can also use arithmetic operators to add, subtract, multiply, or divide the values in the data fields without selecting a function. For example, the formula
{Printed Pages}*{Printed Copies}multiplies the number of printed pages by the number of printed copies. - To add the current value of a parameter, expand the Parameters section and double-click one of the available parameters.Parameters without a default value cannot be included in calculated fields.
Make sure that you enter all the required parts of the formula according to the function syntax or the sequence of operations. For more information on the supported operators and functions, see Supported Operators and Functions.To specify the level of granularity for calculations, you can use level-aware calculations (LAC). For more information, see Level-Aware Calculations.
- To add a function, expand the Functions section and double-click the function that you want to use.
- Enter a name for the calculated field at the top of the dialog.
- Click Save.If there are errors in your formula, the editor displays an error message. Check the formula for a red line, and then hover your cursor over the line to see the error message. Common errors include missing punctuation, missing parameters, misspellings, and invalid data types.
The calculated field that you created is added to the list of fields available in
the Data panel. An icon with an equal sign (
) is displayed next to calculated fields.
To edit or delete a calculated field, click , the Options button, next to the field and select Edit calculated field or Remove calculated field.
1.4.6.2 Supported Operators and Functions
1.4.6.2.1 Supported Operators
You can use these operators in calculated fields:
- Addition (+)
- Subtraction (−)
- Multiplication (*)
- Division (/)
- Modulo (%)
- Power (^)
- Equal (=)
- Not equal (<>)
- Greater than (>)
- Greater than or equal to (>=)
- Less than (<)
- Less than or equal to (<=)
- AND
- OR
- NOT
=) and Not equal (<>) comparisons are case-sensitive.You can apply these mathematical functions to an expression:
Mod(number, divisor)– Finds the remainder after dividing a number by a divisor.Log(expression)– Returns the base 10 logarithm of a given expression.Ln(expression)– Returns the natural logarithm of a given expression.Abs(expression)– Returns the absolute value of a given expression.Sqrt(expression)– Returns the square root of a given expression.Exp(expression)– Returns the base of the natural logarithm (e) raised to the power of a given expression.
To make lengthy calculations easier to read, you can use parentheses to clarify groupings and precedence in calculations. In the following statement, you do not need parentheses. The multiplication statement is processed first, and then the result is added to five, returning a value of 26. However, parentheses make the statement easier to read and maintain.
5 + (7 * 3)
Because parentheses are first in the order of operations, you can also use them to change the order in which operators are applied. For example, in the following statement, the addition is processed first, and then the result is multiplied by 3, returning a value of 36.
(5 + 7) * 3
Examples of Using Operators
- Multiple arithmetic operators
- This example uses multiple arithmetic operators to subtract the number of black-and-white
and single-color copier clicks from the total number of copier clicks:
{All Copier Clicks} - ({Black & White Copier Clicks} + {Single-Color Copier Clicks}) - (/) Division
- The following example uses division to divide 3 by 2. A value of 1.5 is returned.
RICOH Supervisor uses floating point divisions.
3/2
- (=) Equal
- The Equal symbol (
=) lets you perform a case-sensitive comparison of values. Rows where the comparison isTRUEare included in the result set.In the following example, the rows where the Location field is South are included in the results. The rows where the Location is south are excluded.
{Location Name} = 'South' - (<>) Not equal
- The Not equal symbol (
<>) checks if a field has any value other than a specified value.For example,
x<>1checks if x is any value other than 1.Note: Always use<>, not!=.This example returns the rows where the number of printed copies is not equal to 10:
{Printed Copies} <> 10 - (^) Power
- You can use the power symbol
^with any numeric field, with any valid exponent.The following example is a simple expression of 2 to the power of 4. It returns a value of 16.
2^4
- AND, OR, and NOT
- The following example uses
AND,OR, andNOTto compare multiple expressions. It uses conditional operators to find printers that are not in the North or South locations and that printed more than 1000 pages. When no results are returned, the valuen/ais used.ifelse(( (NOT ({Location Name} = 'North' OR {Location Name} = 'South')) AND {Printed Pages} > 1000), {Printer Name}, 'n/a') - Comparison lists (in or not in)
-
This example returns rows where x is in the list (1, 2, 3):
x = 1 OR x = 2 OR x = 3
This example returns rows where x is not in the list (1, 2, 3):
NOT(x = 1 OR x = 2 OR x = 3 )
- Between comparison
- The following example returns rows where the job end time is between the first day
and last day of 2023. To include the first and last day,
or equal tois used for the comparison operators.{Job End Time} >= "1/1/2023" AND {Job End Time} <= "12/31/2023"
1.4.6.2.2 Supported Functions
Aggregate Functions
Aggregate functions return values grouped by the chosen dimension or dimensions. For each aggregation, there is also a conditional aggregation that performs the same type of aggregation based on a condition.
avgaverages the set of numbers in the specified measure, grouped by the chosen dimension or dimensions.avgIfcalculates the average based on a conditional statement.countcalculates the number of values in a dimension or measure, grouped by the chosen dimension or dimensions.countIfcalculates the count based on a conditional statement.distinct_countcalculates the number of distinct values in a dimension or measure, grouped by the chosen dimension or dimensions.distinct_countIfcalculates the distinct count based on a conditional statement.maxreturns the maximum value of the specified measure, grouped by the chosen dimension or dimensions.maxIfcalculates the maximum based on a conditional statement.medianreturns the median value of the specified measure, grouped by the chosen dimension or dimensions.medianIfcalculates the median based on a conditional statement.minreturns the minimum value of the specified measure, grouped by the chosen dimension or dimensions.minIfcalculates the minimum based on a conditional statement.percentile(alias ofpercentileDisc) computes the nth percentile of the specified measure, grouped by the chosen dimension or dimensions.percentileContcalculates the nth percentile based on a continuous distribution of the numbers of the specified measure, grouped by the chosen dimension or dimensions.percentileDisc(percentile) calculates the nth percentile based on the actual numbers of the specified measure, grouped by the chosen dimension or dimensions.periodToDateAvgaverages the set of numbers in the specified measure for a given time granularity, such as a quarter, up to a point in time.periodToDateCountcalculates the number of values in a dimension or measure for a given time granularity, such as a quarter, up to a point in time including duplicates.periodToDateMaxreturns the maximum value of the specified measure for a given time granularity, such as a quarter, up to a point in time.periodToDateMedianreturns the median value of the specified measure for a given time granularity, such as a quarter, up to a point in time.periodToDateMinreturns the minimum value of the specified measure or date for a given time granularity, such as a quarter, up to a point in time.periodToDatePercentilecalculates the percentile based on the actual numbers in the specified measure for a given time granularity, such as a quarter, up to a point in time.periodToDatePercentileContcalculates the percentile based on a continuous distribution of the numbers in the specified measure for a given time granularity, such as a quarter, up to a point in time.periodToDateStDevcalculates the standard deviation of the set of numbers in the specified measure for a given time granularity, such as a quarter, up to a point in time based on a sample.periodToDateStDevPcalculates the population standard deviation of the set of numbers in the specified measure for a given time granularity, such as a quarter, up to a point in time based on a sample.periodToDateSumadds the set of numbers in the specified measure for a given time granularity, such as a quarter, up to a point in time.periodToDateVarcalculates the sample variance of the set of numbers in the specified measure for a given time granularity, such as a quarter, up to a point in time.periodToDateVarPcalculates the population variance of the set of numbers in the specified measure for a given time granularity, such as a quarter, up to a point in time.stdevcalculates the standard deviation of the set of numbers in the specified measure, grouped by the chosen dimension or dimensions, based on a sample.stdevIfcalculates the sample standard deviation based on a conditional statement.stdevpcalculates the standard deviation of the set of numbers in the specified measure, grouped by the chosen dimension or dimensions, based on a biased population.stdevpIfcalculates the population deviation based on a conditional statement.sumadds the set of numbers in the specified measure, grouped by the chosen dimension or dimensions.sumIfcalculates the sum based on a conditional statement.varcalculates the variance of the set of numbers in the specified measure, grouped by the chosen dimension or dimensions, based on a sample.varIfcalculates the sample variance based on a conditional statement.varpcalculates the variance of the set of numbers in the specified measure, grouped by the chosen dimension or dimensions, based on a biased population.varpIfcalculates the population variance based on a conditional statement.
When a calculated field formula contains an aggregation, it becomes a custom aggregation. To make sure that the data is displayed accurately, these rules apply to custom aggregations:
- Custom aggregations cannot contain nested aggregate functions, as in the formula
sum(avg(x)/avg(y)). However, you can nest nonaggregated functions inside or outside aggregate functions, as in the formulasceil(avg(x))oravg(ceil(x)). - Custom aggregations cannot contain both aggregated and nonaggregated fields, in any combination.
- Filter groups cannot contain both aggregated and nonaggregated fields.
- You cannot convert custom aggregations to a dimension or add them to a field well as a dimension.
- In pivot tables, you cannot add custom aggregations to table calculations.
- Scatter plots with custom aggregations must have at least one dimension in the Group/Color field well.
Conditional Functions
coalescereturns the value of the first argument that is not null.ifelseevaluates a set ofif, thenexpression pairings, and returns the value of thethenargument for the firstifargument that evaluates to TRUE.inevaluates an expression to see if it is in a given list of values.isNotNullevaluates an expression to see if it is not null.isNullevaluates an expression to see if it is null. If the expression is null, the function returns TRUE, and otherwise it returns false.notInevaluates an expression to see if it is not in a given list of values.nullIfcompares two expressions. If they are equal, the function returns null. If they are not equal, the function returns the first expression.switchreturns an expression that matches the first label equal to the condition expression.
Date Functions
addDateTimeadds or subtracts a unit of time from the date or time provided.addWorkDaysadds or subtracts the given number of work days from the date or time provided.dateDiffreturns the difference in days between two date fields.epochDateconverts an epoch date into a standard date.extractreturns a specified portion of a date value.formatDateformats a date using a pattern that you specify.isWorkDayreturns TRUE if a given date-time value is a work or business day.netWorkDaysreturns the number of working days between the provided two date values.nowreturns the current date and time.truncDatereturns a date value that represents a specified portion of a date.
Numeric Functions
ceilrounds a decimal value to the next highest integer.decimalToIntconverts a decimal value to an integer.floordecrements a decimal value to the next lowest integer.intToDecimalconverts an integer value to a decimal.roundrounds a decimal value to the closest integer or, if scale is specified, to the closest decimal place.
Mathematical Functions
mod(number, divisor)finds the remainder after dividing a number by a divisor.log(expression)returns the base 10 logarithm of a given expression.ln(expression)returns the natural logarithm of a given expression.abs(expression)returns the absolute value of a given expression.sqrt(expression)returns the square root of a given expression.exp(expression)returns the base of the natural logarithm (e) raised to the power of a given expression.
String Functions
concatconcatenates two or more strings.containschecks if an expression contains a substring.endsWithchecks if the expression ends with the substring specified.leftreturns the specified number of leftmost characters from a string.locatelocates a substring within another string, and returns the number of characters before the substring.ltrimremoves the preceding blank space from a string.parseDateparses a string to determine if it contains a date value and returns the date if it finds it.parseDecimalparses a string to determine if it contains a decimal value.parseIntparses a string to determine if it contains an integer value.replacereplaces part of a string with a new string.rightreturns the specified number of rightmost characters from a string.rtrimremoves the following blank space from a string.splitsplits a string into an array of substrings, based on a delimiter that you choose, and returns the item specified by the position.startsWithchecks if the expression starts with the substring specified.strlenreturns the number of characters in a string.substringreturns the specified number of characters in a string, starting at the specified location.toStringformats the input expression as a string.trimremoves both the preceding and following blank space from a string.
1.4.6.2.2.1 Supported Table Calculations
Lookup-Based Functions
Differencecalculates the difference between a measure based on one set of partitions and sorts, and a measure based on another.Lagcalculates the lag (previous) value for a measure.Leadcalculates the lead (following) value for a measure.percentDifferencecalculates the percentage difference between the current value and a comparison value.
Over Functions
avgOvercalculates the average of a measure over one or more dimensions.countOvercalculates the count of a field over one or more dimensions.distinctCountOvercalculates the distinct count of the operand partitioned by the specified attributes at a specified level.maxOvercalculates the maximum of a measure over one or more dimensions.minOvercalculates the minimum of a measure over one or more dimensions.percentileOvercalculates the nth percentile of a measure partitioned by a list of dimensions.percentileContOvercalculates the nth percentile based on a continuous distribution of the numbers of a measure partitioned by a list of dimensions.percentileDiscOvercalculates the nth percentile based on the actual numbers of a measure partitioned by a list of dimensions.percentOfTotalcalculates the percentage that a measure contributes to the total.periodOverPeriodDifferencecalculates the difference of a measure over two different time periods as specified by period granularity and offset.periodOverPeriodLastValuecalculates the last (previous) value of a measure from a previous time period as specified by period granularity and offset.periodOverPeriodPercentDifferencecalculates the percent difference of a measure over two different time periods as specified by period granularity and offset.periodToDateAvgOverTimecalculates the average of a measure for a given time granularity, such as a quarter, up to a point in time.periodToDateCountOverTimecalculates the count of a dimension or measure for a given time granularity, such as a quarter, up to a point in time.periodToDateMaxOverTimecalculates the maximum of a measure or date for a given time granularity, such as a quarter, up to a point in time.periodToDateMinOverTimecalculates the minimum of a measure or date for a given time granularity, such as a quarter, up to a point in time.periodToDateSumOverTimecalculates the sum of a measure for a given time granularity, such as a quarter, up to a point in time.sumOvercalculates the sum of a measure over one or more dimensions.stdevOvercalculates the standard deviation of the specified measure, partitioned by the specified attribute or attributes, based on a sample.stdevpOvercalculates the standard deviation of the specified measure, partitioned by the chosen attribute or attributes, based on a biased population.varOvercalculates the variance of the specified measure, partitioned by the chosen attribute or attributes, based on a sample.varpOvercalculates the variance of the specified measure, partitioned by the chosen attribute or attributes, based on a biased population.
Ranking Functions
Rankcalculates the rank of a measure or a dimension.denseRankcalculates the rank of a measure or a dimension, ignoring duplicates.percentileRankcalculates the rank of a measure or a dimension, based on percentile.
Running Functions
runningAvgcalculates a running average for a measure.runningCountcalculates a running count for a measure.runningMaxcalculates a running maximum for a measure.runningMincalculates a running minimum for a measure.runningSumcalculates a running sum for a measure.
Window Functions
firstValuecalculates the first value of the aggregated measure or dimension partitioned and sorted by specified attributes.lastValuecalculates the last value of the aggregated measure or dimension partitioned and sorted by specified attributes.windowAvgcalculates the average of the aggregated measure in a custom window that is partitioned and sorted by specified attributes.windowCountcalculates the count of the aggregated measure in a custom window that is partitioned and sorted by specified attributes.windowMaxcalculates the maximum of the aggregated measure in a custom window that is partitioned and sorted by specified attributes.windowMincalculates the minimum of the aggregated measure in a custom window that is partitioned and sorted by specified attributes.windowSumcalculates the sum of the aggregated measure in a custom window that is partitioned and sorted by specified attributes.
1.4.6.3 Order of Evaluation in Analyses
This list shows the order of evaluation for analyses:
- Level-aware calculation - window (LAC-W) Prefilter level: Evaluates the data at the original table cardinality before analysis filters.
- Simple calculations: Calculations at scalar level without any aggregations or window calculations are
applied. For example,
date_metric/60, parseDate(date, 'yyyy/MM/dd'), ifelse(metric > 0, metric, 0), split(string_column, '|' 0). - LAC-W function PRE_FILTER: If any
LAC-W PRE_FILTERexpression is used in the visual, RICOH Supervisor first computes the window function at the original table level, before any filters. If theLAC-W PRE_FILTERexpression is used in filters, it is applied at this point. For example,maxOver({Printed Pages}, [{Location Name}, {Printer Name}], PRE_FILTER) > 1000.
- Simple calculations: Calculations at scalar level without any aggregations or window calculations are
applied. For example,
- LAC-W Preaggregate level: Evaluates the data at the original table cardinality before aggregations.
- Filters added during analysis: Filters created for unaggregated fields in the visuals are applied at this point,
similar to
WHEREclauses. For example,year > 2020. - LAC-W function PRE_AGG: If any
LAC-W PRE_AGGexpression is used in the visual, RICOH Supervisor computes the window function before any aggregation applied. If theLAC-W PRE_AGGexpression is used in filters, it is applied at this point. For example,maxOver({Printed Pages}, [{Location Name}, {Printer Name}], PRE_AGG) > 1000. - Top/bottom N filters: Filters that are configured on dimensions to display top/bottom N items are applied.
- Filters added during analysis: Filters created for unaggregated fields in the visuals are applied at this point,
similar to
- Level-aware calculation - aggregate (LAC-A) level: Evaluates aggregations at a customized level, before visual aggregations.
- Custom-level aggregations: If any
LAC-Aexpression is used in the visual, it is calculated at this point. RICOH Supervisor computes the aggregation, grouped by the dimensions that are specified in the calculated fields. For example,max({Printed Pages}, [{Location Name}]).
- Custom-level aggregations: If any
- Visual level: Evaluates aggregations at visual level and post-aggregation table calculations, with
the remaining configurations applied in the visuals.
- Visual-level aggregations: Aggregations based on the fields in the field wells are calculated, grouped by the
dimensions from the visuals. If any filter is built on top of the aggregations, it
is applied at this point, similar to
HAVINGclauses. For example,min({Printed Pages}) > 1000. - Table calculations: If there is any post-aggregation table calculation used in the visual, it is calculated at this point. RICOH Supervisor performs window calculations after visual aggregations. Similarly, filters built on post-aggregation table calculations are applied.
- Other category calculations: Calculations for the Other category in line charts, bar charts, combo charts, funnel charts, tree maps, pie charts, or donut charts are applied.
- Totals and subtotals: Totals and subtotals are calculated in donut charts, tables, or pivot tables.
- Visual-level aggregations: Aggregations based on the fields in the field wells are calculated, grouped by the
dimensions from the visuals. If any filter is built on top of the aggregations, it
is applied at this point, similar to
1.4.6.4 Level-Aware Calculations
Level-Aware Calculation - Aggregate (LAC-A) Functions
With LAC-A functions, you can specify at what level to group the computation. By adding
an argument into an existing aggregate function, such as sum, max, or count, you can define a group-by level for the aggregation. The added level can be any
dimension independent of the dimensions added to the visual. For example: sum(measure,[group_field_A]).
To use LAC-A functions, enter them directly in the editor, adding the aggregation levels as the second argument, between brackets. This example shows an aggregate function and a LAC-A function, for comparison:
- Aggregate function:
sum({Printed Pages}) - LAC-A function:
sum({Printed Pages}, [{Location Name},{Printer Name}])
You can also create a dynamic LAC group key that adapts to the group-by fields from
the visual by using the $visualDimensions parameter. The $visualDimensions parameter represents the fields added to the Group by field well in the current visual. These examples show how to dynamically add group
keys to the visual dimensions or remove group keys from the visual dimensions:
- LAC-A with dynamic-added group key:
sum({Printed Pages}, [${visualDimensions},{Location Name},{Printer Name}])This function calculates, before the visual-level aggregation is calculated, the sum of printed pages, grouping by location, printer, and any other fields in the Group by field well.
- LAC-A with dynamic-removed group key:
sum({Printed Pages}, [${visualDimensions},!{Location Name},!{Printer Name}])This function calculates, before the visual-level aggregation is calculated, the sum of printed pages, grouping by the fields in the Group by field well, except location and printer.
LAC-A functions are supported for these aggregate functions: avg, count, distinct_count, max, median, min, percentile, percentileCont, percentileDisc, stdev, stdevp, sum, var, and varp.
LAC-A Examples
You can use LAC-A functions for these types of use cases:
- Run calculations that are independent of the levels in the visual. For example, if
you use the following calculation, the printed pages are aggregated only at the location
level, but not across other dimensions in the visual.
sum({Printed Pages},[{Location Name}]) - Run calculations for dimensions that are not included in the visual. For example,
if you use the following function, you can calculate the average number of printed
pages by location, even if the Location Name field is not included in the visual.
avg(sum({Printed Pages},[{Location Name}])) - Use LAC-A combined with other aggregate functions and LAC-W functions. There are two
ways that you can nest LAC-A functions with other functions.
- You can write a nested syntax when you create a calculation. For example, the LAC-A
function can be nested with a LAC-W function:
sum(avgOver({Printed Copies},[{Printer Name}],PRE_AGG),[{Location Name}]) - When you add a LAC-A function into a visual, the calculation can be combined with visual-level aggregate functions that you set in the field wells. For more information about changing the aggregation of fields in the visual, see Changing Field Aggregation.
- You can write a nested syntax when you create a calculation. For example, the LAC-A
function can be nested with a LAC-W function:
LAC-A Limitations
These limitations apply to LAC-A functions:
- LAC-A functions are supported for all additive and non-additive aggregate functions,
such as
sum,count, andpercentile. LAC-A functions are not supported for conditional aggregate functions that end withif, such assumifandcountif, or for period aggregate functions that start withperiodToDate, such asperiodToDateSumandperiodToDateMax. - Row-level and column-level totals are not currently supported for LAC-A functions in tables and pivot tables. When you add row-level or column-level totals to the chart, the total number shows as blank. Other non-LAC dimensions are not affected.
- Nested LAC-A functions are not currently supported. A limited capability of LAC-A
functions nested with regular aggregate functions and LAC-W functions are supported.
For example, these functions are valid:
Aggregation(LAC-A()). For example:max(sum({Printed Pages}, [{Location Name}]))LAC-A(LAC-W()). For example:sum(sumOver({Printed Pages},[{Printer Name}],PRE_AGG), [{Location Name}])
These functions are not valid:
LAC-A(Aggregation()). For example:sum(max({Printed Pages}), [{Location Name}])LAC-A(LAC-A()). For example:sum(max({Printed Pages}, [{Location Name}]),[{Printer Type}])LAC-W(LAC-A()). For example:sumOver(sum({Printed Pages},[{Printer Name}]),[{Location Name}],PRE_AGG)
Level-Aware Calculation - Window (LAC-W) Functions
With LAC-W functions, you can specify the window or partition for computing the calculation.
LAC-W functions are a group of window functions, such as sumOver, maxOver, or denseRank, that you can run at the prefilter or preaggregate level. For example: sumOver(measure,[partition_field_A],pre_agg).
LAC-W functions can help you answer these types of questions:
- How many of the printers processed a number of jobs under a certain value? The count is used as a dimension rather than a metric in the visual.
- How much is the contribution of each printer to the total printer throughput?
- How are my printers grouped into cumulative throughput ranges? The grouping is used as a dimension rather than a metric.
For more complex questions, you can inject a calculation or filter before RICOH Supervisor gets to a specific point in the evaluation of your settings. To directly influence the results, you add a calculation level keyword to a table calculation. For more information on how queries are evaluated, see Order of Evaluation in Analyses.
These calculation levels are supported for LAC-W functions:
PRE_FILTER– Before applying the filters from the analysis, RICOH Supervisor evaluates prefilter calculations. Then it applies any configured filters on the prefilter calculations.PRE_AGG– Before computing visual-level aggregations, RICOH Supervisor performs preaggregate calculations. Then it applies any configured filters on the preaggregate calculations. These operations happen before applying top and bottom N filters.
You can use the PRE_FILTER or PRE_AGG keyword as a parameter in these table calculation functions: avgOver, countOver, denseRank, distinctCountOver, minOver, maxOver, percentileRank, Rank, stdevOver, stdevpOver, sumOver, varOver, and varpOver.
When you specify a calculation level, you use an unaggregated measure in the function.
For example, you can use countOver({Job ID}, [{Printer ID}], PRE_AGG). By using PRE_AGG, you specify that the countOver function executes at the preaggregate level.
By default, the first parameter for each function must be an aggregated measure. If
you use either PRE_FILTER or PRE_AGG, you use a nonaggregated measure for the first parameter.
For LAC-W functions, the visual aggregation defaults to MIN to eliminate duplicates. To change the aggregation, click , the Options button, next to the field, then select Aggregate and one of the available aggregate functions.
1.4.7 Data Fields
You can interact with the available data fields from various places across the application. For example, you can see the list of data fields in the Data panel when you create visuals for your analyses. You also interact with the data fields when you filter and sort data or drill down into visuals.
There are two main types of data fields: dimension fields and measure fields.
- Dimension or category fields
- Descriptive fields with alphanumeric strings that you can use to label and categorize
data, such as printer names, printer types, and job states.
- Date fields with dates and time intervals. You can use date fields to organize your
data into hierarchies according to year, quarter, and month or into units of time
such as hours or minutes.
- Measure fields
- Numeric fields with quantified data that you can aggregate or calculate, such as
number of impressions, number of copies, and event duration.
1.4.7.1 Data Fields from RICOH Supervisor Data Collector
- Important:
- To retrieve data from your printers, you must first add the printers in RICOH Supervisor Data Collector. Make sure that you configure all the settings correctly according to the printer type and that the data collector can communicate with the printers and retrieve data. For more information, see the RICOH Supervisor Data Collector documentation.
- All the time-related data is displayed in the printer time zone set in RICOH Supervisor Data Collector.
These data fields are available from RICOH Supervisor Data Collector:
| Field Name | Description |
|---|---|
| Account section | |
| Account ID | The unique identifier assigned to the account in RICOH Account Administration. |
| Account Name | The account name configured in RICOH Account Administration. |
| Data Collector | The name of the data collector as it is configured in RICOH Supervisor Data Collector. |
| Job section | |
| Job Duration (ms) |
The amount of time required for printing the job in milliseconds. On cut sheet printers, the job duration includes the time the printer was in an error state while printing the job. On continuous form printers, the job always goes to the printed or aborted state when a printer error occurs. When the error is resolved and printing resumes, RICOH Supervisor Data Collector creates a new job with the same name but with a different job ID. The job duration is tracked separately for each job ID and the time the printer was in an error state is not included. |
| Job End Time |
The time when the job finished printing in the printer time zone set in RICOH Supervisor Data Collector. We recommend using the Job Start Time and Job End Time data fields only for information about the job. To view data based on time intervals, use the fields available in the Date section. |
| Job ID |
The unique identifier assigned to the job. Job IDs are useful for distinguishing and tracking each individual job. For example, you can use the Job ID field if you want to count the number of jobs that were printed during a time period. If you use the Job Name field instead, jobs with the same name are counted only once. |
| Job Name | The name of the job. |
| Job Printing Side |
The printing side setting: 1-sided or 2-sided. For continuous form printers, the printing side information is retrieved based on the current printer configuration and not on the job settings. Make sure that you restart the printer every time you change the printer configuration. On printers with multiple engines, if engine 2 or 3 is disabled, RICOH Supervisor Data Collector cannot identify the printer configuration accurately. As a result, when you print a 1-sided job, the printing side is reported as 2-sided. The printing side information is not available for TotalFlow Print Server cut sheet printers. |
| Job Start Time |
The time when the job started printing in the printer time zone set in RICOH Supervisor Data Collector. We recommend using the Job Start Time and Job End Time data fields only for information about the job. To view data based on time intervals, use the fields available in the Date section. |
| Job State | The state of the job: aborted, printed, or printing. |
| Printed Copies |
The number of printed copies. For aborted jobs on InfoPrint 5000, and InfoPrint 4100 continuous form printers, the number of printed copies is always estimated assuming that all jobs are 2-up. As a result, the estimation is incorrect if the job has other n-up settings. On continuous form printers, the job always goes to the aborted or printed state when a printer error occurs. When the error is resolved and printing resumes, RICOH Supervisor Data Collector creates a new job with the same name but with a different job ID. The number of printed copies is reported as follows:
|
| Printed Impressions |
The number of printed impressions.
If a job contains inserts, the inserts are not taken into account for the number of printed impressions. For aborted jobs on InfoPrint 5000, and InfoPrint 4100 continuous form printers, the number of printed impressions is always estimated assuming that all jobs are 2-up. As a result, the estimation is incorrect if the job has other n-up settings. On continuous form printers, the job always goes to the aborted or printed state when a printer error occurs. When the error is resolved and printing resumes, RICOH Supervisor Data Collector creates a new job with the same name but with a different job ID. The number of printed impressions is reported as follows:
|
| Printed Pages |
The number of printed pages.
If a job contains inserts, the inserts are not taken into account for the number of printed pages. For aborted jobs on InfoPrint 5000, and InfoPrint 4100 continuous form printers, the number of printed pages is always estimated assuming that all jobs are 2-up. As a result, the estimation is incorrect if the job has other n-up settings. On continuous form printers, the job always goes to the aborted or printed state when a printer error occurs. When the error is resolved and printing resumes, RICOH Supervisor Data Collector creates a new job with the same name but with a different job ID. The number of printed pages is reported as follows:
|
| Printed Paper Length (Feet) |
The length of paper printed by continuous form printers, measured in feet. In visuals, the Printed Paper Length (Feet) and Printed Paper Length (Meters) data fields are switched automatically based on the Length unit option specified under . The paper length data might not always be exact due to printer communication delays. Sometimes, there might be a difference of a few feet between the reported data and the actual length of printed paper. On continuous form printers, the job always goes to the aborted or printed state when a printer error occurs. When the error is resolved and printing resumes, RICOH Supervisor Data Collector creates a new job with the same name but with a different job ID. The printed paper length is tracked and reported separately for each job ID. |
| Printed Paper Length (Meters) |
The length of paper printed by continuous form printers, measured in meters. In visuals, the Printed Paper Length (Feet) and Printed Paper Length (Meters) data fields are switched automatically based on the Length unit option specified under . The paper length data might not always be exact due to printer communication delays. Sometimes, there might be a difference of a few feet between the reported data and the actual length of printed paper. On continuous form printers, the job always goes to the aborted or printed state when a printer error occurs. When the error is resolved and printing resumes, RICOH Supervisor Data Collector creates a new job with the same name but with a different job ID. The printed paper length is tracked and reported separately for each job ID. |
| Printed Sheets |
The number of printed sheets.
If a job contains inserts, the inserts are not taken into account for the number of printed sheets. For aborted jobs on continuous form printers, the number of printed sheets is always estimated assuming that all jobs are 2-up. As a result, the estimation is incorrect if the job has other n-up settings. On continuous form printers, the job always goes to the aborted or printed state when a printer error occurs. When the error is resolved and printing resumes, RICOH Supervisor Data Collector creates a new job with the same name but with a different job ID. The number of printed sheets is reported as follows:
|
| Job Ink Usage section | |
| Job Ink Usage - Color Continuous Form | |
| Engine 1 C Ink Usage (Cc) |
The amount of cyan ink used on engine 1, measured in cubic centimeters. This data field applies to both InfoPrint 5000 color printers and RICOH Pro VC printers. |
| Engine 1 Flushing C Ink Usage (Cc) - RICOH Pro VC |
The amount of cyan ink used on engine 1 for flushing the printhead, measured in cubic centimeters. This data field only applies to RICOH Pro VC printers. |
| Engine 1 Flushing K Ink Usage (Cc) - RICOH Pro VC |
The amount of black ink used on engine 1 for flushing the printhead, measured in cubic centimeters. This data field only applies to RICOH Pro VC printers. |
| Engine 1 Flushing M Ink Usage (Cc) - RICOH Pro VC |
The amount of magenta ink used on engine 1 for flushing the printhead, measured in cubic centimeters. This data field only applies to RICOH Pro VC printers. |
| Engine 1 Flushing Y Ink Usage (Cc) - RICOH Pro VC |
The amount of yellow ink used on engine 1 for flushing the printhead, measured in cubic centimeters. This data field only applies to RICOH Pro VC printers. |
| Engine 1 K Ink Usage (Cc) |
The amount of black ink used on engine 1, measured in cubic centimeters. This data field applies to both InfoPrint 5000 color printers and RICOH Pro VC printers. |
| Engine 1 M Ink Usage (Cc) |
The amount of magenta ink used on engine 1, measured in cubic centimeters. This data field applies to both InfoPrint 5000 color printers and RICOH Pro VC printers. |
| Engine 1 Y Ink Usage (Cc) |
The amount of yellow ink used on engine 1, measured in cubic centimeters. This data field applies to both InfoPrint 5000 color printers and RICOH Pro VC printers. |
| Engine 2 C Ink Usage (Cc) |
The amount of cyan ink used on engine 2, measured in cubic centimeters. This data field applies to both InfoPrint 5000 color printers and RICOH Pro VC printers. |
| Engine 2 Flushing C Ink Usage (Cc) - RICOH Pro VC |
The amount of cyan ink used on engine 2 for flushing the printhead, measured in cubic centimeters. This data field only applies to RICOH Pro VC printers. |
| Engine 2 Flushing K Ink Usage (Cc) - RICOH Pro VC |
The amount of black ink used on engine 2 for flushing the printhead, measured in cubic centimeters. This data field only applies to RICOH Pro VC printers. |
| Engine 2 Flushing M Ink Usage (Cc) - RICOH Pro VC |
The amount of magenta ink used on engine 2 for flushing the printhead, measured in cubic centimeters. This data field only applies to RICOH Pro VC printers. |
| Engine 2 Flushing Y Ink Usage (Cc) - RICOH Pro VC |
The amount of yellow ink used on engine 2 for flushing the printhead, measured in cubic centimeters. This data field only applies to RICOH Pro VC printers. |
| Engine 2 K Ink Usage (Cc) |
The amount of black ink used on engine 2, measured in cubic centimeters. This data field applies to both InfoPrint 5000 color printers and RICOH Pro VC printers. |
| Engine 2 M Ink Usage (Cc) |
The amount of magenta ink used on engine 2, measured in cubic centimeters. This data field applies to both InfoPrint 5000 color printers and RICOH Pro VC printers. |
| Engine 2 Y Ink Usage (Cc) |
The amount of yellow ink used on engine 2, measured in cubic centimeters. This data field applies to both InfoPrint 5000 color printers and RICOH Pro VC printers. |
| Engine 3 K1 Ink Usage (Cc) - InfoPrint 5000 |
The amount of K1 ink used on engine 3, measured in cubic centimeters. The K1 and K2 ink data for engine 3 usually refers to MICR (magnetic ink character recognition) ink. This data field only applies to InfoPrint 5000 color printers. |
| Engine 3 K2 Ink Usage (Cc) - InfoPrint 5000 |
The amount of K2 ink used on engine 3, measured in cubic centimeters. The K1 and K2 ink data for engine 3 usually refers to MICR (magnetic ink character recognition) ink. This data field only applies to InfoPrint 5000 color printers. |
| Overall C Ink Usage (Cc) |
The total amount of cyan ink used, measured in cubic centimeters. The ink data included in this field depends on the printer:
|
| Overall K Ink Usage (Cc) |
The total amount of black ink used, measured in cubic centimeters. The ink data included in this field depends on the printer:
|
| Overall K1 Ink Usage (Cc) - InfoPrint 5000 |
The total amount of K1 ink used on engine 3, measured in cubic centimeters. The K1 and K2 ink data for engine 3 usually refers to MICR (magnetic ink character recognition) ink. This data field only applies to InfoPrint 5000 color printers. |
| Overall K2 Ink Usage (Cc) - InfoPrint 5000 |
The total amount of K2 ink used on engine 3, measured in cubic centimeters. The K1 and K2 ink data for engine 3 usually refers to MICR (magnetic ink character recognition) ink. This data field only applies to InfoPrint 5000 color printers. |
| Overall M Ink Usage (Cc) |
The total amount of magenta ink used, measured in cubic centimeters. The ink data included in this field depends on the printer:
|
| Overall Y Ink Usage (Cc) |
The total amount of yellow ink used, measured in cubic centimeters. The ink data included in this field depends on the printer:
|
| Job Ink Usage - InfoPrint 5000 Black & White | |
| Engine 1 K1 Ink Usage (Cc) | The amount of K1 ink used on engine 1, measured in cubic centimeters. |
| Engine 1 K2 Ink Usage (Cc) | The amount of K2 ink used on engine 1, measured in cubic centimeters. |
| Engine 2 K1 Ink Usage (Cc) | The amount of K1 ink used on engine 2, measured in cubic centimeters. |
| Engine 2 K2 Ink Usage (Cc) | The amount of K2 ink used on engine 2, measured in cubic centimeters. |
| Overall K1 Ink Usage (Cc) | The total amount of K1 ink used on both engines, measured in cubic centimeters. |
| Overall K2 Ink Usage (Cc) | The total amount of K2 ink used on both engines, measured in cubic centimeters. |
| Job Ink Usage - All Printers | |
| MICR Ink Usage (Cc) |
The total amount of MICR (magnetic ink character recognition) ink used, measured in cubic centimeters. The ink data included in this field depends on the printer:
|
| Overall K Ink Usage (Cc) |
The total amount of black ink used, measured in cubic centimeters. The ink data included in this field depends on the printer:
|
| Print Speed (M/min) | The print speed in meters per minute. |
|
|
| Location section | |
| Location Name |
The name of the location. To view data per location, you must first group your printers by location in the Locations panel on the Settings tab. Only the printers that are currently registered in RICOH Supervisor Data Collector can be associated with a location. A location is displayed in visuals and filters only if it contains at least one printer and if data is available from the printers assigned to the location. If the location is associated with a shift, data must be available for the time interval covered by the shift. |
| Operator - Continuous Form section | |
| Logged Activity Type |
The type of operator activity, such as logging in, logging out, clearing errors, cleaning the printer, or aligning forms. The log-in and log-out activities are generated automatically when an operator logs in or logs out. The rest of the activities are retrieved from the printer log. For more information on adding activities to the printer log, see the printer documentation. The operator activity data is collected from the local printer console and the remote console. When the data is collected from the remote console, the activity is associated with the local console user. This data field applies to InfoPrint 4100, InfoPrint 5000, RICOH Pro VC40000, RICOH Pro VC60000, RICOH Pro VC70000, and RICOH Pro VC80000 continuous form printers. |
| Operator Login Duration (ms) |
The amount of time the operator was logged in to the printer, measured in milliseconds. When an operator logs in to the printer, the login duration starts increasing until that operator logs out or a different operator logs in. The login duration data is collected only for operators that are logged on the local printer console. This data field applies to InfoPrint 4100, InfoPrint 5000, RICOH Pro VC40000, RICOH Pro VC60000, RICOH Pro VC70000, and RICOH Pro VC80000 continuous form printers. |
| Operator Name |
The name or user ID of the operator logged in to the printer. This data field applies to InfoPrint 4100, InfoPrint 5000, RICOH Pro VC40000, RICOH Pro VC60000, RICOH Pro VC70000, and RICOH Pro VC80000 continuous form printers. |
| Preset - Continuous Form section | |
| Preset Action Type |
The action performed on the preset: created, loaded, changed, and modified.
This data field applies to InfoPrint 4100, InfoPrint 5000, RICOH Pro VC40000, RICOH Pro VC60000, RICOH Pro VC70000, and RICOH Pro VC80000 continuous form printers. |
| Preset Name |
The name of the printer preset. This data field applies to InfoPrint 4100, InfoPrint 5000, RICOH Pro VC40000, RICOH Pro VC60000, RICOH Pro VC70000, and RICOH Pro VC80000 continuous form printers. |
| Printer section | |
| Printer ID |
The unique identifier assigned to the printer. Printer IDs are useful for distinguishing and tracking each individual printer. For example, you can use the Printer ID field in formulas to calculate the average number of printed jobs per printer. The list of printer IDs includes all the printer IDs that were registered in the system, including the IDs of deleted printers. |
| Printer Model |
The model of the printer. The printer model is received from the printer through RICOH Supervisor Data Collector. You cannot change the printer model, it is populated automatically. |
| Printer Name |
The name of the printer as it is configured in RICOH Supervisor Data Collector. If you rename a printer, make sure that you update all the filters that use the old printer name. The data available for the renamed printer is not affected. The list of printers includes all the printers that were registered in the system, including deleted printers. |
| Printer Type |
The type of the printer: cut sheet, continuous form, or not available. Not available is displayed for printers that had the Not connected status when they were added in RICOH Supervisor Data Collector. |
| Printer Intervention section | |
| Printer Engine |
The printer engine where the printer intervention occurred. You can use this data field to view printer interventions by printer engine. For continuous form printers, the Printer Engine values can be 1, 2, or 3, depending on the printer. For cut sheet printers, the Printer Engine value is Not Available. The Printer Engine data field is only available for printer intervention tracking. |
| Printer Intervention Code | The code of the printer intervention. |
| Printer Intervention Duration (ms) | The duration of the printer intervention in milliseconds. |
| Printer Intervention ID |
The unique identifier assigned to the printer intervention. Printer Intervention IDs are useful for distinguishing and tracking each individual printer intervention. For example, you can use the Printer Intervention ID field if you want to count the number of interventions that occurred during a time period. If you use the Printer Intervention Message or Printer Intervention Code fields instead, each intervention message or intervention code is counted only once even when the same intervention occurred multiple times. |
| Printer Intervention Message | The description of the printer intervention. |
| Printer Intervention Sequence |
The sequence of printer interventions used when the printer sends several intervention codes at the same time: Main Error, Second Error, Third Error, Fourth Error, Fifth Error, Sixth Error, Seventh Error, Eighth Error, or Ninth Error. This data field is important for printer intervention data accuracy when a main intervention
generates a sequence of other interventions. For example, the The printer intervention sequence is also useful when several independent interventions,
such as RICOH Supervisor orders the printer interventions from a set of simultaneous interventions based on this default order:
For example, if the If the Any other printer interventions that are received from the printer but are not included in the default list take precedence over the interventions in the list. You can add the Printer Intervention Sequence field as a filter to obtain accurate results in visuals that display the printer
intervention duration. For example, you can filter the data to include only intervention
codes with the Main Error value and exclude the All the printer intervention data collected with a RICOH Supervisor Data Collector version older than 1.1.0.669 is automatically assigned to the N\A intervention sequence value. Make sure that you include this value in the Printer Intervention Sequence filter if you want to view older data. |
| Printer State section | |
| Printer State | The state of the printer: initializing, feeding, preparing, printing, processing, receiving, not available, not ready, error, restart, pre/post not ready, pre/post busy, pre/post threading, pre/post EOF, pre/post paused, cleaning, adjusting, maintenance, idle, ready, sleeping, shutdown, warming, started, start-up, or unknown. |
| Printer State Category |
The printer state category:
|
| Printer State Duration (ms) | The amount of time the printer was in a specific state, measured in milliseconds. |
| Printer State ID |
The unique identifier assigned to the printer state. State IDs are useful for distinguishing and tracking each individual printer state. For example, you can use the Printer State ID field if you want to count the number of times the printer was in an error state. |
| Printer Throughput - Copiers section | |
| All Copier Clicks | The total number of copier clicks. |
| Black & White Copier Clicks | The number of black-and-white copier clicks. |
| Full-Color Copier Clicks | The number of full-color copier clicks. |
| Single-Color Copier Clicks | The number of single-color copier clicks. |
| Two-Color Copier Clicks | The number of two-color copier clicks. |
|
|
| Printer Throughput - Cut Sheet Printers section | |
| All Printer Clicks |
The total number of printer clicks. The All Printer Clicks value does not include the number of fifth station printer clicks, except for jobs that are printed only with fifth station toner. |
| Black & White Printer Clicks | The number of black-and-white printer clicks. |
| Fifth Station Printer Clicks |
The number of fifth station printer clicks, including clicks for clear toner and other types of special effect toner. The number of fifth station printer clicks is not included in the All Printer Clicks and Lifetime Printer Clicks values, except for jobs that are printed only with fifth station toner. |
| Full-Color Printer Clicks | The number of full-color printer clicks. |
| Lifetime Printer Clicks |
The total number of clicks registered since the first use of the printer. The Lifetime Printer Clicks value does not include the number of fifth station printer clicks, except for jobs that are printed only with fifth station toner. When you add the Lifetime Printer Clicks data field to a visual, use the Also, make sure that you always use the sum(max({Lifetime Printer Clicks}, [{Printer Name}]))
When you view lifetime click data for specific time periods, RICOH Supervisor displays a value only for the time periods in which there was activity on the printer and the lifetime clicks value increased. |
| Single/Two-Color Printer Clicks | The number of single-color and two-color printer clicks. |
|
|
| Printer Throughput - Scanners section | |
| All Scanner Clicks | The total number of scanner clicks. |
| Black & White Scanner Clicks | The number of black-and-white scanner clicks. |
| Color Scanner Clicks | The number of color scanner clicks. |
|
|
| Shift section | |
| Shift Name |
The name of the shift. To view data per shift, you must first record your shifts in the Shifts panel on the Settings tab. Shifts apply only to printers that are currently registered in RICOH Supervisor Data Collector. Data is assigned to a shift based on the printers included in the shift location and the printer time zone set in RICOH Supervisor Data Collector. If a shift does not have a location specified, it applies to all the printers available in the system. All the job data collected in the time interval covered by a shift is assigned to that shift, even if the job started printing or finished printing outside the shift interval. A shift is displayed in visuals and filters only if data is available for the time interval covered by the shift. If the shift is associated with a location, data must be available from the printers assigned to that location. |
| Date section | |
| Date |
Date and time values, useful for filtering data based on specific time intervals. These values are based on the printer time zone set in RICOH Supervisor Data Collector. |
1.4.7.2 Data Fields from Avanti Slingshot
These data fields are available:
| Avanti Slingshot - Activities Fields Name |
|---|
| Activity Contact Name |
| Activity Due Date |
| Activity Employee Code |
| Activity Employee Name |
| Activity End Date |
| Activity Note Text |
| Activity Objective |
| Activity Priority |
| Activity Regarding |
| Activity Regarding Reference |
| Activity Status |
| Activity Subject |
| Activity Type |
| Created Date |
| Cust_id |
| Last Modified Date |
| Avanti Slingshot - Customer Address Fields Name |
|---|
| Created Date |
| Customer Address Address1 |
| Customer Address Address2 |
| Customer Address Address3 |
| Customer Address City |
| Customer Address Code |
| Customer Address Contact Address City |
| Customer Address Contact Address Country Code |
| Customer Address Contact Business Email |
| Customer Address Contact Business Ext |
| Customer Address Contact Business Fax |
| Customer Address Contact Business Phone |
| Customer Address Contact File As |
| Customer Address Contact First and Last |
| Customer Address Contact First Name |
| Customer Address Contact Full Name |
| Customer Address Contact Middle Name |
| Customer Address Contact Mobile Phone |
| Customer Address Contact Home Email |
| Customer Address Contact Home Fax |
| Customer Address Contact Home Phone |
| Customer Address Contact Other Email |
| Customer Address Contact Job Description |
| Customer Address Contact Job Description Type |
| Customer Address Contact Last Name |
| Customer Address Contact Address Name |
| Customer Address Contact Address Country Name |
| Customer Address Contact Address Postal Zip |
| Customer Address Contact Address Stateprov Code |
| Customer Address Contact Address Stateprov Name |
| Customer Address Contact Address1 |
| Customer Address Contact Address2 |
| Customer Address Contact Address3 |
| Customer Address Contact Other Phone |
| Customer Address Contact Suffix |
| Customer Address Contact Title |
| Customer Address Country Code |
| Customer Address Country Name |
| Customer Address Email Address |
| Customer Address Fax |
| Customer Address Fax Ext |
| Customer Address Is Onetime |
| Customer Address Name |
| Customer Address Phone1 |
| Customer Address Phone1 Ext |
| Customer Address Phone2 |
| Customer Address Phone2 Ext |
| Customer Address Phone3 |
| Customer Address Phone3 Ext |
| Customer Address Postal Zip |
| Customer Address Stateprov Code |
| Customer Address Stateprov Name |
| Avanti Slingshot - Customer Contacts Fields Name |
|---|
| Contact Address City |
| Contact Address Country Code |
| Contact Address Country Name |
| Contact Address Name |
| Contact Address Postal Zip |
| Contact Address Stateprov Code |
| Contact Address Stateprov Name |
| Contact Address1 |
| Contact Address2 |
| Contact Address3 |
| Contact Business Email |
| Contact Business Ext |
| Contact Business Fax |
| Contact Business Phone |
| Contact File As |
| Contact First and Last |
| Contact First Name |
| Contact Full Name |
| Contact Home Email |
| Contact Home Fax |
| Contact Home Phone |
| Contact Job Description |
| Contact Job Description Type |
| Contact Last Name |
| Contact Middle Name |
| Contact Mobile Phone |
| Contact Other Email |
| Contact Suffix |
| Contact Title |
| Created Date |
| Custcontact One Time |
| Avanti Slingshot - Customer Costs Fields Name |
|---|
| Fiscal Year |
| Fiscal Period |
| Cost Amount |
| Created Date |
| Avanti Slingshot - Customer Sales Fields Name |
|---|
| Customer Cost Amount |
| Customer Profit Amount |
| Customer Sales Amount |
| Customer Sales Period |
| Customer Sales Year |
| Fiscal Period End Date |
| Is MTD |
| Is YTD |
| Avanti Slingshot - Fiscal Periods Fields Name |
|---|
| Created Date |
| Fiscal Period Year |
| Fiscal Period Start |
| Fiscal Period End |
| IsYTD |
| Avanti Slingshot - Fiscal Periods Detail Name |
|---|
| Created Date |
| Fiscal Period Number |
| Fiscal Period Start Date |
| Fiscal Period End Date |
| Fiscal Period Year |
| IsMTD |
| Avanti Slingshot - Customers Fields Name |
|---|
| Created Date |
| Customer Accepts Backorders |
| Customer Category Code |
| Customer Category Description |
| Customer Class Code |
| Customer Class Description |
| Customer Code |
| Customer Credit Limit |
| Customer Csr Code |
| Customer Csr Name |
| Customer Currency Code |
| Customer Currency Name |
| Customer Industry Code |
| Customer Industry Description |
| Customer is Fob |
| Customer Minimum Order Amount |
| Customer Name |
| Customer Parent Customer Code |
| Customer Parent Customer Name |
| Customer Payment Code |
| Customer Payment Description |
| Customer Payment Terms Code |
| Customer Payment Terms Description |
| Customer Po Required |
| Customer Primary Address Address1 |
| Customer Primary Address Address2 |
| Customer Primary Address Address3 |
| Customer Primary Address City |
| Customer Primary Address Code |
| Customer Primary Address Contact Business Email |
| Customer Primary Address Contact Business Ext |
| Customer Primary Address Contact Business Phone |
| Customer Primary Address Contact Full Name |
| Customer Primary Address Contact Job Description |
| Customer Primary Address Contact Job Description Type |
| Customer Primary Address Contact Mobile Phone |
| Customer Primary Address Country Code |
| Customer Primary Address Country Name |
| Customer Primary Address Email Address |
| Customer Primary Address Fax |
| Customer Primary Address Fax Ext |
| Customer Primary Address Name |
| Customer Primary Address Phone1 |
| Customer Primary Address Phone1 Ext |
| Customer Primary Address Postal Zip |
| Customer Primary Address Stateprov Code |
| Customer Primary Address Stateprov Name |
| Customer Primary Bill Address Address1 |
| Customer Primary Bill Address Address2 |
| Customer Primary Bill Address Address3 |
| Customer Primary Bill Address City |
| Customer Primary Bill Address Code |
| Customer Primary Bill Address Contact Business Email |
| Customer Primary Bill Address Contact Business Ext |
| Customer Primary Bill Address Contact Business Phone |
| Customer Primary Bill Address Contact Full Name |
| Customer Primary Bill Address Contact Job Description |
| Customer Primary Bill Address Contact Job Description Type |
| Customer Primary Bill Address Contact Mobile Phone |
| Customer Primary Bill Address Country Code |
| Customer Primary Bill Address Country Name |
| Customer Primary Bill Address Email Address |
| Customer Primary Bill Address Fax |
| Customer Primary Bill Address Fax Ext |
| Customer Primary Bill Address Name |
| Customer Primary Bill Address Phone1 |
| Customer Primary Bill Address Phone1 Ext |
| Customer Primary Bill Address Postal Zip |
| Customer Primary Bill Address Stateprov Code |
| Customer Primary Bill Address Stateprov Name |
| Customer Primary Shipto Address Address1 |
| Customer Primary Shipto Address Address2 |
| Customer Primary Shipto Address Address3 |
| Customer Primary Shipto Address City |
| Customer Primary Shipto Address Code |
| Customer Primary Shipto Address Contact Business Email |
| Customer Primary Shipto Address Contact Business Ext |
| Customer Primary Shipto Address Contact Business Phone |
| Customer Primary Shipto Address Contact Full Name |
| Customer Primary Shipto Address Contact Job Description |
| Customer Primary Shipto Address Contact Job Description Type |
| Customer Primary Shipto Address Contact Mobile Phone |
| Customer Primary Shipto Address Country Code |
| Customer Primary Shipto Address Country Name |
| Customer Primary Shipto Address Email Address |
| Customer Primary Shipto Address Fax |
| Customer Primary Shipto Address Fax Ext |
| Customer Primary Shipto Address Name |
| Customer Primary Shipto Address Phone1 |
| Customer Primary Shipto Address Phone1 Ext |
| Customer Primary Shipto Address Postal Zip |
| Customer Primary Shipto Address Stateprov Code |
| Customer Primary Shipto Address Stateprov Name |
| Customer Priority |
| Customer Sales Group Code |
| Customer Sales Group Description |
| Customer Sales Person Code |
| Customer Sales Person Name |
| Customer Ship Complete |
| Customer Ship Method Code |
| Customer Ship Method Name |
| Customer Sic Code |
| Customer Sic Name |
| Customer Status |
| Customer Tax Group Code |
| Customer Tax Group Description |
| Customer Tax Registration Number |
| Customer Territory Code |
| Customer Territory Description |
| Customer Type |
| Customer Website |
| Date Fields Name |
|---|
| Date |
| Avanti Slingshot - Estimates Fields Name |
|---|
| Created Date |
| Estimate Csr Code |
| Estimate Csr Name |
| Estimate Customer Po |
| Estimate Date |
| Estimate Description |
| Estimate Estimator Code |
| Estimate Estimator Name |
| Estimate Fiscal Period |
| Estimate Fiscal Year |
| Estimate Good Until Date |
| Estimate Number |
| Estimate Opportunity 30 Days |
| Estimate Opportunity 60 Days |
| Estimate Opportunity 90 Days |
| Estimate Opportunity Chance To Close Percentage |
| Estimate Opportunity Closed Date |
| Estimate Opportunity Committed Close |
| Estimate Opportunity Expected Close Date |
| Estimate Opportunity Lost Amount |
| Estimate Opportunity Over 90 Days |
| Estimate Opportunity Stage |
| Estimate Opportunity Won Amount |
| Estimate Sales Person Code |
| Estimate Sales Person Name |
| Estimate Status |
| Estimate Subtotal Amount |
| Estimate Total Amount |
| Avanti Slingshot - Estimate Detail Fields Name |
|---|
| Accounter |
| Created Date |
| Estimate Detail Code |
| Estimate Detail Description |
| Estimate Detail Discount Amt |
| Estimate Detail Extended Price |
| Estimate Detail Line Num |
| Estimate Detail Rd Diff |
| Estimate Detail Qty Backorder |
| Estimate Detail Qty Ordered |
| Estimate Detail Qty Received |
| Estimate Detail Qty Reserved |
| Estimate Detail Qty Shipped |
| Estimate Detail Reference Num 1 |
| Estimate Detail Reference Num 2 |
| Estimate Detail Type |
| Estimate Detail Unit Price |
| Estimate Detail Unit Price Uom |
| Estimate Detail Uom |
| Estimate Detail Warehouse |
| Hoodie Commit SeqNo |
| Hoodie Commit Time |
| Hoodie File Name |
| Hoodie Partition Path |
| Hoodie Record Key |
| Last Modified Date |
| Ordh_id |
| Ordrevd_id |
| Org_id |
| Source File |
| Tenant |
| Avanti Slingshot - Estimate Detail Section Fields Name |
|---|
| Accounter |
| Created Date |
| Estimate Detail Section Bleed L |
| Estimate Detail Section Bleed W |
| Estimate Detail Section CBar |
| Estimate Detail Section Color |
| Estimate Detail Section Description |
| Estimate Detail Section Diff |
| Estimate Detail Section Finish |
| Estimate Detail Section Finish L |
| Estimate Detail Section Finish W |
| Estimate Detail Section Form No |
| Estimate Detail Section Grain Direction |
| Estimate Detail Section Gripper |
| Estimate Detail Section Last Completed |
| Estimate Detail Section Next Milestone |
| Estimate Detail Section Num |
| Estimate Detail Section Pages |
| Estimate Detail Section Press |
| Estimate Detail Section Press Time |
| Estimate Detail Section Qty |
| Estimate Detail Section Substrate |
| Estimate Detail Section Substrate Weight |
| Estimate Detail Section Type |
| Estimate Detail Section Weight Uom |
| Estimate Detail Section Work Weight Uom |
| Hoodie Commit Seq No |
| Hoodie Commit Time |
| Hoodie File Name |
| Hoodie Partition Path |
| Hoodie Record Key |
| Last Modified Date |
| Ordrevd_id |
| Ordrevds_id |
| Org_id |
| Source File |
| Tenant |
| Location Fields Name |
|---|
| Location Name |
| Operator Fields Name |
|---|
| Operator Name |
| Operator Activity - Continuous Form Fields Name |
|---|
| Logged Activity Type |
| Operator Session - Continuous Form Fields Name |
|---|
| Operator Login Duration (Ms) |
| Avanti Slingshot - Orders Fields Name |
|---|
| Days Left in Shipment |
| Div Code |
| Div Name |
| Order Csr Code |
| Order Csr Name |
| Order Customer Po |
| Order Date |
| Order Description |
| Order Expected Ship Date |
| Order External Order Id |
| Order Fiscal Period |
| Order Fiscal Year |
| Order Not Fully Invoiced |
| Order Number |
| Order Project |
| Order Promise Date |
| Order Proof Date |
| Order Release Date |
| Order Sales Order Ref 1 |
| Order Sales Order Ref 2 |
| Order Sales Person Code |
| Order Sales Person Name |
| Order Sales Territory Code |
| Order Sales Territory Name |
| Order Ship Method Code |
| Order Ship Method Description |
| Order Shipping Amount |
| Order Status |
| Order Subtotal Amount |
| Order Total Actual Cost |
| Order Total Amount |
| Order Total Tax Amount |
| Order Total Commission Amount |
| Order Total Postage Amount |
| Order Total Contract Charge Amount |
| Order Type |
| Plant Code |
| Plant Name |
| Avanti Slingshot - Orders Detail Fields Name |
|---|
| Accounter |
| Created Date |
| Hoodie Commit Seq No |
| Hoodie Commit Time |
| Hoodie File Name |
| Hoodie Partition Path |
| Hoodie Record Key |
| Job Id |
| Last Modified Date |
| Order Detail Code |
| Order Detail Description |
| Order Detail Discount Amt |
| Order Detail Extended Price |
| Order Detail Line Num |
| Order Detail Ord Diff |
| Order Detail Qty Back Order |
| Order Detail Qty Ordered |
| Order Detail Qty Received |
| Order Detail Qty Reserved |
| Order Detail Qty Shipped |
| Order Detail Reference Num 1 |
| Order Detail Reference Num 2 |
| Order Detail Type |
| Order Detail Unit Price |
| Order Detail Unit Price Uom |
| Order Detail Uom |
| Order Detail Warehouse |
| Ordh_id |
| Ordrevd_id |
| Org_id |
| Source File |
| Tenant |
| Avanti Slingshot - Orders Detail Section Fields Name |
|---|
| Accounter |
| Created Date |
| Hoodie Commit Seq No |
| Hoodie Commit Time |
| Hoodie File Name |
| Hoodie Partition Path |
| Hoodie Record Key |
| Last Modified Date |
| Order Detail Section Bleed L |
| Order Detail Section Bleed W |
| Order Detail Section CBar |
| Order Detail Section Color |
| Order Detail Section Description |
| Order Detail Section Diff |
| Order Detail Section Finish |
| Order Detail Section Finish L |
| Order Detail Section Finish W |
| Order Detail Section Form No |
| Order Detail Section Grain Direction |
| Order Detail Section Gripper |
| Order Detail Section Last Completed Milestone |
| Order Detail Section Next Milestone Uncompleted |
| Order Detail Section Num |
| Order Detail Section Pages |
| Order Detail Section Press |
| Order Detail Section Press Time |
| Order Detail Section Qty |
| Order Detail Section Substrate |
| Order Detail Section Substrate Weight |
| Order Detail Section Type |
| Ordrevd_id |
| Ordrevds_id |
| Org_id |
| Source File |
| Tenant |
| Weight Uom |
| Worktype Uom |
| Avanti Slingshot - Invoices Fields Name |
|---|
| Created Date |
| Invoice Record Type |
| Invoice Customer Code |
| Invoice Customer Name |
| Invoice Number |
| Invoice Date |
| Invoice Subtotal Amount |
| Invoice Postage Amount |
| Invoice Freight Amount |
| Invoice Salestax Amount |
| Invoice Total Amount |
| Fiscal Year |
| Fiscal Period |
| Avanti Slingshot - Invoices Cost Centre Fields Name |
|---|
| Accounter |
| Created Date |
| Hoodie Commit Seq No |
| Hoodie Commit Time |
| Hoodie File Name |
| Hoodie Partition Path |
| Hoodie Record Key |
| Inv_id |
| Invccs_id |
| Invoice Cost Centre Cost of Sales |
| Invoice Cost Centre Department |
| Invoice Cost Centre Discount |
| Invoice Cost Centre Gross Sales |
| Invoice Cost Centre Net Sales |
| Invoice Cost Centre Operation |
| Invoice Cost Centre Operation Category |
| Last Modified Date |
| Org_id |
| Source File |
| Tenant |
| Avanti Slingshot - Invoices Billing Code Fields Name |
|---|
| Accounter |
| Created Date |
| Hoodie Commit Seq No |
| Hoodie Commit Time |
| Hoodie File Name |
| Hoodie Partition Path |
| Hoodie Record Key |
| Inv_id |
| Invd_id |
| Invoice Billing Code |
| Invoice Billing Code Address Code |
| Invoice Billing Code Description |
| Invoice Billing Code Ext Price |
| Invoice Billing Code Level |
| Invoice Billing Code Qty |
| Invoice Billing Code Rounding Indicator |
| Invoice Billing Code Sequence Nr |
| Invoice Billing Code Ship Address Name |
| Invoice Billing Code Tax Amt |
| Invoice Billing Code Unit Price |
| Last Modified Date |
| Org_id |
| Source File |
| Tenant |
| Avanti Slingshot - Jobs Fields Name |
|---|
| Created Date |
| Fiscal Period |
| Fiscal Year |
| Job Actual Labour Cost |
| Job Actual Material Cost |
| Job Actual Other Cost |
| Job Actual Purchase Cost |
| Job Actual Total Cost |
| Job Budget Labour |
| Job Budget Material |
| Job Budget Purchase |
| Job Budget Status |
| Job Budget Total |
| Job Completed Date |
| Job Date |
| Job Date 2 |
| Job Description |
| Job Expected Ship Date |
| Job Has Milestones |
| Job Invoice Status |
| Job Max Milestone Date Completed |
| Job Max Milestone Date Due |
| Job Max Milestone Date Scheduled |
| Job Number |
| Job Paper Actual Cost |
| Job Paper Budget Cost |
| Job Press |
| Job Price |
| Job Priority |
| Job Schedule Status |
| Job Ship Method |
| Job Shipping Status |
| Job Status |
| Job Total Press Time |
| Milestone Last Modified Date |
| Variance |
1.4.7.3 Data Fields from RICOH API for Fiery
These data fields are available from RICOH API for Fiery:
| Field Name | Description |
|---|---|
| Black & white printed pages - RICOH API for Fiery | The number of black-and-white printed pages. |
| Color printed pages - RICOH API for Fiery | The number of full-color printed pages. |
| Blank printed pages - RICOH API for Fiery | The number of blank printed pages. |
| Tabs printed - RICOH API for Fiery | The number of printed tabs. |
| Rip duration (Seconds) - RICOH API for Fiery | The amount of time required for rip, measured in seconds. |
1.4.7.4 Data Fields from RICOH ProcessDirector
- Important:
- If you have the RICOH ProcessDirector feature, you can receive data from RICOH ProcessDirector through data transmitters. To purchase the RICOH ProcessDirector feature, contact your Ricoh representative.
- All the time-related data is displayed in the time zone of your browser.
These data fields are used for the RICOH ProcessDirector sample dashboard, but you can include any data fields that are collected and transmitted to RICOH Supervisor:
| Field Name | RICOH ProcessDirector Database Name | RICOH ProcessDirector Property Name |
|---|---|---|
| job_customername | Job.CustomerName | Customer name |
| job_locations | Job.Locations | Requested location |
| job_print_cumulativesheets | Job.Print.CumulativeSheetsStacked | Cumulative sheets stacked |
| job_scheduleuserid | Job.Scheduleuserid | Scheduled by |
| job_print_cumulativepagesstacked | Job.Print.Cumulativepagesstacked | Cumulative pages stacked |
| printer_id | Printer.Id | Printer name |
| job_print_endprinttime | Job.Print.Endprinttime | Print complete time |
1.5 Working with Real-Time Printer Data
Important: The options you see in the Real Time Display tab and the actions that you can perform depend on your user role. Roles can restrict access to certain user interface areas or limit the available actions.
For more information, see Users and Roles.
1.5.1 Viewing Printer Information
- Click
, the Real Time Display tab. - Under Printer Groups, click All printers or a specific printer group name.The printers included in the group are displayed as individual cards. For printers with dual-simplex configuration, a separate card is displayed for each engine and all the data metrics are tracked per engine.
- Look at the information displayed on the printer cards.This information is available:
- Printer name
- The name of the printer.
- Printer status
- When the printer is connected and transferring data, the printer card shows the printer status. For more information on status messages, see Printer Status.
- Connection status
- When there is no data transfer from a printer, the printer card is inactive and shows
the connection status instead of the printer status:
- Not configured: No communication channels are configured for the printer. Go to the data collector and configure at least one supported communication channel.
- Not connected: The communication channels cannot communicate with the printer and there is no data transfer. Go to the data collector, verify the printer settings and the network settings, and fix any connectivity issues.
- Not available: Cannot communicate with the data collector to retrieve printer information. Verify the network settings and fix any connectivity issues.
- Waiting for data: The connection with the communication channels is being established and there is no data transfer yet. Wait for the connection to be established or go to the data collector and make sure that there are no connectivity issues.
If the connection with RICOH Supervisor Data Collector is still active, you can access the corresponding data collector page directly from the printer card. Click
, the information icon, and then click Open the data collector page in a new tab. - Name of the current job
- This information is displayed only when the printer status is Printing.
- Data collecting period
- For more information on setting the data collecting period, see Customizing Printer Cards.
- Monitored data metrics
- For more information on setting the data metrics, see Customizing Printer Cards.
Note: You can filter the printers in a group by name. Enter a printer name or part of a printer name in the Search printers text box.Note: The printer cards metrics in the Real Time Display tab may be updated with delay if time on printers or the machine where RICOH Supervisor Data Collector is installed is not set correctly. For more information, see If You Encounter a Problem.
1.5.1.1 Printer Status
, the information icon.Status Messages and Printer States
| Status Message / Printer States | |
|---|---|
 |
Idle Ready Not ready Pre/post not ready Sleeping Shutdown Warming Started Start-up |
 |
Initializing Feeding Preparing Printing Processing Receiving |
 |
Adjusting Cleaning Maintenance Not available Restart Pre/post busy Pre/post threading Pre/post EOF Pre/post paused Error, when the error that occurred on the printer is not critical. |
 |
Error, when the error that occurred on the printer is critical. |
|
Any other printer state. |
|
- Note:
- For more information on printer states, see the printer documentation.
- For printers with duplex or triplex configuration, the Printing and Idle status messages are displayed only when all the printer engines are in a printing
or idle state. When at least one of the engines is in an error state, the Error status message is displayed. If only one of the engines is in an error state, the
engine number is included in the Error status message.
For printers with dual-simplex configuration, a separate printer card is displayed for each engine and the status is tracked per engine.
- When several error codes are received from the printer at the same time, only the
main error is displayed on the printer card.
RICOH Supervisor orders the errors from a set of simultaneous errors based on this default order:
inputTrayEmptymediaEmptymarkerSupplyEmptyoutputBinFullmarkerWasteFullpaperJammediaLowcoverOpenserviceRequestedofflineunknown
For example, if the
inputTrayEmpty,serviceRequested, andofflineerror codes are received at the same time,inputTrayEmptyis the main error that is displayed on the printer card.If the
mediaEmptyandpaperJamerror codes are received at the same time,mediaEmptyis the main error that is displayed on the printer card.Any other errors that are received from the printer but are not included in the default list take precedence over the errors in the list.
1.5.2 Viewing Printer Information in Full-Screen Mode
- Click , the Real Time Display tab.
- Under Printer Groups, click All printers or a specific printer group name.The printers included in the group are displayed as individual cards. For printers with dual-simplex configuration, a separate card is displayed for each engine and all the data metrics are tracked per engine.
- On the group heading, click
, the Expand button.
To exit the full-screen mode, press the Esc key or click
, the Collapse button.
1.5.3 Customizing Printer Cards
- Click , the Real Time Display tab.
- Under Printer Groups, click All printers or a specific printer group name.The printers included in the group are displayed as individual cards.
- Click
, the Options button, in the corner of the printer card. - Click Preview.
- Specify the required data settings in the Customize view dialog box.
You can select the data collecting period, set the monitored data metrics and their performance targets, and specify how the data is represented.
For details about a specific setting, click the
button to display the on-screen field help. - Click OK.
1.5.4 Customizing Multiple Printer Cards
- Click , the Real Time Display tab.
- Under Printer Groups, click All printers or a specific printer group name.
- Click
, the Options button, on the group heading and select Customize views.
- Select the printers that you want to customize.
To customize all the printers in the group, select the Select all check box.
Note: You cannot customize different types of printers at the same time. - Click Customize views.
- Specify the required data settings in the Customize view dialog box.
You can select the data collecting period, set the monitored data metrics and their performance targets, and specify how the data is represented.
For details about a specific setting, click the
button to display the on-screen field help. - Click OK.
1.5.5 Creating Printer Groups
- Click , the Real Time Display tab.
- Click
, the Group printers button, next to Printer Groups. - Select the printers that you want to include in the group.
To include all the printers, select the Select all check box.
- In the Name field, enter a name for the group.
- To reorder the printer cards, click the cards and drag them to a different location.
- Click Create.
1.5.6 Editing Printer Groups
- Click , the Real Time Display tab.
- Under Printer Groups, select the group that you want to edit.
- Click , the Options button, on the group heading and select Edit group.
- Select the printers that you want to include in the group.To include all the printers, select the Select all check box.
- Enter a new name for the group in the Name field.
- To reorder the printer cards, click the cards and drag them to a different location.
- Click Save.
1.5.7 Removing Printer Groups
- Click , the Real Time Display tab.
- Under Printer Groups, select the group that you want to remove.
- Click , the Options button, on the group heading and select Remove group.
- In the confirmation dialog box, click OK.
1.5.8 Adding, Editing, and Removing Printers
- Click , the Data Collectors tab.
- In the Data Collectors list, select the data collector that you want to work with.You can see the printers that are configured for a data collector in the information panel on the right under Data Source.
- In the data collector information panel, click the IP address of the data collector to open RICOH Supervisor Data Collector and access the data collector page.
- In RICOH Supervisor Data Collector, add, edit, or remove printers as necessary.For more information, see the RICOH Supervisor Data Collector documentation.
1.6 Security
1.6.1 Users and Roles
These roles are available:
- Administrator and Self-Service
- Has access to all the functions and configuration settings.
- Administrator
-
- Has access to all the functions and configuration settings, with some limitations in the Dashboards tab.
- In the Dashboards tab, the administrator can view dashboards, interact with visuals, and use filters.
- Self-Service
-
- Has access to all the functions and configuration settings in the Dashboards tab.
- Can configure notification settings for their own account, set user preferences, and upload ink data. For all the other settings, the self-service user has read-only access.
- Viewer
-
- In the Dashboards tab, the viewer can view dashboards, interact with visuals, and use filters.
- Can configure notification settings for their own account, set user preferences, and upload ink data. For all the other settings, the viewer has read-only access.
- Large Display
-
- Can view the printer groups and printer cards from the Real Time Display tab and can switch to full-screen mode.
- Can view notifications and set user preferences.
- Cannot access any other user interface areas.
Note: The session timeout settings do not affect the Large Display user.Make sure that the platform role is also set to Large Display in RICOH Account Administration. For more information, see the RICOH Account Administration documentation.
- None
- Cannot access RICOH Supervisor.
These limitations apply for each specific user interface area:
| User Interface Area | Roles and Limitations | |||||
|---|---|---|---|---|---|---|
| Administrator and Self-Service | Administrator | Self-Service | Viewer | Large Display | None | |
|
Dashboards tab |
No limitations. |
Cannot create or manage analyses and visuals. |
No limitations. |
Cannot create or manage analyses and visuals. |
No access. |
No access. |
|
Real Time Display tab |
No limitations. |
No limitations. |
Cannot create, edit, or delete printer groups. Cannot edit printer card settings. |
Cannot create, edit, or delete printer groups. Cannot edit printer card settings. |
Cannot create, edit, or delete printer groups. Cannot edit printer card settings. |
No access. |
|
Data Collectors tab |
No limitations. |
No limitations. |
Cannot download, update, or delete data collectors. |
Cannot download, update, or delete data collectors. |
No access. |
No access. |
|
Settings tab |
No limitations. |
No limitations. |
Cannot create, edit, or delete locations. Cannot create, edit, or delete shifts. Cannot configure account settings. |
Cannot create, edit, or delete locations. Cannot create, edit, or delete shifts. Cannot configure account settings. |
Cannot configure notification settings. Cannot create, edit, or delete locations. Cannot create, edit, or delete shifts. Cannot access account settings. |
No access. |
|
Account menu |
No limitations. |
No limitations. |
Cannot use access management functions. |
Cannot use access management functions. |
Cannot use access management functions. |
No access. |
1.7 Troubleshooting and Support
1.7.1 If You Encounter a Problem
Cannot Sign In
Make sure that you enter your email address and password correctly. The password is case-sensitive.
If you forgot your password, click Forgot password on the sign-in page and follow the required steps. After you provide the email address for your account, you receive a verification code for resetting the password.
The User Interface Content Is Not Displayed Correctly
The Web page was not loaded correctly. Clear the web browser cache and reload the page.
See the web browser documentation for instructions on how to clear the cache and reload a page.
Cannot Access RICOH Supervisor with Google Chrome
To access RICOH Supervisor with Google Chrome, make sure you enable third-party cookies for the app-ricohsoftware domain where your instance of RICOH Supervisor runs.
The Dashboards are Not Displayed in Incognito Mode
When in Incognito mode, if dashboards are not loaded in the Dashboards tab, try one of these possible solutions:
- Go to , and select Allow all cookies.
- You can also turn off the Google Chrome Incognito mode.
- Go to , and select Allow sites to save and read cookie data.
- You can also turn off the Microsoft Edge private browsing mode.
Cannot Access Some User Interface Areas and Functions
The options you see on the user interface and the actions that you can perform depend on your user role. Roles can restrict access to certain user interface areas or limit the available actions.
For more information, see Users and Roles.
Connectivity Issues After Upgrading RICOH Supervisor Data Collector
If you encounter issues after a software upgrade, try uninstalling and reinstalling RICOH Supervisor Data Collector:
- Uninstall the application without deleting the data collector from the cloud.
- Reinstall the application and restore the data collector configuration.
For more information, see the RICOH Supervisor Data Collector documentation.
Cannot Edit a Dashboard
You can only edit dashboards that you created or shared dashboards for which you were assigned editing rights.
If you cannot edit a shared dashboard:
- Ask the owner of the shared dashboard to make the changes.
- Ask the owner of the shared dashboard to assign you editing rights.
- Duplicate the shared dashboard and edit the copy.
Some Printer Cards Are Inactive
When there is no data transfer from a printer, the printer card is inactive.
Try one of these actions, depending on the connection status:
- Not configured: No communication channels are configured for the printer. Go to the data collector and configure at least one supported communication channel.
- Not connected: The communication channels cannot communicate with the printer and there is no data transfer. Go to the data collector, verify the printer settings and the network settings, and fix any connectivity issues.
- Not available: Cannot communicate with the data collector to retrieve printer information. Verify the network settings and fix any connectivity issues.
- Waiting for data: The connection with the communication channels is being established and there is no data transfer yet. Wait for the connection to be established or go to the data collector and make sure that there are no connectivity issues.
If the connection with RICOH Supervisor Data Collector is still active, you can access the corresponding data collector page directly from
the printer card. Click , the information icon, and then click Open the data collector page in a new tab.
Missing or Inaccurate Data
If you notice missing or inaccurate data in the Dashboards and Real Time Display tabs, go to RICOH Supervisor Data Collector and make sure that all the settings are configured correctly according to the printer type. Verify that there are no connectivity issues and that the data collector can successfully communicate with the printers and retrieve data.
For more information, see the RICOH Supervisor Data Collector documentation.
Missing or Inaccurate Data after Power Outage
In case of a power outage, we recommend that you uninstall and reinstall RICOH Supervisor Data Collector. Make sure that you do not select the Delete the Data Collector from the cloud check box when you uninstall the application. Otherwise, any stored data is lost.
To prevent any power outage related issues, make sure that you use an Uninterruptible Power Supply (UPS) for power outages.
Data for Printed Impressions and Sheets Is Not Always Accurate for InfoPrint 5000 and InfoPrint 4100 Printers
For InfoPrint 5000 and InfoPrint 4100 continuous form printers, the number of printed impressions and the number of printed sheets are calculated in RICOH Supervisor Data Collector assuming that all jobs are 2-up, regardless of the printer configuration:
- Number of printed impressions
-
Pages in PDF file/2 × copies
- Number of printed sheets
-
(Pages in PDF file/2/printing side value) × copies
For 1-sided jobs, the printing side value is 1. For 2-sided jobs, the printing side value is 2.
For more information, see Data Fields.
Performance Issues While Working with Dashboards
The number of visuals included in a dashboard might affect the system performance. RICOH Supervisor supports up to 30 visuals in a single sheet and up to 20 sheets per analysis.
Filtering Jobs Based on Printed Metrics Does Not Return the Expected Results
Sometimes, job data is received through several separate events instead of a single event. As a result, when you filter jobs based on printed metrics, such as the printed paper length, printed sheets, printed pages, or printed impressions, the available values do not represent the total values for the job. Instead they correspond to the separate values received for each event.
For example, if the total printed paper length for a job was 121 feet received through 2 separate events as 60 feet and 61 feet, the values available when you filter by Printed Paper Length (Feet) are 60 and 61, not 121.
The Time Zone of a Data Source Is Not Set
The time zone of each data source is displayed on the Data Collectors tab under Data Source Time Zone.
If the Data Source Time Zone setting is shown as Not set, you must go to RICOH Supervisor Data Collector and specify a time zone for the data source. Make sure that the latest version of RICOH Supervisor Data Collector is installed.
A Location Does Not Appear in the Dashboards Tab
Newly added locations are available in the Dashboards tab only after the next data refresh.
To be displayed in visuals and filters, a location must also meet these requirements:
- The location must contain at least one printer.
- Data must be available from the printers assigned to the location.
- If the location is associated with a shift, data must be available for the time interval covered by the shift.
A Shift Does Not Appear in the Dashboards Tab
Newly added shifts are available in the Dashboards tab only after the next data refresh.
To be displayed in visuals and filters, a shift must also meet these requirements:
- If the shift is associated with a location, data must be available for the time interval covered by the shift from the printers assigned to that location.
- If the shift is not associated with a location, data must be available for the time interval covered by the shift from any printer in the system.
Job Names Are Displayed Incorrectly
To correctly display printer data, such as job names, when RICOH Supervisor Data Collector receives information through SNMP, make sure that the value set for the Printer Character Set option matches the language settings configured on the printer. For more information, see the printer documentation.
The Printer Character Set option is available when you add or edit printers that use the Generic SNMP Printer, RICOH GW Cut Sheet Printer, or RICOH EFI Cut Sheet Printer configuration.
Custom Visuals Do Not Show Accurate Printer Error Data
When you create visuals that show printer errors and error duration, make sure that you add a Printer Error Sequence filter in the visual and set it to Main Error. This way, when the printer sends several error codes at the same time, only the main error is included in the visual.
This filter is especially useful when a main error state generates a sequence of other
error states. For example, the serviceRequested and offline error codes are often received alongside the main error. The filter excludes the
serviceRequested and offline error codes when they overlap with the main error.
The filter also applies when several independent errors, such as paperJam and mediaLow,
happen at the same time.
For more information on the Printer Error Sequence field and on how RICOH Supervisor orders simultaneous errors and determines the main error, see Data Fields.
All the errors collected with a RICOH Supervisor Data Collector version older than 1.1.0.669 are automatically assigned to the N\A error sequence value. If you want to view older data, also include the N\A value in the Printer Error Sequence filter.
On printers with multiple engines, you can have several main errors at the same time, one per engine. To improve error data accuracy, you can also add a Printer Engine filter in the visual and display data per engine.
The Correlation Between Jobs and Printer Errors Is Not Always Accurate
The correlation between jobs and printer errors is currently available only for EFI Fiery and RICOH GW cut sheet printers.
RICOH Supervisor might not be able to correlate printed or aborted jobs with printer errors if the jobs were finalized before the error event was received from the printer.
On continuous form printers, the job always goes to the printed or aborted state when a printer error occurs. When the error is resolved and printing resumes, RICOH Supervisor Data Collector creates a new job with the same name but with a different job ID. As a result, RICOH Supervisor cannot correlate the job with the printer error.
Issues with Pop-Up Windows Blocked by the Web Browser
If your web browser is configured to block pop-up windows, some functions might not be available or might not work properly.
You can change the web browser security settings to allow pop-up windows from RICOH Supervisor. Add these addresses to the list of exceptions in the web browser settings:
- For the United States:
ricohsoftware.comwww.ricohsoftware.com*.app-ricohsoftware.com
- For Europe:
ricohsoftware.euwww.ricohsoftware.eu*.app-ricohsoftware.eu
See the web browser documentation for instructions on how to change permissions for pop-up windows.
Issues with Blocked URLs
If your network uses a web content filtering system, make sure that you allow access to these URLs:
- For the United States:
ricohsoftware.comhelp.ricohsoftware.comsupervisor.app-ricohsoftware.comservices.app-ricohsoftware.comdatacollector.app-ricohsoftware.comfileupload.app-ricohsoftware.comcognito-idp.us-west-2.amazonaws.com
- For Europe:
ricohsoftware.euhelp.ricohsoftware.comsupervisor.app-ricohsoftware.euservices.app-ricohsoftware.eudatacollector.app-ricohsoftware.eufileupload.app-ricohsoftware.eucognito-idp.eu-west-1.amazonaws.com
Create a HAR file in your browser
In order to investigate or replicate a certain issue, our Ricoh representative may require a HAR file and an output file of the console from the browser that RICOH Supervisor application runs in. The instructions below represent a guideline for generating the HAR/log files, but might not match the experience in the latest versions of the browsers or in the version that you use.
- Google Chrome:
- In the browser heading, click , the Customize and control Google Chrome icon, and select .
- In the Console tab, click
, the Clear console icon. - In the Network tab, click , the Clear icon, to clear all current network requests.
- In the Network tab, select the Preserve log check box.
- Reproduce the issue from your support case.
- In the Network tab, click
, the Export HAR... icon, and save the file. - In the Console tab, right click on any of the items in the list.
- Choose Save as..., and then save the file.
- In the browser heading, click
- Microsoft Edge:
- In the browser heading, click
, the Settings and more icon, and select . - In the Console tab, clear the console output.
- In the Network tab, clear all current network requests.
- In the Network tab, select the Preserve log check box.
- Reproduce the issue from your support case.
- In the Network tab, click
, the Export HAR... icon, and save the file. - In the Console tab, right click on any of the items in the list.
- Choose Save as..., and then save the file.
- In the browser heading, click
- Mozilla Firefox:
- In the browser heading, click
, the Open application menu icon, and select . - In the Console tab, clear the Web Console output.
- In the Network tab, clear all current network requests.
- In the Network tab, choose the Gear icon, and select Persist Logs.
- Reproduce the issue from your support case.
- In the Network tab, right click on any network request in the request list.
- Choose Save All As HAR, and then save the file.
- In the Console tab, right click on any of the items in the list.
- Choose Save all Messages to File, and then save the file.
- In the browser heading, click
A Shift Does Not Appear in the Dashboards Tab
Newly added shifts are available in the Dashboards tab only after the next data refresh.
To be displayed in visuals and filters, a shift must also meet these requirements:
- If the shift is associated with a location, data must be available for the time interval covered by the shift from the printers assigned to that location.
- If the shift is not associated with a location, data must be available for the time interval covered by the shift from any printer in the system.
Printer Cards Metrics Are Displayed with Delays
If time on printers or the machine where RICOH Supervisor Data Collector is installed is not set correctly, the printer cards metrics in the Real Time Display tab may be updated with delay.
If you encounter any delays in printer card metrics, complete the following steps:
- Set the time on printer on-time, with no delays.
- Set the time on the machine on-time, with no delays.
- If you have RICOH Supervisor Data Collector already installed, restart the service.
- Print a job on the defined printer.
- In the Real Time Display tab, check the printer cards metrics.
Deleted Printers Are Not Visible For Filtered Shifts
Shifts apply only to printers that are currently registered in RICOH Supervisor Data Collector.
If you want deleted printers to be visible, make sure you remove the shift setting from the filter.
If You Cannot Access the Application
This section explains what to do if you cannot access the application.
|
Action and reference |
|---|
|
Contacting Ricoh Support
If you need help with a RICOH Supervisor issue, you can contact a Ricoh support representative.
For technical support inside the United States, contact 1-877-318-8968. For all other regions, contact your Ricoh sales representative or technical specialist.
, for viewing and editing the settings of the data collector and for viewing plug-in
information and the activity log.
, for viewing your user name and for signing out.
, for viewing information on how to configure and use 
, for finding a data source configured in 
, the 
, the 
becomes visible in the footer. Click the information button for more details.
, the 
, the 
, the 
, the 
, the 
, the menu button, on the printer card and select 