Installing MobileFirst Server administration with the Server Configuration Tool

You can use the Server Configuration Tool to install and configure MobileFirst Server administration.

Before you begin

Verify that the user who runs the Server Configuration Tool has the privileges that are described in File system prerequisites.

About this task

Restriction:
  • The Server Configuration Tool does not support server farms. Therefore, you cannot use this tool to install, upgrade, or configure a server farm.
  • MobileFirst Server is not supported for production use on Mac OS X.

Procedure

  1. Start the Server Configuration Tool.
    • On Linux: In the desktop menu, click IBM MobileFirst Platform Server > Server Configuration Tool.
    • On Windows: In the Start menu, click IBM MobileFirst Platform Server > Server Configuration Tool.
    • On Mac OS X: In the Finder, double-click the file mf_server_install_dir/shortcuts/configuration-tool.sh.
      Note: The mf_server_install_dir placeholder represents the directory where you install MobileFirst Server. mf_server is the shortcut for MobileFirst Server.
  2. Select Create a MobileFirst Server Configuration.
  3. Name your configuration.
  4. In the Configuration Description window:
    1. Enter the context root of the MobileFirst Administration REST service.

      The context root is used to create the URL to the MobileFirst REST Administration service. This URL is typically in the form <URL_TO_APPLICATION_SERVER_HTTPS_PORT>/contextroot or <URL_TO_APPLICATION_SERVER_HTTP_PORT>/contextroot.

    2. Enter an environmentId.

      This ID is optional and is used to distinguish between different deployments of the MobileFirst Server administration components in the same application server environment, for example in the same cell of WebSphere® Application Server Network Deployment.

      Important: Review carefully this environment ID. It must match the environment ID of all the runtime environments that are managed by this MobileFirst Server administration component. If you install or upgrade the MobileFirst runtime environments with separate Ant files, this verification is particularly important because the environmentId attribute must match. For a server farm, all installations must also have the same environmentId attribute.
      The environmentId attribute is an attribute of the following Ant tasks:
  5. In the Console Settings window, enter the context root of the MobileFirst Operations Console.
  6. In the Database Properties window:
    1. Select your database type: IBM® DB2®, MySQL, Oracle, or Cloudant®.
    2. In the next window, enter the details to connect to the database instance, or to a valid Cloudant account.
    3. In the Database itional properties window, enter the parameters to connect to the administration database.
    4. If the database administrator did not create the databases in step Optional creation of the administration database, enter the database administration credentials in the database creation request window.
      Note: For IBM DB2 and for Oracle, you must have an SSH access to the host where the database management system (DBMS) is installed.

      If you selected a relational database, the Server Configuration Tool creates the database for you. If you select Cloudant as the database management system for your MobileFirst runtime environment, the Server Configuration Tool does not create a database.

  7. In the Application Server Choice window:
    1. Select your application server type: WebSphere Application Server, WebSphere Application Server Liberty profile, or Apache Tomcat.
    2. In the Application Server window, enter the data so that you can deploy IBM MobileFirst Platform Foundation to that application server.
    3. Depending on your application server, proceed as follows:
      • If the application server is WebSphere Application Server Liberty profile, or Apache Tomcat, select Create a default user if you want to declare a user who can log in to the console as administrator to the MobileFirst Operations Console
      • If the application server is WebSphere Application Server, select Declare the WebSphere Administrator as an administrator of IBM MobileFirst Platform Operations Console if you want to allow the WebSphere administrator to log in to the MobileFirst Operations Console.

      For more information about further configuration of security roles, see Configuring user authentication for MobileFirst Server administration.

  8. When all the data is entered, click Deploy. The following effects take place:
    • For relational databases:
      • If the database administrator did not complete step Optional creation of the administration database, the database for the MobileFirst Server administration is created and access rights are granted to the user that is specified in the database additional properties window.
      • If the tables for MobileFirst administration do not exist in the database, they are created.
      • The MobileFirst administration components are installed in the application server and are connected to the database.
    • For Cloudant:
      • The application server is configured with the required information to connect to your Cloudant account. The database for the MobileFirst Server administration is created when the application server starts.
  9. Restart the application server
  10. If you are in an environment where you must protect the password of the user who can log in to the console as administrator to the MobileFirst Operations Console, follow the steps in Securing the MobileFirst Server administration.
  11. Open the console.

    If the context root of the console was not changed in the Console Settings window, you find it at <URL_TO_APPLICATION_SERVER_HTTPS_PORT>/worklightconsole, or if HTTPS is not supported in your application server, at the unsecured URL <URL_TO_APPLICATION_SERVER_HTTP_PORT>/worklightconsole.

What to do next

Install a MobileFirst runtime environment. For more information, see Deploying, updating, undeploying, or upgrading MobileFirst Server by using the Server Configuration Tool.