Reports

The feature adds one step template and two objects called Data Collectors and Data Transmitters. The Reports feature does not include business intelligence software. You can use your preferred tool with the information stored in the PostgreSQL database.

Step template

• WritePropsToReportsDatabase

  Lets you choose which job and document properties to store in the PostgreSQL database when the step runs and the database table to store the data in. You can insert multiple WritePropsToReportsDatabase steps in a workflow wherever you want to store properties at different times during job processing.

Objects

The Reports feature adds the Data collector and Data transmitter objects.

Data collector

Data collectors let you configure what RICOH ProcessDirector information to store in the PostgreSQL database. You can capture job property values, document property values, printer data, and user activity data using the supplied Data collectors.

Data transmitter

Data transmitters let you configure what information to extract from one or more PostgreSQL databases to send to another application. Data transmitters use the REST protocol to send the data to another application. You can specify when and how often the data is sent.

Installation

If you have the Reports feature installed with a previous version of RICOH ProcessDirector, the Reports feature is updated when you upgrade the base product.

If you are installing the Reports feature for the first time, you do not need to purchase the feature, and it does not require a license key.

When you install the Reports feature, it installs the PostgreSQL database program, which runs on the primary server.

With RICOH ProcessDirector for Linux, the PostgreSQL database can reside on a different server. However, RICOH ProcessDirector cannot create the database on a different computer. If you have RICOH ProcessDirector for Windows, the database program can only store data on the primary server.

For RICOH ProcessDirector version 3.8.3 or earlier, installing and using the Reports feature to collect data in the PostgreSQL database required configuring a Reports.json file. During the upgrading process, RICOH ProcessDirector version 3.8.4 or higher reads your existing Reports.json file and configures the data collectors to match your settings. Editing the Reports.json file is no longer necessary. To make future changes, use the Reports ⇒ Data Collectors tab on the Administration page.

Configuration

You use the Administration page to configure basic information about the PostgreSQL database, such as:

• The database name
• The user and password that RICOH ProcessDirector uses to access the database
• The host name and port of the computer that the database tables are stored on

To configure Reports to collect job data, printer data, or user activity data, you can configure the appropriate data collector to specify the data to capture.

To configure Reports to use the WritePropsToReportsDatabase step, add the step to your workflows as needed. When the step runs, it stores the property values in the specified database tables. If the table does not exist when the step runs, RICOH ProcessDirector creates it.

After the database is created and contains data, you can use SQL statements to query data and to export data to external storage for long-term use or use a data transmitter to send the data to another application that accepts data exchange over the REST protocol.

To configure Reports to send data on a specific schedule, or when the Enabled status changes, you configure the appropriate data transmitter to specify the interval and frequency. You can enable and disable data transmitters to add or remove properties.

You can use the One-time transmission function to send a specific set of data outside the scheduled time, such as when testing the transmitter or to resend data that was previously sent.

Data visualization

To analyze data stored in the PostgreSQL database, you can use a business intelligence tool, such as Tableau. The Reports feature includes a Tableau workbook with sample worksheets that let you visualize the data for pages printed and jobs by customer. After examining the supplied data visualizations, you can create your own data visualizations and publish them to a server or make them available to management.