Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update OpenSRP to download resources referenced on the Composition.focus and Composition.entry attributes #3617

Open
1 of 2 tasks
dubdabasoduba opened this issue Nov 16, 2024 · 0 comments · May be fixed by #3662
Open
1 of 2 tasks
Assignees
Labels
App Configuration Enhancement New feature or request

Comments

@dubdabasoduba
Copy link
Member

dubdabasoduba commented Nov 16, 2024

Describe the feature request.

  • The OpenSRP mobile app uses the Composition resource to define the resources that need to be downloaded to the app for configurations and workflow execution.
    • For a composition to be validated, every section must include at least one of the following: an entry, text, or sub-section.
  • This ticket involves updating the OpenSRP mobile app code to support both the entry and focus attributes for referencing resources the app requires. This update will maintain backward compatibility with existing implementations.
  • focus should be deprecated over time, and users will be encouraged to transition to the entry attribute for resource referencing.

Additional context

  • Teams are advised to use the text property for Composition resources that haven't migrated to using entry to pass validation. Below is an example of how to use text
{
  "title": "Application configuration details",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Application configuration details</div>"
  },
  "focus": {
    "reference": "Binary/592f27bc-d476-4d8f-9307-07e00f1b91bb",
    "identifier": {
      "value": "application"
    }
  },
  "mode": "working"
}

Acceptance criteria

  • Composition resources defined using the entry attribute should load correctly on the app.
  • All resources referenced on the entry and focus attributes should be downloaded correctly.

Area path
A list of ordered steps in the app on the usage of the feature to support anyone testing it e.g. Code reviewer, QA e.g.

  1. Login to the app
  2. Open Navigation bar
  3. Click on Children register
  4. Click on Child profile
  5. Click on Edit profile from menu

Implementation plan (For Engineers)
The plan for implementing the solution e.g. via a description or a checklist for the various ordered tasks that will need to be completed.
i.e. Describe how you intend to solve the problem

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment