Setting up Maximo Application Suite

The Suite setup program guides you through the initial configuration of IBM® Maximo® Application Suite.

Note: The following process discusses customer-managed Maximo Application Suite. For IBM managed Maximo Application Suite, no action is required, and you can go directly to Getting started.

Before you begin

• Complete the installation.
  The setup sign-in URL link to the Suite setup program and the login credentials that you need to use to complete the setup process are provided in the installation summary.

• Enable login for Maximo Application Suite self-signed certificates.
  If you are using self-signed certificates in a development or test environment, you must manually enable login by using either of the following methods:

  • Download the certificates from the cluster and add them to your local certificate manager.
  • In your browser, go to the Maximo Application Suite API URL: https://api.<mas_domain>/ and then accept the certificate security risks. After you accept the risks, an AIUC01999E error is displayed. This message is expected. You can now continue with the setup process.

Custom certificates

In the setup 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.

Setup process

Log in to the Suite setup program by using the super user credentials that were created by the installer.
Setup URL: https://admin.<mas_domain>/initialsetup
Important: Treat the super user account the same way you treat the root account on your servers and use it only for the initial setup. As part of the setup, you create a default administrator user account that has access to the Maximo Application Suite administrative interface. Use this administrative account to add and manage users, deploy applications, and more.

Complete the following steps to configure the Maximo Application Suite dependencies.

Important: The Suite setup configurations are set at the System scope. For more information about configuration scopes, see Configure Maximo Application Suite.

Tip: You can click Exit to temporarily leave the Suite setup program and then use the setup URL to return to the same step later.

Configure MongoDB

MongoDB is used as the data dictionary for Maximo Application Suite and its component applications. It is also used as the default user registry.
The following MongoDB information is required:

• Hostname and port
  Tip: You can configure one or more MongoDB hostname and port combinations.
• Authentication mechanism
  Specify the mechanism that is used to authenticate Maximo Application Suite when it connects to MongoDB. Select the closest match to the mechanism that is configured for your MongoDB cluster. For example, if your cluster uses the SCRAM-SHA-256 mechanism, select DEFAULT (SCRAM).
• Auth db
  Enter the MongoDB config database.
• MongoDB login credentials
  At a minimum, the MongoDB administrator needs table creation privileges.
• Upload a CA certificate.
  Important: If your MongoDB cluster uses self-signed CA certificates you must retrieve or add a certificate.

Note: The MongoDB verification might take up to a minute.
Important: The configuration cannot be modified after the MongoDB verification is complete. MongoDB is a prerequirement for Maximo Application Suite. Changing the configuration requires careful coordination and possible data migration to avoid service outages. System administrators can change the configuration in the OpenShift console. For assistance with changing the MongoDB configuration, contact your IBM representative.

Configure Behavior Analytics Services

Maximo Application Suite uses Behavior Analytics Services (BAS) to collect and process license and usage information.
Enter the following Behavior Analytics Services instance information to configure Maximo Application Suite analytics:

• 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
  A contact email address to use for Behavior Analytics Services communication. The email address does not have to match an existing Maximo Application Suite user.
• Given name
  The given name of the owner of the provided contact email address that is used for Behavior Analytics Services communication.
• Surname
  The surname of the owner of the provided contact email address that is used for Behavior Analytics Services communication.

Retrieve or add a CA certificate.

For more information about how to install and configure the Behavior Analytics Services component, see Configure dependencies.

Configure the Suite License Service

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

Each Maximo Application Suite instance can be connected to a unique SLS instance. Two or more Maximo Application Suite instances can also share an SLS and the corresponding license file.

Enter the following SLS information to configure Maximo Application Suite:

• URL
  The URL for the SLS server.
• Registration key Enter the SLS registration key.

Retrieve or add a CA certificate.

Important: Depending on your environment, the SLS configuration might take 10 minutes or more to complete.

Upload your license key file

Note: If the IBM® Suite License Service that you configured for use with Maximo Application Suite includes a valid license file, you do not need to upload a license file. You can continue with the next configuration step.

To activate Maximo Application Suite, you must provide your license key from the License Key Center. The login information is provided in the License Key Center welcome letter. For more help on licensing, see the IBM Support - Licensing page.
To create the license file:

1. Log in to the License Key Center.
2. Select your company name.
3. Select the IBM AppPoints product line.
4. Select the IBM MAXIMO APPLICATION SUITE... license key name.
5. Select the product or sales order for which to create the license key.
6. Enter the number of keys to generate. These correspond to the AppPoints that are allocated to the license key.

7. Provide the Maximo Application Suite license server parameters.
   Use the parameters that are displayed in the Advanced settings->License key section of the Suite setup program, or provide the following parameters:

   Parameter	Value
   Configuration	Single License Server
   Host ID Type	Ethernet address
   Host ID	The host ID that was generated when you installed the Suite License Service (SLS). To display this ID, connect to your OpenShift cluster and run the following command: oc -n <sls_project_namespace> get licenseservice sls For example, if the namespace of the SLS project is mas-sls-dev5, run the following command: oc -n mas-sls-dev5 get licenseservice sls In the command output, the host ID is displayed in the LICENSEID column.
   Hostname	A host name of your choice, for example: sls-mas
   Port	27000

8. Download the key and then upload it to the Suite setup program.

Create the workspace

The Maximo Application Suite workspace is a unique collection of configuration settings for your instance of Maximo Application Suite. Enter the following information to create your Maximo Application Suite workspace:

• Workspace ID
  The workspace ID forms part of the Maximo Application Suite URL, for example:
  https://<workspace_id>.home.<mas_domain>
  Important: The workspace ID must be 3 - 12 characters in length, and can contain only lowercase letters and numbers. The first character must be a letter.
• Workspace display name
  The display name is shown in your Maximo Application Suite user interface.

Review the setup configuration

Your Maximo Application Suite setup is now complete. Verify that all configuration settings are done and then click Finish to complete the setup.

Next steps

After the Maximo Application Suite setup is complete, you can start to use your environment by going to the Suite administration or Suite navigator page: https://admin.<mas_domain>
https://<workspace_id>.home.<mas_domain>

As the Maximo Application Suite super user, you can now continue configuring your environment to suite your enterprise needs:

• Configure authentication
  Maximo Application Suite supports local user authentication by MongoDB and authentication by using LDAP or SAML.
  
• Configure LDAP 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.
  
• Create administrator user accounts
  The initial super user account is used to complete the Maximo Application Suite setup. You can add application administrator users or system administrator users for day-to-day administrative tasks.
  
• Getting started
  With the setup completed, your users can log in and start to use Maximo Application Suite.