xxnullxx - 5e4f0aeccfd5400001c7b322

RICOH Account Administration

Ricoh Company, Ltd

1 RICOH Account Administration

RICOH Account Administration is the administration interface for RICOH TotalFlow Cloud applications, such as RICOH Predictive Insight™.
Reference: For information on RICOH TotalFlow Cloud security policies, see RICOH TotalFlow Cloud Security Overview.

1.1 Overview of RICOH Account Administration

Administrators use RICOH Account Administration to manage RICOH TotalFlow Cloud users and other objects used in your applications.

The available functions vary based on the application subscriptions that your company purchased. For all TotalFlow Cloud applications, you use Account Administration to:

  • Add, modify, and delete users.
  • View details about your subscriptions.
  • View and modify your account details.

For some applications, other functions are added so you can:

  • Download and install RICOH Cloud Connector, to help communicate with Ricoh applications installed inside your network.

1.1.1 What's New?

RICOH Account Administration regularly updates available function and fixes defects.

RICOH Account Administration includes various defect fixes and security updates in every deployment. Additional changes for each deployment are listed here.

June 12, 2026
Bug fixes and security updates, including fixes for CWE-117 and CWE-93.
June 11, 2026
Updated help system to include content for Data Export API, a function available for beta testing: Working with the Data Export API – BETA
May 1, 2026
Updated Ricoh TotalFlow Cloud Security Overview.
April 7, 2026
Bug fixes and security updates, including fixes for CVE-2025-45768 and CVE-2026-26007.
January 21, 2026
Bug fixes and security updates, including fixes for CVE-2025-66418 and CVE-2025-66471.
December 17, 2025
Bug fixes and security updates, including fixes for CVE-2025-48976, CVE-2025-7962, and CVE-2025-12383.
October 30, 2025
Bug fixes and security updates, including fixes for CVE-2025-9636 and CVE-2025-48924.
July 30, 2025
  • Bug fixes and security updates, including fixes for CVE-2024-37891 and CVE-2024-12797.
July 23, 2025
  • Bug fixes and security updates, including fixes for CVE-2025-50181 and CVE-2025-50182.
July 9, 2025
  • Updated the Privacy Policy for Japan.
  • Added support for customers in Slovenia and Croatia.
  • Bug fixes and security updates, including fixes for CVE-2021-28168.
July 2, 2025
  • Bug fixes and security updates, including fixes for CVE-2023-52428 and CVE-2023-1370.
June 4, 2025
  • Bug fixes and security updates, including fixes for CVE-2024-47554 and XUC-XUC-MAVEN-100000.
April 23, 2025
  • Bug fixes and security updates, including a fix for CVE-2024-37891.
April 8, 2025
April 2, 2025
  • Updated to change name of RICOH Supervisor to RICOH Predictive Insight in all references.
  • Security updates and bug fixes.
March 12, 2025
  • Performance improvements.
  • Security updates and bug fixes.
February 4, 2025
  • Various security updates, including fixes for CVE-2024-45296, CVE-2024-45590, CVE-2017-20165, and CVE-2024-39338.
  • Editorial changes and bug fixes.
January 29, 2025
  • Various security updates, including fixes for CWE-798.
  • Editorial changes and bug fixes.
December 5, 2024
  • The Ricoh Europe Privacy Policy now also applies to Ukraine, Romania, and Israel.
  • Editorial changes and bug fixes.
October 30, 2024
  • Various security updates, including fixes for CVE-2024-37891.
  • Editorial changes and bug fixes.
October 2, 2024
  • Various security updates, including fixes for CVE-2023-2650, CVE-2023-3446, CVE-2023-49083, CVE-2023-50782, CVE-2024-0727, CVE-2024-26130, and CVE-2023-4807.
  • Editorial changes and bug fixes.
July 17, 2024
  • Removed support for RICOH TotalFlow Producer.
  • Editorial changes and bug fixes.
June 20, 2024
  • Editorial changes and bug fixes.
June 11, 2024
  • Editorial changes and bug fixes.
May 22, 2024
  • Updated the list of supported printers for the RICOH TotalFlow Producer Advanced subscription and also included support for printers with the Ricoh standard internal controller.
  • Editorial changes and bug fixes.
April 30, 2024
  • Editorial changes and bug fixes.
April 15, 2024
  • Editorial changes and bug fixes.
April 9, 2024
  • Editorial changes and bug fixes.
March 14, 2024
  • Editorial changes and bug fixes.
March 7, 2024
  • Editorial changes and bug fixes.
February 27, 2024
  • For the RICOH TotalFlow Producer Advanced subscription, RICOH Account Administration added support for configuring and managing printers.

    To communicate with the printers running in your environment, RICOH Cloud Connector now includes the RICOH Printer Connector component. The RICOH Printer Connector component is currently available only in the Windows version of RICOH Cloud Connector.

  • Editorial changes and bug fixes.
February 13, 2024
  • Editorial changes and bug fixes.
January 30, 2024
  • Editorial changes and bug fixes.
November 14, 2023
  • In support of RICOH TotalFlow Producer, RICOH Account Administration added support for the BETA feature Office Conversion.

    This feature is available with a RICOH TotalFlow Producer Advanced subscription.

August 2, 2023
  • In support of RICOH TotalFlow Producer, RICOH Account Administration added support for these system objects:
    • Automations
    • Connectors
    • Customers
    • Hot folders

    These objects are only visible after you activate a subscription for RICOH TotalFlow Producer, however, instructions for managing them are included in the help system.

June 21, 2023
  • Help system updates.
March 1, 2023
  • Various security updates, including fixes for CVE-2022-41946 and CVE-2022-42003.
November 10, 2022
  • Various security updates, including fixes for CVE-2022-42889.
August 24, 2022
  • Various security updates, including fixes for CVE-2022-31197.
July 27, 2022
  • Various security updates.
June 24, 2022
  • Added support for configuring RICOH Cloud Connector to use HTTPS.
  • Various security updates, including fixes for CVE-2022-21724.
May 17, 2022
  • RICOH Cloud Connector installation through the user interface is now available.
March 11, 2022
  • Updated translations to include RICOH Cloud Connector content.
  • Updated English documentation for RICOH Cloud Connector and overview topics.
February 23, 2022
  • Added support for customers in Canada.
January 19, 2022
  • Various security updates, including fixes for CVE-2021-44228.
October 27, 2021
  • RICOH Cloud Connector is now available.
September 1, 2021
  • Added support for customers in France.
August 25, 2021
  • Added support for customers in Germany.
July 28, 2021
  • Added support for customers in Vietnam.
May 12, 2021
  • Added support for customers in Belgium and Luxembourg.
May 7, 2021
  • Updated the cookie policy for customers in Japan.
March 17, 2021
  • Added support for customers in Portugal.
February 17, 2021
  • Added support for customers in Spain.
December 16, 2020
  • Added support for customers in the Philippines.
December 2, 2020
  • Added support for customers in Switzerland.
September 9, 2020
  • Added support for customers in Japan.
September 2, 2020
  • Updated the Privacy Policy for customers in the United States.
August 5, 2020
  • Added support for customers in Sweden.
May 20, 2020
  • Added support for customers in Malaysia and Mexico.

1.1.2 System Objects

System objects are items that you define in TotalFlow Cloud applications and use to build your solution just as you want it. In Account Administration, some examples of system objects are users and connectors.

The system objects you define in Account Administration might be used across TotalFlow Cloud applications.

1.1.2.1 Connectors

Connectors are applications stored on your local systems that create a link between cloud applications and software or devices installed on-premises. This connection creates a communication path between the systems. To connect to RICOH TotalFlow Cloud, you install RICOH Cloud Connector on a server in your network.

These applications use RICOH Cloud Connector to install and manage subscription licenses:

  • RICOH InfoPrint Manager for Windows and for Linux
  • RICOH Auto Color Adjuster

Related information:

RICOH Cloud Connector

1.1.2.2 Users

Anyone who works with RICOH TotalFlow Cloud applications must be defined as a User.

When Ricoh initially sets up your account, one Administrator user is created. The administrator receives a welcome email from TotalFlow Cloud, with a link to log in and change their initial password. This administrator is responsible for creating users for the rest of your organization.

Users are assigned roles for each application that you have purchased a subscription for. Roles are based on the user's job responsibilities and vary from application to application. For example, Account Administration has two roles that you can assign to users:

Administrator
Users who are permitted to view details about your account, create and manage other users, and administer other objects as required.
None
Users whose job responsibilities include working in your subscribed applications, but not administering users or other objects.

A user might be an Administrator in Account Administration, but a Viewer in an application like RICOH Predictive Insight.

Users are also assigned a role within the TotalFlow Cloud platform. Most users are assigned to the Standard platform role. However, other applications can add special platform roles.

For example, RICOH Predictive Insight adds the Large display platform role. You create a user with the Large display platform role when, for example, you want to show RICOH Predictive Insight dashboards on a display in your production area to show current status. Someone in your company logs in as the Large display user and maximizes the browser window on the large display. The Large display user has View-only access and can stay logged in for the maximum time allowed.

Related information:

Adding Users

1.1.3 User Interface

Users with permission to access RICOH Account Administration can open the user interface from any system that is connected to the Internet and has a supported browser installed.

1.1.3.1 Banner

The banner is the black bar at the top of the user interface. It is available from all pages in the interface.

