Domain & Application Management

At the platform: the domain catalogue

With the console on the platform, this screen is the Domain catalogue: the whole tree of domains, sub-domains and the applications in each, as every account and tenant sees it. It is found under Settings → Domains.

1. To add a top-level domain, type its name under New top-level domain and press Create domain.
2. To add beneath a domain, press Create sub-domain or Create application on its row, type the name and press Save.
3. Rename changes the name only. Move up and Move down change the order among the domain's siblings (or the application's place in its domain).
4. Retire checks what uses the domain and says so in a sentence.

• A key is made from the name when a domain or application is created ("Executive Education" becomes executive_education) and never changes. A name whose key is already taken is refused; choose a different name.
• A new domain or application is open in every account and tenant where its parent is open, until one of them closes it: availability is open unless closed.
• A domain is retired only when nothing uses it — sub-domains, applications, domain fields or validation rules, EntityViews, availability settings or members' choices; the refusal names what does. An application is retired the same way — only when no field, A_EntityView, runtime, availability setting, member's choice or capability version uses it. A retired row is never deleted: it leaves the catalogue, the availability screens and every picker, and its key stays taken.
• A domain has a name and a key; there is no description yet.
• Every change is recorded in the audit trail at the platform.

Tip Seeing the catalogue needs domain.read at the platform, and changing it needs domain.write there; both sit with the platform administrator. Without domain.write the tree is shown read only and a note names the missing key.

In a Tenant: what's on this screen

• A Tenant switcher at the top; the screen fills in for the Tenant you choose.
• One sentence saying the domain tree itself is authored at the platform, with a link to how.
• The Domain tab: the platform's whole Domain tree, expanded with its sub-Domains. Each row shows On or Off; the name of an Off one appears struck through.
• The Application tab: the Applications this Tenant can see, grouped by the Domain they belong to.

What you can do

1. Choose the relevant tab.
2. Press the On / Off button on the row you want to change. The change is saved at that moment; there is no separate save button.

The Domain tree itself doesn't change here; only what is on in this Tenant changes. A domain or application the platform adds later starts On here. When you turn off a parent Domain, the Domains under it can't be used either; when you refresh the page, they also show as Off.

Keep in mind Turning a Domain off makes the choices users previously made for that Domain inactive. Turning the Domain back on doesn't bring those choices back; users need to choose again.

Good to know

Tip Seeing it needs domain.read in this Tenant, and turning things on and off needs domain.write; the Application tab depends on the same permission. If you don't have the permission, you see status badges instead of buttons, and a note stating the missing permission.

An Application you turn off here no longer appears on this Tenant's Applications screen or in the catalog. Check on the Applications screen whether an Application that is on actually opens.