OpenCRVS
v1.3
v1.3
  • 👋Introduction
  • Product Specifications
    • Functional Architecture
    • Workflow management
    • Status Flow Diagram
    • Users
      • Examples
    • Core functions
      • 1. Notify event
      • 2. Declare event
      • 3. Validate event
      • 4. Register event
      • 5. Print certificate
      • 5. Issue certificate
      • 6. Search for a record
      • 7. View record
      • 8. Correct record
      • 9. Verify record
      • 10. Archive record
      • 11. Vital statistics export
    • Support functions
      • 10. Login
      • 11. Audit
      • 12. Deduplication
      • 13. Performance management
      • 14. Payment
      • 15. Learning
      • 16. User support
    • Admin functions
      • 17. User management
      • 18. Comms management
      • 19. Content management
      • 20. Config management
    • Data functions
      • 21. Legacy data import
      • 22. Legacy paper import
  • Technology
    • Architecture
      • Performance tests
    • Standards
      • FHIR Documents
        • Event Composition
        • Person
        • Registration Task
        • Event Observations
        • Locations
    • Security
    • Interoperability
      • Create a client
      • Authenticate a client
      • Event Notification clients
      • Record Search clients
      • Webhook clients
      • National ID client
      • FHIR Location REST API
      • Other ways to interoperate
  • Default configuration
    • Intro to Farajaland
    • Civil registration in Farajaland
    • OpenCRVS configuration in Farajaland
      • User / role mapping
      • Application settings
      • Declaration forms
      • Certificate templates
    • Business process flows in Farajaland
  • Setup
    • 1. Establish team
    • 2. Gather requirements
    • 3. Installation
      • 3.1 Set-up a local development environment
        • 3.1.1 Install the required dependencies
        • 3.1.2 Install OpenCRVS locally
        • 3.1.3 Starting and stopping OpenCRVS
        • 3.1.4 Log in to OpenCRVS locally
        • 3.1.5 Tooling
      • 3.2 Set-up your own country configuration
        • 3.2.1 Fork your own country configuration repository
        • 3.2.2 Set up administrative address divisions
          • 3.2.2.1 Prepare source file for administrative structure
          • 3.2.2.2 Prepare source file for statistics
        • 3.2.3 Set up CR offices and Health facilities
          • 3.2.3.1 Prepare source file for CRVS Office facilities
          • 3.2.3.2 Prepare source file for health facilities
        • 3.2.4 Set up employees & roles for testing or production
          • 3.2.3.1 Prepare source file for employees
          • 3.2.3.2 Configure role titles
        • 3.2.5 Set up application settings
          • 3.2.5.1 Configuring Metabase Dashboards
        • 3.2.6 Configure certificate templates
        • 3.2.7 Configure declaration forms
          • 3.2.7.1 Configuring an event form
        • 3.2.8 Seeding your local development environment database
          • 3.2.8.1 Clearing your local development environment database
        • 3.2.9 Countryconfig APIs explained
          • 3.2.9.1 Managing language content
      • 3.3 Set-up a server-hosted environment
        • 3.3.1 Provision your server nodes with SSH access
        • 3.3.2 Provision environment
        • 3.3.3 Provision a comms gateway
        • 3.3.4 Set up an SMTP server for OpenCRVS monitoring alerts
        • 3.3.5 Setup DNS A records
        • 3.3.6 Deploy (Automated & Manual)
        • 3.3.7 Seeding & clearing data on a server
        • 3.3.8 Automated & manual backup and manual restore
    • 4. Functional configuration
      • 4.1 Configure application settings
      • 4.2 Configure registration periods and fees
      • 4.3 Create new user roles
      • 4.4 Managing system users
    • 5. Testing
    • 6. Go-live
    • 7. Monitoring
      • 7.1 Application logs
      • 7.2 Infrastructure health
      • 7.3 Routine monitoring checklist
      • 7.4 Setting up alerts
      • 7.5 Managing a Docker Swarm
  • General
    • Contributing
    • Releases
      • v1.3.5: Release notes
      • v1.3.4: Release notes
      • v1.3.2: Release notes
      • v1.3.1: Release notes
      • v1.3.* to v1.3.* Migration notes
      • v1.3.0: Release notes
      • v1.2.* to v1.3.* Migration notes
        • v1.2 to v1.3: Form migration
      • v1.2.1: Release notes
      • Patch: Elasticsearch 7.10.2
      • v1.2.0: Release notes
      • v1.1.* to v1.2.* Migration notes
      • v.1.1.2: Release notes
      • v.1.1.1: Release notes
      • v1.1.0: Release notes
    • Interoperability roadmap
    • Product roadmap