The icons in the banner let you do a variety of tasks:

  • Switch to another RICOH TotalFlow Cloud application you have access to.

    Click , the App Switcher icon, and choose which app to open. The application opens in the same tab.

  • Submit ideas to improve our applications.

    Click , the Submit Ideas icon, then click Add a New Idea to describe what we should add. You can also review ideas submitted by other customers. If you like the idea, vote for it. Ideas that are supported by more than one customer are likely to catch our attention and have a better chance of being implemented!

  • View notifications sent by system administrators or by the applications themselves.

    Click , the Notifications icon.

      Note:
    • You can see some notifications without opening the Notifications list. These notifications appear in a strip above or below the banner or at the bottom of the browser window.

  • View details about your user ID or your company's account.

    Click , the Account icon. Your user ID and account name are at the top of the menu. Select any option to see the associated settings or information.

  • Get assistance using the application.

    Click , the Help icon, and select Help.

  • View the Terms of Use for TotalFlow Cloud applications.

    Click , the Help icon, and select Terms of Use.

1.1.3.2 Main Page

When you log in to RICOH Account Administration or return to it from a different application, you see the main page with one of the tabs open.

The number of tabs available varies based on the applications that you have subscribed to. All applications include these tabs:

  • Subscriptions
  • Users
  • Details

Other applications add other tabs as needed. For example, with a RICOH Auto Color Adjuster subscription, the Connectors tab is also available.

Most of the tabs show a list of objects in a table. On all tables, you can:

  • Sort the entries.

    Click the table header once to sort in ascending order and again to sort in descending order.

  • Change and rearrange the columns that display.

    Click gear icon, the gear icon, and select Manage Columns.

  • Search for text in the table.

    Click search icon, the Search icon, and type the text to find.

1.1.3.2.1 Connectors Tab

Registered connectors are listed on the Connectors tab in RICOH Account Administration.

Connectors tab

Here are the actions that you can do on this tab:

  • View all the registered connectors and their properties, such as: Status, Version, Platform, or the last time they were contacted.
  • Download the latest RICOH Cloud Connector version for your operating system.

    Click Download and select the operating system.

  • Generate a one-time code to register a cloud connector.

    Click Generate one-time code.

  • Edit, delete, or view the connections associated with a connector.

    Right-click a connector and select an option from the menu.

      Note:
    • To edit a connector, the server that the connector is defined on must be running and you must have a working network connection with it.
    • When you delete a connector, the RICOH Cloud Connector instance is not uninstalled but it becomes unregistered from the cloud and associated subscriptions might be affected.

Clicking , the tools icon, opens a menu from which you can refresh the information in the table and manage the table columns.

1.1.3.2.2 Details Tab

Use the Details tab to see information about your company account.

You can click Edit details, in the top-right corner of the page, to update your company name, contact and billing information, default language, and the timeout period for all the users in your company.

1.1.3.2.3 Subscriptions Tab

Use the Subscriptions tab to view all the subscriptions associated with your account, including those that have expired. You can also download RICOH Cloud Connector, if you need it.

Subscriptions tab

Each subscription that your company has purchased displays as a card on the Subscriptions tab. The card shows the start and expiration dates for the subscription. Clicking Details opens a dialog that shows more information, including:

  • The number and types of each license included with the application
  • Details about the subscription, including any add-ons purchased with it

1.1.3.2.4 Users Tab

The Users tab lets you create and manage the users who have access to your applications.

Users tab

On the Users tab, you can:

  • Create users.

    Click Add user.

  • Edit, copy, and delete existing users.

    Right-click a row and select an option from the menu.

  • Resend invitations to users who have not responded to their initial invitation.

    Right-click a row and select Resend invitation.

1.1.4 RICOH Cloud Connector

RICOH Cloud Connector is an application that you install on your network to manage communication with the RICOH TotalFlow Cloud.

Cloud Connector is required only with specific products and in certain configurations:

  • RICOH InfoPrint Manager Subscription

    If you purchase RICOH InfoPrint Manager Subscription, Cloud Connector is installed with the product. It connects with RICOH TotalFlow Cloud to verify that your subscription has not expired.

  • RICOH Auto Color Adjuster

    RICOH Auto Color Adjuster uses Cloud Connector to manage subscriptions.

Related information:

RICOH Cloud Connector

1.1.5 Accessibility

Ricoh strives to provide products with usable access for everyone, regardless of age or ability.

For more information about the commitment that we have made to accessibility, refer to the Accessibility page on the Ricoh website.

Accessibility features

Accessibility features help users who have disabilities, such as restricted mobility or limited vision, use information technology products successfully.

The major accessibility features in this product let you:

  • Use screen readers, screen magnifiers, and other assistive technologies.
  • Use a keyboard instead of a mouse.
  • Change attributes such as volume, color, contrast, and font size.
  • Distinguish keys by touch without activating them.
  • Attach alternative input and output devices such as special pointing devices and Braille displays.

In addition, the information center and the publications for the product are in an accessible format.

Keyboard navigation

This product uses standard Microsoft Windows navigation keys.

1.1.6 Trademarks

RICOH InfoPrint Manager™ and RICOH Predictive Insight™ are trademarks of Ricoh Company, Ltd. in the United States, other countries, or both.

Firefox is a registered trademark of the Mozilla Foundation.

Google and Chrome are trademarks of Google Inc.

Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates.

Linux is the registered trademark of Linus Torvalds in the U.S. and other countries.

Microsoft, Windows, Windows Server, Windows Vista, and Internet Explorer are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

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

  • Windows Server 2019:
    • Microsoft®Windows Server® 2019 Standard
    • Microsoft®Windows Server® 2019 Essentials
  • Windows Server 2022:
    • Microsoft®Windows Server® 2022 Standard
    • Microsoft®Windows Server® 2022 Essentials
  • Windows 10:
    • Microsoft® Windows 10 Pro
    • Microsoft® Windows 10 Enterprise
  • Windows 11:
    • Microsoft® Windows 11 Pro
    • Microsoft® Windows 11 Enterprise

OpenJDK is a trademark of Oracle America, Inc. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates. Copyright Oracle America, Inc.

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 TotalFlow™ Cloud

Familiarize yourself with TotalFlow Cloud applications so you can start working.

1.2.1 Signing in to RICOH TotalFlow Cloud for the First Time

When your account is created, you receive an email from RICOH TotalFlow Cloud. Use the button in that email to log in for the first time.

To sign in to RICOH TotalFlow Cloud for the first time, follow these steps:
  1. Open the email that you received from RICOH TotalFlow Cloud.
  2. Click Sign in to your account.
    The sign-in page opens in your default web browser.
  3. Type a password in the New password and Confirm password fields, then click create password.
    Passwords must be more than eight characters long and meet the criteria listed on the page.
      Note:
    • The email invitation expires after seven days. If you click the link after the invitation expires, an error page opens and a new email invitation is sent to you automatically.
      Important: Only click the Resend invitation link on that page if you do not see a new email from RICOH TotalFlow Cloud within 15 minutes.
    • If you have other problems creating your account, contact your administrator and ask them to send your invitation again.

Related information:

Getting Started with RICOH TotalFlow Cloud for Administrators
Getting Started with RICOH TotalFlow Cloud for Users

1.2.2 Getting Started with RICOH TotalFlow Cloud for Administrators

Administrators set up TotalFlow Cloud objects and applications to prepare them for others to use. They create user IDs for others and stay aware of scheduled downtime, system updates, and subscription information.

Administrators complete most of their tasks in the RICOH Account Administration application, but might also access and use other applications.

To get started with RICOH TotalFlow Cloud as an Administrator:

  1. Log in and change your password.
    When your user ID is created, you receive an email inviting you to log in and start to use RICOH TotalFlow Cloud applications. The first time you log in, you must reset your password.
      Note:
    • Ricoh only creates one user for your account. That user is an administrator. If you are the first user, you are responsible for adding more users and giving them access to the correct applications. You can create other administrators and delegate responsibilities to them.

    As an Administrator, you are directed to the Account Administration application.

  2. Take action on cookie settings.
    TotalFlow Cloud applications use cookies, some of which are required. Review Managing cookie settings to learn more about cookies and the actions you can take.
  3. Familiarize yourself with the application interface. Review these topics:
  4. Review your account information and subscriptions.
  5. Learn about the components of your system, so you can start to plan the objects you need to create.
  6. Use the procedures included in this section and in the Configuring section to create the user IDs and other objects required for your account.

Related information:

Signing in to RICOH TotalFlow Cloud for the First Time

1.2.2.1 Viewing Subscriptions

You can view details about your subscriptions in RICOH Account Administration.
To view subscriptions:
  1. Sign in to RICOH Account Administration.
  2. Click Subscriptions in the left pane.
    The Subscriptions page contains your subscription cards, along with their current status and expiration dates. A subscription status can be:
    Active
    The subscription is currently available for use.
    Pending
    The subscription's start date has not yet arrived.
    Suspended
    The subscription has been de-activated due to an event such as violation of terms and conditions or lack of payment. It can be restored when the problem is resolved.
    Expired
    The term of the subscription has elapsed.
  3. To expand the subscription details, click Details.

    The Licenses table includes information about the licenses for various functions included in the subscription and all add-ons and the number of each type of license you have purchased under this subscription.

    The Subscription details table contains a summary of the product and all add-ons included in this subscription.

To renew a subscription or purchase more add-ons, contact your Ricoh representative.

1.2.2.2 Adding Users

When you add a user, you specify the user's contact information and what type of role the user has for each application.

You can create a new user or copy an existing user. Copying users can save time, especially when you need to create several users with similar properties.

To add a user:

  1. In the left pane, click Users.
  2. Choose one of these options:
    • To add a new user: Click Add user in the top-right corner of the window.
    • To copy an existing user: Right-click the row for an existing user and select Duplicate.
  3. In the dialog that opens, enter the details for the user.
  4. Under User type, select Internal to create a user account for one of your employees.
  5. Under Platform role, select one of these options:
    • Standard - The user can log in to the application with standard time-out and access options.
    • Large display - The user has view-only access to the application on a large display, and their login does not time out.
  6. Under Access & roles, select the user's access and role for each application. Click the arrow in the Access & roles column for each application.
      Note:
    • Some subscriptions include limitations on the number of users that can be assigned to each role.
  7. Click Ok.
