Actions reference

Actions that can be performed from the Device Registration Service for a Unified Client for Ricoh Smart Operation Panel 1.1 device. An action can be performed on a single device or on all devices in a group.

Note: When DRS is performing a Quick Install or Full Install action of Unified Client for Ricoh Smart Operation Panel 1.1 device(s), or when such action has already been queued for execution, it is not recommended to modify the device configurations or the associated application profiles as it could interfere with the ongoing installation process and lead to unpredictable results and/or action failures. Likewise, when a Sync Assets or Sync Workflow Buttons action is being performed or queued, modifications to settings of the respective feature must be avoided.
To perform an action, first select a device on the Device tab in the Device Registration Service web console. Then, in the box at the top of the Details pane, click an available action to perform on the device and click the run button . This includes the following entries:
Action History entry Description

Time

Shows date and time.

Action

Specifies current action type information.

Message

Specifies current action message information (success/fail).

Status

Specifies current status message information (running/complete).

Success

Specifies current success message information (Yes/No).

Device

Shows all devices in use.

Address

Shows IP address in use.
Return Code Shows Return Code number. For details, see Return codes.
You can follow deployment status feedback under Action History.
To perform an action on all devices in a group, first select the group folder on the Device tab, and then run the action.
Action Description
Full Install Performs an Install and Reboot, Configure and Reboot, Sync Assets, then Sync Workflow Buttons. Recommended for new installs.
Sync Assets Syncs customized assets (logo image, welcome image and welcome text). Not supported when authentication is set to False.
Sync Workflow Buttons Syncs selected workflow buttons. Not supported when authentication is set to False.
Quick Install Installs the Unified Client for Ricoh Smart Operation Panel 1.1 on the device. This action installs the package associated with device configuration, sets required SP modes, restarts the MFP, performs a Configure and Reboot, and also performs Sync Assets, and Sync Workflow buttons actions.

This action is to be used for upgrades, changing application, or advanced troubleshooting. You must update to the latest Unified Client for Ricoh Smart Operation Panel 1.1 version using DRS first.

Note: This action will not install the ScanEX.

Uninstall

Uninstalls the Unified Client for Ricoh Smart Operation Panel 1.1 on the device. For more information, refer to Uninstall the client using DRS.

Get device settings

Gets current SP Mode settings on the device. Running this Action logs SP Mode settings and their values to a properties file (with the .properties extension). The default path to these properties files is:

C:\Program Files\Nuance\Device Registration Service\Service\Plugins\RXOP-SOP\CLITools\output

The file name of each log includes the IP address of the device followed by an underscore (_) and a Universal Time (UT) date-time stamp (YYYYMMDDHHMMSS). For example:

10.56.59.31_20160802221258.properties
10.56.59.35_20160802221451.properties
10.56.59.35_20160805204754.properties

Each file first lists the day, month, date, local time, time zone and year followed by one property setting and value per line in the following format:

#
#Fri Aug 05 16:48:39 EDT 2016
adminAuthKey.file.tools=false
adminAuthKey.network.file=false
adminAuthKey.machine.general=false
adminAuthKey.file=false
userAuthDocumentServer=1
...

The actual settings and values listed in the file depend on the device.

Set device settings

This action is to be used for advanced troubleshooting purposes only.

This action sets configurations that were not completed by Full Install or Quick Install actions (or Install and Reboot and Configure and Reboot actions).

Run this action if you get the following warning (return code = 1) on completion of either the Install and Reboot or the Configure and Reboot action:

Warning: Some configurations not set

Reboot

Restarts the MFP.

Install and Reboot

This action is to be used for advanced troubleshooting purposes only.

This action first uninstalls any package already installed on the MFP, then installs the package associated with the device configuration, sets required SP mode, and then restarts the MFP. The reboot may take some time to complete.
Note: Install and Reboot action removes existing Home Key setting and if client needs to be assigned to the Home Key, a reconfiguration is needed.
Run the Configure and Reboot action after you complete this action.
Note: This action will install the ScanEX.

Configure and Reboot

This action is to be used for advanced troubleshooting purposes only.

Updates device configuration for the Ricoh package installed on the device and then restarts the MFP. This action must be run after you complete the Install and Reboot action.

The device will be rebooted two times when you run this action. The Action initially tries to set SP Mode settings to their default values and afterwards applies the new values, including whether to associate the Home key with the client, that have been specified in the Device settings. Warnings that settings were not configured indicates that the Action was unable to apply a setting, which you may choose to manually configure on the physical device.