> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ocient.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Ocient Management UI Configuration

> Connect to and configure the Ocient Management UI, including login, access control, ocui package management, connection endpoints, and SSL certificates.

export const Firefox = "Firefox®";

export const Microsoft = "Microsoft®";

export const Safari = "Safari®";

export const Google = "Google®";

export const Ocient = "Ocient®";

The {Ocient} Management UI is a web-based interface designed to support the primary tasks of database users without requiring command-line tools. Here, learn about how to connect to the UI, configure access control, and set up connection endpoints.

For an overview of UI features and pages, see [Ocient Management UI Features](/ocient-management-ui).

## Connect to the UI

Learn how to connect to the Ocient Management UI remotely. This process assumes you have access to an Ocient System with the UI installed.

### Prerequisites

Any computer that you use to access the UI remotely must have:

* Network access to an Ocient System with the UI installed
* {Google} Chrome, {Safari}, {Microsoft} Edge, or {Firefox} (latest version)

### Log Into the Ocient Management UI

Follow these steps to connect to your Ocient System from any machine with network access.

#### Navigate to the UI Using a Web Browser

To access the Ocient Management UI, use a web browser to navigate to the SQL Node using its IP address or hostname as a URL domain. This URL must use the `https` protocol.

Your SQL Node connection information is available from your Ocient System or database administrators. For details, see [Configure Connection Endpoints](#configure-connection-endpoints).

To connect, specify the SQL Node IP address or hostname.

```
https://<ip_or_hostname>
```

After loading, your web browser displays the Ocient Management UI login page.

<Frame>
  <img src="https://mintcdn.com/ocient/w626gMba_eZkoilg/images/UI_Login_Page.png?fit=max&auto=format&n=w626gMba_eZkoilg&q=85&s=13ca2fe9b33645cfcd5479226110728f" alt="Ocient Management UI login page showing database connection and credential fields, with a single sign-on option." width="1956" height="1030" data-path="images/UI_Login_Page.png" />
</Frame>

#### Select the Database

The Ocient Management UI can connect to individual databases or the default `system` database.

**Connect to the Default Database**

By default, the login page connects to `system`, which gives you visibility into all databases where you have access. To create or modify tables or to execute data pipelines, connect to an individual database instead. For details, see [Manage Users, Groups, and Roles](/manage-users-groups-and-roles).

**Connect to Your Database**

To connect to your database, enter the name of the database in the **Connect to** field on the login page.

<Frame>
  <img src="https://mintcdn.com/ocient/w626gMba_eZkoilg/images/UI_Login_Credentials.png?fit=max&auto=format&n=w626gMba_eZkoilg&q=85&s=19d8ca45dadb0bf56bae14e0898cc8c8" alt="Ocient Management UI login page showing the database selection field and a single sign-on option." width="405" height="512" data-path="images/UI_Login_Credentials.png" />
</Frame>

You can also change your active database connection after logging in using the database switcher in the sidebar navigation.

### Login Credentials

You can log in to the Ocient Management UI using either of these methods:

* User credentials (username, password).
* Single Sign-On (SSO) authentication — The UI supports multiple SSO integrations configured per database or Connectivity Pool.

For details about configuring SSO integrations, see [Authentication Methods](/authentication-methods).

## Administration

Learn how to configure and administer the Ocient Management UI.

### Access Control

For full UI visibility and functionality, you must have read, create, and modify privileges on each database that you want to connect to.

These user roles have full visibility and functionality in the Ocient Management UI:

* `System Administrator`
* `Database Administrator`

Other roles can use the UI but have limited capabilities based on their privileges.

To assign user roles and privileges, see [Data Control Language (DCL) Statement Reference](/data-control-language-dcl-statement-reference).

### Install and Manage the ocui Package

The Ocient System includes a base version of the Management UI bundled with the core `ocient` package. The `ocui` package is a separate DEB or RPM package that allows you to update the Management UI without upgrading the entire Ocient System. Install the `ocui` package on any SQL Node where you want to host the updated UI.

When the `ocui` package version matches the installed `ocient` package version, the system hosts the UI from the `ocui` package. When the versions differ, the system falls back to the base UI included with the `ocient` package.

<Info>
  For access to the `ocui` package, contact Ocient Support.
</Info>

#### Install the ocui Package

Transfer the `ocui` package file to the target SQL Node, then install it using the appropriate package manager command.

Install using DEB.

```shell theme={null}
sudo dpkg -i ocui.deb
```

Install using RPM.

```shell theme={null}
sudo dnf install ./ocui.rpm
```

After installation, verify that the Management UI is accessible by navigating to the SQL Node URL in a web browser. For details, see [Connect to the UI](#connect-to-the-ui).

#### Verify the Installed Version

Use the package manager to check the installed `ocui` version on the SQL Node.

Check the version using DEB.

```shell theme={null}
dpkg-query -W ocui
```

Check the version using RPM.

```shell theme={null}
rpm -qa ocui
```

#### Uninstall the ocui Package

Remove the `ocui` package from the SQL Node using the appropriate package manager command. After removal, the system reverts to the base Management UI included with the `ocient` package.

Remove using DEB.

```shell theme={null}
sudo dpkg -r ocui
```

Remove using RPM.

```shell theme={null}
sudo dnf remove ocui
```

### Configure Connection Endpoints

Access the Ocient Management UI by connecting to a SQL Node using the connection parameters set by its Connectivity Pool.

The Connectivity Pool defines a SQL Node connection configuration with:

* IP address
* Hostname
* Port
* SSO integration

For information on all Connectivity Pools created in your system, query the `sys.connectivity_pools` system catalog table.

For information on SQL Node connection parameters (IP address and network ports), query the `sys.connectivity_pool_participants` system catalog table.

To alter SQL Node connection parameters (IP address, port, and SSO integration), see [Cluster and Node Management](/cluster-and-node-management).

### Configure API Port

For network access, the Ocient Management UI requires a Connectivity Pool with an open port for the HTTP Query API. Follow these steps to ensure your port is accessible.

1. Identify the Connectivity Pool and SQL Node you want to use by querying the `sys.connectivity_pool_participants` system catalog table.

```sql theme={null}
SELECT * FROM sys.connectivity_pool_participants;
```

2. In the system catalog output, check the `openapi_port` value for the Connectivity Pool and SQL Node you want to use. If this `openapi_port` value is `NULL`, the port is not open.

3. If you need to open the port or change its value, execute this statement using your Connectivity Pool and SQL Node names. This example uses port `443`, which is the default port for HTTPS traffic.

```sql theme={null}
ALTER CONNECTIVITY_POOL <connectivity_pool_name>
    ALTER PARTICIPANT <SQL_node_name>
    SET openapi_port 443;
```

### Install SSL Certificates

The Ocient Management UI uses SSL certificates to connect to the system, similar to other methods such as the JDBC driver.

<Note>
  By default, the system uses self-signed certificates. Using these certificates can result in the browser displaying an invalid certificate warning. For details about installing certificates, see [Secure Connections Using TLS](/secure-connections-using-tls).
</Note>

## Related Links

[Ocient Management UI](/ocient-management-ui)

[Load Data](/load-data)

[SQL Reference](/sql-reference)

[Database Administration](/database-administration)