The user receives an email inviting them to log in to RICOH TotalFlow Cloud, where they can modify their information and change their password. The email invitation is valid for seven days.
    Note:
  • If the user does not log in before the email invitation expires, you can send the invitation again. Right-click the user and choose Resend invitation.

Related information:

Users

1.2.3 Getting Started with RICOH TotalFlow Cloud for Users

Users of RICOH TotalFlow Cloud applications fall into a variety of roles from business intelligence analysts to print shop operators.

Most users have access to one RICOH TotalFlow Cloud application. You can also update details about your own user ID and your password.

To get started with RICOH TotalFlow Cloud applications as a user:

  1. Log in and change your password.
    When your user ID is created, you receive an email inviting you to log in and start to use RICOH TotalFlow Cloud applications. The first time you log in, you must reset your password.

    After you change your password, you see the application that you can use.

  2. Take action on cookie settings.
    TotalFlow Cloud applications use cookies, some of which are required. Review Managing cookie settings to learn more about cookies and the actions you can take.
  3. Familiarize yourself with the application interface. Review these topics as they apply to you:
  4. Learn about the components of your system.

Related information:

Signing in to RICOH TotalFlow Cloud for the First Time

1.2.4 Managing cookie settings

RICOH TotalFlow Cloud applications use cookies to improve your experience with our software. You can control the settings for some of those cookies.
RICOH TotalFlow Cloud applications might use these types of cookies:
Strictly necessary cookies
These are cookies that are essential for our applications to function. If you choose not to accept these cookies, you might be unable to log in to our applications or to use other essential features.
Performance cookies
Performance cookies, also known as statistics cookies, collect information about how well our applications function. This information is aggregated and made anonymous, so it cannot be used to identify you.
Performance data collected includes information gathered by Google Analytics. To prevent your data from being collected by Google Analytics, turn off performance cookies.
Functionality cookies
Functionality cookies, also known as preferences cookies, remember information such as the last page you visited or what language you prefer.
Marketing cookies
Marketing cookies collect information about your online activity to help deliver relevant advertising.

To manage cookie settings:

  1. Log in to any TotalFlow Cloud application.
  2. In the banner, click account icon, the Account icon, and select Cookie Settings.
  3. In the Cookie Settings dialog, click View Cookie Statement to see a list of the cookies used in TotalFlow Cloud applications and their descriptions.
  4. Use the switches to turn each type of cookie on or off.
    By default, all cookies are turned on:
  5. Click OK.

1.3 Configuring

Use these procedures to set up your system so other people in your company can use it.

1.3.1 Adding Users

When you add a user, you specify the user's contact information and what type of role the user has for each application.

You can create a new user or copy an existing user. Copying users can save time, especially when you need to create several users with similar properties.

To add a user:

  1. In the left pane, click Users.
  2. Choose one of these options:
    • To add a new user: Click Add user in the top-right corner of the window.
    • To copy an existing user: Right-click the row for an existing user and select Duplicate.
  3. In the dialog that opens, enter the details for the user.
  4. Under User type, select Internal to create a user account for one of your employees.
  5. Under Platform role, select one of these options:
    • Standard - The user can log in to the application with standard time-out and access options.
    • Large display - The user has view-only access to the application on a large display, and their login does not time out.
  6. Under Access & roles, select the user's access and role for each application. Click the arrow in the Access & roles column for each application.
      Note:
    • Some subscriptions include limitations on the number of users that can be assigned to each role.
  7. Click Ok.
The user receives an email inviting them to log in to RICOH TotalFlow Cloud, where they can modify their information and change their password. The email invitation is valid for seven days.
    Note:
  • If the user does not log in before the email invitation expires, you can send the invitation again. Right-click the user and choose Resend invitation.

Related information:

Users

1.4 Managing Objects

After you create users and configure your account details, you can update them as needed.

1.4.1 Managing Account Details

You can modify your account details, including your company and contact information.
To manage account details:
  1. Click Details on the left panel.
  2. Click Edit details.
  3. Modify the information as needed and click Ok.

1.4.2 Modifying User Information

You can modify a user's information when needed.
To modify user information:
  1. Click Users in the left pane.
  2. Right-click the user whose information you want to modify and click Edit.
  3. Modify the user's information as needed and click Ok.

1.4.3 Changing your Password

Change your password to ensure the security of your account.
    Note:
  • If you do not know your current password, open the login page for RICOH TotalFlow Cloud and click Forgot password. Type your email address and click Next. Check your email for a message from RICOH TotalFlow Cloud containing instructions for resetting your password.

To change your password:

  1. Log in to RICOH TotalFlow Cloud.
  2. In the banner, click Account icon, the Account icon, and choose Profile Settings.
  3. On the left side of the Ricoh Software Profile & Preferences page, click Password.
  4. Enter your current password and your new password twice.
  5. Click Change password.
  6. Click Close.
The next time you log in, be sure to use the new password.

1.5 Working with the Data Export API – BETA

With the Data Export API, you can extract information collected by RICOH Predictive Insight for use in other processes and tools in your organization.

The Data Export API provides programmatic access to printer information, job history, and printer state data. You can use it to feed reporting tools, populate dashboards, archive operational data, or integrate RICOH Predictive Insight data with other systems in your environment.

1.5.1 Data Export API

The Data Export API is a REST API that provides three endpoints. You can use those endpoints to download information about your printers and the jobs they have processed, as well as the operating states of those printers over time.

You can use the Data Export API to pull RICOH Predictive Insight data into business intelligence tools, data warehouses, dashboards, and other applications in your organization.

Authentication

You create and manage API keys in RICOH Account Administration. You can create as many keys as you need: one per application that downloads data or one key for use across your organization. Set up expiration date according to your security practices, and rotate keys as needed. You can set the overlap period, so the old and new keys both work for a number of days. If necessary, you can delete a key to deactivate it immediately.

The API key also carries your tenant identity, which is why no tenant or account parameter is required on any request. Anyone who has the key value can submit requests as your tenant, so protect API keys the same way you would protect a password.

Available endpoints

The API includes the following endpoints:

/printers
Returns the list of printers in your account, including the printer name, model, manufacturer, serial number, engines, and current connection status.
/jobs
Returns job-level details for one or more printers, including timing, printed copies, pages, impressions, sheets, roll length, and ink and flushing usage by color channel. By default, the response covers the previous 24 hours.
/printer-states
Returns the operating state of each printer engine, either as an aggregated history over a time range or as the current state only. You can retrieve actual printer states, such as: Printing, Preparing, Maintenance, or Sleeping, or those states can be grouped into categories: up, down, idle, or unknown.

Tip: The /printer-states endpoint reports state information per printer engine, not per printer. A printer with multiple engines returns one row per engine.

Testing the API

An interactive documentation page is available so that you can review each endpoint, see the parameters it accepts, and try sample requests directly from your browser. To open the page, go to:

To submit requests from the documentation page or from your own applications, you first need to create an API key. You create and manage API keys in Account Administration.

1.5.2 Creating and managing API keys

An API key authorizes requests to the Data Export API. You create and manage API keys in Account Administration, and you supply the key when you submit requests from the interactive documentation page or from your own applications.

Each request to the Data Export API must include a valid API key in the x-api-key request header. The key authenticates the request to your account (tenant).

To create API keys, you must have Administrator access to Account Administration. In addition, your account must have a paid subscription with a Data Export API usage plan.

Use the procedures in this topic to:

  • Create a new API key.
  • Edit the name, expiration, or description of an existing key.
  • Rotate a key to replace its secret value without changing the key's identity.
  • Remove a key from the system, due to security breach or expiration.
Note: When you create or rotate an API key, there is a brief window before the key is registered and ready to use. Generally, this window is less than one minute.
  • To create a new API key:
    1. In the left pane of Account Administration, click API Keys.
    2. Click Create API Key.
    3. Enter a name and description for this key.
    4. For Expiration date, choose a date up to 367 days in the future.
    5. For Licenses, choose RPI Data Export Usage Plan for API Keys.
    6. Click Next.
      The key is generated and saved.
    7. Click Copy to copy the generated key to your clipboard. Store it securely.
      Important: The full key value is displayed only when the key is created. You cannot access it again. If you lose the value, you must rotate the key to generate a new one.
    1. Click I saved my key to close the dialog.
  • To edit an existing API key:
    1. In the left pane of Account Administration, click API Keys.
    2. Locate the key that you want to change. Right-click the row for the key and select Edit API Key.
    3. Update the name, expiration date or description as needed.
      Editing a key does not change the key value. Applications that already use the key continue to work without changes.
    4. Click OK.
  • To rotate an API key:
    1. In the left pane of Account Administration, click API Keys.
    2. Locate the key that you want to rotate. Right-click the row for the key and select Rotate API Key.
    3. Set the Overlap period in days to the number of days that you want both the existing key and the rotated version to be active at the same time.
    4. Set a new Expiration date for the key.
    5. Click OK.
    6. Click Copy to copy the generated key to your clipboard. Store it securely.
      Important: The full key value is displayed only when the key is created. You cannot access it again. If you lose the value, you must rotate the key to generate a new one.
    7. Update any applications, scripts, or saved interactive documentation sessions that use the key before the overlap period expires.
  • To remove a key from the system:
    1. In the left pane of Account Administration, click API Keys.
    2. Locate the key that you want to rotate. Right-click the row for the key and select Delete Immediately.
    3. In the dialog, select Yes, delete the key.
      This step is required, because deletion is permanent. After you delete the key, you cannot recover it.
    4. Click OK.

