Skip to main content
Skip table of contents

Terminal Deployment Tool

This tool can only be used to install FUJIFILM BI Terminal, Ricoh Standard Gen 2 Cloud Terminal, and the Xerox Gen 2 Cloud Terminal. For the FUJIFILM BI Cloud Terminal installation, the tool only works in MS Windows.

Preparation

For Windows, built-in JAVA is always used, therefore you can skip this step.

  • For macOS, it's recommended to have JAVA 11 installed.

    If you want to use built-in JAVA, you must allow libraries System Preferences > Security & Privacy > Allow Anyway next to the library name.


  • To verify the version, use the java -version command in the cmd line/terminal.
  • To install Java (optional):
    • on macOS, use Homebrew.
    • on Linux, use apt-get.

Prerequisites

The device must be set up according to documentation before using this tool.

If you are installing Ricoh Cloud Terminal against a cloud solution that does not have a publicly trusted Certificate Authority, you need to run the "fetch-certificate" command in your Terminal Deployment Tool. See the Advanced commands section below for this function's description and examples.

Terminal Deployment Tool options

When installing Ricoh Cloud Terminal against an on-premise solution, you can use the deployment tool to push your Certificate Authority to the printer so it will trust your site server. This is only needed when you use a certificate that is not signed by a publicly trusted CA. For how to create and import this CA, see the CustomCA-README file located in <your deployment tool location>\certificates.

Using Terminal Deployment Tool

Terminal Deployment Tool is available on Y Soft Partner Portal.

  1. Download an archive according to your operating system.
  2. Extract the archive.
  3. Run cmd line/terminal from the root folder of the extracted Terminal Deployment Tool archive.
  4. Use commands and parameters from the following sections.

Basic commands

INSTALL

Installs Cloud Terminal to target MFD, configures it, and performs any necessary configuration on the device, such as SP options, or authentication settings.

Mandatory parameters
Short parameterLong parameterDescriptionNote

vendorVendor

Supported vendor values (case insensitive):

  • RICOH
  • FUJIFILMBI
  • XEROX
-i--ipMFD IP address
-a--apikeyAPI key

API key obtained from your SAFEQ Cloud account

-m--server-domainServer Domain

The domain of the server to which the Cloud Terminal will connect. It can be either the domain of the cloud primary server or the domain of a local gateway.

Example:

  • customer.ap.ysoft.cloud

  • 10.22.56.21
-u--usernameMFD admin username
-p--passwordMFD admin password
Optional parameters
Short parameterLong parameterDescriptionNote
-f--force-reinstallUninstalls the application's prior installation.

This also removes application data. You will need to do the device code flow again.

The parameter works for Ricoh terminal only.

Example:

CODE 
install RICOH -f -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>

--vidVID for card reader configuration. Skip the parameter if you do not wish to do card reader configuration.  Set an empty string to configure the USB Reader set in the configuration properties.

Ricoh terminal only.

Example:

  • CODE 
    install RICOH -f -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>  --vid=<CARD_READER_VID> --pid=<CARD_READER_PID>
  • CODE 
    install RICOH -f -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD> --vid="" --pid=""

--pidPID for card reader configuration. Skip the parameter if you do not wish to do a card reader configuration. Set empty string to configure USB Reader set in configuration properties.

Ricoh terminal only.

Example:

  • CODE 
    install RICOH -f -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>  --vid=<CARD_READER_VID> --pid=<CARD_READER_PID>
  • CODE 
    install RICOH -f -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD> --vid="" --pid=""
-cd--cloud-domainSpecifies the cloud domain of the tenant. Use this parameter only if you are configuring Xerox Terminal to connect a gateway. If specified, this value must reflect the domain of your primary server.

Xerox terminal only.

Example:

CODE 
install XEROX -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>  -m <GATEWAY_DOMAIN> -cd <CLOUD_DOMAIN> -a <API_KEY>


-k Enables the kiosk mode for Xerox MFDs. This causes all applications, other than the Cloud Terminal and Jobs to be locked and hidden during the installation. If you wish to leave a specific application accessible, modify xeroxKioskAllowList in the configuration.properties file. Alternatively you can also run the set-app-access command afterwards to set access to specific applications.

Xerox terminal only.

Example:

CODE 
install XEROX -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>  -m <GATEWAY_DOMAIN> -cd <CLOUD_DOMAIN> -a <API_KEY> -k


-scp--skip-card-pluginSkips card plugin installation and disabling of Xerox card plugins during installation on VersaLink Gen 2 devices.

Xerox terminal only.

Example:

CODE 
install XEROX -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>  -m <GATEWAY_DOMAIN> -cd <CLOUD_DOMAIN> -a <API_KEY> -scp


Optional URL override parameters

Paths to all the needed services are resolved automatically from the --server-domain parameter. In case of non-standard deployment, individual paths can be overridden using:

Short parameterLong parameterDescriptionNote
-s--sqtsCloud Terminal API URL

Example:

  • https://customer.ap.safeq.cloud:8705


-d--idmAuthorization Service URL

