Installing YSoft SafeQ Embedded Terminal for OKI

Before installation

1

Make sure all general properties as defined in Installing Embedded Terminals document are completed
 

2

Configure the MFP properly. See Configuring OKI for YSoft SafeQ Embedded Terminal for more information.
 

3

Go to SafeQ Web Interface > System Settings and set forceStartInternalLdap to enabled. This option will ensure that internal LDAP server (required for authentication on OKI Embedded Terminal) will be initialized during CML/ORS service start.
 

Add a device with terminal to YSoft SafeQ

1

Log in to the Web administration, use account authorized to manage the system.

 

2

Open Devices > Printers from the menu.

images/download/attachments/21955456/menu_printers.png

3

Click the Items button in the top-right corner of the window (as illustrated on the picture below).

Choose to add device manually or using a template. This guide continues with manual steps, however you can find more details about using device templates in the Device Templates  chapter.

images/download/attachments/21955456/device_add_1.png

4

On the Basic tab, enter necessary details to identify a device. Please note that Name and IP address are mandatory and must be unique in case of one ORS server. Here is a list of all available options for each device.

    • Name - name your device. The name will be used to identify the device in YSoft SafeQ. Tip: Make sure to call all devices in a similar manner (e.g. model number) for easier troubleshooting.

    • Description - you can specify further details to recognize the device in the system.

    • Location - use this option if you want to describe exact placement of the device.

    • Group - this option defines in which group or ORS server will the device be placed. Choose from existing groups or ORS servers.

    • Cost center - device may belong to a particular cost center. Choose from existing cost centers.

    • IP address - mandatory configuration. IP address must be unique within a group or the ORS server. You can also use domain name instead of IP adress.

    • Page tracking mechanism - configuration defines the type of accounting to be used.

    • Accounting driver - this option can be used with external terminals and online accounting. With embedded terminals, you can use accounting driver to collect device counters (see Tools - Counter reports for more details).

images/download/attachments/21955456/web1.png

5

Continue to the Terminal tab, select the Embedded   terminal option at the top. More configuration options will be displayed. Once you click Save device installation will begin.

    • Vendor

    • Authentication
      Enable this option if you want the users to authenticate before accessing the device. Note that this may affect also other features.

      • Method – Select the authentication method. Username and password or PIN are supported authentication methods. With this option, authentication with Card via YSoft USB card reader is also possible but additional configuration might be required, for more information see the article Configuring OKI for YSoft SafeQ Embedded Terminal.

      • (Advanced only) Mode  keep the To device option. Users must authenticate to unlock the device and access any of the features.

      • When any users username contains @ character, additional configuration is required, for more information see the article Configuring OKI for YSoft SafeQ Embedded Terminal with the At sign in username.


    • Application
      Enable this option if you want to use the YSoft SafeQ interface application. Note that this application may be required by some other features.

      • (Advanced only) Type – Select the type of terminal to install:

        • Browser – Application will use browser-based terminal with YSoft SafeQ interface.

      • (Advanced only) Job list folders – Select which folders should be displayed to the users.

    • Scan
      Enable this option if you want to enable YSoft SafeQ scanning features.
       

    • Accounting
      Enable this option if you want to enable native accounting.

 images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg NOTE: Some options are available for editing only in the Advanced view. You can choose between Basic and Advanced in the lower left corner. If any Advanced option is changed from its default value it will become editable also in the Basic view until its value is changed again to default.

images/download/attachments/30672326/OKI_updated.png

 

6

Direct printing tab allows you to specify direct queue(s) which enable the device to receive jobs without the need for user to authenticate at the terminal (note: print job is still authorized in YSoft SafeQ).
 

In order to add a direct queue, click the Add queue button in the top right corner and specify its name. The direct queue name must be unique in the entire system.
 

For each direct queue, you can enable or disable deleting the print jobs after being printed out (released at the printer) by choosing the option Delete after printing. More information about deleting jobs after print is available at Delete jobs after printing.

images/download/attachments/21955457/web3.png

7

Navigate to the Advanced tab, which allows you to specify additional optional configuration.

  • Equipment number - specify unique identifier for each device. Equipment number remains the same even if the device name or IP address is changed.

  • Maintenance contract number - typically used to identify specific contract linked to the device.

  • Contact person - use this value to specify person responsible for the device (in case of failure, errors, maintenance, etc.)

  • Scan jobs default addressee - this option is used with Terminal Professional and therefore does not apply to installation of Terminal Embedded.

  • Printer type - this is a custom field which can be used with printer type definition (located in Devices > Tools > Printer types menu).

  • Backend - option refers to network protocol used for communication with the device and used for printing at the device. After selecting another printing backend, use the wrench icon to automatically adjust the Port number. Otherwise, you will need to change it manually.
    The following network protocols are available:

    • IPP - provides a standard network protocol for remote printing as well as for managing print jobs, media size, resolution, etc.

    • IPPSSL - basic IPP with job encryption over SSL.

    • LPR - general TCP/IP utility that is used to send print jobs from clients to print servers.

    • LPR (PJL Copies) - basic LPR extended with PJL method for switching printer languages at the job level.

    • TCP/IP Raw - TCP/IP with raw socket that allows access to the underlying transport provider.

    • TCP/IP Raw NoMap - same as TCP/IP Raw, but with NoMap function.

  • Port - port number that device uses for communication. This option depends on the selected print backend.

  • Print job encoding - encoding type used by the device. Encoding is defined by print driver used by the users at the time of creating print job. It can affect job accounting for users with diacritics in the login name. Default value is UTF-8.

  • Online accounting / Offline print accounting / Offline copy accounting - select to enable particular accounting method (this is an optional configuration).

  • Alert messages encoding - configures encoding of messages created by the device.

images/download/attachments/21955457/web4.png

8

The SNMP tab allows configuration of SNMP v2 and SNMP v3 used with the device.

    • SNMP v2

      • SNMP read-only community for remotely accessing the device states.

      • SNMP read-write community for remotely reading and writing to device properties.

    • SNMP v3

      • Username

      • Context name

      • Authentication algorithm

      • Authentication password

      • Privacy algorithm

      • Privacy password

images/download/attachments/21955457/web5.png

9

Prices tab configures the costs of using device features.

Configured prices are used for accounting print, copy and scan jobs performed at the device. Prices are defined in the assigned price list. For more information about job accounting see Price list and Advanced Detail Accounting.

images/download/attachments/21955457/web6.png

images/download/attachments/21955457/web7.png

10

Tags tab enables different print languages or user tags for the device.

All print languages are enabled by default. This configuration must match tags for each job (see detailed job information).
Check how to use System and User tags.

images/download/attachments/21955457/we8.png

11

Click Save device button. After confirmation, the device will be automatically reinstalled with updated configuration and embedded terminal.

images/download/attachments/21955457/device_confirm.png

12

The embedded terminal is being installed. New popup with installation progress will appear. You can close the window with device settings.

For more details about the installation, click the small double arrow icon images/download/attachments/21955457/arrow.png .

images/download/attachments/21955457/web9.PNG

13

After installation is completed, message "Installation finished successfully" is displayed.

Should the installation process encounter any issues, please open the installation details with more information about the error.

images/download/attachments/21955457/web10.PNG

14

If you need to change the settings of an already installed device or terminal, click the edit icon or double-click the device from the list.

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/warning.svg Please note, that some settings may require terminal reinstallation, which will occur automatically after saving the changes.images/download/attachments/21955457/device_edit.png