[P10] Onboard a Site
Summary
The operator connects a new site to EMS through a guided set-up. EMS creates or links the portal tenant and registration system, issues the credentials in both directions and records the site’s callback address, so nothing is copied by hand.
Actor & Context
Actor: Operator
Frequency: Once per site, and when a site moves
Precondition: The operator has an EMS account with rights for the organisation; the site is installed
Entry point: The set-up wizard on the site, or Connect a site in EMS
Main Flow
-
The operator obtains an enrolment code in EMS for the organisation (or starts from the site and is handed off to EMS).
-
The operator enters the code in the site’s set-up.
-
EMS creates or links the portal tenant and registration system, issues the site-to-EMS and EMS-to-site credentials, and records the site’s callback address.
-
If the site has a store, set-up registers it with EMS as the payment provider.
-
Set-up checks both directions and reports the result.
Alternative Flows
-
AF-1: Code expired or already used: set-up says so and asks for a new one.
-
AF-2: Check fails: set-up states what does not work (for example EMS cannot reach the site) and how to fix it.
-
AF-3: Credentials rotated later: EMS issues new ones; the site picks them up without manual edits and no service restart is needed.
Acceptance Criteria
-
No credential is typed or copied by hand (PS-ON-02)
-
Both directions are proven at the end (PS-ON-04)
-
The organisation follows from the connection (PS-CF-03)
-
Rotation needs no restart (PS-ON-05)
API Surface
The calls below are named by purpose; their exact form is defined in the public site design.
| Call | Purpose |
|---|---|
EMS: issue enrolment code |
Admin Portal |
EMS: exchange enrolment code |
Creates tenant, registration system, credentials |
EMS: check connection |
Both directions |
Design Anchors
-
Public Site Requirements — PS-ON-01 to 05, PS-CF-02, PS-CF-03