Maximo Application Suite
Customer-managed

Configuring and activating Maximo Real Estate and Facilities

Before you can grant users access and start working with the application, you must configure and activate IBM® Maximo Real Estate and Facilities. You can activate Maximo Real Estate and Facilities after the deployment is complete.

Before you begin

Important:

Before you activate Maximo Real Estate and Facilities, ensure that a default storage class is set in the Red Hat OpenShift cluster or specify a storage class for logs and user files. If you don't specify a storage class for logs and user files in the custom resource, the operator uses the default storage class that is set in the cluster and if it is not set, the deployment fails.

Do not change the storage class after you start activation. After the storage class is set, you cannot change it without losing data.

Confirm that the Maximo Real Estate and Facilities database is configured and you have its information available, including the JDBC URL in the correct format.

If you need to integrate with external servers over TLS, you must provide CA certificates for the servers. Have the CA certificates details ready.

Procedure

  1. Create a secret with the default name format of <workspaceId>-facilities-vs--sn to hold the value for AES encryption. This value must be available during activation. For more information, see AES encryption.
  2. In Maximo Application Suite, from the side navigation menu, click Applications and then click Real Estate and Facilities. On the Real Estate and Facilities page, click Activate.
  3. Set Advanced settings to on to see the settings for Real Estate and Facilities.
  4. Configure the database connection information for Maximo Real Estate and Facilities. The Real Estate and Facilities configuration scope is workspace-application, which means that the configuration is set for and can be used with a single application in the default workspace.
    1. In the Dependencies and Integrations section, on the Database connection tile, select View.
    2. On the Database connection page, click Edit.
    3. In the JDBC connection information section, select the SSL-enabled checkbox and specify the following information.
      Note: Only secure sockets layer (SSL) connections to the database are supported.

      Specify the JDBC connection URL, username, password to connect to the database as shown in the following examples.

      • For IBM Db2® database:

        jdbc:db2://<hostname>:<port>/<database name>:sslConnection=true;sslVersion=TLSv1.2;

        For example:

        jdbc:db2://169.61.55.213:50010/mref428:sslConnection=true;sslVersion=TLSv1.2;

        By default, if a value is not specified, the database schema value is the database username in capital letters.

        You can optionally specify a custom database schema value that doesn't match the username, such as MREFDB, in capital letters.

        jdbc:db2://<hostname>:<port>/<database name>:sslConnection=true;sslVersion=TLSv1.2;currentSchema=<SCHEMA_NAME>;
        Warning: When you specify a custom schema, ensure that the custom database schema value does not match the database user name or the Db2 driver fails. If you want the username and database schema values to match, do not set currentSchema=<SCHEMA_NAME>.

        For example:

        jdbc:db2://169.61.55.213:50010/mref428:sslConnection=true;sslVersion=TLSv1.2;currentSchema=MREFDB;
      • For Oracle Database:

        jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCPS)(HOST=<hostname>)(PORT=<port number>))(CONNECT_DATA=(SID=<Service ID>)))

        The protocol for SSL is TCPS.

        Service names are not supported.

        For example:

        jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCPS)(HOST=169.61.55.213)(PORT=5500))(CONNECT_DATA=(SID=orashift)))
      • For Microsoft SQL Server database:

        jdbc:jtds:sqlserver://<host>:<port>;datatabaseName=<database name>;tds=<jTDS version>;SendStringParametersAsUnicode=false;prepareSQL=2;ssl=authenticate

        jTDS is a required driver for Maximo Real Estate and Facilities and must be specified in the JDBC URL.

        For example:

        jdbc:jtds:sqlserver://169.61.55.214:2022;databaseName=justice4;tds=8.0;SendStringParametersAsUnicode=false;prepareSQL=2;ssl=authenticate

      Additional driver options (optional)

      Typically, you can specify JDBC options as part of the URL for the database. However, in some cases you might want to specify extra JDBC options. You can add multiple options separated by a semicolon (;).

      For example, your URL might exceed the maximum length that is allowed. Or, you might want to configure a JDBC option that cannot be included in the connection URL. However, you cannot specify the same JDBC option in both the URL and the additional driver options. If you do, JDBC driver errors can cause the connection to fail.

      Security: Custom certificates

      If you are using certificates from a nontrusted certificate authority or if default trusted certificate authorities are not automatically used, add the custom certificate here.

      If you chose to use an SSL-enabled database connection, click Add + to display the fields to include in your database certificate.

      In the Alias field, specify an alias name to identify the certificate, for example, DB2WHcert. Each alias name must be unique within the workspace.

      In the Certificate content field, copy and paste your certificate in the format that is mentioned in the field content. After you copy and paste the text into the field, including the BEGIN CERTIFICATE, and END CERTIFICATE text, click Confirm.

      Click Retrieve to retrieve certificates from the server. You can retrieve a Privacy Enhanced Mail (PEM) certificate for your database. The file must be a Base-64 encoded X.509 file. You do not need to retrieve a private key. For more information, see the documentation for your database. The suite automatically downloads and saves any CA certificates that are configured with the server. The certificates are not validated, so you must verify them and remove any unwanted certificates for the server.

    4. Click Save. The Database connection page is closed.
      Note: Click Save and Select if you do not want to wait for the database connection verification after you complete the fields.
    5. Click the Database connection tile to verify your database connection. Expand the Status section that is loading in the Configuration Scope: Workspace-application section to display some tiles. Click Select when the Status icon displays the Ready message ready.
  5. By default, the system manages advanced settings and the recommended values are set. To review or modify the default values, set Advanced settings to off.
  6. To modify the workload size, in the Deployment section, set System Managed to off.
    Choose Small, Medium, or Large. The default value is Small. For more information, see Workload sizes and deployments.
  7. To configure persistent storage, in the Storage section, set System Managed to off.
    Log files storage access mode
    Supported access modes are ReadWriteOnce and ReadWriteMany. The default is ReadWriteOnce.
    Log files storage class
    The storage class can vary based on your environment. For example, ibmc-file-gold-gid for IBM Cloud®, or ocs-storagecluster-cephfs.
    Note: The Red Hat OpenShift Container Platform cluster must be equipped with a StorageClass that can grant read/write permission to the Linux® root group and to support Kubernetes ReadWriteMany or ReadWriteOnce access mode.
    To view a list of available storage classes in your cluster, run the following Red Hat OpenShift console command:
    
    oc get storageclasses
    Log files storage size
    Specify a size in GB based on your requirements for logs. The default is 30.
    User files storage access mode
    Supported access modes are ReadWriteOnce and ReadWriteMany. The default is ReadWriteOnce.
    User files storage class
    The storage class can vary based on your environment. For example, ibmc-file-gold-gid for IBM Cloud, or ocs-storagecluster-cephfs.
    Note: The Red Hat OpenShift Container Platform cluster must be equipped with a StorageClass that can grant read/write permission to the Linux root group and to support Kubernetes ReadWriteMany or ReadWriteOnce access mode.
    To view a list of available storage classes in your cluster, run the following Red Hat OpenShift console command:
    
    oc get storageclasses
    User files storage size
    Specify a size in GB based on your requirements for logs. The default is 50.
  8. Starting in Maximo Real Estate and Facilities 9.2, to configure whether the Maximo Real Estate and Facilities Application OM package is installed by the operator, in the Application Object Migration section, set System Managed to off and select an option.
    Warning: Application upgrades can overwrite your custom changes. Do not select Automatic if you have customized your application.
    Note: This feature is available only in the feature channel. In Maximo Application Suite, customer-managed users can use the feature channel to update their nonproduction instances to preview new features. For more information, see What's new in the Maximo Application Suite feature channel
    Application Object Migration
    Specify whether the operator installs the Maximo Real Estate and Facilities Application OM package during deployment. The default value is Manual. Available options are:
    • Manual - Does not install the application OM package. You can upgrade the application manually later.
    • Load only - Loads the application OM package but does not import it.
    • Automatic - Loads and imports (installs) the application OM package.
    For more information, see Upgrading the Maximo Real Estate and Facilities Application.
  9. To connect to external systems, in the Imported certificates section, set System Managed to off.

    Click Add to add trusted certificates for external sites into the truststore in WebSphere® Application Server Liberty. Specify the certificate alias and copy and paste the contents of the certificate. Each alias name must be unique within the workspace. For more information, see Adding trusted certificates.

  10. To configure Liberty application server, in the Server configuration section, set System Managed to off.
    Liberty Server XML extensions
    By default, no extensions are specified. You can specify a sequence of XML elements to be added to the server.xml file of the WebSphere Application Server Liberty as shown in the following example:
    <logging consoleLogLevel=“AUDIT” traceSpecifcation=“*=audit:com.ibm.ws.security.saml.*=all” />
    The XML elements are added and the <workspaceId>-facilities-lexml--sn secret is created.
    Tip: To verify the configuration changes directly on the server, you can access the server.xml file in the appserver and multiagent pods at the following location: /opt/ibm/wlp/usr/servers/defaultServer/server.xml
    Maximum connection pool size
    The default value for the maximum connection pool size of the database is 100 per pod.
  11. To modify the timeout for Maximo Real Estate and Facilities routes, in the Network section, set the System Managed to off.
    The default value is 600s. The supported values for the time unit are microseconds (us), milliseconds (ms), seconds (s), minutes (m), hours (h), or days (d). For more information about routes, see Network considerations.
  12. Click Start activation.
  13. On the Confirmation page, click Confirm.

What to do next

Verify that IBM Maximo Real Estate and Facilities was deployed in Suite administration.

Then, you must create the mandatory initial FACILITIESADMIN administrator user in Maximo Application Suite administration and give them access to Maximo Real Estate and Facilities, Administering Maximo Real Estate and Facilities users.

If you intend to use IBM Maximo Monitor for Workplace Analytics, you must also deploy IBM Maximo Monitor, see Deploying IBM Maximo Monitor.