Configuring and activating Maximo Manage
Activate Maximo® Manage to configure it and make it available in your Maximo Application Suite environment.
Before you begin
- You can check the actual supported matrix of your current Maximo Manage application that is deployed and the matrix of compatibility between the components, through the Red Hat® OpenShift® console:
- In the Red Hat OpenShift console, from the side navigation menu, click Workloads > Pods and from the Projects list, select the namespace of your Maximo Manage instance, such as mas-<yourmasinstancename>-manage, and then click the ibm-mas-manage-operator-<somestring> pod.
- On the Terminal tab, connect to the webhook container.
- Open the supported matrix JSON file that displays the components version that each
Maximo Manage application version supports. Then, look for the version
that you previously installed. To determine the version of the base, click
Details and click Manager in the
Containers section. The version is displayed in the lmage
version field. Return to the Terminal tab and use this command to
open the file:
cat /manage-admission/metadata/supported-versions-matrix.jsonSee the following example of how the file format appears:
"8.7.4": [ { "name": "aviation", "versions": [ "8.1.12" ] }Note: In this example, the Manage application version is 8.1.12. - Open the dependency matrix JSON file that displays the compatibility between each component by
using the following command: cat dependency-matrix.json The file displays the
components with the following attributes:
"aviation": { "description": "Maximo Aviation", "includesForbidden": [ "hse", "serviceprovider" ], "includesCoexist": [ "acm", "transportation" ], "conflict": [ "civil", "health", "oilandgas", "oracleadapter", "nuclear", "sapadapter", "spatial", "utilities"Note: The component includesForbidden cannot be co-deployed with the listed components.
The component includesCoexist can be co-deployed with the listed components.
The component conflict cannot be co-deployed with the listed components.
Procedure
- In Maximo Application Suite, from the side navigation menu, click Applications and then click Manage. On the Manage page, click Activate.
- Click Show advanced settings to configure Maximo Manage.
- Configure the database connection information for
Maximo Manage.
- In the Dependencies and Integrations section, on the Database connection tile, select View.
- On the Database connection page, click Edit.
- In the JDBC connection information section, specify the
following fields: Note:
If you are upgrading from Maximo Asset Management to Maximo Application Suite, refer to the maximo.properties file of your Maximo Asset Management folder to get the values for hostname, port, and database name to use in the jdbc URL as required by Maximo Manage.
- If you want to use an SSL-enabled connection, specify this field by using one of the following
JDBC URL formats. Ensure that the port that is used contains the SSL-enabled port of the database.
- Oracle Database
- TCPS is the protocol to use for Oracle SSL connections. For
Oracle SSL database connections in
Maximo Manage, you must specify SID=<TNS Service ID>. You can
use the following URL as an
example:
jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCPS)(Host=mymaximodb.com)(Port=2484))(CONNECT_DATA=(SID=MAXDB))) - Microsoft SQL Server Database
- For SQL Server SSL database connections in
Maximo Manage, you must specify
encrypt=true. Ensure that you use a semicolon to end the JDBC connection
string. You can use the following URL as an
example:
jdbc:sqlserver://mymaximodb.com:1433;databaseName=MAXDB;encrypt=true; - IBM® Db2® database
- For Db2 SSL database connections in
Maximo Manage, you must specify
sslConnection=true. Ensure that you use a semicolon to end the JDBC
connection string. You can use the following URL as an example:
jdbc:db2://mymaximodb.com:50001/MAXDB:sslConnection=true;
- In the User name field, specify the database username.
- In the Password field, specify the database user password.
- Ensure that you select the SSL Enabled option.
- If you want to use non-SSL enabled connection, specify the Connection
string field by using one of the following JDBC URL formats, depending on the database
you are using.
- Oracle Database
- You can use the following URL as an example:
jdbc:oracle:thin:@mymaximodb.com:1521:MAXDB - Microsoft SQL Server database
- You can use the following URL as an example:
jdbc:sqlserver://mymaximodb.com:1433;databaseName=MAXDB;integratedSecurity=false;encrypt=false; - IBM Db2 database
- You can use the following URL as an example:
jdbc:db2://mymaximodb.com:50001/MAXDB
- In the Username field, specify the database username.
- In the Password field, specify the database user password.
- Ensure that you do not select the SSL Enabled option.
- If you want to use an SSL-enabled connection, specify this field by using one of the following
JDBC URL formats. Ensure that the port that is used contains the SSL-enabled port of the database.
- Optional: In the Additional driver options
section, in the Driver options field, add more driver options, which are
separated by a semicolon.
- Typically, you can specify JDBC options as part of the URL for the database. However, in some cases you might want to specify JDBC options in the Driver options field.
For example, your URL might exceed the maximum length that is allowed. You might also 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 Driver options field. If you do, JDBC driver errors can cause the connection to fail.- If you specify an extra JDBC option for your database, the CustomProxyDriver acts as a proxy driver that routes the database requests to the actual driver for your type of database.
- If you chose to use an SSL-enabled database connection, in the
Security section, 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.
- In the Certificate content field, copy and paste your certificate in the format that is mentioned in the field content. 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. After you copy and paste the text into the field, including the BEGIN CERTIFICATE, and END CERTIFICATE text, click Confirm.
- 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.
- 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.
- If you plan to deploy Maximo Optimizer, see Deploying Maximo Optimizer.
- In the Components section, select the industry
solutions or add-ons and the version that you are also activating with
Maximo Manage.
- If you select latest from the New version list for
the selected industry solution or add-on, the version of the component that is supported by the
current
Maximo Manage application version is co-deployed with
Maximo Manage base component.Note: If you set your configuration settings to the latest version for the components before you upgrade the application, the components will be automatically updated after the upgrade. If you select a specific version instead, then the components are not updated until you manually change their versions to the current, supported version of the new application version. You can do this for both by selecting the exact version or by selecting latest.
- If you select one component to deploy by selecting the latest option, you must select latest for any other component you co-deploy. If you select one component to deploy with an exact version number, you must select the exact version number for any other extra component that you co-deploy. You cannot mix exact version numbers and the latest version in the components you want to co-deploy.
- You also can click in the New version column for a component and select Select version. In the Select unlisted version modal, you can specify a valid version that is supported by the current application version that is deployed in the Version field. Click Save.
For more information, see Deployment of industry solutions and add-ons. The documentation includes information on access to the compatibility matrix that shows the compatibility between application version and components versions. Some components might not be compatible with each other. - If you select latest from the New version list for
the selected industry solution or add-on, the version of the component that is supported by the
current
Maximo Manage application version is co-deployed with
Maximo Manage base component.
- Click Show advanced settings to view and specify the
configuration settings, such as database, server bundle, language settings, and others.
- In the Database section, set System
managed to off and manually configure the database.
- Schema
- Enter the name of the schema that is configured in your database. For more information on database configuration for Maximo Manage, see Setting up your database.
- Encryption secret (optional)
- This value is optional if you are deploying
Maximo Manage in your database for the first time, and your database is
not encrypted. Enter your encryption keys for this parameter. For more encryption settings
information, see Database encryption.
A table with Key and Value column titles is displayed. Click Add property +. In the Key column, enter MXE_SECURITY_CRYPTOX_KEY. In the Value column, enter your encryption key value.
In the Key/Value table, click Add property + again. In the Key column, enter MXE_SECURITY_CRYPTO_KEY. In the Value column, enter your encryption key value.
- Table space
- If the default value does not match your database configuration, enter the name of the table space that was configured in your database. For more information about database configuration for Maximo Manage, see Setting up your database.
- Index space
- If the default value does not match your database configuration, enter the name of the index space that was configured in your database. For more information about database configuration for Maximo Manage, see Setting up your database.
- Install demo data
- If you are deploying a test or demonstration environment for
Maximo Manage, you can install sample data.
The sample data in the demo database is useful for development or test environments.
To set up a test or development environment with demo data, install an instance of Maximo Application Suite specifically for testing or development. Then, when you configure the database settings for your Maximo Manage deployment, select the option to install demo data.
Note: You cannot add sample data after Maximo Manage is deployed because the database is updated without sample data. To add the sample data after deploying Maximo Manage, you must re-create or clean your database, and reconfigure Maximo Manage. - Db2 text search
- This property is only applicable if the IBM Maximo Asset Management database is
Db2 and it is not containerized Db2. For any other cases, this property is ignored. If containerized
Db2 is used, text search cannot be enabled. The property only
takes effect when the
Maximo Manage database is
being installed. In this case, the
-qparameter passes to maxinst to enable text search for all columns that are flagged as searchable. After the Maximo Manage database is installed, any change to this property has no effect and does not alter the database. The default value isFalse. - Db2 Vargraphic
- If you use Db2 and you plan to install a language other than English for your base language or as an extra language, select this option. If you intend to add more languages later, select this option during your initial deployment. This option does not affect the Maximo Manage deployment if it is selected and you are using a database other than Db2.
- In the Database section, set System
managed to off and manually configure the database.
- If you want to set
Maximo Manage with a language other than English, or to include other languages in your
Maximo Manage deployment, set the System
managed checkbox in the Languages section to off.
Then, in the Base field, select your preferred language to be the base language. In the Additional field, order the list of other languages. For more information, see Language support.Note: If you are selecting other languages, make sure that you do not select a language in the Additional field that was selected in the Base field. For example, if you set the base as EN, do not select EN in the Additional field.
- Configure server bundles for your deployment.
- To deploy Maximo Manage with more than one server bundle, or
with customized configurations for it, in the Server Bundles section, set
System managed to off. A table with Name, Pod count, Type, and Additional Properties column titles is displayed. This table has Default, User synchronization, and Mobile optional fields available.When you set System managed to off, the default settings for the Name and Type fields are all. The default Pod count is 1.
- Click Add bundle to add more server bundles.
- Select the server bundle that you want to set for the Default, User synchronization, and Mobile fields.
- Optional: Change the name, pod count, type, route subdomain name and other customized configurations according to your preference.
- In the Additional Properties column, click
View to view the Route subdomain value. The Additional server bundle properties page for your selected server bundle is displayed with the Route subdomain and Additional server configfields available. You can specify properties by clicking Add property + in the Bundle level properties table. For more information, see Server bundle overview.
- To deploy Maximo Manage with more than one server bundle, or
with customized configurations for it, in the Server Bundles section, set
System managed to off.
- If you want to include specific customizations through a customization archive, in the
Customizations section set System managed to off.
Click Add customization archive +. In the File address
field, specify the location of the customization archive. If you must enter credentials to access
the file, specify them in the Credentials (optional) field. To include more
customization archive files, click Add customization archive +. For more
information, see the related sections in Customizing the application.
- In the Customization section of the configuration window,
specify the URL for the customization archive file. The following URL protocols are supported:
- HTTP
- HTTPS
- FTP
- FTPS
- Optional: If you applied password security to the file, in the
Credentials field, specify the user ID and password in the following format:
user=your user name password=your password
- In the Customization section of the configuration window,
specify the URL for the customization archive file.
- If you do not want the server bundles to start after the database operations of the Maximo Manage deployment are completed, set System managed to off in the Server mode section. Next, set Mode to Off to prevent access to the Maximo Manage application after deployment. You can restart the server bundle or bundles when you change the configuration to On and activate Maximo Manage again.
- To connect to Persistent Volume Claims (PVC), in the Persistent volume
claims section, set System managed to off, and click
Add PVC +. A table with the following columns is displayed.
Option Description PVC name The user-defined name of the persistent volume claim with a maximum of 63 characters. Volume name Leave blank as it is provisioned dynamically. Size The amount of storage that is required for this persistent claim, for example, 60G. Mount path The mount path for the volume within the Maximo Manage pod. When you configure the PVCs in OpenShift Container Platform cluster on deployments, use the default storage class nameStorageClasses ocs-storagecluster-cephfsto create a ReadWriteMany (rwx) PVC. The storage in the volume that you provisioned are available to all server bundles in the workspace. You can also configure a PVC for specific server bundles in a deployment. If you configure a PVC for a server bundle, the mount path that you specify for the server bundle PVC overrides the path that you specify for the deployment.Tip: To configure a PVC in OpenShift Container Platform cluster on IBM Cloud® platform, use the defaultStorageClasses ibmc-file-gold-gid(instead ofStorageClasses ocs-storagecluster-cephfs) to create a ReadWriteMany PVC. - If you select Asset Configuration Manager or Aviation in the list of components, the Build data interpreter section is displayed. If you want to customize the configuration for the build data interpreter (BDI), set System managed to off. You can then specify a BDI version instead of latest, the default setting. Click Add instance +. You can customize each instance by selecting View in the Configuration column. The BDI Configuration page is displayed. You can change and save the configuration. Then, you can return to the BDI configuration page, select Reset to Defaults, and click Save to return to the default settings, if needed.
- If you want to use an earlier build for deployment, in the Build
tag section, set System managed to off. Then, in the
Build tag field, specify the build tag. Build images are tagged with a
timestamp, for example
buildtag: 202011092887843.Note: You can see all available build tag or imagestreamtags by going to the Red Hat OpenShift web console. Locate your the build and navigate to image streams. Click on the maxadmin image stream to see all available imagestreamtags. You can use the Red Hat OpenShift command line interface to find the same information. - To connect to any external systems that Maximo Manage with is integrated with, set Imported certificates to off. Then, click Add + and import the certificate for the system and click Confirm.
- Optional: You can specify the time zone that your database server is configured to use. In the Server time zone section, set the System Managed to off. In the Time Zone field, select the time zone of your database server.
- If you are deploying Maximo Health as part of Maximo Manage , you can enable asset investment optimization. In the Asset investment optimization section, set the System managed to off. Then, select Asset investment optimization. When asset investment optimization is enabled, the Asset investment optimizer page is available in Maximo Health. Ensure that you deploy and configure Maximo Scheduler Optimization before you enable asset investment optimization.
- If you want to configure Maximo Manage to send server bundle logs to Simple Storage Service (S3) object storage, set Simple storage service to on.
- If you want to specify information for IBM Watson® Studio, set IBM Watson Studio to on.
- If you want to specify information for IBM App Connect, set IBM App Connect to on.
- Click Start activation to start the activation
process. Note: You can reconfigure the activation process as needed. Follow these steps.If you click Exit, you are redirected again to the Application Details page. You can continue to monitor the status. View the Workspace Activation detailed process, or under Activate in workspace, you can click Go to workspace details page link.
- Select Actions > Workspace Details > Update configuration.
- Select the specific configuration that you want to change in the Update Manage Configurationpage. The configuration option is displayed. You can reconfigure a specific option and other options as you need.
- Click Activate again.