Configuring the Suite

Use the Suite administration Configurations page to access and manage the IBM® Maximo® Application Suite configuration settings for your environment.

When you deploy and activate a Maximo Application Suite application, you must provide the required settings for the application and for any supporting tools. You can preconfigure these settings to require no further input during deployment. For more information, see Deploying and activating applications.

The following sections describe the Maximo Application Suite configurations and the required parameters.

Configuration scope

Maximo Application Suite configurations are set at a defined scope, such as system or application.

• System scope
  The configuration is set for and can be used across the whole suite. Example: A JDBC configuration that can be used by all applications in the suite.
• Workspace scope The configuration is set for and can be used in the default workspace. Example: The JDBC connection that can be used by all applications in the suite.
• Application scope
  The configuration is set for and can be used by a single application. Example: The JDBC connection that is used by the application.
• Workspace-application scope
  The configuration is set for and can be used by a single application in the default workspace. Example: The JDBC connection that is used by the application in the default workspace.

Storing configuration values as secrets

Maximo Application Suite uses OpenShift for managing digital authentication credentials (secrets).

Input parameters that are stored as secrets are identified by a capital S.

After you submit a parameter as a secret, the secret value cannot generally be viewed by using the Maximo Application Suite user interface. Only secret parameters that are labeled with an eye icon can be viewed.

OpenShift administrators can view Maximo Application Suite secret values at: OpenShift dashboard > Projects > mas-<instance_name>-core > Workloads > Secrets.

Important: When you edit a Maximo Application Suite configuration that uses one or more secrets, such as a database password, you must reenter the secret values before you can save the updated configuration.

Updating secrets from the user interface

To update the value of a secret:

1. Open the configuration that includes the secret that you want to update, such as a database password or similar.
2. Edit the configuration and enter the updated parameter value.
3. Click Save.

The secret is updated.

Updating the super user password

The super user is a special Maximo Application Suite user that is not editable from the user interface. The super user password is stored as a secret.

To change the password for the super user:

1. Log in to the OpenShift web console as an administrator.
2. Provide a new secret for: OpenShift dashboard > Projects > mas-<instance_name>-core > Workloads > Secrets > <instance_name>-credentials-superuser
3. Delete the following pods, and then wait until they become ready again: admin-dashboard and coreidp.

The super user password secret is updated.

Custom certificates

In the configuration steps that follow, if the service that you are connecting to uses the transport layer security (TLS) communication protocol and is not secured with a certificate that is issued by a well-known certificate authority (CA), you must provide the certificate of the CA that issued the service's certificate. Because the CA might use intermediate CAs, you can provide more than one certificate.

For each certificate that you provide, the following details are displayed:

• The name of the certificate issuer.
• The name of the subject, such as the organization, that the certificate is issued to.
• The start and end dates of the certificate's validity period. If the validity of any certificate that you provide expires soon, a warning message appears.

You can automatically retrieve or manually add certificates.

Automatically retrieving certificates

In the certificates section, click Retrieve. If the connection credentials that you specify are correct, all CA certficates that are configured on the server are automatically retrieved and displayed.

These certificates are not validated. You must verify that only the correct certificates are retrieved and remove any unexpected certificates.

After you retrieve certificates, you can manually add more certificates.

Manually adding certificates

In the certificates section, click Add manually and specify the following values for each certificate that you want to add:

• Alias
  An alphanumeric identifier that is between 3 and 50 characters long.
• Certificate content
  The content of a certificate file in either the X.509 or PEM formats.

Storage

The storage configurations control Maximo Application Suite storage options at the system and application scope.

Database connection

A database is used for Maximo Application Suite application data and data analytics storage.

Configuration parameters

The following parameters are configurable:

• URL
  The URL is of the following form:
  protocol://<hostname>:<port>/<database_name>

  • Protocol
    Example: jdbc:db2
  • Hostname
  • Port
  • Database name

• Maximo Manage only: SSL Enabled
  Important: SSL enabled must be set if you are adding certificates for the Maximo Manage connection.

• Retrieve or add a CA certificate.
• Username
• Password
• Maximo Manage only: Optional driver options

