Case Admin Web

Web application for administration of Case Definition data (initially for importing definitions).

Overview

Express application that allows an authorised user to import Case Definitions in the form of an Excel spreadsheet.

Getting started

Prerequisites

• Node.js >= 18.17.0

Environment variables

The following environment variables are required:

Name	Default	Description
IDAM_BASE_URL	-	Base URL for IdAM's User API service (idam-app). http://localhost:5000 for the dockerised local instance or tunnelled dev instance.
IDAM_S2S_URL	-	Base URL for IdAM's S2S API service (service-auth-provider). http://localhost:4502 for the dockerised local instance or tunnelled dev instance.
IDAM_ADMIN_WEB_SERVICE_KEY	-	Case Admin Web's IdAM S2S micro-service secret key. This must match the IdAM instance it's being run against.
IDAM_LOGOUT_URL	-	URL of the IdAM Authentication Web logout page. https://localhost:3501/login/logout for the dockerised local instance.
IDAM_OAUTH2_TOKEN_ENDPOINT	-	URL of the IdAM OAuth2 API endpoint for obtaining an OAuth2 token. http://localhost:5000/oauth2/token for the dockerised local instance or tunnelled dev instance.
IDAM_OAUTH2_AW_CLIENT_SECRET	-	Secret to be passed to IdAM when obtaining an OAuth2 token. This must match the IdAM instance it's being run against.
ADMINWEB_LOGIN_URL	-	URL of the IdAM Authentication Web login page. https://localhost:3501/login for the dockerised local instance.
ADMINWEB_IMPORT_URL	-	URL of the Case Definition Store API import endpoint. http://localhost:4451/import for the dockerised local instance.
ADMINWEB_UPLOAD_DICTIONARY_FILE_PATH	-	Path to local dir for upload.
APPINSIGHTS_INSTRUMENTATIONKEY	-	Secret for Microsoft Insights logging, can be a dummy string in local.

Building

The project uses yarn. To build it, execute the following command:

yarn install

Setup styles:

yarn setup

Running

Start the application by executing the following command:

yarn start

To be able to log on and use the application you have to have a IDAM user with ccd-import role created.

Note: You can also start the application by executing:

node server.js

Accessing the service

The application uses HTTP, port 3100 by default. Point your browser at http://localhost:3100 to login.