Set up Maximo Application Suite

The 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 link to the setup program and the login credentials that you need to use to complete the setup process are provided with the installation summary.

Important: Each step must be completed before you can proceed to the next step. As you complete each step, the information provided is verified. After a step is verified and completed, you cannot go back and change the information. Do not proceed to the next step until you are certain that everything is correct.

Tip: You can save and exit to temporarily leave the setup program and then use the setup URL to return to the same step later.

Setup process

  1. Log in to the Maximo Application Suite setup by using the super user credentials that were created by the installer.
    Setup URL: https://admin.masdomain.com/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.
  2. 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.
    • MongoDB login credentials.
      At a minimum, the MongoDB administrator needs table creation privileges.
      Note: The MongoDB verification might take up to a minute. The configuration cannot be modified after the setup is complete.
  3. Configure analytics.
    Maximo Application Suite uses Behavior Analytics Services to collect and process license and usage information.
    Enter the following Behavior Analytics Services instance information to configure Maximo Application Suite analytics:

    • Hostname
      The hostname of the server where you installed the Behavior Analytics Services Operator.
    • Port
      The assigned Behavior Analytics Services port.
    • API key
      The API key that is assigned to 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 used for Behavior Analytics Services communication.
    • Surname
      The surname of the owner of the provided contact email address used for Behavior Analytics Services communication.

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

  4. 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://workspaceid.home.masdomain.com
      Important: The Workspace ID must be 3 - 12 characters in length, and may 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.
  5. Optional: Configure LDAP.
    You can optionally use an LDAP server for user authentication.
    For more information about configuring Maximo Application Suite for LDAP, see Configure LDAP.
    The following LDAP information is required:
    • Server URL
    • Bind DN
    • Bind password
    • Base DN
    • User ID map
  6. Optional: Configure SAML.
    You can optionally use a SAML server for user authentication. For more information about configuring Maximo Application Suite for SAML, see Configure SAML.
    The following SAML information is required:

    • Service provider name
    • Name identifier format
  7. Upload the license file.
    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 on IBM.com.
    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 following Maximo Application Suite license server parameters, which are provided in the license step of the Setup process:
      Parameter Value
      Configuration Single
      Host ID MAC address
      Hostname Hostname
      Port Port: Default 27000
      Host ID Type Ethernet address
    8. Download the key and then upload it to the Maximo Application Suite setup.
  8. Create the administrator account.
    The initial administrator account is initially used to complete the Maximo Application Suite configuration, enable applications, and add users. You can create the administrative user in MongoDB or use an existing LDAP user.
    Provide the following information:
    • Given name and surname.
    • Email address
    • Username
      Tip: If you are using LDAP, the username must match an existing LDAP user ID.
    • Password
      Tip: If you are using LDAP, you are selecting an existing user account and no password needs to be created.
  9. Review the setup information.
    Your Maximo Application Suite setup information is displayed. If needed, make a copy of the information and then click Finish to log in to the Maximo Application Suite administrative user interface to complete the product configuration.
    Sample URL:
    https://admin.masdomain.com

Next steps

After Maximo Application Suite is set up, you can start to use your environment.