IBM Maximo Assist

IBM® Maximo® Assist provides technicians with AI-powered guidance through a knowledge base of equipment maintenance data and gives them remote access to experts for assistance. Using an intuitive mobile interface, technicians can diagnose equipment problems, find recommended solutions, and collaborate with experts to resolve problems.

Overview

Maximo Assist helps to reduce the time that is required to diagnose and repair equipment problems, improves first-time fix rates, improves diagnosis accuracy, and drives higher levels of technician productivity.

Maximo Assist is available from the Suite navigator or directly at the following URL:
https://<workspace_id>.assist.<mas_domain>

For more information, see the Maximo Assist documentation.

Deploy Maximo Assist

By deploying and activating the Maximo Assist application, you make it available for use in Maximo Application Suite.

The following steps are specific to the Maximo Assist application and are part of the overarching application deployment process. You must complete the predeployment and deployment steps before you activate the application, and then you must complete the postactivation steps. By default, the application is not available to any users until you activate the application and then grant users access.

Beginning with Maximo Assist 8.2, CouchDB is embedded and automatically deployed with Maximo Assist. You do not have to manually install it.

Predeployment steps

Before you deploy Maximo Assist, ensure that the following dependencies are prepared and available for use:

Install Watson Discovery

Install IBM Watson Discovery 2.2.1 for IBM Cloud Pak for Data 3.5.0. See the Watson Discovery section of Getting started with IBM Cloud Pak for Data 3.5.0.

  1. Install IBM Cloud Pak for Data 3.5.0
    Complete the Pre-installation tasks for IBM Cloud Pak for Data 3.5.0. These tasks include setting up the Portworx storage. For more information, see Setting up Portworx storage.
    After you create the Portworx storage classes, ensure that the following Portworx storage classes that are required by Maximo Assist and the dependencies are created:

    • portworx-db-gp2-sc
    • portworx-db-gp3-sc
    • portworx-couchdb-sc
    • portworx-shared-gp3
    • portworx-metastoredb-sc
  2. Install the control plane of IBM Cloud Pak for Data 3.5.0. For more information, see Installing the control plane.

  3. Install Watson Discovery 2.2.1 for IBM Cloud Pak for Data 3.5.0.
    For more information about Watson Discovery, see the Watson Discovery overview.
    Complete the steps in Setting up the cluster for Watson Discovery and Installing Watson Discovery.
    Note: If you are installing Watson Discovery in production mode, create an override file before you start the installation. For more information, see Creating an override file for Watson Discovery.

Installing a stand-alone, external CouchDB instance (Optional)

Because CouchDB is embedded and automatically deployed, you do not have to install it. However, you can use the following instructions if you want to install a stand-alone, external instance of CouchDB.

  1. Install the CouchDB Operator on Red Hat OpenShift 4.5.
    For more information, see the Installing the Operator for Apache CouchDB on Red Hat OpenShift version 4.
  2. Deploy a CouchDB 3.1.1 cluster on OpenShift. For more information, see the documentation about deploying a CouchDB cluster on OpenShift in Deploying a CouchDB Cluster.

    1. Create a CouchDBCluster that has the following configuration, making sure that the values of the requests and limits resources are at least equal to the values that are used in the example:

      spec:
         environment:
          adminPassword: '<your_password>' // e.g. 'changeme'
         disk: 100Gi            
         size: 3
        storageClass: 'portworx-couchdb-sc'
         version: 3.1.1
         resources:
           db:
            requests:
              memory: '4Gi'
              cpu: '2'
             limits:
               memory: '8Gi'
               cpu: '4'
          mgmt:
             requests:
               memory: '128Mi'
               cpu: '250m'
            limits:
               memory: '256Mi'
               cpu: '500m'
      
    2. To expose the CouchDBCluster, create a reencrypting route by setting tls.termination to reencrypt when creating the route).
      For more information, see Access CouchDB with OpenShift route.

    3. After you create the route, run the following command to find the HOST of couchdb:

      oc get route <couchdb-route-name> -n <couchdb-namespace>
      
  3. Access the CouchDB dashboard at https://<couchdb-host>/_utils.
    To sign in, enter the admin user and the password that was specified at deployment time in the environment.adminPassword field.