You can use the new or updated API key on the interactive documentation page to test the Data Export API, and in any application that submits requests to the API.

1.5.3 Trying out the Data Export API

Follow this procedure for a brief introduction to the API, using the interactive documentation page as a guide.

Before you start this task, create an API key using RICOH Account Administration.

This procedure walks you through:

  1. Authenticating the interactive documentation page
  2. Retrieving the list of printer IDs for the printers in your account
  3. Retrieving the status of one or more printers
  4. Requesting information about jobs associated with one or more of those printers

To use the Data Export API:

  1. Open the Data Export API interactive documentation here:
  2. Authenticate using an API key:
    1. Click Authorize on the right side of the page.
    2. In the Available Authorizations dialog, enter your API key in the Value field.
      Available authorizations dialog
    1. Click Authorize to authenticate.
    2. Click Close.
    You can now test the available API functions. Use this interface to familiarize yourself with the syntax before integrating the API into your applications.
  3. Retrieve the list of printer IDs for the printers defined in your account.
    To retrieve job and printer status information, you must include printer ID values in your API requests. Printer IDs do not change. If you retrieve them now and save the values, you can use the IDs in other API calls.
    1. Open the Printers section, then open the GET /printers endpoint.
      You see that no parameters are required for this endpoint.
    2. Click Try it out, then click Execute.
    3. Review the response body. You see a list of details about the printers that are monitored by RICOH Predictive Insight. The response looks similar to this:
      [
  {
    "printerName": "VC80_2",
    "printerId": "0bc6b7b3-8df9-4293-cdd4-5ae3162c4d4c",
    "engines": 2,
    "manufacturer": "Ricoh",
    "model": "RICOH Pro VC80000",
    "printerMode": "duplex",
    "printerType": "continuous_feed",
    "serialNumber": "Printer 1: 10-11111 and Printer 2: 10-11112",
    "connectionStatus": "not_connected"
  },
  {
    "printerName": "IP 5000",
    "printerId": "0f8726da-8q37-9c3l-8710-065d7c265122",
    "engines": 1,
    "manufacturer": "InfoPrint",
    "model": "InfoPrint 5000 GP v3.17.129",
    "printerMode": "simplex",
    "printerType": "continuous_feed",
    "serialNumber": "10-1111111",
    "connectionStatus": "connected"
  }
]

      Record the values of the printerId parameters for each of your printers.

  4. Request the printer state history for one or more printers in your system.
    1. Open the GET /printer-states endpoint.
    2. Click Try it out.
    3. Next to printerId, click Add string item.
    4. Replace the text in the field with one of the printer ID values that you retrieved in step 3.
      To retrieve status history for additional printers, click Add string item again and add another printer ID value.
    5. For timezone, choose the timezone to use for the data.
    6. Specify start and end times for the time range to report on. Leave these values blank to retrieve data for the previous 24 hours.
    7. Leave the last three values set to the default, so you can see the full list of information that the API can return.
    8. Click Execute.
    9. Review the response body. You see a list of printer state data for each printer engine, one stanza for each printer state change.
    10. Change the values for the currentState, stateCategoryOnly, and stateCategory parameters and click Execute again to see how the response changes.
      • Leaving these parameters set to the default (unset) has the same effect as setting them to false.
      • You can use these alone or in combination with each other.
  5. Request information about jobs associated with one or more of those printers:
    1. Open Jobs section of the page.
    2. Open the GET /jobs endpoint.
    3. Click Try it out.
    4. Next to printerId, click Add string item.
    5. Replace the text in the field with one of the printer ID values that you retrieved in step 3.
      To retrieve job information for additional printers, click Add string item again and add another printer ID value.
    6. For timezone, choose the timezone to use for the data.
    7. Specify start and end times for the time range to report on. Leave these values blank to retrieve data for the previous 24 hours.
    8. For jobState, leave the value blank to see the full range of responses that the API can return.
    9. Click Execute.
    10. Review the response to see the job information returned.
    11. Change the value for jobState and click Execute again to see how the response changes.

1.5.4 Date and time handling in the Data Export API

The Data Export API uses a single, consistent model for handling dates and times: every request supplies an IANA timezone, every date and time value is interpreted in that timezone, and every date and time value in the response is formatted in that same timezone. Use this topic to understand how the model works and to avoid common mistakes.
The date and time model

Three rules describe how the API handles dates and times:

  1. Every request to /jobs and /printer-states must include a timezone parameter that contains a valid IANA timezone identifier, for example America/Denver or Europe/Bucharest.
  2. Any startDateTime or endDateTime value supplied in the request is interpreted as a local time in the supplied timezone. The values do not include a UTC offset.
  3. Every date and time value in the response is formatted as a local time in the same timezone, using the pattern YYYY-MM-DDTHH:MM:SS.sss.

The timezone parameter governs the meaning of the request and the formatting of the response. Two requests for the same underlying data, submitted with different timezones, produce responses with different timestamp strings even though they describe the same events.

Date and time format

The API uses one format for all date and time values, in both requests and responses:

YYYY-MM-DDTHH:MM:SS.sss

For example, 2026-03-15T14:30:00.000 is 2:30:00 PM on March 15, 2026, interpreted in the timezone supplied with the request.

Important: The format does not include a UTC offset (such as -06:00) or a Z suffix. Do not append one. Both requests and responses use local time only, with the timezone carried separately as a request parameter.

In requests, the milliseconds portion (.sss) is optional. In responses, it is always present.

Default time range

You can omit startDateTime, endDateTime, or both. The two defaults are applied independently:

  • If you omit startDateTime, the API uses 24 hours before the current time as the start of the range.
  • If you omit endDateTime, the API uses the current time as the end of the range.

The defaults combine in the way you would expect:

  • If you omit both values, the API returns data for the previous 24 hours.
  • If you supply startDateTime as one hour ago and omit endDateTime, the API returns data for the previous hour.
  • If you supply endDateTime and omit startDateTime, the API returns data for the range starting 24 hours before the request and ending at the endDateTime.

Default values are calculated in the timezone supplied with the request.

Data retention: the previous seven days

The Data Export API serves real-time operational data. Job records and printer state history are available for the previous seven days only. A request for data older than seven days returns an error.

Plan your integration so that scheduled extracts run frequently enough to capture all data before it ages out:

  • For nightly extracts, allow a margin of at least one or two days. If a scheduled run fails, you have time to investigate and re-run before the data is no longer available.
  • For backfills or one-time extracts, do not request data more than seven days old.
Rules for the requested range
  • startDateTime must be earlier than endDateTime. A request that violates this rule fails with ERR_INVALID_DATE_RANGE.
  • Both values must use the format described in Date and time format. A request with a malformed value fails with ERR_INVALID_DATE_FORMAT.
  • The duration between startDateTime and endDateTime must not exceed the maximum allowed range. A request that exceeds the maximum fails with ERR_DATE_RANGE_EXCEEDED.
Supplying the timezone

The timezone parameter accepts IANA timezone identifiers, such as America/Denver, America/New_York, Europe/Bucharest, Asia/Tokyo, or UTC. The interactive documentation page lists every value that the API accepts.

An invalid or unrecognized identifier fails with ERR_INVALID_TIMEZONE. Three-letter abbreviations such as MST or EST are not IANA identifiers and are not accepted; use the corresponding region-based identifier (for example, America/Denver or America/New_York) instead.

Daylight saving time and ambiguous times

Because requests and responses are expressed as local times, daylight saving time transitions create two situations to be aware of:

Skipped local times in the spring transition
When clocks move forward, one hour of local time does not exist. For example, in America/Denver on the day of the spring transition, 02:30:00 is not a valid local time. Avoid using times in the skipped hour as startDateTime or endDateTime.
Repeated local times in the fall transition
When clocks move back, one hour of local time occurs twice. A value such as 01:30:00 on the day of the fall transition is ambiguous. Choose times outside the repeated hour to avoid uncertainty about which instance you are requesting.

If your integration runs unattended and might submit a request whose start or end time falls inside a transition, schedule the request to run a few hours away from the transition or use times that are clearly outside it.

Recommendations for storing and comparing response timestamps

Response timestamps are local times without an offset. To avoid ambiguity in downstream systems, consider one of the following approaches:

  • Store the response timestamp together with the timezone you supplied in the request. The pair, taken together, identifies a unique instant in time.
  • In your integration, convert each response timestamp to UTC before storing it, using the timezone you supplied in the request. Storing UTC values simplifies comparisons across data extracted with different timezones.
  • Always submit requests with the same timezone, for example UTC, so that all stored timestamps are directly comparable.
Examples

The following examples illustrate how the timezone, start time, and end time work together.

Default window in Mountain Time
A request submitted at 9:00 AM on March 15, 2026, in America/Denver, with no start or end time supplied, returns data from 2026-03-14T09:00:00 through 2026-03-15T09:00:00, both interpreted in Mountain Time.
Specific window in Eastern European Time
A request that supplies timezone=Europe/Bucharest, startDateTime=2026-03-15T08:00:00, and endDateTime=2026-03-15T16:00:00 returns data for the eight-hour business day in Bucharest local time. Response timestamps are also formatted in Bucharest local time.
The same window viewed in two timezones
To retrieve the same underlying data twice, formatted for two audiences, submit two requests with different timezone values and adjust startDateTime and endDateTime so that they describe the same instants in each timezone. The response payloads describe the same events but use different timestamp strings.

Related information:

Working with Data Export API response limits

1.5.5 Data Export API response fields

