Embedded Client installation on Kyocera devices

The Embedded Client (HyPAS application) can be automatically installed, activated and configured by IQ4docs, but it is also possible to install and activate it with external programs or directly on the device.

Note that a suitable device license must be available for operating the device with Embedded Client, see Licensing.

All KYOCERA print and copy systems are supported for the print function. The following systems are supported for the use of an Embedded Client.

  • Technology: KYOCERA HyPAS
  • Application: Embedded Application
  • Installation: Remote installation and configuration
  • KX printer driver (use the driver of the largest device in the device fleet, not the universal driver).
  • Classic Universal Printer Driver PCL6
A4 monochrome A4 color A3 monochrome A3 color
ECOSYS M3040idn* ECOSYS M6035cidn* TASKalfa 3010i* TASKalfa 2551ci*
ECOSYS M3145idn* ECOSYS M6230cidn* TASKalfa 3011i* TASKalfa 2552ci
ECOSYS M3540idn* ECOSYS M6235cidn* TASKalfa 3212i* TASKalfa 2553ci
ECOSYS M3550idn* ECOSYS M6535cidn* TASKalfa 3510i* TASKalfa 2554ci
ECOSYS M3560idn* ECOSYS M6630cidn TASKalfa 3501i* TASKalfa 3051ci*
ECOSYS M3645idn ECOSYS M6635cidn TASKalfa 3511i* TASKalfa 3252ci
ECOSYS M3655idn TASKalfa 308ci TASKalfa 4002i* TASKalfa 3253ci
ECOSYS M3660idn TASKalfa 352ci TASKalfa 4012i* TASKalfa 3551ci*
  TASKalfa 356ci* TASKalfa 4501i* TASKalfa 3554ci
  TASKalfa 358ci TASKalfa 5002i TASKalfa 4551ci*
  TASKalfa 406ci* TASKalfa 5003i TASKalfa 4052ci
  TASKalfa 408ci TASKalfa 5004i TASKalfa 4053ci
    TASKalfa 5501i* TASKalfa 4054ci
    TASKalfa 6002i TASKalfa 5052ci
    TASKalfa 6003i TASKalfa 5053ci
    TASKalfa 6004i TASKalfa 5054ci
    TASKalfa 6501i* TASKalfa 5551ci*
    TASKalfa 7002i TASKalfa 6052ci
    TASKalfa 7004i TASKalfa 6053ci
    TASKalfa 8001i* TASKalfa 6054ci
    TASKalfa 8002i TASKalfa 6551ci*
      TASKalfa 7052ci
      TASKalfa 7054ci
      TASKalfa 7551ci*
      TASKalfa 8052ci

* DeviceClient can only be installed up to version 4.11.

Observe the following instructions to ensure that the Embedded Client runs correctly on the device.

Before using the Embedded Client with a Kyocera device, make sure the following settings are made:

  • Energy saving standby mode: Full standby
  • Deactivate switch-off rule for
    • Network
    • USB cable
    • USB Host
    • Applications

If problems occur with these settings (e.g. the menu of the device is not loaded fully), it may help to change the settings, restart the machine, change them back to the correct values and restart the machine again.

  • Set U parameter 346
    • Set Timer/Sleep Level to Less Energy Save
    • Auto Sleep to Off
  • Timer settings: Each of the following timers automatically logs out the user from the device when the timer expires. Set the time periods as desired:
    • Control panel reset timer: Starts after the last touch of the device screen, runs out even if the device is still printing or scanning - the current job is not interrupted, but no further jobs are started (e.g. in case someone wants to print all their print jobs).
    • Energy saving timer: Starts after the device completes one operation (printing, scanning...).
    • Sleep timer: Starts after the device completes one operation (printing, scanning, etc.).

The Embedded Client for several devices can be installed and activated simultaneously via the IQ4docs device list. To do so, proceed as follows.

To open the web administration, enter http://<hostname>/webadmin in the web browser (where hostname corresponds to the server on which IQ4docs WebAdmin was installed). In a client environment, enter the URL that you received from the client administrator (for example, http://server/webadmin/#/cf992178-4bd6-431c-b815-b9d734d0ded3). If you are not already logged in, log in with a user that has administrator rights (login and password) or as the IQ4docs system administrator (administrator with password admin by default).

In the web administration, click Devices > Device List in the menu. The list appears showing all devices that have already been added to the system manually or via the device search (see also Device List).

  • Select one or more devices with the checkbox at the beginning of the line.
  • Click the Configure Devices drop-down list and select Install Embedded Client.
  • You will be asked to select the installation package (after installation, the file is located in the installation directory under assets/kyocera-device-client or assets/lexmark-device-client (marked with the version number).
  • Once the installation package has been selected, it is installed and activated on the selected devices. In addition, the devices are also immediately set up for IQ4docs.
  • Once the process has been successfully completed and the list view has been reloaded with the Refresh button , the device is marked with a green dot.

The installation only works if the manufacturer of the device is known. Check the Manufacturer entry in the detailed data record of the device if the installation fails.

The Embedded Client is transferred via RAW for the installation. If the RAW print protocol is disabled in the device, the Embedded Client cannot be installed via the WebAdmin.

If the Embedded Client has been installed in any other way (e.g. via USB stick), only the configuration can be sent to the device. To do so, select Set Up Device For IQ4docs.

The installation can be performed for several devices at the same time. Installation with the Kyocera Netviewer is no different than installing any other application on a HyPAS-enabled device. For more details, see the KM Netviewer documentation.

After installation, carry out the configuration in the IQ4docs device list. To do so, select Set Up Device For IQ4docs.

The installation of the DeviceClient described below is carried out on the device via a USB stick.

Copy the installation package (*.pkg) to an empty USB stick that can be read by the device (root directory).

In order to perform the installation, you must have administrator privileges on the device.

  • Log into the device if necessary.
  • Open System Menu > Application.
  • Click on Add.
  • Insert the USB stick into a USB port. A list of available applications appears (the list should contain only the entry IQ4docs).
  • Select IQ4docs.
  • Select Install. After doing this, close the dialog with Close.
  • After the installation, you still have to activate the application. To do so, select the application IQ4docs and select Activate Application.
  • Close the system menu, e.g. by pressing the Copy button, and remove the USB stick. IQ4docs starts without further input.
  • Close the system menu, e.g. by pressing the Copy button, and remove the USB stick. The Embedded Client starts without further input. If the device has already been created and activated with the IQ4docs Admin, the login screen appears automatically after a maximum of two minutes. This screen will now appear every time the device is started.
  • You configure the Embedded Client in the IQ4docs device list. To do so, select Set Up Device For IQ4docs.

Uninstalling the Embedded Client is performed on the device. To do this, you must access the system menu and have administrator privileges. You can log in with a user who has administrator rights or enter the unlock code on the login screen. Follow these steps:

  • If you have logged in with an unlock code, the input dialog for the administration password may appear. Enter the password and confirm with OK.
  • You will now see the Embedded Client. Close the Embedded Client (if necessary, use the Copy button of the Embedded Client).
  • Open the system menu > Applications.
  • Select Embedded Client from the list of installed programs, select Delete and confirm the confirmation prompt.