This "how to" describes how and when it is necessary to restart SPOC or a SPOC group. It is strongly recommended to perform the restart with no load on the SPOC server (no new jobs, no printing/copying/scanning, ...) and running Dispatcher Paragon Management Server.

A SPOC group (near roaming) with only one SPOC server is not a supported configuration. A SPOC group has to have at least two SPOC servers.

When the enableEtcd option is enabled in the Management System Settings, a SPOC group must consist of at least three SPOC servers to ensure ETCD quorum. Alternatively, the group can include two SPOC servers, with a third server running only the extension SWC-155 (ETCD witness server).

To control services, run 'Services' on the Windows server (Start > Run > Services.msc > Enter).

What a SPOC cache is and how to delete it is described in How to Delete the Dispatcher Paragon Spooler Controller Cache.

SPOC Maintenance Scenarios: 

When Creating a SPOC Group from Standalone SPOCs

After creating a new SPOC group using Dispatcher Paragon Management Interface, follow the steps below.

If the SPOC servers are newly installed, then:

Follow the steps described in the section How to Safely Restart a SPOC Group without Cache Deletion below ( (lightbulb) In this case, it is not necessary to wait as described in step 8).

If SPOC servers are already in production and contain waiting and printed jobs, then:

Follow the steps described in the section How to Safely Restart a SPOC Group with Cache Deletion below.

When Adding a Standalone SPOC to an Existing SPOC Group

After adding standalone SPOC to an existing SPOC group using Dispatcher Paragon Management Interface, follow the steps below.

After adding a standalone SPOC to an existing SPOC group that already has two members:

Follow the steps described in the section How to Safely Restart a SPOC Group with Cache Deletion below, including the newly added SPOC.

After adding a standalone SPOC to an existing SPOC group that already has three or more members:

    1. Newly added SPOC:
      1. Stop following services:
        Dispatcher Paragon Spooler Controller
        Dispatcher Paragon Spooler Controller Group Service
        Dispatcher Paragon Terminal Server
      2. Stop all other Konica Minolta services except following:
        Dispatcher Paragon Management Service (if present)
        Dispatcher Paragon Bundled PostgreSQL <version> (if present)
      3. Delete the folder <install_dir>\SPOC\SpoolCache .
    2. SPOCs that were original members of a SPOC group:
      1. Follow the steps described in the section How to Safely Restart a SPOC Group without Cache Deletion .
    3. Newly added SPOC:
      1. Start the Dispatcher Paragon Spooler Controller service.
      2. Wait for Dispatcher Paragon Spooler Controller Group Service to start automatically within two minutes.
      3. Start all the remaining Konica Minolta services configured with a startup type other than Manual.
      4. Wait until SPOC shows ONLINE status on Management interface or until <install_dir>\SPOC\logs\spoc_lifecycle.log shows last status "ONLINE".
      5. Wait until distributed layer has converged, meaning that spoc.log contains text "RescueCache| Rescue process for SPOC's cache finished.", this may take approximately 5 minutes.

After adding SPOC (any SPOC group size)

    1. If enableEtcd is Enabled in Management System Settings, follow the steps described in the section How to ensure etcd cluster is working correctly.
    2. Perform Spooler Controller Near Roaming Health Check.

When Removing One SPOC from a SPOC Group

After removing SPOC from a SPOC group using Dispatcher Paragon Management Interface, follow these steps:

    1. SPOCs that remained in a SPOC group:
      1. Perform steps outlined in section How to safely restart a SPOC group with cache deletion.
      2. If enableEtcd is Enabled in Management System Settings, follow the steps described in the section How to ensure etcd cluster is working correctly.
      3. Perform Spooler Controller Near Roaming Health Check.
    2. Removed SPOC:
      1. Stop following services:
        Dispatcher Paragon Spooler Controller
        Dispatcher Paragon Spooler Controller Group Service
        Dispatcher Paragon Terminal Server
      2. Stop all other Konica Minolta services except following:
        Dispatcher Paragon Management Service (if present)
        Dispatcher Paragon Bundled PostgreSQL <version> (if present)
      3. Start Dispatcher Paragon Spooler Controller service.
      4. Start all the remaining Konica Minolta services configured with a startup type other than Manual.

When Moving a SPOC from a SPOC Group to Another SPOC Group

When it is necessary to move a SPOC from a SPOC group to another SPOC group, do it in two steps.

  1. First, remove the SPOC from the SPOC group and make it a standalone SPOC (follow section "When Removing One SPOC from a SPOC Group").
  2. Then add the standalone SPOC to the new SPOC group (follow section "When Adding a Standalone SPOC to an Existing SPOC Group").

  3. If enableEtcd is Enabled in Management System Settings, follow the steps described in the section How to ensure etcd cluster is working correctly.

  4. Perform Spooler Controller Near Roaming Health Check.

    Optionally, all this can be done in one step, but it requires following How to safely restart a SPOC group with cache deletion section for both SPOC groups.

When Changing the IP Address of Site Server

When the IP address of Site Server (SPOC) is changed as described in the section How to Change the IP Address of Dispatcher Paragon Site Server, then follow the steps described in the section How to safely restart SPOC group with cache deletion on all remaining members of Spooler Controller Group to properly reconnect the node with the changed IP address.

When Restarting the Server with the Installed SPOC