Powered by GitBook
On this page
  1. Setup
  2. 3. Installation
  3. 3.2 Set-up your own country configuration
  4. 3.2.4 Set up employees & roles for testing or production

3.2.3.1 Prepare source file for employees

Previous3.2.4 Set up employees & roles for testing or productionNext3.2.3.2 Configure role titles

Last updated 1 year ago

Prepare your default-employees source file. This is a file for every employee who will have initial access to OpenCRVS. You can import and create csv files in Excel or Google Drive.

In development/staging or QA environments, these users will be created in an "active" state and will not be required to change their password nor be required to set up reset authentication credentials security questions when logging in. This makes the quality assurance process easier. In development/staging and QA environments, all of these users will be able to submit a test 2FA code of six zeros: "000000" when logging in.

In production environments, these users will be created in an "pending" state and will be required to change their password and set up reset authentication credentials security questions when logging in. 2FA codes will be delivered to the users email address.

All of these users will be able to sign in to OpenCRVS initially with the same test password as documented in the csv. This is a temporary password but nevertheless it is saved in Git repositories.

For this reason we strongly recommend that in production the list only contains a National System Admnistrator who can immediately update their password when logging in the first time to something stronger. When creating users in production through the OpenCRVS UI, the system generates random unique passwords for all new users and they receove these passswords in an email invite.

Using our file as an example, you can create employees with all possible roles to quality assure your OpenCRVS instance, or just a single National System Admin role. Our test-employees.csv file looks like this:

primaryOfficeId
givenNames
familyName
systemRole
role
mobile
username
email
password

CRVS_OFFICE_JWMRGwDBXK

Kalusha

Bwalya

FIELD_AGENT

Social Worker

0911111111

k.bwalya

kalushabwalya@gmail.com

test

CRVS_OFFICE_JWMRGwDBXK

Felix

Katongo

REGISTRATION_AGENT

Registration Agent

0922222222

f.katongo

felixkatongo@gmail.com

test

CRVS_OFFICE_JWMRGwDBXK

Kennedy

Mweene

LOCAL_REGISTRAR

Local Registrar

0933333333

k.mweene

kennedymweene@gmail.com

test

Do not change or re-format the header row as the code requires these names to be precise in order to parse the csv. Do not use commas in any cell and do not have any empty rows.

  • Each row will represent a unique "user" in your country.

  • Do not change or re-format the header row as the code requires these names to precise in order to parse the csv. All data in the csv must contain no commas.

  • The primaryOfficeId column is the identifier for the civil registration office where the user will be located. Notice that the format is "CRVS_OFFICE_<office id>". For example, all of these users aove will be created in Ibombo District Office

  • The givenNames column must be the users' first names separated by using a space.

  • The familyName column must be the users' first names separated by using a space.

  • The systemRole column must be set to one of the following supported system roles only, and this defines user permissions:

FIELD_AGENT

REGISTRATION_AGENT

LOCAL_REGISTRAR

LOCAL_SYSTEM_ADMIN

NATIONAL_SYSTEM_ADMIN

NATIONAL_REGISTRAR

PERFORMANCE_MANAGEMENT

  • The role column can be any text value to represent the public facing role title for this individual.

  • The mobile column must contain a mobile number without your country code. Ensure that the mobile number validates using whatever phone number regular expression that you intend to use in section 3.2.9 Set up initialisation settings. You can ignore this if you are not using phone numbers as a method of communication.

  • The username column must be a unique username that the user will use to authenticate with when logging in.

  • The email column must contain a valid email address

  • The password column will be the password used for initial login. Refer to the note above.

You can upload transparent PNGs to use for any user's signature at any time by editing the user in the "Team" section of OpenCRVS UI.

It is configurable that some users have their signatures digitally printed onto certificates. Usually this is the case for LOCAL_REGISTRAR or NATIONAL_REGISTRAR user types. can be used to create a transparent PNG if you do not have access to any other image editing software. There are many free websites you can find to convert a PNG image file to base64 text, such as .

csv
default-employees.csv
This website
this one