Preparing to add a new framework

These are the things a developer currently needs to do to prepare a new framework for applications.

Note

Unless otherwise noted, you should make sure you do ALL these steps in the right order.

1 - Make the content

In the frameworks repository, run the clone-latest-framework.py script. For instance, to create a new framework G-Cloud 12 from G-Cloud 11 run:

./scripts/clone-latest-framework --family=g-cloud --iteration=12 --launch-year=2020

This will create a new folder in the frameworks directory based on the previous iteration of that framework.

Each framework iteration has sub-folders for:

  • questions: all the question content for both supplier declarations and service definitions.
  • manifests: manifests define the order that questions are presented by the front-end applications.
  • messages: various framework-specific messages shown during applications, such as important dates.
  • metadata: information that links two or more frameworks, e.g. which service attributes can be copied between frameworks.
  • search_mappings: contains a base mapping, used to generate the framework’s Elasticsearch mapping for the Search API.

The cloning script provides placeholder dates and URLs that will need to be updated and confirmed with the real content (see below).

Commit the changes and update the version number in package.json. Normally this will be a minor version bump, as it shouldn’t break functionality.

See the README in the frameworks repository for more detail about how these things work.

After cloning the content:

  • Confirm any new framework application questions with Crown Commercial Services (CCS) and a GDS content designer before launch. It’s advisable to keep any script-generated dates in the content to a far-future year (e.g. 1st March 2525) until they are confirmed with CCS.
  • Add any new free text fields for G-Cloud services to the scan-g-cloud-services-for-bad-words.py script.
  • Make sure any non-question content changes (e.g. home page messages) have been approved with a content designer.
  • Update the version number in the frameworks repository’s package.json file.
  • Pull in the new version of the frameworks package to all the frontend apps. For the Briefs FE, Brief Responses FE and Supplier FE, you will also need to load the content for the new framework in app/main/__init__.py.
  • Run framework-applications/generate-questions-csv.py from the scripts repository to export the declaration and service questions as a CSV file, ready to publish for suppliers. These files will normally be published by a framework manager using the admin interface.

2 - Generate service validation schemas and add them to the API

The API needs service validation schemas for each lot on the new framework, to validate requests containing service data.

  • In the frameworks repository, add the required schema names to the list in schema_generator/validation.py

  • Then (assuming your API code is checked out in a folder at the same level as your frameworks code) run:

    python ./scripts/generate-validation-schemas.py --output-path=../digitalmarketplace-api/json_schemas/
    
  • Then commit the freshly-generated schemas into the API.

If there are subsequent changes to questions in the frameworks repo, remember to regenerate the schemas.

3 - Add a supplier declaration validator (optional)

Unlike services, supplier declarations are validated in the supplier frontend due to the limitations of JSON schema (specifically that it can’t be used to conditionally validate based on values of keys elsewhere in the JSON).

Frameworks from G-Cloud 8 onwards use a shared validator class to validate frameworks. If no validator is specified for a framework this shared validator will be used by default.

If the new framework requires any custom validation (e.g. dependencies between questions), create a new class in the supplier frontend as follows:

  • Add the new framework to the validator list in app/main/helpers/validation.py.
  • Add any new optional and/or dependent declaration questions to the validator (for example, conditional followup questions).

4 - Check application email templates

A number of emails are sent during framework applications. Make sure all the emails below have templates on GOV.UK Notify, and that they have been checked by the framework product manager and a content designer:

  • The new framework is coming
  • Applications are open
  • You have started an application
  • You have submitted a clarification question
  • Clarification questions have been updated
  • Clarification questions are closing today
  • Applications are closing soon
  • Applications are closed
  • You submitted an application / You did not submit an application
  • Notify successful suppliers of award
  • Framework is now live

Unsuccessful suppliers will be contacted separately by CCS.

5 - Create any new lots

If the new framework also has new lots, these will have to be created by a database migration (the API does not currently support creating or modifying lots).

If the lots already exist, you can re-use the existing lot slugs when creating your new framework via the API (this is step 1 in the framework lifecycle).

7 - Generate the assessment schemas

Note

This can be done at any time before applications close

Run the generate-assessment-schema.py script in our frameworks repository, to create the pass/fail json schema with which we assess suppliers’ declarations. Pipe the output to the /schemas folder in the scripts repository and commit it.

For example, to generate assessment schema for G-Cloud 12:

./scripts/generate-assessment-schema.py g-cloud-12 > ../digitalmarketplace-scripts/schema/g-cloud-12-assessment-schema.json

If the declaration has new mitigatingFactors questions for discretionary failures, add these to the export-framework-results-reasons.py script in the scripts repository, for inclusion in the pass/fail report (to be sent to CCS).

DOS frameworks used to also have assessment schemas for services, but these are now validated in the API, in the same way as G-Cloud services.

8 - Create a new search mapping (G-Cloud only)

Note

This can be done at any time before the framework goes live

  • Run the generate-search-config.py script from the frameworks repository to generate a search mapping for the new G-Cloud index. This should take the name <doctype>-<framework_slug>, e.g. services-g-cloud-10.
  • Commit the output to the Search API repository, under digitalmarketplace-search-api/mappings.

9 - Let’s go!

Everything is now set up and ready to create and launch the new framework itself! Follow the steps in Framework lifecycle for developers to get cracking.

Note

Check with the framework’s product manager and/or the comms team before you start the next steps in production, as the creating the framework in the database will display information to users on the home page.