Kyocera Control Server Components

Kyocera Control is made up of several components that will be briefly described in greater detail below in order to make it possible to determine the best possible type of installation for each particular case.

Learn more about the functionality of Kyocera Control under Technical design.

All Kyocera Control microservices (web services) are run by Windows IIS. Each microservice has its own application pool. The user who runs the application pool can be created during installation (user Kyocera Control system) or another user can be specified. When the user Kyocera Control system is created, a complex, automatically generated password is established for this purpose. If it should be necessary to change the password or use another user, further information can be found under Change System User.

The microservices communicate with each other using the RabbitMQ message broker system. The services read the access data for RabbitMQ from the configuration file LocalService.config at startup.

To improve performance, it is possible to have IIS start multiple instances of a service. How many are actually started is decided automatically by IIS. Specify the desired maximum number in the IIS Manager. To do this, open the Advanced Settings of the required application pool and specify the number of processes under Maximum Number of Work Processes.

All microservices require directory access to the folders Logs and WorkflowFiles (and their sharing).

Activities in connection with the billing of jobs, cost centers, postings, etc. are taken care of by the AccountingService. Its log file is Logs\AccountingService.log.

The AddressbookService takes care of reading and writing address book entries. Its log file is Logs\AddressbookService.log.

The AuthenticationService carries out authentication on the WebClient, WebAdmin and on the Embedded Client on the device. Its log file is Logs\AuthenticationService.log.

The ConfigService (configuration service) manages configuration information that the other microservices require. This is mainly information concerning access information to the database, services and directories (initially read from the LocalService.config configuration file and then stored in the database). It performs the collection of system information. The user who runs the application pool of the ConfigService must be a member of the following local Windows user groups:

  • Power Protocol User
  • Power Monitoring User

Its log file is Logs\ConfigService.log.

The DbSyncService is an optional IIS service and is responsible for data distribution over multiple, complete Kyocera Control installations. This allows all installations to be centrally managed from one main installation. In addition, cross-location printing between the individual installations is made possible. DbSyncService is not included in the suite installer package and is only available separately on request. Its log file is Logs\DeviceService.log

The DeviceService is responsible for the communication with the devices. It also generates page contents displayed on the device (visible interface of the Embedded Client). In addition, it carries out the licensing of the system and requires Internet access for online licensing. Its log file is Logs\DeviceService.log.

The EpsonComService is responsible for communication with Epson devices. It is mandatory when using Epson devices. Its log file is Logs\EpsonComService.log.

FleetComService is responsible for communication with the fleet management KYOcontrol Fleet (this requires one KYOcontrol Fleet installation). Without KYOcontrol Fleet, it manages the locations of the devices. Its log file is Logs\FleetcomService.log.

The HPcomService is responsible for the communication with HP (Hewlett-Packard) devices. It is mandatory when using HP devices. Its log file is Logs\HPcomService.log.

The ImageService processes image data (e.g. from scans) and performs file format conversions, image optimization and the OCR function. It stores files in desired destination directories (depending on the module used, the rights of the user executing its application pool are used for this purpose). Its log file is Logs\ImageService.log.

If a message (e.g. an e-mail) is to be sent, this is done by the NotificationService, which transmits the message to the desired SMTP server (also fax e-mails when a fax server is used). Its log file is Logs\NotificationService.log.

The PostboxService handles the management of mailboxes, i.e. incoming connections (e-mail). Its log file is Logs\PostboxService.log.

The print service accepts and analyses print jobs. It also checks the user rights when printing. It also sends the print data to the device. Its log file is Logs\PrintService.log.

The ReportService creates time-controlled reports that have been defined in the report generator. Its log file is Logs\ReportService.log.

The TerminalService establishes the connection to a payment terminal. Its log file is Logs\TerminalComService.log.

The UserService reads the user information from the database. If users are imported, it reads the data e.g. from a directory service into the Kyocera Control database. Its log file is Logs\UserService.log.

The Windows Authentication Service (WindowsAuthService) is required for an automatic Windows login (Single Sign On, SSO). Its log file is Logs\WindowsAuthService.log.

The WorkflowService knows all information about a workflow (created in the Workflow Editor). It ensures that the process is adhered to and forwards information to the subsequent modules or their services in the workflow. Its log file is Logs\WorkflowService.log.

The RabbitMQ software is a message broker that uses the AMQP (Advanced Message Queuing Protocol) (runs as a Windows service). The RabbitMQ server is run by the Erlang runtime environment. The components (microservices, devices...) notify each other via the RabbitMQ queues. RabbitMQ can be run on multiple machines in a fail-safe cluster (special configuration required).

MongoDB (derived from the English humongous), is a schema-free, document-oriented NoSQL database. It is very fast and allows easy expansion of the data repository, since no database schema or tables exist whose structure would have to be adapted. The MongoDB server services can also run on multiple computers and replicate automatically (special configuration required).

The WebAdmin feature installs the web interface for the administration (web administration). It is automatically linked to an icon on the desktop and in the start menu and can be accessed with a modern web browser.

The WebClient feature installs the web interface for users (for viewing print or scan jobs, managing addresses, etc.). It is automatically linked to an icon on the desktop and in the start menu and can be accessed with a modern web browser.