xxnullxx - 5e4f0ab9cfd5400001c7b31a

RICOH Supervisor

1 RICOH Supervisor

RICOH Supervisor is a cloud-based application that helps you monitor, understand, and improve your print production environment through visual representations.

1.1 Overview of RICOH Supervisor

With RICOH Supervisor, you are always aware of what is happening in your print shop.

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.
Important: RICOH Supervisor is not a billing application but it can help you better understand your costing by providing valuable insights into the typical workload and performance of your devices.

1.1.1 What's New?

This page provides information about new or updated functions, defect fixes, and deprecated functionality.
Important: To benefit from the new or improved functions, fixes, and security updates, make sure that you always upgrade to the latest version of RICOH Supervisor Data Collector. For more information, see Updating Data Collectors.
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
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. For more information, see Viewing 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)
    For more information, see the RICOH Supervisor Data Collector documentation. (Requires the new version of RICOH Supervisor Data Collector).
  • 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.
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. For more information, see Sharing Dashboards.
  • 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. For more information, see Sharing Dashboards.
  • Various security fixes including CVE-2022-1587, CVE-2022-1586, CVE-2022-31197, and CVE-2022-40674.
  • Minor bug fixes.
September 15, 2022
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
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. For more information, see Viewing Dashboards.
  • 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. For more information, see Managing the Widgets in the Widget Library.
  • 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. For more information, see Using the Default Widgets 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.
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. For more information, see Creating a Funnel Chart Widget.
  • Improved the sorting function available in pivot tables. For more information, see Creating a Pivot Table Widget.
  • 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.
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.
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.
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 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.

    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.
February 25, 2021
  • Replaced the Years in Date Months in Date Days in Date 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 Default 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. For more information, see Analyzing Trends in Widget 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 Account Account details.
  • 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.
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 Settings User Preferences.
  • 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 RICOH Supervisor User Interface

RICOH Supervisor provides a comprehensive and intuitive web-based user interface for viewing and managing the data collected from connected data sources. You can customize the way the data is displayed, generate reports, monitor printer performance based on targets, and set up notifications.
Reference: For a video presentation of the RICOH Supervisor user interface, go to Ricoh How-to Videos.

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.

User interface overview

The user interface consists of these areas:

  1. Banner for account and user management, notifications, and help access.

  2. Dashboards tab for filtering, viewing, and downloading collected data.

  3. Real Time Display tab for monitoring printer status and performance.

  4. Data Collectors tab for configuring data collectors and software connectors.

  5. Settings tab for configuring user preferences, notifications, locations, and shifts.

1.1.2.1 Banner

The banner provides access to account and user management settings, notifications, and help content.

Click the banner items to open the list of available options.

Menu bar

1.1.2.2 Dashboards Tab

The Dashboards tab provides different layout and graphical options for displaying historical data collected from your system. You can apply filters to focus on specific data or time intervals and download reports.

A dashboard is a collection of customizable widgets with various functions for representing data in a meaningful way.

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.

Dashboards tab

The time when the data in a dashboard was last updated is displayed next to the dashboard name in the time zone of the web browser that accesses RICOH Supervisor.

The maximum time between refreshes in the Dashboards tab is 2 hours. However, internal processing could cause delay in data update.

1.1.2.3 Real Time Display Tab

The Real Time Display tab provides up-to-date status and performance information for the printers registered in RICOH Supervisor Data Collector.

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.

Real Time Display tab

The data displayed in the Real Time Display tab is updated every 1 to 2 minutes.

Note: The polling interval used in RICOH Supervisor Data Collector for the configured printer type and communication method might cause delays in data availability. For more information, see the RICOH Supervisor Data Collector documentation.

1.1.2.4 Data Collectors Tab

On the Data Collectors tab, you can configure data collectors and software connectors and view their connection status.

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.

Data Collectors tab

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.2.5 Settings Tab

You can use the options from the Settings tab to configure user preferences, notifications, locations, and shifts.
Notifications panel

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.3 Notices

1.1.3.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.3.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.3.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

This section includes basic procedures for working with RICOH Supervisor.

1.2.1 Computer Requirements

To access RICOH Supervisor, your computer must meet the following requirements.
Item Requirements
Web browser
  • Google Chrome 116 or later
  • Mozilla Firefox 116 or later
  • Microsoft Edge 116 or later
    Important:
  • You must enable JavaScript for the web browser.
  • You must enable cookies in your web browser.
  • In Google Chrome, you must enable third-party cookies. For more information, see If You Encounter a Problem.
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

Authorized users can sign in from any system that is connected to the Internet and has a supported web browser installed.
Note: For information on the supported web browsers and the minimum requirements, see Computer Requirements.
To sign in:
  1. Open a web browser window.
  2. Enter this URL in the address bar:
  3. On the sign-in page, enter your email address and password and click Sign in.
    Sign-in page

    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.
For security reasons, your session expires after 15 minutes of inactivity. The session timeout settings do not affect the Large Display user.

1.2.3 Downloading and Installing RICOH Supervisor Data Collector

To start monitoring and gathering data from your printers, you must first install the RICOH Supervisor Data Collector application. If a data collector is not available, the Welcome to RICOH Supervisor page is displayed.
To download and install RICOH Supervisor Data Collector:
  1. 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.
    Install RICOH Supervisor Data Collector
  2. Check the computer requirements and click Next.
    Install RICOH Supervisor Data Collector
  3. Check the ports that you need to open and click Next.
    Install RICOH Supervisor Data Collector
  4. Check the URLs that need to be white listed from your firewall in order to be accessible for the data collector. Click Next.
    Install RICOH Supervisor Data Collector
  5. On the Download & Install Data Collector page, click Download Data Collector for Windows or click here for Linux.
    Download RICOH Supervisor Data Collector
  6. Save the installation file to your computer.
    The procedure for saving the file depends on the web browser.
  7. Launch the installer as an administrator on a Windows system or as root on a Linux system.
  8. When the installer is displayed, select a language and click OK.
  9. In the Welcome dialog box, click Next.
  10. In the License Agreement dialog box:
    1. Read the license agreement.
    2. Click I accept the terms of the License Agreement.
    3. Click Next.
  11. In the Install Folder dialog box:
    1. 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.
    2. 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.
  12. In the Shortcut Folder dialog box:
    1. Specify where you want to create the product icons.
    2. Click Next.
  13. In the Proxy Settings dialog box:
    1. Review and update the information, if necessary. The installer attempts to detect automatically your system proxy configuration.
    2. Click Next.
  14. In the Choose Region dialog box:
    1. 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
    2. Click Next.
  15. In the Configure ports dialog box:
    1. 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.
    2. Click Next.
  16. In the Summary dialog box:
    1. Review the information you provided.
    2. To go back and edit the information you provided, click Previous.
    3. To proceed, click Install.
  17. After the installation is complete, select the Open RICOH Supervisor Data Collector check box to open the application.
  18. Click Done to close the installer.
After you install and configure RICOH Supervisor Data Collector, it might take up to 30 minutes for the collected data to be available in the Dashboards tab.

1.2.4 Downloading and Installing RICOH Supervisor Data Collector with Command Line

