eM-B2G-UC1-MoJ-HPMMS Data & Reporting Platform
Last updated
Last updated
Copyright © 2024
Example Implementation
| Use Case Step | Use Case: Ministry of Justice - HMPPS Data & Reporting platform, Step: Registration (Public Sector buyer) |
|---|---|
| Use Case Step | Use Case: Ministry of Justice - HMPPS Data & Reporting platform, Step: Registration (Public Sector buyer) |
|---|---|
Preconditions(list of conditions that MUST be met in order to be able to successfully execute this process)
· The buyer must be employed by, or represent, a public sector organisation.· The buyer has a work email address to create an account OR· The buyer has successfully logged into their government SSO (Registration BB) and has the necessary authorization to complete the registration process.· Data sharing agreement between Registration BB and respective registries where information is queried from has been signed (contract) and respective REST API services in Information Mediator has been opened to Registration BB.· The buyer email address domain is held on, or can be added to, a registry with approved or authenticated public sector domains.
Data inputs
1. Email address2. Password3. Name4. Organisation
Actors(the people, organizations, computer systems - hardware and software, and building blocks that participate in the activity)
Human: Public sector worker, System AdministratorSystem:· Digital Registries BB· Identity BB· Consent BB· Messaging BB· Information Mediator BB
Normal Course (what happens if the event is triggered and the preconditions have been met)
Create a buyer account: Registration page provides a high level explanation of what is needed and process to create an account. “You must be employed by, or represent, a public sector organisation. Use your work email address to create an account. We use this to check that you are part of a public sector organisation. We will send an account activation email to this address. You will then be able to set your password.”Step 1: The public sector worker enters their email address to create an account:1. Enter email address2. Validate email address structure3. Confirm ‘Create account’Step 2: The application submits the email address to the relevant Digital Registries BB to verify it belongs to an authorised public sector organisation.Step 3: The application sends an email to the public sector worker with a URL to complete account creation.Step 4: The public sector worker completes account creation:1. Click on link in email2. Create account password3. Confirm
Alternative Course(links to other use cases in case there are different ways how to solve the same use case)
If the public sector worker does not have an email address recognised by the registry, the registration application needs to provide an alternate mechanism for the worker to request an account.1. System Administrator confirms the domain is valid and adds to the registry.2. Public sector worker is notified and sent a link to create an account (URL to registration page)
Data output
Post-Conditions (the success criteria)
The buyer is registered and can access buyer-only areas of the marketplace.
Exceptions(error situations)
· A buyer can be only registered once. The system must prevent multiple registrations.o Provide details on exception code and messageo Mitigation steps: Describe steps to be taken by the actors· If the buyer does not have an email address with a domain registered in the Registry, then it is not possible to create an account (no personal emails).o Provide details on exception code and messageo Mitigation steps: Describe steps to be taken by the actors· If Identity BB or Consent BB is not available (service outage), then …..o Mitigation steps: Describe steps to be taken by the actors· If no internet, then the system is not available.o Mitigation steps: Display error page
Related BBs(working groups related to this example implementation)
Identity BBApproval BBRegistration BBDigital Registries BB
Sequence Diagram
Preconditions(list of conditions that MUST be met in order to be able to successfully execute this process)
· The supplier has an email address to create an account· The supplier must be employed by, and be authorised to represent, an organisation.· The supplier organisation is a legal entity and listed in the relevant registry (or via API to an official source).· Data sharing agreement between Registration BB and respective registries where information is queried from has been signed (contract) and respective REST API services in Information Mediator has been opened to Registration BB.
Data inputs
1. Email address2. Password3. Name4. Organisation name5. Organisation address6. Contact phone number (for buyer communications)7. Contact email address (for buyer communications)8. Company ID (e.g. DUNS number in the UK, or registered on Companies House)
Actors(the people, organizations, computer systems - hardware and software, and building blocks that participate in the activity)
Human: Supplier representativeSystem:· Digital Registries BB· Identity BB· Consent BB· Messaging BB· Information Mediator BB
Normal Course (what happens if the event is triggered and the preconditions have been met)
Create a supplier account: Registration page provides a high level explanation of what is needed and process to create an account. “You must provide:- a company name and company details that buyers may use to contact you- your own details to create a login- a DUNS number.It will take about 5 minutes to create your account. If your company isn’t registered with Companies House. If your company isn’t registered with Companies House, you may need to apply for a DUNS number before you can create a supplier account. It could take 3 to 5 days to get your DUNS number.”Step 1: The supplier enters their information to create an account:1. Enter company ID (e.g. DUNS) *note this first step to reduce failing later in the process2. Enter company name3. Enter contact name4. Enter contact email address5. Enter contact phone number6. Confirm ‘Create account’Step 2: Create login details (not visible on the Marketplace)1. Enter work email address (note, can also add other email addresses later)2. Confirm ‘Continue’Step 3: Check your information:1. View ‘Company ID’, ‘Company name’, ‘Contact name’, ‘Contact email’, ‘Contact phone number’, ‘Login email’2. Option to change each field individually3. Confirm ‘Create account’4. Confirmation page with next step “We’ve sent an email to <email>. Use the link to activate your account and set your password.”Confirm application sends an email to the supplier with a URL to complete account creation.Step 4: The supplier completes account creation:5. Click on link in email6. Create account password7. Confirm
Alternative Course(links to other use cases in case there are different ways how to solve the same use case)
Data output
Post-Conditions (the success criteria)
The supplier is registered and can access supplier-only areas of the marketplace.
Exceptions(error situations)
· A supplier can be only registered once. The system must prevent multiple registrations.o Provide details on exception code and messageo Mitigation steps: Describe steps to be taken by the actors· If the supplier does not have a valid Company ID….o Provide details on exception code and messageo Mitigation steps: Describe steps to be taken by the actors· If Identity BB or Consent BB is not available (service outage), then …..o Mitigation steps: Describe steps to be taken by the actors· If no internet, then the system is not available.o Mitigation steps: Display error page
Related BBs(working groups related to this example implementation)
Identity BBApproval BBRegistration BBDigital Registries BB
Sequence Diagram