This service is part of the Single Front Door (SFD) service.
REST API Object processor for the Single Front Door (SFD) service. This service provides endpoints to persist and retrieve metadata relating to uploaded files to support the Single Front Door project.
The service works alongside the CDP Uploader. If the upload request to the CDP Uploader is made using the object processor as the callback route the service receives the payload and persists the metadata to the database.
- Persist metadata after upload ✅
- Retrieve metadata about uploaded files (in development) 🏗️
- Push metadata to CRM (future work) 🗓️
- Docker
- Docker Compose
- Node.js (v22 LTS)
We recommend using the fcp-sfd-core repository for local development. You can however run this service independently by following the instructions below.
Container images are built using Docker Compose, with the same images used to run the service with either Docker Compose or Kubernetes.
When using the Docker Compose files in development the local app folder will
be mounted on top of the app folder within the Docker container, hiding the CSS files that were generated during the Docker build. For the site to render correctly locally npm run build must be run on the host system.
By default, the start script will build (or rebuild) images so there will rarely be a need to build images manually. However, this can be achieved through the Docker Compose build command:
# Build container images
docker-compose build
Use Docker Compose to run service locally.
docker-compose up --build
The tests have been structured into subfolders of ./test as per the
Microservice test approach and repository structure
A convenience npm script is provided to run automated tests in a containerised
environment. This will rebuild images before running tests via docker-compose,
using a combination of compose.yaml and compose.test.yaml.
To run the tests:
npm run docker:test
You can also run the tests directly using docker compose:
docker compose -f compose.yaml -f compose.test.yaml run --rm "fcp-sfd-object-processor"
THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:
http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3
The following attribution statement MUST be cited in your products and applications when using this information.
Contains public sector information licensed under the Open Government license v3
The Open Government Licence (OGL) was developed by the Controller of His Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.
It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.