Skip to main content

Project Overview & Configuration

Every project has a Configuration page — the home for its settings, identifiers, processes, roles, and irreversible actions. This page covers how to open it and walks through the Project overview tab; the other tabs each have their own page.

Opening the Configuration page​

From the dashboard, find the project's card and click Manage project. Cockpit opens the project's Configuration page (/configuration/<id>), which lands on the Project overview tab.

The Configuration tabs​

The Configuration page has six tabs:

TabWhat it's for
Project overviewthe project's name, identifiers, deployment model, user breakdown, and storage (below)
Processesthe project's authentication processes — see Authentication Processes (setup)
Rolesthe roles assigned to the project's users — see Roles & Permissions
External JWTexternal-JWT authentication — see External JWT Configuration
Custom propertiescustom key/value properties — see Custom Properties
Danger zonedeployment-model switch, transfer ownership, delete — see Danger Zone
info

The exact tabs depend on the deployment model and your access level. A Project-Access admin can't view or manage Processes, and some Danger zone actions are Environment-Access only.

Project overview​

Identity​

  • Project Name — editable; click the Edit project name pencil to rename.
  • Project ID (set up by you) — the reverse-domain Application ID (e.g. com.mycompany.myproject); in the SDK it's the projectId field of SdkOptions. It has a copy button and an Edit project ID pencil.
  • Project group ID (set up by Cardinal) — iCure's internal group identifier, read-only with a copy button.
caution

When you initialize the Cardinal SDK you want the Project ID (set up by you) — not the Project group ID (set up by Cardinal). See Initialize the Cardinal SDK.

Deployment​

  • Deployment Model — Single - Tenant or Multi - Tenant.
  • Number of tenants — how many tenants the project holds.
  • Tenant group ID — shown only for single-tenant projects (the id of the project's one hidden tenant), with a copy button.
info

Switching between single- and multi-tenant is done from the Danger zone (the Deployment model section), and managing the tenants of a multi-tenant project happens on the Managing Tenants page.

User breakdown​

For a single-tenant project, the overview shows a per-type count of its users — Healthcare parties, Patients, and Devices. In a multi-tenant project the users live inside each tenant, so you'll find the breakdown per tenant on the Managing Tenants page instead.

Storage​

The storage section reports how much room the project uses:

  • Size of data and Size of attachments — the current usage.
  • Clusters — the region(s) where the project's data is hosted.
info

Most recent backup / Oldest backup are reserved here but not yet shown. Storage usage counts against your Cardinal plan; see Storage & Plans.

Where to go next​

Cardinal SDK reference: a project is a Group in the Cardinal SDK; its Project ID is the Application ID (projectId in SdkOptions).