Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Target release

Type // to add a target release date

Epic

Type /Jira to add Jira epics and issues

Document status

DRAFT

Document owner

@ mention owner

Designer

@ designer

Tech lead

@ lead

Technical writers

@ writers

QA

🎯 Objective

  • To automate the process of uploading photos of examination candidates to HikCentral.

\uD83D\uDCCA Success metrics

Goal

Metric

Check if the students have exam before uploading the photos to HikCentral

  • Allow the students to enter exam hall when there is exam scheduled

  • Avoid unnecessary or prohibited entry

Transfer photos from S3 to HikCentral automatically and as scheduled

Save time and manpower

\uD83E\uDD14 Assumptions

  • Accepted formats of student photos: PNG, JPEG, JPG

  • The photos in S3 are saved in format “{StudentId}.png“

  • All students who have exam, must have photos in S3 ready

\uD83D\uDDD2 Requirements

Requirement

Notes

Get the list of students who have exam on the present week

The data should include: Student ID, Enrolment Date, Completion Date

Retrieve photos from S3 based on the students list

  • The photos' filenames are the Student ID

  • Accepted formats of student photos: PNG, JPEG, JPG

Insert the photos into HikCentral via OpenAPI

  • The photos will be saved in HikCentral, with the following specifications

    • ID: Student ID

    • First Name: Student ID

    • Last Name: “APU“

    • Department: “APU“

    • BeginTime: Enrolment Date

    • endTime: 1 year after Completion Date

    • faceData: Photo encoded in Base64

  • The function will send photo into HikCentral via OpenAPI, one photo per request.

  • If the student ID’s photo already exists, the insertion will be skipped.

Resources used by the backend system:

  • Python v3.11.6

  • OracleDB View

  • S3 - Student Photos

  • HikCentral Professional Server and OpenAPI

Each of the request sent for HikCentral OpenAPI requires authentication header, please refer to HCP OpenAPI's Headers Configuration

For guidance on HikCentral, please refer to https://tpp.hikvision.com/tpp/Training. This website contains Support Ticket Form for assistance purposes.

\uD83C\uDFA8 User interaction and design

AWS Architecture Diagram

Flow Chart

(question) Open Questions

Question

Answer

Date Answered

(warning) Out of Scope

  • No labels