Tip: If your Db2 Warehouse is running under Cloud Pak for Data you can obtain the database name, SSL port number and certificate from the Cloud Pak for Data administration console.

Maximo Monitor and IoT tool requirements

The System-scoped Db2 Warehouse configuration for the Maximo Monitor application and the IoT tool must fulfill the following requirements:

• URL:
  • Append ;sslConnection=true to the URL so that it has the form:
    jdbc:db2://hostname:port/database_name;sslConnection=true
  • Use the secure (SSL) port number.
• Set the SSL Enabled slider to Yes.
• Retrieve or add the CA certificate that is used by the Db2 Warehouse service.

Required by

• Maximo Monitor at the System scope.
• Maximo® Predict

Note: The Db2 database connection can also be shared with other Maximo Application Suite applications that require database connectivity. For example, when you deploy Maximo® Health and Maximo® Predict, you can select to share the main Maximo Application Suite JDBC Db2 connection, or you can set up a unique database connection for these applications.

CouchDB

CouchDB is a required component for Maximo® Assist. Beginning with Maximo Assist 8.2, CouchDB is embedded and automatically deployed with Maximo Assist. You do not have to manually install it. For more information, see Install CouchDB.

Configuration parameters

The following parameters are configurable:

• URL
  Example: https://<mycouchdb>.<mydomain.com>
• Username
• Password

Required by

• Maximo® Assist at the Application scope.

MongoDB

MongoDB is a core component of Maximo Application Suite and is used by Maximo Application Suite and its applications to store configuration data. The MongoDB data storage is configured during the initial setup.

Important: Changing the MongoDB configuration after setup requires careful coordination and data migration to avoid service disruptions. If you need to change the MongoDB configuration after the initial setup, contact support.

Configuration parameters

The following parameters are configurable:

• Username
• Password
• Hosts
• Port
• ConfigDb

Retrieve or add a CA certificate.

Required by

• Maximo Application Suite at the System scope.
• Maximo Monitor

Object Storage

Object Storage is a required component for Maximo® Assist. For more information, see Install Ceph Object Storage.

Configuration parameters

The following parameters are configurable:

• URL
  S3-compatible object storage URL.
• Username
• Password

Retrieve or add a CA certificate.

Required by

• Maximo® Assist at the System scope.

Users and identity

Maximo Application Suite supports local user authentication by MongoDB and authentication by using Lightweight Directory Access Protocol (LDAP) or Security Assertion Markup Language (SAML).

LDAP

To use LDAP user registry with Maximo Application Suite, you need the following LDAP server information:

Configuration parameters

The following parameters are configurable:

• URL of your LDAP instance
• Bind DN and Bind password
• Base DN
• UserID Map

Retrieve or add a CA certificate.

Required by

• Optional: Maximo Application Suite at the System scope.

SAML

Configuring SAML user authentication for use with Maximo Application Suite is a multistep process:

1. Create SAML service provider information
   Your Maximo Application Suite server acts as service provider for the SAML identify provider (IdP). You need to provide a preferred service provider name and select a name identifier format, or you can use the default values. The information is written to a service provider metadata file that you use to configure your SAML provider. For more information, see SAML server.
2. Register with the SAML provider.
   Configure your SAML IdP to recognize Maximo Application Suite. Use the downloaded SP file and follow the information for your SAML provider to complete this step.
3. From your SAML IdP, download the SAML IdP metadata XML file to Maximo Application Suite.

Configuration parameters

The following parameters are configurable:

• Service provider name
  Use the default provided name or provide one of your own. The name is used to register the Maximo Application Suite service provider.
• Name identifier format
  The format of the username identifier that is used with the SAML server.

Required by

• Optional: Maximo Application Suite at the System scope.

User registry synchronization

User registry synchronization simplifies Maximo Application Suite user management by synchronizing users and groups between an LDAP server and your local Maximo Application Suite user registry. For more information, see User registry synchronization.

Configuration parameters

The following parameters are configurable:
LDAP domain attributes:

• URL
• Base DN
• Bind DN
• Bind password

User synchronization:

• User Base DN
• User ID map
• User filter

Group synchronization:

• Group Base DN
• Group filter
• Group ID map
• Group member ID map

Other:

• Synchronization schedule
• Identity provider
• Default permissions

Retrieve or add a CA certificate.

Required by

• Maximo Application Suite at the System scope.

SMTP

An SMTP server connection is required to enable email notifications for Maximo Application Suite system events, such as new user welcome emails and password reset communication. For more information, see SMTP.

Configuration parameters

The following parameters are configurable:

• SMTP host and port
• Security protocol for the server Supported: None, STARTTLS, and SSL/TLS
• Authentication credentials for the SMTP server, if required by your SMTP server.
• Sender email address
• Suite system email address

Retrieve or add a CA certificate.

Required by

• Maximo Application Suite at the System scope.

Push notifications

The Maximo Assist Collaborate feature uses push notifications with your mobile service.

Configuration parameters

The following parameters are configurable:

• Bundle identifier
• URL
• API key

Retrieve or add a CA certificate.

Required by

• Maximo Assist at the System scope.

Analytics and licensing

These configurations manage the Maximo Application Suite license and usage management.

Behavior Analytics Services

The Behavior Analytics Services operator (BAS) collects and processes Maximo Application Suite license and usage information.

For more information about how to configure Behavior Analytics Services, see Configure Behavior Analytics Services.

Configuration parameters

The following parameters are configurable:

• URL The Behavior Analytics Services Operator Endpoint URL that was created when you installed BAS.
• API Key The BAS API Key that you generated for Maximo Application Suite.
• Email
• Given name
• Surname

Retrieve or add a CA certificate.

Required by

• Maximo Application Suite at the System scope.

Suite License Service

The Suite License Service (SLS) stores and manages the Maximo Application Suite license.

For more information about how to configure Suite License Service, see Configure Suite License Service.

Configuration parameters

The following parameters are configurable:

• Suite Licensing Service URL
• Registration key

Retrieve or add a CA certificate.

Required by

• Maximo Application Suite at the System scope.

Other

These configurations control various settings in Maximo Application Suite.

Apache Kafka

Apache Kafka acts as a buffer for asynchronous operations inside the Maximo Application Suite applications.

Important: Be careful if you change the Kafka configuration after you deploy one or more applications that use it. As a rule, cease all active use of the application for a period, disable the application, reconfigure Kafka, and then redeploy the application. For more information, see the application-specific documentation.

Configuration parameters

The following parameters are configurable:

• Username
• Password
• Hosts

Retrieve or add a CA certificate.

Required by

• Maximo Monitor at the System scope.

IBM® App Connect

Using IBM App Connect, you can connect applications and data from existing systems and modern technologies across all their environments.

For more information about how to configure and set up IBM® App Connect, see Configure IBM® App Connect .

Required by

• Optional: IoT tool at the System scope.
• Maximo Health and Predict - Utilities

External launchers

External launchers are products that are managed outside of Maximo Application Suite. By configuring an external launcher, you enable it for use with Maximo Application Suite and add a tile in the Suite navigator.

Configuration parameters

The following parameter is configurable:

• URL
  The URL for the Maximo Application Suite external product user interface.

Watson Discovery

Watson Discovery is a required component for Maximo® Assist. For more information, see Install Watson Discovery.

Configuration parameters

• URL
• Username
• Password
• The API versioning of Watson Discovery

Required by

• Maximo® Assist at the Application scope.

IBM Watson™ Studio

Watson Studio is a required component for Maximo Health and Predict - Utilities. For more information, see Deploy Maximo Health and Predict - Utilities.

Configuration parameters

The following parameters are configurable:

• Root URL
• Username
• Password
• Project ID

Required by

• Maximo Health and Predict - Utilities at the Application scope.

IBM® Maximo® Visual Inspection Edge

By using IBM® Maximo® Visual Inspection Edge, you can deploy multiple models that were trained in IBM® Maximo® Visual Inspection to edge devices.

Configuration parameters

The following parameters are configurable:

• Location and purpose of the edge deployment.

Required by

• Requires Maximo Visual Inspection at the Application scope.

Related topics

• Manage applications
  
• Getting started