Each Data Export API endpoint returns a JSON array of objects. Use the tables in this topic to interpret the fields in each response.
Conventions used in this reference
  • All durations are reported in milliseconds.
  • All date and time values are formatted in the timezone specified by the timezone request parameter, using the pattern YYYY-MM-DDTHH:MM:SS.sss.
  • Identifier fields (printerId, jobId) are stable across requests and can be cached by integrating applications. printerId never changes, so values can be stored and reused across sessions.
GET /printers response fields

The /printers endpoint returns one object per printer identified in the account and tracked by a data collector.

Field Type Description
printerName string The display name assigned to the printer in RICOH Predictive Insight.
printerId string (UUID) The unique identifier for the printer. Use this value as the printerId parameter when you call /jobs or /printer-states.
engines integer The number of print engines in the printer. Continuous-feed printers can have one or more engines; cut-sheet printers typically report a single engine. Each engine is reported as a separate row in /printer-states responses.
manufacturer string The manufacturer of the printer, for example Ricoh or InfoPrint.
model string The printer model as reported by the device, for example RICOH Pro VC80000.
printerMode string Whether the printer is operating in simplex or duplex mode. This field can be absent for printer types where the value does not apply, such as cut-sheet devices.
printerType string Whether the printer supports continuous_feed or cut_sheet paper.
serialNumber string The serial number reported by the printer. For multi-engine printers, this field can include serial numbers for each engine in a single string, for example Printer 1: 10-11111 and Printer 2: 10-11112.
connectionStatus string Indicates whether RICOH Predictive Insight can currently reach the printer. Possible values are connected and not_connected.
GET /jobs response fields

The /jobs endpoint returns one object per job processed by the requested printers within the requested time range.

Field Type Description
printerId string (UUID) The identifier of the printer that processed the job. Matches a printerId from the /printers response.
jobId string The unique identifier of the job.
jobName string The name of the job as submitted to the printer, typically the source filename.
jobPrintingSide string The side or sides printed for this job, for example simplex or duplex.
jobAction string The state of the job at the time the request was processed. Possible values:
  • printing: the job was printing when the request was issued.
  • printed: the job finished printing successfully.
  • aborted: the job ended before it finished printing.
  • completed: the job reached a final state. This value is a superset that includes both printed and aborted jobs. Use it when you want to retrieve all jobs that are no longer active, regardless of outcome.
jobStartTime string (datetime) The local date and time when the job started printing, in the timezone supplied in the request.
jobEndTime string (datetime) The local date and time when the job ended, in the timezone supplied in the request.
jobDuration integer The elapsed printing time for the job, in milliseconds.
printedCopies integer The number of copies of the job produced.
printedPages integer The total number of logical pages printed for the job, including all copies.
printedImpressions integer The total number of impressions printed. An impression is one side of one sheet, so a duplex job produces two impressions per sheet.
printedSheets integer The total number of physical sheets used for the job.
printedRollFeet number For continuous-feed printers, the length of media consumed by the job, in feet.
printedRollMeters number For continuous-feed printers, the length of media consumed by the job, in meters.
inkC, inkM, inkY, inkK number The amount of cyan, magenta, yellow, and black ink consumed by the job, reported per color channel in cubic centimeters (cc).
flushingC, flushingM, flushingY, flushingK number The amount of cyan, magenta, yellow, and black ink consumed during printhead flushing operations associated with the job, reported per color channel in cubic centimeters (cc). Flushing values are tracked separately from inkC/M/Y/K so that productive ink usage can be distinguished from maintenance usage.
GET /printer-states response fields

The /printer-states endpoint returns one object per printer engine, per state interval. Which fields are present depends on the request mode:

  • Aggregated history (default): all fields are returned.
  • Current state only (currentState=true): printerStateDuration, historyStartTime, and historyEndTime are omitted.
  • State category only (stateCategoryOnly=true): printerState is omitted.
Field Type Description
printerId string (UUID) The identifier of the printer this row describes. Matches a printerId from the /printers response.
engine string The engine within the printer that this row describes, for example engine_1, engine_2, or engine_3. A printer with multiple engines returns one row per engine for each state interval.
stateCategory string The high-level category that the engine state rolls up to. Possible values are up, down, idle, and unknown. Use this field for dashboards and reporting that need consistent categories across printer models.
printerState string The raw state reported by the printer engine, such as Printing, Preparing, Maintenance, or Sleeping. Raw state values vary by printer model. Omitted when stateCategoryOnly=true.
Note: See Printer states and state categories for a complete list of states and their mappings.
printerStateDuration integer The length of time the engine remained in this state, in milliseconds. Omitted when currentState=true.
historyStartTime string (datetime) The local date and time when the engine entered this state, in the timezone supplied in the request. Omitted when currentState=true.
historyEndTime string (datetime) The local date and time when the engine left this state, in the timezone supplied in the request. For the most recent interval in an aggregated response, this value can equal the end of the requested time range. Omitted when currentState=true.

1.5.5.1 Printer states and state categories

The /printer-states endpoint reports both a raw printer state and a high-level state category. Use the tables in this topic to understand which raw states roll up into which categories.
About printer states and categories

For each printer engine, the Data Export API reports two related values:

printerState
The raw operating state reported by the printer engine, such as printing, sleeping, or maintenance. The set of raw states varies by printer model.
stateCategory
A high-level grouping that classifies the raw state as up, down, idle, or unknown. Categories are consistent across printer models, so they are the better choice for dashboards and reports that aggregate data from multiple printers.

The category assignments are defined by RICOH Predictive Insight and apply uniformly to every printer reporting through the Data Export API.

Up states

An engine is reported as up when it is actively producing output or actively preparing to produce output. Use this category to measure productive operating time.

Raw printer state Description
feeding The engine is feeding media in preparation for printing.
initializing The engine is initializing as part of starting a print operation.
preparing The engine is preparing to print, for example by loading job data or warming components for an imminent job.
printing The engine is printing.
processing The engine is processing job data.
receiving The engine is receiving a job from the print server.
Down states

An engine is reported as down when it cannot print and operator or service intervention, maintenance, or recovery is required or in progress. Use this category to measure unplanned and planned downtime.

Raw printer state Description
adjusting The engine is performing an adjustment operation that prevents printing.
calibrating The engine is calibrating, for example for color or registration.
cleaning The engine is performing a cleaning operation.
disconnected The engine has lost its connection to RICOH Predictive Insight.
error The engine has reported an error condition that prevents printing.
maintenance The engine is performing a maintenance operation.
not available The engine is reachable but cannot accept work at this time.
pre/post busy A pre- or post-processing device attached to the engine is busy and is blocking printing.
pre/post eof A pre- or post-processing device has reached an end-of-form condition that is blocking printing.
pre/post paused A pre- or post-processing device is paused and is blocking printing.
pre/post threading A pre- or post-processing device is threading media and is blocking printing.
rebooting The engine is rebooting.
recirculation The engine is recirculating ink.
restart The engine is in a restart condition.
restarting The engine is restarting.
Idle states

An engine is reported as idle when it is operational and able to print but is not currently producing output. Use this category to measure available capacity.

Raw printer state Description
checking The engine is performing a routine check that does not block work.
idle The engine is operational and waiting for work.
not ready The engine is operational but is not currently in a ready-to-print state.
pre/post not ready A pre- or post-processing device is not ready, but the engine itself is operational.
ready The engine is ready to accept and print a job.
shutdown The engine has been shut down.
shutting down The engine is in the process of shutting down.
sleeping The engine is in a low-power sleep state.
start-up The engine is in a start-up phase.
started The engine has completed its start-up sequence.
starting The engine is starting.
stopping The engine is stopping but has not yet shut down.
warming The engine is warming up.
Unknown

The category unknown is reported when RICOH Predictive Insight cannot determine a category for the raw state, for example because the raw state value is not recognized. If your application encounters unknown categories regularly, contact your representative to confirm that your printer is reporting expected state values.

1.5.5.2 Working with Data Export API response limits

The Data Export API does not paginate responses. If a request would return more data than the API permits in a single response, the request fails with an error rather than returning a partial result. Plan your integrations to stay within the limits by narrowing the date range, reducing the number of printers per request, or both.
What the limits are

Two kinds of limits apply to requests that include a date range:

Maximum date range
If the time between startDateTime and endDateTime exceeds seven days, the API returns a 400 response with the error code ERR_DATE_RANGE_EXCEEDED. Reduce the size of the requested time window and submit the request again.
Maximum response size
The maximum supported size of a response file is 6MB, which should be large enough to hold the data for nearly 10,000 jobs. If the data that matches a request would exceed the maximum response size, the API returns a 413 response with the error code ERR_RESPONSE_LIMIT_EXCEEDED. The response body includes a maxJobs value that indicates the limit in effect. To recover, narrow the date range, request fewer printers, or both, and submit the request again.
Planning requests to stay within the limits

To design an integration that reliably stays within the response limits, consider the following factors:

  • Job volume per printer. A high-throughput continuous-feed printer can produce many more jobs per hour than a low-volume cut-sheet printer. If you mix both in your fleet, the high-volume printers determine how short your time windows must be.
  • Number of printers per request. Each request can include multiple printerId values. Combining many printers into a single request is convenient, but every additional printer increases the response size and the chance of exceeding the limit.
  • Time of day. If your operation runs in shifts, jobs and state changes are concentrated in certain hours. A 24-hour window can return very different volumes depending on when those 24 hours start and end.
  • Tolerance for retries. If a request fails with ERR_RESPONSE_LIMIT_EXCEEDED, your integration must split the request and retry. Designing for smaller windows up front is usually less complex than implementing dynamic splitting.
Recommended patterns

The following patterns work well for common integration scenarios:

