Settings schemas and shared bases
Lesson 9 of 25 7 min read
Build the settings form organisations fill in for a type, and read the shared bases that come with each release.
Many integrations need a few settings from each customer: an account number, a warehouse code, a default carrier. A settings schema turns your list of settings into the form organisations fill in. In this lesson you will add one, and then look at the read-only Shared screen.
Settings schemas
A settings schema makes the settings form that an organisation fills in for an integration of the type. You only need one if the type needs settings.
Open Administration → Maps & Profiles → Settings Schemas. The page has two tabs:
| Tab | What it shows |
|---|---|
| Shapes | The settings forms, one for each integration type and document type. |
| Fragments | Shared parts that shapes can use. Read-only. |
A shape is one settings form. A fragment is a reusable set of settings that several shapes can include, so common settings are defined once.
Connection settings or document settings
A shape is for an integration type and, optionally, one document type:
- Leave Document type empty for the settings of the connection itself, such as an account id.
- Select a document type for settings that apply to that document type only, such as a default service level for warehouse orders.
Add a shape
- Select Add. The New settings shape page opens.
- In Integration type, select the type.
- Leave Document type empty for connection settings, or select a document type.
- Type a Name and, optionally, a Description.
- Optional: in Fragments, select shared parts. If two fragments declare the same setting, the first one owns it.
- In Own properties, type the settings of this shape.
- Select Save.
- Look at What a tenant will see. It shows the form that organisations will fill in.
The preview updates after you save
What a tenant will see updates only after you save, because Supply Lens builds the form from the fragments and the own properties together. Save, then check the preview.
After you save a shape, you cannot change its Integration type or Document type. The page then names the shape by them, for example acme-api connection. If you picked the wrong document type, make a new shape.
Shared bases
Administration → Maps & Profiles → Shared shows the shared bases that come with each release. You can only read them.
- Open Administration → Maps & Profiles → Shared.
- In Read through, select an organisation.
- Select Read it on the row you want to see.
To change a shared base for one organisation, publish an overlay onto it in that organisation. If you try to open a shared base for editing, Prism tells you: This is the shared base we ship. It cannot be edited here.
Settings for Northbank Fulfilment
Northbank Fulfilment, a 3PL, needs a client code for every customer, and a default service level for warehouse orders. You make two shapes for the northbank-wms type:
- northbank-wms connection, with no document type, holding the client code.
- A shape for warehouse orders, holding the default service level.
You save each, then check What a tenant will see to make sure the form reads well before any customer sees it.
Recap
- A settings shape is the settings form for a type, or for one of its document types.
- Leave Document type empty for connection settings.
- Fragments are shared, read-only parts; the first fragment to declare a setting owns it.
- What a tenant will see updates only after you save; type and document type are fixed after saving.
- Shared bases are read-only; change one for an organisation with an overlay.
Your progress is saved in this browser. Create a free account to keep it everywhere, take quizzes and earn certificates.