--- title: Settings description: The Settings area holds your Organization profile, the knowledgebase the AI assistant reads, plan and billing details, usage, the audit log, and the API keys that authenticate integrations. source: https://documentation.controlcomtech.com/platform/settings --- # Settings Settings is where an Organization is configured rather than operated: the business identity shown across the app, the reference documents the AI assistant reads, the plan you are on and what you have used of it, the audit trail of who changed what, and the API keys that let outside systems call the platform on your behalf. > **Workflow Stage: Integrate** ## Overview Open **Settings** at the bottom of the sidebar, under **Team**. The page is a single screen with a row of tabs across the top: **General**, **Organization**, **Knowledgebase**, **Plan & billing**, **Usage**, **API keys** and **Logs**. General is the landing tab, so the bare `/settings` URL opens it. Reaching Settings at all requires the `ReadOrganizationConfiguration` permission, and the individual actions inside it are gated separately. Creating a key needs `CreateApiKey`, editing one needs `UpdateApiKey`, so a role can be allowed to read the key list without being able to mint new credentials. ## General General is a directory rather than a form. Each row names an area of the platform, describes it in a sentence, and has a **Manage** button that jumps to the screen where that area is actually configured. Nothing is edited on this tab itself. ![The General tab in ControlCom Connect Settings, listing configuration areas with Manage buttons](https://documentation.controlcomtech.com/images/settings/01-settings-general.png) *The General tab: one row per configuration area, each linking to the screen that owns it* The rows are **Devices & connectivity** (device administration), **Alarms & events**, **Team & access** (users and roles), **Branding**, **Command Groups**, **Customers**, **Pipelines** and **Virtual Variables**. Use it as a map when you know what you want to change but not where the platform keeps it. ## Organization The Organization tab holds the identity of the account. Each field is a row with its current value on the right and a **Change** button that opens a small dialog for that field alone. ![The Organization tab showing name, identifier, timezone, colors, logo and AI assistant context rows](https://documentation.controlcomtech.com/images/settings/02-settings-organization.png) *The Organization tab, with each field edited through its own dialog* | Field | What it affects | | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Name | The legal business name or any unique identifier. Shown across the app and on generated reports. | | Organization Identifier | Used for console access on API keys and service accounts. A service account signs in with this identifier plus its username and password. | | Timezone | Used to schedule the weekly digest and to describe the week it covers. | | Colors | The sidebar and brand colors used across the app. | | Logo | Displayed in the navigation and on reports. | | AI Assistant Context | Background the AI assistant reads on every conversation: systems, thresholds and procedures specific to your facility. Up to 32,000 characters, with the current count shown on the row. | The Organization Identifier matters beyond cosmetics. Until it is set, any API key with console access enabled cannot be used to sign in, and the API keys tab shows a warning banner linking straight back to this field. ## Knowledgebase The Knowledgebase tab holds processes, manuals and drawings that the AI assistant can search and reason over. Documents are indexed automatically after upload, and the **Version** column reports where that indexing stands: `Indexing…` while it runs, `Index failed` if it did not complete, and `v1`, `v2` and so on once a version is searchable. Click **Document** to upload a file, give it a title and assign it a type. Each row can also be linked to Assets, given an owner, and put on a review cycle, which drives the **Next review** column and the **Needs review** status. The row menu handles the rest of the lifecycle: **Edit**, **Upload new version**, **Retry indexing** after a failure, **Mark reviewed**, **Download**, and **Archive** or **Restore**. The **Status** filter switches the list between Active, Needs review, Archived and All. ## API Keys An API key is how a system that is not a person authenticates to ControlCom Connect: a SCADA front end pushing readings, a reporting job pulling history, an MCP client configuring the platform. The tab lists every key in the Organization. ![The API keys tab listing keys with their id, description, status, role, console access and creation date](https://documentation.controlcomtech.com/images/settings/03-api-keys-list.png) *The API keys list: each key shows the role it inherits and whether console access is enabled* Each row shows the key **ID** (the public half of the credential pair), its **Description**, a **Status** dot for active or inactive, the **Role** it inherits its permissions from, a **Console** icon that is lit when the key can also sign in to the app, and the date it was **Created**. The toolbar searches across ids and descriptions, filters by status and by role, and exports the list to a file. Secrets never appear here. The platform stores only a hash of the secret, so the list endpoint has nothing to show even to an administrator. ## Creating an API Key Click **New API Key** to open the creation screen. ![The Create API Key screen with a description filled in and a role selected](https://documentation.controlcomtech.com/images/settings/04-create-api-key.png) *Creating a key: the description is for humans, the role decides what the key may do* **Description** is optional and only helps you recognise the key later, so name the system that will hold it. **Role** is the important field: a key has no permissions of its own and inherits them from the role you assign, exactly as a user does. A key created with **No role** can authenticate but will be refused on every permission-gated operation, so pick the narrowest role that covers what the integration needs. **Allow console access** turns the key into a service account that can also sign in to the app. Leave it unchecked for a plain API key. When it is checked, the form offers **Auto-generate** or **Custom credentials**: auto-generate produces the username and password for you, while custom credentials let you choose them, with a live check that the username is not already taken. A service account signs in from the login screen through **Log in with a service account**, which asks for the Organization Identifier, the username and the password. Click **Create API Key**. The **API Key Created** dialog then shows the credentials once, with the warning "Copy your API key credentials now. The secret will not be shown again": * **ID**, the public half of the pair. * **Secret**, the private half. It is displayed on this screen and nowhere else, ever again. * **Authorization header**, the two credentials already Base64-encoded and formatted as an HTTP Basic header, ready to paste into a client. * **MCP client config**, a JSON block pointing at your Organization's Builder MCP endpoint with the same credentials embedded, for `~/.claude.json`, `claude_desktop_config.json` or another MCP client. Copy the secret before dismissing the dialog with **I've Copied the Key**. If it is lost, the only remedy is to create a replacement key. See [Authentication](https://documentation.controlcomtech.com/api-reference/authentication) for how the two values are combined into a request, and [Connect Your Client](https://documentation.controlcomtech.com/build/mcp/connect) for the MCP path. ## Managing Existing Keys The row menu on a key opens **Edit API Key**, which shows the key ID read-only and lets you change the description, reassign the role and toggle console access. Changing the role takes effect on the next request, which makes it the fastest way to narrow what a key can reach. ![The Edit API Key dialog showing the read-only key id, description, role and console access fields](https://documentation.controlcomtech.com/images/settings/05-edit-api-key.png) *Editing a key: the id is fixed, the role and console access are not* Editing never regenerates or reveals the secret, and the tab has no action that deletes a key. Plan for that: give each integration its own key with the narrowest workable role, so a credential that has to be retired can be reduced to a role with no permissions rather than left with broad access. ## Plan, Billing and Usage **Plan & billing** shows the plan the Organization is on, the billing email, the current billing cycle with the next charge date, and the amount due. **View Invoices** and **View Usage** jump to the matching screens, **Change Plan** opens the plan picker, and **Cancel Plan** ends the subscription at the end of the current period. Below the plan card, **Payment Methods** lists saved cards and adds new ones through **Add Card**. Accounts billed by invoice rather than by card show custom contract dates instead of a charge date, and cancellation is handled by the account manager. **Usage** answers what you have consumed against those plan limits. **Monthly Usage Trends** charts data stored against data transferred over the last twelve billing periods, and below it the period picker switches between the current cycle and closed ones, with a per-metric breakdown for the selected period. Usage figures can be up to an hour behind live. ## Logs The Logs tab is the audit trail of changes people made to the Organization. Each entry carries an action badge (created, updated or deleted), the change itself with the API route it went through, when it happened in both absolute and relative form, and who did it. The view opens on the last 30 days. Use the date range picker to widen or move that window, **Reset to last 30 days** to return to the default, and the search box to filter by message, route or user. The export button writes the filtered entries out for retention or review outside the platform. ## Related Workflow Stages Settings sits at the Integrate end of the workflow, because the credentials created here are what let anything outside ControlCom Connect participate in it. A key with the right role can read the readings you [Collected](https://documentation.controlcomtech.com/build/sending-data) and [Stored](https://documentation.controlcomtech.com/platform/variables), query the same data you explore in [Platform Explorer](https://documentation.controlcomtech.com/platform/explorer), and drive the [API](https://documentation.controlcomtech.com/api-reference) or the [Builder MCP](https://documentation.controlcomtech.com/build/mcp) programmatically. Two neighbours are worth knowing about. Roles come from Team & Access, reachable from the General tab, and a key can never do more than its role allows. The Knowledgebase feeds the AI stage: what you upload there is what the assistant can cite when it answers questions about your facility.