Manage your education and skills funding - Audit API

Introduction

Audit API provides a single shared service to audit events in "Manage your education and skills funding". This is a BETA version and is currently used only by a limited number of components.

Getting Started

This is a self-contained Visual Studio 2019 solution containing a number of projects (web application, service and repository layers, with associated unit test and integration test projects). To run this product locally, you will need to configure the list of dependencies, once configured and the configuration files updated, it should be F5 to run and debug locally.

Installing

Clone the project and open the solution in Visual Studio 2019.

List of dependencies

Item	Purpose
SQL database	Audit storage

SQL (Azure) Database

You can choose any of the following for local development

• Microsoft SQL Server Express
• Microsoft SQL Server
• SQL Azure

In reality we would recomend using MS SQL express for local development.

Local Config Files

Once you have cloned the public repo you need the following configuration files listed below.

Location	config file
Pds.Shared.Audit.Api	appsettigns.development.json

The following is a sample configuration file

{
    "ConnectionStrings": {
        "audit": "Server=replace_db;Database=replace_dbname;Trusted_Connection=True;"
    },
    "Authentication": {
        "Instance": "replace_azure_active_directory_instance",
        "TenantId": "replace_azure_active_directory_tenantId",
        "ClientId": "replace_azure_active_directory_clientid"
    },
    "AllowedHosts": "*",
    "Logging": {
        "LogLevel": {
            "Default": "Information"
        }
    }
}

The following configurations needs to be replaced with your values.

Key	Token	Example
ConnectionStrings.audit	replace_db	(local)
ConnectionStrings.audit	replace_dbname	AuditDb
Authentication.Instance	replace_azure_active_directory_instance	https://localhost/
Authentication.TenantId	replace_azure_active_directory_tenantId	empty_string
Authentication.ClientId	replace_azure_active_directory_clientid	empty_string

API references

Install and configure project to run locally, F5 to start the instance which should by default display Open API documentation, it can be found at https://localhost:44389/swagger.

Build and Test

This API is built using

• Microsoft Visual Studio 2019
• .Net Core 3.1

To build and test locally, you can either use visual studio 2019 or VSCode or simply use dotnet CLI dotnet build and dotnet test more information in dotnet CLI can be found at https://docs.microsoft.com/en-us/dotnet/core/tools/.

Configuring for release

In addition to development configuration, this API requires additional configuration for release environment, the following provides a sample config that you will need to configure.

{
    "ConnectionStrings": {
        "audit": "Server=replace_db;Database=replace_dbname;Trusted_Connection=True;"
    },
    "Authentication": {
        "Instance": "replace_azure_active_directory_instance",
        "TenantId": "replace_azure_active_directory_tenantId",
        "ClientId": "replace_azure_active_directory_clientid"
    },
    "AllowedHosts": "*",
    "PdsApplicationInsights": {
        "InstrumentationKey": "replace_application_insights_instrumentationkey",
        "Environment": "replace_environment"
    },
    "Logging": {
        "ApplicationInsights": {
            "LogLevel": {
                "Default": "Information",
                "Microsoft": "Error"
            }
        },
        "LogLevel": {
            "Default": "Information"
        }
    }
}

The following configurations needs to be replaced with your values.

Key	Token	Example
ConnectionStrings.audit	replace_db	SQL Server or SQl Azure server instance
ConnectionStrings.audit	replace_dbname	AuditDb
Authentication.Instance	replace_azure_active_directory_instance	https://login.microsoftonline.com/
Authentication.TenantId	replace_azure_active_directory_tenantId	Valid azure active directory tenant id
Authentication.ClientId	replace_azure_active_directory_clientid	Valid application id in azure active directory
PdsApplicationInsights.InstrumentationKey	replace_application_insights_instrumentationkey	Valid azure application instance instrumentation id
PdsApplicationInsights.Environment	replace_environment	Any string to identify your environment e.g. LocalDevelopment

Contribute

To contribute,

• If you are part of the team then create a branch for changes and then then submit your changes for review by creating a pull request.
• If you are external to the organisation then fork this repository and make necessary changes and then submit your changes for review by creating a pull request.