Simprints Documentation
  • Introduction
    • Goals
    • Audience
    • Disclaimer
  • Product Overview
    • Product Overview
      • Simprints ID (SID)
        • Enrolment
        • Verification
        • Indentification
      • Biometrics
        • Fingerprints Recognition
          • Vero Fingerprint Scanners
        • Face Recognition
      • SID Intents Launcher
      • Cloud Backend
      • Data Collection Platforms
        • DHIS2
        • CommCare
        • ODK + Survey CTO
  • Architecture
    • System architecture
      • Mobile
        • Simprints ID (SID)
          • Project structure
          • Biometric flow orchestration
  • Installation
    • Installation, Quick Start and Device Requirements
      • Installation
      • Quick Start Guide
      • Device Requirements
  • Security & Privacy
    • Security & Privacy Considerations
      • Security Policy
      • Responsible Use
      • Privacy Policy
      • Cookie Policy
  • Development
    • Getting setup
    • Simprints for Developers
      • Simprints for Developers
      • Integrating with Simprints
        • Getting Started
        • Enrollment
        • Identification
        • Verification
        • Exit Forms
        • Confidence Score Bands
        • Enrolment & Identification +
        • Handling Errors
        • Metadata
      • Other Intergrations
        • ODK Integrations + SurveyCTO
          • Enrol
          • Identify
          • Verify
          • FAQ
        • CommCare Integration
          • CommCare: Enrolment
          • Identification
          • FAQs
          • ↔️CoSync
        • DHIS2
  • Troubleshooting
    • FAQs
    • Common Issues
  • Community & Support
    • Support Channels
    • Community Guidelines
    • Open Source Contributions
  • Product Roadmap
    • Product Roadmap
      • Current Releases
      • Previous Releases
      • Submit an Idea or Request
  • Licence
  • Contribution Guidelines
    • Contribution Guidelines
      • Code Contributions
      • Bug Reports
      • Feature Requests
  • Supporting Partners
Powered by GitBook
LogoLogo
On this page
  • Vulcan Configuration
  • CommCareHQ configuration

Was this helpful?

Edit on GitHub
  1. Development
  2. Simprints for Developers
  3. Other Intergrations
  4. CommCare Integration

CoSync

PreviousFAQsNextDHIS2

Last updated 9 months ago

Was this helpful?

Simprints offers two independent ways of synchronising data between devices:

  1. Simprints' own backend (a.k.a. BFSID) Data is synced up to Simprints' backend (currently built on the Google Cloud Platform) and then down to each device according to the project synchronisation settings.

  2. CoSync Data is returned back to the calling app (CommCare in this case) which takes care to synchronise it between devices according to its logic. Simprints ID can then read the data back when fulfilling identification requests.

Both synchronisation options are independent so they can be enabled together (to have double synchronisation) or only one of them can be selected.

Vulcan Configuration

To enable CoSync you have to open the projects 'Configurations' tab in and go the 'Synchronization' sub-tab. There you will find two dropdowns for 'Simprints sync' and 'Co sync'.

There are two types of data to be synchronised - analytics and biometrics. Analytics includes all the steps (both user- and app-driven) that were performed by Simprints ID. Biometrics is the biometric data of the enrolled subjects. For both Simprints and CoSync you can configure 'None', 'Only analytics', 'Only biometrics' and 'Everything' and any combination between the two is possible.

(Note: Analytics for CoSync are currently being revamped so are unavailable as of v2024.1.3 of Simprints ID)

In order to use CoSync for synchronising biometric data you need to select either 'Only biometrics' or 'Everything'.

CommCareHQ configuration

Saving the biometric data

In order to save the biometric data returned by Simprints ID you need to save the 'subjectActions' key from the enrolment callout response:

Providing biometric data to Simprints ID

In order for Simprints ID to use CommCare as the data source for biometric data for identification callouts they need to have an extra flag 'biometricDataSource' that's set to 'CommCare':

(Note: Reading biometric data from CommCare is only available from Simprints ID v2024.1.3 on)

Enrolment+ with CoSync

If you are going to use Enrolment+ together with CoSync then you need to set the biometricDataSource = 'CommCare' extra in the REGISTER callout (see ), too. This is so the biometric search before enrolling a subject uses CommCare as the data source.

↔️
section above
Vulcan