To start monitoring and gathering data from your printers, you must first install the RICOH Supervisor Data Collector application. If a data collector is not available, the Install Data Collector to Get Printer Data page is displayed.
You can download and install RICOH Supervisor Data Collector using the command line installation:
  1. 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.
    Install RICOH Supervisor Data Collector
  2. Check the computer requirements and click Next.
    Install RICOH Supervisor Data Collector
  3. Check the ports that you need to open and click Next.
    Install RICOH Supervisor Data Collector
  4. Check the URLs that need to be white listed from your firewall in order to be accessible for the data collector. Click Next.
    Install RICOH Supervisor Data Collector
  5. On the Download & Install Data Collector page, click Download Data Collector for Windows or click here for Linux.
    Download RICOH Supervisor Data Collector
  6. Save the installation file to your computer.
    The procedure for saving the file depends on the web browser.
  7. Open a command prompt.
  8. 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_NO_PROXY={true|false} | -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_NO_PROXY No Yes Use/do not use proxy true/false System proxy settings (Windows)
    -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.
    Note: After the command line installation, it takes approximately 2 minutes for RICOH Supervisor Data Collector to become functional.
    Note: If you use the sudo command when launching the installer on a Linux system, the proxy settings (if not specified) will default to the system proxy settings only if the -E option is specified:
    sudo INSTALLER -E -i silent -DC_REGION={USA|Europe} [{-DC_NO_PROXY={true|false} | -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

You can sign out from the Account menu.
To sign out:
  1. On the banner, click Account button, the Account button.
  2. Click Sign out.

1.3 Configuration

This section provides useful information for configuring the system and includes procedures for working with data collectors and software connectors, setting user preferences and notifications, and creating locations and shifts.

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

You can manage your account and user settings using the RICOH Account Administration application. Information related to your subscription is also available.
To configure account and user settings:
  1. On the banner, click Account button, the Account button.
  2. 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.
  3. In RICOH Account Administration, view and update the settings as necessary.
For information on managing accounts, users, and subscriptions, see the RICOH Account Administration documentation.

1.3.2 Configuring Profile Settings

You can view and modify your profile settings from the Account menu.
To configure profile settings:
  1. On the banner, click Account button, the Account button.
  2. Click Profile Settings.
  3. 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 Help button to display the on-screen field help.

1.3.3 Configuring Data Collectors

On the Data Collectors tab, you can configure data collectors and view useful data collector information, including the IP address, current software version, available updates, communication status, and data sources.
To use data collectors, you must first download and install RICOH Supervisor Data Collector. For more information, see Downloading and Installing RICOH Supervisor Data Collector.

1.3.3.1 Downloading Data Collectors

You can download additional data collectors from the Data Collectors tab.
To download a data collector:
  1. Click Data Collectors tab, the Data Collectors tab.
  2. Click Download Data Collector button, the Download Data Collector button, next to Data Collectors.
    Data Collectors tab - Download Data Collector
  3. In the Welcome to RICOH Supervisor dialog box, click Download Data Collector in the section that corresponds to your operating system.
    Welcome to RICOH Supervisor dialog box
    Note: Make sure that you have one of the supported operating system versions.
  4. Save the installation file to your computer.
    The procedure for saving the file depends on the web browser.
  5. To launch the installer, run the downloaded installation file.
  6. Follow the required installation steps.

1.3.3.2 Viewing Data Collector Information

The Data Collectors tab displays information about the configured data collectors, including the IP address, current software version, available updates, communication status, and data sources.
To view information for a data collector:
  1. Click Data Collectors tab, the Data Collectors tab.
    Data Collectors tab
  2. Select the data collector that you want to view in the Data Collectors list.
  3. 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

If a newer software version is available, you can download an update for the data collectors.
To update a data collector:
  1. Click Data Collectors tab, the Data Collectors tab.
  2. Select the data collector that you want to update in the Data Collectors list.
  3. In the data collector information panel, click Download Data Collector button, the Download Data Collector button, under Update.
    Data Collectors tab - Update a data collector

    The Download Data Collector button is active only when a software update is available.

  4. Save the installation file to your computer.
    The procedure for saving the file depends on the web browser.
  5. To launch the installer, run the downloaded installation file on the system where RICOH Supervisor Data Collector is installed.
  6. Follow the required installation steps.

1.3.3.4 Changing Data Collector Settings

To change the settings of a data collector, you must use RICOH Supervisor Data Collector.
To change data collector settings:
  1. Click Data Collectors tab, the Data Collectors tab.
    Data Collectors tab
  2. In the Data Collectors list, select the data collector that you want to edit.
  3. 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.
  4. 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

You can delete data collectors that are no longer required.
To delete a data collector:
  1. Click Data Collectors tab, the Data Collectors tab.
  2. Select the data collector that you want to delete in the Data Collectors list.
  3. In the data collector information panel, click Delete....
    Data Collectors tab - Delete a data collector
    Note: You can delete only data collectors that are not connected.
  4. 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

To track ink usage for your InfoPrint 5000 continuous form printers, you must upload ink data for each printer on the Data Collectors tab.
To upload ink data for an InfoPrint 5000 printer:
  1. 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.
  2. In RICOH Supervisor, click Data Collectors tab, the Data Collectors tab.
  3. Select the data collector where the printer is registered in the Data Collectors list.
  4. Find the printer in the data source list and click Upload CSV Ink File... button, the Upload CSV Ink File... button.
    Data Collectors tab - Upload ink data

    The Upload CSV Ink File... button is active for all printer states.

  5. 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.
  6. 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.
  7. 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.

  8. Verify the result of the data upload and validation:
    • If the upload and validation were successful, the upload complete icon 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 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.

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

Software connectors let you collect and display data from other applications. For example, 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.

1.3.4.1 Configuring the RICOH ProcessDirector Software Connector

The RICOH ProcessDirector software connector uses data transmitters to push RICOH ProcessDirector data to the cloud through a secure connection. Data collection and transmission is supported in RICOH ProcessDirector version 3.10 or later. For more information, see the RICOH ProcessDirector documentation.
    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 5432 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

The SOFTWARE CONNECTORS section from the Data Collectors tab displays information about the data transmitters configured in RICOH ProcessDirector, including the communication status, the total amount of data received, the next scheduled update, and the data tables.
    Note:
  • This function is only available with the RICOH ProcessDirector feature. If you want to purchase this feature, contact your Ricoh representative.
To view information for a software connector:
  1. Click Data Collectors tab, the Data Collectors tab.
    Data Collectors tab
  2. Select the software connector that you want to view in the SOFTWARE CONNECTORS list.
  3. 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

You can configure account settings on the Settings tab.
    Note:
  • Account settings are available only if you have an administrator role.
To configure account settings:
  1. Click Settings tab, the Settings tab.
  2. On the Settings tab, click Account Settings.
  3. In the Account Settings panel, configure the available settings.
    Account Settings panel

      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 Help button to display the on-screen field help.

1.3.6 Configuring User Preferences

You can configure user preferences on the Settings tab.
    Note:
  • User preferences are available only when data is received from RICOH Supervisor Data Collector.
To configure user preferences:
  1. Click Settings tab, the Settings tab.
  2. On the Settings tab, click User Preferences.
  3. In the User Preferences panel, configure the available settings.
    User Preferences panel

    For details about a specific setting, click the Help button to display the on-screen field help.

1.3.7 Configuring Notifications

Notifications help you stay aware of what is happening in your print shop and react to problems as soon as they appear. You can set notification preferences for data collectors, printer connectivity, software updates, low printer consumables, printer errors, and idle status.
    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

You can access the list of current notifications from the banner.
    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.
To view current notifications:
  1. On the banner, click Notifications button, the Notifications button.
  2. Look at the list of events in the Notifications panel.
    Notifications panel
  3. 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.
  4. To view older notifications, click Notifications History button, the Notifications History button.
    Notifications History panel

    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

You can configure notification preferences on the Settings tab.
To edit a notification:
  1. Click Settings tab, the Settings tab.
  2. On the Settings tab, click Notifications.
  3. In the Notifications panel, click Edit button, the Edit button, next to the notification that you want to edit.
    Notifications panel - Edit a notification
    Note: You can also click the notification name to start editing it.
  4. Modify the notification settings in the Edit Notification dialog box.
    Edit Notification dialog box

    The available options depend on the notification type.

    For details about a specific setting, click the Help button to display the on-screen field help.

  5. Click OK.

1.3.7.3 Enabling and Disabling Notifications

You can enable or disable notifications according to your needs.
To enable or disable a notification:
  1. Click Settings tab, the Settings tab.
  2. On the Settings tab, click Notifications.
  3. In the Notifications panel, turn the switch on or off to enable or disable a notification.
    Notifications panel - Enable 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

You can group printers by location and then use the locations for data filtering.
    Note:
  • Locations are available only when RICOH Supervisor Data Collector is installed and has registered printers.

1.3.8.1 Adding Locations

You can define locations on the Settings tab.
To add a location:
  1. Click Settings tab, the Settings tab.
  2. On the Settings tab, click Locations.
  3. In the Locations panel, click Add Location.
    Locations panel - Add location
  4. Specify the location settings in the Add Location dialog box.
    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 Help button to display the on-screen field help.

  5. 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 widgets 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

You can edit the settings of a location.
To edit a location:
  1. Click Settings tab, the Settings tab.
  2. On the Settings tab, click Locations.
  3. In the Locations panel, click Options button, the Options button, next to the location that you want to edit and select Edit.
    Locations panel
    Note: You can also click the location name to start editing it.
  4. Modify the location settings in the Edit Location dialog box.
    Edit Location dialog box

    For details about a specific setting, click the Help button to display the on-screen field help.

  5. Click OK.

1.3.8.3 Deleting Locations

You can delete locations that are no longer required.
To delete a location:
  1. Click Settings tab, the Settings tab.
  2. On the Settings tab, click Locations.
  3. In the Locations panel, click Options button, the Options button, next to the location that you want to remove and select Delete.
    Locations panel
  4. 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 widgets and filters. Make sure that you remove or recreate any widgets or filters that included the deleted location.

1.3.9 Configuring Shifts

If your print shop has work shifts, you can record them on the Settings tab. Shifts are useful for performance comparisons and for setting target metrics.
    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.

1.3.9.1 Adding Shifts

You can configure shifts on the Settings tab.
To add a shift:
  1. Click Settings tab, the Settings tab.
  2. On the Settings tab, click Shifts.
  3. In the Shifts panel, click Add Shift.
    Shifts panel - Add shift
  4. Specify the shift settings in the Add Shift dialog box.
    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.

    For details about a specific setting, click the Help button to display the on-screen field help.

  5. 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 widgets 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

You can modify shift settings.
To edit a shift:
  1. Click Settings tab, the Settings tab.
  2. On the Settings tab, click Shifts.
  3. In the Shifts panel, click Options button, the Options button, next to the shift that you want to edit and select Edit.
    Shifts panel
    Note: You can also click the shift name to start editing it.
  4. Modify the shift settings in the Edit Shift dialog box.
    Edit Shift dialog box

    For details about a specific setting, click the Help button to display the on-screen field help.

  5. Click OK.

1.3.9.3 Deleting Shifts

You can delete the shifts that you no longer need.
To delete a shift:
  1. Click Settings tab, the Settings tab.
  2. On the Settings tab, click Shifts.
  3. In the Shifts panel, click Options button, the Options button, next to the shift that you want to remove and select Delete.
    Shifts panel
  4. 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 widgets and filters. Make sure that you remove or recreate any widgets or filters that included the deleted shift.

1.4 Working with Dashboards

Dashboards are a collection of widgets that display the data provided by your data sources in a meaningful way. You can access your own dashboards and dashboards other users shared with you.
Reference: For a video presentation of the functions available in the Dashboards tab, go to Ricoh How-to Videos.
    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.

  • The time when the data in a dashboard was last updated is displayed next to the dashboard name in the time zone of the web browser that accesses RICOH Supervisor.

  • All the time-related data from the Dashboards tab is displayed in the printer time zone set in RICOH Supervisor Data Collector or in the time zone of the user's browser.

1.4.1 Creating and Managing Dashboards

Dashboards provide various functions for displaying and interacting with collected data. You can create, view, and manage dashboards from the Dashboards tab.

1.4.1.1 Creating Dashboards

You can create new dashboards and customize them according to your needs.
Reference: For a video presentation of this function, go to Ricoh How-to Videos.
To create a dashboard:
  1. Click Dashboards tab, the Dashboards tab.
  2. Click Create dashboard button, the Create dashboard button, next to Dashboards.
    Dashboards tab - Create a dashboard
    You can also right-click the dashboard panel and select New Dashboard....
  3. On the dashboard heading, enter a name for the dashboard.
    Dashboards tab - New dashboard
  4. In the Widget library panel on the right, expand the widget group and drag and drop widgets into the dashboard area.
    • To hide or display the Widget library panel, click Toggle widgets button, the Toggle widgets button.
    • The Widget library panel lists the default widgets provided with RICOH Supervisor and custom widgets that you created. For more information on the Widget library panel, see Managing the Widgets in the Widget Library. For more information on the default widgets, see Using the Default Widgets.
    • You can also create new widgets and add them to the dashboard. For more information on creating widgets, see Creating Widgets.
    Note: To avoid system performance issues, we recommend that you do not add more than 10 widgets to a dashboard.
  5. Customize the dashboard settings and content according to your needs.
    • To change the color palette, click Change dashboard color palette button, the Change dashboard color palette button, on the dashboard heading and select one of the available color palettes.

      For more information, see Changing the Dashboard Color Palette.

    • To move a widget to a different position, click the widget heading and hold the mouse button, then drag the widget to the new location.

      If you drag a widget on top of another widget, the available space is split between the two widgets.

    • To resize a widget, drag its edges right, left, up, or down.
    • To resize the widgets inside a row so they occupy an equal amount of space, click Options button, the Options button, in the corner of a widget and select Distribute widgets evenly in this row.

      If the dashboard has multiple columns, the widgets are distributed only within their column.

    • To remove a widget from the dashboard, click Options button, the Options button, in the corner of the widget and select Delete.

1.4.1.2 Viewing Dashboards

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.

Important: The dashboards are not displayed in Incognito mode. For more information, see If You Encounter a Problem.

To view a dashboard:
  1. Click Dashboards tab, the Dashboards tab.
  2. Select the dashboard that you want to view in the Dashboards list. The dashboards are grouped 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.
    Dashboards tab - View a dashboard
    Shared dashboards are marked with an asterisk (*). For more information on sharing dashboards, see Sharing Dashboards.

1.4.1.3 Editing Dashboards

To edit a dashboard, you can simply select it and start making changes.
To edit a dashboard:
  1. Click Dashboards tab, the Dashboards tab.
  2. Select the dashboard that you want to edit in the Dashboards list.
    Dashboards tab - Edit a dashboard
  3. On the dashboard heading, enter a new name for the dashboard.
  4. Customize the dashboard settings and content according to your needs.
    • To change the color palette, click Change dashboard color palette button, the Change dashboard color palette button, on the dashboard heading and select one of the available color palettes.

      For more information, see Changing the Dashboard Color Palette.

    • To move a widget to a different position, click the widget heading and hold the mouse button, then drag the widget to the new location.

      If you drag a widget on top of another widget, the available space is split between the two widgets.

    • To resize a widget, drag its edges right, left, up, or down.
    • To resize the widgets inside a row so they occupy an equal amount of space, click Options button, the Options button, in the corner of a widget and select Distribute widgets evenly in this row.

      If the dashboard has multiple columns, the widgets are distributed only within their column.

    • To remove a widget from the dashboard, click Options button, the Options button, in the corner of the widget and select Delete.

1.4.1.4 Customizing the Dashboard Layout

The dashboard layout can be easily customized by changing the number of columns and reorganizing the widgets inside the columns.
Note: This function is only available with the Self-Service feature. If you want to purchase this feature, contact your Ricoh representative.

By default, a dashboard is created with a single column and the widgets are arranged one underneath the other. When you add a new widget, it is added at the bottom of the dashboard.

You can add up to four columns to the dashboard. Each column can contain multiple widgets, but a widget cannot span more than one column. You can also drag widgets one on top of another to split the available space horizontally.

To customize the dashboard layout:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Click Options button, the Options button, on the dashboard heading and select Columns and the number of columns.
    Dashboards tab - Dashboard options
  3. To move a widget to a different column or position, click the widget heading and hold the mouse button, then drag the widget to the new location.
    You can also place widgets side-by-side using one of these methods:
    • Place each widget in a different column.
    • Drag one widget on top of the other. The available space is split between the widgets.
  4. To resize a widget, use one of these methods:
    • Resize the dashboard column that contains the widget by dragging the edge of the column right or left. All the widgets in the column are resized automatically.
    • Resize the widget by dragging its edges right, left, up, or down.
    Note: If you reduce the height of an indicator widget, it automatically turns into a ticker widget. The appearance of the ticker widget depends on the type of the original indicator widget. Ticker widgets for numeric indicators differ from ticker widgets for gauge indicators.
  5. To resize the widgets inside a row so they occupy an equal amount of space, click Options button, the Options button, in the corner of a widget and select Distribute widgets evenly in this row.
    If the dashboard has multiple columns, the widgets are distributed only within their column.
  6. To add a title to a widget directly from the dashboard, click Add Title at the top of the widget and enter the title in the text box.
  7. To change the title of a widget directly from the dashboard, click the current title and enter the new title in the text box.

1.4.1.5 Changing the Dashboard Color Palette

You can easily change the color scheme of the dashboard to match your preferences.
To change the color palette:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Click Change dashboard color palette button, the Change dashboard color palette button, on the dashboard heading and select one of the available color palettes.
    Dashboards tab - Color palette
      Note:
    • The Color Blind 1, Color Blind 2, and Color Blind 3 palettes are suitable for color blindness.

    • If you change the colors in an individual widget to colors that are not part of the palette, the new colors are applied to the widget regardless of the applied palette. If you select a new color palette for the dashboard, the widget colors change according to the new palette.

      To avoid losing your custom color settings for the widget, you can make a copy of the dashboard before applying the new color palette.

1.4.1.6 Duplicating Dashboards

You can copy an existing dashboard and use it as a starting point for a new dashboard.
To duplicate a dashboard:
  1. Click Dashboards tab, the Dashboards tab.
  2. Select the dashboard that you want to duplicate in the Dashboards list.
  3. Click Options button, the Options button, on the dashboard heading and select Duplicate.
    Dashboards tab - Dashboard options
    You can also right-click on the dashboard that you want to duplicate from the Dashboards list and select Duplicate.
  4. Select the new dashboard in the Dashboards list.
  5. On the dashboard heading, enter a new name for the dashboard.
  6. Customize the dashboard settings and content according to your needs.

1.4.1.7 Sharing Dashboards

You can share your dashboards with other users. Dashboard recipients can see the dashboards that were shared with them in the SHARED WITH ME section.
    Important:
  • This function is only available with the Self-Service feature. If you want to purchase this feature, contact your Ricoh representative.
  • When you share a dashboard, the dashboard recipients will receive a notification email.

    Dashboard recipients can see the dashboards that were shared with them in the SHARED WITH ME section.

To share a dashboard:
  1. Click Dashboards tab, the Dashboards tab.
  2. Select the dashboard that you want to share in the Dashboards list.
    Make sure that you are the owner of the selected dashboard.
  3. Click Options button, the Options button, on the dashboard heading and select Share.
    Dashboards tab - Dashboard options
  4. Specify the required settings in the Share dialog box:
    Share dialog box
    1. Enter user email addresses to set the dashboard recipients.

      To add all the users registered on the company account, enter the tenant ID. To see the tenant ID, click Account button, the Account button, select Account details, and go to Tenant ID. Only administrators can view account details.

      The contact information of the users you add is listed in the center of the dialog box.

    2. To specify how the recipients can interact with the shared dashboard, select an option from the menu available next to each user:
      • Can View: The recipients can view the dashboard but they cannot modify it.
      • Can Design: The recipients can view and modify the dashboard.

        The changes that they make in the dashboard do not affect your copy of the dashboard. These changes are automatically performed on a separate copy of the dashboard to which only they have access. Dashboard recipients can revert to your latest shared copy at any time by clicking Options button, the Options button, on the dashboard heading and selecting Restore Dashboard.

      You can also transfer dashboard ownership to an authorized user by selecting Owner.
    3. To select the users that will receive a schedule report, click the Off button for each user. The button will change in On. To subscribe all users from the list to email reports, click Subscribe All.
    4. To allow users to manage their subscription settings, click Users cannot change their subscription settings. The setting changes to Users can change their subscription settings.
    5. If the shared users can change their subscription settings, when they click Options button, the Options button, on the dashboard heading, they can select Email reports.
      Dashboards tab - Dashboard options

      In the Share dialog box, the user can cancel the subscription by disabling the subscription to report deliveries set by the dashboard owner or confirm the subscription by leaving the option enabled and clicking OK. If the subscription option is enabled, the user can also modify the settings for his schedule reports. To receive a report on demand, manage the settings for the report and click the SEND ME A REPORT NOW button.

      Share dialog box
  5. To schedule a report delivery, click Dashboards delivery tab, the Schedule report delivery tab.
    Schedule report delivery tab
    1. In the Email report content section, select the type of report that you want to send:
      • Email report: The widgets are embedded in the email message body, arranged vertically.
      • PDF attachment: The report is attached to the email as a PDF.
    2. In the Schedule section, set the time zone for sending the email reports and select the frequency for sending email notifications. You can choose from:
      • Daily: Select to send one email report at the defined time. In the Everyday field, select the days the scheduled report is to be sent. You can select multiple days. Select the hour that the email will be sent.
      • Monthly: Select to send one email report a month. In the Every month field, select the month the scheduled report is to be sent. You can select multiple months. Select Every month to send a report each month. Select the day or the days of the month and the hour that the email will be sent.
    3. Click OK.

When an owner modifies a dashboard, the dashboard is not automatically updated for recipients. The owner of the dashboard must share the updated dashboard again and the dashboard recipients must refresh their dashboard before any of the changes are applied. For more information, see Sharing Dashboard Updates.

As a dashboard owner, you can stop sharing a dashboard at any time by removing all the recipients from the Share dialog box.

1.4.1.7.1 Sharing Dashboard Updates

As a dashboard owner, when you modify a shared dashboard, the dashboard is not automatically updated for recipients. You must share the updated dashboard again and the recipients must refresh their dashboard before any of the changes are applied.
To share dashboard updates:
  1. Click Dashboards tab, the Dashboards tab, and select the dashboard that you want to share.
  2. Click Options button, the Options button, on the dashboard heading and select Share Updates.
    Note: If the dashboard did not change since the last time it was shared, the available share option is Share Again. You can use the Share Again option when you want to update the list of recipients and permissions for a shared dashboard.
  3. In the Share dialog box, update the list of recipients and their permissions as required and click OK.

1.4.1.7.2 Restoring Dashboards

If you modified a shared dashboard, you can revert to the latest copy shared by the dashboard owner at any time. When you restore a dashboard, local changes to the dashboard are overridden.
To restore a dashboard:
  1. Click Dashboards tab, the Dashboards tab, and select the dashboard that you want to restore.
  2. Click Options button, the Options button, on the dashboard heading and select Restore Dashboard.
  3. Confirm the restore action.

1.4.1.8 Deleting Dashboards

You can delete dashboards that are no longer required. The dashboard data is not affected.
To delete a dashboard:
  1. Click Dashboards tab, the Dashboards tab.
  2. Select the dashboard that you want to delete in the Dashboards list.
  3. Click Options button, the Options button, on the dashboard heading and select Delete Dashboard....
    Dashboards tab - Dashboard options
    You can also right-click on the dashboard that you want to delete from MY DASHBOARDS list and select Delete.
  4. In the confirmation dialog box, click OK.
    The dashboard is removed from the Dashboards list.
You can delete only the dashboards that you created. A dashboard that was shared with you is removed only if the owner of the dashboard deletes it or stops sharing it. Shared dashboards are marked with an asterisk (*).

1.4.2 Creating and Managing Widgets

Each widget is a dynamic visualization of data. You specify the data that you want to include in the widget and you select the type of visualization or the chart type.

1.4.2.1 Creating Widgets

You can create new widgets for your dashboard using the Widget Designer.
Note: This function is only available with the Self-Service feature. If you want to purchase this feature, contact your Ricoh representative.
To create a widget:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. If the Widget library panel is not visible, click Toggle widgets button, the Toggle widgets button, on the dashboard heading.
  3. In the Widget library panel, click Create new widget button, the Create new widget button.
    Dashboards tab - New dashboard
  4. In the Widget Designer, configure the required settings for the new widget.
    Dashboards tab - Widget Designer
    1. Enter a title for the widget in the Set a Title field.
      You can also add a widget title directly from the dashboard.
    2. Select the type of data visualization from the list in the top-left corner.
      Several types of charts are available.
    3. In the data panel on the left, select the values that you want to display in the widget and the values required for grouping the data.
      The options differ depending on the type of visualization.

      Click Add button, the Add button, next to a data section and select a field in the Add a Field dialog box.

      Dashboards tab - Widget Designer

      The icon to the left of each field indicates the type of the field:

      • Date icon Date
      • Alphanumeric icon Descriptive
      • Numeric Numeric

      Each field has a default behavior that depends on the type of data included in the field and the type of data required by the widget. For example, when the widget requires numeric values, the default aggregation method for numeric fields is Sum. You can see information about the default behavior of a field by hovering over the field.

      To change the default behavior of a field, hover over the field and click More.... You can select a different aggregation method, apply filters, or set a different time period for date fields.

    4. To manage the filters that affect the widget, click the Filters tab on the right.
    5. To customize the appearance of the widget, click the Design tab on the right.
      You can configure labels, legends, line types, and other formatting settings. The options differ depending on the type of visualization.
    6. To prevent data selections in a widget from affecting the dashboard, click Options button, the Options button, and disable the Widget affects dashboard filters option.
      By default, when you make a selection in a widget, a filter is added and applied to the dashboard according to the selected data.
    7. To give access only to predefined drill hierarchies and prevent viewers from drilling down freely to any field, click Options button, the Options button, and disable the Enable Drill to Anywhere option.
    8. To hide the title bar, click Options button, the Options button, and enable the Hide Title Bar option.
    9. To see a preview of the widget design and content, look at the preview area in the center.

      By default, the Update on Every Change option is enabled and the preview is updated automatically.

      To improve performance when you work with a large amount of data and slow query times, you can disable the Update on Every Change option. Click the Update button whenever you want to display the latest changes.

    10. To download the widget data, click Download your widget button, the Download your widget button, and select a file format.
      This option is available only after you add data to the widget. The file formats available for download depend on the widget type.
  5. Click Apply.
    Dashboards tab - Widget Designer
The new widget is added to the dashboard and to the widget library.

1.4.2.1.1 Creating an Area Chart Widget

Area charts are recommended for displaying absolute or relative values over a time period. An area chart is similar to a line chart except that the areas under each line are filled in and can be stacked.
To create an area chart:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. In the Widget library panel, click Create new widget button, the Create new widget button, to create a widget and open it in the Widget Designer.
    For more information, see Creating Widgets.
  3. In the Widget Designer, select Area Chart from the list of widget types in the top-left corner.
  4. In the data panel on the left, add data to the widget:
    1. In the X-Axis section, click Add button, the Add button, and select the field whose values you want to place on the x-axis.
      Usually, the x-axis in an area chart is used to represent time.

      You must add at least one item to the x-axis. You can add at most two items. When you add two x-axis items, the two x-axes are combined.

    2. In the Values section, click Add button, the Add button, and select the field whose values you want to place on the y-axis.
      Usually, the y-axis in an area chart is used to represent numeric data and determines the height of the area in the chart.

      You must add at least one field to the y-axis. When you add more than one field, each item is represented in the chart by its own color and area.

      Note: If one of the values uses a considerably different scale, you can add it to the right axis. Click Options button, the Options button, and select Show on Right Axis.
    3. In the Break by section, click Add button, the Add button, and select the field that you want to use to group the data represented in the chart.
      The field added in the Break by section is represented by its own area in the chart and is automatically added to the chart legend.

      You can use a Break by field under these conditions:

      • You can add only one Break by field.
      • The Break by option is available only when a single field is selected in the Values section.
      • If you used the Break by option, you can select only one field in the Values section.

  5. In the Design tab on the right, customize the appearance of the widget:
    1. Under Area Type, specify how the areas are represented in the widget.
      • Classic: Areas overlap and smaller areas appear on top of larger areas and cover them. The colors indicate the distribution between the values.
      • Stacked: Areas are stacked on top of each other and do not overlap. You can hover over the areas to see the percentage distribution among the values.
      • Stack 100: Areas are stacked on top of each other and do not overlap. The combined area is stretched to represent 100%. This option is most commonly used when the relative distribution of the values is more important than their aggregation.
    2. Under Line Type, select Straight or Smooth to specify how the line appears in the widget.
    3. Under Line Width, select Thin, Bold, or Thick.
    4. Under Legend, specify whether to show or hide the legend and set its position.
    5. Under Value Label, specify whether to show or hide labels with values and set their orientation.
    6. Under Markers, specify whether to show or hide markers over data points and set their appearance.
    7. Under X-Axis, specify whether to show or hide the x-axis and select the graphical elements that you want to include.
      These options are available:
      • Grid Lines: Displays grid lines on the x-axis.
      • Labels: Displays labels on the x-axis.
      • Title: Displays the x-axis title. You can use the default title or enter a different title in the text box.
    8. Under Y-Axis, specify whether to show or hide the y-axis and select the graphical elements that you want to include.
      These options are available:
      • Grid Lines: Displays grid lines on the y-axis.
      • Logarithmic: Displays the data using orders of magnitude.
      • Labels: Displays labels on the y-axis.
      • Title: Displays the y-axis title. You can use the default title or enter a different title in the text box.
      • Min, Max, Intervals: To change the default minimum, maximum, or interval values on the y-axis, enter new values in the text boxes. To restore any of the values to their default states, click Reset button, the Reset button.
    9. Under Auto Zoom, enable or disable the automatic zoom function.
      When a widget contains more data than can be displayed in the view, the Auto Zoom option resizes the chart automatically and, if necessary, displays a zoom bar. The zoom bar lets you scroll right and left or up and down and zoom in and out of different parts of the widget.
  6. Click Apply.

1.4.2.1.2 Creating an Area Map Widget

Area map widgets let you compare values and display categories across geographical regions. You can use area maps when you have geographical regions in your data, such as countries, states, counties, or postal codes.
To create an area map:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. In the Widget library panel, click Create new widget button, the Create new widget button, to create a widget and open it in the Widget Designer.
    For more information, see Creating Widgets.
  3. In the Widget Designer, select Area Map from the list of widget types in the top-left corner.
  4. In the data panel on the left, add data to the widget:
    1. In the Country/state section, click Add button, the Add button, and select a field that contains geographical data.
    2. In the Color section, click Add button, the Add button, and select the field whose values you want to display on the map.
  5. In the Design tab on the right, select the map type.
  6. Click Apply.

1.4.2.1.3 Creating a Bar Chart Widget

The bar chart is commonly used to compare multiple items. Bar charts display categories or items (descriptive data) along the y-axis and their values on the x-axis. You can also group the values by another category.
To create a bar chart:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. In the Widget library panel, click Create new widget button, the Create new widget button, to create a widget and open it in the Widget Designer.
    For more information, see Creating Widgets.
  3. In the Widget Designer, select Bar Chart from the list of widget types in the top-left corner.
  4. In the data panel on the left, add data to the widget:
    1. In the Categories section, click Add button, the Add button, and select the field whose values you want to place on the y-axis.
      Usually, the y-axis in a bar chart is used for descriptive data.

      You must add at least one item to the y-axis. You can add at most two items. When you add two y-axis items, the two y-axes are combined.

    2. In the Values section, click Add button, the Add button, and select the fields whose values determine the length of the bars.
      Usually, the values in a bar chart represent numeric data.

      You must add at least one field in the Values section. When you add more than one field, each item is represented in the chart by its own color and bar.

      Note: If one of the values uses a considerably different scale, you can add it to the right axis. Click Options button, the Options button, and select Show on Right Axis.
    3. In the Break by section, click Add button, the Add button, and select the field that you want to use to group the data represented in the chart.
      Each group is represented by a different bar and is automatically added to the chart legend.

      You can use a Break by field under these conditions:

      • You can add only one Break by field.
      • The Break by option is available only when a single field is selected in the Values section.
      • If you used the Break by option, you can select only one field in the Values section.

  5. In the Design tab on the right, customize the appearance of the widget:
    1. Under Bar Type, specify how the bars are represented in the widget.
      • Classic: Bars are displayed side by side.
      • Stacked: Bars are stacked one next to the other and do not overlap. You can hover over the bars to see the percentage distribution among the values.
      • Stack 100: Bars are stacked one next to the other and do not overlap. The combined bar is stretched to represent 100%. This option is most commonly used when the relative distribution of the values is more important than their aggregation.
    2. Under Legend, specify whether to show or hide the legend and set its position.
    3. Under Value Label, specify whether to show or hide labels with values and set their orientation.
    4. Under X-Axis, specify whether to show or hide the x-axis and select the graphical elements that you want to include.
      These options are available:
      • Grid Lines: Displays grid lines on the x-axis.
      • Labels: Displays labels on the x-axis.
      • Title: Displays the x-axis title. You can use the default title or enter a different title in the text box.
    5. Under Y-Axis, specify whether to show or hide the y-axis and select the graphical elements that you want to include.
      These options are available:
      • Grid Lines: Displays grid lines on the y-axis.
      • Logarithmic: Displays the data using orders of magnitude.
      • Labels: Displays labels on the y-axis.
      • Title: Displays the y-axis title. You can use the default title or enter a different title in the text box.
      • Min, Max, Intervals: To change the default minimum, maximum, or interval values on the y-axis, enter new values in the text boxes. To restore any of the values to their default states, click Reset button, the Reset button.
    6. Under Auto Zoom, enable or disable the automatic zoom function.
      When a widget contains more data than can be displayed in the view, the Auto Zoom option resizes the chart automatically and, if necessary, displays a zoom bar. The zoom bar lets you scroll right and left or up and down and zoom in and out of different parts of the widget.
  6. Click Apply.

1.4.2.1.4 Creating a Box and Whisker Plot Widget

The box and whisker plot, or box plot, is useful for representing the distribution, variability, and center of a data set along an axis.
Box plots are divided into four quartiles. The middle quartiles are represented by a box that contains 50% of the data and the median value. The upper and lower quartiles contain the maximum and minimum values and the remaining 50% of the data. These quartiles are represented by lines called whiskers.

You can adjust the maximum and minimum values when you create the box plot. By default, these values are within 1.5 times of the IQR (Interquartile Range). You can set them to the actual maximum and minimum values or to within one standard deviation of the mean of your data.

Box plots divide five descriptive statistics into four equal quartiles. You can view the statistics by hovering over the box plot.

To create a box and whisker plot:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. In the Widget library panel, click Create new widget button, the Create new widget button, to create a widget and open it in the Widget Designer.
    For more information, see Creating Widgets.
  3. In the Widget Designer, select Box and Whisker Plot from the list of widget types in the top-left corner.
  4. In the data panel on the left, add data to the widget:
    1. In the Category section, click Add button, the Add button, and select the field whose values you want to place on the x-axis.
      The x-axis in a box and whisker plot is used to represent numeric data.
    2. In the Value section, click Add button, the Add button, and select the field whose values you want to place on the y-axis.
  5. In the Design tab on the right, customize the appearance of the widget:
    1. Under Whisker values, specify how the whiskers are calculated and displayed.
      • IQR: The whisker values are calculated within 1.5 times the IQR, which represents the difference between the 1st and 3rd quartiles.
      • Extrema: The whisker values include the maximum and minimum values in the calculation.
      • Standard Deviation: The whisker values are calculated to one standard deviation above and below the mean of the data.
    2. Under Box, specify whether to display a full box or hollow box.
    3. Under Value Label, specify whether to show or hide labels with values and set their orientation.
    4. Under Legend, specify whether to show or hide the legend and set its position.
    5. Under Show Outliers, specify whether to show or hide outliers.
    6. Under X-Axis, specify whether to show or hide the x-axis and select the graphical elements that you want to include.
      These options are available:
      • Grid Lines: Displays grid lines on the x-axis.
      • Labels: Displays labels on the x-axis.
      • Title: Displays the x-axis title. You can use the default title or enter a different title in the text box.
    7. Under Y-Axis, specify whether to show or hide the y-axis and select the graphical elements that you want to include.
      These options are available:
      • Grid Lines: Displays grid lines on the y-axis.
      • Labels: Displays labels on the y-axis.
      • Title: Displays the y-axis title. You can use the default title or enter a different title in the text box.
      • Min, Max, Intervals: To change the default minimum, maximum, or interval values on the y-axis, enter new values in the text boxes. To restore any of the values to their default states, click Reset button, the Reset button.
    8. Under Auto Zoom, enable or disable the automatic zoom function.
      When a widget contains more data than can be displayed in the view, the Auto Zoom option resizes the chart automatically and, if necessary, displays a zoom bar. The zoom bar lets you scroll right and left or up and down and zoom in and out of different parts of the widget.
  6. Click Apply.

1.4.2.1.5 Creating a Calendar Heatmap Widget

The calendar heatmap widget visualizes values over days in a calendar-style view, making it easy to identify daily patterns or anomalies.
To create a calendar heatmap:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. In the Widget library panel, click Create new widget button, the Create new widget button, to create a widget and open it in the Widget Designer.
    For more information, see Creating Widgets.
  3. In the Widget Designer, select Calendar Heatmap from the list of widget types in the top-left corner.
  4. In the data panel on the left, add data to the widget:
    1. In the Date section, click Add button, the Add button, and select the date field that you want to use as the calendar.
      The range of the calendar is based on the minimum and maximum date values within the field.
    2. In the Color section, click Add button, the Add button, and select the field that determines which days to color.
  5. In the Design tab on the right, customize the appearance of the widget:
    1. Under Months, specify how many months are displayed at once.
      You can select One Month View, Quarter View, Half-Year View, or Year View.
    2. Under Calendar Type, select the display mode.
      • Classic: Each month is presented in typical calendar format.
      • Week View: Months are ordered by weekdays from top to bottom.
    3. Under Week Begins on, set the first day of the week.
    4. Under Gray out Weekends, specify whether to use gray for the weekend days.
    5. Under Show Day Number, specify whether to show the day numbers in the calendar.
    6. Under Show Day Name, specify whether to show the day name abbreviations in the calendar.
  6. Click Apply.

1.4.2.1.6 Creating a Column Chart Widget

Column charts are useful for comparing multiple items and for comparing data over time. The column chart can include multiple values on both the x-axis and y-axis. It can also include a breakdown by categories.
To create a column chart:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. In the Widget library panel, click Create new widget button, the Create new widget button, to create a widget and open it in the Widget Designer.
    For more information, see Creating Widgets.
  3. In the Widget Designer, select Column Chart from the list of widget types in the top-left corner.
  4. In the data panel on the left, add data to the widget:
    1. In the Categories section, click Add button, the Add button, and select the field whose values you want to place on the x-axis.
      Usually, the x-axis in a column chart is used for descriptive data.

      You must add at least one item to the x-axis. You can add at most two items. When you add two x-axis items, the two x-axes are grouped.

      To change the order of the categories, drag a category up or down in the Categories list.

    2. In the Values section, click Add button, the Add button, and select the fields whose values determine the height of the columns.
      Usually, the values in a column chart represent numeric data.

      You must add at least one field in the Values section. When you add more than one field, each item is represented in the chart by its own color and column.

      Note: If one of the values uses a considerably different scale, you can add it to the right axis. Click Options button, the Options button, and select Show on Right Axis.
    3. In the Break by section, click Add button, the Add button, and select the field that you want to use to group the data represented in the chart.
      Each group is represented by a different column and is automatically added to the chart legend.

      You can use a Break by field under these conditions:

      • You can add only one Break by field.
      • The Break by option is available only when a single field is selected in the Values section.
      • If you used the Break by option, you can select only one field in the Values section.

  5. In the Design tab on the right, customize the appearance of the widget:
    1. Under Column Type, specify how the columns are represented in the widget.
      • Classic: Columns are displayed side by side.
      • Stacked: Columns are stacked on top of each other and do not overlap. You can hover over the columns to see the percentage distribution among the values.
      • Stack 100: Columns are stacked on top of each other and do not overlap. The combined column is stretched to represent 100%. This option is most commonly used when the relative distribution of the values is more important than their aggregation.
    2. Under Legend, specify whether to show or hide the legend and set its position.
    3. Under Value Label, specify whether to show or hide labels with values and set their orientation.
    4. Under X-Axis, specify whether to show or hide the x-axis and select the graphical elements that you want to include.
      These options are available:
      • Grid Lines: Displays grid lines on the x-axis.
      • Labels: Displays labels on the x-axis.
      • Title: Displays the x-axis title. You can use the default title or enter a different title in the text box.
    5. Under Y-Axis, specify whether to show or hide the y-axis and select the graphical elements that you want to include.
      These options are available:
      • Grid Lines: Displays grid lines on the y-axis.
      • Logarithmic: Displays the data using orders of magnitude.
      • Labels: Displays labels on the y-axis.
      • Title: Displays the y-axis title. You can use the default title or enter a different title in the text box.
      • Min, Max, Intervals: To change the default minimum, maximum, or interval values on the y-axis, enter new values in the text boxes. To restore any of the values to their default states, click Reset button, the Reset button.
    6. Under Auto Zoom, enable or disable the automatic zoom function.
      When a widget contains more data than can be displayed in the view, the Auto Zoom option resizes the chart automatically and, if necessary, displays a zoom bar. The zoom bar lets you scroll right and left or up and down and zoom in and out of different parts of the widget.
  6. Click Apply.

1.4.2.1.7 Creating a Funnel Chart Widget

The funnel chart is especially useful for showing stages in a process that are sequentially dependent.

For example, you can use funnel charts when you want to represent a greater number of items in the first stage versus a smaller number in the final stage. You can also use them to track sequential data that moves through stages or to reveal bottlenecks in a linear production process.

Each stage in the funnel chart corresponds to a percentage. The top, thickest stage is the largest and each subsequent stage is thinner than its predecessor. If you have a stage that appears thicker than the previous stage, there might be a problem in your process.

There are two ways to create a funnel chart:

  • You can select a category along with a single value. The value is broken by the members of the category and each member appears as a separate section in the funnel chart.
  • You can select multiple values. Each value appears as a separate section in the funnel chart.

To create a funnel chart:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. In the Widget library panel, click Create new widget button, the Create new widget button, to create a widget and open it in the Widget Designer.
    For more information, see Creating Widgets.
  3. In the Widget Designer, select Funnel Chart from the list of widget types in the top-left corner.
  4. In the data panel on the left, add data to the widget:
    • If you have data fields that contain all the steps in the process, select a category along with a single value. Click Add button, the Add button, in the Categories section and select the category field. Then, click Add button, the Add button, in the Values section and select the value field.
    • If you want to include individual values in the funnel chart, add multiple value fields. Click Add button, the Add button, in the Values section and select the value fields that you want to include in the funnel chart. Each value field appears as a separate stage in the chart.
    The fields appear in the same top to bottom order in the funnel chart as they appear in the data panel. The value of the top stage is always 100% and the percentage value for each subsequent stage is derived from the top stage.
  5. In the Design tab on the right, customize the appearance of the widget:
    1. Under Funnel Size, select Wide, Regular, or Narrow.
    2. Under Funnel Type, select Regular or Pinched. The Pinched option displays the last stage as a rectangle.
    3. Under Funnel Direction, select Regular or Inverted. The Inverted option flips the funnel chart so the first stage is on the bottom and the last stage is on top.
    4. Under Legend, specify whether to show or hide the legend and set its position.
    5. Under Labels, specify the labels that you want to display in the funnel chart.
      These options are available:
      • Categories: Displays the label for each stage.
      • Percent: Displays the percentage represented by each stage. The first value in the funnel chart is considered 100%. Each subsequent value is represented as a percentage of the first value.
      • Value: Displays the numerical value of each stage.
      • Decimals: Displays the percentages with one decimal place when the Percent option is enabled.
  6. Click Apply.

1.4.2.1.8 Creating an Indicator Widget

The indicator widget provides various options for displaying one or two numeric values as a number, gauge, or ticker. You can also add a color-coded indicator icon that represents the value in the widget. For example, you can add a green up arrow or a red down arrow.
To create an indicator widget:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. In the Widget library panel, click Create new widget button, the Create new widget button, to create a widget and open it in the Widget Designer.
    For more information, see Creating Widgets.
  3. In the Widget Designer, select Indicator from the list of widget types in the top-left corner.
  4. In the data panel on the left, add data to the widget:
    1. In the Value section, click Add button, the Add button, and select the primary field.
      The name and value of the primary field are displayed as the main title and main value.
    2. In the Secondary section, click Add button, the Add button, and select the secondary field.
      The name and value of the secondary field are displayed under the main field.
    3. For gauge indicators, set the minimum and maximum values that can be represented by the gauge.
      You can enter a fixed numeric value or select a numeric field with a dynamic value in the data browser.
    For indicator widgets, you can also specify whether an icon appears in the widget and select the color of the icon. For example, you can add a red arrow pointing downwards for a negative value. For more information, see Setting Conditional Coloring.
  5. In the Design tab on the right, customize the appearance of the widget:
    1. Under Indicator Type, select Numeric or Gauge.
      Note: If you reduce the height of an indicator widget, it automatically turns into a ticker widget. The appearance of the ticker widget depends on the type of the original indicator widget. Ticker widgets for numeric indicators differ from ticker widgets for gauge indicators.
    2. Configure the options available for the selected type of indicator.
      You can select a skin and specify the components that you want to include in the widget.
  6. Click Apply.

1.4.2.1.9 Creating a Line Chart Widget

Line charts can be used for comparing data over time or for comparing changes over the same time period for more than one group or category.
To create a line chart:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. In the Widget library panel, click Create new widget button, the Create new widget button, to create a widget and open it in the Widget Designer.
    For more information, see Creating Widgets.
  3. In the Widget Designer, select Line Chart from the list of widget types in the top-left corner.
  4. In the data panel on the left, add data to the widget:
    1. In the X-Axis section, click Add button, the Add button, and select the field whose values you want to place on the x-axis.
      Usually, the x-axis in a line chart is used to represent time.

      You must add at least one item to the x-axis. You can add at most two items. When you add two x-axis items, the two x-axes are combined and a separate line is displayed for each unique value of the second x-axis.

    2. In the Values section, click Add button, the Add button, and select the field whose values you want to place on the y-axis.
      Usually, the y-axis in a line chart is used to represent numeric data and determines the height of the lines in the chart.

      You must add at least one field to the y-axis. When you add more than one field, each item is represented by its own line in the chart and is automatically added to the chart legend.

      Note: If one of the values uses a considerably different scale, you can add it to the right axis. Click Options button, the Options button, and select Show on Right Axis.
    3. In the Break by section, click Add button, the Add button, and select the field that you want to use to group the data represented in the chart.
      The field added in the Break by section is represented by its own line in the chart and is automatically added to the chart legend.

      You can use a Break by field under these conditions:

      • You can add only one Break by field.
      • The Break by option is available only when a single field is selected in the Values section.
      • If you used the Break by option, you can select only one field in the Values section.

  5. In the Design tab on the right, customize the appearance of the widget:
    1. Under Line Type, select Straight or Smooth to specify how the line appears in the widget.
    2. Under Line Width, select Thin, Bold, or Thick.
    3. Under Legend, specify whether to show or hide the legend and set its position.
    4. Under Value Label, specify whether to show or hide labels with values and set their orientation.
    5. Under Markers, specify whether to show or hide markers over data points and set their appearance.
    6. Under X-Axis, specify whether to show or hide the x-axis and select the graphical elements that you want to include.
      These options are available:
      • Grid Lines: Displays grid lines on the x-axis.
      • Labels: Displays labels on the x-axis.
      • Title: Displays the x-axis title. You can use the default title or enter a different title in the text box.
    7. Under Y-Axis, specify whether to show or hide the y-axis and select the graphical elements that you want to include.
      These options are available:
      • Grid Lines: Displays grid lines on the y-axis.
      • Logarithmic: Displays the data using orders of magnitude.
      • Labels: Displays labels on the y-axis.
      • Title: Displays the y-axis title. You can use the default title or enter a different title in the text box.
      • Min, Max, Intervals: To change the default minimum, maximum, or interval values on the y-axis, enter new values in the text boxes. To restore any of the values to their default states, click Reset button, the Reset button.
    8. Under Auto Zoom, enable or disable the automatic zoom function.
      When a widget contains more data than can be displayed in the view, the Auto Zoom option resizes the chart automatically and, if necessary, displays a zoom bar. The zoom bar lets you scroll right and left or up and down and zoom in and out of different parts of the widget.
  6. Click Apply.

1.4.2.1.10 Creating a Liquid Fill Gauge Widget

The liquid fill gauge widget is useful when you want to visualize data that represents liquid levels, such as ink usage. The liquid level rises in the gauge based on the percentage of the current value from the maximum value set for the widget.
To create a liquid fill gauge widget:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. In the Widget library panel, click Create new widget button, the Create new widget button, to create a widget and open it in the Widget Designer.
    For more information, see Creating Widgets.
  3. In the Widget Designer, select Liquid Fill Gauge from the list of widget types in the top-left corner.
  4. In the data panel on the left, add data to the widget:
    1. In the Value section, click Add button, the Add button, and select the numeric field that you want to represent in the widget.
    2. In the min and max sections, set the minimum and maximum values, which determine the level of the liquid.
      Click Add button, the Add button, and then click Create Formula button, the Create Formula button, in the top-left corner of the data browser dialog box. In the Formula Editor, enter a fixed numeric value or select a numeric field with a dynamic value.
  5. In the Design tab on the right, customize the appearance of the widget:
    1. Under Wave Rise, specify if the wave rises to its full height or if it starts at its full height when the widget loads.
    2. Under Value Count Up, specify if the displayed value counts up to the final value or if the final value is displayed when the widget loads.
    3. Under Wave Animate, specify if the wave is animated or static.
    4. Under Show Tooltip, specify whether to display the current, minimum, and maximum values when you hover over the widget.
    5. Under Wave Count, specify the maximum number of full waves that are displayed in the widget.
  6. Click Apply.
Data download to a PDF or image file is not currently supported for liquid fill gauge widgets.

1.4.2.1.11 Creating a Pie Chart Widget

Pie charts are used to display proportional data and percentages.
To create a pie chart:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. In the Widget library panel, click Create new widget button, the Create new widget button, to create a widget and open it in the Widget Designer.
    For more information, see Creating Widgets.
  3. In the Widget Designer, select Pie Chart from the list of widget types in the top-left corner.
  4. In the data panel on the left, add data to the widget:
    1. In the Categories section, click Add button, the Add button, and select the field that you want to display in the pie chart.
      You can add only one field.

      Usually, the categories of a pie chart contain descriptive data.

      Note: By default, all slices that are smaller or equal to 3% are grouped into a slice called Others. You can hover over the Others slice to display its breakdown. You can also click the Others slice to display a second pie chart that shows the breakdown of all the slices included in the Others slice.
    2. In the Values section, click Add button, the Add button, and select the field whose values determine the size of the pie slices.
      You can add only one field.

      Usually, the values in a pie chart represent numeric data.

      Note: To set the order of the slices in the pie chart, hover over the field from the Values section, click Sort button, the Sort button, and select one of the available options. You can display the slices clockwise or counter clockwise based on category percentages or clockwise based on category name.
  5. In the Design tab on the right, customize the appearance of the widget:
    1. Under Pie Type, select Classic, Donut, or Ring.
    2. Under Legend, specify whether to show or hide the legend and set its position.
    3. Under Labels, specify the labels that you want to display in the pie chart.
      These options are available:
      • Categories: Displays the label for each slice.
      • Value: Displays the numerical value of each slice.
      • Percent: Displays the percentage represented by each slice.
      • Decimals: Displays the percentages with one decimal place when the Percent option is enabled.
    4. Under Show 'Others' Slice, specify whether to group smaller slices into the Others slice or to display them individually.
      If you enable Show 'Others' Slice, you can define what is included in the Others slice:
      • Include all the slices with values less than the specified percentage. By default, the reference value is 3%.
      • Show the specified number of slices in the pie chart and group the remaining smaller slices into the Others slice. By default, the number of slices is set to 7.
  6. Click Apply.

1.4.2.1.12 Creating a Pivot Table Widget

Pivot tables are useful for summarizing and analyzing large amounts of data.
To create a pivot table:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. In the Widget library panel, click Create new widget button, the Create new widget button, to create a widget and open it in the Widget Designer.
    For more information, see Creating Widgets.
  3. In the Widget Designer, select Pivot from the list of widget types in the top-left corner.
  4. In the data panel on the left, add data to the widget:
    1. In the Rows section, click Add button, the Add button, and select the fields whose values you want to place in the rows of the pivot table.
      When you add more than one row, the rows are divided into subrows, or groups.
    2. In the Columns section, click Add button, the Add button, and select the fields whose values you want to place in the columns of the pivot table.
      You can drag and drop fields to change their order or to move them to a different section.
    3. In the Values section, click Add button, the Add button, and select the fields whose values appear in the rows and columns of the pivot table.
      Note: To add data bars to your pivot table, click Options button, the Options button, next to a value and select Data Bars.
    4. To add subtotals to rows, click Options button, the Options button, next to a row and select Subtotals.
    5. To specify how to calculate the subtotals, click Options button, the Options button, next to a field from the Values section, select Subtotal By and a method.
      The default option is Auto, which aggregates all the data. The other custom options (Sum, Min, Max, Average, Median) calculate only the values in the rows above the subtotal.
    6. To add grand totals to rows, click Options button, the Options button, next to a row and select Grand Totals.
  5. In the Design tab on the right, customize the appearance of the widget:
    1. Under Page Size, specify the number of items per page.
    2. Under Colors, select the table elements that you want to highlight.
      You can also use conditional coloring to highlight values in a pivot table. For more information, see Setting Conditional Coloring.
    3. Under Auto Height, enable or disable the automatic height function.
  6. Click Apply.
You can sort the columns of a pivot table in ascending or descending order by clicking Sort icon, the Sort icon, next to the column heading. For a more complex analysis, you can also sort the data based on one or more row fields. Click Sort icon, the Sort icon, next to a column heading and select the row fields that you want to use to sort the data.

1.4.2.1.13 Creating a Polar Chart Widget

You can use the polar chart, or radar chart, to compare multiple categories or variables with a spatial perspective in a radial chart.
To create a polar chart:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. In the Widget library panel, click Create new widget button, the Create new widget button, to create a widget and open it in the Widget Designer.
    For more information, see Creating Widgets.
  3. In the Widget Designer, select Polar Chart from the list of widget types in the top-left corner.
  4. In the data panel on the left, add data to the widget:
    1. In the Categories section, click Add button, the Add button, and select the field whose values are represented as columns in the circle.
      You can add only one field.

      Usually, the categories of a polar chart contain descriptive data.

    2. In the Values section, click Add button, the Add button, and select the field whose values determine the distance between the top of the column and the center of the polar circle.
      Usually, the values in a polar chart represent numeric data.

      When you select more than one field in the Values section, the items are stacked on top of each other.

    3. In the Break by section, click Add button, the Add button, and select the field that you want to use to group the data represented in the chart.
      The field added in the Break by section is represented by its own column and color in the chart and is automatically added to the chart legend.

      You can use a Break by field under these conditions:

      • You can add only one Break by field.
      • The Break by option is available only when a single field is selected in the Values section.
      • If you used the Break by option, you can select only one field in the Values section.

  5. In the Design tab on the right, customize the appearance of the widget:
    1. Under Polar Type, select Column, Area, or Line.
    2. Under Legend, specify whether to show or hide the legend and set its position.
    3. Under Value Label, specify whether to show or hide labels with values and set their orientation.
    4. Under Categories, specify whether to show or hide the categories and select the graphical elements that you want to include.
      These options are available:
      • Grid Lines: Displays grid lines.
      • Labels: Displays value labels.
      • Title: Displays the category title. You can use the default title or enter a different title in the text box.
    5. Under Axis, specify whether to show or hide the axis and select the graphical elements that you want to include.
      These options are available:
      • Grid Lines: Displays grid lines.
      • Logarithmic: Displays the data using orders of magnitude.
      • Labels: Displays value labels.
      • Min, Max, Intervals: To change the default minimum, maximum, or interval values on the axis, enter new values in the text boxes. To restore any of the values to their default states, click Reset button, the Reset button.
  6. Click Apply.

1.4.2.1.14 Creating a Scatter Chart Widget

The scatter chart displays the distribution of two variables along the x-axis and y-axis.
It also includes two additional dimensions of data that are shown as colored points scattered across the chart:
  • Point: A field that determines the number of points in the chart. A point is drawn for each field value.
  • Size: An optional field that determines the size of the points in the chart. The point size is relative to the field values.
To create a scatter chart:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. In the Widget library panel, click Create new widget button, the Create new widget button, to create a widget and open it in the Widget Designer.
    For more information, see Creating Widgets.
  3. In the Widget Designer, select Scatter Chart from the list of widget types in the top-left corner.
  4. In the data panel on the left, add data to the widget:
    1. In the X-Axis section, click Add button, the Add button, and select the field whose values you want to place on the x-axis.
      Usually, the x-axis in a scatter chart is used to represent numeric data. Descriptive data is also supported.

      You can add only one field.

    2. In the Y-Axis section, click Add button, the Add button, and select the field whose values you want to place on the y-axis.
      Usually, the y-axis in a scatter chart is used to represent numeric data. Descriptive data is also supported.

      You can add only one field.

    3. In the Point section, click Add button, the Add button, and select the field whose values you want to scatter across the chart as points.
      The Point field must contain descriptive data. You can add a Point field only if either the x-axis or the y-axis contains numeric data.

      You can add only one field.

    4. In the Break by/Color section, do one of these:
      • Click Add button, the Add button, and select the field that you want to use to group the data represented in the chart.

        This field must be a descriptive field. If you select descriptive data, the points in the chart are grouped into the members of the Break by field. Each member is represented by a different color.

      • Click Add button, the Add button, and select the field that you want to use to color the data in the chart.

        This field must be a numeric field. If you select numeric data, the point color is a gradient where the highest value is the darkest color and the lowest value is the lightest color.

    5. In the Size section, click Add button, the Add button, and select the field that determines the size of the points.
      This field must contain numeric data.
  5. In the Design tab on the right, customize the appearance of the widget:
    1. Under Legend, specify whether to show or hide the legend and set its position.
    2. Under Marker Size, specify the size of the points.
      If you are not using a Size field, the slider changes the size of all the points on the map. If you are using a Size field, drag each side of the slider to determine the relative minimum and maximum point sizes.
    3. Under Value Label, specify whether to show or hide labels with values and set their orientation.
    4. Under X-Axis, specify whether to show or hide the x-axis and select the graphical elements that you want to include.
      These options are available:
      • Grid Lines: Displays grid lines on the x-axis.
      • Logarithmic: Displays the data using orders of magnitude.
      • Labels: Displays labels on the x-axis.
      • Title: Displays the x-axis title. You can use the default title or enter a different title in the text box.
      • Min, Max, Intervals: To change the default minimum, maximum, or interval values on the x-axis, enter new values in the text boxes. To restore any of the values to their default states, click Reset button, the Reset button.
    5. Under Y-Axis, specify whether to show or hide the y-axis and select the graphical elements that you want to include.
      These options are available:
      • Grid Lines: Displays grid lines on the y-axis.
      • Logarithmic: Displays the data using orders of magnitude.
      • Labels: Displays labels on the y-axis.
      • Title: Displays the y-axis title. You can use the default title or enter a different title in the text box.
      • Min, Max, Intervals: To change the default minimum, maximum, or interval values on the y-axis, enter new values in the text boxes. To restore any of the values to their default states, click Reset button, the Reset button.
  6. Click Apply.

1.4.2.1.15 Creating a Scatter Map Widget

Scatter maps let you visualize geographical data as points scattered on a map. The map distinguishes data using different colors and sizes for the data points.
To create a scatter map:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. In the Widget library panel, click Create new widget button, the Create new widget button, to create a widget and open it in the Widget Designer.
    For more information, see Creating Widgets.
  3. In the Widget Designer, select Scatter Map from the list of widget types in the top-left corner.
  4. In the data panel on the left, add data to the widget:
    1. In the Location section, click Add button, the Add button, and select a field that contains geographical data.
      The supported location types are country, city, state/province, and latitude/longitude.

      To visualize latitude and longitude data, you must first add the field containing latitude data and then the field containing longitude data.

      To improve the accuracy of the map:

      • Use more than one geographic level. For example, if you have both a country and a city field, add both of them in the Location section.
      • Click the location type icon in the top-left corner of the geographic field and select Country, State/Province, or City, instead of the default Auto option.

    2. In the Color section, click Add button, the Add button, and select the field that you want to use to color the data in the chart.
      The Color field must contain numeric data. The values of this field are displayed when you hover over a data point on the map.
    3. In the Size section, click Add button, the Add button, and select the field that determines the size of the points.
      This field must contain numeric data.
    4. In the Details section, click Add button, the Add button, and select an additional data field that appears when you hover over a data point on the map.
  5. In the Design tab on the right, customize the appearance of the widget:
    1. Under Markers Style, specify the style of the data points.
    2. Under Marker Size, specify the size of the data points.
      If you are not using a Size field, the slider changes the size of all the points on the map. If you are using a Size field, drag each side of the slider to determine the relative minimum and maximum point sizes.
  6. Click Apply.

1.4.2.1.16 Creating a Sunburst Widget

The sunburst widget is similar to a pie chart but it is multi-dimensional. While a pie chart combines one descriptive field and one numeric value, the sunburst widget can display multiple rings, one for each field. Each ring in the sunburst chart shows a breakdown of its parent ring slice.
To create a sunburst widget:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. In the Widget library panel, click Create new widget button, the Create new widget button, to create a widget and open it in the Widget Designer.
    For more information, see Creating Widgets.
  3. In the Widget Designer, select Sunburst from the list of widget types in the top-left corner.
  4. In the data panel on the left, add data to the widget:
    1. In the Categories section, click Add button, the Add button, and select the fields whose values are represented as slices in the ring.
      Usually, the categories of a sunburst widget contain descriptive data.

      If you add multiple fields, each field is represented as a child ring with its values grouped based on the parent ring slice.

    2. In the Values section, click Add button, the Add button, and select the field whose values determine the size of the ring slices.
      Usually, the values in a sunburst widget represent numeric data.

      You can add only one field.

  5. In the Design tab on the right, customize the appearance of the widget:
    1. Under Center, specify the information that is displayed in the center of the widget when you hover over a slice.
      These options are available:
      • Value: Displays the actual numeric value associated with the slice.
      • Contribution: Displays the contribution of the slice to the entire field as a percentage.
      • Contribution to parent: Displays the contribution of the slice to its parent ring slice as a percentage.
    2. Under Tooltip, specify whether to show the actual value or the contribution of a slice when you hover over it.
    3. Under Legend, specify whether to show or hide the legend and set its position.
  6. Click Apply.

1.4.2.1.17 Creating a Table Widget

The table widget displays raw and non-aggregated data in columns, with as many fields and metrics as needed.
To create a table:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. In the Widget library panel, click Create new widget button, the Create new widget button, to create a widget and open it in the Widget Designer.
    For more information, see Creating Widgets.
  3. In the Widget Designer, select Table from the list of widget types in the top-left corner.
  4. In the data panel on the left, in the Columns section, click Add button, the Add button, and select the fields whose values you want to place in the columns of the table.
    You can drag and drop fields to change their order.
  5. In the Design tab on the right, customize the appearance of the widget:
    1. Under Borders, specify border settings.
    2. Under Column Width, specify how to resize the columns.
      • Manual: You can manually resize the column width by dragging the column separator.
      • Automatic: Columns are resized automatically to fit the content of the cells.
    3. Under Colors, select the table elements that you want to highlight.
    4. Under Word Wrap, specify whether to wrap text in headers and rows.
    5. Under Infinite Scroll, enable or disable the infinite scroll function.
      If the Infinite Scroll option is enabled, all the items are included in a single page. Additional data loads as you scroll down in the page.

      If the Infinite Scroll option is disabled, the items are displayed on multiple pages. You can specify the number of items per page.

    6. Under Auto Height, enable or disable the automatic height function.
  6. Click Apply.

1.4.2.1.18 Creating a Treemap Widget

The treemap widget is a multi-dimensional widget that displays hierarchical data in the form of nested rectangles. For example, you can use a treemap instead of a column chart to compare a large number of categories and subcategories.
To create a treemap:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. In the Widget library panel, click Create new widget button, the Create new widget button, to create a widget and open it in the Widget Designer.
    For more information, see Creating Widgets.
  3. In the Widget Designer, select Treemap from the list of widget types in the top-left corner.
  4. In the data panel on the left, add data to the widget:
    1. In the Categories section, click Add button, the Add button, and select the fields whose values are represented as rectangles in the chart.
      Usually, the categories in a treemap represent descriptive data.

      You can add up to three fields so that a rectangle hierarchy is created.

      To change the order of the categories, drag a category up or down in the Categories list.

    2. In the Size section, click Add button, the Add button, and select the field whose values determine the size of the rectangles.
      Usually, this field contains numeric data.

      You can add only one field.

    3. In the Color section, click Add button, the Add button, and select the field that determines the colors of the rectangles.
      This field must be one of the fields selected in the Categories section. If you add a different field, it is added to the Categories section automatically.

      The available coloring options depend on the type of the selected field:

      • If you select a numeric value, each rectangle is colored according to its place in the range of field values. You can change the color settings in the color picker dialog box.
      • If you select a descriptive field, all the rectangles that are members of the selected field have the same color. For example, if you select the field that is also used as the first category, the entire treemap is divided into groups of colors. If you select the field that is used as the second category, all the rectangles that have the same value also have the same color.

  5. In the Design tab on the right, customize the appearance of the widget:
    1. Under Captions, select the field names that you want to display in the treemap.
      The field names are always visible when you hover over a rectangle.
    2. Under Tooltip, specify whether to show the actual value or the contribution of a rectangle when you hover over it.
  6. Click Apply.

1.4.2.2 Viewing Widget Information

To view information about the widgets:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. On the dashboard, go to the widget that you want to view.
  3. Press the information button to view the widget details.
  4. Look at the information displayed.
    This information is available:
    Date
    The date the widget was updated.
    State Categories
    • Up time corresponds to these printer states: initializing, feeding, preparing, printing, processing, and receiving.
    • Idle time corresponds to these printer states: idle, ready, not ready, pre/post not ready, sleeping, shutdown, warming, started, and start-up.
    • Down time corresponds to these printer states: not available, error, restart, pre/post busy, pre/post threading, pre/post EOF, pre/post paused, cleaning, adjusting, and maintenance.
    Note: The state categories are only displayed for widgets that are using up time, down time, and idle time values from printers.

1.4.2.3 Configuring Advanced Widget Settings

When you create or edit widgets in the Widget Designer, several advanced settings are available for customizing the content, appearance, and behavior of the widget.
Note: This function is only available with the Self-Service feature. If you want to purchase this feature, contact your Ricoh representative.

1.4.2.3.1 Combining Two Types of Visualizations in a Widget

In chart widgets, such as line charts, area charts, column charts, and bar charts, you can represent one or more selected fields using a different visualization than the visualization of the original widget.
For example, in a line chart widget you can represent a specific field as a column chart.
To select a different visualization for a field in the widget:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Create or edit a widget in the Widget Designer.
    For more information, see Creating Widgets or Editing Widgets.
  3. In the Values section from the data panel on the left, click Options button, the Options button, next to the field that you want to change.
  4. Click Series Type and select the alternative visualization type that you want to use for the field.
    You can drag the field up or down in the Values section to bring its visualization to back or front.
    Note: The widget keeps the original visualization type. The Design tab displays only the design options for the original visualization type.

1.4.2.3.2 Selecting Colors in Widgets

The Widget Designer automatically assigns different colors to different field values.
You can change the default colors by selecting a specific color or a range of colors. You can also define conditional coloring that depends on the value of a field.

1.4.2.3.2.1 Selecting a Specific Color

You can assign a specific color to a data value that does not change. This color applies only to the current widget.
To select a specific color:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Create or edit a widget in the Widget Designer.
    For more information, see Creating Widgets or Editing Widgets.
  3. In the data panel on the left, click a color icon to open the color picker dialog box.
  4. Click the Single Color tab and select a color.
    Color Picker dialog box - Single tab
    To select a custom color that does not exist in the palette, enter a hexadecimal value in the # Insert Custom Color field.
  5. Click OK.

1.4.2.3.2.2 Selecting a Range of Colors

You can assign a range of colors to a field according to its value.
To select a color range:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Create or edit a widget in the Widget Designer.
    For more information, see Creating Widgets or Editing Widgets.
  3. In the data panel on the left, click a color icon to open the color picker dialog box.
  4. Click the Range tab.
    Color Picker dialog box - Range tab
  5. Select a type of configuration:
    • To assign a color range automatically, select Auto.
    • To configure the color range manually, select Manual.
  6. If you set the configuration to Manual, follow these steps:
    1. Click the color rectangles at the left and right to change the start and end colors of the range.
    2. Select the Coloring method option.
      The Min/Max option displays the full color range. The Min option displays colors for all the values between the minimum and middle values, while all other values are displayed in gray. The Max option displays colors for all the values between the middle and maximum values, while all other values are displayed in gray.
    3. To change the default minimum, middle, and maximum values, enter new values for the Customize range setting.
      By default, the color range is set to match the minimum and maximum values of the data. Instead, you can manually set the minimum and maximum values.

      All the values that are below the minimum value are assigned to the color on the left. All the values that are over the maximum value are assigned to the color on the right.

      By default, the middle color is gray. All values larger than the middle value gradually get the color on the right. All values smaller than the middle value gradually get the color on the left. You can change the middle value to specify which value is assigned to gray.

  7. For the Transition setting, select Steps to define a distinct number of colors in the range or select Gradient for a linear color range.
  8. Click OK.

1.4.2.3.2.3 Setting Conditional Coloring

You can set conditional coloring for fields based on their values.
In addition, for indicator widgets, you can also specify whether an icon appears in the widget and select the color of the icon. For example, you can add a red arrow pointing downwards for a negative value.
To set conditional coloring:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Create or edit a widget in the Widget Designer.
    For more information, see Creating Widgets or Editing Widgets.
  3. In the data panel on the left, click a color icon to open the color picker dialog box.
  4. Click the Conditional tab.
    Color Picker dialog box - Conditional tab
    Each row in this tab represents a condition that you can apply to the values of the field. If the condition is true, the value is shown in the color that you select in the row. For example, one row can specify that a negative value is displayed in red and another row can specify that a positive value is displayed in green.
  5. In each row, define an expression to be applied to the value of this field by selecting an operator and specifying a value.
  6. Select a color for the field.
  7. To add and define more conditions, click Add condition.
    In the dashboard, the conditions are evaluated in the order in which they appear in this tab, from top to bottom. The first condition that is true determines the color. You can reorder the conditions by dragging them up or down.
  8. Click OK.

1.4.2.3.3 Sorting Field Values in Widgets

By default, the values that you add to a widget are not sorted. You can select a sorting option to specify the order in which the items are displayed.
To sort field values:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Create or edit a widget in the Widget Designer.
    For more information, see Creating Widgets or Editing Widgets.
  3. In the data panel on the left, hover over a field and click Sort button, the Sort button.
  4. Select Ascending or Descending.

1.4.2.3.4 Renaming Fields in Widgets

The names of fields in widgets are taken from the raw data. You can change the names of the fields according to your needs.
To rename a field in a widget:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Create or edit a widget in the Widget Designer.
    For more information, see Creating Widgets or Editing Widgets.
  3. In the data panel on the left, click Options button, the Options button, next to a field and select Rename.
  4. Enter a new field name.
    The new name is used only in the current widget. It does not appear in the data browser or in other widgets in the dashboard.

1.4.2.3.5 Formatting Numbers in Widgets

You can change the way numbers are displayed in widgets. For example, you can display a number as a percentage and set the number of decimal places.
To format numbers in a widget:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Create or edit a widget in the Widget Designer.
    For more information, see Creating Widgets or Editing Widgets.
  3. In the data panel on the left, hover over a numeric field and click Format Number button, the Format Number button.
  4. In the Format Number dialog box:
    • To display the value as a number, click the Number tab and configure options for abbreviations, decimal places, and thousands separator.
    • To display the value as currency, click the Currency tab and configure options for abbreviations, decimal places, and currency symbols.
    • To display the value as a percentage, click the Percent tab and configure options for decimal places.
    You can preview your settings in the preview area at the bottom of the dialog box.
  5. Click OK.

1.4.2.3.6 Formatting Date and Time Values in Widgets

You can change the format of the date and time values that are displayed in your widgets.
To format date and time values in a widget:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Create or edit a widget in the Widget Designer.
    For more information, see Creating Widgets or Editing Widgets.
  3. In the data panel on the left, hover over a date field and click Format Date button, the Format Date button.
  4. In the Format Date dialog box, select one of the tabs on the left to specify the format for years, quarters, months, weeks, days, and time values.
    You can select one of the predefined formats or specify a custom format.
  5. Click OK.

1.4.2.3.7 Creating a Continuous Chart with Missing Date Values

If your data is missing date values, you can add the missing dates to your chart to create a continuous data flow. You can also specify whether to display missing dates as gaps in the chart or to include null values as zero values to avoid gaps and maintain a continuous data flow.
For example, if your chart begins on June 8 and ends on June 20 and there is no value for June 13, you can choose to include the missing date on the x-axis. You can also specify whether to continue the graph by creating zero values or to cut the graph where there are missing values.
To create a continuous chart:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Create or edit a widget that is based on a Cartesian chart in the Widget Designer.
    For more information, see Creating Widgets or Editing Widgets.
  3. In the X-Axis section, click Options button, the Options button, next to a date field and select Continuous Timeline.
  4. To treat null values as zero values, click Options button, the Options button, in the Values section, and select Display Missing Values as Zeros.

1.4.2.3.8 Adding Drill Hierarchies to Widgets

Viewers can drill down in a widget and get an in-depth view of a selected value.
While viewers can select a drill path from the complete list of fields, it is easier to select a drill hierarchy from a predefined list. This is especially useful when there is a large amount of data and viewers need to remember specific fields and select them each time.

As a self-service user, you can add predefined drill hierarchies to widgets.

Note: Your administrator must first create the drill hierarchies before you can add them in the Widget Designer.
To enable drill hierarchies in a widget:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Create or edit a widget in the Widget Designer.
    For more information, see Creating Widgets or Editing Widgets.
  3. In the data panel on the left, click Options button, the Options button, next to a field and select Hierarchies....
  4. Select the check box next to the drill hierarchies that you want to make available to dashboard viewers.
    Hierarchies with a lock icon always appear in the widget. To unlock this option, contact your administrator.

1.4.2.3.9 Disabling the Drill to Anywhere Option

As a self-service user, you can give access only to predefined drill hierarchies and prevent viewers from drilling down freely to any field.
To disable the Enable Drill to Anywhere option:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Create or edit a widget in the Widget Designer.
    For more information, see Creating Widgets or Editing Widgets.
  3. Click Options button, the Options button, and disable the Enable Drill to Anywhere option.
    As a result, the Choose Another… option is removed from the drill options displayed for the widget.

1.4.2.4 Editing Widgets

Using the Widget Designer, you can modify the content, appearance, and behavior of a widget.
Note: This function is only available with the Self-Service feature. If you want to purchase this feature, contact your Ricoh representative.
To edit a widget:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
    Make sure that you have editing rights for the selected dashboard.
  2. On the dashboard, go to the widget that you want to edit.
  3. Click Edit Widget button, the Edit Widget button, in the corner of the widget.
    Dashboards tab - Edit widget
  4. Modify the widget settings in the Widget Designer and click Apply.
    Dashboards tab - Edit widget settings
    Note: If you want to duplicate the widget and edit the copy instead of the original widget, click Options button, the Options button, and select Save a Copy.

    For more information on using the Widget Designer, see Creating Widgets.

1.4.2.5 Analyzing Trends in Widget Data

In widgets that show data over time, you can add trend lines and apply advanced analytic models to highlight tendencies in the data and get useful insights.
Dashboards tab - Widget trend line
    Note:
  • This function is only available for area charts, bar charts, column charts, line charts, and polar charts.
  • Only time series with a single date dimension are supported. If the widget contains multiple data fields in the Categories section, this function is not available.
  • This function is not available if a sorting option is applied to the value fields included in the widget.
  • Using a Break by field is not supported.
  • Null values might disrupt the calculations of the models and affect accuracy.
To analyze trends in widget data:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. On the dashboard, go to the widget that you want to work with.
  3. Click Analyze It button, the Analyze It button, select Trend, and enable the Show Trend option.
    Dashboards tab - Analyze data

    If the widget includes multiple value fields, you must select the field that you want to analyze before enabling the Show Trend option.

  4. To customize the trend line settings, select Trend Settings.
    Dashboards tab - Trend settings
    • Under Trend Variable, you can see the value field that is analyzed for the trend line.
    • Under Trend Type, you can specify the type of trend line:
      Linear Trend
      Adds a straight line that shows if the trend is increasing or decreasing. A linear trend line is useful when the values are increasing or decreasing at a steady rate.
      Logarithmic Trend
      Adds a best-fit curved line that shows whether the data converges within time. A logarithmic trend line is useful when the rate of change in the data increases or decreases quickly and then levels out.
    • In the Compare To section, you can add a second trend line that lets you compare the current trend to data from a previous time period.

      Select a time period from the list and enable the Compare To option. Equivalent data must be available for the selected time period.

      For example, you can compare the trend for the daily number of jobs from this month with the trend from the previous month.

  5. To view information about the trend data, select Trend Information.
    Dashboards tab - Trend information

Once the trend line is added to the widget, you can click it at any time to open the Quick Settings dialog box and make any required changes.

You can also add trend lines from the Widget Designer. In the data panel on the left, hover over the value field that you want to analyze and click Analyze It button, the Analyze It button.

1.4.2.6 Duplicating Widgets

You can create a copy of a widget. This function is useful for saving the original widget in the dashboard before making changes. The new widget is separate from the original widget and no changes to the new widget affect the original widget.
Note: This function is only available with the Self-Service feature. If you want to purchase this feature, contact your Ricoh representative.
To duplicate a widget:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. On the dashboard, go to the widget that you want to duplicate.
  3. Click Options button, the Options button, in the corner of the widget and select Duplicate.
    Dashboards tab - Widget options
    Note: You can also duplicate a widget that is open in the Widget Designer. Click Options button, the Options button, and select Save a Copy. A copy is created and displayed in the Widget Designer instead of the original widget.

1.4.2.7 Removing Widgets from the Dashboard

You can remove widgets from a dashboard. The widget data is not affected.
To remove a widget from a dashboard:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. On the dashboard, go to the widget that you want to delete.
  3. Click Options button, the Options button, in the corner of the widget and select Delete.
    Dashboards tab - Widget options
  4. Confirm the delete action.

1.4.3 Managing the Widgets in the Widget Library

You can edit or delete the custom widgets that you created from the Widget library panel.
    Note:
  • This function is only available with the Self-Service feature. If you want to purchase this feature, contact your Ricoh representative.
  • You cannot delete or modify the default widgets. You can only delete and modify custom widgets. In the Widget library panel, the Add to dashboard button Add to dashboard button is displayed next to default widgets and the Options button Options button is displayed next to custom widgets.

    For viewers, the Add to dashboard button Add to dashboard button is displayed next to custom widgets as well.

  • Custom widgets appear at the end of the list under the default widgets. For more information on the default widgets, see Using the Default Widgets.
  • In the Widget library panel, the widgets are grouped into categories, including Printer Throughput, Printer Utilization, Job Performance, Errors, Consumables, RICOH API for Fiery, Custom Widgets and RICOH ProcessDirector. The RICOH ProcessDirector widget category is only available with the RICOH ProcessDirector feature. If you want to purchase this feature, contact your Ricoh representative.
To manage the widgets in the library:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. If the Widget library panel is not visible, click Toggle widgets button, the Toggle widgets button, on the dashboard heading.
  3. In the Widget library panel:
    1. To edit a custom widget, click Options button, the Options button, and select Edit.
      The widget opens in the Widget Designer. For more information on using the Widget Designer, see Creating Widgets.
    2. To delete a custom widget, click Options button, the Options button, and select Delete.

1.4.4 Using the Default Dashboards and Filters

The default dashboards contain several predefined widgets, which interpret and display the data provided by your data collectors and software connectors. You can access the default dashboards from the Dashboards tab after you start gathering data.
Reference: For a video presentation of the default dashboards and filters, go to Ricoh How-to Videos.
To use the default dashboards and filters:
  1. Click Dashboards tab, the Dashboards tab.
  2. In the Dashboards list, select the Capacity Planning (Impressions), Ink Consumption (Inkjet printers only), Job Insights, Printer Utilization, or RICOH ProcessDirector dashboard.
    Dashboards tab - Default 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 errors and error duration to help you find the jobs that caused the most errors.

    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 error durations and error types.

    For more information, see Printer Utilization Dashboard.

    RICOH ProcessDirector dashboard

    Displays information collected from RICOH ProcessDirector.

    For more information, see RICOH ProcessDirector Default Dashboard.

  3. To interact with the widgets from the default dashboards:
    • To display additional details, hover over the data in the widgets.
    • To select data in a widget and filter the dashboard according to the selected data, click an item in the widget.

      In chart widgets, you can drag the cursor to draw the area that you want to select, then release the mouse button and click Select in the menu.

      For more information, see Making Selections in a Widget.

    • To drill down into data and get an in-depth view of a selected value, right-click an item in the widget and select a drilling option.

      For more information, see Drilling down in a Widget.

    • To analyze trends in widget data, click Analyze It button, the Analyze It button, select Trend, and enable the Show Trend option.

      This function is only available for area charts, bar charts, column charts, line charts, and polar charts.

      For more information, see Analyzing Trends in Widget Data.

    • To download widget data, click Options button, the Options button, in the corner of the widget, then select Download and a file format.

      For more information, see Downloading Widget Data.

  4. To filter the data in the dashboard using the default filters:
    • To display or hide the Filters panel, click Toggle filters button, the Toggle filters button, on the dashboard heading.
    • To edit a filter, use one of these methods:
      • Click Edit Filter button, the Edit Filter button, next to the filter name to open the Edit Filter dialog box and modify the filter settings.
      • Expand the filter and select or clear the check box next to the values that you want to include or exclude.
    • To enable or disable a filter, turn the switch next to the filter on or off.

      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.

    • To save the current state of the filters and their settings, click Options button, the Options button, at the top of the Filters panel and select Set as My Default Filters.

      To restore the saved filters, click Restore my default filters button, the Restore my default filters button.

    For more information on using filters, see Working with Filters. For more information on the filters defined for each default dashboard, see Capacity Planning (Impressions) Dashboard, Job Insights Dashboard, Printer Utilization Dashboard or RICOH ProcessDirector Default Dashboard.
  5. To download the dashboard data as a PDF file or a PNG image, click Options button, the Options button, on the dashboard heading, then select Download and a file format.
  6. To customize the default dashboards:
    • To change the color palette, click Change dashboard color palette button, the Change dashboard color palette button, on the dashboard heading and select one of the available color palettes.

      For more information, see Changing the Dashboard Color Palette.

    • To move a widget to a different position, click the widget heading and hold the mouse button, then drag the widget to the new location.

      If you drag a widget on top of another widget, the available space is split between the two widgets.

    • To resize a widget, drag its edges right, left, up, or down.
    • To resize the widgets inside a row so they occupy an equal amount of space, click Options button, the Options button, in the corner of a widget and select Distribute widgets evenly in this row.
    • To remove a widget from the dashboard, click Options button, the Options button, in the corner of the widget and select Delete.

    All the changes are applied to a local copy of the default dashboards and do not affect the original versions.

  7. To duplicate a default dashboard and use it as a starting point for a new dashboard, click Options button, the Options button, on the dashboard heading and select Duplicate.
    For more information, see Duplicating Dashboards.
If you modified a default dashboard, such as changing the color palette or editing the filter settings, you can revert to the original version of the dashboard at any time. Click Options button, the Options button, on the dashboard heading and select Restore Dashboard. All the local changes to the dashboard are overridden.

1.4.4.1 Capacity Planning (Impressions) Dashboard

The default 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.
    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.

Dashboards tab - Capacity Planning (Impressions) dashboard

These default widgets are included in the Capacity Planning (Impressions) dashboard:

ANNUAL VOLUME
Widget type: Polar chart
Displays the total number of printed impressions per year. Includes data from both cut sheet and continuous form printers.
MONTHLY VOLUME
Widget type: Column chart
Displays the total number of printed impressions per month. Includes data from both cut sheet and continuous form printers.
DAILY VOLUME - BEST & WORST CALENDAR DAYS
Widget type: Calendar heatmap

Displays a calendar with the daily number of printed impressions. Includes data from both cut sheet and continuous form printers.

The days in the calendar are displayed with different shades of blue according to the minimum and maximum throughput values:

  • Light blue icon Days with the minimum throughput value are displayed with the lightest shade of blue.
  • Light blue range icon Days with a throughput value closer to the minimum value are displayed with lighter shades of blue.
  • Dark blue range icon Days with a throughput value closer to the maximum value are displayed with darker shades of blue.
  • Dark blue icon Days with the maximum throughput value are displayed with the darkest shade of blue.

PRINTERS WITH HIGHEST VOLUME FOR SELECTED DATES
Widget 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
Widget type: Area 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
Widget 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 filters are defined for the Capacity Planning (Impressions) dashboard:

Date Range
Lets you filter the data based on a specific data collecting period. By default, the data in the dashboard is limited to the current quarter.

When you edit the filter, you can also switch from a time frame filter to a different type of time filter. To switch to a list filter, which lets you select specific years, quarters, months, weeks, days, or time intervals, select the List tab. To switch to a calendar filter, which lets you select custom date ranges from a calendar, select the Calendar tab.

The data is selected based on the time zone of the web browser that accesses RICOH Supervisor. The first day of the week is Monday.

Location Name Printer Name Shift Name

This set of dependent filters lets you display data only for specific locations, printers, and shifts.

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 widgets 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 widgets 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.

By default, all locations, printers, and shifts are included.

1.4.4.2 Ink Consumption (Inkjet printers only) Dashboard

The default dashboard provides information for ink consumption by tracking the monthly and daily ink usage and the ink consumption per printer and per job.
    Note:
  • This dashboard requires data from RICOH Supervisor Data Collector.

All the time-related data from the Ink Consumption 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.

Dashboards tab - I Consumption dashboard

These default widgets are included in the Ink Consumption dashboard:

MONTHLY INK USAGE - ALL PRINTERS (LITERS)
Widget type: Area chart
Displays the total ink usage per month, measured in liters. Includes data from all inkjet printers.
DAILY INK USAGE - HIGHEST TO LOWEST
Widget type: Calendar
Displays the days with the highest to lowest daily ink usage. Includes data from all inkjet printers.
INK USAGE PER PRINTER (LITER)
Widget type: 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) - HIGHEST 20
Widget type: 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.

1.4.4.3 Job Insights Dashboard

The default 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 errors and error duration to help you find the jobs that caused the most errors.
    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.

Dashboards tab - Job Insights dashboard

These default widgets are included in the Job Insights dashboard:

PAGES PRINTED FOR SELECTED DATES
Widget type: 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
Widget type: 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
Widget type: 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
Widget type: 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
Widget type: 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
Widget type: 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 ERRORS VERSUS ERROR DURATION
Widget type: Scatter chart

Displays the number of errors and error duration for jobs that encountered a printer error. 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 error duration. The color of the dots ranges from yellow to red based on the number of errors, with red being used for the highest value.

For increased accuracy, a Printer Error Sequence filter is applied to the widget. 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 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 and are not included in the widget.

ERRORS BY DURATION FOR SELECTED JOBS
Widget type: Bar chart

Displays the printer errors 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 Error Sequence filter is applied to the widget. 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 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 and are not included in the widget.

These filters are defined for the Job Insights dashboard:

Date Range
Lets you filter the data based on a specific data collecting period. By default, the data in the dashboard is limited to the current quarter.

When you edit the filter, you can also switch from a time frame filter to a different type of time filter. To switch to a list filter, which lets you select specific years, quarters, months, weeks, days, or time intervals, select the List tab. To switch to a calendar filter, which lets you select custom date ranges from a calendar, select the Calendar tab.

The data is selected based on the time zone of the web browser that accesses RICOH Supervisor. The first day of the week is Monday.

Job Name

Lets you display data only for specific jobs.

By default, all jobs are included.

Location Name Printer Name Shift Name

This set of dependent filters lets you display data only for specific locations, printers, and shifts.

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 widgets 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 widgets 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.

By default, all locations, printers, and shifts are included.

1.4.4.4 Printer Utilization Dashboard

The default 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 error durations and error types.
    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.

Dashboards tab - Printer Utilization dashboard

These default widgets are included in the Printer Utilization dashboard:

DAILY UTILIZATION
Widget 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 widget, 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 widget.

You can use the slider to focus on a specific range of data.

PRINTER UTILIZATION FOR SELECTED DATES
Widget type: 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 widget, 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 widget.

You can use the slider to focus on a specific range of data.

IMPRESSIONS PER HOUR FOR SELECTED DATES
Widget 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
Widget type: Bar 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.

ERROR DURATION PER PRINTER FOR SELECTED DATES
Widget type: Bar chart

Displays the total error duration per printer, 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 Error Sequence filter is applied to the widget. 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 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 and are not included in the widget.

ERROR TYPE DURATION TREEMAP FOR SELECTED PRINTERS AND DATES
Widget type: Treemap

Displays the error type distribution for the printers and the time period specified in the Filters panel. Includes data from both cut sheet and continuous form printers.

Each error message is represented by a rectangle. The size of the rectangles depends on the error duration. The color of the rectangles ranges from orange to red also based on the error duration, with red being used for the highest value.

For increased accuracy, a Printer Error Sequence filter is applied to the widget. 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 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 and are not included in the widget.

These filters are defined for the Printer Utilization dashboard:

Date Range
Lets you filter the data based on a specific data collecting period. By default, the data in the dashboard is limited to the current quarter.

When you edit the filter, you can also switch from a time frame filter to a different type of time filter. To switch to a list filter, which lets you select specific years, quarters, months, weeks, days, or time intervals, select the List tab. To switch to a calendar filter, which lets you select custom date ranges from a calendar, select the Calendar tab.

The data is selected based on the time zone of the web browser that accesses RICOH Supervisor. The first day of the week is Monday.

Location Name Printer Name Shift Name

This set of dependent filters lets you display data only for specific locations, printers, and shifts.

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 widgets 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 widgets 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.

By default, all locations, printers, and shifts are included.

1.4.4.5 RICOH ProcessDirector Default Dashboard

The RICOH ProcessDirector default dashboard displays information collected from RICOH ProcessDirector.

All the time-related data from the RICOH ProcessDirector dashboard is displayed in the time zone of your browser.

Dashboards tab - RICOH ProcessDirector dashboard

These default widgets are included in the RICOH ProcessDirector dashboard:

Total print volume
Widget type: Line chart
Shows the total printed number of sheets and pages daily.
Volume by printer
Widget type: Bar chart
Shows the total printed number of sheets and pages for each printer.
Volume by customer
Widget type: Bar chart
Shows the total number of sheets and pages printed for each customer.
Volume by location
Widget type: Bar chart

Shows the total number of sheets and pages printed at each location.

Volume by printer operator
Widget type: Bar chart

Shows the total number of sheets and pages scheduled for printing by each user.

1.4.5 Using the Default Widgets

RICOH Supervisor provides several default widgets so that you can easily create dashboards with meaningful data.
The default widgets are available in the Widget library panel and in the default dashboards.

1.4.5.1 Using the Default Widgets for Data from RICOH Supervisor Data Collector

RICOH Supervisor provides several default widgets that are available for data from RICOH Supervisor Data Collector.
The default widgets are available in the Widget library panel and in the default dashboards.

These widgets are available by default:

ANNUAL VOLUME
Widget type: Polar chart
Displays the total number of printed impressions per year. Includes data from both cut sheet and continuous form printers.
AVERAGE JOB DURATION
Widget type: 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.
AVERAGE JOB SIZE
Widget type: Indicator
Displays the average job size based on the number of printed pages. Includes data from both cut sheet and continuous form printers.
CLICKS PER PRINTER
Widget type: Pivot

Displays the overall values provided by each printer for black-and-white printer clicks, full-color printer clicks, single-color and two-color printer clicks, and total printer clicks. Only includes data from cut sheet printers.

The total printer clicks value does not include the number of fifth station printer clicks, except for jobs that are printed only with fifth station toner.

CLICKS TODAY
Widget type: Indicator

Displays the total number of printer clicks for the current day and the daily average. Only includes data from cut sheet printers.

The total printer clicks value does not include the number of fifth station printer clicks, except for jobs that are printed only with fifth station toner.

DAILY CLICKS
Widget type: Area chart

Displays the total number of printer clicks per day. Only includes data from cut sheet printers.

The total printer clicks value does not include the number of fifth station printer clicks, except for jobs that are printed only with fifth station toner.

DAILY CLICKS PER PRINTER
Widget type: Pivot

Displays the daily values provided by each printer for black-and-white printer clicks, full-color printer clicks, single-color and two-color printer clicks, and total printer clicks. Only includes data from cut sheet printers.

The total printer clicks value does not include the number of fifth station printer clicks, except for jobs that are printed only with fifth station toner.

DAILY ERRORS BY PRINTER
Widget type: Column Chart

Displays the error type distribution for the 10 printers with the highest number of errors for the current day. Includes data from both cut sheet and continuous form printers.

For increased accuracy, a Printer Error Sequence filter is applied to the widget. 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 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 and are not included in the widget. If you want to view older data, edit the widget and include the N\A value in the Printer Error Sequence filter.

DAILY IMPRESSIONS
Widget type: Line chart
Displays the number of printed impressions per day. Includes data from both cut sheet and continuous form printers.
DAILY IMPRESSIONS
Widget type: Indicator
Displays the number of printed impressions for the current day and the best daily result. Includes data from both cut sheet and continuous form printers.
DAILY INK USAGE - HIGHEST TO LOWEST
Widget type: Calendar
Displays the days with the highest to lowest daily ink usage. Includes data from all inkjet printers.
DAILY JOBS PRINTED BY PRINTER
Widget type: Bar chart
Displays the top 10 performing printers based on the total number of printed jobs for the current day. Includes data from both cut sheet and continuous form printers.
DAILY THROUGHPUT (PAPER LENGTH)
Widget type: Indicator

Displays the length of paper printed for the current day, measured in feet or meters, and the best daily result. Only includes data from continuous form printers.

The unit of measurement depends on the Length unit option specified under Settings User Preferences.

DAILY THROUGHPUT (PAPER LENGTH)
Widget type: Line chart

Displays the length of paper printed per day, measured in feet or meters. Only includes data from continuous form printers.

The unit of measurement depends on the Length unit option specified under Settings User Preferences.

DAILY THROUGHPUT (SHEETS)
Widget type: Indicator
Displays the number of printed sheets for the current day and the best daily result. Includes data from both cut sheet and continuous form printers.
DAILY THROUGHPUT (SHEETS)
Widget type: Line chart
Displays the number of printed sheets per day. Includes data from both cut sheet and continuous form printers.
DAILY UTILIZATION
Widget 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 widget, 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 widget.

You can use the slider to focus on a specific range of data.

DAILY UTILIZATION BY PRINTER
Widget type: Bar chart

Displays the up time, idle time, and down time percentages for the 10 printers with the highest up time values for the current 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 widget, 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 widget.

DAILY VOLUME - BEST & WORST CALENDAR DAYS
Widget type: Calendar heatmap

Displays a calendar with the daily number of printed impressions. Includes data from both cut sheet and continuous form printers.

The days in the calendar are displayed with different shades of blue according to the minimum and maximum throughput values:

  • Light blue icon Days with the minimum throughput value are displayed with the lightest shade of blue.
  • Light blue range icon Days with a throughput value closer to the minimum value are displayed with lighter shades of blue.
  • Dark blue range icon Days with a throughput value closer to the maximum value are displayed with darker shades of blue.
  • Dark blue icon Days with the maximum throughput value are displayed with the darkest shade of blue.

ERROR DURATION PER PRINTER FOR SELECTED DATES
Widget type: Bar chart

Displays the total error duration per printer, 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 Error Sequence filter is applied to the widget. 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 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 and are not included in the widget. If you want to view older data, edit the widget and include the N\A value in the Printer Error Sequence filter.

ERROR TYPE DURATION TREEMAP FOR SELECTED PRINTERS AND DATES
Widget type: Treemap

Displays the error type distribution for the printers and the time period specified in the Filters panel. Includes data from both cut sheet and continuous form printers.

Each error message is represented by a rectangle. The size of the rectangles depends on the error duration. The color of the rectangles ranges from orange to red also based on the error duration, with red being used for the highest value.

For increased accuracy, a Printer Error Sequence filter is applied to the widget. 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 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 and are not included in the widget. If you want to view older data, edit the widget and include the N\A value in the Printer Error Sequence filter.

ERRORS BY DURATION FOR SELECTED JOBS
Widget type: Bar chart

Displays the printer errors 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 Error Sequence filter is applied to the widget. 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 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 and are not included in the widget. If you want to view older data, edit the widget and include the N\A value in the Printer Error Sequence filter.

IMPRESSIONS PER HOUR FOR SELECTED DATES
Widget 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
Widget type: Bar 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.

INK USAGE PER PRINTER (LITER)
Widget type: 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) - HIGHEST 20
Widget type: 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.

