Upgrade the Plant Applications Standard Web Client

Before you begin

  • Ensure that you create a backup copy of the text file that includes the user-specific settings. The file is created in the directory <tomcat_home>/Apache Software Foundation/Tomcat 9.0/users/<user>, where:
    • <tomcat_home> is the directory where you installed Apache Tomcat. For example, C:/Program Files.
    • <user> is the name of a logged-in user.
    After you upgrade, you can copy-paste the file to the same location to replicate the user-specific settings. For more information, refer to the Plant Applications Web Client Help.

About this task

You can upgrade any earlier service pack (SP) version of Plant Applications Web Client 7.0.
Note: The Plant Applications 8.2 installer is the base installer for all upgrade requirements.

Procedure

  1. Run the installfrontend.exe file as an Administrator.
    The installation menu appears, displaying the Install Proficy Plant Applications 8.2 screen.
    Tip: You can hover over each task that appears in the installation menu to refer to the tooltip associated with that task.
  2. Select Plant Applications Web Client.
    The installer gathers the current configuration and determines the required configurations that need to be updated.

    Then the upgrade wizard appears, displaying the Welcome to Plant Applications Web Client screen.

  3. In the Welcome to Plant Applications Web Client 8.2 screen, select Next.
    The Read and accept the license agreement to continue screen appears.

  4. Read the license agreement, select Accept, and then select Next to continue the installation.
    The Prerequisites screen appears.

  5. In the Prerequisites screen, select Next to view all installed prerequisites and install any missing prerequisites.
    The Operations Hub Credentials screen appears.

  6. In the Operations Hub Credentials screen, enter the credentials to access the Operations Hub server as described in the following table.
    Credential Description
    Server Name This field is automatically populated with the local host name, fully qualified host name, or IP address, based on the configuration in Operations Hub. You can edit the host name of the Operations Hub server based on requirement.
    Note: Instead of IP address, it is recommended to use the Operations Hub host name (computer name).
    Port Enter the Operations Hub port number.
    Tenant Username Enter the tenant Hub username to access the Operations Hub server instance.
    Note: The default user name is OphubAdmin.
    Tenant Password Enter the password for the user name you entered in the Tenant Username box.
    Note: The tenant username and password must be same as the credentials that you have specified during the Operations Hub installation.
    If all the options are entered correctly, the Next button is enabled.
  7. Select Next.
    The Historian UAA Credentials screen appears.

  8. In the Historian UAA Credentials screen, enter the password to access the Historian UAA server and then select Validate.
    The following table describes each icon indicating a validation status that might appear during the validation process.
    Icon Description
    Indicates that the validation is in progress.
    Indicates that the validation was successful.
    Indicates that the validation was unsuccessful. In this case, make sure you enter the correct password.
    If the Historian UAA server connection is successfully validated, the Next button is enabled.
  9. Select Next.
    The UAA Credentials screen appears.

  10. In the UAA Credentials screen, enter the credentials to access the UAA server as described in the following table.
    Credential Description
    Server Name Enter the host name of the UAA server.
    Note: Instead of IP address, it is recommended to use the UAA host name (computer name).
    Port Enter the UAA port number.
    Admin Client ID Enter the admin Client ID to access the UAA server instance.
    Note: The default user name is admin.
    Admin Client Secret Enter the Client Secret for the user name you entered in the Admin Client ID box.
    Validate Select Validate to validate the UAA server connection.
    Note: The following table describes each icon indicating a validation status that might appear during the validation process.
    Icon Description
    Indicates that the validation is in progress.
    Indicates that the validation was successful.
    Indicates that the validation was unsuccessful. In this case, make sure you enter the correct password.
    If all the options are entered correctly, the Next button is enabled.
  11. Select Next.
    The Plant Applications Database Credentials screen appears.

  12. In the Plant Applications Database Credentials screen, in the Plant Applications Database section, enter the Plant Applications database credentials as described in the following table.
    Credential Description
    Server name Enter the server name where the Plant Applications database is installed in the format HOST_NAME\INSTANCE. Where HOST_NAME is the host name (either a fully qualified domain name or IP address, of the server) and INSTANCE is the instance of the server used by the database.
    Note: If there is no instance for the server, you can enter HOSTNAME as the server name. Localhost is not an acceptable value for HOSTNAME.
    Database Enter the name of the Plant Applications database that you want to connect with the Plant Applications Web Client.
    Username Enter the user name that has permissions to access the database you entered in the Database box. By default, the user name appears as sa.
    Password Enter the password for the user name you entered in the Username box.
    Port Optional: Enter the number of the port that the instance uses to listen for client connections.
    Note: The default port is 1433.
  13. Select Validate Connection to validate the database connection.
    Note: The validation process takes some time to check whether a compatible version of the Plant Applications server is installed.
    The following table describes each icon indicating a validation status that might appear during the validation process.
    Icon Description
    Indicates that the validation is in progress.
    Indicates that the validation was successful.
    Indicates that the validation was unsuccessful. In this case, make sure you enter the correct password.
  14. In the Plant Applications Database Credentials screen, select the CouchDB tab.
    The Document Service Couch DB Credentials section appears.

  15. In the Document Service Couch DB Credentials screen, enter the Couch DB credentials as described in the following table.
    Credential Description
    CouchDB Server Uri Enter the fully qualified web address of Apache CouchDB in the format: https://<host name or IPaddress>:<port number>.
    Node Enter the name of the node where Apache CouchDB is running. By default, the node value appears.
    Username Enter the user name of the administrator that has permissions to access the database you entered in the Database box.
    Password Enter the password for the user name you entered in the Username box.
    Couch Certificate Select Browse to locate the Apache CouchDB server certificate (couch_server.crt) that you have generated and upload it.
    Validate Select Validate to validate the Apache CouchDB database credentials.
    Note: The following table describes each icon indicating a validation status that might appear during the validation process.
    Icon Description
    Indicates that the validation is in progress.
    Indicates that the validation was successful.
    Indicates that the validation was unsuccessful. In this case, make sure you enter the correct password.
    If the Apache CouchDB database connection is successfully validated, the Next button is enabled.
  16. Select Next.
    The Plant Applications Administrator User Credentials screen appears.

  17. In the Plant Applications Administrator User Credentials screen, enter the Plant Applications Administrator credentials as described in the following table.
    Note: Ensure that the user credentials entered here must exist in Plant Applications Server with an administrator role defined and you must use the same credentials to login to the Web Client applications.
    Credential Description
    User Name Enter the user name for an administrator account in Plant Applications.
    Note: The default user name is OphubAdmin.
    Password Enter the password for the user name you entered in the User Name box.
    Validate Select Validate to validate the Plant Applications Administrator credentials.
    Note: The following table describes each icon indicating a validation status that might appear during the validation process.
    Icon Description
    Indicates that the validation is in progress.
    Indicates that the validation was successful.
    Indicates that the validation was unsuccessful. In this case, make sure you enter the correct password.
    If the Plant Applications Administrator connection is successfully validated, the Next button is enabled.
  18. Select Next.
    The Tomcat Installation screen appears.
    Note: If you already have a Tomcat instance running, a message stating that the Tomcat instance has been found appears in the Tomcat Installation screen informing you to select the existing Tomcat instance.

  19. In the Tomcat Installation screen, select OK.
    The installer prompts you to select an existing Tomcat instance if the Tomcat installation details are available in the registry settings for the Plant Applications Web Client on your computer.
  20. In the Tomcat Installation screen, select an appropriate Tomcat instance from the drop-down list box.
  21. In the Tomcat Installation screen, enter the Tomcat installation details for a new or existing installation as described in the following table. The installer prompts you to enter details for an existing Tomcat if the Tomcat installation details are available in the registry settings for the Plant Applications Web Client on your computer. Else, the installer prompts you to enter details for a new installation of Tomcat.
    Installation Detail Description
    Port Enter the HTTP port that Tomcat uses to listen for client connections.
    Note: The default port is 8081.
    Redirect Port Enter the HTTPS port that Tomcat uses to redirect all HTTP requests to this port.
    Note: The default redirect port is 8444.
    Username Enter the user name to access Tomcat.
    Note: The default user name is admin.
    Roles Skip this box because it is automatically populated.
    Password Enter the password for the user name you entered in the Username box.
    Re-enter Password Reenter the password for the user name entered in the Username box.
    Note: This box appears only when a new installation of Tomcat is initiated by the installer.
  22. Select Next.
    The Customize Web Client Log Files Location screen appears.

  23. Optional: In the LogFiles Base Folder box, select Browse to browse and select the directory where you want to install the Plant Applications Web Client service logs.
  24. Select Next.
    The RabbitMQ Credentials screen appears.

  25. In the RabbitMQ Credentials screen, perform one of the following steps:
    • Enter the RabbitMQ credentials for the machine that hosts your Plant Applications message bridge as described in the following table, and then select Validate Connection.
      Credential Description
      Server name Enter the computer name or IP address that hosts your Plant Applications Message Bridge.
      Username Enter the Administrator's user name that you set during Plant Applications Message Bridge installation.
      Password Enter the password for the Administrator's user name you entered in the Username box.
      The following table describes each icon indicating a validation status that might appear during the validation process.
      Icon Description
      Indicates that the validation is in progress.
      Indicates that the validation was successful.
      Indicates that the validation was unsuccessful. In this case, make sure you enter the correct password.
  26. Select Next.
    The Kafka Credentials screen appears.

  27. In the Kafka Credentials screen, enter the credentials to access the Kafka server as described in the following table.
    Credential Description
    Server Name Enter the host name of the Kafka server.
    Note: Instead of IP address, it is recommended to use the Kafka host name (computer name).
    Kafka Port Enter the Kafka port number.
    Zookeeper Client Port Enter the Zookeeper Client port number.
    Validate Select Validate to validate the Kafka server connection.
    Note: The following table describes each icon indicating a validation status that might appear during the validation process.
    Icon Description
    Indicates that the validation is in progress.
    Indicates that the validation was successful.
    Indicates that the validation was unsuccessful. In this case, make sure you enter the correct password.
    If all the options are entered correctly, the Next button is enabled.
  28. Select Next.
    The You are ready to upgrade screen appears.

  29. Select Upgrade, and then wait for the upgrade process to complete.
    Depending on the contents to be upgraded, the upgrade process might take some time. A message appears in the wizard, indicating whether the upgrade was successful or not.
  30. Optional: Select View Logs to see the upgrade details.
  31. In the Upgrade Successful screen, select Exit to close the upgrade wizard.
    Plant Applications Web Client has been upgraded to the latest version.
  32. Run Message Bridge Configuration Utility on the Plant Applications Server to update the Kafka details in the Message Bridge configuration.
  33. Run Operations Hub Posting Utility to import the Plant Applications into the Operations Hub.
  34. Once you have completed running Message Bridge Configuration and Operations Hub Posting utilities, Verify the Installation to verify if the Plant Applications Web Client applications are up and running.
  35. Access REST APIs to access the REST APIs for Plant Applications Web Client.