When a server restart is required due to, e.g., Windows updates, Windows failure, or a hardware configuration change, then restart the operating system. Windows shuts down all services, reboots, and then restarts them.

  • The SPOC server that is not part of the SPOC group:
    • You may restart multiple SPOC servers in parallel
  • SPOC servers in a SPOC group (any size of SPOC group):
    • Only one member (server) of a SPOC group can be restarted at a time. Once the server restarts and the SPOC is visible online on Management Server (Dispatcher Paragon management interface> Devices > Spooler Controller Groups), wait circa 5-10 minutes. If you wish, you may then proceed with the restart of the next SPOC server in the group.
    • If you restarted multiple members of a SPOC group in parallel, follow the section How to safely restart a SPOC group with cache deletion on all members of a SPOC group.

SPOC Restart Procedures:

The following section describes the process for restarting a standalone SPOC and a SPOC group. To choose the right one, please check the use cases above. If you delete the cache during a restart, the cache recovery algorithm executes and the SPOC downloads all its jobs from Dispatcher Paragon Management Server and saves them to its cache and distributed layer if the SPOC is in the SPOC group. If you do not delete the cache during the restart, the cache rescue algorithm executes. The difference between the cache recovery and cache rescue algorithm is that in the cache rescue algorithm, the jobs are not downloaded from Dispatcher Paragon Management Server and stored in the cache and distributed layer again, but only the jobs' "statuses" are updated according to the newest time stamp (the time stamp on the SPOC vs. the time stamp on Dispatcher Paragon Management Server).

How to Safely Restart a SPOC Group with Cache Deletion

  1. Perform these steps on all SPOC group members:
    1. Stop following services:
      Dispatcher Paragon Spooler Controller
      Dispatcher Paragon Spooler Controller Group Service
      Dispatcher Paragon Terminal Server
    2. Stop all other Konica Minolta services except following:
      Dispatcher Paragon Management Service (if present)
      Dispatcher Paragon Bundled PostgreSQL <version> (if present)
    3. Delete the folder <install_dir>\SPOC\SpoolCache .
  2. Perform these steps on one SPOC group member:
    1. Start the Dispatcher Paragon Spooler Controller service.
    2. Wait for Dispatcher Paragon Spooler Controller Group Service to start automatically within two minutes.
    3. Start all the remaining Konica Minolta services configured with a startup type other than Manual.
    4. Wait until SPOC shows ONLINE status on Management interface or until <install_dir>\SPOC\logs\spoc_lifecycle.log shows last status "ONLINE".
    5. Wait for the message "End of processing of GetNewJobsByUsersResponseMessage" to appear in the <install_dir>\SPOC\logs\spoc.log. This process may take 5 to 30 minutes, depending on the size of the environment and the volume of print jobs.
  3. Repeat the step 2 on all SPOCs in the SPOC group, always one server at a time.

    Previously printed jobs may not be visible in the terminal job list for until spooler job recovery has completed.

How to Safely Restart a SPOC Group without Cache Deletion

  1. Perform these steps on one SPOC group member:
    1. Stop following services:
      Dispatcher Paragon Spooler Controller
      Dispatcher Paragon Spooler Controller Group Service
      Dispatcher Paragon Terminal Server
    2. Stop all other Konica Minolta services except following:
      Dispatcher Paragon Management Service (if present)
      Dispatcher Paragon Bundled PostgreSQL <version> (if present)
    3. Start the Dispatcher Paragon Spooler Controller service.
    4. Wait for Dispatcher Paragon Spooler Controller Group Service to start automatically within two minutes.
    5. Start all the remaining Konica Minolta services configured with a startup type other than Manual.
    6. Wait until SPOC shows ONLINE status on Management interface or until <install_dir>\SPOC\logs\spoc_lifecycle.log shows last status "ONLINE".
    7. Wait until distributed layer has converged, meaning that spoc.log contains text "RescueCache| Rescue process for SPOC's cache finished.", this may take approximately 5 minutes.
  2. Repeat the step 1 on all SPOCs in the SPOC group, always one server at a time.

Terminal Server procedures

How to ensure etcd cluster is working correctly

If enableEtcd is Enabled in the management interface Settings, follow the steps below:

  1. On any server that belongs to the cluster, locate etctctl.exe utility in the directory <install dir>\SPOC\terminalserver\etcd
  2. Check that the etcd cluster is healthy, as well as all of its members, and that cluster contains correct members, by executing the command:
    etcdctl.exe --endpoint http://127.0.0.1:2377 cluster-health
    For example, if the cluster should have three members, output should be like this:
    member 5f8cbaace2f3bf3b is healthy: got healthy result from http://10.0.5.219:2377
    member dce1e734da5d583f is healthy: got healthy result from http://10.0.5.218:2377
    member d177d434de7565cb is healthy: got healthy result from http://10.0.5.217:2377
    cluster is healthy
    If the members are not healthy, follow the steps in Reconfiguring or Recovering an etcd Cluster in Terminal Server guide to make the cluster healthy before proceeding further.
  3. If etcd authentication is enabled (property enableEtcdApiAuth set to Enabled in the management interface Settings), make sure the authentication on the etcd cluster is configured correctly by executing the command (replace username and password with valid etcd credentials):
    etcdctl.exe --endpoint http://127.0.0.1:2377 -u root:password auth enable
    If the output is:
    auth: No root user available, please create one
     Then authentication is not configured properly. Follow the Hardening etcd communication security guide, section Enable authentication of the etcd API.
  4. Check again that the cluster is healthy 
    etcdctl.exe --endpoint http://127.0.0.1:2377 cluster-health