JOB INK USAGE - THIS WEEK (TOP 1000)
Widget type: Bar Chart

Displays the total amount of cyan, magenta, yellow, black, and MICR (magnetic ink character recognition) ink used for the 1000 jobs with the highest black ink usage for the current week. Only includes data from InfoPrint 5000, RICOH Pro VC40000, RICOH Pro VC60000, RICOH Pro VC70000, and RICOH Pro VC80000 printers.

The first day of the week is Monday.

The ink data included for each job depends on the printer type:

InfoPrint 5000 black and white printers
The total amount of K1 and K2 ink used, measured in liters.
InfoPrint 5000 color printers
The total amount of cyan, magenta, yellow, black, and MICR ink used, measured in liters. MICR ink data is based on the total amount of K1 and K2 ink used on engine 3.
RICOH Pro VC printers
The total amount of cyan, magenta, yellow, and black ink used for printing and flushing the printhead, measured in liters.

To track ink usage for InfoPrint 5000 printers, you must upload ink data for each printer on the Data Collectors tab. For more information, see Uploading Ink Data for InfoPrint 5000 Printers.

For RICOH Pro VC40000, RICOH Pro VC60000, RICOH Pro VC70000, and RICOH Pro VC80000 printers, make sure that you use the RICOH Pro VC printer type configuration in RICOH Supervisor Data Collector.

JOBS 1-SIDED / 2-SIDED
Widget type: Pie chart
Displays the percentage of 1-sided jobs and 2-sided jobs from the total number of printed jobs. Includes data from both cut sheet and continuous form printers.
JOBS BY NUMBER OF ERRORS VERSUS ERROR DURATION
Widget type: Scatter chart

Displays the number of errors and error duration for jobs that encountered a printer error. 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 error duration. The color of the dots ranges from yellow to red based on the number of errors, with red being used for the highest value.

For increased accuracy, a Printer Error Sequence filter is applied to the widget. 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 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 and are not included in the widget. If you want to view older data, edit the widget and include the N\A value in the Printer Error Sequence filter.

JOBS PRINTED
Widget type: Area chart
Displays the number of printed jobs per day, for the last 7 days. Includes data from both cut sheet and continuous form printers.
JOBS PRINTED / ABORTED
Widget type: Pie chart
Displays the percentage of printed jobs and aborted jobs from the total number of jobs. Includes data from both cut sheet and continuous form printers.
JOBS PRINTED FOR SELECTED DATES
Widget type: 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.
JOBS PRINTED PER PRINTER
Widget type: Column chart
Displays the number of printed jobs and aborted jobs per printer. Includes data for both cut sheet and continuous form printers.
JOBS PRINTED TODAY
Widget type: 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.
MONTHLY BLACK INK USAGE (LITER)
Widget type: Liquid Fill Gauge

Displays the total amount of black ink used in the current month, measured in liters. Only includes data from InfoPrint 5000, RICOH Pro VC40000, RICOH Pro VC60000, RICOH Pro VC70000, and RICOH Pro VC80000 printers.

The liquid level rises based on the percentage of the current value from the maximum value. The maximum value is set to 100000.

The ink data included for each printer depends on the printer type:

InfoPrint 5000 black and white printers
The total amount of K1 and K2 ink used on both engines.
InfoPrint 5000 color printers
The total amount of black ink used on both engines.
RICOH Pro VC printers
The total amount of black ink used on both engines for printing and flushing the printhead.

To track ink usage for InfoPrint 5000 printers, you must upload ink data for each printer on the Data Collectors tab. For more information, see Uploading Ink Data for InfoPrint 5000 Printers.

For RICOH Pro VC40000, RICOH Pro VC60000, RICOH Pro VC70000, and RICOH Pro VC80000 printers, make sure that you use the RICOH Pro VC printer type configuration in RICOH Supervisor Data Collector.

MONTHLY CLICKS
Widget type: Area chart

Displays the total number of printer clicks per month. Only includes data from cut sheet printers.

The total printer clicks value does not include the number of fifth station printer clicks, except for jobs that are printed only with fifth station toner.

MONTHLY CLICKS
Widget type: Indicator

Displays the total number of printer clicks for the current month and the best monthly result. Only includes data from cut sheet printers.

The total printer clicks value does not include the number of fifth station printer clicks, except for jobs that are printed only with fifth station toner.

MONTHLY CLICKS PER PRINTER
Widget type: Pivot

Displays the monthly values provided by each printer for black-and-white printer clicks, full-color printer clicks, single-color and two-color printer clicks, and total printer clicks. Only includes data from cut sheet printers.

The total printer clicks value does not include the number of fifth station printer clicks, except for jobs that are printed only with fifth station toner.

MONTHLY CYAN INK USAGE (LITER)
Widget type: Liquid Fill Gauge

Displays the total amount of cyan ink used in the current month, measured in liters. Only includes data from InfoPrint 5000, RICOH Pro VC40000, RICOH Pro VC60000, RICOH Pro VC70000, and RICOH Pro VC80000 printers.

The liquid level rises based on the percentage of the current value from the maximum value. The maximum value is set to 100000.

The ink data included for each printer depends on the printer type:

InfoPrint 5000 color printers
The total amount of cyan ink used on both engines.
RICOH Pro VC printers
The total amount of cyan ink used on both engines for printing and flushing the printhead.

