Installing YSoft SafeQ Embedded Terminal for Xerox EIP

Before installation

1

Make sure that all steps from Install Embedded Terminals are carried out before the installation.

2

Configure the device. See Configuring Xerox EIP for YSoft SafeQ Embedded Terminal for more information.

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.

      • (Advanced only) Mode

        1. To device - the device is locked. User must authenticate to unlock the device and access any of the features. This is the recommended option.

        2. To each application - the user must authenticate only to access the YSoft SafeQ or any other application specified by administrator. 
          images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/warning.svg If you have previously manually configured any application or feature to authenticate via YSoft SafeQ, the reinstallation of the YSoft SafeQ Embedded Terminal will cause such configuration to be deleted. In this case, you can manually export security settings of the printer before terminal reinstallation and then recover the device to its original state. For more information see Configuring Xerox EIP for YSoft SafeQ Embedded Terminal.
          images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/warning.svg Access definition control of native applications (e.g. copy) is not supported with this mode of authentication.

      • (Advanced only) Network Card reader – Enter a serial number of a network card reader for this device. images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg Note: The serial number must be unique for each device.

    • 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/warning.svg WARNING: Make sure that your device supports JBA / Network Accounting. Otherwise the installation will fail.

    • Payments
      Enable this option if you want to use Payment System with this device. When enabled, users with money accounts will be charged for print, copy and scan activity according to the appropriate price list. 
      images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/warning.svg WARNING: Make sure that your device supports Job Limits. Otherwise the installation will fail.

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg NOTE: Some options are available for editting 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/21955418/web2.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

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/warning.svg If the installation finished with warning (yellow icon), check the installation steps to see the necessary additional settings, that were not successfully set automatically. In Configuring Xerox EIP for YSoft SafeQ Embedded Terminal select a sub-page according your particular device model. There you can find a part named "After installation of YSoft SafeQ Embedded Terminal" that contains all the necessary instructions.

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/warning.svg In case you change title of your application (property application-title in configuration) and reinstall the Embedded Terminal, the YSoft SafeQ application on the device can get unlocked and the application icon may change its screen position. In that case, please lock the application again and move the icon to the original place manually. (See documentation of your Xerox device for more information.)

Additional notes

Language selection

On some Xerox devices (e.g. Phaser 3635) the currently selected language on device cannot be detected. Therefor the Blocking, Login and Card Assignment screens are not displayed in this language. In such case, you can enable forceLanguageOnXsaAuthentication property. This will make all screens to be displayed in one language, the first one in supported-lang-priority property list.

Access rights definition

For access rights control of native applications (e.g. copy) on YSoft SafeQ Embedded Terminal for Xerox, it is necessary to enable property enableXeroxAccessDefinition in System settings in YSoft SafeQ Web administration. The access rights control is only supported with authentication mode To device.
Access rights control of native applications is not supported on some models. To see, whether your model is supported, check the installation overview window. You can find there one of the two messages:

  • This device supports access definition for copy and fax.

  • This device does not support access definition for copy and fax

Access right control of color is not supported in native applications. This can be only configured individually per device by administrator. For more information see Configuring Xerox EIP for YSoft SafeQ Embedded Terminal.