Configure Maximo Application Suite
Use the administration Configurations and Integrations pages to access and manage the IBM® Maximo® Application Suite component settings for your environment.
Configuration and integration management requires the following entitlement and access:
| Administration Enablement | Administration Access |
|---|---|
| Base or Premium | System management |
Tip: When you deploy a Maximo Application Suite application, you are prompted for the required settings for the application and for any supporting tools. You can pre-configure these settings, in which case the information is just validated during installation and no further input is required.
| Configurations | Required by application |
|---|---|
| MongoDB | All |
| Apache Kafka | Maximo Monitor |
| LDAP | Optional |
| SAML | Optional |
| Db2 Warehouse | Maximo Monitor |
| Integrations | Required by application |
|---|---|
| Slack | Optional |
| PagerDuty | Optional |
The following sections describe the Maximo Application Suite components and the required parameters.
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.
MongoDB details
The following parameters are configurable:
- Username
- Password
- Hosts
- Port
- ConfigDb
Required by
- Maximo Application Suite
- Maximo Monitor
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
Required by
- Maximo Monitor
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
Required by
- Optional: Maximo Application Suite
SAML
Configuring SAML user authentication for use with Maximo Application Suite is a multistep process:
- 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 use the defaults. The information is written to a service provider meta data file that you use to configure your SAML provider.
- 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.
- 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. This is the name that is used to register the Maximo Application Suite service provider. - Name identifier format
This is the format of the username identifier that is used with the SAML server.
Required by
- Optional: Maximo Application Suite
Db2 Warehouse
Db2 is a core component of the Maximo Monitor application where it is used for device data and data analytics storage.
Configuration parameters
The following parameters are configurable:
- Protocol -
jdbc:bd2 - Hostname
- Port number
Important: For Maximo Monitor and IoT tool, you must use the secure port number. - Database name
- Username
- Password
- Hosts/Hostname
- Port
- Protocol:
jdbc:db2 - Database name
- Options: Set to
sslConnection=true
Required by
- Maximo Monitor
- Maximo® Health
- 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 set up a unique database connection for these applications.
Slack
Maximo Application Suite supports sending notifications to Slack on topics such as installation, upgrade, rollback, deploy, and disable actions.
To deploy this feature, register an application in your Slack workspace and provide its API Key along with the name of Slack channel to post to.
Note: This configuration is shared with the rest of Maximo Application Suite. Notifications are provided across all applications and during Maximo Application Suite upgrades.
Configuration parameters
The following parameters are configurable:
- Apikey
- Channel
Required by
- Optional: Maximo Application Suite
PagerDuty
Maximo Application Suite supports PagerDuty as an internal tool for incident response.
Configuration parameters
The following parameters are configurable:
- Apikey
Required by
- Optional: Maximo Application Suite