GIAP (Get Information about pupils) is a replacement of the existing KtS (Key to Success) service that has been in operation for around 15 years. The GIAP service consists of a web application, a data pipeline, a database and set of Azure functions.
| Tool | StatusPage | Usage |
|---|---|---|
| GitHub | https://www.githubstatus.com | Source code, GitHub actions for CI/CD |
| Azure | https://status.azure.com | CIP Infrastructure |
| npm | https://status.npmjs.org | npm package restore |
| NuGet | https://status.nuget.org | dotnet package restore |
Related repositories
Clone the repository on your local machine in a suitable location
git clone https://github.com/DFE-Digital/get-information-about-pupilsGIAP has been developed using .NET Core so you will need an appropriate IDE (or text file browser if you wish). Either Visual Studio Code (with .NET C# support) or Visual Studio would be preferable, this was developed using Visual Studio 2019/2022.
Load the solution and build it (F5 or use the menu). Ensure Dfe.GIAP.WEB project is set as default and run the application.
GIAP-Web relies on a set of Azure Functions in the GIAP.AzureFunctions application, these then query Azure Cognitive Services/CosmosDB for data. The initial access is granted via DSI which provides authentication and authorisation to the application.
graph TD
X[DFE Sign-in] --> A
A --> X
A[GIAP Web] --- B[GIAP Azure Function]
B --- E[Azure BLOB storage]
B --- D[Azure Cognitive Search]
B --- C[Azure CosmosDB]
D --- C
GIAP web has a number of dependancies listed below, some are closed source, others are open.
- .NET 8
- node
- gulp
- DSI (DfE sign-in)
- CosmosDb Infrastructure library
Press Ctrl+Shift+B (if you are using Visual Studio) to build the project. To run all tests in Visaul Studio, select Tests from top menu and run all unit tests. Unit tests live in the Unit Test project folder and use XUnit, NSubstitute, and Moq. There exists testing projects for Common Layer, Service Layer, and Web Layer. Unit tests should be written in the form {TARGET CLASS OR MODULE}_{EXPECTED_OUTCOME}WHEN{CONDITION}
There are a number of key settings contained in the appsettings.json file. It is recommended to create an appsettings.local.json file to store values as they won't be checked into source control as .gitignore. An example is provided for reference, additionally a launchSettings.json is required in Properties.
launchSettings.json
{
"iisSettings": {
"windowsAuthentication": false,
"anonymousAuthentication": true,
"iisExpress": {
"applicationUrl": "https://localhost:44378",
"sslPort": 44378
}
},
"profiles": {
"IIS Express": {
"commandName": "IISExpress",
"launchBrowser": true,
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Local"
}
},
"DfE.GIAP.Web": {
"commandName": "Project",
"launchBrowser": true,
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Local"
},
"applicationUrl": "https://localhost:44378;http://localhost:5000"
}
}
}appsettings.local.json
{
"AppVersion": "2.Local",
"SessionTimeout": 20,
"IsSessionIdStoredInCookie": true,
"MaximumNonUPNResults": 100,
"MaximumNonULNResults": 100,
"MaximumUPNsPerSearch": 4000,
"DsiClientId": "dsi-client-id",
"DsiClientSecret": "dsi-client-secret",
"DsiApiClientSecret": "dsi-api-client-secret",
"DsiMetadataAddress": "dsi-metadata-address",
"DsiAuthorisationUrl": "dsi-authorisation-url",
"DsiRedirectUrlAfterSignout": "dsi-redirect-url-after-signout",
"DsiServiceId": "dsi-service-id",
"DsiAudience": "dsi-audience",
"StorageAccountName": "account-name",
"StorageAccountKey": "account-key",
"StorageContainerName": "container-name",
"NonUpnPPLimit": 4000,
"NonUpnNPDMyPupilListLimit": 100,
"UpnPPMyPupilListLimit": 4000,
"UpnNPDMyPupilListLimit": 4000,
"MaximumULNsPerSearch": 4000,
"CommonTransferFileUPNLimit": 10,
"MetaDataDownloadListDirectory": "AllUsers/Metadata",
"DownloadOptionsCheckLimit": 500,
"UseLAColumn": true,
"NpdUseGender": true,
"PpUseGender": false,
"FeUseGender": false,
"FeatureManagement": {
"FurtherEducation": true
},
"SecurityHeaders": {
"Remove": [
"Server",
"X-Powered-By"
],
"Add": {
"Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload",
"X-XSS-Protection": "0",
"X-Content-Type-Options": "nosniff",
"X-Frame-Options": "DENY",
"Content-Security-Policy": "default-src 'self';"
}
},
"GetUserProfileUrl": "http://localhost:7071/api/get-user-profile?code=",
"GetLatestNewsStatusUrl": "http://localhost:7071/api/get-latest-news-status?code=",
"DeleteNewsArticleUrl": "http://localhost:7071/api/delete-news-article?code=",
"DownloadPupilsByUPNsCSVUrl": "http://localhost:7071/api/download-pupils-by-upns-csv?code=",
"DownloadPupilsByUPNsTABUrl": "http://localhost:7071/api/download-pupils-by-upns-tab?code=",
"DownloadPupilPremiumByUPNFforCSVUrl": "http://localhost:7071/api/download-pupil-premium-by-upns-csv?code=",
"GetContentByIDUrl": "http://localhost:7071/api/get-content-by-id?code=",
"QueryLAByCodeUrl": "http://localhost:7071/api/get-la-by-code?code=",
"QueryLAGetAllUrl": "http://localhost:7071/api/get-la-all?code=",
"GetAcademiesURL": "http://localhost:7071/api/get-academies?code=",
"QueryNewsArticleUrl": "http://localhost:7071/api/get-news-article-by-id?code=",
"QueryNewsArticlesUrl": "http://localhost:7071/api/get-news-articles?code=",
"UpdateNewsDocumentUrl": "http://localhost:7071/api/update-news-document?code=",
"UpdateNewsPropertyUrl": "http://localhost:7071/api/update-news-article-property?code=",
"LoggingEventUrl": "http://localhost:7071/api/logging-event?code=",
"CreateOrUpdateUserProfileUrl": "http://localhost:7071/api/create-or-update-user-profile?code=",
"DownloadCommonTransferFileUrl": "http://localhost:7071/api/download-common-transfer-file?code=",
"DownloadSecurityReportByUpnUrl": "http://localhost:7071/api/download-security-report-by-upn-searches?code=",
"DownloadSecurityReportByUlnUrl": "http://localhost:7071/api/download-security-report-by-uln-searches?code=",
"DownloadSecurityReportDetailedSearchesUrl": "http://localhost:7071/api/download-detailed-searches?code=",
"DownloadSecurityReportLoginDetailsUrl": "http://localhost:7071/api/download-login-details?code=",
"DownloadPupilsByULNsUrl": "http://localhost:7071/api/download-further-education?code=",
"DownloadPrepreparedFilesUrl": "http://localhost:7071/api/pre-prepared-downloads?code=",
"PaginatedSearchUrl": "http://localhost:7071/api/get-page/{indexType}/{queryType}?code=",
"GetAllFurtherEducationURL": "http://localhost:7071/api/get-all-fe?code=",
"GetFurtherEducationByCodeURL": "http://localhost:7071/api/get-fe-by-code?code=",
"SetLatestNewsStatusUrl": "http://localhost:7071/api/set-latest-news-status?code=",
"FeatureFlagAppConfigUrl": "Endpoint="
}
giap-web has an build pipeline which runs on each commit.
The solution depends on the DfEDigital GitHub Packages NuGet Feed.
GIAP uses Application Insights to log auditing, warnings, and errors.
In this project, we have a Gulp task which combines the JS files and CSS files into a minified version. We’re using npm to install dependencies. We need to install Gulp globally. Assuming you have node and npm installed already.
npm install -g gulpThis installs it system wide as opposed to installing on a project-by-project basis. Gulp runner also compile Sass (for CSS styling) files into CSS. Unfortunately, SCSS won’t work out of the box. Some browsers don’t understand what SASS/SCSS syntax is, so we need to compile it down to a plain css file for them. The only library we need will be gulp-sass, so install it like this:
npm install gulp-sassYou may notice you have a package.json and package-lock.json file. This process also creates a node_modules directory within the solution folder.
gulp-sass: Sass is a preprocessor and to run in the browsers it needs to be compiled into css, that’s why we need gulp-sass, this gulp plugin will compile the Scss files into CSS. gulp-rename: this gulp plugin is useful if we want to change the extension file names.
The Gulp task runs behind the scenes when you compile your project.
Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.
The documentation is © Crown copyright and available under the terms of the Open Government 3.0 licence