Nightly extract for reporting
Run a scheduled job once per day that requests the previous 24 hours of data, one printer at a time. This pattern is simple to implement, easy to retry on failure, and keeps each response small. Combine the per-printer responses in your downstream process.
Hourly extract for near-real-time dashboards
Run a scheduled job once per hour that requests the previous hour of data for all printers in a single call. Hourly windows keep response sizes small even for high-volume printers. If your fleet is large, request printers in groups rather than all at once.
Backfill of historical data
To populate a data warehouse with historical data, iterate over the time range in fixed-size windows (for example, six hours per request) and over your printers in small groups. Process one window at a time and store the results before moving to the next window. If a window fails with ERR_RESPONSE_LIMIT_EXCEEDED, split that window in half and retry the two halves.
Current printer state for monitoring
To monitor the current state of every printer in your fleet without retrieving history, call /printer-states with currentState=true. The response includes one row per engine and is not affected by the date range, so a single request can cover the entire fleet.
Handling response-limit errors in your integration

When you receive a 413 response with ERR_RESPONSE_LIMIT_EXCEEDED, take one or more of the following actions before retrying the request:

  • Reduce the time window. Splitting the window in half is a reliable strategy; if the halved request still fails, split again.
  • Reduce the number of printerId values in the request. If one printer is responsible for most of the volume, request that printer separately.
  • If the request is for a current snapshot rather than a history, use currentState=true on /printer-states to avoid date-range-driven volume entirely.

Do not retry the same request without changing parameters. The API does not return partial results, so an unchanged retry will fail again.

Related information:

Date and time handling in the Data Export API

1.5.6 Data Export API request and response examples

Use the examples in this topic as a starting point for your own integration. Each example shows a representative request URL together with the response body that the API returns.
About these examples
  • The examples use placeholder hostnames, API keys, and printer IDs. Substitute the values for your own environment when you adapt them.
  • Date and time values are formatted as local times in the timezone supplied with the request, in the pattern YYYY-MM-DDTHH:MM:SS.sss.
  • All durations are in milliseconds. All ink and flushing values are in cubic centimeters (cc).
  • Examples are illustrative. Numeric values such as ink usage, page counts, and durations represent plausible operational data, not measurements from a specific printer.
GET /printers

Retrieves the printers available to the supplied API key. The endpoint takes no parameters.

Request:

GET https://rpi-data-export.app-devricohsoftware.com/api/v1/printers
x-api-key: YOUR_API_KEY

Response (200 OK):

[
  {
    "printerName": "VC60000_Line1",
    "printerId": "f7932e31-6545-4bff-8971-f84ef5f5b3dc",
    "engines": 2,
    "manufacturer": "Ricoh",
    "model": "RICOH Pro VC60000",
    "printerMode": "duplex",
    "printerType": "continuous_feed",
    "serialNumber": "Printer 1: 10-11111 and Printer 2: 10-22222",
    "connectionStatus": "connected"
  },
  {
    "printerName": "VC80_2",
    "printerId": "0bc6b7b3-8df9-4293-cdd4-5ae3162c4d4c",
    "engines": 2,
    "manufacturer": "Ricoh",
    "model": "RICOH Pro VC80000",
    "printerMode": "duplex",
    "printerType": "continuous_feed",
    "serialNumber": "Printer 1: 10-33333 and Printer 2: 10-33334",
    "connectionStatus": "not_connected"
  },
  {
    "printerName": "IP 5000",
    "printerId": "0f8726da-8a37-4c3b-8710-065d7c265122",
    "engines": 1,
    "manufacturer": "InfoPrint",
    "model": "InfoPrint 5000 GP v3.17.129",
    "printerMode": "simplex",
    "printerType": "continuous_feed",
    "serialNumber": "10-1111111",
    "connectionStatus": "connected"
  }
]
GET /jobs

Retrieves jobs processed by one or more printers within a time range. The example requests a single printer for an eight-hour window in America/Denver local time, restricted to jobs that finished printing successfully.

Request:

GET https://rpi-data-export.app-devricohsoftware.com/api/v1/jobs
    ?printerId=f7932e31-6545-4bff-8971-f84ef5f5b3dc
    &timezone=America/Denver
    &startDateTime=2026-03-15T08:00:00
    &endDateTime=2026-03-15T16:00:00
    &jobState=printed
x-api-key: YOUR_API_KEY

Response (200 OK):

[
  {
    "printerId": "f7932e31-6545-4bff-8971-f84ef5f5b3dc",
    "jobId": "5ae3162c4d4c-1771233448485-Cust_MH_Arena.pdf-13925",
    "jobName": "Cust_MH_Arena.pdf",
    "jobPrintingSide": "duplex",
    "jobAction": "printed",
    "jobStartTime": "2026-03-15T08:14:22.000",
    "jobEndTime": "2026-03-15T08:47:51.000",
    "jobDuration": 2009000,
    "printedCopies": 1,
    "printedPages": 4800,
    "printedImpressions": 4800,
    "printedSheets": 2400,
    "printedRollFeet": 1640.5,
    "printedRollMeters": 500.02,
    "inkC": 184.6,
    "inkM": 172.3,
    "inkY": 198.1,
    "inkK": 245.7,
    "flushingC": 2.4,
    "flushingM": 2.4,
    "flushingY": 2.4,
    "flushingK": 2.4
  },
  {
    "printerId": "f7932e31-6545-4bff-8971-f84ef5f5b3dc",
    "jobId": "5ae3162c4d4c-1771237012003-DM_Spring_Promo.pdf-13926",
    "jobName": "DM_Spring_Promo.pdf",
    "jobPrintingSide": "duplex",
    "jobAction": "printed",
    "jobStartTime": "2026-03-15T09:22:10.000",
    "jobEndTime": "2026-03-15T11:05:44.000",
    "jobDuration": 6214000,
    "printedCopies": 25000,
    "printedPages": 50000,
    "printedImpressions": 50000,
    "printedSheets": 25000,
    "printedRollFeet": 17082.0,
    "printedRollMeters": 5206.9,
    "inkC": 1923.4,
    "inkM": 1810.7,
    "inkY": 2055.2,
    "inkK": 2540.8,
    "flushingC": 12.6,
    "flushingM": 12.6,
    "flushingY": 12.6,
    "flushingK": 12.6
  }
]

An empty array ([]) is a valid response and means that no jobs matched the request.

GET /printer-states (aggregated history)

The default response mode returns one row per state interval per engine, with full duration and history fields. The example requests a four-hour window for one printer.

Request:

GET https://rpi-data-export.app-devricohsoftware.com/api/v1/printer-states
    ?printerId=f7932e31-6545-4bff-8971-f84ef5f5b3dc
    &timezone=America/Denver
    &startDateTime=2026-03-15T08:00:00
    &endDateTime=2026-03-15T12:00:00
x-api-key: YOUR_API_KEY

Response (200 OK):

[
  {
    "printerId": "f7932e31-6545-4bff-8971-f84ef5f5b3dc",
    "engine": "engine_1",
    "stateCategory": "idle",
    "printerState": "ready",
    "printerStateDuration": 854000,
    "historyStartTime": "2026-03-15T08:00:00.000",
    "historyEndTime": "2026-03-15T08:14:14.000"
  },
  {
    "printerId": "f7932e31-6545-4bff-8971-f84ef5f5b3dc",
    "engine": "engine_1",
    "stateCategory": "up",
    "printerState": "printing",
    "printerStateDuration": 2017000,
    "historyStartTime": "2026-03-15T08:14:14.000",
    "historyEndTime": "2026-03-15T08:47:51.000"
  },
  {
    "printerId": "f7932e31-6545-4bff-8971-f84ef5f5b3dc",
    "engine": "engine_1",
    "stateCategory": "down",
    "printerState": "maintenance",
    "printerStateDuration": 1980000,
    "historyStartTime": "2026-03-15T08:47:51.000",
    "historyEndTime": "2026-03-15T09:20:51.000"
  },
  {
    "printerId": "f7932e31-6545-4bff-8971-f84ef5f5b3dc",
    "engine": "engine_2",
    "stateCategory": "idle",
    "printerState": "sleeping",
    "printerStateDuration": 14400000,
    "historyStartTime": "2026-03-15T08:00:00.000",
    "historyEndTime": "2026-03-15T12:00:00.000"
  }
]
GET /printer-states (current state only)

When you set currentState=true, the response includes one row per engine with the current state. Duration and history fields are omitted.

Request:

GET https://rpi-data-export.app-devricohsoftware.com/api/v1/printer-states
    ?printerId=f7932e31-6545-4bff-8971-f84ef5f5b3dc
    &timezone=America/Denver
    &currentState=true
x-api-key: YOUR_API_KEY

Response (200 OK):

[
  {
    "printerId": "f7932e31-6545-4bff-8971-f84ef5f5b3dc",
    "engine": "engine_1",
    "stateCategory": "up",
    "printerState": "printing"
  },
  {
    "printerId": "f7932e31-6545-4bff-8971-f84ef5f5b3dc",
    "engine": "engine_2",
    "stateCategory": "idle",
    "printerState": "ready"
  }
]
GET /printer-states (state category only)

When you set stateCategoryOnly=true, the response omits the raw printerState field and reports only the high-level category. Duration and history fields are retained.

Request:

GET https://rpi-data-export.app-devricohsoftware.com/api/v1/printer-states
    ?printerId=f7932e31-6545-4bff-8971-f84ef5f5b3dc
    &timezone=America/Denver
    &startDateTime=2026-03-15T08:00:00
    &endDateTime=2026-03-15T12:00:00
    &stateCategoryOnly=true
x-api-key: YOUR_API_KEY

Response (200 OK):

