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, business model, 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 sees Processes read-only, 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.
  • Business model — how the project is invoiced: Per Healthcare Professional (HCP), Per Patient, or Per Device or Institution Bed. Its pencil opens Change the project business model. See Business model below.
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.

Business model​

The business model decides what the project is invoiced on and, with it, how its storage allowance is calculated — see Storage & Plans. It's chosen on the Users step of the project wizard, and can be changed here or from the project card's Edit action.

ModelYou are invoiced for
Per Healthcare Professional (HCP)each active healthcare professional using your project
Per Patienteach patient record held in your project
Per Device or Institution Bedeach registered device or institution bed
caution

Changing the business model of an existing project affects how it is invoiced — contact the iCure team if you are not sure which model to select.

info

Projects created before business models existed show Per HCP (default): Cockpit assumes the Per-HCP model for them and derives their limits from it, with an alert at the top of the overview — "No business model has been selected for this project yet…" — and a Select your business model link. Pick the real model to see accurate limits. A project that somehow carries more than one model shows Business model conflict: no limit can be calculated and no users can be added until you select the correct one.

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​

The overview shows a per-type count of the project's users — Healthcare parties, Patients, and Devices — across all its tenants. Each badge is a shortcut: on a single-tenant project it opens the Users page filtered to that type; on a multi-tenant project it opens the Tenants page and the first tenant you open shows its Users tab already filtered. See Managing Users.

Storage​

The storage section reports how much room the project uses against its allowance:

  • Structured storage and File storage charts (one Combined storage chart on the Free plan) — usage against the limit: a fixed 500 MB per project on the Free plan, or, on a paid plan, the allowance derived from the business model and the number of users it bills on. Hover a chart for the rate and the date of the figures.
  • Clusters — the region(s) where the project's data is hosted.
info

The counts and storage figures are refreshed every 24 hours by the metrics service; a banner on the overview tells you when they were last updated, so what you changed today is not counted yet. See Metrics. The charts are the same for Environment-Access and Project-Access admins. 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).