DIGIT Works
PlatformDomainsAcademyDesign SystemFeedback
Works v1.1
Works v1.1
  • Introducing Works
    • What's New
  • Design Approach
    • Approach
    • Solution Design
  • Specifications
    • Functional Specifications
      • Project
      • Estimates
      • Organisation
      • Attendance Management
      • Measurements
      • Muster Roll
      • Expenditure / Billing
      • Contracts
    • Release Notes
      • MDMS & Configuration Updates
      • Test cases
      • Data Migration
      • Service Build Updates
  • Reference Implementations
    • MUKTASoft v2.1
    • MUKTASoft v2.2
      • Specifications
        • Roadmap
        • User Persona
        • Functional Requirements
          • Product Requirements Document v2.0
          • Product Requirements Document v2.1
            • Employee Mobile Application
            • Aadhaar Integration
            • Estimate Templates
            • SOR Rate Analysis
          • User Stories
            • Time Extension
              • CBO: Create Time Extension
              • Time Extension Workflow
              • EMP: Create Time Extension
              • Search and View Time Extension
              • CBO: My Requests
              • CBO: Edit Time Extension
            • JIT-FS Integration
              • Fund Allocation Register
              • Create Payment Instruction
              • PIS: Payment Instruction Status
              • PAG: Payment Advice Status
              • PD: Update payment details
              • FD: Update Failed Payments
              • Create Revised Payment Instruction
              • Revised PI: Update payment details
              • Revised PI: Updated Failed Payments
              • Search Payment Instruction
              • View Payment Instruction
            • Work Order
              • Create Work Order
              • Work Order Workflow
              • Work Order Inbox Page
              • Create/ Submit Work Order
              • Edit/Submit Work Order
              • Verify & Forward
              • Send Back
              • Send Back To Originator
              • Reject Work Order
              • Approve
              • Search Work Order
              • Work Order PDF
            • Dashboard v1.0
              • Commons
              • KPIs: Actions Items
              • KPIs: SLA Breached
              • KPIs: Leaderboard
              • KPIs: Activities by Status
              • KPIs: Payments
              • KPIs: Expenditure
            • Schedule of rates
              • Create SOR
              • Search SOR
              • View SOR
              • Modify SOR
              • Add/ Modify Rate
            • Detailed Estimate
              • Create Detailed Estimate
              • Change in workflow
              • Change in edit estimate
              • Search and View Detailed Estimate
            • Detailed MB
              • Create MB
              • MB Inbox
              • MB Workflow
              • Search MB
              • View MB
              • Edit MB
            • Employee Mobile Application
              • Employee Login
              • Home Page
              • Work Orders
              • Create/ Edit MB
              • Measurement Books
              • View Measurement Book
            • Aadhar Integration
              • Wage Seeker's Registration
              • Wage Seeker Modification
            • Improvements
              • Moving Skills to SOR Master
              • Re-payment of failed payment
              • Revising estimate calculation logic
              • Material purchase payment to CBO
            • Estimate Template
              • Create Template
              • Search Template
              • View Template
              • Modify Template
              • Change in estimate to add template
            • Rate Analysis
              • Add/ Edit Rate Analysis
              • View Rate Analysis
              • Revising Rate
              • Analysis Statements
              • Utilization Statements
              • Download of analysis statements
            • Data Protection & Privacy
              • Display Privacy Notice In Login
              • Display Bank Account Details On Wage Bill
              • Display Muster Roll Details
              • View Payment Instruction - Mask Account Number & IFSC
              • View /Edit Wage Seeker Details
              • View/Edit Organisation Details
              • Display Engaged Wage Seeker Details
              • Display Organisation Profile & Bank Details
              • Track Attendance Changes
              • View Muster Rolls
              • Search Wage Seeker
              • Remove PII & Sensitive Data From Additional Fields
      • Deployment
        • Release Notes
          • Service Build Updates
          • Data Migration
          • Test Cases
        • Deployment Guide
        • SMS Adapter Services
          • Notification Consumer
          • Notification Consumer Service
          • Contact Notification Service
          • Estimate Notification
          • Expense Notification Service
          • Muster Roll Notification Service
          • Measurement Notification Service
          • Organisation Notification Service
          • Individual Notification Service
        • MUKTASoft Services
          • IFMS Adapter
          • Expense Calculator
          • Works PDF
          • MUKTA Services
          • Bank Account Search
          • Individual Search
          • Organisation Search
          • Bill Scheduler
          • Statements
          • Rate Analysis
        • Configuration
          • Master Data Templates
            • Project Type
            • Target Demography
            • Unit Of Measurement (Units)
            • Overheads
            • Skill Category & Skills
            • Community-Based Organisation Roles
            • Scheme
            • Expense Heads
            • Standard Deductions
            • Organisation Type
            • Organisation Sub Type
            • Organisation Functional Category
            • Organisation Class/Rank
            • HRMS Sections/Departments
            • HRMS Designation
            • HRMS Employment Type
            • User Role
            • Organization
            • Wage Seeker
            • Tenants
            • Ward Boundary
            • Locality Boundary
            • Payment Advice Format
            • Users Data
            • Schedule of rates
            • Rate Analysis
          • Notifications & SMS Templates
          • Localisation
          • Dashboard Reindexing
          • Platform Service Configuration
          • UI Configuration
            • Common Configurations
              • Role Configuration
              • MDMS Configuration
              • APK Generation
            • Modules
              • Project
              • Estimate
              • Workorder
                • Time Extension
              • Muster Roll
              • Bill
              • Organization
              • Wage Seeker
              • Wage Seeker (CBO Application)
              • Attendance (CBO Application)
              • Muster Roll (CBO Application)
              • Mukta Dashboard
              • Measurement
              • SORs and Rates
              • IFMS Adapter UI
              • Rate Analysis
              • Revision Of Rates
              • Estimate Template
              • Measurement Book (Mobile Application)
        • Customisation
          • Works UI
            • UI Tech Flow Diagrams
          • UI Screens Customisation
            • Document Upload Container
            • CSS Customisation
            • Inbox/Search Screen
      • Implementation
        • Pilot Roll Out Plan
        • Pilot Go Live Definition
        • Pilot Sucess Metrics
        • Success Metrics
        • Adoption Metrics
        • Adoption Template
        • Implementation Plan & Checklist
        • Issue Management - Standard Operating Procedures
        • Training Resources
          • User Manual
            • Mobile Application User Manual
              • CBO - Getting Started
                • My Works
                • Track Attendance
                • Muster Rolls
                • My Bills
                • My Requests
              • Employee - Getting Started
                • Work Orders
                • Measurement Books
            • Web Application User Manual
              • Getting Started
              • Project
              • Estimate
              • Work Order
              • Time Extension
              • Measurement Book
              • Muster Roll
              • Billing
              • Payments
              • Rates Revision
              • Registries
                • Wage Seekers
                • Organizations
                • Schedule Of Rates
                  • SOR Definition
                  • Rates
                  • Rate Analysis
                • Estimate Template
            • Kibana Dashboard User Manual
          • Training Videos
        • UAT Planning
          • UAT Test Case Scenarios
          • UAT Schedule Plan
          • Issue Reporting Template
          • UAT Credentials
  • Platform
    • Architecture
      • High Level Design
      • Low Level Design
        • Registries
          • Individual
          • Bank Account
          • Organization
        • Services
          • Project
          • Detailed Estimates
          • Contracts
          • Attendance
          • Muster Roll
          • Expense
          • Schedule of Rates (archive)
          • Detailed Measurement Book
  • Setup
    • Install Works
      • Install Using GitHub Actions In AWS
      • System Data Setup
    • Configure Works
      • Service Configuration
        • Project
        • Estimate
        • Contract
        • Attendance
        • Muster Roll
        • Expense
        • Bank accounts
        • Organisation
        • Individual
        • Estimate Template
  • General
    • Source Code
    • Roadmap
    • Discussion Board
    • Issues