To track ink usage for InfoPrint 5000 printers, you must upload ink data for each printer on the Data Collectors tab. For more information, see Uploading Ink Data for InfoPrint 5000 Printers.

For RICOH Pro VC40000, RICOH Pro VC60000, RICOH Pro VC70000, and RICOH Pro VC80000 printers, make sure that you use the RICOH Pro VC printer type configuration in RICOH Supervisor Data Collector.

MONTHLY ERRORS BY PRINTER
Widget type: Column Chart

Displays the error type distribution for the 10 printers with the highest number of errors for the current month. Includes data from both cut sheet and continuous form printers.

For increased accuracy, a Printer Error Sequence filter is applied to the widget. 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 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 and are not included in the widget. If you want to view older data, edit the widget and include the N\A value in the Printer Error Sequence filter.

MONTHLY IMPRESSIONS
Widget type: Indicator
Displays the number of printed impressions for the current month and the best monthly result. Includes data from both cut sheet and continuous form printers.
MONTHLY INK USAGE - ALL PRINTERS (LITER)
Widget type: Area chart
Displays the total ink usage per month, measured in liters. Includes data from all inkjet printers.
MONTHLY JOBS PRINTED BY PRINTER
Widget type: Bar chart
Displays the top 10 performing printers based on the total number of printed jobs for the current month. Includes data from both cut sheet and continuous form printers.
MONTHLY MAGENTA INK USAGE (LITER)
Widget type: Liquid Fill Gauge

Displays the total amount of magenta ink used in the current month, measured in liters. Only includes data from InfoPrint 5000, RICOH Pro VC40000, RICOH Pro VC60000, RICOH Pro VC70000, and RICOH Pro VC80000 printers.

The liquid level rises based on the percentage of the current value from the maximum value. The maximum value is set to 100000.

The ink data included for each printer depends on the printer type:

InfoPrint 5000 color printers
The total amount of magenta ink used on both engines.
RICOH Pro VC printers
The total amount of magenta ink used on both engines for printing and flushing the printhead.

To track ink usage for InfoPrint 5000 printers, you must upload ink data for each printer on the Data Collectors tab. For more information, see Uploading Ink Data for InfoPrint 5000 Printers.

For RICOH Pro VC40000, RICOH Pro VC60000, RICOH Pro VC70000, and RICOH Pro VC80000 printers, make sure that you use the RICOH Pro VC printer type configuration in RICOH Supervisor Data Collector.

MONTHLY MICR INK USAGE (LITER)
Widget type: Liquid Fill Gauge

Displays the total amount of MICR (magnetic ink character recognition) ink used in the current month, measured in liters. Only includes data from InfoPrint 5000 color printers.

The liquid level rises based on the percentage of the current value from the maximum value. The maximum value is set to 100000.

MICR ink data is based on the total amount of K1 and K2 ink used on engine 3.

To track ink usage for InfoPrint 5000 printers, you must upload ink data for each printer on the Data Collectors tab. For more information, see Uploading Ink Data for InfoPrint 5000 Printers.

MONTHLY THROUGHPUT (PAPER LENGTH)
Widget type: Indicator

Displays the length of paper printed for the current month, measured in feet or meters, and the best monthly result. Only includes data from continuous form printers.

The unit of measurement depends on the Length unit option specified under Settings User Preferences.

MONTHLY THROUGHPUT (SHEETS)
Widget type: Indicator
Displays the number of printed sheets for the current month and the best monthly result. Includes data from both cut sheet and continuous form printers.
MONTHLY UTILIZATION BY PRINTER
Widget type: Bar chart

Displays the up time, idle time, and down time percentages for the 10 printers with the highest up time values for the current month. 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 widget, 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 widget.

MONTHLY VOLUME
Widget type: Column chart
Displays the total number of printed impressions per month. Includes data from both cut sheet and continuous form printers.
MONTHLY YELLOW INK USAGE (LITER)
Widget type: Liquid Fill Gauge

Displays the total amount of yellow ink used in the current month, measured in liters. Only includes data from InfoPrint 5000, RICOH Pro VC40000, RICOH Pro VC60000, RICOH Pro VC70000, and RICOH Pro VC80000 printers.

The liquid level rises based on the percentage of the current value from the maximum value. The maximum value is set to 100000.

The ink data included for each printer depends on the printer type:

InfoPrint 5000 color printers
The total amount of yellow ink used on both engines.
RICOH Pro VC printers
The total amount of yellow ink used on both engines for printing and flushing the printhead.

To track ink usage for InfoPrint 5000 printers, you must upload ink data for each printer on the Data Collectors tab. For more information, see Uploading Ink Data for InfoPrint 5000 Printers.

For RICOH Pro VC40000, RICOH Pro VC60000, RICOH Pro VC70000, and RICOH Pro VC80000 printers, make sure that you use the RICOH Pro VC printer type configuration in RICOH Supervisor Data Collector.

PAGES PRINTED FOR SELECTED DATES
Widget type: 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.
PAGES PRINTED TODAY
Widget type: 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.
PEAK PRODUCTION DAYS
Widget type: Area 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
Widget 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.
PRINTER INK USAGE - THIS MONTH (TOP 30)
Widget type: Column Chart

Displays the total amount of cyan, magenta, yellow, black, and MICR (magnetic ink character recognition) ink used in the current month for the 30 printers with the highest black ink usage. Only includes data for InfoPrint 5000, RICOH Pro VC40000, RICOH Pro VC60000, RICOH Pro VC70000, and RICOH Pro VC80000 printers.

The ink data included for each printer depends on the printer type:

InfoPrint 5000 black and white printers
The total amount of K1 and K2 ink used on both engines, measured in liters.
InfoPrint 5000 color printers
The total amount of cyan, magenta, yellow, and black ink used on both engines and the total amount of MICR ink used, measured in liters. MICR ink data is based on the total amount of K1 and K2 ink used on engine 3.
RICOH Pro VC printers
The total amount of cyan, magenta, yellow, and black ink used on both engines for printing and flushing the printhead, measured in liters.

To track ink usage for InfoPrint 5000 printers, you must upload ink data for each printer on the Data Collectors tab. For more information, see Uploading Ink Data for InfoPrint 5000 Printers.

For RICOH Pro VC40000, RICOH Pro VC60000, RICOH Pro VC70000, and RICOH Pro VC80000 printers, make sure that you use the RICOH Pro VC printer type configuration in RICOH Supervisor Data Collector.

PRINTER STATUS (CUMULATIVE)
Widget type: Pie chart

Displays the percentage of time the printers reported a specific status. Includes data from both cut sheet and continuous form printers.

Printer status values with smaller percentages are grouped in the Others category. You can click Others to display a second pie chart that shows percentages for the status values in the Others category.

Event duration values are retrieved from the printers in milliseconds. In the widget, 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 widget.

Note: If you drill down into the Error category to display percentages for every error code, the sum of the duration values listed for the error codes does not match the overall duration for the Error category. The event duration values are registered individually for every error code even when several error events overlap and cover the same time interval. For the Error category, overlapping error events are not registered separately.
PRINTER THROUGHPUT (IMPRESSIONS)
Widget type: Column chart
Displays the number of printed impressions per printer. Includes data for both cut sheet and continuous form printers.
PRINTER THROUGHPUT (PAPER LENGTH)
Widget type: Column chart

Displays the length of paper printed per printer, measured in feet or meters. Only includes data for continuous form printers.

The unit of measurement depends on the Length unit option specified under Settings User Preferences.

PRINTER THROUGHPUT (SHEETS)
Widget type: Column chart
Displays the number of printed sheets per printer. Includes data for both cut sheet and continuous form printers.
PRINTER UTILIZATION
Widget type: Column chart

Displays the up time, idle time, and down time per printer. 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 widget, 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 widget.

PRINTER UTILIZATION FOR SELECTED DATES
Widget type: 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 widget, 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 widget.

You can use the slider to focus on a specific range of data.

PRINTERS WITH HIGHEST VOLUME FOR SELECTED DATES
Widget 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.

THROUGHPUT (CLICKS) - BEST & WORST CALENDAR DAYS
Widget type: Calendar heatmap

Displays a calendar with the daily number of total printer clicks. Only includes data from cut sheet printers.

The days in the calendar are displayed with different colors according to the maximum, minimum, and average total clicks values:

  • Green icon Days with the maximum total clicks value are displayed with green.
  • Light green icon Days with a total clicks value equal to or above the average value are displayed with a light shade of green.
  • Light red icon Days with a total clicks value below the average value are displayed with a light shade of red.
  • Red icon Days with the minimum total clicks value are displayed with red.

The total printer clicks value does not include the number of fifth station printer clicks, except for jobs that are printed only with fifth station toner.

THROUGHPUT (IMPRESSIONS) - BEST & WORST CALENDAR DAYS
Widget type: Calendar heatmap

Displays a calendar with the daily number of printed impressions. Includes data from both cut sheet and continuous form printers.

The days in the calendar are displayed with different colors according to the maximum, minimum, and average throughput values:

  • Green icon Days with the maximum throughput value are displayed with green.
  • Light green icon Days with a throughput value equal to or above the average value are displayed with a light shade of green.
  • Light red icon Days with a throughput value below the average value are displayed with a light shade of red.
  • Red icon Days with the minimum throughput value are displayed with red.

THROUGHPUT (PAPER LENGTH) - BEST & WORST CALENDAR DAYS
Widget type: Calendar heatmap

Displays a calendar with the daily length of paper printed, measured in feet or meters. Only includes data from continuous form printers.

The unit of measurement depends on the Length unit option specified under Settings User Preferences.

The days in the calendar are displayed with different colors according to the maximum, minimum, and average throughput values:

  • Green icon Days with the maximum throughput value are displayed with green.
  • Light green icon Days with a throughput value equal to or above the average value are displayed with a light shade of green.
  • Light red icon Days with a throughput value below the average value are displayed with a light shade of red.
  • Red icon Days with the minimum throughput value are displayed with red.

THROUGHPUT (PAPER LENGTH) - PEAK HOURS
Widget type: Line chart

Displays the overall peak hours based on the total hourly length of paper printed, measured in feet or meters. Only includes data from continuous form printers.

The unit of measurement depends on the Length unit option specified under Settings User Preferences.

THROUGHPUT (SHEETS) - BEST & WORST CALENDAR DAYS
Widget type: Calendar heatmap

Displays a calendar with the daily number of printed sheets. Includes data from both cut sheet and continuous form printers.

The days in the calendar are displayed with different colors according to the maximum, minimum, and average throughput values:

  • Green icon Days with the maximum throughput value are displayed with green.
  • Light green icon Days with a throughput value equal to or above the average value are displayed with a light shade of green.
  • Light red icon Days with a throughput value below the average value are displayed with a light shade of red.
  • Red icon Days with the minimum throughput value are displayed with red.

THROUGHPUT (SHEETS) - PEAK HOURS
Widget type: Line chart
Displays the overall peak hours based on the total hourly number of printed sheets. Includes data from both cut sheet and continuous form printers.
UTILIZATION (ALL PRINTERS)
Widget type: Line chart

Displays the overall printer up time, idle time, and down time per day, for the last 30 days. 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 widget, 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 widget.

WEEKLY CLICKS
Widget type: Indicator

Displays the total number of printer clicks for the current week and the weekly average. Only includes data from cut sheet printers.

The first day of the week is Monday.

The total printer clicks value does not include the number of fifth station printer clicks, except for jobs that are printed only with fifth station toner.

WEEKLY CLICKS
Widget type: Area chart

Displays the total number of printer clicks per week. Only includes data from cut sheet printers.

The first day of the week is Monday.

The total printer clicks value does not include the number of fifth station printer clicks, except for jobs that are printed only with fifth station toner.

WEEKLY ERRORS BY PRINTER
Widget type: Column Chart

Displays the error type distribution for the 10 printers with the highest number of errors for the current week. Includes data from both cut sheet and continuous form printers.

The first day of the week is Monday.

For increased accuracy, a Printer Error Sequence filter is applied to the widget. 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 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 and are not included in the widget. If you want to view older data, edit the widget and include the N\A value in the Printer Error Sequence filter.

WEEKLY IMPRESSIONS
Widget type: Indicator

Displays the number of printed impressions for the current week and the best weekly result. Includes data from both cut sheet and continuous form printers.

The first day of the week is Monday.

WEEKLY JOBS PRINTED BY PRINTER
Widget type: Bar chart

Displays the top 10 performing printers based on the total number of printed jobs for the current week. Includes data from both cut sheet and continuous form printers.

The first day of the week is Monday.

WEEKLY THROUGHPUT (PAPER LENGTH)
Widget type: Indicator

Displays the length of paper printed for the current week, measured in feet or meters, and the best weekly result. Only includes data from continuous form printers.

The unit of measurement depends on the Length unit option specified under Settings User Preferences.

The first day of the week is Monday.

WEEKLY THROUGHPUT (SHEETS)
Widget type: Indicator

Displays the number of printed sheets for the current week and the best weekly result. Includes data from both cut sheet and continuous form printers.

The first day of the week is Monday.

WEEKLY UTILIZATION BY PRINTER
Widget type: Bar chart

Displays the up time, idle time, and down time percentages for the 10 printers with the highest up time values for the current week. Includes data from both cut sheet and continuous form printers.

The first day of the week is Monday.

The up time, down time, and idle time values are retrieved from the printers in milliseconds. In the widget, 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 widget.

    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 in the default widgets is 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.
  • Depending on the printer, the number of printed sheets and printed impressions is either retrieved directly from the printer or calculated in RICOH Supervisor Data Collector. For more information, see Data Fields.
  • The number of printer clicks is based on the data received from the printer counters and does not include scanner and copier clicks. If a printer does not provide any click data, RICOH Supervisor displays 0 for the number of clicks. For information on the printer counters, see the printer documentation.

    How the clicks are counted also depends on the printer. For example, some printers only provide the total number of printer clicks and do not send separate data for black-and-white clicks, full-color clicks, or single-color and two-color clicks.

    While RICOH Supervisor Data Collector is stopped, no click data is received from the printer. The clicks value is synchronized with the printer counters when RICOH Supervisor Data Collector is restarted.

    Click data is retrieved only for cut sheet printers.

  • The up time, down time, and idle time data metrics are calculated based on the printer state:
    • Up time corresponds to these printer states: initializing, feeding, preparing, printing, processing, and receiving.
    • Idle time corresponds to these printer states: idle, ready, not ready, pre/post not ready, sleeping, shutdown, warming, started, and start-up.
    • Down time corresponds to these printer states: not available, error, restart, pre/post busy, pre/post threading, pre/post EOF, pre/post paused, cleaning, adjusting, and maintenance.

    For printers with duplex, triplex, or dual-simplex configuration, the up time and idle time values are increased 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 down time value is increased.

  • 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.

    The printing side information is not available for TotalFlow Print Server cut sheet printers.

  • Data download to a PDF or image file is not currently supported for liquid fill gauge widgets.

1.4.5.2 Using the Default Widgets for Data from RICOH ProcessDirector

RICOH Supervisor provides several default widgets that are available for data from RICOH ProcessDirector.
The default widgets are available in the RICOH ProcessDirector dashboard.

These widgets are available by default:

TOTAL PRINT VOLUME
Widget type: Line chart
Shows the total printed number of sheets and pages daily.
VOLUME BY PRINTER
Widget type: Bar chart
Shows the total printed number of sheets and pages for each printer.
VOLUME BY CUSTOMER
Widget type: Bar chart
Shows the total number of sheets and pages printed for each customer.
VOLUME BY LOCATION
Widget type: Bar chart

Shows the total number of sheets and pages printed at each location.

VOLUME BY PRINTER OPERATOR
Widget type: Bar chart

Shows the total number of sheets and pages scheduled for printing by each user.

    Important:
  • All the time-related data in the default widgets is displayed in the printer time zone set in RICOH Supervisor Data Collector.

1.4.6 Making Selections in a Widget

You can click a specific portion of a widget to select it. The dashboard is filtered according to the selected data and a filter is automatically added to the Filters panel.
Note: You can also use the selection to drill down in the widget. For more information, see Drilling down in a Widget.
To select data in a widget:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. On the dashboard, go to the widget that you want to work with.
  3. Click an item in the widget to select it and to add a dashboard filter according to the selection.
    To select multiple items, hold the Ctrl key, click the items, then release the Ctrl key and click Select in the menu.

    In chart widgets, you can drag the cursor to draw the area that you want to select, then release the mouse button and click Select in the menu.

To clear the selection, click Clear Selection at the top of the widget.

1.4.7 Drilling down in a Widget

You can drill down into data in most widgets to get an in-depth view of a selected value.
To drill down in a widget:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. On the dashboard, go to the widget that you want to work with.
  3. Right-click an item in the widget and select a drilling option.
    • To select the drill path manually, select Drill Into..., and then select a field in the Drill into a Field dialog box.

      If you have already drilled into this widget, shortcuts to previously selected fields are available.

    • To use a predefined drill hierarchy, select one of the hierarchies available under Drill.

      If you want to drill into a different field, you can select Choose Another…, and then select a field in the Drill into a Field dialog box.

    Drilling into a widget
  4. To drill up to a higher level, click a previous drill level at the top of the widget.
    To drill back all the way to the top, click Close icon, the Close icon.

1.4.8 Downloading Data and Creating Reports

Downloading the content of dashboards and widgets is useful when you want to share your data or create reports and presentations.
Dashboard data can be downloaded as a PDF file or a PNG image. Widget data can be downloaded as a PNG image, CSV file, PDF file, or Excel file, depending on the widget type.
Note: Data download to a PDF or image file is not currently supported for liquid fill gauge widgets.

1.4.8.1 Downloading Dashboard Data as an Image File

You can save the current dashboard data as a PNG image file.
To download dashboard data as an image file:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Click Options button, the Options button, on the dashboard heading and select Download Download Image.
    Dashboards tab - Dashboard options
  3. In the Download Image dialog box, specify formatting settings for the image.
    Download Image dialog box
    1. From the Size (Width) list, select the image size.
    2. In the Data section, select the information that you want to include.
  4. Click Download.
  5. Save the file to your computer.
    The procedure for saving the file depends on the web browser.
    Note:
  • Japanese characters and the Japanese date format are not currently supported in the name of the downloaded PNG file. You can rename the file after you download it.
  • When you download dashboard data as a PNG file, default data field names are retrieved directly from the database and might not always match the names displayed on the user interface.

1.4.8.2 Downloading Dashboard Data as a PDF File

You can save the current dashboard data as a PDF file.
To download dashboard data as a PDF file:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Click Options button, the Options button, on the dashboard heading and select Download Download PDF.
    Dashboards tab - Dashboard options
  3. In the PDF Report Settings dialog box, specify formatting settings for the report:
    PDF Report Settings dialog box
    1. From the Paper Size list, select one of the available paper sizes.
    2. In the Orientation section, select Portrait or Landscape.
    3. In the Header section, set the header type and select the information that you want to include.
    4. In the Footer section, select the Page Number check box if you want to add page numbers to the report pages.
    5. In the preview panel, switch to Edit mode, then drag the separator lines to modify the area available for each widget.
    Note: You can click the Save button to save the specified formatting settings for future PDF reports created from the current dashboard. When you click Save, the PDF Report Settings dialog box closes and you must restart the download procedure.
  4. Click Download button, the Download button.
  5. Download the file to your computer.
    The procedure for downloading the file depends on the web browser.
    Note:
  • Japanese characters and the Japanese date format are not currently supported in the name of the downloaded PDF file. You can rename the file after you download it.
  • When you download dashboard data as a PDF file, default data field names are retrieved directly from the database and might not always match the names displayed on the user interface.

1.4.8.3 Downloading Widget Data

You can download widget data as a PNG image, CSV file, PDF file, or Excel file. The file formats available for download depend on the widget type.
To download widget data:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. On the dashboard, go to the widget that you want to export.
  3. Click Options button, the Options button, in the corner of the widget, select Download and a file format.
    Dashboards tab - Widget options
  4. Save the file to your computer.
    The procedure for saving the file depends on the web browser.
Note: If a widget contains a large amount of data, many columns, or complex calculations, the export to an Excel file might fail. Try filtering the widget data and reducing the number of columns.

1.4.9 Working with Filters

Filters affect the data that is displayed in the dashboard and let you focus on specific areas.

1.4.9.1 Creating Dashboard Filters

Dashboard filters affect all the widgets in the dashboard, except for the widgets that you configured as independent.
Note: This function is only available with the Self-Service feature. If you want to purchase this feature, contact your Ricoh representative.
To create a dashboard filter:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Click Toggle filters button, the Toggle filters button, on the dashboard heading.
    Dashboards tab - Filters panel
  3. In the Filters panel, click Filter Your Dashboard.
    If other filters are already defined, click Create button, the Create button, at the top of the Filters panel to add a new filter.
  4. In the Add Filter dialog box, configure the settings required for the new filter.
    Add Filter dialog box - Select field
    1. Select the field that you want to use for the filter.
    2. Select a type of filter from the tabs on the left.
      Several types of filters are available, including List, Text, Values, Calendar, Time Frame, and Ranking. The available options depend on whether the selected field is a numeric field, a text field, or a date.
      Add Filter dialog box - Configure filter
    3. Specify filtering details in the panel on the right.
      The settings depend on the type of filter that you are creating:
    4. To save the filter and add it to the Starred tab for future use, click Favorite button, the Favorite button.
      You can save the filter with the default name or specify a different name.

      Saved filters are useful when you want to quickly add a new filter with the same field type or to update a filter to reflect the unique parameters defined in the saved filter.

      Your saved filters are visible to recipients when you share the dashboard.

    5. Click OK to filter the data in the dashboard and add the new filter to the Filters panel.
    After a filter is added to the dashboard, it is displayed in the Filters panel and it is automatically turned on. Any changes that you make to the filter are immediately reflected in the dashboard.
      Note:
    • To reorder the filters in the Filters panel, drag a filter above or below another filter.
    • To rename a filter, click Options button, the Options button, and select Rename. Enter the new filter name in the text box.

1.4.9.1.1 Creating a List Filter

List filters let you specify whether selected field values are included or excluded.
To create a list filter:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Click Toggle filters button, the Toggle filters button, on the dashboard heading.
  3. In the Filters panel, click Filter Your Dashboard.
    If other filters are already defined, click Create button, the Create button, at the top of the Filters panel to add a new filter.
  4. In the Add Filter dialog box, follow these steps:
    1. Select a field.
    2. Click the List tab.
      Add Filter dialog box - List filter
    3. Select or clear the check box next to the values that you want to include or exclude.
      By default, list filters let you select multiple values. To switch to single selection, click Selection type icon, the Selection type icon in the top-right corner.
    4. Click OK.

1.4.9.1.2 Creating a Text Filter

Text filters let you filter data based on text matching.
To create a text filter:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Click Toggle filters button, the Toggle filters button, on the dashboard heading.
  3. In the Filters panel, click Filter Your Dashboard.
    If other filters are already defined, click Create button, the Create button, at the top of the Filters panel to add a new filter.
  4. In the Add Filter dialog box, follow these steps:
    1. Select a text field.
    2. Click the Text tab.
      Add Filter dialog box - Text filter
    3. Select the operator.
      Multiple operators are available, including Starts With, Ends With, Containing, Equals, Doesn't Start With, Doesn't End With, Doesn't Contain, and Doesn't Equal.
    4. Enter the value by which to filter.
      The list of results is displayed in the preview area.
    5. To add more conditions, click Add condition.
      To specify how filter operators are combined, select AND or OR from the use menu.
    6. Click OK.

1.4.9.1.3 Creating a Numeric Value Filter

Numeric value filters let you limit the dashboard data to specific value ranges. For example, you can display only printer clicks under a certain value.
To create a numeric value filter:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Click Toggle filters button, the Toggle filters button, on the dashboard heading.
  3. In the Filters panel, click Filter Your Dashboard.
    If other filters are already defined, click Create button, the Create button, at the top of the Filters panel to add a new filter.
  4. In the Add Filter dialog box, follow these steps:
    1. Select a numeric field.
    2. Click the Values tab.
      Add Filter dialog box - Numeric value filter
    3. Select the operator.
      Multiple operators are available, including Equals, Not Equal to, Smaller than, Equal or smaller than, Greater than, Equal or greater than, and Between.
    4. Enter the value by which to filter.
      The list of results is displayed in the preview area.
    5. To add more conditions, click Add condition.
      To specify how filter operators are combined, select AND or OR from the use menu.
    6. Click OK.

1.4.9.1.4 Creating a Ranking Filter

Ranking filters let you include only the top ranking or bottom ranking field values.
To create a ranking filter:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Click Toggle filters button, the Toggle filters button, on the dashboard heading.
  3. In the Filters panel, click Filter Your Dashboard.
    If other filters are already defined, click Create button, the Create button, at the top of the Filters panel to add a new filter.
  4. In the Add Filter dialog box, follow these steps:
    1. Select a field.
    2. Click the Ranking tab.
      Add Filter dialog box - Ranking filter
    3. Select Top or Bottom and the number of items to include.
    4. Next to Ranked by, select a field by which to rank the data.
      The list of results is displayed in the preview area.
    5. Click OK.

1.4.9.1.5 Creating a Calendar Filter

Calendar filters let you select custom date ranges from a calendar.
To create a calendar filter:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Click Toggle filters button, the Toggle filters button, on the dashboard heading.
  3. In the Filters panel, click Filter Your Dashboard.
    If other filters are already defined, click Create button, the Create button, at the top of the Filters panel to add a new filter.
  4. In the Add Filter dialog box, follow these steps:
    1. Select a date field.
    2. Click the Calendar tab.
      Add Filter dialog box - Calendar filter
    3. Use the quick navigation menu to jump to a point in time.
    4. Select a date range using one of these methods:
      • Select a start date and an end date from the calendar.
      • Enter the start date and the end date in the From and To fields.
      • Click Today, Earliest Date, or Latest Date.

        Earliest Date and Latest Date refer to the earliest and latest dates with data.

    5. Click OK.

When they interact with time filters, viewers can change the filter type. For example, they can switch between Calendar and Time Frame.

1.4.9.1.6 Creating a Time Frame Filter

Time frame filters let you filter dashboards to preset dynamic time frames, such as Last Year, Last 2 Quarters, or Last Week.
To create a time frame filter:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Click Toggle filters button, the Toggle filters button, on the dashboard heading.
  3. In the Filters panel, click Filter Your Dashboard.
    If other filters are already defined, click Create button, the Create button, at the top of the Filters panel to add a new filter.
  4. In the Add Filter dialog box, follow these steps:
    1. Select a date field.
    2. Click the Time Frame tab.
      Add Filter dialog box - Time frame filter
    3. Select Years, Quarters, Months, Weeks, or Days from the menu.

      The data is selected based on the time zone of the web browser that accesses RICOH Supervisor. The first day of the week is Monday.

    4. Select a time period.
    5. Click OK.

When they interact with time filters, viewers can change the filter type. For example, they can switch between Calendar and Time Frame.

1.4.9.1.7 Using Wildcard Characters in Filters

To filter lists or text quickly, you can use wildcard characters such as underscore (_) or percent (%), which function as placeholders.
These wildcard characters are supported:
Single Characters
You can enter an underscore (_) as a placeholder for a single unknown character.
Multiple Characters
You can enter a percent (%) symbol as a placeholder for zero or more characters.
Escape Characters
If you are searching for a string with an underscore or percent symbol, add a backslash (\) in front of the special character. The backslash is treated as an escape character.

1.4.9.1.8 Configuring Advanced Filtering Criteria

You can define advanced filtering criteria that are not included in the predefined settings.
To define advanced filtering criteria:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Click Toggle filters button, the Toggle filters button, on the dashboard heading.
  3. In the Filters panel, click Filter Your Dashboard.
    If other filters are already defined, click Create button, the Create button, at the top of the Filters panel to add a new filter.
  4. In the Add Filter dialog box, follow these steps.
    1. Select the field that you want to use for the filter.
    2. Click the Advanced tab.
      Add Filter dialog box - Advanced tab
    3. Write the filtering criteria in the script panel.
    4. To see the results of the filtering criteria, click Test.
    5. Click OK.
In this example an OR statement is used to display multiple printer names:Add Filter dialog box - Advanced tab

1.4.9.1.9 Creating Dependent Filters

Dependent filters let you combine multiple dashboard filters into a hierarchy. The filters affect each other from parent to child, to grandchild, and so on. When you filter the parent field, fewer options are available for the child filter.

For example, you can narrow the results to find a specific job by setting the location name, the printer name, and the job name as dependent filters. After you select a location, only printers from that location are displayed. After you select a printer, only jobs from that printer are displayed.

Note: By default, filters are not dependent. Dependent filters can be defined only for list filters.
To create a dependent filter:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Click Toggle filters button, the Toggle filters button, on the dashboard heading.
  3. In the Filters panel, create and configure the parent filter.
    For more information on creating filters, see Creating Dashboard Filters.
  4. On the parent filter, click Add a dependent filter button, the Add a dependent filter button or click Options button, the Options button, and select Add a Dependent Filter.
  5. Configure the child filter.
    There are fewer options available for selection in the child filter because of the selections in the parent filter.

    The child filter appears under the parent filter with a down arrow on its heading, which shows the filter hierarchy.

  6. Repeat the steps for each new child filter to create multiple levels of dependent filters.

1.4.9.1.10 Limiting Filters to Specific Values with Background Filters

Background filters let you limit the data that is exposed to viewers or reduce the amount of filtering required.
You can define which of the fields in a filter are visible to viewers. Then, viewers can use the updated and restricted filter to further filter the dashboard using the available fields.

This function is useful when viewers require only specific data and would need to search through a long list of fields or when you do not want to expose all the data for security purposes.

For example, if a simple list filter initially includes a list of 10 locations, you can limit the filter to include only 5 specified locations. Viewers can see only these 5 locations when they set the filter.

For a ranking filter that requires only the top 5 locations based on the number of printers to be included in the list, viewers can still see only 5 locations. However, the list of locations changes as the number of printers changes.

To use background filters:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Click Toggle filters button, the Toggle filters button, on the dashboard heading.
  3. In the Filters panel, create a background filter using one of these methods:
    • For a filter without selected values, click Options button, the Options button, select Create Background Filter, configure the filter settings, and click OK.
    • For a filter that already has specific values selected, click Options button, the Options button, and select Set as Background Filter.

    The background filter is marked with a filter icon. The filter icon is not visible to viewers.

  4. To edit a background filter:
    1. Click Options button, the Options button, and select Edit Background Filter.
    2. Update the filter settings and click OK.
  5. To remove a background filter, click Options button, the Options button, and select Remove Background Filter.

1.4.9.2 Editing Dashboard Filters

You can modify the filters that are applied to a dashboard.
To edit a dashboard filter:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Click Toggle filters button, the Toggle filters button, on the dashboard heading.
    Dashboards tab - Filters panel
  3. In the Filters panel, go to the filter that you want to edit and do one of these:
    • Expand the filter and modify the specified options.
    • Click Edit Filter button, the Edit Filter button, next to the filter name to open the Edit Filter dialog box and modify the filter settings.

      For more information on configuring filters, see Creating Dashboard Filters.

1.4.9.3 Enabling and Disabling Dashboard Filters

You can activate and deactivate the filters configured for a dashboard to control the data that is displayed in the widgets.
To enable or disable dashboard filters:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Click Toggle filters button, the Toggle filters button, on the dashboard heading.
    Dashboards tab - Filters panel
  3. In the Filters panel, turn the switch on or off to enable or disable a filter.

1.4.9.4 Locking Dashboard Filters

You can lock a filter to prevent viewers from making any changes. The viewer can see the defined filter settings, but cannot edit the locked filter.
Note: This function is only available with the Self-Service feature. If you want to purchase this feature, contact your Ricoh representative.
To lock a dashboard filter:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Click Toggle filters button, the Toggle filters button, on the dashboard heading.
  3. In the Filters panel, go to the filter that you want to lock, click Options button, the Options button, and select Lock.
    Dashboards tab - Filter options

    A lock icon appears to indicate that the filter is locked.

    To unlock the filter, click Options button, the Options button, and select Unlock.

1.4.9.5 Deleting Dashboard Filters

You can delete dashboard filters that are no longer required.
Note: This function is only available with the Self-Service feature. If you want to purchase this feature, contact your Ricoh representative.
To delete a dashboard filter:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Click Toggle filters button, the Toggle filters button, on the dashboard heading.
    Dashboards tab - Filters panel
  3. In the Filters panel, go to the filter that you want to delete and click Remove the item button, the Remove the item button.
    You can use the switch to turn off a filter temporarily. Delete the filter only if you do not need it any longer.

1.4.9.6 Saving a Default Filters View

You can save the current state of your filters and their settings at any time. The current state includes the existing filters, their configuration, and the order in which they appear in the Filters panel.
After modifying any of the filter settings, you can restore your filters to their previously saved state.
To save your current set of filters:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Click Toggle filters button, the Toggle filters button, on the dashboard heading.
  3. At the top of the Filters panel, click Options button, the Options button and select Set as My Default Filters.
    Filters panel - Options
  4. To restore the saved filters, click Restore my default filters button, the Restore my default filters button.

1.4.9.7 Restoring Dashboard Filters

If you changed the filters configured for a shared dashboard, you can revert to the latest copy shared by the dashboard owner at any time. When you restore a dashboard, local changes to the dashboard are overridden.
To restore dashboard filters:
  1. Click Dashboards tab, the Dashboards tab, and select a shared dashboard from the list.
  2. Click Options button, the Options button, on the dashboard heading and select Restore Dashboard.
  3. In the confirmation dialog box, click OK.

1.4.9.8 Creating Widget Filters

In the Widget Designer, you can specify which subset of data values is displayed in a widget by defining a widget filter. This type of filter affects only the widget it is applied to. For example, you can create a filter that shows data only from specific printers.
Note: This function is only available with the Self-Service feature. If you want to purchase this feature, contact your Ricoh representative.

Widget filters are not visible in the dashboard and cannot be edited directly from the dashboard. Viewers do not see these filters and cannot change them.

When you create a widget filter for a field that is already filtered in a dashboard filter, the widget filter overrides the dashboard filter. For example, you can apply both a dashboard filter and a widget filter for the months field. If January and February are selected for the dashboard filter and March and April are selected for the widget filter, you see data for March and April in the widget, according to the widget filter.

If your widget is filtered using measured values, the measured value overrides any other widget or dashboard filters set for the same fields.

To add a widget filter:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Create or edit a widget.
    For more information, see Creating Widgets or Editing Widgets.
  3. In the Widget Designer, click the Filters tab on the right.
    The Filters panel is displayed with separate Dashboard Filters and Widget Filters sections.
    Widget Designer - Filters panel
  4. Under Widget Filters, click Add button, the Add button.
  5. In the Filter a Field dialog box, configure the settings required for the new filter.
    Filter a Field dialog box
    1. Select the field that you want to use for the filter.
    2. Select a type of filter from the tabs on the left.
      Filter a Field dialog box - Configure filter
    3. Specify filtering details in the panel on the right.
      The settings depend on the type of filter that you are creating.

      The procedure for defining widget filters is similar to the procedure for defining dashboard filters. For more information on creating filters, see Creating Dashboard Filters. The difference is that the widget filter affects only the widget it is defined for and can be accessed only from the Widget Designer.

    4. Click OK to filter the data in the widget and add the new filter to the Filters panel in the Widget Designer.
    You can define multiple filters, each for a different field. These filters have an AND relationship between them.
      Note:
    • To reorder the filters in the Filters panel, drag a filter above or below another filter.
    • To rename a filter, click Options button, the Options button, and select Rename. Enter the new filter name in the text box.
  6. Optional: To limit the values that are visible in the widget filter, set the filter as a background filter using one of these methods:
    • For a filter without selected values, click Options button, the Options button, select Create Background Filter, configure the filter settings, and click OK.
    • For a filter that already has specific values selected, click Options button, the Options button, and select Set as Background Filter.

    The background filter is marked with a filter icon.

    Background filters are useful when you want to focus on a subset of data and avoid searching through a long list of options.

    To edit a background filter, click Options button, the Options button, and select Edit Background Filter.

    To remove a background filter, click Options button, the Options button, and select Remove Background Filter.

  7. Click Apply.
You can also directly filter a field that is already included in the widget. In the data panel on the left, hover over the field that you want to filter and click Filter field values button, the Filter field values button.

1.4.9.9 Editing Widget Filters

You can modify the filters that are applied to a widget.
Note: This function is only available with the Self-Service feature. If you want to purchase this feature, contact your Ricoh representative.
To edit a widget filter:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Open the widget that you want to work with in the Widget Designer.
    For more information, see Editing Widgets.
  3. In the Widget Designer, click the Filters tab on the right.
    Widget Designer - Filters panel
  4. Under Widget Filters, go to the filter that you want to edit and do one of these:
    • Expand the filter and modify the specified options.
    • Click Edit Filter button, the Edit Filter button, next to the filter name and modify the filter settings.

      For more information on configuring filters, see Creating Widget Filters.

  5. Click Apply.

