Configure a New Retailer
This guide covers bringing a new tenant onto My-Scan — what needs to happen after the tenant itself already exists. Creating the Hii Retail tenant is not something My-Scan (or any product team) does.
1. Tenant creation (not My-Scan's job)
A Hii Retail tenant is created by the IAM team — reach them via Slack #hiiretail-iam. Only Extenda Retail administrative personnel are authorized to create a tenant; retailers can't create one themselves. See Tenants for the concept. If this is for testing rather than production, see Testing & Test Tenants instead — a test tenant follows the same IAM process.
Everything below assumes the tenant already exists.
2. Register My-Scan's OCMS Software Statement
Each tenant needs its own Software Statement linked to My-Scan's global mys OCMS template, so OCMS clients for that tenant are auto-approved rather than needing manual approval per client. See OCMS: Software Statements for the general mechanism this uses.
Create it in the OCMS section of the tenant's Hii Retail Console (https://[your-tenant].hiiretail.com).
3. Set initial tenant-level configuration
With the tenant and Software Statement in place, set the tenant-level values relevant to this retailer:
PaymentSettings(currency, country code, languages, tender type) — only needed if the retailer wants shoppers to pay directly on their device. A retailer can instead have every trip finish by handing the ticket to a POS/SCO for payment — see Integrate a New POS — with no payment provider configured on the My-Scan side at all. If direct device payment is wanted, see Add a New Parameter and Integrate a Payment Provider.- Tenant-level CCC values that shouldn't just inherit the platform default — see Configuration: Tenant Configuration.
If a value isn't set here, it falls back to the platform/tenant default via CCC or Parameters inheritance — you only need to set what's actually different for this retailer.
4. Verify
- Create a test basket for the new tenant (see Quick Start) and confirm it succeeds.
- Confirm the retailer's checkout path works end to end: Integrate a Payment Provider if direct device payment is configured, or Integrate a New POS if the retailer relies on POS handover instead.
- If this is a test tenant rather than production, see Testing & Test Tenants for the domain/token differences.
Reference
- Tenants — the platform-wide tenant concept.
- OCMS: Software Statements — the general OCMS mechanism.
- Configuration: Tenant Configuration — CCC tenant-level settings.