Starting the OneDB Explore Server

This topic provides a brief tutorial to help you get started with OneDB Explore Server.

  1. Locate the onedbe-explore-server.jar and the server.log4j.xml file in the OneDBExplore package.
  2. Create an HCL OneDB Explore Server Configuration file. You can refer to the onedb-explore-server-example.properties file as an example.

    The OneDB Explore server configuration file must contain an initialAdminPassword . All other configuration properties are optional.

    Sample configuration file

    # required initial password for the admin user
initialAdminPassword=myPassword123
# optionally, uncomment these properties to have OneDB Explore encrypt its internal H2
database
#h2.encrypt.enable=true
#h2.encrypt.password=password
    Note: The initialAdminPassword property is only required the very first time you start the OneDB Explore server, when it performs its start-up initialization and creates the first user named admin. Afterwards, you can remove the initialAdminPassword property from the onedb-explore-server.properties file.
    Note: Password must be at least 8 characters and must contain at least one lowercase character, one uppercase character, and one number.
  3. Optionally, edit the server.log4j.xml file to Logging in HCL OneDB Explore.
    Note: By default OneDB Explore runs on 8080 port. For more information, see HCL OneDB Explore Server Configuration.
  4. Start the OneDB Explore server using the following command:
    java -Dfile.encoding=utf-8 -jar onedb-explore-server.jar -config
onedb-explore-server.properties -log4jFilePath onedb-explore-server.xml
    where onedb-explore-server.properties is the name of the OneDB Explore server configuration file and onedb-explore-server.xml is the name of configuration file for logging.
    Note: Providing log4jFilePath is optional.
    Note: You can also start or stop the server using the script available in OneDBExplore package. For more information on this, see OneDB Explore help.

    When the OneDB Explore server is started for the first time, a user with system administrator privileges for OneDB Explore is created with the username admin and the password as specified in the initialAdminPassword property from your configuration file.

  5. Using a web browser, go to the OneDB Explore UI at http://localhost:8080/ and login with the user admin and the password specified in your configuration file.
  6. Once logged in, click Add Server to add an OneDB server that you want to monitor.