1.4.9.10 Enabling and Disabling Widget Filters

You can activate and deactivate the filters configured for a widget.
Note: This function is only available with the Self-Service feature. If you want to purchase this feature, contact your Ricoh representative.
To enable or disable widget filters:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Open the widget that you want to work with in the Widget Designer.
    For more information, see Editing Widgets.
  3. In the Widget Designer, click the Filters tab on the right.
    Widget Designer - Filters panel
  4. Under Widget Filters, turn the switch on or off to enable or disable a filter.

    By default, the Update on Every Change option is enabled and the preview is updated automatically.

    To improve performance when you work with a large amount of data and slow query times, you can disable the Update on Every Change option. Click the Update button whenever you want to display the latest changes.

  5. Click Apply.

1.4.9.11 Deleting Widget Filters

You can delete widget filters that are no longer required.
Note: This function is only available with the Self-Service feature. If you want to purchase this feature, contact your Ricoh representative.
To delete a widget filter:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Open the widget that you want to work with in the Widget Designer.
    For more information, see Editing Widgets.
  3. In the Widget Designer, click the Filters tab on the right.
    Widget Designer - Filters panel
  4. Under Widget Filters, go to the filter that you want to delete and click Remove the item button, the Remove the item button.
    You can use the switch to turn off a filter temporarily. Delete the filter only if you do not need it any longer.
  5. Click Apply.

1.4.9.12 Configuring How Filters Affect the Dashboard and Widgets

You can configure different filtering behaviors.
Note: This function is only available with the Self-Service feature. If you want to purchase this feature, contact your Ricoh representative.

1.4.9.12.1 Configuring How Dashboard Filters Affect a Widget

Dashboard filters affect all the widgets in the dashboard, except for widgets that you configured as independent. An independent widget is not affected by dashboard filters.
To define the effect of dashboard filters on a widget:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Create or edit a widget.
    For more information, see Creating Widgets or Editing Widgets.
  3. In the Widget Designer, click the Filters tab on the right.
    The Filters panel is displayed with separate Dashboard Filters and Widget Filters sections.
    Widget Designer - Filters panel
  4. Under Dashboard Filters filters, turn the switch on or off to enable or disable a dashboard filter.
    If a dashboard filter is turned-off, it does not affect the widget.
  5. Click Apply.
You can also make the widget independent of all current and future dashboard filters by turning off the Dashboard Filters option.

1.4.9.12.2 Configuring How a Filtered Widget Behaves

When fields that are visible in a widget are filtered, the resulting data can be displayed in Slice/Filter mode or Highlight mode.
For example, a column chart shows the up time value for different printers. If the chart is set to Highlight mode and you filter a subset of printers, the selected printers are highlighted in the chart.

If the chart is set to Slice/Filter mode, all the printers that were not selected are removed from the chart.

To set the filtering mode:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Create or edit a widget.
    For more information, see Creating Widgets or Editing Widgets.
  3. In the Widget Designer, click the Filters tab on the right.
    Widget Designer - Filters panel
  4. In the Filters panel, select Slice/Filter or Highlight.
  5. Click Apply.

1.4.9.12.3 Configuring How a Selection in a Widget Affects the Dashboard

By default, when you make a selection in a widget, a filter is added and applied to the dashboard according to the selected part of the chart.
To prevent data selections in a widget from affecting the dashboard filters:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Create or edit a widget.
    For more information, see Creating Widgets or Editing Widgets.
  3. In the Widget Designer, click Options button, the Options button, and disable the Widget affects dashboard filters option.
  4. Click Apply.

1.4.10 Using Formulas

Formulas are custom calculations performed on one or more data fields. They provide an important way to analyze results.
Note: This function is only available with the Self-Service feature. If you want to purchase this feature, contact your Ricoh representative.
Formulas let you create complex calculations and combine fields from different data sources. You can also customize the formulas to reflect specific criteria and conditions or recalculate formulas based on any filter, variable, or level of granularity.

These are the main functions available in RICOH Supervisor:

Goal Function Types and Syntax
Perform calculations based on criteria Measured value

Numeric value filters: ≠, =, >, <, between

Text filters: Contains, Doesn't Contain, Doesn't End With, Doesn't Start With, Ends With, Starts With, Equals, Not Equal

List filters: Include, Exclude

Ranking filters: Top ranking, Bottom ranking

Time filters: Date and Calendar

Combine data or apply simple mathematical operations Aggregate functions

Operator: +, -, *, /

Aggregate:Sum()

Average:Avg()

Count:Count(), DupCount()

Range:Max(), Min()

Summarize data Statistical functions

Central tendency:Median(), Mode(), Largest()

Standard deviation and variance:Stdev(), Stdevp(), Varp(), Var()

Quartile and percentile:Quartile(), Percentile()

Accumulate data Rolling sum or average

Sum to date:YTDSum(), QTDSum(), MTDSum()

Average to date:YTDAvg(), QTDAvg(), MTDAvg()

Compare time periods or trends Time functions

Past periods:PastYear(), PastQuarter(), PastMonth(), Next(), Prev()

Growth trend:Growth(), GrowthRate()

Time difference:YDiff(), QDiff(), MDiff(), DDiff(), HDiff(), MnDiff(), SDiff()

You can see information on all the available functions directly in the Formula Editor when you hover over a function in the list.

1.4.10.1 Creating and Editing Formulas

You can create formulas for your widgets directly from the data browser when you add a field or you can edit the calculations for existing fields.
Note: The Rdouble and Rint functions are not currently supported.
To create or edit a formula:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Create or edit a widget in the Widget Designer.
    For more information, see Creating Widgets or Editing Widgets.
  3. In the data panel on the left, do one of these:
    • To add a new field based on a formula, click Add button, the Add button, and then click Create Formula button, the Create Formula button, in the top-left corner of the data browser dialog box.
    • To change the formula used for an existing field, hover over the field and click Edit Formula button, the Edit Formula button.
  4. Define the formula in the Formula Editor.
    Formula Editor
    1. In the Functions tab, select the function that you want to use.
      You can hover over a function in the list to see the function description and the required syntax.

      The available functions are grouped into four categories: Statistical, Math, Date & Time, and Other. To go to a specific category, click Jump To button, the Jump To button, and select a category name.

    2. In the Data Browser tab, select one or more data fields to include them in the formula.

      Each field has a default behavior that depends on the type of data included in the field and the type of data required by the widget. For example, when the widget requires numeric values, the default aggregation method for numeric fields is Sum. You can see information about the default behavior of a field by hovering over the field.

      To change the default behavior of a field, hover over the field and click More.... You can select a different aggregation method, apply filters, or set a different time period for date fields.

      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 [Total Printed Pages]*[Total Printed Copies] multiplies the number of printed pages by the number of printed copies.

    3. Enter the required parts of the formula according to the function syntax.
    4. To change the default behavior of a data field inside the formula, right-click the field and select one of the options available in the menu.
      • Rename: Enter a different name for the field.

        For example, you can specify a name that represents the expected result or that includes any filters that you applied.

      • Filter: Add filters to the field.

        For example, in the formula SUM([Printed Impressions]), you can add a ranking filter for the Printed Impressions field to calculate the sum of printed impressions using only the top 10 values.

      • Type: Change the default aggregation method.

        For example, you can switch from Sum to Average.

    5. Click OK.
    A large version of the Formula Editor is also available. Click Expand button, the Expand button, in the top-right corner of the dialog box.Formula Editor - Large version

1.4.10.2 Saving and Reusing Formulas

You can save formulas for future use.
Note: If you change a saved formula, the changes apply only to future uses of the formula. Previous uses of the formula are not affected.
To save and reuse formulas:
  1. Define a formula in the Formula Editor.
    For more information, see Creating and Editing Formulas.
  2. Click Favorite button, the Favorite button.
  3. Enter a name for the formula and confirm the save action.
  4. Click OK.
    Saved formulas appear in the data browser in the Formulas section.
  5. To use a saved formula, select it in the data browser when you add fields to your widgets.

1.4.10.3 Using Quick Functions

The Widget Designer provides several predefined quick functions that you can easily apply when you select fields for your widgets.
Quick functions instantly add a time dimension to any existing value and formula. These functions include calculations for past values, change over time, contribution, and running totals.
To use quick functions:
  1. Click Dashboards tab, the Dashboards tab, and select a dashboard from the list.
  2. Create or edit a widget in the Widget Designer.
    For more information, see Creating Widgets or Editing Widgets.
  3. In the data panel on the left, click Options button, the Options button, next to a numeric field.
  4. Select Quick Functions and the function that you want to apply.

For example, you can use a quick function if you are reviewing the total number of printed sheets per month but also want to see the accumulated annual value. You can simply use a quick function to calculate the year-to-date total for printed sheets.Quick Functions

You can also apply quick functions to a saved formula. For example, to compare the year-to-date number of printed sheets to the same period from the previous year, you can first apply the year-to-date function to the total number of printed sheets and save the formula. Then, you can add the saved year-to-date formula and apply another quick function for past values to perform the same calculation on data from the previous year.

1.4.10.4 Building Formulas with Functions

Functions are operations that perform common types of calculations and can be used to build formulas.
There are four main types of functions that you can use to combine, summarize, accumulate, and compare data. In this section you can find information about the most common functions, including information about the function syntax and examples.
Combine Data: Aggregate Functions
Aggregations are used to perform mathematical calculations on data. You can run multiple aggregations on several fields simultaneously, which makes it easy to summarize data based on multiple factors.
Syntax:
Function (Numeric Field)
Parameters:

Function: Sum(), Avg(), Count(), DupCount(), Max(), Min()

Numeric Field: A numeric field or formula.

For example, if you want to create a pivot table that shows the printer name and the average number of printed impressions, you can use a simple aggregation to calculate the average number of printed impressions for each printer:

AVG([Total Printed Impressions])

To also include the average number of printed impressions per day for each printer, you can use multi-pass aggregations that perform multiple calculations simultaneously. Instead of adding a new column for days in the pivot table, you can create a multi-pass aggregation that first calculates the sum of printed impressions per day and then averages the results for each printer:

AVG([Days in Date], [Total Printed Impressions])

Summarize Data: Statistical Functions
Statistical functions provide meaningful summaries of data and can help you make informed decisions. They are especially useful for analyzing large data sets.
Syntax:
Function (Numeric Field)
Parameters:

Function: Median(), Mode(), Largest(), Stdev(), Stdevp(), Varp(), Var(), Quartile(), Percentile()

Numeric Field: A numeric field or formula.

For example, you can use statistical functions to understand typical results or make predictions based on central tendency and standard deviations.

Accumulate Data: Running Total and Average
Often, to measure performance, data must be viewed in a continuous and accumulative format over extended periods such as years, quarters, or months. Several functions are available for creating running totals and averages over standard or custom time periods.
Syntax:
Function (Numeric Field)
Parameters:

Function: YTDAvg(), QTDAvg(), MTDAvg(), YTDSum(), QTDSum(), MTDSum(), RPSum(), RPAvg()

Numeric Field: A numeric field or formula.

For example, you can use the Year to Date Average function to track progress towards increasing the number of printed jobs:

