System Updates

This topic discusses how to check for, select, and install system updates to the Server. 

Applying software updates to a Single Server

Software updates are made available periodically. These updates may provide feature enhancements, bug fixes, updated EDI Standards, and other advances and improvements. Some licensing requirements may apply.

Before you begin:

• The Server automatically shuts down after updates have installed, at which point you will be required to manually restart the Server. Please ensure access to the Server.
  It is recommended to schedule the update at a time when server interruption has minimal impact.
• Verify all Projects and related resources in your Workspace have been committed to an SVN repository.
• Stop any testing being done.
• Back up your Server install directory.
• Temporarily stop external notifications being sent to Clarify during the update process; this includes the Clarify/Harmony messaging framework, if integrated.

The following steps take place from within the Studio Admin Console.

Note: The Server being updated must be started before starting the following procedure.

1. Select the specific Server to apply update to. This can be done from the Server Environment drop-down.
2. Suspend the Server by clicking the Suspend button. For more information see Managing Studio Connections to Servers.
   Note: Allow all running processes to finish.
3. Click the Update Server button. The Update Server window appears, showing available updates.
   Note: This button is only enabled once the Server has been suspended.
4. Select the update by clicking the related checkbox. Click Next.
   Note: An update that displays a red plus sign indicates an update that has not yet been installed.

5. Review the items to be installed as described in the Details section. Click Finish when ready to install.
   Note: While the Details section provides a summary description of update details, additional information can be found in the current Cleo Clarify Release Notes.

   You will be prompted: The Server will automatically be shut down after updates are installed. Please ensure access to the machine is available to manually restart the Server before continuing. Are you sure you would like to continue?

   Click Yes to restart and complete the update.

6. Resume the server. This can be done by clicking the Start/Resume Server button on the Admin Console.

Applying software updates to a Server Cluster

Software updates are made available periodically and can be applied to a Server Cluster. These updates may provide feature enhancements, bug fixes, updated EDI Standards, and other advances and improvements. Some licensing requirements may apply.

Before you begin

• Always schedule the update at a time when the Server Cluster interruption has minimal impact.
• Verify that all Projects and related resources in your Workspace have been committed to an SVN repository.
• Stop any testing being done.
• Temporarily stop external notifications being sent to Clarify during the update process; this includes the Clarify/Harmony messaging framework, if integrated.
• Close any programs, command or terminal windows that access the Clarify install folders, with the exception of a command or terminal window using the <Share>/Clarify_6_Server/utils folder for use of the clarify_ctl command. For more information on using the Studio or clarify_ctl to manage servers in a Cluster, see How to Stop, Suspend, and Resume the Server Cluster.

Steps

1. Shutdown the Server Cluster
   Once suspended, stop the Server Cluster by calling the –shutdownCluster command to shut down the Clarify server cluster.
   Example: clarify_ctl.sh –shutdownCluster
    
2. Confirm that no Clarify services are running
   Confirm that Clarify services (for all Server Nodes) are not running. You can use the systemctl command to display the status of the service and confirm it is inactive/not running. This command should be completed on all server nodes.
   Example: sudo systemctl status clarify
   
   If the clarify service is still active, you can use the systemctl command to stop the clarify service. This command should be completed on all server nodes.
   Example: sudo systemctl stop clarify
    
3. Confirm that no Cluster applications (Coordinator, Receivers, Active Servers) are running
   Use clarify_ctl to call the -clusterStatus command.
   Example: clarify_ctl.sh -clusterStatus
    
4.  Start a single Server Node in the Server Cluster (with the Clarify service)
   Use systemctl to start a Clarify service on one server node in the Cluster.
   Example: sudo systemctl start clarify
    
5. Confirm the Server Node has started
   Call the clarify_ctl.sh –clusterStatus command. An active status under Active Servers indicates the Server Node has started. Coordinator and Receivers (Apps) should still be in suspended status.
    
6. Update the Server from the Studio.
   a) From the Studio’s Admin Console, click the Update Server button . The Update Server window appears, showing available updates. (If the button is deactivated, you must reconnect to the server and log in.)
   
   b) Select the update by clicking the related checkbox. Click Next. An update that displays a red plus sign indicates an update that has not yet been installed.
   
   c) Review the items to be installed as described in the Details section and click Finish when ready to install.
   Note: The Studio may disconnect while it waits for the Cluster to update.
   
   The cluster restarts multiple times during the update. To confirm that the update has finished, run the clarify_ctl.sh -clusterStatus command. When it reports that a Coordinator, Receiver, and Active Server application are all running, the update has finished.
    
7. Re-establish the Connection from the Studio (if necessary)
   At the end of the update, the Studio may disconnect from the Server Cluster. Should this occur, re-establish the connection by selecting the Active Server from the Server drop-down menu in the Studio’s Admin Console.
   
   Click the View Server Information button in the Studio’s Admin Console to verify that the version has been updated.
    
8. Start Clarify services on additional Server Nodes
   In step 6 above, you started the Clarify service on a single server node; now start the services on the remaining server nodes.
   Example: sudo systemctl start clarify
    
9. Resume the Cluster
   This can be done with either clarify_ctl –resumeCluster or by clicking the Start/Resume Server button on the Admin Console.
   
   The update is complete.
   
   For more information on using the Studio or clarify_ctl to manage servers in a Cluster, see How to Stop, Suspend, and Resume the Server Cluster.