Manage shared settings

Set the shared preferences the platform reads by storing values against centrally registered setting definitions — at the organisation level, or at a more specific scope that overrides it.

Before you start

• You need settings.view to read and settings.manage to change shared settings. Every change is audited.
• A setting definition is a central, global entry that declares its value type, the scope levels it may be set at, and whether overrides below the organisation are permitted. You store values against these definitions; you do not create the definitions themselves.
• Secrets and provider credentials are out of scope for shared settings — values containing keys such as secret, token, password or api_key are rejected.

Steps

Pick the setting definition

1. Open Admin Setup → Settings → Shared settings and choose the Setting definition (required). It must be an active, centrally registered definition.
2. Note its value type — the value you enter is checked against it (for example a boolean, an integer, a three-letter currency code, a locale such as en-US, an enum from the registered allowed values, or a start/end time range in HH:MM).

   [screenshot: Shared settings list]

Choose the scope

1. Choose the Scope level (required): organisation, entity, branch or department.
2. Name the targets the level requires:
   • Entity scope requires an Entity.
   • Branch scope requires an Entity and a Branch.
   • Department scope requires Entity, Branch and Department.
3. The scope must belong to your organisation and be internally consistent. If the definition does not permit lower-level overrides, only the organisation level is accepted.

Enter the value

1. Enter the Value (required — it must be present) in the type the definition expects.
2. Optionally add an Override reason and a Status.
3. Save — the change is audited.

   [screenshot: Set shared setting value]

Result

Your value is stored at the chosen scope. Because a value can be set at several levels, the platform resolves an effective value for any scope by walking the hierarchy — a department inherits the organisation’s setting unless a more specific value overrides it.

Related

• Admin Setup reference
• Set your company profile and branding
• Set up your organisation structure