YTDAVG([# of unique Job ID])

Change over Time: Time Functions
Time functions let you compare results at different points in time and determine growth rates. Functions can be set for standard time periods, such as year, quarter, month, and day, or for custom periods.
Note: To calculate time functions, a time filter must be applied on the dashboard or widget.
Syntax:
Function (Numeric Field)
Parameters:

Function: PastYear(), PastQuarter(), PastMonth(), Growth(), GrowthRate(), Contribution(), YDiff(), QDiff(), MDiff(), DDiff(), HDiff(), MnDiff(), SDiff(), Next(), Prev(), DiffPastYear(), DiffPastQuarter(), DiffPastMonth()

Numeric Field: A numeric field or formula.

For example, to compare growth in printed impressions to the same period in the previous year, you can use the DiffPastYear function:

DIFFPASTYEAR([Total Printed Impressions])

1.4.10.5 Creating Formulas Based on Filters

To create formulas that evaluate specific conditions, you can use the measured value function, which performs a calculation only when the values meet a set of criteria.
The criteria for measured values can be based on any logical operators in a filter.
Measured Value Syntax:
(Measure, Scope 1, Scope 2, ..., Scope N)
Parameters:
Measure: A field measure or formula.
Scope: A filter, including numeric value, text, list, ranking, and time filters.
To create a formula with filters:
  1. Define a formula in the Formula Editor.
    For more information, see Creating and Editing Formulas.
  2. Enter the syntax for the measured value function and include the field that you want to use as a filter in the formula.
  3. Right-click the field and select Filter.
  4. In the Filter dialog box, select a type of filter from the tabs on the left and specify filtering details in the panel on the right.
  5. Click OK.

For example, you can use the measured value function with a list filter to count only 2-sided jobs.Formula Editor - List Filter

Another example is using a ranking filter to track the contribution of best-performing printers to the total number of processed jobs. You can create a formula that calculates the number of jobs only for top-ranking printers. This formula filters the data dynamically since the list of top-ranking printers changes over time based on printer performance.Formula Editor - Ranking Filter

Note: If a widget is filtered using measured values, the measured value overrides any other widget or dashboard filters specified for the same fields.

1.4.10.6 Using Conditional Statements

Conditional statements are formulas that let you create additional categories in your data set. When the condition is met, the new category is added to the widget without modifying the data set itself.
For example, if you want to calculate only certain values according to conditions you define, you can use conditional statements to include only the values of interest. There are several conditional statements that you can use to evaluate criteria and display only the relevant results in your widgets.
Note: Conditional statements are supported only for measures and aggregations and return numeric values.
IF
IF(Boolean_expression, <numeric expression 1>, <numeric expression 2>)

The IF function evaluates a boolean expression. When the expression is true, numeric expression 1 is returned. When the expression is false, numeric expression 2 is returned.

Example:

IF(SUM([Total Printed Sheets]) < 10, 0, SUM([Total Printed Sheets]) )

Nested IF statements are also supported.

Example:

IF(SUM([Total Printed Impressions]) < 100, 1, (IF(SUM([Total Printed Impressions]) < 1000, 2, 3) ) )

isNull
ISNULL(<numeric expression>)

The isNull function returns true if the expression does not contain data, or is Null. It can be used as a condition inside conditional statements.

Example:

IF(ISNULL(SUM([Total Printed Impressions])), 0, SUM([Total Printed Impressions]) )

CASE
CASE
WHEN Boolean_expression THEN <result_expression>
[ ... ]
[ ELSE <else_result_expression> ]
END

The CASE function evaluates boolean expressions. When the expression is true, the corresponding result_expression is returned. If no match is found, the else_result_expression is returned. If there is no default returned and no values match, Null is returned.

Example:

CASE
WHEN COUNT([Job ID]) < 100 THEN 1
WHEN COUNT([Job ID]) < 1000 THEN 2
ELSE 3
END

1.4.11 Data Fields

Fields represent the data from RICOH Supervisor Data Collector, RICOH API for Fiery and RICOH ProcessDirector.

1.4.11.1 Data Fields from RICOH Supervisor Data Collector

Fields from RICOH Supervisor Data Collector represent the data provided by your data sources. You can interact with fields from the data browser, which appears in various places across the application. For example, the data browser is displayed when you select the data that is included in a widget, create filters, or drill down in a widget.

There are three types of fields from RICOH Supervisor Data Collector: date fields, descriptive fields, and numeric fields. In the data browser, an icon is displayed before each field to indicate its type:

  • Date icon Date fields

    Date fields can include both date and time values. 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 15-minute intervals.

  • Descriptive icon Descriptive fields

    Descriptive fields include alphanumeric strings that you can use to label and categorize data, such as printer names, printer types, and job states.

  • Numeric icon Numeric fields

    Numeric fields include quantified data that you can aggregate or calculate, such as number of impressions, number of copies, and event duration.

    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:

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.
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 widget, use the Max() aggregation method. In the Add a Field dialog box, hover over the Lifetime Printer Clicks field, click More..., and select Max.

Also, make sure that you always use the Max() aggregation method when you include the Lifetime Printer Clicks data field in formulas:

SUM([Printer Name], [Max Lifetime Printer Clicks])

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.
  • You can only track click data per printer and not per job.
  • The number of printer clicks is based on the data received from the printer counters and does not include scanner and copier clicks. If a printer does not provide any click data, RICOH Supervisor displays 0 for the number of clicks. For information on the printer counters, see the printer documentation.
  • How the clicks are counted also depends on the printer. For example, some printers only provide the total number of printer clicks and do not send separate data for black-and-white clicks, full-color clicks, or single-color and two-color clicks.
  • While RICOH Supervisor Data Collector is stopped, no click data is received from the printer. The clicks value is synchronized with the printer counters when RICOH Supervisor Data Collector is restarted.
  • Click data is retrieved only for cut sheet printers.
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.
  • You can only track click data per printer and not per job.
  • The number of copier clicks is based on the data received from the printer counters. If a printer does not provide any click data, RICOH Supervisor displays 0 for the number of clicks. For information on the printer counters, see the printer documentation.
  • How the clicks are counted also depends on the printer. For example, some printers only provide the total number of copier clicks and do not send separate data for black-and-white clicks, full-color clicks, single-color clicks, and two-color clicks.
  • While RICOH Supervisor Data Collector is stopped, no click data is received from the printer. The clicks value is synchronized with the printer counters when RICOH Supervisor Data Collector is restarted.
  • Click data is retrieved only for cut sheet printers.
Date section
Date

Date and time values, useful for filtering data based on specific time intervals.

These values are based on the time zone of the web browser that accesses RICOH Supervisor.

The first day of the week is Monday.

Printer Error section
Printer Engine

The printer engine where the error occurred.

You can use this data field to view errors 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 error tracking.

Printer Error Code The code of the printer error.
Printer Error Duration (ms) The duration of the printer error condition in milliseconds.
Printer Error ID

The unique identifier assigned to the printer error.

Error IDs are useful for distinguishing and tracking each individual error.

For example, you can use the Printer Error ID field if you want to count the number of errors that occurred during a time period. If you use the Printer Error Message or Printer Error Code fields instead, each error message or error code is counted only once even when the same error occurred multiple times.

Printer Error Message The description of the printer error condition.
Printer Error Sequence

The sequence of errors used when the printer sends several error 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 error data accuracy 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 error sequence is also useful when several independent errors, such as paperJam and mediaLow, happen at the same time.

RICOH Supervisor orders the errors from a set of simultaneous errors based on this default order:

  1. inputTrayEmpty
  2. mediaEmpty
  3. markerSupplyEmpty
  4. outputBinFull
  5. markerWasteFull
  6. paperJam
  7. mediaLow
  8. coverOpen
  9. serviceRequested
  10. offline
  11. unknown

For example, if the inputTrayEmpty, serviceRequested, and offline error codes are received at the same time, inputTrayEmpty corresponds to Main Error, serviceRequested to Second Error, and offline to Third Error.

If the mediaEmpty and paperJam error codes are received at the same time, mediaEmpty corresponds to Main Error and paperJam to Second Error.

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.

You can add the Printer Error Sequence field as a filter to obtain accurate results in widgets that display the error duration. For example, you can filter the data to include only error codes with the Main Error value and exclude the serviceRequested and offline error codes from the error duration 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.

Job Ink Usage - InfoPrint 5000 Black & White section
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.
Job Name The name of the job.
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.
Print Speed (M/min) The print speed in meters per minute.
Printed Paper Length (Feet)

The length of paper printed, measured in feet.

In both default and custom widgets, the Printed Paper Length (Feet) and Printed Paper Length (Meters) data fields are switched automatically based on the Length unit option specified under Settings User Preferences.

Printed Paper Length (Meters)

The length of paper printed, measured in meters.

In both default and custom widgets, the Printed Paper Length (Feet) and Printed Paper Length (Meters) data fields are switched automatically based on the Length unit option specified under Settings User Preferences.

  • The Job Ink Usage - InfoPrint 5000 Black & White section includes data from InfoPrint 5000 black and white printers.

    To track ink usage for InfoPrint 5000 printers, you must upload ink data for each printer on the Data Collectors tab. For more information, see Uploading Ink Data for InfoPrint 5000 Printers.

  • When you create widgets with ink data fields, make sure that you only include fields from the same ink data section, Job Ink Usage - All Printers, Job Ink Usage - Color Continuous Form, or Job Ink Usage - InfoPrint 5000 Black & White.
  • By default, the ink values displayed in RICOH Supervisor are rounded up to two decimal places. You can adjust the number of decimal places when you create or edit widgets in the Widget Designer. For more information, see Formatting Numbers in Widgets.
Job Ink Usage - Color Continuous Form section
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.

Job Name

The name of the job.

This data field applies to both InfoPrint 5000 color printers and RICOH Pro VC 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:

InfoPrint 5000 color printers
The total amount of cyan ink used on both engines.
RICOH Pro VC printers
The total amount of cyan ink used on both engines for printing and flushing the printhead.

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:

InfoPrint 5000 color printers
The total amount of black ink used on both engines.
RICOH Pro VC printers
The total amount of black ink used on both engines for printing and flushing the printhead.

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:

InfoPrint 5000 color printers
The total amount of magenta ink used on both engines.
RICOH Pro VC printers
The total amount of magenta ink used on both engines for printing and flushing the printhead.

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:

InfoPrint 5000 color printers
The total amount of yellow ink used on both engines.
RICOH Pro VC printers
The total amount of yellow ink used on both engines for printing and flushing the printhead.

Print Speed (M/min) - InfoPrint 5000

The print speed in meters per minute.

This data field only applies to InfoPrint 5000 color printers.

Printed Paper Length (Feet) - InfoPrint 5000

The length of paper printed, measured in feet.

In both default and custom widgets, the Printed Paper Length (Feet) and Printed Paper Length (Meters) data fields are switched automatically based on the Length unit option specified under Settings User Preferences.

This data field only applies to InfoPrint 5000 color printers.

Printed Paper Length (Meters) - InfoPrint 5000

The length of paper printed, measured in meters.

In both default and custom widgets, the Printed Paper Length (Feet) and Printed Paper Length (Meters) data fields are switched automatically based on the Length unit option specified under Settings User Preferences.

This data field only applies to InfoPrint 5000 color printers.

  • The Job Ink Usage - Color Continuous Form section includes data from InfoPrint 5000 color printers and RICOH Pro VC40000, RICOH Pro VC60000, RICOH Pro VC70000, and RICOH Pro VC80000 printers.

    To track ink usage for InfoPrint 5000 printers, you must upload ink data for each printer on the Data Collectors tab. For more information, see Uploading Ink Data for InfoPrint 5000 Printers.

    For RICOH Pro VC40000, RICOH Pro VC60000, RICOH Pro VC70000, and RICOH Pro VC80000 printers, make sure that you use the RICOH Pro VC printer type configuration in RICOH Supervisor Data Collector.

  • When you create widgets with ink data fields, make sure that you only include fields from the same ink data section, Job Ink Usage - All Printers, Job Ink Usage - Color Continuous Form, or Job Ink Usage - InfoPrint 5000 Black & White.
  • By default, the ink values displayed in RICOH Supervisor are rounded up to two decimal places. You can adjust the number of decimal places when you create or edit widgets in the Widget Designer. For more information, see Formatting Numbers in Widgets.
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:

  • If the job went to the aborted state, the actual number of printed copies is reported for the first job ID and other intermediary job IDs. For the last job ID created for the job, the total number of printed copies is reported instead.
  • If the job went to the printed state, the total number of printed copies is reported for each job ID. When you aggregate the printed copies value based on the job name, the result is a multiple of the number of copies that were actually printed for the job. For example, if one error occurs during processing and the job is printed in two stages, the aggregated value is double the number of copies that were actually printed.

Printed Impressions

The number of printed impressions.

Fiery and RICOH GW cut sheet printers and RICOH Pro VC continuous form printers
The number of printed impressions is retrieved directly from the printer. The printer calculates the number of printed impressions based on the number of pages in the PDF file and the job printing settings:

Pages in PDF file/n-up value × copies

Examples:

  • If the PDF file has 100 pages, the job is 1-sided, the n-up value is 2, and the number of copies is 3, the number of printed impressions is 150.
  • If the PDF file has 100 pages, the job is 2-sided, the n-up value is 1, and the number of copies is 3, the number of printed impressions is 300.

TotalFlow Print Server cut sheet printers
The number of printed impressions is retrieved directly from the printer. The printer calculates the number of printed impressions based on the number of pages in the PDF file and the job printing settings:

Pages in PDF file × copies

Examples:

  • If the PDF file has 100 pages, the job is 1-sided, the n-up value is 2, and the number of copies is 3, the number of printed impressions is 300.
  • If the PDF file has 100 pages, the job is 2-sided, the n-up value is 1, and the number of copies is 3, the number of printed impressions is 300.

InfoPrint 5000 and InfoPrint 4100 continuous form printers
The number of printed impressions is calculated in RICOH Supervisor Data Collector assuming that all jobs are 2-up, regardless of the printer configuration:

Pages in PDF file/2 × copies

Examples:

  • If the PDF file has 100 pages, the job is 1-sided, the n-up value is 2, and the number of copies is 3, the number of printed impressions is 150.
  • If the PDF file has 100 pages, the job is 2-sided, the n-up value is 1, and the number of copies is 3, the number of printed impressions is 150.

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:

  • If the job went to the aborted state, the actual number of printed impressions is reported for the first job ID and other intermediary job IDs. For the last job ID created for the job, the total number of printed impressions is reported instead.
  • If the job went to the printed state, the total number of printed impressions is reported for each job ID. When you aggregate the printed impressions value based on the job name, the result is a multiple of the number of impressions that were actually printed for the job. For example, if one error occurs during processing and the job is printed in two stages, the aggregated value is double the number of impressions that were actually printed.

Printed Pages

The number of printed pages.

EFI Fiery and RICOH GW cut sheet printers
The number of printed pages is retrieved directly from the printer. The printer calculates the number of printed pages based on the number of pages in the PDF file and the job printing settings:

Pages in PDF file/n-up value × copies

Examples:

  • If the PDF file has 100 pages, the job is 1-sided, the n-up value is 2, and the number of copies is 3, the number of printed pages is 150.
  • If the PDF file has 100 pages, the job is 2-sided, the n-up value is 1, and the number of copies is 3, the number of printed pages is 300.

TotalFlow Print Server cut sheet printers and RICOH Pro VC, InfoPrint 5000, and InfoPrint 4100 continuous form printers
The number of printed pages is retrieved directly from the printer. The printer calculates the number of printed pages based on the number of pages in the PDF file and the job printing settings:

Pages in PDF file × copies

Examples:

  • If the PDF file has 100 pages, the job is 1-sided, the n-up value is 2, and the number of copies is 3, the number of printed pages is 300.
  • If the PDF file has 100 pages, the job is 2-sided, the n-up value is 1, and the number of copies is 3, the number of printed pages is 300.

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:

  • If the job went to the aborted state, the actual number of printed pages is reported for the first job ID and other intermediary job IDs. For the last job ID created for the job, the total number of printed pages is reported instead.
  • If the job went to the printed state, the total number of printed pages is reported for each job ID. When you aggregate the printed pages value based on the job name, the result is a multiple of the number of pages that were actually printed for the job. For example, if one error occurs during processing and the job is printed in two stages, the aggregated value is double the number of pages that were actually printed.

Printed Paper Length (Feet)

The length of paper printed by continuous form printers, measured in feet.

In both default and custom widgets, the Printed Paper Length (Feet) and Printed Paper Length (Meters) data fields are switched automatically based on the Length unit option specified under Settings User Preferences.

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 both default and custom widgets, the Printed Paper Length (Feet) and Printed Paper Length (Meters) data fields are switched automatically based on the Length unit option specified under Settings User Preferences.

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.

EFI Fiery, RICOH GW, and TotalFlow Print Server cut sheet printers and RICOH Pro VC continuous form printers
The number of printed sheets is retrieved directly from the printer. The printer calculates the number of printed sheets based on the number of pages in the PDF file and the job printing settings:

(Pages in PDF file/n-up value/printing side value) × copies

For 1-sided jobs, the printing side value is 1. For 2-sided jobs, the printing side value is 2.

Examples:

  • If the PDF file has 100 pages, the job is 1-sided, the n-up value is 2, and the number of copies is 3, the number of printed sheets is 150.
  • If the PDF file has 100 pages, the job is 2-sided, the n-up value is 1, and the number of copies is 3, the number of printed sheets is 150.

InfoPrint 5000 and InfoPrint 4100 continuous form printers
The number of printed sheets is calculated in RICOH Supervisor Data Collector assuming that all jobs are 2-up, regardless of the printer configuration:

(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.

Examples:

  • If the PDF file has 100 pages, the job is 1-sided, the n-up value is 2, and the number of copies is 3, the number of printed sheets is 150.
  • If the PDF file has 100 pages, the job is 2-sided, the n-up value is 1, and the number of copies is 3, the number of printed sheets is 75.

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:

  • If the job went to the aborted state, the actual number of printed sheets is reported for the first job ID and other intermediary job IDs. For the last job ID created for the job, the total number of printed sheets is reported instead.
  • If the job went to the printed state, the total number of printed sheets is reported for each job ID. When you aggregate the printed sheets value based on the job name, the result is a multiple of the number of sheets that were actually printed for the job. For example, if one error occurs during processing and the job is printed in two stages, the aggregated value is double the number of sheets that were actually printed.

Job Ink Usage - All Printers section
Job Name The name of the job.
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:

InfoPrint 5000 color printers
The total amount of K1 and K2 ink used on engine 3.
InfoPrint 5000 black and white printers and RICOH Pro VC printers
The value for this field is always 0.

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:

InfoPrint 5000 color printers
The total amount of cyan ink used on both engines.
RICOH Pro VC printers
The total amount of cyan ink used on both engines for printing and flushing the printhead.

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:

InfoPrint 5000 black and white printers
The total amount of K1 and K2 ink used on both engines.
InfoPrint 5000 color printers
The total amount of black ink used on both engines.
RICOH Pro VC printers
The total amount of black ink used on both engines for printing and flushing the printhead.

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:

InfoPrint 5000 color printers
The total amount of magenta ink used on both engines.
RICOH Pro VC printers
The total amount of magenta ink used on both engines for printing and flushing the printhead.

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:

InfoPrint 5000 color printers
The total amount of yellow ink used on both engines.
RICOH Pro VC printers
The total amount of yellow ink used on both engines for printing and flushing the printhead.

  • The Job Ink Usage - All Printers section includes data from InfoPrint 5000, RICOH Pro VC40000, RICOH Pro VC60000, RICOH Pro VC70000, and RICOH Pro VC80000 printers.

    To track ink usage for InfoPrint 5000 printers, you must upload ink data for each printer on the Data Collectors tab. For more information, see Uploading Ink Data for InfoPrint 5000 Printers.

    For RICOH Pro VC40000, RICOH Pro VC60000, RICOH Pro VC70000, and RICOH Pro VC80000 printers, make sure that you use the RICOH Pro VC printer type configuration in RICOH Supervisor Data Collector.

  • When you create widgets with ink data fields, make sure that you only include fields from the same ink data section, Job Ink Usage - All Printers, Job Ink Usage - Color Continuous Form, or Job Ink Usage - InfoPrint 5000 Black & White.
  • By default, the ink values displayed in RICOH Supervisor are rounded up to two decimal places. You can adjust the number of decimal places when you create or edit widgets in the Widget Designer. For more information, see Formatting Numbers in Widgets.
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 widgets 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 Activity - 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 will be 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 Session - Continuous Form section
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 - Continuous Form section
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.

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 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 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.
  • You can only track click data per printer and not per job.
  • The number of scanner clicks is based on the data received from the printer counters. If a printer does not provide any click data, RICOH Supervisor displays 0 for the number of clicks. For information on the printer counters, see the printer documentation.
  • How the clicks are counted also depends on the printer. For example, some printers only provide the total number of scanner clicks and do not send separate data for black-and-white clicks and color clicks.
  • While RICOH Supervisor Data Collector is stopped, no click data is received from the printer. The clicks value is synchronized with the printer counters when RICOH Supervisor Data Collector is restarted.
  • Click data is retrieved only for cut sheet printers.
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 widgets 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.

Preset - Continuous Form section
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.

Preset Action - Continuous Form section
Preset Action Type

The action performed on the preset: created, loaded, changed, and modified.

  • When a new preset is created, the preset is marked as Created and some settings are marked as significant or insignificant.
  • When a preset is loaded, the preset is marked as Loaded.
  • When insignificant printer settings change, the preset does not change. The job is considered valid and goes to the printed state. The preset is marked as Changed to indicate that there are minor differences between the preset and the current printer settings.

  • When significant printer settings change, the preset does not change. The job is considered invalid if it has a specified preset. The preset is marked as Modified to indicate that there are major differences between the preset and the current printer settings.

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 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:

  • The Up category includes these printer states: initializing, feeding, preparing, printing, processing, and receiving. The printer is available and printing jobs.
  • The Idle category includes these printer states: idle, ready, not ready, pre/post not ready, sleeping, shutdown, warming, started, and start-up. The printer is ready to receive jobs but is not processing yet.
  • The Down category includes these printer states: not available, error, restart, pre/post busy, pre/post threading, pre/post EOF, pre/post paused, cleaning, adjusting, and maintenance. The printer is not available to print jobs because it’s broken, in error state, in maintenance, or the system is not available.
  • The Unknown category includes the unknown printer state and any printer state that is not included in one of the other categories.
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.

1.4.11.2 Data Fields from Avanti Slingshot

Data fields from Avanti Slingshot include data provided by 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.11.3 Data Fields from RICOH API for Fiery

Data fields from RICOH API for Fiery include data provided by RICOH API for Fiery from the Fiery printers.

These data fields are available:

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.11.4 Data Fields from RICOH ProcessDirector

Fields from RICOH ProcessDirector represent the collected data about RICOH ProcessDirector documents, users and other objects.

    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 default widgets, 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

On the Real Time Display tab, you can see up-to-date status and performance information for the printers registered in RICOH Supervisor Data Collector. The information is displayed on individual printer cards. You can group the printer cards and specify how the data is displayed.
Reference: For a video presentation of the functions available in the Real Time Display tab, go to Ricoh How-to Videos.

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

The printer cards provide information about each monitored printer.
To view printer information:
  1. Click Real Time Display tab, the Real Time Display tab.
    Real Time Display tab
  2. 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.
  3. 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 Information icon, 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 status messages shown on the printer cards are based on the printer state.
Important: When there is no data transfer from a printer, the printer card is inactive and shows the connection status instead of the printer status. For more information on the connection status, click Information icon, the information icon.
Status Messages and Printer States
Status Message / Printer States
Idle

Idle

Ready

Not ready

Pre/post not ready

Sleeping

Shutdown

Warming

Started

Start-up

Printing

Initializing

Feeding

Preparing

Printing

Processing

Receiving

Warning

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

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:

    1. inputTrayEmpty
    2. mediaEmpty
    3. markerSupplyEmpty
    4. outputBinFull
    5. markerWasteFull
    6. paperJam
    7. mediaLow
    8. coverOpen
    9. serviceRequested
    10. offline
    11. unknown

    For example, if the inputTrayEmpty, serviceRequested, and offline error codes are received at the same time, inputTrayEmpty is the main error that is displayed on the printer card.

    If the mediaEmpty and paperJam error codes are received at the same time, mediaEmpty is 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

The full-screen mode makes it easier to monitor the printer status and performance.
To view printer information in full-screen mode:
  1. Click Real Time Display tab, the Real Time Display tab.
    Real Time Display tab
  2. 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.
  3. On the group heading, click Expand button, the Expand button.
    Real Time Display tab - Full-screen mode
    To exit the full-screen mode, press the Esc key or click Collapse button, the Collapse button.

1.5.3 Customizing Printer Cards

You can specify the data that is displayed on the printer cards and customize its appearance.
To customize a printer card:
  1. Click Real Time Display tab, the Real Time Display tab.
  2. Under Printer Groups, click All printers or a specific printer group name.
    The printers included in the group are displayed as individual cards.
  3. Click Options button, the Options button, in the corner of the printer card.
  4. Click Preview.
    Real Time Display tab - Customize printer card
  5. Specify the required data settings in the Customize view dialog box.
    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 Help button to display the on-screen field help.

  6. Click OK.

1.5.4 Customizing Multiple Printer Cards

If you want to configure the same settings for multiple printer cards, you can edit multiple cards at once.
To customize multiple printer cards:
  1. Click Real Time Display tab, the Real Time Display tab.
  2. Under Printer Groups, click All printers or a specific printer group name.
  3. Click Options button, the Options button, on the group heading and select Customize views.
    Real Time Display tab - Printer group options
  4. Select the printers that you want to customize.
    Real Time Display tab - Customize multiple printer cards

    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.
  5. Click Customize views.
  6. Specify the required data settings in the Customize view dialog box.
    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 Help button to display the on-screen field help.

  7. Click OK.

1.5.5 Creating Printer Groups

For easier management, you can organize the printers into groups.
To create a printer group:
  1. Click Real Time Display tab, the Real Time Display tab.
  2. Click Group printers button, the Group printers button, next to Printer Groups.
  3. Select the printers that you want to include in the group.
    Real Time Display tab - Group printers

    To include all the printers, select the Select all check box.

  4. In the Name field, enter a name for the group.
  5. To reorder the printer cards, click the cards and drag them to a different location.
  6. Click Create.

1.5.6 Editing Printer Groups

You can modify existing printer groups.
To edit a printer group:
  1. Click Real Time Display tab, the Real Time Display tab.
  2. Under Printer Groups, select the group that you want to edit.
  3. Click Options button, the Options button, on the group heading and select Edit group.
    Real Time Display tab - Printer group options
  4. Select the printers that you want to include in the group.
    To include all the printers, select the Select all check box.
  5. Enter a new name for the group in the Name field.
  6. To reorder the printer cards, click the cards and drag them to a different location.
  7. Click Save.

1.5.7 Removing Printer Groups

You can remove printer groups that are no longer required.
To remove a printer group:
  1. Click Real Time Display tab, the Real Time Display tab.
  2. Under Printer Groups, select the group that you want to remove.
  3. Click Options button, the Options button, on the group heading and select Remove group.
    Real Time Display tab - Printer group options
  4. In the confirmation dialog box, click OK.

1.5.8 Adding, Editing, and Removing Printers

The Real Time Display tab shows the printers that were configured using RICOH Supervisor Data Collector. To add more printers, edit the printer settings, or remove printers, you must go to RICOH Supervisor Data Collector.
To add, edit, or remove printers:
  1. Click Data Collectors tab, the Data Collectors tab.
    Data Collectors tab
  2. 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.
  3. 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.
  4. 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

Authorized users can access RICOH Supervisor using a registered email address and a valid password. The levels of access and the actions the users can perform depend on the associated user role.

1.6.1 Users and Roles

Everyone who works with RICOH Supervisor has a user account that is assigned to a role. Roles define the levels of access and the actions the users can perform.

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, create dashboards using predefined widgets, and use predefined dashboard 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, create dashboards using predefined widgets, and use predefined dashboard 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

Cannot modify dashboards created by other users.

Cannot create, edit, or delete widgets.

Cannot create or delete filters.

Cannot share dashboards.

Cannot modify dashboards created by other users.

Cannot modify dashboards created by other users.

Cannot create, edit, or delete widgets.

Cannot create or delete filters.

Cannot share dashboards.

Cannot modify dashboards created by other users.

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

If you encounter problems while you are working with RICOH Supervisor, you might be able to solve them by using the information in this section.

1.7.1 If You Encounter a Problem

This section provides explanations and possible solutions for problems that you might encounter.
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.

Note: Enabling these third-party cookies lets Supervisor connect with the engine that powers your dashboards. RICOH Supervisor does not use marketing or advertising cookies.

To enable third party cookies:

  • Click , the configuration icon.
  • Click Settings
  • Open the Privacy and security tab.
  • Open the Tracking protection page.
  • Scroll down to Allowed to use third-party cookies and click Add.
  • Enter
    [*.]app-ricohsoftware.com
    or
    [*.]app-ricohsoftware.eu

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:

Google Chrome:

  • Go to Settings Privacy and security Cookies and other site data, and select Allow all cookies.
  • You can also turn off the Google Chrome Incognito mode.

Microsoft Edge:

  • Go to Settings Cookies and site permissions Manage and delete cookies and site data, 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:

  1. Uninstall the application without deleting the data collector from the cloud.
  2. 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 Information icon, 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 widgets included in a dashboard might affect the system performance. We recommend that you do not add more than 10 widgets to a dashboard.

Unsupported Data Fields in Widgets

If a widget contains data fields that are no longer supported, a database error occurs and the widget cannot be loaded. Replace any affected default widgets in your dashboards with the latest versions from the widget library. Edit or recreate custom widgets to include only data fields that are currently supported.

A database error also occurs when you drill down in a widget and select a data field that is no longer supported from the list of previously used drill options. To cancel the drill action and reload the widget, click Close icon, the Close icon, in the top-left corner of the widget. For shared dashboards, you can also use the Restore Dashboard option to revert to the latest copy shared by the dashboard owner. Click Options button, the Options button, on the dashboard heading and select Restore Dashboard.

For more information on the supported data fields, see Data Fields.

Data in Widgets Is Not Displayed Using the Correct Measurement Unit

The measurement unit used for data metrics based on the length of paper printed, such as throughput for continuous form printers, depends on the Length unit option specified under Settings User Preferences.

If the data in the default widgets is not displayed using the correct measurement unit, try one of these possible solutions:

  • Make sure that the measurement unit is set correctly under Settings User Preferences.

    The Printed Paper Length (Feet) and Printed Paper Length (Meters) data fields are switched automatically based on the Length unit option specified under Settings User Preferences.

  • Recreate older dashboards to include the latest versions of the default widgets.

If the data in custom widgets is not displayed using the correct measurement unit, try one of these possible solutions:

  • Make sure that the measurement unit is set correctly under Settings User Preferences.

    The Printed Paper Length (Feet) and Printed Paper Length (Meters) data fields are switched automatically based on the Length unit option specified under Settings User Preferences.

  • Recreate older widgets to include the latest versions of the data fields.

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.

The Default Widgets Are Not Translated After They Are Added to a Dashboard

When the web browser language is set to a supported language other than English, the default widgets from the widget library are not automatically translated when they are added to a dashboard. Refresh the web browser page to update the text in the widgets.

When You Export Dashboard Data as a PDF File, the Preview Is Incorrect and the Download Fails

If a dashboard includes older versions of the default widgets or custom widgets with older versions of data fields, the data download might not work properly. The preview of the PDF file might not be correct and the download might time out.

Try one of these possible solutions:

  • Recreate the dashboard to include the latest versions of the default widgets.
  • Update custom widgets to use the latest versions of the data fields. Then, recreate the dashboard and include the updated custom widgets.

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 widgets 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 widgets 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.

Some Printer Errors Are Not Included in the Default Widgets

For increased accuracy, a Printer Error Sequence filter is 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 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 and are not included in the widget. If you want to view older data, edit the widget and 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 widget and display data per engine.

Custom Widgets Do Not Show Accurate Printer Error Data

When you create widgets that show printer errors and error duration, make sure that you add a Printer Error Sequence filter in the widget 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 widget.

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 widget 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.com
    • www.ricohsoftware.com
    • *.app-ricohsoftware.com
  • For Europe:
    • ricohsoftware.eu
    • www.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.com
    • *.app-ricohsoftware.com
    • https://cognito-idp.us-west-2.amazonaws.com
    • https://logs.us-west-2.amazonaws.com
    • https://www.googletagmanager.com
    • https://www.google-analytics.com
    • ricoh-us.sisense.com
  • For Europe:
    • *.ricohsoftware.eu
    • *.app-ricohsoftware.eu
    • https://cognito-idp.eu-west-2.amazonaws.com
    • https://logs.eu-west-2.amazonaws.com
    • https://www.googletagmanager.com
    • https://www.google-analytics.com
    • ricoh-eu.sisense.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:
    1. In the browser heading, click Customize and control Google Chrome icon, the Customize and control Google Chrome icon, and select More tools Developer tools.
    2. In the Console tab, click Clear console icon, the Clear console icon.
    3. In the Network tab, click Clear icon, the Clear icon, to clear all current network requests.
    4. In the Network tab, select the Preserve log check box.
    5. Reproduce the issue from your support case.
    6. In the Network tab, click Export HAR..., the Export HAR... icon, and save the file.
    7. In the Console tab, right click on any of the items in the list.
    8. Choose Save as..., and then save the file.
  • Microsoft Edge:
    1. In the browser heading, click Settings and more icon, the Settings and more icon, and select More tools Developer tools.
    2. In the Console tab, clear the console output.
    3. In the Network tab, clear all current network requests.
    4. In the Network tab, select the Preserve log check box.
    5. Reproduce the issue from your support case.
    6. In the Network tab, click Export HAR..., the Export HAR... icon, and save the file.
    7. In the Console tab, right click on any of the items in the list.
    8. Choose Save as..., and then save the file.
  • Mozilla Firefox:
    1. In the browser heading, click Open application menu icon, the Open application menu icon, and select More tools Web Developer Tools.
    2. In the Console tab, clear the Web Console output.
    3. In the Network tab, clear all current network requests.
    4. In the Network tab, choose the Gear icon, and select Persist Logs.
    5. Reproduce the issue from your support case.
    6. In the Network tab, right click on any network request in the request list.
    7. Choose Save All As HAR, and then save the file.
    8. In the Console tab, right click on any of the items in the list.
    9. Choose Save all Messages to File, and then save the file.

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 widgets 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

  1. Make sure that you are connected to the Internet.
  2. Make sure that you are using a supported web browser. For more information, see Computer Requirements.
  3. Make sure that the IP address is accessible. Use a shell command interface to ping the IP address. If no result is returned, contact the system administrator to check if the IP address is not blocked.
  4. Make sure that the trial period is still active or that you have a valid subscription. For more information, contact a service representative.
  5. Make sure that you are accessing the latest content. Clear the web browser cache and reload the page.
  6. Make sure that your web browser is configured correctly. If the problem persists, restart the web browser.
  7. Make sure that the date, time, and time zone are set correctly on your system.

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.

2 RICOH Supervisor Data Collector

RICOH Supervisor Data Collector is a web-based application that lets you collect information from printers. The information is stored in the cloud where it becomes available to other connected applications.

2.1 Overview of RICOH Supervisor Data Collector

RICOH Supervisor Data Collector is a web-based application that lets you collect information from printers. The information is stored in the cloud where it becomes available to other connected applications.

You can configure the data sources that RICOH Supervisor Data Collector queries and the type of information that you want to obtain, define security settings, and view activity logs.

    Important:
  • You cannot view the stored data on the RICOH Supervisor Data Collector user interface. All the collected data is sent to connected applications, such as RICOH Supervisor, which process and display the information for easy monitoring and analysis.
  • When RICOH Supervisor Data Collector is not connected to the cloud, you cannot add, edit, or delete a data source. When the connection with the cloud is restored, all functions are enabled.

2.1.1 What's New?

This page provides information about new or improved functions, fixed defects, and deprecated functionality.
Important: To benefit from the new or improved functions, fixes, and security updates, make sure that you always upgrade to the latest version of RICOH Supervisor Data Collector.
April 25, 2024
  • Various security fixes including CVE-2024-29025.
  • Minor bug fixes.
April 4, 2024
  • Updated the list of allowed URLs and domains for installing RICOH Supervisor Data Collector. For more information, see Computer Requirements.
  • Various security updates.
  • Minor bug fixes.
March 14, 2024
February 29, 2024
  • Various security updates.
  • Minor bug fixes.
February 22, 2024
  • Various security fixes including CVE-2023-46589.
  • Minor bug fixes.
February 1, 2024
  • Added support for Pro VC80000 TotalFlow Print Server and RICOH ProC7500 printers. For more information, see Supported Printers.
  • Various security fixes including CVE-2024-21634.
  • Minor bug fixes.
January 11, 2024
  • Various security updates.
  • Minor bug fixes.
December 21, 2023
  • Enable the RICOH API for Fiery feature for RICOH Pro9500 printers. For more information, see RICOH Fiery Cut Sheet Printer .
  • Various security updates.
  • Minor bug fixes.
November 29, 2023
  • Various security fixes including CVE-2023-35116, CVE-2023-40167, CVE-2023-36478, CVE-2023-4586, and CVE-2023-46233.
  • Minor bug fixes.
November 9, 2023
  • Updated the list of supported operating systems. Removed support for Windows Server 2012. For more information, see Computer Requirements.
  • 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 Computer Requirements.
  • Added information about the length limit for job names for each printer type. For more information, see Collected Data and Common Problems.
  • Various security updates.
  • Minor bug fixes.
October 18, 2023
  • Various security updates.
  • Minor bug fixes.
September 28, 2023
  • Various security updates.
  • Minor bug fixes.
September 7, 2023
  • Various security updates.
  • Minor bug fixes.
August 17, 2023
  • Various security fixes including 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)
    For more information, see Collected Data.
  • Various security updates.
  • Minor bug fixes.
July 6, 2023
  • Various security updates.
  • Minor bug fixes.
June 15, 2023
May 18, 2023
  • Added support for enabling and disabling the feature number 5565 on the physical printer. For more information, see Editing Printer Properties.
  • Various security updates.
  • 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 Common Problems.
  • Various security updates.
  • Minor bug fixes.
April 6, 2023
  • Various security updates.
  • Minor bug fixes.
March 23, 2023
  • Various security updates.
  • Minor bug fixes.
March 16, 2023
  • Various security fixes including CVE-2022-41915.
  • Minor bug fixes.
February 23, 2023
  • Various security updates.
  • Minor bug fixes.
February 16, 2023
  • Various security updates.
  • Minor bug fixes.
February 2, 2023
  • Updated the list of supported operating systems. Added support for CentOS Stream 8, openSUSE Leap Desktop 15.4 or higher and removed support for Windows 8.1. For more information, see Computer Requirements.
  • 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 Computer Requirements.
  • 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. For more information, see Editing Printer Properties.
  • 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-2021-37137, CVE-2021-37136, CVE-2019-20445, CVE-2019-20444, CVE-2022-24823, CVE-2021-21290, CVE-2021-43797, CVE-2020-11612, and CVE-2022-31160.
  • Minor bug fixes.
November 17, 2022
  • Various security updates.
  • Minor bug fixes.
October 27, 2022
  • Various security updates.
  • Minor bug fixes.
October 6, 2022
  • Various security updates.
  • Minor bug fixes.
September 15, 2022
August 25, 2022
  • Various security fixes including CVE-2022-34305.
  • Minor bug fixes.
August 4, 2022
  • Various security fixes including CVE-2022-2047.
  • Minor bug fixes.
July 14, 2022
  • Various security fixes.
  • Minor bug fixes.
June 23, 2022
  • Updated the list of supported operating systems. Added support for Windows 11 and Windows Server 2022. For more information, see Computer Requirements.
  • 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 Computer Requirements.
  • Various security fixes.
  • Minor bug fixes.
June 2, 2022
  • Improved the accuracy of job data collected through RICOH API for Fiery on Fiery printers. For more information, see RICOH Fiery Cut Sheet Printer .
  • Various security fixes.
  • Minor bug fixes.
May 16, 2022
  • Various security fixes.
  • Minor bug fixes.
April 21, 2022
  • Minor bug fixes.
April 14, 2022
  • Minor bug fixes.
March 10, 2022
  • Minor bug fixes.
February 17, 2022
  • Minor bug fixes.
February 10, 2022
  • Various security fixes.
  • Minor bug fixes.
January 27, 2022
  • Minor bug fixes.
January 6, 2022
  • Fixed security vulnerability issue CVE-2021-44228 and CVE-2021-44832. (Requires the new version of RICOH Supervisor Data Collector)
  • Minor bug fixes.
December 16, 2021
  • Fixed security vulnerability issue CVE-2021-45105. (Requires the new version of RICOH Supervisor Data Collector)
  • Minor bug fixes.
November 18, 2021
  • Various security updates.
  • Minor bug fixes.
November 11, 2021
  • 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.

    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.
September 24, 2021
  • Various security updates.
  • Minor bug fixes.
September 2, 2021
  • Improved the upload diagnostic data function. For more information, see Uploading Diagnostic Data.
  • Various security updates.
  • Minor bug fixes.
August 12, 2021
  • Improved data privacy and security for the logs collected in RICOH Supervisor Data Collector.
  • 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.
  • Improved the job event handling for TotalFlow Print Server printers.
  • Fixed program shortcut issues that occurred when the RICOH Supervisor Data Collector installation language was Spanish.
  • Various security updates.
  • Minor bug fixes.
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.
  • Fixed data collection issues caused by restarting the RICOH Supervisor Data Collector service while RICOH Supervisor was under maintenance.
  • Improved overall connectivity for TotalFlow Print Server printers.
  • Various security updates.
  • Minor bug fixes.
June 10, 2021
  • Added support for tracking fifth station printer clicks from cut sheet printers.
  • Added support for tracking scanner and copier clicks from cut sheet printers.
  • Fixed issues with sudden and incorrect increases in printer click values.
  • 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.

  • 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 Fiery and RICOH GW cut sheet printers.
  • Various security updates.
  • Minor bug fixes.
April 29, 2021
  • 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.
  • Fixed issue with negative values displayed for the error duration.
  • Fixed issue with TotalFlow Print Server printers that did not automatically reconnect through JMF after they were restarted.
  • Fixed issue with serial numbers that were not correctly retrieved from the printer.
  • Fixed issue where the printer cards were not always visible after logging in to RICOH Supervisor Data Collector.
  • Various security updates.
  • Minor bug fixes.
April 8, 2021
  • Added the Preset and Operator Name data fields for continuous form printers.

    For printers that are already registered in the system, RICOH Supervisor Data Collector starts collecting preset data the next time there is a snapshot update and operator data the next time an operator logs in to the printer.

  • 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.
  • Various security updates.
  • Minor bug fixes.
March 18, 2021
  • Added support for adjusting the printer time zone based on daylight saving time.

    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.
  • Various security updates.
  • Minor bug fixes.
February 25, 2021
  • Added support for uploading diagnostic data that can help troubleshoot problems. For more information, see Uploading Diagnostic Data.
  • Added the Printer Character Set option for printers that use the Generic SNMP Printer, RICOH GW Cut Sheet Printer, or RICOH Fiery Cut Sheet Printer configuration. RICOH Supervisor Data Collector uses the character set to process and display printer data and job data correctly.

    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.
  • Ended support for RICOH Supervisor Data Collector version 1.0. Make sure that you upgrade to the latest available version.
  • Various security updates.
  • Minor bug fixes.
February 4, 2021
  • Improved the RICOH Supervisor Data Collector logging mechanism.
  • 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.
  • Various security updates.
  • Minor bug fixes.
January 14, 2021
  • Fixed disk space issues caused by large RICOH Supervisor Data Collector log files.
  • 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".
  • 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 snapshot was restored.
  • Various security updates.
  • Minor bug fixes.
December 17, 2020
  • Improved the accuracy of data metrics collected when groups of jobs are submitted to a TotalFlow Print Server cut sheet printer.
  • Improved the processing and storing of printer events.
  • Fixed issue with simplex printers that were sometimes incorrectly displayed as duplex after the RICOH Supervisor Data Collector service was restarted.
  • Various security updates.
  • Minor bug fixes.
December 3, 2020
  • Various security updates.
  • Minor bug fixes.
November 5, 2020
  • Updated the list of supported operating systems. Added support for Windows 8.1 and Windows Server 2019 and removed support for Windows 7 and Windows 8. For more information, see Computer Requirements.
  • Improved the accuracy of data metrics for aborted jobs on continuous form printers.
  • Improved the accuracy of data metrics for jobs that were suspended and resumed on Fiery printers.
  • Fixed tracking issues for jobs that were submitted using the process and hold option on Fiery printers.
  • 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 from RICOH Supervisor.

    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 support for tracking lifetime printer clicks for cut sheet printers.

    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.

  • Improved the accuracy of printed impressions data for continuous form printers.
  • Fixed issues with the message displayed when a new version of RICOH Supervisor Data Collector is available.
  • Various security updates.
  • Minor bug fixes.
September 24, 2020
  • Fixed printer status issues that occurred after the RICOH Supervisor Data Collector service was stopped and restarted.
  • Fixed connectivity issues with TotalFlow Print Server printers when HTTPS was enabled for RICOH Supervisor Data Collector.
  • Various security updates.
  • Minor bug fixes.
September 3, 2020
  • 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 Enabling HTTPS for RICOH Supervisor Data Collector .
  • Fixed display issues for job names with special characters.
  • Various security updates.
  • Minor bug fixes.
August 13, 2020
  • Added support for several printers. For more information, see Supported Printers.
  • Various security updates.
  • Minor bug fixes.
July 30, 2020
  • Improved the accuracy of printed copies data for continuous form printers.
  • Various security updates.
  • Minor bug fixes.
July 2, 2020
  • Various security updates.
  • Minor bug fixes.
June 11, 2020
  • Improved filtering precision when searching for events in logs.
  • More information is displayed on the printer cards. Now you can see the printer type on each printer card on the Printers page.
  • Various security updates.
  • Minor bug fixes.
May 21, 2020
  • You can now reset your user account password from the RICOH Supervisor Data Collector sign-in page.
  • Added information about how to reach technical support in the Troubleshooting and Support section.
  • Fixed issues with data for reprinted jobs.
  • Various security updates.
  • Minor bug fixes.
April 30, 2020
  • Improved 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.
  • Improved login experience. The user email field is no longer case-sensitive.
  • 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 from the RICOH Supervisor help page.
  • Improved the accuracy of the job information collected from cut sheet printers. The data collectors can now receive accurate information from cut sheet printers about jobs, sheets, and impressions when users submit groups of jobs.
  • 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.
March 19, 2020
  • Enhanced connection between RICOH Supervisor Data Collector and the data recipients by improving the communication routine of the data collectors.
  • Improved interface communication by replacing the messages received from SNMP with custom messages that match with the RICOH Productivity Tracker messages.
  • Improved the accuracy of the job information collected from cut sheet printers. The data collectors can now receive accurate information from cut sheet printers about Total Sheets, Total Pages, and Total Impressions of aborted jobs, too.
February 27, 2020
  • Improved the accuracy of the information gathered by data collectors. You can now select the time zone of the physical printer, for the data collector to be able to identify the printer correctly and collect more accurate data.
  • Added support for a new printer type in the printer definition dialog box. You can now collect job information from cut sheet printers with TotalFlow Print Server controller.
  • You can now view the printers that are already configured in RICOH Supervisor Data Collector when selecting an IP range, so you can better choose which printers to add.
February 06, 2020
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 and counted on the Real Time Display and Dashboards tabs.

For common problems and possible solutions, see Common Problems.

2.1.2 RICOH Supervisor Data Collector User Interface

RICOH Supervisor Data Collector provides a comprehensive and intuitive web-based user interface for viewing and managing connected data sources.
Reference: For a video presentation of the RICOH Supervisor Data Collector user interface, go to Ricoh How-to Videos.

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.

Printers page

The RICOH Supervisor Data Collector user interface consists of these areas:

  1. The Printers page, for viewing and managing printers as data sources for RICOH Supervisor Data Collector.

  2. The Go to Analytics tab, for monitoring data sources, viewing collected data, and setting alerts for important changes.

  3. The Settings button Settings button, for viewing and editing the settings of the data collector and for viewing plug-in information and the activity log.

  4. The Account button Account button, for viewing your user name and for signing out.

  5. The Help button Help button, for viewing information on how to configure and use RICOH Supervisor Data Collector.

  6. The Search button Search button, for finding a data source configured in RICOH Supervisor Data Collector.

  7. The Add Printer... and Scan for Printers buttons, for adding a printer manually or searching for printers automatically.

  8. The RICOH Supervisor Data Collector footer, for viewing cloud and ground information about the data collector.

2.1.2.1 Printers Page

The Printers page displays information on the printers configured in RICOH Supervisor Data Collector.
Printers page

On each printer card, you can view the printer name, IP address or host name, connectivity status, and printer type. If the printer status is Not connected or Partial data transfer, you can click the Details button to view details about connectivity.

On the Printers page, you can also add printers and edit or delete printers that are already configured in RICOH Supervisor Data Collector.

To view the printers as a list, click List view button, the List view button, in the top-right corner of the page.

2.1.2.2 Go to Analytics Tab

You can click the Go to Analytics button to view the collected data, monitor the data sources, and set alerts for important changes.

When you click the Go to Analytics button, you are redirected to the RICOH Supervisor sign-in page.

RICOH Supervisor sign-in page

Enter your user account email and password to sign in to RICOH Supervisor.

For more information on how to monitor data sources, view collected data, and set alerts, see the RICOH Supervisor documentation.

2.1.2.3 Settings Tab

In the Settings tab, you can view and edit the settings of the data collector and view plug-in information and the activity log.

Click Settings button, the Settings button, in the top-right corner of the RICOH Supervisor Data Collector main page, and select General Settings, Plug-in Management, or Activity Log.

Settings menu
General tab

General tab

In the General tab, you can configure your data collector according to your needs:

Name
You can edit the name of the data collector.
Store Data Locally
To keep the collected data only locally, enable the Store Data Locally option. To set the storage location, you can enter a file path in the input field or you can click Browse for Folder button, the Browse for Folder button, to create or select a folder on the computer where RICOH Supervisor Data Collector is installed. Enabling local data storage may require additional disk space.

Browse for Folder dialog box

    Important:
  • If you enable Store Data Locally, RICOH Supervisor Data Collector does not send data to the cloud and, as a result, you cannot see the data in RICOH Supervisor. Use this option only if you have other means of analyzing data.
  • Even if Store Data Locally is enabled, you must have an internet connection for your subscription to be validated.
  • RICOH Supervisor Data Collector does not manage your local data storage. If you enable Store Data Locally, the data collector creates a series of files with the data collected from the printers, in the specified location, each time new data is collected. Delete or move any unnecessary files created by the data collector in the data storage location.

Current version
This field displays the RICOH Supervisor Data Collector version installed on your system.
Available updates
This field displays the latest RICOH Supervisor Data Collector version that is currently available. If an update is available, you can click the download button to download the installation package for the new version.
Description
You can enter a description for the data collector.
Use HTTP Proxy Server
Enable the Use HTTP Proxy Server option if you want to enable proxy settings for the internet connection. Improper proxy configuration may cause connectivity issues with the cloud. If there are any connectivity issues, the system displays an offline status at the top of the main page.

Offline status

Host Address
Specify the IP address or the DNS name for the proxy server.
Port
Specify the port number for the proxy server.
Username
Enter a valid user name for the proxy server.
Password
Enter the password for the specified user name.
Bypass/Exclude Hosts
Specify the IP address or the DNS name for the proxy server exceptions. You can add or remove exceptions from the bypass list by using the plus or the minus button. Each exception must be listed on a separated line.

To save the changes, click OK. To discard the changes, click Cancel.

Plug-in Management tab

Plug-in Management tab

In the Plug-in Management tab, you can view information on the plug-ins used for retrieving data from various sources.

Activity Log tab

Activity Log tab

In the Activity Log tab, you can view information on system events and user actions. Data is stored in the activity log for 30 days.

This information is available in the Activity Log tab:

  • Severity
  • Timestamp
  • Issued by
  • Event Type
  • Component
  • Component Type
  • Message

2.1.2.4 RICOH Supervisor Data Collector Footer

The RICOH Supervisor Data Collector footer provides cloud and ground information on the configured data collector. The information in the footer is refreshed periodically with updates from the cloud or each time a device is added or deleted.

RICOH Supervisor Data Collector footer

The following information is available in the footer:

Data Collector Name
The name of the data collector you configured. You can update the data collector name on the General Settings page.
Communication Status
The communication status between the data collector and the cloud. The status can be Connected or Not Connected.
Current version / Update
The RICOH Supervisor Data Collector version installed on your system and the latest version that is currently available. If an update is available, you can click the download button to download the installation package for the new version.
Data Source Usage
The number of used data source entitlements from the total number of available data sources. If you used all the available data sources from your subscription, you can view pricing details and purchase more data sources.

If you used 50% of the available data sources, the information button Information button becomes visible in the footer. Click the information button for more details.

2.1.3 Notices

2.1.3.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.

2.1.3.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.

2.1.3.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.

HP and LaserJet are registered trademarks of HP Development Company, L.P.

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.

Mac is a trademark of Apple Inc., registered in the U.S. and other countries and regions.

Microsoft, Windows, Windows Server, and Microsoft Edge 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.

Ubuntu is a registered trademark of Canonical Ltd.

The proper names of the Windows operating systems are as follows:

  • Windows 11 Pro or Enterprise
  • Windows 10 (20H2 or higher) Pro or Enterprise
  • Windows 8.1 Pro or Enterprise
  • Windows Server 2022 Standard, Essentials, or Datacenter with Desktop Experience
  • Windows Server 2019 Standard, Essentials, or Datacenter with Desktop Experience
  • Windows Server 2016 Standard, Essentials, or Datacenter with Desktop Experience
  • Windows Server 2012 R2 Standard or Enterprise with Desktop Experience

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.

2.2 Getting Started with RICOH Supervisor Data Collector

This section includes basic procedures for working with RICOH Supervisor Data Collector.

2.2.1 Computer Requirements

To run RICOH Supervisor Data Collector, your computer must meet these requirements. Before setup, make sure that all the requirements are met.

System Requirements

This table lists the requirements for the computer where you install RICOH Supervisor Data Collector:

Item Requirements
Computer
  • Server Class Computer
  • CPU: Quad Core Processor 2.7 GHz or higher (64–bit CPU)
  • Main memory: 4 GB RAM or higher (8 GB RAM or higher recommended)
Important: To avoid performance issues, we recommend that you register up to 15 printers for 4 GB available RAM.

If you want to monitor a larger number of printers, increase the available RAM or install additional data collectors.

Hard disk 30 GB of available disk space for the initial installation and up to 250 GB or more, depending on usage
Note: The amount of space required varies greatly, depending on the log size and whether the Store Data Locally feature is enabled within RICOH Supervisor Data Collector. The log size depends on the number of printers connected, the printer type used, and the uptime of the application. Using a solid-state drive (SSD) is recommended for better performance.
Display 1280 × 1024 pixels or higher
Note: Maximize the browser window when you use this application. If the size of the browser window is not large enough to display the user interface, you might experience problems with truncated display.
Operating systems
  • Windows 11 (22H2 or higher) Pro or Enterprise
  • Windows 10 (22H2 or higher) Pro or Enterprise
  • Windows Server 2022 Standard, Essentials, or Datacenter with Desktop Experience
  • Windows Server 2019 Standard, Essentials, or Datacenter with Desktop Experience
  • Windows Server 2016 Standard, Essentials, or Datacenter with Desktop Experience
  • Ubuntu Desktop (22.04 LTS, 20.04 LTS)
  • CentOS Stream 8
  • openSUSE Leap Desktop (15.5 or higher)
  • Red Hat Enterprise Linux (7.9, 8.6 or higher)
    Important:
  • The 64-bit operating systems satisfy the minimum operating system requirements.
  • If you install RICOH Supervisor Data Collector on an operating system that is running on VMware software, the system might experience slow performance. To avoid any RICOH Supervisor Data Collector performance issues, make sure that you allocate a separate disk drive for the VMware software.
  • Make sure that the computer where you install RICOH Supervisor Data Collector is not set to enter sleep mode. During sleep mode, RICOH Supervisor Data Collector cannot collect data and the connection with the cloud is interrupted.
  • On openSUSE, make sure you install the insserv-compat package before installing RICOH Supervisor Data Collector. Install RICOH Supervisor Data Collector and restart the computer.
Network
  • Make sure that the Domain Name Services (DNS) name is configured on the machine where RICOH Supervisor Data Collector is installed and contains a suffix that is registered in your DNS server database. The DNS name must be assigned to a reachable IP. Make sure that you use a static IP address.
  • Make sure that the DNS name contains only these ASCII characters:
    • English lowercase characters a-z
    • English uppercase characters A-Z
    • Numbers 0‒9
    • Hyphen-minus character -
TCP/IP ports To allow RICOH Supervisor Data Collector to access the cloud and initiate outgoing connections, open these ports:
  • RICOH Supervisor Data Collector user interface:
    • HTTP: 80
    • HTTPS: 443
To allow the RICOH Supervisor Data Collector web server to communicate with the data sources, open these ports:
  • RICOH Supervisor Data Collector: 19280.

    Configure this port to allow incoming connections from the intranet.

  • Domain Name System (DNS): 53.
  • Printer Web pages: 80.

    Configure this port to allow outgoing requests via TCP.

  • SNMP: 161/162.

    Configure this port to allow RICOH Supervisor Data Collector to initiate outgoing requests via TCP/UDP to contact cut sheet printers.

  • JMF: 8010.

    Configure this port to allow RICOH Supervisor Data Collector to initiate outgoing requests via TCP to contact cut sheet printers.

  • RICOH Productivity Tracker: 10000.

    Configure this port to allow RICOH Supervisor Data Collector to initiate outgoing requests via TCP to contact continuous form printers.

    Important:
  • An IPv4 configuration is required.
  • If your firewall is configured to block the default ports or the ports that you set up during the installation, you must open them. For more information, see the documentation for the Windows firewall. If you are using a different firewall, read the documentation for the firewall on your computer to make sure that the RICOH Supervisor Data Collector ports are open.
Web browser
  • Google Chrome 116 or later
  • Mozilla Firefox 116 or later
  • Microsoft Edge 116 or later
    Important:
  • You must enable JavaScript for the web browser.
Allowed URLs To install RICOH Supervisor Data Collector in the United States, make sure that you allow access to these URLs:
  • https://ricohsoftware.com/datacollector/account-info.json
  • https://datacollector.app-ricohsoftware.com/account-details.json
To run RICOH Supervisor Data Collector, make sure that you allow access to the following domains:
  • For the United States:
    • ricohsoftware.com
    • help.ricohsoftware.com
    • supervisor.app-ricohsoftware.com
    • services.app-ricohsoftware.com
    • datacollector.app-ricohsoftware.com
    • fileupload.app-ricohsoftware.com
    • cognito-idp.us-west-2.amazonaws.com
  • For Europe:
    • ricohsoftware.com
    • help.ricohsoftware.com
    • supervisor.app-ricohsoftware.eu
    • services.app-ricohsoftware.eu
    • datacollector.app-ricohsoftware.eu
    • fileupload.app-ricohsoftware.eu
    • cognito-idp.us-west-2.amazonaws.com
Supported languages Dutch, English, French, German, Italian, Japanese, Spanish

Client Computer Requirements

This table lists the requirements for any computer that accesses RICOH Supervisor Data Collector:

Item Requirements
Display 1280 × 1024 pixels or higher
Operating system Any Windows, Linux, or Mac system that supports one of the required web browsers.
Network access Access to the target server by referring to the IP address or DNS host name.
Web browser
  • Google Chrome 116 or later
  • Mozilla Firefox 116 or later
  • Microsoft Edge 116 or later
Important: You must enable JavaScript for the web browser.
Supported languages Dutch, English, French, German, Italian, Japanese, Spanish

2.2.2 Downloading and Installing RICOH Supervisor Data Collector on Windows

To start monitoring and gathering data from your printers, you must first install the RICOH Supervisor Data Collector application. If a data collector is not available, the Install Data Collector to Get Printer Data page is displayed.
To download and install RICOH Supervisor Data Collector on Windows:
  1. 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.
    Install RICOH Supervisor Data Collector
  2. Check the computer requirements and click Next.
    Install RICOH Supervisor Data Collector
  3. Check the ports that you need to open and click Next.
    Install RICOH Supervisor Data Collector
  4. Check the URLs that need to be white listed from your firewall in order to be accessible for the data collector. Click Next.
    Install RICOH Supervisor Data Collector
  5. On the Download & Install Data Collector page, click Download Data Collector for Windows or click here for Linux.
    Download RICOH Supervisor Data Collector
  6. Save the installation file to your computer.
    The procedure for saving the file depends on the web browser.
  7. Launch the installer as an administrator.
  8. When the installer is displayed, select a language and click OK.
  9. In the Welcome dialog box, click Next.
  10. In the License Agreement dialog box:
    1. Read the license agreement.
    2. Click I accept the terms of the License Agreement.
    3. Click Next.
  11. In the Install Folder dialog box:
    1. 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.
    2. 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.
  12. In the Shortcut Folder dialog box:
    1. Specify where you want to create the product icons.
    2. Click Next.
  13. In the Proxy Settings dialog box:
    1. Review and update the information, if necessary. The installer attempts to detect automatically your system proxy configuration.
    2. Click Next.
  14. In the Choose Region dialog box:
    1. 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
    2. Click Next.
  15. In the Configure ports dialog box:
    1. 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.
    2. Click Next.
  16. In the Summary dialog box:
    1. Review the information you provided.
    2. To go back and edit the information you provided, click Previous.
    3. To proceed, click Install.
  17. After the installation is complete, select the Open RICOH Supervisor - Data Collector check box to open the application.
  18. Click Done to close the installer.
When you upgrade RICOH Supervisor Data Collector, you are prompted to restart the computer. Click Restart.

If RICOH Supervisor Data Collector does not launch after the computer restart, launch the Change Installation executable file, run Repair, then restart the computer again.

You can also repair RICOH Supervisor Data Collector with the command line option.

Run the command in the installation path on the computer where RICOH Supervisor Data Collector is installed:

"Change Installation.exe" -i silent -repair

2.2.3 Downloading and Installing RICOH Supervisor Data Collector on Linux

To start monitoring and gathering data from your printers, you must first install the RICOH Supervisor Data Collector application. If a data collector is not available, the Install Data Collector to Get Printer Data page is displayed.
To download and install RICOH Supervisor Data Collector on Linux:
  1. 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.
    Install RICOH Supervisor Data Collector
  2. Check the computer requirements and click Next.
    Install RICOH Supervisor Data Collector
  3. Check the ports that you need to open and click Next.
    Install RICOH Supervisor Data Collector
  4. Check the URLs that need to be white listed from your firewall in order to be accessible for the data collector. Click Next.
    Install RICOH Supervisor Data Collector
  5. On the Download & Install Data Collector page, click Download Data Collector for Linux or click here for Windows.
    Download RICOH Supervisor Data Collector
  6. Save the installation file to your computer.
    The procedure for saving the file depends on the web browser.
  7. Run the command:
    chmod 777 DC*.bin
  8. Launch the installer as root using the command:
    sudo ./DC-*.bin
  9. When the installer is displayed, select a language and click OK.
  10. In the Welcome dialog box, click Next.
  11. In the License Agreement dialog box:
    1. Read the license agreement.
    2. Click I accept the terms of the License Agreement.
    3. Click Next.
  12. In the Link Folder dialog box:
    1. Specify where you want to create the product links.
    2. Click Next.
  13. In the Proxy Settings dialog box:
    1. Review and update the information, if necessary. The installer attempts to detect automatically your system proxy configuration.
    2. Click Next.
  14. In the Choose Region dialog box:
    1. 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
    2. Click Next.
  15. In the Configure ports dialog box:
    1. 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.
    2. Click Next.
  16. In the Summary dialog box:
    1. Review the information you provided.
    2. To go back and edit the information you provided, click Previous.
    3. To proceed, click Install.
  17. After the installation is complete, select the Open RICOH Supervisor - Data Collector check box to open the application.
  18. Click Done to close the installer.
      Note:
    • The default installation location, /opt/RICOH/DataCollector, cannot be changed.
    • The SupervisorWeb Service commands are:
      sudo systemctl start SupervisorWeb
      sudo systemctl stop SupervisorWeb
      sudo systemctl restart SupervisorWeb
      sudo systemctl status SupervisorWeb
    • If the SupervisorWeb Service commands are not recognized after installation, restart the Linux server.

When you upgrade RICOH Supervisor Data Collector, you are prompted to restart the computer. Click Restart.

If RICOH Supervisor Data Collector does not launch after the computer restart, launch the Change Installation executable file, run Repair, then restart the computer again.

You can also repair RICOH Supervisor Data Collector with the command line option.

Run the command:

./'Change Installation' -i silent -repair

2.2.4 Downloading and Installing RICOH Supervisor Data Collector with Command Line

To start monitoring and gathering data from your printers, you must first install the RICOH Supervisor Data Collector application. If a data collector is not available, the Install Data Collector to Get Printer Data page is displayed.
You can download and install RICOH Supervisor Data Collector using the command line installation:
  1. 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.
    Install RICOH Supervisor Data Collector
  2. Check the computer requirements and click Next.
    Install RICOH Supervisor Data Collector
  3. Check the ports that you need to open and click Next.
    Install RICOH Supervisor Data Collector
  4. Check the URLs that need to be white listed from your firewall in order to be accessible for the data collector. Click Next.
    Install RICOH Supervisor Data Collector
  5. On the Download & Install Data Collector page, click Download Data Collector for Windows or click here for Linux.
    Download RICOH Supervisor Data Collector
  6. Save the installation file to your computer.
    The procedure for saving the file depends on the web browser.
  7. Open a command prompt.
  8. 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_NO_PROXY={true|false} | -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_NO_PROXY No Yes Use/do not use proxy true/false System proxy settings (Windows)
    -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.
    Note: After the command line installation, it takes approximately 2 minutes for RICOH Supervisor Data Collector to become functional.
    Note: If you use the sudo command when launching the installer on a Linux system, the proxy settings (if not specified) will default to the system proxy settings only if the -E option is specified:
    sudo INSTALLER -E -i silent -DC_REGION={USA|Europe} [{-DC_NO_PROXY={true|false} | -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>]

2.2.5 Upgrading RICOH Supervisor Data Collector

Whenever a new version of RICOH Supervisor Data Collector is available, a message is displayed on the footer and on the top banner of the interface. The message shows the version number and lets you know that you can download the new version.
To download and install a new version of RICOH Supervisor Data Collector when you already have RICOH Supervisor Data Collector installed:
  1. On the RICOH Supervisor Data Collector main page, click either DOWNLOAD UPDATE on the top banner, or Download button, the Download button, on the RICOH Supervisor Data Collector footer.
    RICOH Supervisor Data Collector footer
    Note: Make sure that your system meets all the listed requirements.
  2. Save the installation file to your computer.
    The procedure for saving the file depends on the web browser.
  3. Launch the installer as an administrator on a Windows system or as root on a Linux system.
  4. When the installer is displayed, select a language and click OK.
  5. Follow the installer prompts to install the new version.
    You receive this message that lets know that you already have RICOH Supervisor Data Collector installed on your computer.Warning message
  6. Click Continue.
  7. After the installation is complete, select the Open RICOH Supervisor Data Collector check box to open the application.
  8. Click Done to close the installer.
When you upgrade RICOH Supervisor Data Collector, you are prompted to restart the computer. Click Restart.

If RICOH Supervisor Data Collector does not launch after the computer restart, run Repair, then restart the computer again. For information on how to run Repair, see the documentation of your operating system.

You can also download the most recent version of RICOH Supervisor Data Collector from the General Settings page. Click Download button, the Download button, under Available updates.General Settings page

2.2.6 Upgrading RICOH Supervisor Data Collector with Command Line

Whenever a new version of RICOH Supervisor Data Collector is available, a message is displayed on the footer and on the top banner of the interface. The message shows the version number and lets you know that you can download the new version.
To download and install a new version of RICOH Supervisor Data Collector when you already have RICOH Supervisor Data Collector installed:
  1. On the RICOH Supervisor Data Collector main page, click either DOWNLOAD UPDATE on the top banner, or Download button, the Download button, on the RICOH Supervisor Data Collector footer.
    RICOH Supervisor Data Collector footer
    Note: Make sure that your system meets all the listed requirements.
  2. Save the installation file to your computer.
    The procedure for saving the file depends on the web browser.
  3. Launch the installer using the command line option:
    INSTALLER -i silent
    Note: The commands do not prompt for input when run from the command line.

2.2.7 Moving RICOH Supervisor Data Collector to a New Server

You can move RICOH Supervisor Data Collector to a new server.
To move RICOH Supervisor Data Collector to a new server:
  1. Sign out from the RICOH Supervisor Data Collector server and save the RICOH Supervisor Data Collector name.
  2. Uninstall RICOH Supervisor Data Collector. In the Uninstall RICOH Supervisor - Data Collector dialog box, make sure the Delete the Data Collector from the cloud check box is not selected. Click Uninstall and Done.
  3. Wait for 5-10 minutes before you continue.
  4. Install RICOH Supervisor Data Collector on the new server.
  5. Under Restore from previous Data Collector, click RESTORE. Select the data collector that you want to restore from the list. Make sure that you select the correct data collector for the restore procedure.
      Note:
    • When you uninstall a data collector and then restore it on a different computer, make sure you follow the procedure above to be able to restore it again on the first computer.

2.2.8 Uninstalling RICOH Supervisor Data Collector

To uninstall RICOH Supervisor Data Collector:
  1. Start the uninstall process on the computer where RICOH Supervisor Data Collector is installed:
    • On Windows, go to C:\Program Files\RICOH\Supervisor\_manage_installation and double-click Change Installation.exe.

      If you changed the default path, go to the install folder that you selected during the installation.

    • On Linux, open a terminal window as the root user and enter this command:
      '/opt/RICOH/DataCollector/_manage_installation/Change Installation'
    If you chose to create shortcuts during the installation, you can also use the RICOH Supervisor - Data Collector - Change Installation shortcut to start the uninstall process.
  2. In the Maintenance Mode dialog box:
    1. Select Uninstall Product.
    2. Click Next.
  3. In the Uninstall RICOH Supervisor - Data Collector dialog box, select the Delete the Data Collector from the cloud check box if you want to delete your data collector from the cloud.
    Important: If you select the Delete the Data Collector from the cloud check box, the RICOH Supervisor Data Collector application and all real-time data are permanently deleted. Historical data gathered by the data collector is still kept in the cloud. If you perform this action, you cannot restore your data collector at a later date.
  4. Click Uninstall.
  5. Click Done.

2.2.9 Uninstalling RICOH Supervisor Data Collector with Command Line

To uninstall RICOH Supervisor Data Collector using the command line option:
  1. Start the uninstall process on the computer where RICOH Supervisor Data Collector is installed:
    • On Windows, go to C:\Program Files\RICOH\Supervisor\_manage_installation, open a command prompt and run the command:
      "Change Installation.exe" -i silent -uninstall [-DC_DELETE_FROM_CLOUD=<deleteFromCloud>] [-DC_RESTART_SYSTEM={true|false}]
    • On Linux, go to /opt/RICOH/DataCollector/_manage_installation, open a command prompt and run the command:
      ./'Change Installation' -i silent -uninstall [-DC_DELETE_FROM_CLOUD=<deleteFromCloud>] [-DC_RESTART_SYSTEM={true|false}]
    Command Line Options
    Command Line Options Mandatory Optional Details Values Default Values
    -DC_DELETE_FROM_CLOUD No Yes Delete RICOH Supervisor Data Collector from cloud. true/false false
    -DC_RESTART_SYSTEM No Yes Restart system after the uninstall is finished. true/false installation setting
    Note: The commands do not prompt for input when run from the command line.

2.2.10 Restoring RICOH Supervisor Data Collector

You can restore a previous configuration stored in the cloud and continue tracking your data sources. A data collector can be retrieved from the cloud only if you do not select the Delete the Data Collector from the cloud check box when you uninstall the application. You can connect to an existing data collector only after a fresh install.
To restore a previously configured data collector:
  1. Follow the installation steps from Downloading and Installing RICOH Supervisor Data Collector on Windows.

    Restoring a data collector

  2. Under Restore from previous Data Collector, click RESTORE.
  3. Select the data collector that you want to restore from the list.
    The list contains uninstalled data collectors and data collectors that are currently offline, including active data collectors that are temporarily offline. Make sure that you select the correct data collector for the restore procedure. If you restore an offline data collector that is already installed on another machine, you will no longer be able to use that data collector on the initial machine.
  4. Click GET STARTED.

When you uninstall a data collector and then restore it on a different computer, you cannot restore it again on the first computer.

Important: To restore a data collector previously configured on a virtual machine, do not use the data collector from the VMware snapshot. Instead, run a new installation of RICOH Supervisor Data Collector and recover the data collector from the cloud.

2.2.11 Signing In

After the installation procedure is completed, you can sign in to RICOH Supervisor Data Collector from your machine or from client workstations using a web browser.
Sign in page

Before you try to sign in, make sure that one of the supported web browsers is installed and configured.

To sign in from the computer where RICOH Supervisor Data Collector is installed:

  1. Go to the folder where RICOH Supervisor Data Collector is installed and double-click RICOH Supervisor - Data Collector in the bin subfolder. The default web browser opens and you see the Sign in page.

    If you chose to create shortcuts during the installation, you can also use the RICOH Supervisor - Data Collector shortcut to open the application.

  2. Enter the user name and the password you used to sign up for RICOH Supervisor Data Collector.
  3. Click SIGN IN.

To sign in to RICOH Supervisor Data Collector from a supported web browser:

  1. Open a web browser window.
  2. Enter this URL in the address bar:

    http://server_address:port_number/DataCollector

    where server_address is the host name or the IP address of the computer where RICOH Supervisor Data Collector is installed and port_number is the web server port.

  3. On the Sign in page, enter the user name and the password you used to sign up for RICOH Supervisor Data Collector.
  4. Click SIGN IN.
    Note: If your password expired or you forgot it, click Forgot password. An email containing a verification code is sent to the email address attached to your account. Follow the instructions in the email to reset your password.

After 15 minutes of inactivity, your session expires. You must log in to continue using the application. Even if you are logged out after 15 minutes of inactivity, RICOH Supervisor Data Collector continues to run in the background.

    Important:
  • When you sign in to RICOH Supervisor Data Collector for the first time, you must use the customer account email and password you obtained when you signed up, to ensure that the data collector is assigned to the proper account.
  • After you install RICOH Supervisor Data Collector on your computer and you perform the first sign-in procedure, as an authorized administrator, the data collector is automatically registered in the cloud. You can choose between creating a new data collector or restoring an existing data collector that is offline and currently not in use.

To sign out from RICOH Supervisor Data Collector, click Account button, the Account button, and select Sign out.

About your subscription
  • If you are using a trial version of RICOH Supervisor Data Collector, a banner on top of the page displays the remaining days of your trial. To close the banner, click Close button, the Close button.
  • If you have subscribed to RICOH Supervisor Data Collector, a banner on top of the page displays the expiration date of your subscription. The banner is visible 30 days before the expiration date. To close the banner, click Close button, the Close button.
  • If your subscription expired, the system displays a warning page and you cannot perform other actions within the application. Contact your Ricoh specialist to renew your subscription. The system keeps your data and history for 30 days after the subscription expiration.

2.3 Configuration

This section provides useful information for configuring the system.

2.3.1 Configuring the Data Collector

After you install RICOH Supervisor Data Collector, you can configure your data collector according to your needs.
To configure your data collector:
  1. On the main page, click Settings button, the Settings button, in the top-right corner.
  2. Select General Settings.
    The General Settings page is displayed.General Settings page
  3. Configure the settings from the General tab.
    These settings are available:
    Name
    You can edit the name of the data collector.
    Store Data Locally
    To keep the collected data only locally, enable the Store Data Locally option. To set the storage location, you can enter a file path in the input field or you can click Browse for Folder button, the Browse for Folder button, to create or select a folder on the computer where RICOH Supervisor Data Collector is installed. Enabling local data storage may require additional disk space.

    Browse for Folder dialog box

      Important:
    • If you enable Store Data Locally, RICOH Supervisor Data Collector does not send data to the cloud and, as a result, you cannot see the data in RICOH Supervisor. Use this option only if you have other means of analyzing data.
    • Even if Store Data Locally is enabled, you must have an internet connection for your subscription to be validated.
    • RICOH Supervisor Data Collector does not manage your local data storage. If you enable Store Data Locally, the data collector creates a series of files with the data collected from the printers, in the specified location, each time new data is collected. Delete or move any unnecessary files created by the data collector in the data storage location.

    Current version
    This field displays the RICOH Supervisor Data Collector version installed on your system.
    Available updates
    This field displays the latest RICOH Supervisor Data Collector version that is currently available. If an update is available, you can click the download button to download the installation package for the new version.
    Description
    You can enter a description for the data collector.
    Use HTTP Proxy Server
    Enable the Use HTTP Proxy Server option if you want to enable proxy settings for the internet connection. Improper proxy configuration may cause connectivity issues with the cloud. If there are any connectivity issues, the system displays an offline status at the top of the main page.
    Host Address
    Specify the IP address or the DNS name for the proxy server.
    Port
    Specify the port number for the proxy server.
    Username
    Enter a valid user name for the proxy server.
    Password
    Enter the password for the specified user name.
    Bypass/Exclude Hosts
    Specify the IP address or the DNS name for the proxy server exceptions. You can add or remove exceptions from the bypass list by using the plus or the minus button. Each exception must be listed on a separated line.
    Important: You have access to data collector settings without authentication from the RICOH Supervisor Data Collector host server. You must secure the host server and allow access only to authorized personnel.
  4. To save the changes, click OK.

2.4 Working with Printers

This section provides useful information for configuring printers as data sources for RICOH Supervisor Data Collector.
Note: For best results, we recommend that you add one printer as data source for a maximum number of two data collectors.

2.4.1 Scanning for Printers

To add printers in RICOH Supervisor Data Collector, you can scan the network for devices. The network scan is performed through SNMP v1/v2.
To start the automatic printer search:
  1. In the top-right corner of the Printers page, expand the Add Printer... menu and select Scan for Printers.
    The Add Printer... menu is disabled when the data collector is offline or when the data source usage limit has been reached.
  2. In the Scan for Printers dialog box, specify the IP range and the SNMP community name, and then click FIND PRINTERS.
    Scan for Printers dialog box
  3. Select the printers that you want to add and click ADD PRINTERS.
  4. Select a time zone for each printer in the list and click SAVE.
      Note:
    • RICOH Supervisor Data Collector uses the printer time zone to correctly identify the printer and collect accurate data. Make sure that the value set for the Time Zone option matches the time zone settings configured on the printer.

      For time zones that observe daylight saving time, the Adjust for daylight saving time automatically check box is selected by default. You can clear the check box if you do not want to apply the daylight saving time adjustment. For time zones that do not observe daylight saving time, the Adjust for daylight saving time automatically option is disabled.

    • By default, this option displays the time zone received from the printer.
    • You can change the time zone of the first printer from the list and then click Apply Below to set the same time zone for the rest of the printers.
    The system displays the added printers as individual cards on the Printers page.
  5. To edit printer properties, right-click a printer card and select Properties.
    Important:
  • RICOH Supervisor Data Collector can use the Scan for Printers function only if you enable the SNMP v1/v2 protocol on the physical printer. For more information, see the printer documentation.
  • When your data source limit is reached, based on your subscription, you cannot add another printer to the data collector. For information on managing account and user settings, see the RICOH Account Administration documentation.
  • You can add printers from different networks to the same data collector as long as the data collector can reach both networks. Otherwise, you need a separate data collector for each network.
  • To avoid duplicate historical data, make sure that you do not add the same printer to multiple data collectors.
  • When the data collector is not connected to the cloud, you cannot add, edit, or delete a data source. When the connection with the cloud is restored, all functions are enabled.

2.4.2 Adding Printers Manually

You can easily register new printers using the Add Printer... function.
To add a printer manually:
  1. On the Printers page, click the Add Printer... button.
    The Add Printer... button is disabled when the data collector is offline or when the data source usage limit has been reached.
  2. Edit the printer properties in the New Printer dialog box.
    New Printer dialog box
    For more information on the available settings, see Editing Printer Properties.
    Based on the specified IP address or host name, RICOH Supervisor Data Collector identifies the printer serial number. 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. If you enter a different name for the data source, the new name also applies to the existing historical data.

    By default, the Resume tracking the previous data source option is enabled and a list with the names of the previous data sources identified in the system is displayed. Only inactive data sources that are no longer registered in any data collector appear in the list. You can disable the Resume tracking the previous data source option if you want to create a new data source instead.Serial Number setting

  3. Click OK.
    Important:
  • When your data source limit is reached, based on your subscription, you cannot add another printer to the data collector. For information on managing account and user settings, see the RICOH Account Administration documentation.
  • You can add printers from different networks to the same data collector as long as the data collector can reach both networks. Otherwise, you need a separate data collector for each network.
  • To avoid duplicate historical data, make sure that you do not add the same printer to multiple data collectors.
  • When the data collector is not connected to the cloud, you cannot add, edit, or delete a data source. When the connection with the cloud is restored, all functions are enabled.

2.4.3 Editing Printer Properties

You can edit the properties of newly added printers or of printers that are already configured in RICOH Supervisor Data Collector.
To edit printer properties:
  1. Right-click a printer card and select Properties from the menu.
    Printer options menu

    If you add a printer using the Add Printer... button, you see the New Printer dialog box. New Printer dialog box

  2. Configure the printer settings.
    IP Address or Host Name
    Specify a valid printer IP address or host name. The printer IP address or host name is required and must be unique.
    Note: Use a static IP address or, if you use DHCP, make sure that the DNS provides the same IP address constantly for the MAC physical address of the printer network card. Manufacturer, Model, Printer Type, Serial Number, Time Zone, Printer Character Set, and JMF URL are updated whenever you change IP Address or Host Name and move focus from the field or press the Enter key.
    Name
    Specify the printer name. The printer name is required and must be unique.
    Description
    Add a description for the printer.
    Manufacturer
    Specifies the name of the printer manufacturer. The system updates the value whenever the IP Address or Host Name changes. You can change the value of this property.
    Model
    Specifies the printer model. The system updates the printer model whenever the IP Address or Host Name changes. You cannot change the value of this property.
    Printer Type
    Defines the communication channels that are used to collect printer data. RICOH Supervisor Data Collector uses several communication channels and protocols to retrieve data from the printers you added in the application. Each printer type communicates with the printer through one or more different channels. The Printer Type value is updated whenever you change IP Address or Host Name. You can change the printer type, but we recommend that you do that only if you know that the type of data you need can be collected through a different communication channel.
      Important:
    • RICOH Supervisor Data Collector determines the Printer Type by sending a query via SNMP to the specified IP address. Make sure that the SNMP settings are correct.
    • For the printer to communicate its details, make sure that the printer is turned on when you add it to RICOH Supervisor Data Collector.

    The following printer types are available:

    RICOH Pro VC
    Used with RICOH continuous form printers from the Pro VC series: RICOH Pro VC40000, RICOH Pro VC60000, RICOH Pro VC70000, and RICOH Pro VC80000.
    InfoPrint 5000
    Used with RICOH continuous form printers from the InfoPrint 5000 series.
    InfoPrint 4100
    Used with RICOH continuous form printers from the InfoPrint series: InfoPrint 4000 and InfoPrint 4100.
    RICOH GW Cut Sheet Printer
    Used with printers that are operated through RICOH GW controllers.
    RICOH Fiery Cut Sheet Printer
    Used with printers that are operated through Fiery controllers.
    RICOH TotalFlow Print Server Cut Sheet Printer
    Used with cut sheet printers that are operated through TotalFlow Print Server controllers.
    Generic SNMP Printer
    Used with all printers that use SNMP and do not belong to any of the other supported printer types.
    Note: Generic SNMP Printer collects only printer information. If you need job information, select one of the other printer types and make sure that the communication channel is enabled at the printer.

    Depending on the selected Printer Type, a communication channel becomes available. Enter all the required information.

    For more information on the supported printers, see Supported Printers. For more information on the data collected for each printer type, see Collected Data.

    Serial Number
    Specifies the serial number of the physical printer.

    RICOH Supervisor Data Collector identifies the printer serial number based on the IP Address or Host Name setting. 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. If you enter a different name for the data source, the new name also applies to the existing historical data.

    New Printer dialog box

    By default, the Resume tracking the previous data source option is enabled and a list with the names of the previous data sources identified in the system is displayed. Only inactive data sources that are no longer registered in any data collector appear in the list. You can disable the Resume tracking the previous data source option if you want to create a new data source instead.Serial Number setting

    Time Zone
    Specifies the time zone of the physical printer.

    RICOH Supervisor Data Collector uses the printer time zone to correctly identify the printer and collect accurate data. Make sure that the value set for the Time Zone option matches the time zone settings configured on the printer.

    For time zones that observe daylight saving time, the Adjust for daylight saving time automatically check box is selected by default. You can clear the check box if you do not want to apply the daylight saving time adjustment. For time zones that do not observe daylight saving time, the Adjust for daylight saving time automatically option is disabled.

      Note:
    • After you specify the IP Address or Host Name setting, this option displays the time zone received from the printer.
    • If you change the time zone settings on the printer, you must manually update the Time Zone option.
    • The specified time zone applies to all future data collected from the printer.
    Printer Character Set
    Specifies the character set used to process and display printer data.

    RICOH Supervisor Data Collector uses the character set to display printer data, such as job names, correctly. 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.

      Note:
    • After you specify the IP Address or Host Name setting, this option displays the character set received from the printer. If the printer does not provide character set information, RICOH Supervisor Data Collector sets the value to Default - ISO-8859-1 - Western Alphabet.
    • If you change the printer language settings, you must manually update the Printer Character Set option.
    • The specified character set applies to all future data collected from the printer.
  3. Configure the RICOH Pro Scanner Option that provides data about print head cleaning, quality control, and collected logs.
    Note: The RICOH Pro Scanner Option is only available for RICOH Pro VC 60000, 70000 and 80000 printers.
    Status
    Specify the status of log collection service from the RICOH Pro Scanner server. You can enable or disable RICOH Pro Scanner server to collect and upload logs to cloud.
    RICOH Pro Scanner Server IP Address or Host Name
    Specify a valid RICOH Pro Scanner Server IP address or host name. The printer IP address or host name is required.
    Note: Each time you modify the IP address or host name of the server and click the TEST button, RICOH Supervisor Data Collector performs a test connection and tries to detect the server. If the IP address or host name of the RICOH Pro Scanner Server is correct, the server will appear ‘Connected’. The message ‘Cannot reach RICOH Pro Scanner Server’ indicates an incorrect IP address or a connection problem.
  4. To save the changes, click OK.
    To discard the changes, click Cancel.
Note: When the data collector is not connected to the cloud, you cannot add, edit, or delete a data source. When the connection with the cloud is restored, all functions are enabled.

2.4.3.1 Generic SNMP Printer

Use this printer type for RICOH printers or any other printer that has Simple Network Management Protocol (SNMP) enabled and a proper printer Management Information Base (MIB) implementation. This printer type provides only printer information.

For more information on the data collected through this printer type, see Collected Data.

New Printer dialog box - Generic SNMP Printer

Select the Simple Network Management Protocol (SNMP) version to establish connectivity between the data collector and the data source. The following SNMP versions are available:

SNMP v1/v2

Select this option if you want to collect data from SNMP v1/v2 enabled printers. Make sure that SNMP is enabled on the printer. If you select SNMP v1/v2, you must specify the Read Community Name setting.

Read Community Name
Specifies the name of the SNMP community to which the printer belongs. This value must match the SNMP community name set on the physical printer.
SNMP v3

Select this option if you want to collect data from SNMP v3 enabled printers. Use SNMP v3 for RICOH printers or any other printer that has SNMP v3 enabled and a proper printer MIB implementation. Make sure that SNMP is enabled on the printer. If you select SNMP v3, you must specify the Username, Context Name, and Security Level settings.

Username
Specifies the name of the user the message is being exchanged for. The value specified in this field must match the user name set on the printer.
Context Name
Specifies the SNMP v3 context name as defined on the device. The value specified in this field must match the context name set on the printer.

This setting is optional.

Security Level
Specifies the SNMP v3 security level:
  • Minimum: without authentication and privacy.

  • Medium: with authentication, but without privacy.

  • Maximum: with authentication and privacy.

To use the Maximum level, this information is required:

Authentication Type
Specifies the authentication protocol used to encrypt and decrypt the messages exchanged between the data collector and the printer:
  • MD5: HMAC-MD5-96 authentication protocol.

  • SHA: HMAC-SHA-96 authentication protocol.

The specified authentication type must match the printer settings.

Authentication Password
Specifies the password used for encrypting the communication. The value specified in this field must match the password set on the printer.
Privacy Type
Specifies the type of privacy protocol between the data collector and the printer:
  • DES: The Data Encryption Standard uses a 56-bit key for each 64-bit block of data.
  • AES-128: The Advanced Encryption Standard uses a 128-bit key for a fixed block size of 128-bit.
  • AES-192: The Advanced Encryption Standard uses a 192-bit key for a fixed block size of 128-bit.
  • AES-256: The Advanced Encryption Standard uses a 256-bit key for a fixed block size of 128-bit.

The specified privacy type must match the printer settings.

Privacy Password

Specifies the privacy key to use with the privacy protocol. The privacy password set in this field and the privacy password set on the printer must match.

Note: 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.

2.4.3.2 RICOH Pro VC

Use this printer type for RICOH continuous form printers from the Pro VC series: RICOH Pro VC40000, RICOH Pro VC60000, RICOH Pro VC70000, and RICOH Pro VC80000.

For more information on the data collected through this printer type, see Collected Data.

Important: Before using this printer type, make sure that Printer Feature 5565 is enabled. This feature allows extended communication with the printer through RICOH Productivity Tracker.

New Printer dialog box - RICOH Pro VC

Select the Simple Network Management Protocol (SNMP) version to establish connectivity between the data collector and the data source. You can find instructions for this step in Generic SNMP Printer .

When RICOH Productivity Tracker is used, RICOH Supervisor Data Collector polls the printer and sends data to the cloud every 30 seconds. This interval can cause delays in data availability and can affect the information displayed in the Real Time Display tab from RICOH Supervisor.

To enable an available feature on the physical printer:

  1. On the Configuration page, select DFE and Features.
  2. Click the Install button to display the list of available Feature Codes.
  3. Select the feature you want to enable and click OK.

Important: The data about printed paper length collected by RICOH Productivity Tracker might not always be exact due to the printer communication delays. Sometimes there might be a difference of a few feet between the reported data and the actual length of printed paper.

2.4.3.3 InfoPrint 5000

Use this printer type for RICOH continuous form printers from the InfoPrint 5000 series.

For more information on the data collected through this printer type, see Collected Data.

Important: Before using this printer type, make sure that Printer Feature 5565 is enabled. This feature allows extended communication with the printer through RICOH Productivity Tracker.

New Printer dialog box - InfoPrint 5000

Select the Simple Network Management Protocol (SNMP) version to establish connectivity between the data collector and the data source. You can find instructions for this step in Generic SNMP Printer .

When RICOH Productivity Tracker is used, RICOH Supervisor Data Collector polls the printer and sends data to the cloud every 30 seconds. This interval can cause delays in data availability and can affect the information displayed in the Real Time Display tab from RICOH Supervisor.

To enable an available feature on the physical printer:

  1. To display the Features Administrator panel from the main panel in the operator console, select Printer Definition and Features.
  2. Click Install to display the list of available Feature Codes.
  3. Select the feature you want to enable or disable and click OK.
  4. To enable a selected feature, select Enable. To disable a selected feature, select Disable.
  5. Click Close.

Note: The printer must be stopped before this function can be performed.

To perform this function, you must have a service role.

Important: The data about printed paper length collected by RICOH Productivity Tracker might not always be exact due to the printer communication delays. Sometimes there might be a difference of a few feet between the reported data and the actual length of printed paper.

2.4.3.4 InfoPrint 4100

Use this printer type for RICOH continuous form printers from the InfoPrint series: InfoPrint 4000 and InfoPrint 4100.

For more information on the data collected through this printer type, see Collected Data.

Important: Before using this printer type, make sure that Printer Feature 5565 is enabled. This feature allows extended communication with the printer through RICOH Productivity Tracker.

New Printer dialog box - InfoPrint 4100

Select the Simple Network Management Protocol (SNMP) version to establish connectivity between the data collector and the data source. You can find instructions for this step in Generic SNMP Printer .

When RICOH Productivity Tracker is used, RICOH Supervisor Data Collector polls the printer and sends data to the cloud every 30 seconds. This interval can cause delays in data availability and can affect the information displayed in the Real Time Display tab from RICOH Supervisor.

To enable an available feature on the physical printer:

  1. To display the Features Administrator panel from the main panel in the operator console, select Printer Definition and Features.
  2. Click Install to display the list of available Feature Codes.
  3. Select the feature you want to enable or disable and click OK.
  4. To enable a selected feature, select Enable. To disable a selected feature, select Disable.
  5. Click Close.

Note: The printer must be stopped before this function can be performed.

To perform this function, you must have a service role.

Important: The data about printed paper length collected by RICOH Productivity Tracker might not always be exact due to the printer communication delays. Sometimes there might be a difference of a few feet between the reported data and the actual length of printed paper.

2.4.3.5 RICOH GW Cut Sheet Printer

Use this printer type for printers that are operated through RICOH GW controllers.

For more information on the data collected through this printer type, see Collected Data.

New Printer dialog box - RICOH GW Cut Sheet Printer

Select the Simple Network Management Protocol (SNMP) version to establish connectivity between the data collector and the data source. You can find instructions for this step in Generic SNMP Printer .

RICOH Supervisor Data Collector polls the printer and sends data to the cloud every 30 seconds. This interval can cause delays in data availability and can affect the information displayed in the Real Time Display tab from RICOH Supervisor.

Note: 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.

2.4.3.6 RICOH Fiery Cut Sheet Printer

Use this printer type for printers that are operated through Fiery controllers. You can receive limited job data through SNMP or you can use RICOH API for Fiery to receive detailed job information.

For more information on the data collected through this printer type, see Collected Data.

New Printer dialog box - RICOH Fiery Cut Sheet Printer

Select the Simple Network Management Protocol (SNMP) version to establish connectivity between the data collector and the data source. You can find instructions for this step in Generic SNMP Printer .

RICOH API for Fiery - Status Enabled
When Status is Enabled, job data is collected through RICOH API for Fiery. The data collector receives detailed job information, such as job ID, job name, job state, copies, pages, sheets, and impressions.

Make sure that the printer has Fiery API version 5.2.27.01 or later and the Fiery patch for RICOH Supervisor. See the Fiery Command WorkStation documentation for information on updating Fiery API.

To use RICOH API for Fiery, you must authenticate with a user name and password that match the credentials used to register on the RICOH Fiery Cut Sheet Printer. If you did not change the default credentials, enter admin for the user name and Fiery.1 for the password.

Click TEST to make sure that there are no connection or authentication issues. RICOH Supervisor Data Collector verifies the connection with the printer and retrieves the printer time zone. If you want to set a different time zone, select another value from the Time Zone list.

    Note:
  • This function is only available with the RICOH API for Fiery feature. If you want to purchase this feature, contact your Ricoh representative.
  • Make sure that you have the Fiery patch installed: FIT102429972 (for Windows-based Fiery controllers) or FIT102430496 (for Linux-based Fiery controllers).
  • For RICOH Pro9500 printers, make sure that you have the minimum version of RICOH API for Fiery installed: 5.2.75.00 and the Fiery patch installed: SP3_FIT102693514 (for Windows-based Fiery controllers).
  • For RICOH ProC7500 printers, make sure that you have the minimum version of RICOH API for Fiery installed: 5.2.75.00 and the Fiery patch installed: SP3_FIT102693519 (for Windows-based Fiery controllers).
  • If you want to use RICOH API for Fiery with printers that are already registered in RICOH Supervisor Data Collector, you must edit the printer properties and enable the RICOH API for Fiery option. Then, follow the steps to authenticate and connect to the printer and adjust the printer time zone as necessary.
  • For jobs submitted directly through Fiery Command WorkStation, Fiery Hot Folders, or FTP, the printing side information might not be reported correctly. To solve the problem, you can set the printing side for each submitted job manually. Right-click the job and select Properties.... In the Job properties dialog box, go to Layout and select a Duplex option. For exact instructions, see the documentation for your Fiery Command WorkStation version.
  • The number of copies is only available for jobs that have finished printing.
  • In some cases, when 2-sided jobs with an uneven number of pages are submitted through PostScript from external applications, the printing side information is not registered correctly on the printer and the job is reported as 1-sided.
RICOH API for Fiery - Status Disabled
When Status is Disabled, data is collected using SNMP. The data collector only receives limited job information, such as job state or error messages.
    Note:
  • 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.
  • For accurate job data, set the printed queue limit to 99 in Fiery Command WorkStation. Go to Servers Device Center Server Configuration and click the Configure button in the bottom-right corner. Then, go to Job Management Printed Queue and enter 99 under Jobs saved in printed queue. For exact instructions, see the documentation for your Fiery Command WorkStation version.
  • In some cases, when printing together multiple short-run jobs, it is possible that some jobs will not be reported in RICOH Supervisor while collecting job data using SNMP.

2.4.3.7 RICOH TotalFlow Print Server Cut Sheet Printer

Use this printer type for printers that are operated through TotalFlow Print Server controllers.

For more information on the data collected through this printer type, see Collected Data.

New Printer dialog box - RICOH TotalFlow Print Server Cut Sheet Printer

Select the Simple Network Management Protocol (SNMP) version to establish connectivity between the data collector and the data source. You can find instructions for this step in Generic SNMP Printer .

You can use the JMF URL field to monitor the printer through JMF communication.

When JMF communication is used, RICOH Supervisor Data Collector polls the printer and sends data to the cloud every 30 seconds. This interval can cause delays in data availability and can affect the information displayed in the Real Time Display tab from RICOH Supervisor.

2.4.4 Supported Printers

This section lists the printers supported by RICOH Supervisor Data Collector.
    Note:
  • The list of printers is kept up to date as support is added for new printers. Check this section periodically to make sure that you have the latest information.
  • Only the printers that have been officially tested are included in the list. You can also register other printers that can communicate through SNMP and collect data using the Generic SNMP Printer configuration. For more information, see Generic SNMP Printer .
Printers with Fiery controllers:
  • Pro C5200 Series Fiery E-24B/E-44B
  • Pro C5300 Series Fiery E-27B/E-47B
  • Pro C7100 Series Fiery E-43A/E-83A
  • Pro C7200 Series Fiery E-35A/E-36A
  • Pro C7200 Series Fiery E-45A/E-46A/E-85A/E-86A
  • Pro C9100 Series Fiery E-43/E-83
  • Pro C9200 Series Fiery E-45/E-46/E-85/E-86
  • Pro 8200 Fiery EB-34
  • Pro 8300 Fiery EB-35
Printers with RICOH Fiery controllers:
  • Pro C9500 Series Fiery N-50/N-70
  • Pro C7100 Series Fiery N-50A/N-70A
Printers with RICOH controllers (GW):
  • Pro C5100 GW
  • Pro C5210 GW
  • Pro C5310S GW
  • Pro C7110 GW
  • Pro C7200 GW
  • Pro C7210 GW
  • Pro C8110 GW
  • Pro C8200EX GW
  • Pro 8300S GW
  • Pro 8320 GW
Continuous form printers:
  • InfoPrint 4100
  • InfoPrint 5000
  • Pro VC40000 TotalFlow Print Server
  • Pro VC60000 TotalFlow Print Server
  • Pro VC70000 TotalFlow Print Server
  • Pro VC80000 TotalFlow Print Server
TotalFlow Print Server cut sheet printers:
  • Pro C7100 Series TotalFlow Print Server R-60
  • Pro C7200 Series TotalFlow Print Server R-62A
  • Pro C7200SX Series TotalFlow Print Server R-62A
  • Pro C9000 SeriesTotalFlow Print Server R-62
Other printers:
  • RICOH MP 6055SP
  • RICOH SP 4520DN
  • HP Color LaserJet CP2025

2.4.5 Collected Data

This table shows the type of data that RICOH Supervisor Data Collector can receive from data sources, depending on the selected printer type.
Collected Data RICOH Pro VC InfoPrint 5000 InfoPrint 4100 RICOH GW Cut Sheet Printer RICOH Fiery Cut Sheet Printer (See note 4*) Generic SNMP Printer RICOH TotalFlow Print Server Cut Sheet Printer
Printer current state Yes Yes Yes Yes Yes Yes Yes
Printer usage statistics Yes Yes Yes Yes Yes Yes Yes
Printed paper length (See note *1) Yes Yes Yes No No No No
Number of clicks No No No Yes Yes Yes Yes
Ink Yes No No No No No No
Printer warnings and errors Yes Yes Yes Yes Yes Yes Yes
Number of printed jobs Yes Yes Yes Yes Yes No Yes
Number of sheets Yes Yes Yes Yes Yes No Yes (See note 3*)
Number of copies Yes Yes Yes Yes Yes No Yes (See note 2*)
Number of pages Yes Yes Yes No Yes No Yes (See note 3*)
Job name (See note *5) Yes Yes Yes Yes Yes No Yes (See note 2*)
Job ID Yes Yes Yes Yes Yes No Yes
Number of impressions Yes Yes Yes Yes Yes No Yes
Job state Yes Yes Yes Yes Yes No Yes
Job warnings and errors Yes Yes Yes Yes Yes No Yes
Job size Yes Yes Yes Yes Yes No Yes
Operator data Yes Yes Yes No No No No
Preset data Yes Yes Yes No No No No
Black & white printed pages - RICOH API for Fiery No No No No Yes No No
Color printed pages - RICOH API for Fiery No No No No Yes No No
Blank printed pages - RICOH API for Fiery No No No No Yes No No
Tabs printed - RICOH API for Fiery No No No No Yes No No
Rip duration (Seconds) - RICOH API for Fiery No No No No Yes No No
Note:
1* The data about printed paper length collected by RICOH Productivity Tracker might not always be exact due to the printer communication delays.
2* For IPDS jobs, RICOH Supervisor Data Collector does not collect this information from TotalFlow Print Server cut sheet printers.
3* Number of total pages for the entire printing session.
4* When RICOH API for Fiery option is enabled.
5* This field only supports a limited number of characters. The limit varies based on the printer you receive information from:
  • Continuous form printers - maximum 255 characters
  • Printers that are operated through Fiery controllers:
    • SNMP - maximum 64 characters, or
    • Fiery API - maximum 256 characters
  • Cut sheet printers that are operated through TotalFlow Print Server controllers - maximum 255 characters
  • Other printers that use SNMP - maximum 64 characters

2.4.6 Editing Multiple Printers

You can select multiple printers and specify their time zone.
To edit multiple printers and set their time zone:
  1. Right-click a printer card and choose Select.
  2. Select the printers that you want to edit.
    You can use the Select All check box if you want to select all the printers.
  3. Click Set Time Zone... in the top-right corner of the page.
  4. In the Set Time Zone dialog box, select a time zone for each printer in the list.
      Note:
    • RICOH Supervisor Data Collector uses the printer time zone to correctly identify the printer and collect accurate data. Make sure that the value set for the Time Zone option matches the time zone settings configured on the printer.

      For time zones that observe daylight saving time, the Adjust for daylight saving time automatically check box is selected by default. You can clear the check box if you do not want to apply the daylight saving time adjustment. For time zones that do not observe daylight saving time, the Adjust for daylight saving time automatically option is disabled.

    • You can change the time zone of the first printer from the list and then click Apply Below to set the same time zone for the rest of the printers.
    • The specified time zone applies to all future data collected from the printer.
  5. Click SAVE.
Note: When the data collector is not connected to the cloud, you cannot add, edit, or delete a data source. When the connection with the cloud is restored, all functions are enabled.

2.4.7 Printer Connectivity Status

You can monitor the state of the connection between the data collector and each individual data source by looking at the printer cards.

Printer connection status

The printer connection states are:

Not configured
No communication channel communicates with the printer.
Connected
The enabled communication channels are gathering and transferring all required data.
Partial data transfer
One or more enabled communication channels are not transferring data. Not all the necessary data metrics are gathered from the device. This might affect the data available in RICOH Supervisor. The system displays the date and time of the first connectivity issue.
Not connected
There is no data transfer. None of the communication channels are gathering data. The device might be offline or the configuration settings of the communication channels might be wrong. The system displays the date and time of the first connectivity issue.
    Note:
  • To receive accurate information on the printer status, make sure that you enable the SNMP protocol on the physical printer and that you configure RICOH Supervisor Data Collector printers with SNMP.
  • The system displays a warning message when the connection with the cloud is interrupted. If the connection with the cloud is not active, the sign-in page and the main page display a warning banner.

2.4.8 Reordering and Selecting Printers

You can manually change the layout of the printer cards on the Printers page.
  • To move a printer card, click the printer card and hold the mouse button, then drag the printer card to the new location.

    Printers page

  • To view printers in a list, click List view button, the List view button. To view printers in cards, click Tile view button, the Tile view button.
  • To view printer properties, delete printers, or select printers, right-click a printer card and use the options available in the menu.
  • To add a printer, scan for printers, or select all the printers, right-click the empty space in the Printers page.
  • Hold the Shift key while selecting so that all the printer cards selected are added to the current selection.
  • Hold the Ctrl key while selecting so that any selection on a printer card changes its state from selected to not selected and from not selected to selected.
  • Hold the Alt key while selecting a printer card to deselect all the other printer cards.
  • You can select multiple printer cards and drag the entire selection in the desired order on the Printers page. To select more printer cards, click and drag a selection rectangle starting from the empty space on the Printers page. When using the rectangle selection, use the Ctrl or Shift key to add printers to the selection and the Alt key to remove a printer from the selection.

To close the printer selection, click Close button, the Close button.

2.4.9 Finding Printers

The search function lets you find printers based on their properties.
To find a printer:
  1. On the Printers page, click Search button, the Search button, in the top-right corner.
    You can search for a printer by entering the printer name, model, manufacturer, IP address or host name, status, or type. The search results are displayed in a table along with all the printer properties.
  2. Select the printer that you want to view.

2.4.10 Deleting Printers

You can remove the printers that you no longer need.
To delete a printer configured in RICOH Supervisor Data Collector:
  1. Right-click the printer card and select Delete... or click Menu button, the menu button, on the printer card and select Delete....
  2. To delete the printer, click Yes.
    To cancel the delete action, click No.
      Important:
    • The delete action cannot be undone. The system displays a warning dialog box.
    • After you delete a printer, you no longer receive information from that printer, but historical data is still available in the system.
    • The deleted printer no longer counts towards your data source usage limit.
    • When the data collector is not connected to the cloud, you cannot add, edit, or delete a data source. When the connection with the cloud is restored, all functions are enabled.
You can also delete multiple printers at once. Right-click a printer card and choose Select. Then, select all the printers that you want to delete and click Delete... in the top-right corner of the page.

2.5 Security

Authorized users can access RICOH Supervisor Data Collector using a registered email address and a valid password. The levels of access and the actions the users can perform depend on the associated user role.

2.5.1 User Roles and Permissions

Everyone who works with RICOH Supervisor Data Collector has a user account that is assigned to a role. Roles define the levels of access and the actions the users can perform.

These user roles are available:

Administrator
The administrator role has full access rights throughout the RICOH Supervisor Data Collector system:
  • Can install RICOH Supervisor Data Collector.
  • Can manage the list of data sources.
  • Can manage the settings and plug-ins.
Viewer
  • Can only view the list of already defined data sources.
  • Can view data source properties.
  • Can monitor the connection status.
None
This account is for authenticated users with no role in RICOH Supervisor Data Collector.
    Note:
  • After your authentication in RICOH Supervisor Data Collector, the system retrieves the roles and permissions attached to your account.
  • You have access to data collector settings without authentication from the RICOH Supervisor Data Collector host server. You must secure the host server and allow access only to authorized personnel.

2.5.2 Enabling HTTPS for RICOH Supervisor Data Collector

RICOH Supervisor Data Collector provides support for using the HTTPS protocol. The HTTPS protocol facilitates secure network communication by establishing an encrypted link between the server and the web browser user interface and ensures the privacy and integrity of all transmitted data.

2.5.2.1 Enabling HTTPS on Windows Servers

This procedure provides the steps for enabling HTTPS on Windows 10. There might be minor differences in other versions of Windows.
To enable HTTPS, you need a digital certificate. You can use a certificate signed by a certificate authority (CA) or a self-signed certificate.
    Important:
  • This procedure uses the Java keytool command. For details about using keytool, see the Java documentation or the documentation provided by the certificate authority.
  • If you changed the default installation path, make sure that you replace C:\Program Files\RICOH\Supervisor\ with the path where RICOH Supervisor Data Collector is installed everywhere in the procedure.
  • Save copies of these files in a safe location in case you need to restore them in the future:
    • C:\Program Files\RICOH\Supervisor\apache-tomcat\conf\server.xml
    • C:\Program Files\RICOH\Supervisor\apache-tomcat\conf\web.xml
    • C:\Program Files\RICOH\Supervisor\config.json
  1. Obtain the digital certificate and store it on the computer where RICOH Supervisor Data Collector is installed.
    • To use a certificate signed by a certificate authority:
      1. Follow the instructions provided by the certificate authority for obtaining a signed certificate and importing it into a keystore file.
      2. Copy the keystore file to the computer where RICOH Supervisor Data Collector is installed. Make sure that you know the password for the keystore file.
      3. Open a Command Prompt window as an administrator.
      4. Go to the folder that contains the Java keytool:
        cd "C:\Program Files\RICOH\Supervisor\jre\bin"
      5. Import the keystore file into the Java trusted certificates store used by RICOH Supervisor Data Collector:
        keytool -importkeystore -srckeystore "keystore_path" -destkeystore "C:\Program Files\RICOH\Supervisor\jre\lib\security\cacerts" -srcstorepass keystore_password -deststorepass changeit

        Replace keystore_path with the path to your keystore file. Leave the quotation marks.

        Replace keystore_password with the password for your keystore file.

    • To create a self-signed certificate:
      1. On the computer where RICOH Supervisor Data Collector is installed, open a Command Prompt window as an administrator.
      2. Go to the folder that contains the Java keytool:
        cd "C:\Program Files\RICOH\Supervisor\jre\bin"
      3. Generate a local keystore file and a self-signed certificate:
        keytool -genkey -keyalg RSA -alias ricohsupervisor -keypass keystore_password -keystore "C:\Program Files\RICOH\Supervisor\ricohsupervisor-localkeystore.jks" -storepass keystore_password -validity certificate_validity -keysize 2048 -ext san=dns:localhost

        Replace keystore_password with the password that you want to set for the keystore file.

        Replace certificate_validity with the number of valid days for the certificate. For example, enter 90 for 90 days.

      4. Import the generated keystore file into the Java trusted certificates store used by RICOH Supervisor Data Collector:
        keytool -importkeystore -srckeystore "C:\Program Files\RICOH\Supervisor\ricohsupervisor-localkeystore.jks" -destkeystore "C:\Program Files\RICOH\Supervisor\jre\lib\security\cacerts" -srcstorepass keystore_password -deststorepass changeit

        Replace keystore_password with the password that you set for the keystore file.

  2. Stop the RICOH Supervisor Data Collector service:
    1. Go to Control Panel Administrative Tools and double-click Services.
    2. In the list of services, right-click RICOH Supervisor Web Server and select Stop.
  3. Enable HTTPS:
    1. Go to C:\Program Files\RICOH\Supervisor\apache-tomcat\conf and edit the server.xml file as an administrator.
    2. Find this code:
      <!--
      <Connector executor="tomcatThreadPool"
       	port="19280"  URIEncoding="UTF-8" protocol="HTTP/1.1"
      	connectionTimeout="20000"
       	redirectPort="8443" />
      -->
    3. Insert this code below it:
      <Connector protocol="org.apache.coyote.http11.Http11NioProtocol" 
      	port="8443" maxThreads="200" scheme="https" secure="true" 
      	SSLEnabled="true" keystoreFile="keystore_path" 
      	keystorePass="keystore_password" clientAuth="false" 
      	sslProtocol="TLS" sslEnabledProtocols="TLSv1.2" />
    4. Replace keystore_path with the path to your keystore file. Leave the quotation marks.
      If you generated a self-signed certificate, use "C:\Program Files\RICOH\Supervisor\ricohsupervisor-localkeystore.jks".
    5. Replace keystore_password with the password for your keystore file. Leave the quotation marks.
    6. Save and close the file.
  4. Redirect HTTP requests to HTTPS:
    1. Go to C:\Program Files\RICOH\Supervisor\apache-tomcat\conf and edit the web.xml file as an administrator.
    2. Go to the last line in the file, </web-app>.
    3. Insert this code right before the last line:
      <security-constraint>
      	<web-resource-collection>
      		<web-resource-name>Entire Application</web-resource-name>
      		<url-pattern>/*</url-pattern>
      	</web-resource-collection>
      	<!-- auth-constraint goes here if you require authentication -->
      	<user-data-constraint>
      		<transport-guarantee>CONFIDENTIAL</transport-guarantee>
      	</user-data-constraint>
      </security-constraint>
    4. Save and close the file.
  5. Change the internal server address:
    1. Go to C:\Program Files\RICOH\Supervisor and edit the config.json file as an administrator.
    2. Replace the line "webAddress": "http://localhost:19280", with "webAddress": "https://localhost:8443",.
    3. Save and close the file.
  6. Start the RICOH Supervisor Data Collector service:
    1. Go to Control Panel Administrative Tools and double-click Services.
    2. In the list of services, right-click RICOH Supervisor Web Server and select Start.
  7. Verify that requests are forwarded to the secure connection:
    1. Open a supported web browser window.
    2. Enter this URL in the address bar:

      http://server_address:port_number/DataCollector

      where server_address is the host name or the IP address of the computer where RICOH Supervisor Data Collector is installed and port_number is the web server port.

      When the page loads, the address should change to https://server_address:port_number/DataCollector.

When users access the system, they are redirected to the secure protocol without having to take any action themselves. However, if you use a self-signed certificate or if the certificate is not specifically tied to the server, the web browser issues a warning that the certificate is not trusted.

Make sure that you repeat the procedure for enabling HTTPS whenever the certificate is about to expire. You must also repeat this procedure each time you run the installation process to reinstall, upgrade, or repair RICOH Supervisor Data Collector.

After you repair RICOH Supervisor Data Collector, if you no longer want to enable HTTPS, you must change the internal server address back to HTTP:

  1. Go to C:\Program Files\RICOH\Supervisor and edit the config.json file as an administrator.
  2. Replace the line "webAddress": "https://localhost:8443", with "webAddress": "http://localhost:19280",.
  3. Save and close the file.
  4. Restart the RICOH Supervisor Data Collector service.

2.5.2.2 Enabling HTTPS on Linux Servers

This procedure provides the steps for enabling HTTPS on Red Hat Enterprise Linux. There might be minor differences in other Linux distributions.
To enable HTTPS, you need a digital certificate. You can use a certificate signed by a certificate authority (CA) or a self-signed certificate.
    Important:
  • This procedure uses the Java keytool command. For details about using keytool, see the Java documentation or the documentation provided by the certificate authority.
  • Save copies of these files in a safe location in case you need to restore them in the future:
    • /opt/RICOH/DataCollector/apache-tomcat/conf/server.xml
    • /opt/RICOH/DataCollector/apache-tomcat/conf/web.xml
    • /opt/RICOH/DataCollector/config.json
  1. Obtain the digital certificate and store it on the computer where RICOH Supervisor Data Collector is installed.
    • To use a certificate signed by a certificate authority:
      1. Follow the instructions provided by the certificate authority for obtaining a signed certificate and importing it into a keystore file.
      2. Copy the keystore file to the computer where RICOH Supervisor Data Collector is installed. Make sure that you know the password for the keystore file.
      3. Open a terminal window as the root user.
      4. Go to the folder that contains the Java keytool:
        cd /opt/RICOH/DataCollector/jre/bin
      5. Import the keystore file into the Java trusted certificates store used by RICOH Supervisor Data Collector:
        keytool -importkeystore -srckeystore "keystore_path" -destkeystore "/opt/RICOH/DataCollector/jre/lib/security/cacerts" -srcstorepass keystore_password -deststorepass changeit

        Replace keystore_path with the path to your keystore file. Leave the quotation marks.

        Replace keystore_password with the password for your keystore file.

    • To create a self-signed certificate:
      1. On the computer where RICOH Supervisor Data Collector is installed, open a terminal window as the root user.
      2. Go to the folder that contains the Java keytool:
        cd /opt/RICOH/DataCollector/jre/bin
      3. Generate a local keystore file and a self-signed certificate:
        keytool -genkey -keyalg RSA -alias ricohsupervisor -keypass keystore_password -keystore "/opt/RICOH/DataCollector/ricohsupervisor-localkeystore.jks" -storepass keystore_password -validity certificate_validity -keysize 2048 -ext san=dns:localhost

        Replace keystore_password with the password that you want to set for the keystore file.

        Replace certificate_validity with the number of valid days for the certificate. For example, enter 90 for 90 days.

      4. Import the generated keystore file into the Java trusted certificates store used by RICOH Supervisor Data Collector:
        keytool -importkeystore -srckeystore "/opt/RICOH/DataCollector/ricohsupervisor-localkeystore.jks" -destkeystore "/opt/RICOH/DataCollector/jre/lib/security/cacerts" -srcstorepass keystore_password -deststorepass changeit

        Replace keystore_password with the password that you set for the keystore file.

  2. Stop the RICOH Supervisor Data Collector service:
    sudo systemctl stop SupervisorWeb
  3. Enable HTTPS:
    1. Go to /opt/RICOH/DataCollector/apache-tomcat/conf and edit the server.xml file as the root user:
      sudo gedit /opt/RICOH/DataCollector/apache-tomcat/conf/server.xml
    2. Find this code:
      <!--
      <Connector executor="tomcatThreadPool"
       	port="19280"  URIEncoding="UTF-8" protocol="HTTP/1.1"
      	connectionTimeout="20000"
       	redirectPort="8443" />
      -->
    3. Insert this code below it:
      <Connector protocol="org.apache.coyote.http11.Http11NioProtocol" 
      	port="8443" maxThreads="200" scheme="https" secure="true" 
      	SSLEnabled="true" keystoreFile="keystore_path" 
      	keystorePass="keystore_password" clientAuth="false" 
      	sslProtocol="TLS" sslEnabledProtocols="TLSv1.2" />
    4. Replace keystore_path with the path to your keystore file. Leave the quotation marks.
      If you generated a self-signed certificate, use "/opt/RICOH/DataCollector/ricohsupervisor-localkeystore.jks".
    5. Replace keystore_password with the password for your keystore file. Leave the quotation marks.
    6. Save and close the file.
  4. Redirect HTTP requests to HTTPS:
    1. Go to /opt/RICOH/DataCollector/apache-tomcat/conf and edit the web.xml file as the root user:
      sudo gedit /opt/RICOH/DataCollector/apache-tomcat/conf/web.xml
    2. Go to the last line in the file, </web-app>.
    3. Insert this code right before the last line:
      <security-constraint>
      	<web-resource-collection>
      		<web-resource-name>Entire Application</web-resource-name>
      		<url-pattern>/*</url-pattern>
      	</web-resource-collection>
      	<!-- auth-constraint goes here if you require authentication -->
      	<user-data-constraint>
      		<transport-guarantee>CONFIDENTIAL</transport-guarantee>
      	</user-data-constraint>
      </security-constraint>
    4. Save and close the file.
  5. Change the internal server address:
    1. Go to /opt/RICOH/DataCollector and edit the config.json file as the root user:
      sudo gedit /opt/RICOH/DataCollector/config.json
    2. Replace the line "webAddress": "http://localhost:19280", with "webAddress": "https://localhost:8443",.
    3. Save and close the file.
  6. Start the RICOH Supervisor Data Collector service:
    sudo systemctl start SupervisorWeb
  7. Verify that requests are forwarded to the secure connection:
    1. Open a supported web browser window.
    2. Enter this URL in the address bar:

      http://server_address:port_number/DataCollector

      where server_address is the host name or the IP address of the computer where RICOH Supervisor Data Collector is installed and port_number is the web server port.

      When the page loads, the address should change to https://server_address:port_number/DataCollector.

When users access the system, they are redirected to the secure protocol without having to take any action themselves. However, if you use a self-signed certificate or if the certificate is not specifically tied to the server, the web browser issues a warning that the certificate is not trusted.

Make sure that you repeat the procedure for enabling HTTPS whenever the certificate is about to expire. You must also repeat this procedure each time you run the installation process to reinstall, upgrade, or repair RICOH Supervisor Data Collector.

After you repair RICOH Supervisor Data Collector, if you no longer want to enable HTTPS, you must change the internal server address back to HTTP:

  1. Go to /opt/RICOH/DataCollector and edit the config.json file as the root user:
    sudo gedit /opt/RICOH/DataCollector/config.json
  2. Replace the line "webAddress": "https://localhost:8443", with "webAddress": "http://localhost:19280",.
  3. Save and close the file.
  4. Restart the RICOH Supervisor Data Collector service.

2.6 Troubleshooting and Support

If you encounter problems while working with RICOH Supervisor Data Collector, you might be able to solve them by using the information in this section.

2.6.1 Uploading Diagnostic Data

If you encounter issues while using RICOH Supervisor Data Collector, you can easily upload diagnostic data that can help troubleshoot the problem.
To upload diagnostic data:
  1. Make sure that you have at least 10 GB of free space available on the drive where RICOH Supervisor Data Collector is installed.
  2. Sign in to RICOH Supervisor Data Collector.
  3. On the menu bar, click Help button, the Help button, and select Send Diagnostic Data.
  4. In the Send Diagnostic Data dialog box, provide more information about the encountered issue and upload the diagnostic data.
    Send Diagnostic Data dialog box
    1. Under Topic, select the type of issue.
      For example, you might encounter connectivity issues or issues with missing or inaccurate data.
    2. Under Printers, select the printers that we should focus on during the investigation of the issue.
      Data is still collected and sent for all the printers registered in the system.
    3. Under Message, enter any other useful information that you would like to include with the diagnostic data.
    4. Click SUBMIT.
    Once the diagnostic data is uploaded, software support can use it to investigate the reported issue. For more information on the collected data, click What information is being sent?.
    Note: You can upload diagnostic data only when the data collector is connected to the cloud. If the data collector is not connected to the cloud, you can instead download the data locally and provide it to your Ricoh support representative.
You can check the status of the data upload in the Activity Log tab. If the upload encountered problems, such as file size or disk space issues, and was unsuccessful, collect the traces manually.

2.6.2 Common Problems

If you encounter problems while using RICOH Supervisor Data Collector, you might be able to solve them by using the information in this section.
Collecting Traces

To help troubleshoot a problem, you can gather traces from your data collector. RICOH Supervisor Data Collector uses a tracing mechanism that records the code activity.

Use one of these methods to collect the data collector traces together with any additional system information, such as installation details and disk space:

  • Upload diagnostic data. For more information, see Uploading Diagnostic Data.

      Note:
    • The traces are automatically collected and uploaded to cloud.
    • You need to sign in to upload diagnostic data.
  • Download the traces by entering this URL in the address bar of your web browser:

    http://server_address:port_number/DataCollector/traces

    where server_address is the host name or the IP address of the computer where RICOH Supervisor Data Collector is installed and port_number is the web server port.

    If you are on the computer where RICOH Supervisor Data Collector is installed and you are using the default port, you can go to http://localhost:19280/DataCollector/traces.

    The resulting package is named dc_traces_yyyymmdd_hhmmss_code.zip, where yyyymmdd and hhmmss represent the date and time when the traces were collected and code is a randomly generated identification code.

      Note:
    • The first part of the URL for collecting traces matches the RICOH Supervisor Data Collector URL. You can simply add /traces at the end of the URL that you are using to access the application.
    • You can collect the traces without signing in.
    • You must send the traces to a Ricoh representative.
  • Manually generate a zip file with collected traces, following these steps:

    1. Log in remotely on the machine where RICOH Supervisor Data Collector is installed.
    2. Download the traces by launching the getTraces.bat script on Windows or the getTraces.sh script on Linux. If RICOH Supervisor Data Collector is installed in the default location, the location of the .bat is C:\Program Files\RICOH\Supervisor\bin for Windows and the location of the .sh on Linux is/opt/RICOH/DataCollector/bin for Linux.
    3. The resulting package is named DataCollector-Traces-timestamp.zip, where timestamp represents the timestamp in milliseconds when the traces were collected.

    Note: You can collect the traces when RICOH Supervisor Data Collector is not accessible via web browser.
Your Region Is Unreachable During the Installation

If the region where you want to store your data cannot be selected in the Choose Region dialog box, 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

Issues with Blocked URLs

For installing RICOH Supervisor Data Collector in the United States, make sure that you allow access to these URLs:

  • For the United States:
    • ricohsoftware.com
    • help.ricohsoftware.com
    • supervisor.app-ricohsoftware.com
    • services.app-ricohsoftware.com
    • datacollector.app-ricohsoftware.com
    • fileupload.app-ricohsoftware.com
    • cognito-idp.us-west-2.amazonaws.com
  • For Europe:
    • ricohsoftware.com
    • help.ricohsoftware.com
    • supervisor.app-ricohsoftware.eu
    • services.app-ricohsoftware.eu
    • datacollector.app-ricohsoftware.eu
    • fileupload.app-ricohsoftware.eu
    • cognito-idp.us-west-2.amazonaws.com

If your network uses a web content filtering system, make sure that you allow access to these URLs:

  • For the United States:
    • *.ricohsoftware.com
    • *.app-ricohsoftware.com
    • *.amazonaws.com
  • For Europe:
    • *.ricohsoftware.eu
    • *.app-ricohsoftware.eu
    • *.amazonaws.com

Restarting the RICOH Supervisor Data Collector Service

Use this procedure if you encounter problems and need to restart the RICOH Supervisor Data Collector service manually:

To restart the RICOH Supervisor Data Collector service, follow these steps on the computer where RICOH Supervisor Data Collector is installed:

  • On Windows, go to Control Panel Administrative Tools and double-click Services. In the list of services, right-click RICOH Supervisor Web Server and select Restart.
  • On Linux, use this command:
    sudo systemctl restart SupervisorWeb

In the RICOH Supervisor Data Collector application, check the status of the data collector and of your registered printers.

Make sure that there are no connectivity or data collection issues.

The Data Collector Appears to Be Unregistered from the Cloud, Your Subscription Is Valid, and This Instance of RICOH Supervisor Data Collector Has Been Previously Registered

Your data collector might get unregistered from the cloud if there is a power outage, the disk is full, or the internal database gets corrupted. The internal database is used for storing data source information until the data collector is connected to the cloud. Data source information might be lost during a power outage or if the disk is full.

Repeat the authentication steps in RICOH Supervisor and restore your data collector. Instead of selecting a new instance, select the data collector corresponding to your previous installation.

To prevent data loss:

  • Make sure that you use an Uninterruptible Power Supply (UPS) for power outages.
  • Limit access to the computer where RICOH Supervisor Data Collector is installed.
  • Check your disk integrity and space availability periodically.
  • It is recommended to keep your data collector connected to the cloud.

Cannot Launch the Application

If RICOH Supervisor Data Collector does not launch after you restart the computer, run Repair, then restart the computer again.

Or 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.

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.

Cannot Access the Application After Changing the RICOH Supervisor Data Collector Server IP Address or Host Name

To avoid issues, restart the RICOH Supervisor Data Collector server after you change its IP address or host name.

Cannot Access the Application on openSUSE

On openSUSE, make sure you install the insserv-compat package before installing RICOH Supervisor Data Collector. Install RICOH Supervisor Data Collector and restart the computer.

If RICOH Supervisor Data Collector was installed before the insserv-compat package, run Repair, then restart the computer again.

Incorrect Display of a Page

The page was not loaded correctly. Clean the web browser cache and reload the page. See your web browser documentation for instructions on how to clean the cache and reload a page.

Make sure that you are using a supported web browser that is properly configured.

Events Are No Longer Received in the Cloud

Make sure that the data collector is online.

Disable the Store Data Locally option in the General Settings tab.

Disable power saving on the computer where RICOH Supervisor Data Collector is installed. Otherwise, the computer might enter sleep or power save mode and the communication with the cloud might be interrupted.

Events Collected by RICOH Supervisor Data Collector While RICOH Supervisor Is in Maintenance Are Lost

If events are not stored locally and sent to the cloud after the scheduled RICOH Supervisor maintenance period, you might have an older version of RICOH Supervisor Data Collector. Upgrade to the latest version.

The Data Collector Is Not Connected to the Cloud

Check your internet connection and your proxy settings.

Cannot Add, Edit, or Delete a Data Source

Make sure that you are connected to the cloud. When the data collector is not connected to the cloud, you cannot add, edit, or delete a data source.

Make sure that you still have available data sources. See the application footer for information on data source usage.

Make sure that you have appropriate user authority. Contact your Ricoh representative to verify the user role provided by your account.

Printers Are Not Automatically Discovered Through the Scan for Printers Function

For RICOH Supervisor Data Collector to find printers through the Scan for Printers function, you must first enable the SNMP v1/v2 protocol on the physical printer. For more information, see the printer documentation.

Make sure that the scanned printers are online.

Information About Printer Status Is Missing

Make sure that you enable the SNMP protocol on the physical printer and that you configure RICOH Supervisor Data Collector printers with the SNMP communication channel. For information on enabling SNMP on the printer, see the printer documentation.

Information About Jobs Is Missing

Make sure that you select the correct printer type for your printer model and enable the SNMP protocol on the physical printer. For information on enabling SNMP on the printer, see the printer documentation.

Job Names Are Displayed Incorrectly

There is a limited number of characters for the job name field. The limit varies based on the printer you receive information from. If you use more, the printer will send truncated or modified data. To correctly display the job name, limit the field characters to:

  • Continuous form printers - maximum 255 characters
  • Printers that are operated through Fiery controllers:
    • SNMP - maximum 64 characters, or
    • Fiery API - maximum 256 characters
  • Cut sheet printers that are operated through TotalFlow Print Server controllers - maximum 255 characters
  • Other printers that use SNMP - maximum 64 characters.

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 Fiery Cut Sheet Printer configuration.

Information About Ink or Roll Usage Is Missing

Make sure that you select the correct printer type for your printer model and enable the RICOH Productivity Tracker communication channel.

Access to RICOH Supervisor Data Collector Settings Is Allowed Without Authentication from the RICOH Supervisor Data Collector Host Server

You must secure the RICOH Supervisor Data Collector host server and allow access only to authorized personnel.

RICOH Supervisor Data Collector Does Not Manage Local Data Storage

If you enable the Store Data Locally option in the General Settings tab, RICOH Supervisor Data Collector creates a series of files with the data collected from the printers, in the specified location, each time new data is collected. It is your responsibility to process or remove the files.

Cannot Access the RICOH Supervisor Data Collector Online Help System

The RICOH Supervisor Data Collector online help system can be viewed only from computers with internet access. Enable internet access on your computer or use the on-screen field help for useful information.

Data Collected for 1-Sided or 2-Sided Jobs Is Not Accurately Reported Through SNMP

If you are submitting jobs with the same printing side, either 1-sided or 2-sided, make sure that they are all completed and reported as printed by RICOH Supervisor Data Collector, before submitting another set of jobs with the same printing side.

If you want to print jobs with different printing sides, 1-sided or 2-sided, make sure that you submit the jobs one by one. After each submitted job is completed and reported as printed by RICOH Supervisor Data Collector, you can submit the next job.

Performance Issues Caused by Insufficient Random Access Memory (RAM)

To avoid performance issues, we recommend that you register up to 15 printers for 4 GB available RAM.

If you want to monitor a larger number of printers, increase the available RAM or install additional data collectors.

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.

Manually Uninstall RICOH Supervisor Data Collector

Manually deleting the RICOH Supervisor Data Collector service does not allow installing a new data collector.

This procedure provides the steps for manually uninstalling RICOH Supervisor Data Collector.

Make sure that you have appropriate user authority. You must have administrator role to complete the procedure. Contact your Ricoh representative to verify the user role provided by your account.

  • On Windows:

    1. Stop the RICOH Supervisor Data Collector service using one of these methods:
      • Use the Services app.
      • Use this command:
        net stop SupervisorWeb
    2. Remove the RICOH Supervisor Data Collector service using one of these methods:
      • Use the regedit tool, following these steps:
        • Open regedit.
        • Go to HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\SupervisorWeb.
        • Right click on SupervisorWeb and select Delete.
      • Use this command:
        reg delete "HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\SupervisorWeb" /f

        If the RICOH Supervisor Data Collector service entry from the Services app is still available, restart the machine where RICOH Supervisor Data Collector is installed.

    3. Remove the RICOH Supervisor Data Collector uninstall entry from Control Panel using one of these methods:
      • Use the regedit tool, following these steps:
        • Open regedit.
        • Go to HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\RICOH Supervisor - Data Collector.
        • Right click on RICOH Supervisor - Data Collector and select Delete.
      • Use this command:
        reg delete “HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\RICOH Supervisor - Data Collector” /f
    4. Edit the Zero G Registry file:
      • Open File Explorer and change the View options by making the system files and folders visible.
      • Go to C:\Program Files\Zero G Registry and edit the .com.zerog.registry.xml file by deleting everything related to RICOH Supervisor Data Collector and to the path where RICOH Supervisor Data Collector was installed.

      If there are other products mentioned in this file, make sure you only delete the entries related to RICOH Supervisor Data Collector.

      If there is only information related to RICOH Supervisor Data Collector, you can delete the file.

    5. Delete the installation folder (Example: C:\Program Files\RICOH\Supervisor).
    6. Delete the RICOH Supervisor Data Collector shortcuts from the Desktop.

  • On Linux:

    1. Stop the RICOH Supervisor Data Collector service using one of these commands:
      sudo service SupervisorWeb stop
      or
      sudo systemctl stop SupervisorWeb
    2. Remove the RICOH Supervisor Data Collector service using this command:
      sudo rm -f /etc/init.d/SupervisorWeb
    3. Edit the Zero G Registry file:
      • Search for .com.zerog.registry.xml (Example: /var/.com.zerog.registry.xml) or use this command:
        sudo find -iname *zerog.registry.xml
      • Edit the file by deleting everything related to RICOH Supervisor Data Collector and to the path where RICOH Supervisor Data Collector was installed.
    4. Delete the installation folders (Example: /opt/RICOH/DataCollector) using the commands:

      sudo rm -rf /opt/RICOH/DataCollector
      sudo rm -rf /root/.DataCollector

Contacting Ricoh Support

If you need help with a RICOH Supervisor Data Collector 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 support.