Common components

What are common components?

Common components are typically software or technical systems created once and reused many times in different services or business contexts.

Examples include applications, data, a network, security products and hosting. They are like building blocks, typically mapped to a business or technical capability, which can be used to deliver more complex services or systems.

Key characteristics

Common components can be of any size but they all share the same characteristics. They are:

• designed according to common standards, principles and patterns, with independent quality assurance
• designed and developed in a modular, scalable and resilient way to support ease of reuse and reliability
• mapped to a specific business or technical capability/service. This enables easy search and prevents duplication
• treated as an asset and therefore require support, continuous improvement, enhancement or replacement
• standalone but work alongside other common components, so that a change on one component doesn’t affect another

Why should we use common components?

The adoption of common components can bring significant benefits to the department and help people build better services, more quickly. Some of these benefits are:

• speed to market – reuse can save time to build, test and deliver services. You should not have to build services from scratch every time
• efficiency and reduced costs – the more you can reuse, the more you can save through reduced duplication. This will enable you to focus your efforts on the innovative aspects of the service
• lower risk – building to common standards lowers the risk of failure

What components are available?

There is a distinction between components used to build a service and tools to enable the building of services.

Service components, products and platforms

Common tooling

How do we use components?

Cloud Infrastructure Platform

The Cloud Infrastructure Platform (CIP) is the department’s Microsoft Azure cloud hosting offer. It’s managed centrally and provides a highly flexible model that gives services control and consistency over how their business services are hosted.

CIP is a set of principles, processes and technologies that support the development and delivery of cloud computing, applications and services.

The CIP platform is designed using a ‘loosely-coupled’ approach, which enables services to be hosted independently from each other. This means changes can be made without affecting other components.

Key benefits include:

• improving efficiency and consistency for delivery teams
• reducing implementation times for projects
• access to best practice templates, automation and customer self-service features
• quick access to a secure ‘sandpit’ environment

Documentation

Read the platform documentation in the service catalogue, that covers security, access, operations and monitoring.

Request CIP access via the Service Portal, if you don’t already have it.

Support

CIP has a support team who handle incidents and requests. Our tiered support operating model makes it easy to accommodate different business requirements. For each service using the platform, a range of support services are provided. All services receive:

• policy support
• guidance for security
• guidance on best practice into production
• working hours support

Optional support services that can be requested during onboarding are:

• support for Azure DevOps for new users
• more extensive support for security / firewalls
• guidance for Azure engineering

We’ve made costing transparent – each service is assigned an ID linked to its Azure account; this makes it simple to track resources being consumed

Read the team’s wiki for further information and ways to contact the CIP Engineering team.

You can raise an onboarding request via the service catalogue.

Roadmap

We’ve moved into the continual improvement phase with ongoing effort to improve our hosting offer, products, services and processes. We’re also moving our services away from our legacy cloud platforms on to the Cloud Infrastructure Platform (CIP). Discovery work to migrate to this central strategic platform has begun.

To deliver an enterprise aligned solution to our customer, we will:

1. Create a holistic cloud operating model, meeting the needs of both the DfE and ESFA platform management and service engineering and delivery teams.
2. Create tailored principles and processes, ensuring resources offered directly by the Cloud Hosting provider (Microsoft Azure) are consumed and configured in the desired manner.
3. Define, create, and manage, a selection of services that enable, empower, and protect, delivery teams and the services created by them.
4. Ensure that services offered to the engineering and delivery teams are fit for purpose, fit for use, isolated from one another, and can be easily discovered and consumed by engineering and delivery teams.

To help us deliver the above, we’ve joined forces with the architecture profession to review our cloud strategy. This includes considering how to evolve as a central provider of cloud services and where hot topics like ‘multi-vendor’ and containerisation fit with our future thinking.

Further guidance

Read the Cloud Infrastructure and Platform Services wiki or contact one of the team:

• Infrastructure Engineering Lead - Ritesh Patel
• Infrastructure Operations Lead - Angie Paylor
• Platform Support Lead - Paul Cripwell
• Head of Infrastructure Services - Huw Evans

GOV.UK PaaS

GOV.UK Platform as a Service (PaaS) is a platform developed by Government Digital Service (GDS) and available for government departments to deploy applications and backend services. It is based on the widely used open source platform Cloud Foundry and built on Amazon Web Services.

It is a simpler alternative to CIP and doesn’t require infrastructure specialists to get started.

Documentation

Visit the GOV.UK PaaS technical guidance for more information.

DfE Sign-in

DfE Sign-in is the department’s strategic Identity and Access Management (IdAM) solution. DfE Sign-in already provides IdAM for services migrated from Secure Access and a number of other services that have on-boarded during 2019. All new services should use DfE Sign-in.