Example:

  • https://customer.ap.safeq.cloud:7400/oauth/v1

-w--scanScan server URL for document delivery
FUJIFILM BI Terminal only

Example:

  • https://customer.ap.safeq.cloud:8707

Command examples

  • Ricoh

    BASH 
    .\terminaldeploymenttool INSTALL RICOH -i <MFD_IP_ADDRESS> -m <SERVER_DOMAIN> -a <API_KEY> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>

  • FUJIFILM BI (Cloud print method will be used as a default)

    BASH 
    .\terminaldeploymenttool INSTALL FUJIFILMBI -i <MFD_IP_ADDRESS> -m <SERVER_DOMAIN> -a <API_KEY> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>

  • Xerox

    BASH 
    .\terminaldeploymenttool INSTALL XEROX -i <MFD_IP_ADDRESS> -m <SERVER_DOMAIN> -a <API_KEY> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>

UNINSTALL

Uninstalls an already installed Cloud Terminal.

Parameters
Short parameterLong parameterDescriptionNote

vendorVendor

Supported vendor values (case insensitive):

  • RICOH
  • FUJIFILMBI
  • Xerox
-i--ipMFD IP address
-p--passwordMFD admin password
-u--usernameMFD admin username
Optional parameters
Short parameterLong parameterDescriptionNote
-k--unlockSpecifies which mode should be used to modify application access after the Cloud Terminal is uninstalled.

XEROX Terminal only

Supported values:

  • restore
    • Selected by default (when not specified). Restores the previous app states saved during installation with kiosk mode. For more information, see kiosk mode option for the install command.
  • unlockAll
    • Unlocks all installed applications on the device, including the native ones.
  • lockAll
    • Locks all installed applications on the device, including the native ones.
  • unlockNative
    • Unlocks just a set of native applications. Other applications remain untouched
    • Unlocks: Jobs, Copy, Email, Fax, ScanTo and USB
Command examples

  • Ricoh

    BASH 
    .\terminaldeploymenttool UNINSTALL RICOH -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>

  • FUJIFILM BI

    BASH 
    .\terminaldeploymenttool UNINSTALL FUJIFILMBI -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>

    After uninstalling FUJIFILM BI Cloud Terminal from a device, "Authentication/Accounting Type" should be set to "Off".

    Follow the process described in FUJIFILM BI Terminal , section Turn on custom service authentication on the device, where you change the custom method to "Off" value.

  • Xerox
    BASH 
    .\terminaldeploymenttool UNINSTALL XEROX -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>

CONFIGURE

Configures or re-configures an already installed Cloud Terminal.

Mandatory parameters
Short parameterLong parameterDescriptionNote

vendorVendor

Supported vendor values (case insensitive):

  • RICOH
  • FUJIFILMBI
  • XEROX
-i--ipMFD IP address
-a--apikeyAPI keyAPI key obtained from your SAFEQ Cloud account.
-m--server-domainServer Domain

The domain of the server to which the Cloud Terminal will connect. It can be either domain of a cloud primary server or the domain of a local gateway.

Example:

  • customer.ap.ysoft.cloud

  • 10.22.56.21
-u--usernameMFD admin username
-p--passwordMFD admin password
Optional URL override parameters

Paths to all the needed services are resolved automatically from the --server-domain parameter. In case of non-standard deployment, individual paths can be overridden using the following parameters:

Short parameterLong parameterDescriptionNote
-s--sqtsCloud Terminal API URL

Xerox terminal is not supported.


Example:

  • https://customer.ap.safeq.cloud:8705

-d--idmAuthorization Service URL



Example:

  • https://customer.ap.safeq.cloud:7400/oauth/v1

-w--scanScan server URL for document delivery

FUJIFILM BI Terminal only

Example:

  • https://customer.ap.safeq.cloud:7400/oauth/v1

Command examples

  • Ricoh

    BASH 
    .\terminaldeploymenttool CONFIGURE RICOH -i <MFD_IP_ADDRESS> -m <SERVER_DOMAIN> -a <API_KEY> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>

  • FUJIFILM BI

    BASH 
    .\terminaldeploymenttool CONFIGURE FUJIFILMBI -i <MFD_IP_ADDRESS> -m <SERVER_DOMAIN> -a <API_KEY> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>

     

  • Xerox
    BASH 
    .\terminaldeploymenttool CONFIGURE XEROX -i <MFD_IP_ADDRESS> -m <SERVER_DOMAIN> -a <API_KEY> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>

HELP

Displays help information about the specified command.

Command example
BASH 
.\terminaldeploymenttool HELP INSTALL

Advanced commands

These commands are meant for more experienced users and are not commonly used. For general issues, it is recommended to uninstall and install the Terminal again.

RESTART

Reboots the MFD.

Parameters
Short parameterLong parameterDescriptionNote

vendorVendor

Currently supported (case insensitive):

  • RICOH
  • FUJIFILMBI
  • XEROX (except for AltaLink devices)