Additional steps to complete for CouchDB before you deploy Maximo Assist

  1. In the OpenShift console, log in to the cluster and create a Maximo® Assist namespace manually. Example: namespace name: mas-instanceId-assist.
  2. Create an assist-secret secret manually in the preceding namespace with the keys and values for your CouchDB installation:

    1. Enter the Key OP_CLOUDANT_URL.

    2. Enter the Value for the CouchDB URL including the username and password. Example: https://<admin>:<password>@mycouchdb.mydomain.com

    3. Enter the Key OP_CLOUDANT_CRT.

    4. Enter the Value for the certificate. You can run the OpenSSL command to get the certificate. For example, to get the certificate for the CouchDB mycouchdb.mydomain.com, run the following command to retrieve and concatenate all certificates parts including -----BEGIN CERTIFICATE----- and -----BEGIN CERTIFICATE-----:

      openssl s_client -servername mycouchdb.mydomain.com -connect mycouchdb.mydomain.com:443 -showcerts

      Example:

      -----BEGIN CERTIFICATE-----  
      MIIDfTCCAmWgAwIBAgIIOnq8pKG8iFAMxN/nPJVuhGh0AlAG6cInwk5JonsIpdAfyqkq6ueY  
      .......  
      SJV70NTmJOkyArnPWZcnjVwKg22YsVMZPcg21Jzv4Fhh1UILZ3ye6mDfqfbA2c9KQrcdeef  
      -----END CERTIFICATE-----  
      -----BEGIN CERTIFICATE-----  
      MIIDDDCCAfSgAwIBAgIBNzkxNDUwHhcNMjEwNDIxMQQnMCWCIyouYXBwcy5hc3wefo  
      .......  
      zcTU2SjXyoM0V1SZQUeh3ZBEzFS4baLE8O1DQywoj30emxPNThhn+/AH8rrr9joS6aBflw==  
      -----END CERTIFICATE----
      
  3. Click Create.

Install Ceph Object Storage

Install Ceph Object Storage on OpenShift 4.5 cluster with Rook-ceph Operator or OpenShift Container Storage operator. For more information, see Red Hat OpenShift Container Storage 4.5 installation with Object Storage Gateway.

After you install Ceph Object Storage, create an S3 user account and get the access key and secret access key of this user account.

Expose the Ceph Object Storage endpoint by creating an OpenShift route for rook-ceph-rgw service by setting tls.termination as edge and getting the route host for Ceph Object Storage.

Deploying Maximo Assist

The following deployment steps are completed in Maximo Application Suite.

  1. In the Suite catalog, on the Applications tab, click the Assist tile.
  2. On the Maximo® Assist catalog page, verify the information.
  3. Select Continue. Note: If there are insufficient AppPoints available to deploy this application, you can still click Continue to complete the application configuration. The application automatically deploys when the required number of AppPoints are available.
  4. Select how you want to keep the application up to date by choosing one of the following options:

    • Click Channel subscription to subscribe to the upgrade channel. When new versions become available, they are added to the channel and updated in your suite instance either automatically or after manual approval. If you want to manually approve upgrades, turn off the Automatic approval toggle.
    • Click Manual to manually select the upgrades that you want to install, then choose Deploy version 8.2.0.

      For more information, see Upgrade strategies.

  5. On the Object storage tile, in the Dependencies section, select Configure and enter the object storage information for your prepared Ceph Object Storage.
    • Enter the Ceph Object Storage S3 route URL, for example: https://ceph-s3-rook-ceph.apps.test.os.yourcompany.com
    • Enter the username, which is the S3-compatible ceph object storage access Key ID.
    • Enter the password, which is the S3-compatible ceph object storage secret key.
    • Optionally, upload a certificate.
  6. Click Show advanced settings to configure Apache CouchDB and Redis.
    • CouchDB By default, Maximo Assist embeds CouchDB when it is deployed. You can specify the following parameters:
      • Replica - The default value is 3.
      • Storage class - The Apache CouchDB Storage Class that can be used from the OpenShift cluster. For example, use the existing managed-nfs-storage or portworx-couchdb-sc cluster.
      • Storage Size - Storage size for CouchDB, for example, 20 Gi.
    • Redis Server
      • Storage Size - Enter the expected disk size. The disk size must be 30 Gi or more.
      • Storage Class - Enter an existing storage class from the OpenShift cluster. The storage class can be used to dynamically provision a persistent volume with access mode RWO, for example, "rook-ceph-block", as the storage class name for the embedded Redis server for Maximo Assist.
  7. Click Deploy and then Begin deployment. The estimated time and configuration time that are listed represent the estimated time that it takes to configure and deploy the application. The times include both front-end configuration work and back-end processing and configuration. You can track the deployment process on the details page. When deployment is complete, you can activate Maximo® Assist to configure a workspace and give users access to the application.