DfE Sign-in is an OpenID Connect (OIDC) identity provider (with support for SAML). It is designed to serve as a delegated authority for identity management, harnessing the global experience for all users. The net result is that Service Owners don’t need to build identity solutions into their services and service users don’t need to maintain many sets of credentials.

Because DfE Sign-in is a standards-based identity provider, integration is simple. Many technologies and frameworks have stable integration components and examples.

Documentation

Our service is available at https://services.signin.education.gov.uk

You may also find the following code repositories for services that use DfE Sign-in useful, along with some example integrations that we have built:

• Teachers Payment Service (Ruby on Rails)
• Course Directory (.NET Core)
• Other integration examples

Support

Support for DfE Sign-in is available through our help pages. These pages contain useful information for users and approvers on how to use DfE Sign-in. If a user is still having problems, they can submit a support request too.

DfE Sign-in support requests are managed via a dedicated DfE Sign-in service desk where we can monitor and track support requests. That enables us to collect information to help improve the service, highlight any potential service issues and regularly update the help pages to further support our users.

Please direct your users through this support route. If there is anything you would like to discuss or be taken through common issues or regular queries, please contact the Product Owner.

Roadmap

You can see who’s already using DfE Sign-in. Any staff, provider and citizen services that currently use the Pirean Access: One product will migrate across to DfE Sign-in.

Further guidance

• Service Manager - Jane Ludlow
• Product Owner - Ilona Posluszny

API Management

Enterprise integration and API management services make it easier to share data quickly and securely – whether you’re an integration partner, developer, publisher or data consumer.

Find and Use an API (FaUAPI)

Find and Use an API is a service which provides a central place to host and discover DfE APIs. It is a secure and fully accredited service that makes it easy to both publish and consume APIs.

It provides a GOV.UK branded public facing front door for users to discover and consume data from DfE APIs. APIs can be public facing, or available to DfE internal users only. A management portal is provided to allow developers to configure, document, provide information on authentication and publish APIs, and to manage subscription requests from users.

Developers of new DfE APIs must host their APIs on Find and Use an API (other than in a small number of agreed exceptional cases), leveraging the security benefits and infrastructure cost savings of a shared service. Existing APIs which are hosted elsewhere must be listed on the service to allow discoverability and satisfy CDDO reporting requirements.

Development / Test / Pre-Production service The Find and Use an API Pre-Production service should be used for all non-production purposes, e.g. development, test, UAT, OAT, or pre-production workloads.

• The pre-production version of the public-facing consumer portal can be found at https://pp-find-and-use-an-api.education.gov.uk
• The pre-production version of the DfE developer-facing management portal can be found at https://pp-apimanagement.education.gov.uk
• Pre-production hosted APIs are available at https://pp-api.education.gov.uk

Production service The Find and Use an API Production service should only be used for production workloads.

• The public-facing consumer portal can be found at https://beta-find-and-use-an-api.education.gov.uk
• The DfE developer-facing management portal can be found at https://apimanagement.education.gov.uk
• APIs are available at https://api.education.gov.uk

Onboarding DfE developers can request a workspace in the pre-production instance at any time and start to use the service. Please contact dfe-api.support@education.gov.uk to arrange a guided onboarding session for your team if required.

Technologies FaUAPI has been developed using Azure platform-as-a-service components, including Azure API Management, and the solution is deployed within the CIP hosting platform with an expert team supporting the infrastructure.

Here are some of the key benefits:

• Makes it easier to share data
• Enables users to discover what data is available to them in a single place
• Makes it easy to manage who can access your data
• Reduces the admin for developer teams
• Supports APIs developers with meeting required standards
• Cost savings
• Helps the department with cross government reporting on APIs

Documentation

We are currently in the process of finalising the documentation for Find and Use an API, so please contact our support mailbox if you need further information.

Support and further guidance

The service is supported internally by the Solutions Delivery Team, within Infrastructure and Platforms. We provide support on weekdays between 9am and 5pm. For any incidents or requests, please log through ServiceNow. Out-of-hours support is available with prior agreement. For any other queries please contact our support mailbox

Enterprise Data and Analytics Platform

The Enterprise Data and Analytics Platform (EDAP) provides the DfE with a strategic and consolidated data management capability. It is an Azure hosted solution fronted by a remote desktop (RD) farm with a range of installed software, including many analytical tools. The Department’s analysts, researchers and data scientists use these tools to analyse data from various data sources. SQL server and a file server complete the platform make-up.

Documentation

The EDAP support team’s SharePoint site has content supporting the customers and both technical and process content supporting the EDAP support team.

Support

