search

avniproject / integration-service

Service for integration Avni with other systems
GNU Affero General Public License v3.0
0 stars 2 forks source link

Add Readme Documentation on Avni-Goonj Integration #81

Closed himeshr closed 8 months ago

himeshr commented 1 year ago

Tasks:

  1. General information about integration-service Design:

    • Why mappings are required in integration service? / Why can’t system identify on itself
    • what happens when integration service encounters an error, stops or continue? Is this behaviour different across integrations?
    • How fresh records sync in integration service works.?
    • How error processing happens.?
    • How frequently the service runs - Is it configurable?

  2. Add Readme Documentation to give basic intrdouction on Avni-Goonj Integration.

    • Goonj
    • Current System Using Papers and forms
    • Challenges with old system
    • Why use Avni
    • Various subject and encounter types
    • Source locations and sync frequency and constraints
    • Integration config
    • Challenges faced with integration work (Locations, Mapping, forms reconfiguration)
    • Major Avni functionalities used in this integration
    • Mapping metadata, groups and types and the logic used for transformation of data between the 2 systems
    • Different entity sync pipelines
    • Direct updates done by Salesforce on Avni
    • Health Checks and Error Record Reports
    • Recovery from errors
    • Sync frequency (main and error jobs)
    • Future scale and growth opportunities (Filter and fetch by States / Accounts)

  3. Add Readme Documentation on how to handle Errors in Avni-Goonj Integration.

    • Document error types managed by two parties, Party background intro, steps to resolve, etc.. in Readme

Google sheet link for ErrorTypes is available at https://docs.google.com/spreadsheets/d/1qw9DLEaBS7o0Svc0TYUztj8n6UjzO7iQTONDhbIbI44/edit?usp=sharing

  1. Create solutions for handling Support for Goonj
  2. Add guide on special functionalities to be validated during regression for Goonj
  3. Add process to be followed by implementation team to develop on goonj organisation
  4. Create guide to be used by Goonj team to understand Avni-Salesforce Integration error monitoring
mahalakshme commented 11 months ago

@himeshr I ve moved this to Ready. Let me know if you think otherwise. Want to do some documentation cards as part of every release.

himeshr commented 8 months ago

Work output documentation file is available here

himeshr commented 8 months ago

No QA required for this.