Activating Maximo Assist

A deployed application is not immediately available. Before you can grant users access and start working with the application, you must activate the application. You can activate the application after the deployment steps are complete. Activating the application does not automatically grant your users access to the application.

If the application deployment is not complete, the Activate button is inactive.

  1. On the Maximo® Assist page, click Activate. The browser displays the Watson Discovery page.
  2. To configure Watson Discovery, enter the following information for your Watson Discovery instance and save your configurations.
    • Enter the URL of the Watson Discovery API, for example: https://test.apps.ocp-ema-lb.fyre.ibm.com/discovery/core/instances/1592958915192/api.
    • Enter the Watson Discovery username.
    • Enter the Watson Discovery password.
    • Enter API version of Watson Discovery in the following format: 2019-11-22.
  3. Click Activate.
  4. On the confirmation page, click Activate. The estimated deployment time that is listed represents the estimated time that it takes to activate the application. You can track the activation process on the Maximo® Assist details page.

Activated applications are available from the Suite navigator and at fixed URLs for Maximo Assist. However, it can take a few hours to complete the activation, and if the application was recently activated, it might appear in the Suite navigator but might not be ready to use.

Post-activation steps

After you deploy and activate Maximo Assist, complete the postactivation tasks.

  1. Configure the Maximo Application Suite Push Notification service so that the Maximo Assist Collaborate feature works with your mobile service.

    1. As a system administrator, on the Suite administration page, click Configurations.
    2. Select Push Notification.
    3. Click Edit and configure the following push notification parameters for sending messages to mobile devices:
      • Enter the bundle identifier of the mobile app, for example: "com.ibm.iot.maximo.mobile".
      • Specify whether you want to configure the production account.
      • Enter the cloud function API endpoint URL for the push notification service.
      • Enter the cloud function API key for the push notification service. You can generate an API key at the following URL after you sign in with your IBM ID at:
        https://b3313318.us-south.apigw.appdomain.cloud/auth/login.
      • Optionally, upload a certificate.
    4. Save the changes.
  2. Optional: Use your own customized redis server instead of embedded for Maximo Assist.

    Create a <em><code>&lt;workspace_id&gt;</code></em>-assist-redis-credentials secret:

     apiVersion: v1
     data:
       url: <base64_encoded_redis_db_url>       // e.g. redis://redis-svc.redis.svc.cluster.local:30279
       username: <base64_encoded_username>
       password: <base64_encoded_password>
       certificate: <base64_encoded_server_certificate>
       clientCertificate: <base64_encoded_client_certificate> // only needed if client auth enforced
       clientPrivateKey: <base64_encoded_client_private_key> // only needed if client auth enforced
     kind: Secret
     metadata:
       name: <em><code>&lt;workspace_id&gt;</code></em>-assist-redis-credentials
       namespace: mas-<instance_id>-assist
     type: Opaque
    

Next steps

As an application administrator, you can now give new Maximo Assist users access to the application. You also must configure automatic refresh for work orders. For more information, see IBM Support.

Update Maximo Assist

The following steps are specific to the Maximo Assist application and are part of the overarching application update process. You must complete the pre-update, update, and post-update steps before you start using the updated application.

Pre-update steps

The Maximo Assist application requires no pre-update steps.

Updating Maximo Assist

The following update steps are completed in Maximo Application Suite.

To update an application:

  1. In the Suite catalog, on the Applications tab, select the Assist tile.
  2. Click Update available.
  3. Information about the latest version is displayed.
    Click Select Maximo Assist to continue.
    You can also click Available versions and then select a different supported version to deploy.
    Note: To deploy a version that is not listed, such as a specific fix, click Deploy another version and then manually enter the version number in the search field.
    Fix version information is provided by your IBM representative.
  4. Click Deploy to start the deployment process.
    The application update process might require software downloads and more configuration steps. The estimated update time is an estimate based on typical network speeds and processing performance.
    Important: During the deployment of the new versions, users might temporarily lose access to the applications while they are being updated.

Post-update steps

The Maximo Assist application requires no post-update steps.

For other getting started steps in Maximo Assist, see Getting started with Maximo® Assist.