There is a specialist in-house technical team providing 2nd and 3rd line support from 09:00 to 17:00 Monday-Friday, excluding UK Bank Holidays. EDAP processes are aligned with DfE standard Service Management processes utilising ServiceNow via the Service Portal for both Incident Management, Access Management, Request Fulfilment etc.

The majority of the Service Requests fulfilled by the team can be categorised under:

• New / Remove Access to the EDAP platform • Change permissions to databases and / or file shares available on the platform • New working environment – creating new database(s) and file share(s) • Data support / ETL requests – providing administration and specialist support • General SQL / tooling guidance and advice

The day-to-day working practices of the team ensures that Information Asset Owners and Managers are able to fulfil their obligations under the Information Asset Ownership and Registration Policy

Roadmap

Customers from across DfE already utilising EDAP include:

• Capital Directorate
• DfE Operations
• FE Data and statistics
• Graduate Outcomes and Skills Analysis
• HE Modelling
• HE Social Research
• HE Statistics Unit
• Learner Data Strategy
• NPD Modernisation
• Skills Policy Analysis
• SPA Data Modelling
• Student Finance Modelling

Alongside on-boarding new customers and data over the coming months the EDAP support team are looking to:

• Enhance and further automate operational reporting
• Embed a Continuous Improvement approach
• Work even more closely with the DfE Service Management teams, looking for further opportunities to streamline and automate processes

Further guidance

Resources for the user community:

• Raise a Support Request – further guidance for the EDAP community and templates
• EDAP User Guides – from the names of the servers and URLs to step by step instructions of how to log on
• Frequently Asked Questions
• Information Asset Registration
• Training Resources
• Link to the RD farm

Team Mailbox: edap.support@education.gov.uk

Platform Support Manager: Chris Collins

Postcode lookup

We’re helping service delivery teams make the right strategic choices for delivering postcode capabilities within their service by identifying a set of common postcode lookup solutions.

The solutions identified below provide functionality to search address details across the UK. They can return results ‘as you type’, meaning users can choose the correct address as they go. Using these solutions can help your service to:

• Reduce inaccuracies from manual entry
• Avoid the chances of having duplicate data
• Improve user experience for data entry and retrieval

Postcode lookup components

These are the products and services in use and available across the department:

• Ordnance Survey Data Hub
• Postcodes.io
• GetAddress.io
• Experian QAS
• Royal Mail
• ONS postcode directory

They each bring a slightly different set of features and capabilities that fit different use cases. This table provides an overview:

Here’s a link to an Excel version of the table.

If you’re considering your options and want more advice, get in touch with your Architecture Lead.

Geospatial mapping

Geospatial mapping tools provide detailed information about geographical regions and sites. These include features like satellite imagery, aerial photography, street maps, 360° interactive street views, real-time traffic conditions and directions (with route planning for traveling by foot, car, bicycle and public transportation).

Geospatial mapping components

These are the products and services in use and available across the department:

• Ordnance Survey Data Hub
• Azure Maps
• Google Maps
• Bing Maps

They each bring a slightly different set of features and capabilities that fit different use cases. This table provides an overview:

Here’s a link to an Excel version of the table.

If you’re considering your options and want more advice, get in touch with your Architecture Lead.

Notifications and messaging

Notification components will enable your service to deliver messages to users. We have two main categories of notification applications - ‘communication’ and ‘error tracking’.

Communication

These applications will let your service send out email, SMS (text messages), letters, or a combination of all three, using HTTPS or SMTP protocols:

• GovUKNotify
• SMTP
• Sparkpost
• Intellisoft SMS
• Send Grid

Error tracking

These applications will provide error monitoring and alerts to services that are developing solutions, so that they are aware of errors as they appear:

• Rollbar
• Sentry

Each application brings a slightly different set of features and capabilities that fit different use cases. This table provides an overview:

Here’s a link to an Excel version of the table.

If you’re considering your options and want more advice, get in touch with your Architecture Lead.

Content Management Systems

A Content Management System (CMS) allows users to create, manage, modify, publish and store digital content in one place.

‘Headless’ content management is being used increasingly within services in the department. This is a back-end only CMS that makes content accessible via a RESTful API, for display through one or more front-end channels.

CMS products support collaboration across teams, with multiple users being able to work on content in the back-end of the CMS, allowing for quick and easy updates. CMS users can customise the design and functionality of the front-end by using templates and extensions.

Contentful is the department’s preferred headless CMS product, which is currently in use by a number of services. Contentful has an enterprise license plan and support, and has been assured for use in DfE, meaning teams can purchase the space size they need and incorporate into their service easily. For more information, email the Digital Tools Support team or contact them via #digital-tools-support on DfE Slack.