[
  {
    "printerId": "f7932e31-6545-4bff-8971-f84ef5f5b3dc",
    "engine": "engine_1",
    "stateCategory": "idle",
    "printerStateDuration": 854000,
    "historyStartTime": "2026-03-15T08:00:00.000",
    "historyEndTime": "2026-03-15T08:14:14.000"
  },
  {
    "printerId": "f7932e31-6545-4bff-8971-f84ef5f5b3dc",
    "engine": "engine_1",
    "stateCategory": "up",
    "printerStateDuration": 2017000,
    "historyStartTime": "2026-03-15T08:14:14.000",
    "historyEndTime": "2026-03-15T08:47:51.000"
  }
]
Example error responses

Every error response uses the same structure: a JSON object with a code, a message, and a numeric statusCode. Some error codes include additional fields, as noted.

400 Bad Request—invalid timezone:

{
  "code": "ERR_INVALID_TIMEZONE",
  "message": "The supplied timezone is not a valid IANA timezone identifier.",
  "statusCode": 400
}

400 Bad Request—missing required parameter:

{
  "code": "ERR_MISSING_PRINTER_ID",
  "message": "At least one printerId value is required.",
  "statusCode": 400
}

400 Bad Request—date range exceeds the maximum allowed:

{
  "code": "ERR_DATE_RANGE_EXCEEDED",
  "message": "The requested date range exceeds the maximum allowed range.",
  "statusCode": 400
}

401 Unauthorized—invalid API key:

{
  "code": "ERR_INVALID_APIKEY",
  "message": "Failed to validate API key.",
  "statusCode": 401
}

403 Forbidden—request includes a printer the API key cannot access:

{
  "code": "ERR_UNAUTHORIZED_PRINTERS",
  "message": "Unauthorized printers.",
  "statusCode": 403
}

413 Payload Too Large—response would exceed the size limit:

{
  "code": "ERR_RESPONSE_LIMIT_EXCEEDED",
  "message": "The response would exceed the maximum allowed size. Narrow the date range or request fewer printers.",
  "statusCode": 413,
  "maxJobs": 8000
}

500 Internal Server Error:

{
  "code": "ERR_INTERNAL_SERVER_ERROR",
  "message": "An internal server error occurred.",
  "statusCode": 500
}

1.5.7 Data Export API troubleshooting

Use this topic to interpret common Data Export API error responses and to identify the most likely cause and fix for each one. Every error response includes a code, a message, and a numeric statusCode; the code value identifies the specific condition.
Authentication and authorization errors
Error code Likely cause What to try
ERR_INVALID_APIKEY (401) The x-api-key header is missing, malformed, expired, or has been deleted. Also occurs briefly (typically less than one minute) immediately after a key is created or rotated, before the new key is registered. Confirm that the request includes the x-api-key header with the full key value. In Account Administration, verify that the key still exists and has not expired. If the key was just created or rotated, wait one minute and retry.
ERR_UNAUTHORIZED_PRINTERS (403) The request includes one or more printerId values that the API key cannot access. Call /printers with the same API key to see exactly which printers are available, then submit the request again with only those printer IDs.
ERR_TENANT_NOT_FOUND (404) The API key is recognized but is not associated with an active account. This can happen if an account has been removed or is configured incorrectly. Contact your Ricoh account representative to confirm that your tenant is active and that the API key is associated with it.
Parameter validation errors (400 Bad Request)

Every parameter validation error returns a 400 status code. The code value identifies the specific problem.

Error code Likely cause What to try
ERR_MISSING_PRINTER_ID The request did not include any printerId values. At least one is required for /jobs and /printer-states. Add at least one printerId query parameter. Repeat the parameter to include multiple printers.
ERR_INVALID_PRINTER_ID_FORMAT A printerId value is not a valid UUID. Verify the value against the response from /printers. Common mistakes include extra whitespace, missing characters, or pasting in the printer name instead of the printer ID.
ERR_INVALID_TIMEZONE The timezone value is missing or is not a valid IANA timezone identifier. Use a region-based identifier such as America/Denver or Europe/Bucharest. Three-letter abbreviations such as MST or EST are not accepted. The interactive documentation page lists every accepted value.
ERR_INVALID_DATE_FORMAT A startDateTime or endDateTime value does not match the expected format. Use the format YYYY-MM-DDTHH:MM:SS, optionally with a .sss milliseconds suffix. Do not include a UTC offset or a Z suffix; the timezone is supplied separately in the timezone parameter.
ERR_INVALID_DATE_RANGE startDateTime is the same as or later than endDateTime. Verify that startDateTime is earlier than endDateTime in the supplied timezone.
ERR_DATE_RANGE_EXCEEDED The duration between startDateTime and endDateTime exceeds the maximum allowed range. Reduce the size of the requested time window. See Working with Data Export API response limits for chunking guidance.
ERR_INVALID_JOB_STATE The jobState value is not one of the accepted values. Use one of printing, printed, aborted, or completed. Note that completed includes both printed and aborted jobs.
ERR_INVALID_STATE_CATEGORY The stateCategory value is not one of the accepted values. Use one of up, down, or idle.
ERR_INVALID_BOOLEAN_PARAM The currentState or stateCategoryOnly parameter has a value other than true or false. Use the literal lowercase strings true or false.
ERR_UNKNOWN_PARAMETERS The request includes one or more parameters that the endpoint does not accept. Compare the request against the parameters listed for the endpoint in the interactive documentation. Common causes include typos, parameters intended for a different endpoint, or extra tracking parameters added by an HTTP client.
ERR_DUPLICATE_PARAMETERS The same parameter is supplied more than once and the endpoint does not accept duplicates for that parameter. Verify the parameter list. The printerId parameter is allowed to repeat (once per printer); other parameters must appear at most once.
ERR_EMPTY_PARAMETERS A required parameter is present but has no value. Verify that every required parameter has a non-empty value.
ERR_INVALID_TENANT_ID The tenant identifier associated with the API key is invalid. Contact your Ricoh account representative.
Response size and method errors
Error code Likely cause What to try
ERR_RESPONSE_LIMIT_EXCEEDED (413) The data that matches the request would exceed the maximum response size. The response body includes a maxJobs field that indicates the limit in effect. Narrow the date range, request fewer printers, or both, and submit the request again. See Working with Data Export API response limits for recommended chunking patterns.
ERR_UNSUPPORTED_METHOD (405) The request used an HTTP method other than GET. The Data Export API supports only the GET method. Update your client to use GET.
Server errors (500 Internal Server Error)

500 responses indicate an unexpected condition on the server. Retries are safe because every Data Export API endpoint is a GET and produces no side effects. Wait a few seconds before retrying, and use exponential backoff if the error persists.

Error code Likely cause What to try
ERR_INTERNAL_SERVER_ERROR An unexpected condition occurred on the server. Wait a few seconds and retry. If the error persists for more than a few minutes, contact your Ricoh account representative.
ERR_TENANT_CHECK_FAILED The server could not verify the tenant associated with the API key. Wait a few seconds and retry. If the error persists, contact your Ricoh account representative.
ERR_PRINTERS_FETCH_FAILED The server could not retrieve the list of printers for the tenant. Wait a few seconds and retry. If the error persists, contact your Ricoh account representative.
ERR_PRINTER_STATES_FETCH_FAILED The server could not retrieve printer state data for the request. Wait a few seconds and retry. If the error persists, contact your Ricoh account representative.
Other symptoms
The response is empty ([]) but you expect data
An empty array means no records matched the request. Verify the time window (the API serves only the last seven days), the timezone, the printerId values, and any filters such as jobState or stateCategory.
Date and time values in the response do not match what you expected
Response timestamps are local times in the timezone supplied with the request. Submitting the same request with a different timezone value produces different timestamp strings even though they describe the same events. See Date and time handling in the Data Export API.
A printer is missing from the /printers response
The API returns only printers that are monitored by a data collector. If a printer is missing, verify that it was registered to a data collector and is currently connected.
A printer-states response includes unknown categories
An unknown category indicates that the raw printer state could not be classified. See Printer states and state categories for the full state-to-category mapping.

1.6 RICOH Cloud Connector

RICOH Cloud Connector is a local system application that provides a secure connection with RICOH TotalFlow Cloud. It assists in product registration and, if required, manages communication with the RICOH TotalFlow Cloud applications.
    Note:
  • If you are using RICOH InfoPrint Manager Subscription, RICOH Cloud Connector is automatically installed with the product. When you uninstall RICOH InfoPrint Manager, RICOH Cloud Connector is automatically uninstalled.
  • You do not need to install RICOH Cloud Connector to use RICOH Predictive Insight.

You can install RICOH Cloud Connector on the following operating systems:

  • On Windows:
    • Microsoft Windows 10 Pro/Enterprise
    • Microsoft Windows 11 Pro
    • Microsoft Windows Server 2019 Standard
    • Microsoft Windows Server 2022 Standard
  • On Linux:
    • Red Hat Enterprise Linux 8
    • Red Hat Enterprise Linux 9
    • Fedora Linux 38
    • CentOS Stream 8
    • Ubuntu 22.04 LTS
    • openSUSE Leap 15.4
    Note:
  • These are the latest versions tested with RICOH Cloud Connector, but you can also use later versions of these operating systems.
  • These operating systems and their updates are supported as long as the manufacturer continues to provide support to their customers under standard agreements, not including extended support.

The RICOH Cloud Connector installation requires at least 1.1 GB of free space.

Related information:

RICOH Cloud Connector
Connectors

1.6.1 Downloading RICOH Cloud Connector

You can download the latest version of RICOH Cloud Connector from the Subscriptions or the Connectors tab in RICOH Account Administration. Download the package onto the server where you plan to install the application.
Before you download Cloud Connector, make sure these conditions are met:
  • The Cloud Connector setup page opens in a web browser. Make sure that the system has the latest versions of one of these browsers installed:
    • Mozilla Firefox
    • Google Chrome
    • Microsoft Edge
  • You have write permission on the default installation location:
    • %ProgramData%\RICOH\Cloud Connector\ for Windows, or
    • /opt/RICOH/RCC/ for Linux.
  • If you choose a different installation path, make sure that it exists and you have write permissions on it. If the directory exists, it must be empty.