Powered by GitBook

All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.

On this page
  • Overview
  • Pre-requisites
  • Functionality
  • Deployment Details
  • Configuration Details
  • Configure Actions
  • Configure Roles
  • Configure Role-Action
  • Idgen Configuration
  • Persister
  • Integration Details

Was this helpful?

  1. Setup
  2. Configure Works
  3. Service Configuration

Attendance

Overview

The attendance service provides generic attendance logging functionality for recording "in" and "out" timestamps for individuals. These timestamps are logged on a per-individual basis. The muster roll service takes on the responsibility of aggregating and calculating attendance based on these recorded timestamps. It processes and computes attendance data using these individual "in" and "out" timestamps to provide a comprehensive view of attendance records.

Pre-requisites

A running DIGIT platform is needed to deploy the attendance service. Specifically, the following dependencies are needed:

  • Individual

  • MDMS

  • Idgen

  • Persister

  • Indexer

Functionality

Provides APIs to:

  • Create an attendance register

  • Map staff to the register

  • Map attendees to the register

  • Log attendance

  • Edit attendance registers, staff, attendees and attendance.

Code

Base URL: /attendance/v1/

Deployment Details

Below are the variables that should be configured for the contract service in the Helm environment file before deployment. The below path is used to locate the Helm environment file.