Other CMS products either in use or have been considered across the department are:

• Orchard Core
• Sitefinity
• Contentstack
• Kontent
• Prismic
• Cosmic JS

Benefits of using a CMS include:

1. No coding knowledge required - Enables non-developers and other users to build websites without coding. (It’s important to note that most CMS applications do allow users to add custom code for more granular control.)

2. Easy collaboration - Multiple users can access and work in the back end of a CMS at the same time.

3. Features, extensions and templates - CMS applications offer built-in features as well as add-ons to customise digital content.

4. Easier updates - Enables users to make changes to digital content faster and easier, to keep content dynamic and relevant.

Each CMS brings a slightly different set of features and capabilities that fit different use cases. This table provides an overview:

Here’s a link to an Excel version of the table.

If you’re considering CMS options, please discuss your needs with the DfE Content Design community on Slack. Work on the strategy for information services within the DfE is ongoing.

Customer Relationship Management

Microsoft Dynamics 365 is in use across DfE to deliver Customer Relationship Management (CRM) for DfE services.

Dynamics 365 provides various CRM features, such as:

• Case Management
• Account Management
• Enquiry Handling

It can also be customised to support operational delivery, such as programme and financial assurance. Specific modules are also available for specific purposes, such as marketing and financial management.

Dynamics 365 Portals provides an out-of-the-box front-end application that integrates directly with Dynamics 365. It can also be customised using CSS and Javascript, so can have a look and feel that is compliant with GOV.UK standards. For more complex implementations, it can also be integrated with a C#/.Net or Ruby application, to give more flexibility.

Where an external-facing application is needed to support the CRM, Dynamics 365 Portals or development of a standalone web application can be used. Dynamics CRM can also be integrated with other external systems, such as support desks.

Thinking of implementing Anti-Virus and file scanning within Dynamics 365?

As the Dynamics 365 virus detection engine runs asynchronously (independent from file uploads), you may need or have the requirement to run realtime anti-virus and file scanning when your users are uploading files.

A DfE team has successfully implemented a product called Cloudmersive. It offers virus scanning and threat detection APIs that can be integrated with Dynamics 365.

Further information

• Product and implentation information - via the Architecture Profession
• Contract information - Contracts team

Support

The Solution Delivery Team (SDT) within Digital and Technology can help anyone looking to create a service that needs CRM capabilities. SDT work through all stages of the development lifecycle - designing, building, supporting and maintaining systems. As a multidisciplinary team, they have both technical and delivery capabilities, and already support a number of CRMs and web applications.

There are 3 routes to providing delivery support:

• SDT can build the end-to-end system for you
• SDT can offer a blended model, where SDT offers part of a multidisciplinary team, with the remainder made up from business areas and/or contractors
• SDT can offer use of contracts with suppliers which SDT will provide oversight for, to ensure services are built using Departmental best practise. These contracts can also be utilised to spin-up a full delivery team.

With all of these delivery routes, SDT will ensure services are built to appropriate standards. This includes reuse of existing solutions where appropriate and ensures services are built in a standardised way, making ongoing maintenance and support easier.

SDT offer a standard support model for services they deliver. This includes:

• Service Level Agreements (SLAs) for incidents and requests, aligned to wider Digital and Technology directorate SLAs
• Incidents and requests handled through standard tooling
• A set amount of development days per year to support work requests (based on the criticality and complexity of your service), along with support in scoping and sizing requests to maximise the development time you have available
• Close working with Service Operations teams, to ensure service standards are maintained and ongoing service assurance is met, including Authority to Operate (AtO) and IT Healthchecks (ITHCs)

SDT have also set up a Dynamics Community of Practice, bringing together teams in the Department that are using Dynamics 365 in their services and projects. The community ensures ongoing conversations are taking place to standardise use of CRM products across the Department and ensure best practise is shared.

For more information, or if you’d like to talk through about options for CRM, please contact Iain McIntosh.

Contact Centre Technology Service (CCTS)

CCTS provides a shared contact centre telephony capability with associated services such as non-geographic numbers, Interactive Voice Response (IVR), call management, recording and reporting. It is currently used by the following DfE service lines.

• Ministerial and Parliamentary Communication Division (MPCD)
• Teachers Qualification Unit (TQU)
• DfE Service Desk
• ESFA Customer Services
• Human Resources
• Press Office
• Standards and Testing Agency (STA)

Initial (Phase 1) deployment of CCTS focused on providing core contact centre telephony capabilities. Future phases will focus on integration with other common components and delivery of additional communication channels as shown below.

Further guidance

Contact Mark Hubbard to find out more about CCTS.

Further guidance on common components

For more information on common components or to discuss adding your component to the repository, contact the architecture profession