Edit Rule

[mahalakshme]

Need:

• Frequently usecase appears where beyond a point, say after collected data is audited, org dont want the users to anymore edit the observations

Acceptance criteria:

• Have a Edit rule above Decision rule at form level.
• Shape of params object:

{
  entity: {}, //it could be one of Individual, ProgramEncounter, ProgramEnrolment, Encounter and ChecklistItem depending on what type of form is this rule attached to
  form: {}, //form to which the rule is attached to, it should ve form name and uuid, others are not necessarily needed, just pass whatever is available
  services,
  entityContext,
  userGroups // details from MyGroups from realmdb
}

• Output: by default allow edit.

{
      editable : {
       value: true/false
       message: 'custom message'
     } 
}

• Default sample rule:

//SAMPLE RULE EXAMPLE
  "use strict";
({params, imports}) => {
    const individual = params.entity;
    // refer <readme link> to know more
    return {
       editable: {
          value: true
        }
   }
};

• On click on Edit button when the rule returns false, show the translation of the message returned by the rule as a toast message in the bottom. If translation not available should show the message returned by rule itself
• Applicable for allowing/disallowing edit of registeration/encounter/program encounter/enrolment
• Scope of this card is to add the rule in app designer and restrict in android app
• Restriction can be based on value on the entity or independent.
• Case to add to make sure it works: After 90 days of entering the details(enrolmentDateTime for program enrolment, encounterDateTime for encounter/program encounters, createdDateTime for registeration), for AP Teach users belonging to Users group should not be able to anymore edit.

One of the test cases:

Disable edit of subject, encounter, and enrolment after 24 hours of encounterDateTime in TeachAP app.

[mahalakshme]

@vinayvenu final review this also

[petmongrels]

Not Implemented

• as a server side rule
• declarative rule

[petmongrels]

Scope:

Different places where from edit form can be launched

1. Registration
2. Enrolment
3. Enrolment Exit
4. Program Encounter
5. Program Encounter Cancel
6. General Encounter
7. General Encounter Cancel
8. Group Subject Registration
9. Form Element Group Edit
10. Checklist Item

Out of scope

1. Location (as it is not transaction data)
2. Task (there is no edit screen for it)
3. BeneficiaryIdentification (not clear what this is for)
4. SubjectEnrolmentEligibility
5. ManualProgramEnrolmentEligibility
6. Encounter Drafts (Should always be editable)
7. Scheduled Encounters (Should always be doable)

Additional Acceptance Criteria

• Rule Failure Telemetry Failure should be saved correctly.

For testing - Valid Disallow Rule

"use strict"; ({params, imports}) => { const {entity, form, services, entityContext, myUserGroups, userInfo} = params; const output = { editable: { value: false, messageKey: "foo" } }; return output; };

For testing - Valid Allow Rule

"use strict"; ({params, imports}) => { const {entity, form, services, entityContext, myUserGroups, userInfo} = params; const output = { editable: { value: true } }; return output; };

For testing - Invalid Rule (should create rule failure telemetry record in the database

"use strict"; ({params, imports}) => { undefined.foo(); };

[petmongrels]

Screen.Recording.2024-02-27.at.3.31.23.PM.mov

Screen.Recording.2024-02-27.at.3.32.06.PM.mov

[petmongrels]

https://avni.readme.io/docs/rules-concept-guide#edit-form-rule (also linked from writing rule page)

…

On Thu, Feb 29, 2024 at 2:31 PM Himesh ***@***.***> wrote: Scope: Different places where from edit form can be launched 1. Registration 2. Enrolment 3. Enrolment Exit 4. Program Encounter 5. Program Encounter Cancel 6. General Encounter 7. General Encounter Cancel 8. Group Subject Registration 9. Form Element Group Edit 10. Checklist Item Out of scope 1. Location (as it is not transaction data) 2. Task (there is no edit screen for it) 3. BeneficiaryIdentification (not clear what this is for) 4. SubjectEnrolmentEligibility 5. ManualProgramEnrolmentEligibility 6. Encounter Drafts (Should always be editable) 7. Scheduled Encounters (Should always be doable) Additional Acceptance Criteria - Rule Failure Telemetry Failure should be saved correctly. For testing - Valid Disallow Rule "use strict"; ({params, imports}) => { const {entity, form, services, entityContext, myUserGroups, userInfo} = params; const output = { editable: { value: false, messageKey: "foo" } }; return output; }; For testing - Valid Allow Rule "use strict"; ({params, imports}) => { const {entity, form, services, entityContext, myUserGroups, userInfo} = params; const output = { editable: { value: true } }; return output; }; For testing - Invalid Rule (should create rule failure telemetry record in the database "use strict"; ({params, imports}) => { undefined.foo(); }; @petmongrels <https://github.com/petmongrels> shouldn't we include all this information in the readme documentation.? — Reply to this email directly, view it on GitHub <#1273 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAZ3C7USY5YXGKFL57J37TYV3W7JAVCNFSM6AAAAABBUO46HOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNZQGY4TKMZUGE> . You are receiving this because you were mentioned.Message ID: ***@***.***>

-- Vivek Singh | +91 98452 32929 | @petmongrels <https://twitter.com/petmongrels>

[AchalaBelokar]

• [] I tried edit registration decision rule maha@calcutta_kids in the registration edit form rule I write this

• ({params, imports}) => {
  const {entity, form, services, entityContext, myUserGroups, userInfo} = params;
  const output = {
  editable: {
  value: false,
  messagekey: "Not editable"
  }
  }; // https://avni.readme.io/docs/writing-rules#16-edit-form-rule
  return output;
  };
  still I am able to edit the registration .

• Same happen with encounter type

[petmongrels]

• missing models commit fixed
• take new build and reinstall app or modify rule once
• the messagekey should be messageKey

[AchalaBelokar]

• Created individual and tried to edit with edit decision rule true /false
• Tried with edit program enrolment with edit decision rule true/false
• Tried with edit Enrolment exit with edit decision rule true/false
• Tried with edit Program encounter with edit decision rule true/ false
• Tried with edit cancel encounter with edit decision rule true/ false
• Tried with edit general encounter with edit decision rule true/ false
• Tried with Group Subject Registration with edit decision rule true/ false
• Form Element Group Edit with edit decision rule true/false

[mahalakshme]

@AchalaBelokar its not decision rule, its edit form rule

• Did you check if translation of message is displaying, it translation uploaded?
• How does it work with form element group - where should be the rule? on form element group or on form will suffice? What do you think is the expected thing?
• Checklist Item form tested? Asking since its not mentioned in the test cases.

[AchalaBelokar]

Checklist item is out of scope.