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. About certificate files
  • 2. Before your start
  • 3. Build your certificate
  1. Setup
  2. 3. Installation
  3. 3.2 Set-up your own country configuration

3.2.6 Configure certificate templates

Previous3.2.5.1 Configuring Metabase DashboardsNext3.2.7 Configure declaration forms

Last updated 1 year ago

1. About certificate files

The next step is for you to design and configure your certificate template files. Your certificates will be different files for each vital event. You use {{ }} syntax to mark where in the SVG you wish the citizen data to be rendered. To get an idea of what we mean, take a look at the Farajaland example certificates and available handlebars for each event:

Event
Certificate template SVG
Available handlebars

Birth

Death

Marriage

It is possible to make custom form fields and when you do, custom handlebars are automatically created. Like .

2. Before your start

  • You can you use any paper size you like as a basis for your SVG.

  • We recommend that you use the multi-lingual font as we do in our certificate for the dynamically generated data that appears from handlebars. All other fonts should be outlined. If you really wish to use another font than Noto Sans, you can edit the font .

  • To render a digital signature for a registrar that is uploaded when , you need to use an image tag syntax like , and then .

3. Build your certificate

  1. Gather requirements Define what data needs to be on your certificate and collect the certificate handlebars you need. We have supplied helper handlebars for all use cases. Some need explanation, or if you feel that you do not have a handlbar for your specific needs, please discuss with us on or email us at and we can work on a new handlebar for you. As an example of a handlebar that needs explanation: {{placeOfBirth}} is used if a user selects a pre-loaded . This handlebar dynamically returns the location hierarchy, e.g. "district, state" to render based on the location of the . You can see that in our place of birth location in the SVG, we have to handle whatever the user chooses to enter into the form.

  2. Design your certificate! Place dummy text for for where you would like handlebar data to appear and use a dummy signature image where you would like the digital signature to appear.

  3. Export to SVG When you have finalised your design you need to export to SVG. Important! If your using Figma make sure to uncheck 'Outline text' for the handlebar dummy text. All other fonts can be outlined.

  4. Add handlebars Open the SVG in a text editor tool such as Visual Studio Code. Replace the dummy text you added with the handlebar. Example: <text fill="#222222" xml:space="preserve" style="white-space: pre" font-family="Noto Sans-Bold" font-size="16" font-weight="bold" letter-spacing="0px"><tspan x="86.6699" y="444.268">{{eventDate}}&#10;</tspan></text>\

  5. Seed, or upload and preview When you are ready to seed your database in , these certificates will be uploaded. Alternatively, a National System Admin can upload the certificate template at any time in the functional configuration UI. You can preview the certificate to check that the some handlebar data is loading as intended. Please note that in our preview functionality, only a few handlebars work with a dummy registration that contains the most basic data. It is for illustration purposes only as you may configure your form in an entirely custom way.

SVG
SVG
handlebar
this
Noto Sans
here
managing users
this
this
Github
team@opencrvs.org
health facility
health facility
if/else logic
step 3.2.8
Birth Certificate
Default birth handlebars
Death Certificate
Default death handlebars
Marriage Certificate
Default marriage handlebars