-i--ipMFD IP address
-p--passwordMFD admin password
-u--usernameMFD admin username
Command example

  • Ricoh

    BASH 
    .\terminaldeploymenttool RESTART RICOH -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>

  • FUJIFILM BI

    CODE 
    .\terminaldeploymenttool RESTART FUJIFILMBI -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>

     

  • Xerox
    BASH 
    .\terminaldeploymenttool RESTART XEROX -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>

Advanced commands for Ricoh

CONFIGURE-SP-OPTIONS

Set SP options of the device.

Parameters
Short parameterLong parameterDescriptionNote

vendorVendorCurrently supported (case insensitive): RICOH
-i--ipMFD IP address
-p--passwordMFD admin password
-u--usernameMFD admin username
Example command
BASH 
.\terminaldeploymenttool CONFIGURE-SP-OPTIONS RICOH -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>

CONFIGURE-CARD-READER

Configures card reader on the device

Parameters
Short parameterLong parameterDescriptionNote

vendorVendorCurrently supported (case insensitive): RICOH
-i--ipMFD IP address

--vidVID for card reader configuration. Skip the parameter if you wish to configure a USB Reader set in configuration properties.Optional parameter

--pidPID for card reader configuration. Skip the parameter if you wish to configure a USB Reader set in configuration properties.Optional parameter
-p--passwordMFD admin password
-u--usernameMFD admin username
Example command
BASH 
.\terminaldeploymenttool CONFIGURE-CARD-READER RICOH -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>

FETCH-CERTIFICATE

Configures custom authentication.

Parameters
Short parameterLong parameterDescriptionNote

vendorVendorCurrently supported (case insensitive): RICOH
-s--sqtsSQTS Terminal URL

Address of your SAFEQ Cloud installation with SQTS port
example: https://myserver.local:8705

When running Cloud Terminal against an on-premise solution, the value is equal to FQDN or IP address of the gateway device.


--force-untrustedenables download of untrusted certificateWithout this parameter, a certificate will not be downloaded unless it's being trusted by the local workstation.
Example command
BASH 
.\terminaldeploymenttool FETCH-CERTIFICATE -s https://<SERVER_ADDRESS>:8705/ --force-untrusted

Advanced commands for FUJIFILM BI

CONFIGURE-FUJIFILM

Configures custom authentication.

Parameters
Short parameterLong parameterDescriptionNote

vendorVendorCurrently supported (case insensitive): FUJIFILMBI
-i--ipMFD IP address
-p--passwordMFD admin password
-u--usernameMFD admin username
Command example
BASH 
.\terminaldeploymenttool CONFIGURE-FUJIFILM FUJIFILMBI -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>

Advanced commands for Xerox

SET-APP-ACCESS

Allows you to change the installed application (any application regardless of origin) accessibility on the device without having to change the values manually in the device administration UI.

Parameters
Short parameterLong parameterDescriptionNote

vendorVendorCurrently supported: XEROX (case insensitive)
-i--ipMFD IP address
-p--passwordMFD admin password
-u--usernameMFD admin username
-a--appApplication nameIf the app is not found, the deployment tool will output all installed application names into the console so that you can check for spelling errors and other potential issues.
enable or disable
Determines whether the application is enabled or disabledIf not specified, the application will be enabled.
Command example
BASH 
.\terminaldeploymenttool SET-APP-ACCESS XEROX -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD> -a "Fax" enable
BASH 
.\terminaldeploymenttool SET-APP-ACCESS XEROX -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD> -a "Fax" disable

Additional configuration

You can find these options in the configuration.properties file inside the terminal deployment tool folder.

Configuration options

xeroxSetTerminalAsDefault

Controls whether the installed Cloud Terminal should also be set as a default application (meaning that it loads automatically after rebooting the device or waking it from sleep).

xeroxKioskAllowList

If this option is not commented out and filled with a comma-separated list, it makes the specified applications accessible even with the kiosk mode enabled.

xeroxApplicationOverrideUrl

Use this option only if your SAFEQ Cloud is hosted on OpenTelekom infrastructure.

By default, the address of Xerox Cloud Terminal points to the tenant's cloud address and is resolved to the appropriate instance of the cloud terminal. However, this automatic resolution is currently not supported for OpenTelekom clusters. Therefore, with this option. you can use Xerox Cloud Terminal also for OpenTelekom clusters.

Set to following values based on your region:

CODE 
Europe
xeroxApplicationOverrideUrl=https://primary.eu-central.ysoft.cloud/xerox

North and South America
xeroxApplicationOverrideUrl=https://primary.us.ysoft.cloud/xerox

Asia and Pacific
xeroxApplicationOverrideUrl=https://primary.ap.ysoft.cloud/xerox

Bundled tools

The <your deployment tool location>\tools folder contains some vendor-specific tools to be used in certain scenarios (such as advanced debugging, etc.). The following tools are included in the Terminal Deployment Tool files:

Xerox Remote Logger – This tool allows you to obtain extensive logs from a running Xerox Gen 2 Cloud Terminal. For more information see Using Xerox Remote Logger tool.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close