Skip to content

JNY-PFM-SEC-001Prepare and hand over a customer workspace

Markdown

JNY-PFM-SEC-001

Prepare and hand over a customer workspace

Markdown
  • DocumentDraft
  • Product intentConfirmed
  • ImplementationObserved

KindJourneyProduct areaPlatformModuleSecurity, Customers and WorkspacesRevision1End-to-endRequired

Read atservices-platform ad3f6a65react-console baf6dae3

The Formal Contract

The narrative above explains; the sections below are authoritative — the rules, scenarios and tests this document binds.

Goal
Establish the customer, provision its workspace, invite the initial administrator and make the business go-live decision.
Screens
/hq/customers/hq/tenants/provision/hq/jobs/tenant_provisioning/{jobId}/hq/tenants/{tenantId}

Steps

#SurfaceActionCapabilityExpectedProvenance
1/hq/customersCreate a customer with the chosen readable reference and classification.CAP-PFM-SEC-001The mocked customer page opens before any workspace is added.test
react-console:e2e/mock/hq-ops.mock.spec.ts#New Customer creates one with Platform's types and opens it
2/hq/tenants/provisionOpen provisioning for that customer and specify the workspace, calendar, initial administrator and sender.CAP-PFM-SEC-003The customer is preselected when provisioning starts from its page.test
react-console:e2e/mock/hq-ops.mock.spec.ts#opens with the customer already chosen when it starts from that customer
3createTenantComplete the wizard and submit the setup request.CAP-PFM-SEC-003The mocked submission navigates to the newly started job.test
react-console:e2e/mock/hq-ops.mock.spec.ts#walks every step and lands on the job it started
4/hq/jobs/tenant_provisioning/{jobId}Inspect provisioning progress on the job page.CAP-PFM-SEC-003The backend job snapshot lists participant work followed by readiness and activation.test
services-platform:modules/tenants/tests/e2e/tenant-provisioning.e2e.spec.js#shows one step per participant, then the readiness check and the activation
5/hq/tenants/{tenantId}Inspect the workspace overview, sandbox list and sender records in HQ.CAP-PFM-SEC-002The mock page displays the overview, related sandboxes and sender DNS records.test
react-console:e2e/mock/hq-ops.mock.spec.ts#shows the overview, its sandboxes and the sender's DNS records
6patchHqTenantChange the workspace business status to live through HQ.CAP-PFM-SEC-002The HQ update returns live business status independently of lifecycle activation.test
services-platform:modules/tenants/tests/e2e/tenants.e2e.spec.js#answers 200 and the live status to the HQ patch

Alternate and Failure Paths

PathFrom stepConditionPath takenOutcomeProvenance
alternate4Provisioning reports a failed step.Review the displayed reason and choose Retry.The mock job returns to a running state.test
react-console:e2e/mock/hq-ops.mock.spec.ts#shows a failed job's reason and retries its provisioning
alternate5The customer requires initial data migration.Use the initial-loading workflow and activate with the required staff permission.The tested activation returns the workspace to active lifecycle with implementation business status.test
services-platform:modules/tenants/tests/e2e/hq-tenant-loading.e2e.spec.js#is served to a staff member holding hq.tenants.activate, returning the tenant to active
failure3The requested workspace reference is taken.Display the server refusal at the workspace-reference field.The mock UI offers the existing workspace rather than opening a new job.test
react-console:e2e/mock/hq-ops.mock.spec.ts#puts Platform's refusal of a taken tenant ID on the Tenant ID
failure6A customer administrator requests a business-status change through the console.Reject the console update and identify the HQ operation.The console request cannot make that status change.test
services-platform:modules/tenants/tests/e2e/tenants.e2e.spec.js#refuses a customer administrator the same change on the console route, naming where it is made

Assertions

IdStatementProvenance
01The mocked provisioning wizard completes its steps and navigates to the started job.test
react-console:e2e/mock/hq-ops.mock.spec.ts#walks every step and lands on the job it started
02The backend provisioning run leaves the workspace active and records activation time.test
03The mock HQ editor saves detail changes, excludes reference editing and confirms disabling.test
react-console:e2e/mock/hq-ops.mock.spec.ts#the edit sheet saves, has no identifier to change, and confirms before disabling the tenant

End-to-end policy: required: The intended flow connects HQ screens, backend provisioning and handover. A browser run against real services is required to establish the combined experience; mock navigation and backend job tests provide separate evidence.

The Markdown files under specs/ in rhythmsoftware/rhythm-v2-docs are the canonical source of truth. This reader is a generated, read-only projection of them.