Download and Use the MaxL Client

To run the MaxL Client for use with Essbase, download the latest version from the Console, set the proxy if needed, run the startup script, and log in.

The Essbase MaxL Client enables you to use MaxL over HTTP or HTTPS. MaxL is an administrative, language-based interface for managing cubes and artifacts. Be sure you are using the latest client version provided in the Console, as older, previously downloaded versions may not work correctly.

To run MaxL statements, you must be a power user or an administrator. Before you download the MaxL Client, see Prerequisites to Set Up the MaxL Client.

If you’re a federated SSO user in Oracle Identity Cloud Service, logging in using MaxL or CLI is not supported. Federated SSO login requires a browser window. Create a native Identity Cloud Service user, and use that instead to log in using MaxL or CLI.

  1. In the Essbase web interface, click Console.

  2. In the Console, go to MaxL Clients.

  3. Click Download Image of the Download icon. next to the MaxL Client that is appropriate for your platform.

  4. Save the compressed EssbaseMaxl file to your local drive.

  5. Extract the contents of the compressed file to a folder.

  6. If you’re using a proxy, you must set the correct proxy in the MaxL execution script, startMAXL.bat or startMAXL.sh. The following example, applicable for editing startMAXL.sh for UNIX, tells MaxL to use the designated proxy (proxy.example.com), but to bypass using a proxy for the specific destinations listed in the exception list (127.0.0.1, localhost, and something.example.com).

    export https_proxy=http://proxy.example.com
    export no_proxy=127.0.0.1,localhost,something.example.com

    For Windows, startMAXL.bat can be edited similarly but with different syntax.

    set proxy proxy-server="https://proxy.example.com" bypass-list="127.0.0.1;localhost;*.example.com"
  7. If you're using Essbase deployed on Oracle Cloud Infrastructure and are using a self signed certificate, you must disable peer verification in the MaxL execution script. Caution: this solution should be only temporary, until you can obtain a trusted CA certificate. Here is an example using bash (for startMAXL.sh):

    export API_DISABLE_PEER_VERIFICATION=1
  8. Run the startMAXL batch or shell script. A command prompt opens, the environment setup completes, and the MaxL Client starts up.

  9. Log in by providing your credentials and the Essbase URL in the MaxL login statement.

    In the following example, the user logging in, User5, is from a federated MSAD directory and logging in to Essbase On-Premise.

    login user User5 P855w0r$4 on "https://192.0.2.1:9001/essbase/agent";

    Tip:

    See MaxL Troubleshooting for On-Premise installations.

    In the following example, the user logging in, admin1@example.com is an Identity Cloud Service administrator who was set as the initial Essbase administrator during Essbase stack deployment on Oracle Cloud Infrastructure. As the password is not entered in this example, the administrator will be prompted to provide it next. The URL is the essbase_url from the job outputs resulting from the stack deployment.

    login admin1@example.com on "https://192.0.2.1/essbase";

    Any Identity Cloud Service user provisioned to work with Essbase can log in to MaxL, as long as they are provisioned as a power user or administrator.

  10. Execute an interactive MaxL statement.

    For example:

    display database all;

To learn more about MaxL, see MaxL Statement Reference.