https://github.com/{{ORG}}/DIGIT-DevOps/deploy-as-code/helm/environments/{{EnvironmentFile}}.yaml

  • Add these ‘db-host’,’db-name’,’db-url’, ’domain’ and all the digit core platform services configurations (Idgen, workflow, user etc.) in respective environments YAML file.

Restart egov-mdms-service, egov-persister, egov-indexer, inbox, egov-workflow-v2, egov-accesscontrol and ZUUL services after the above changes are performed.

Configuration Details

Configure Actions

Add all the APIs exposed by the attendance service (refer to the table below for actual APIs) to the actions.json file in MDMS

Module name: ACCESSCONTROL-ACTIONS-TEST

Master name: actions-test

Configure Roles

Configure roles based on the roles column below in roles.json file.

Module name: ACCESSCONTROL-ROLES

Master name: roles

Configure Role-Action

Role-action mapping is configured in MDMS per the table below .

Module name: ACCESSCONTROL-ROLEACTIONS

Master name: roleactions.json

Roles
APIs /Actions
  • ORG_ADMIN

  • JUNIOR_ENGINEER

  • MUNICIPAL_ENGINEER

/attendance/v1/_create

  • ORG_ADMIN

  • JUNIOR_ENGINEER

  • MUNICIPAL_ENGINEER

/attendance/v1/_update

  • ORG_ADMIN

  • JUNIOR_ENGINEER

  • MUNICIPAL_ENGINEER

/attendance/v1/_search

  • ORG_ADMIN

  • ORG_STAFF

/attendance/staff/v1/_create

  • ORG_ADMIN

  • ORG_STAFF

/attendance/staff/v1/_delete

  • ORG_ADMIN

  • ORG_STAFF

/attendance/attendee/v1/_create

  • ORG_ADMIN

  • ORG_STAFF

/attendance/attendee/v1/_delete

  • ORG_ADMIN

  • ORG_STAFF

/attendance/log/v1/_create

  • ORG_ADMIN

  • ORG_STAFF

/attendance/log/v1/_search

  • ORG_ADMIN

  • ORG_STAFF

/attendance/log/v1/_update

Idgen Configuration

IDGen format for attendance register number

{

"format": "WR/[fy:yyyy-yy]/[cy:MM]/[cy:dd]/[SEQ_ATTENDANCE_REGISTER_NUM]",

"idname": "attendance.register.number"

}

Persister

Integration Details

Base Path:

/attendance/

PreviousContractNextMuster Roll

Was this helpful?

Refer to the .

Add attendance-service related environment variables’ value like the way it's done in the’ environment YAML file.

Add the ‘’ related configuration to the respective environment YAML file. Make sure you change the gitsync.branch name.

Check the attendance-service persister file is added in the egov-persister.perister-yml-path variable. If not, follow the steps outlined.

Make sure to add the DB(Postgres and flyway) username & password in the respective environment secret YAML file as per the steps given.

Make sure to add the DIGIT core services-related secrets that are configured in the respective environment secret file the way it's done.

Make sure the id format is configured in the file of the common-masters module in MDMS.

Make sure that the file is present in the MDMS repository of the organisation: https://github.com/{{ORG}}/works-configs/tree/<BRANCH>/egov-persister

Sample are here to demonstrate integration with the attendance service.

Module code
sample here
‘dev
https://github.com/egovernments/DIGIT-DevOps/blob/digit-works/deploy-as-code/helm/environments/works-dev.yaml#L77
https://github.com/egovernments/DIGIT-DevOps/blob/digit-works/deploy-as-code/helm/environments/works-dev.yaml#L189
https://github.com/egovernments/DIGIT-DevOps/tree/digit-works/deploy-as-code/helm/charts/digit-works/backend/attendance-service
egov-mdms-service
here
here
here
IdFormat.json
attendance-service-persister.yml
postman collections
API spec