To download RICOH Cloud Connector:
  1. Log in to the server that you want to install Cloud Connector on as an administrator.
  2. Log in to RICOH TotalFlow Cloud as a user with access to RICOH Account Administration.
  3. In RICOH Account Administration, click Subscriptions in the left pane.
    You see the Subscriptions tab and the links for downloading the RICOH Cloud Connector package.
    Downloading RICOH Cloud Connector
  4. Click Download for Windows or Download for Linux, according to your operating system.
  5. Save the installation package in a location where you have write and execute permissions. On Linux, you download an archive named ricoh-cloud-connector-linux.gz, which contains the executable file.
    The name of the downloaded file is:
    • On Windows: ricoh-cloud-connector-win.exe
    • On Linux: ricoh-cloud-connector-linux.gz

1.6.2 Installing or Updating

After downloading the current version of RICOH Cloud Connector, install it on the server that you identified.
    Note:
  • If you downloaded the installation files to a different machine, copy the files to the system that you want to install the program on.
  • Make sure that you have enough space on the disk. The RICOH Cloud Connector installation requires at least 1.1 GB of free space.
To install or update RICOH Cloud Connector:
  1. Log in to the computer where you downloaded the RICOH Cloud Connector installer executable as an Administrator.
    On a Linux system, you must log in with a user account that has read and write permissions on these directories:
    • /var
    • /etc
    • /usr
    • /opt

    Also, you need execute permission for the RICOH Cloud Connector executable file that you downloaded.

  2. If you are installing on Linux, find and double-click ricoh-cloud-connector-linux.gz to unpack the installer files.
    Important: Among the unpacked files, you should see the installer executable file, named ricoh-cloud-connector-linux. Make sure that the file can be run as an executable. Follow the procedure for your Linux version to make it executable.
  3. Find and double-click the RICOH Cloud Connector installer executable.
    The name of the executable file is:
    • On Windows: ricoh-cloud-connector-win.exe
    • On Linux: ricoh-cloud-connector-linux

    If you are installing RICOH Cloud Connector for the first time, the RICOH Cloud Connector Installation page opens in the default browser.

    If you are updating RICOH Cloud Connector, the RICOH Cloud Connector Update page opens in the default browser.

    Note: If the RICOH Cloud Connector Installation page does not open, your anti-virus or browser might be blocking the installer.

    Check the address bar of your browser to see if it blocked a page from opening. If the page was blocked, grant permission to display the page. If the page still does not display, refer to the Troubleshooting topic below.

  4. If you are installing for the first time:
    1. Review the legal terms and select I accept the terms of the license agreement..
    2. Verify the install location and that you have write and execute permissions for it, then click INSTALL.
  5. If you are updating RICOH Cloud Connector:
    Note: Your previous setup details are imported, including acceptance of the license.
    1. Review the information about your current version of RICOH Cloud Connector and the update version.
    2. Click UPDATE.

The installation starts and you can view its progress.

When the installation completes, the RICOH Cloud Connector Setup page opens automatically.

The RICOH Cloud Connector service starts automatically after each successful installation, update, or system restart.

Related information:

Could not install RICOH Cloud Connector

1.6.3 Setting Up

After you install RICOH Cloud Connector, you must configure it to communicate with RICOH TotalFlow Cloud.
When the RICOH Cloud Connector installation completes, the RICOH Cloud Connector Setup page opens in the default browser.
To set up RICOH Cloud Connector:
  1. The System name property is automatically filled in with the name of the system as set in the operating system. You can update it to something that is more recognizable or easier to remember.
  2. If your company uses proxy servers, ask your IT department for the correct IP address or host name and port number to use. Select the option I am going to use a proxy server. and type the correct values in the Proxy settings fields.
  3. Click Test proxy. If the proxy settings are not validated, check them with your IT department, enter the correct values and try again.
  4. Click Generate code.

    If you are not logged in to Account Administration, the login dialog opens. Log in to Account Administration.

    When you are logged in, you see the Generate a One-time Code window and a unique one-time code that is valid for 20 minutes.
  5. Copy the code, return to RICOH Cloud Connector, and paste the code in the One Time Code field.
  6. Click Submit.
    If your authorization is valid, you receive a confirmation message. Click Close.

    You see the License Settings dialog.

    It contains all the details that you entered during the setup. You can edit the System name and Proxy settings, if necessary.

  7. Close the browser tab or window to exit RICOH Cloud Connector setup.

1.6.3.1 System Name

Displays the name of the device that you are setting up RICOH Cloud Connector on.

By default, this value is the name of this system assigned in the operating system. You can change it to a more recognizable name. RICOH Account Administration displays this name on the Connectors tab, in the table of registered connectors.

1.6.3.2 Proxy Settings

Some companies use proxy servers to provide an extra layer of network protection.

If your company uses proxy servers, ask your IT department for the correct IP address or host name and port number to use.

1.6.3.3 One-time Code

The one-time code generated by RICOH Account Administration that you must use to register RICOH Cloud Connector, so that information can be transmitted from your network to the RICOH TotalFlow Cloud applications.

To log in to RICOH Account Administration, you need a RICOH TotalFlow Cloud user ID.

1.6.4 Uninstalling RICOH Cloud Connector

This section describes how to uninstall RICOH Cloud Connector using Windows system tools.
    Note:
  • To uninstall RICOH Cloud Connector on Linux, follow the instructions that your Linux distribution provides.
To uninstall RICOH Cloud Connector on Windows:
  1. Log on to the computer where RICOH Cloud Connector is installed as an Administrator.
  2. Click the Windows search button and search for the Apps & Features page.
  3. Look for and click the RICOH Cloud Connector application name.
  4. Click Uninstall.
  5. Click Uninstall again to confirm that you understand that the application and its related information will be uninstalled.
    You see the RICOH Cloud Connector Uninstall page:
  6. Review the information and select I understand and want to uninstall RICOH Cloud Connector. Depending on the configuration, your machine might restart after the uninstall process..
      Note:
    • If you uninstall RICOH Cloud Connector, all the programs that were using the uninstalled Cloud Connector for their subscriptions stop working.
  7. Click UNINSTALL.
  8. Log in to RICOH Account Administration and make sure that the uninstalled Cloud Connector is no longer displayed in the Connectors table.
    You can delete it manually if it was not automatically removed.

1.6.5 Troubleshooting

1.6.5.1 Common Problems

1.6.5.1.1 Could not install RICOH Cloud Connector

When you install RICOH Cloud Connector and the installation page is not displayed, try these actions.

Possible reasons why the installation page does not open:

  • You are not logged in as an administrator.

    Log in as a user with administrator rights and try again.

  • On Linux, the installation file is not defined as an executable file.

    Follow the instructions for your version of Linux to make the file executable.

  • An ad blocker prevents the RICOH Cloud Connector Installation from opening in a new browser window.

    Find the pop-up blocker settings in your browser and allow the page to open.

  • Your anti-virus software is blocking the installer from running.

    Grant permission for the program to run inside your anti-virus program.

  • You have reached the maximum number of cloud connectors that your subscription supports.

    Log in to RICOH Account Administration and remove the disconnected cloud connectors from Connectors table. Or, contact your Ricoh sales representative to upgrade your subscription.

If none of the above is true, use the command line procedure to install RICOH Cloud Connector:

  1. Log in to the computer where you downloaded the installation files, as a user with administrator rights.
  2. Open a command prompt with Run as administrator option and locate the RICOH Cloud Connector executable file.
    Important: Make sure that you have permission to execute the file. If you are on Linux, make sure that the file is executable. If it is not, follow the procedure for your Linux version to make it executable.
  3. Type the following installation command:

    rccInstallerFileName --install

  4. Press Enter.

Related information:

Installing or Updating

1.6.5.1.2 Edge does not launch when installing RICOH Cloud Connector

If Microsoft Edge is your default browser and you are using the built-in Administrator account, the browser does not open automatically when you install RICOH Cloud Connector.

When this happens, you can either sign in with different user account credentials, or change your default browser to a different one, such as Chrome or Firefox. Then start the RICOH Cloud Connector installer again.

1.6.5.1.3 Cloud Connector Error: Signature not yet current

This error might occur if the server time is not synchronized with your current local time.

Make sure that the time of your server is synchronized with the current time with an accuracy of up to 5 minutes.

If you are using Windows, we recommend that you set the current time automatically:

  1. Log in to Windows as an administrator.
  2. Click the Windows icon on the task bar.
  3. Go to Settings ⇒ Time & language ⇒ Date & time.
  4. Turn on the Set time automatically option.
  5. Scroll down to Additional settings and click Sync now.

1.6.5.2 Downloading RICOH Cloud Connector Logs

If you encounter issues while using RICOH Cloud Connector, you can easily download the application logs, which can help troubleshoot the problem.
To download logs:
  1. Open a web browser window.
  2. Enter the URL for the RICOH Cloud Connector Setup page in the address bar:

    http://server_address:port_number/license,

    where server_address is the IP address or host name of the computer where RICOH Cloud Connector is installed and port_number is the application port.

    If you are on the computer where RICOH Cloud Connector is installed and you are using the default port, you can go to http://localhost:15180/license.
  3. Click , the Help icon, on the banner and select Download logs.
  4. Save the log package to your system.
    The procedure for saving the file depends on the web browser settings.

    The logs are saved in ZIP format and the resulting package is named RCC_logs_yyyy-mm-ddThh_mm_ss.zip, where yyyy-mm-dd and hh_mm_ss represent the date and time when the logs were collected.