/
Service Manager for Windows
Document toolboxDocument toolbox

Service Manager for Windows

Owned by Sarabjeet Kaur
Dec 19, 2024
3 min read

The Windows Service Manager is a tool designed to simplify tasks like starting or stopping services, disabling services, delaying their startup, or pausing and resuming Windows Services. Kyvos Reporting Service is a Windows NT Service that runs essential Kyvos services such as the Report Server, Web Server, and Load Balancer in the SYSTEM account. Processes running in the SYSTEM account continue even after the user logs off.

Purpose of Kyvos Reporting Service

The Kyvos Reporting Service ensures that the Kyvos processes (Report Server, Web Server, and Load Balancer) start automatically when the system boots up, eliminating the need for users to log in to launch these processes.

Servers Managed by Kyvos Reporting Service

Kyvos Reporting Service manages the following server processes:

  • Report Server: Provides reporting services and internal repository services to clients.

  • Web Server: Offers a web-based interface for users, processes user requests, sends them to the Report Server, and delivers the Report Server's responses to users.

  • Load Balancer Server: Enables scalability and high availability by allowing the distribution of load across multiple report servers in a clustered environment. The Load Balancer Server receives user requests and distributes them to different report servers to efficiently handle heavy loads.

Kyvos Reporting Service Manager

The Kyvos Reporting Service Manager is a Windows-based user interface that allows administrators to view and manage the Kyvos Server processes.

Opening the Service Manager

  1. From the Start Menu, navigate to Kyvos Reporting > Service Manager.

The Service Manager window lists all the Kyvos Reporting services and their current status (started or stopped). When a server is selected, its properties are displayed below the list.

Tool Buttons

  • Add: To add a new server.

  • Delete: To delete a server. Deleting a server will stop it if it’s running and remove it from the manager list.

  • Start: To start the selected server(s).

  • Stop: To stop the selected server(s). You can highlight multiple servers by holding Shift + Click and then stop them all.

  • Logs: To view logs for the selected server.

Note

A server in the process of starting cannot be deleted or stopped. You cannot perform any actions on a server that is in the process of stopping.

Action Buttons

  • Save: This option saves any changes made to the Add New Server dialog and Service Manager dialog, such as configuration or global setting changes.

  • Reset: Abandon any changes made to the Add New Server and Service Manager dialog.

Adding a Server

Important

Ensure the server is in the stopped state before adding it. Adding a running server may lead to conflicts, such as port binding issues when the service attempts to start.

  1. Click the Add button in the Service Manager window. The Add New Server dialog will open.

  2. Enter the following information for the new server:

    • Server Type: Select from Report Server, Web Server, or LoadBalancer Server.

    • Server Name: A unique identifier for the server.

      • The name must only contain letters, numerals, periods, dashes, @, spaces, and underscores.

    • Executable File Path to Run Server: Specify the file path for the script that starts the server. Example: D:\Program Files\Kyvos Reporting\ReportEngine\bin\run.bat

    • Executable File Path to Stop Server: Specify the file path for the script that stops the server. Example: D:\Program Files\Kyvos Reporting\ReportEngine\bin\shutdown.bat

    • Property File Path: Path to the configuration file containing details such as server port, log file location, etc. Example: D:\Program Files\Kyvos Reporting\ReportEngine\Config\ReportEngine.properties

  3. After entering all required details, click OK. The Add New Server dialog will close, and the newly added server will appear in the Service Manager dialog.

  4. Save the changes by clicking the Save button in the Service Manager dialog.

Server Properties

These properties are common for all servers:

  • Start Servers During System Boot Up: Check this box to automatically start all servers when the system boots. If unchecked, servers can be manually started from the Service Manager.

  • Enable Auto-Restart if Servers Crash: Check this box to automatically restart a server if it crashes. The system considers a server to be "crashed" if it is not stopped via the Kyvos Reporting Service Manager.

  • Server Startup Timeout: Defines the timeout (in seconds) for server startup. The system will continue pinging the server until it responds, or until the timeout is reached. If the server does not respond within this time, an error is logged. Valid range: 0 to 7200 seconds.

  • Server Process Monitor Interval: Defines how often the system checks if the server is running (in seconds). Valid range: 10 to 7200 seconds.

Copyright Kyvos, Inc. All rights reserved.