Prepare for Including Analysis and Review tools

[dave-mills]

The current version of the tool is essentially an upload and storage system for analysis outputs. We want to enable users to run the analysis of policy documents directly within the tool instead of using an external tool and then bringing the results into the platform. For this, we will integrate some key functionality from Taguette.

To set that up, we need to update the database structures and data model classes to include some key relationships and properties. We also need to create the new front-end structure.

[dave-mills]

Data Model Updates

Policy

• Rename to PolicyDocument to better reflect the things it represents.
• Add a longtext content
• Add a string text_direction, and make a PHP enum class to ensure that the values are either "LEFT_TO_RIGHT" or "RIGHT_TO_LEFT". For now, set the default as LEFT_TO_RIGHT.

Highlight

• Add a new model Highlight with the properties:

  • policy_document_id (and a belongsTo relationship to PolicyDocument)
  • start_offset - int
  • end_offset - int
  • snippet - text

• Add a many-many relationship with link table between Highlight and PriorityAction, so that users can tag each highlight with any number of priority actions.

I was wondering if maybe Highlights and Statments could be the same thing, but I actually think it's better having them separate, as they can be for different purposes:

• a "Highlight" is an extract from a PolicyDocument - a snippet captured word-for-word.
• a "Statement" can be any entered text, e.g. a summary of findings that the user enters directly.

Front-end Additions

The current testers asked for a way to bulk-upload policy documents. I think that makes sense to do as a new page on the AppPanel, with a form to upload any number of documents to the current assessment at once - i.e. with a multiple UploadField component.

Ideally, it should prevent the user from removing any documents that have highlights added.

[dave-mills]

References:

• database diagram of current setup: https://lucid.app/lucidchart/70b20365-3f96-467e-b8d7-aae176a43028/edit?invitationId=inv_796164d9-4011-4a02-a999-d408bf0a434f
• work in progress designs for analysis front-end: https://www.figma.com/design/YnLDcLHTqu5dMCRadQKGFC/Policy-Tool?t=8kfIrrm9g4EMs3SR-1

[dan-tang-ssd]

Front-end Additions

The current testers asked for a way to bulk-upload policy documents. I think that makes sense to do as a new page on the AppPanel, with a form to upload any number of documents to the current assessment at once - i.e. with a multiple UploadField component.

In app panel, I created a new assessment then add policy documents.
I found that multiple files can be uploaded at once. Can we do multiple file upload in this page instead of creating a new page for bulk upload?

---

Screen shots:

[dan-tang-ssd]

Ideally, it should prevent the user from removing any documents that have highlights added.

Maybe we can split the file upload component into two separate file upload components.

The first file upload component to show existing uploaded files without any highlight, user can add new files and/or delete the uploaded files.

The second file upload component to show existing uploaded files with highlight(s), user can only view the filenames of these files. I used disabled() to disable the whole file upload component. It is more preferred if we can disable file deletion but keep the file download feature.

In filterMediaUsing(), I used media ID as a condition for the mock up now. We will need a criteria to determine if an uploaded file has any highlight or not.

I would recommend to add column highlights.media_id, so that we can check if there is any highlight for a particular uploaded file.

---

Screen shots:

[dan-tang-ssd]

Besides, there are two minor issues found during testing.

1. Start New Assessment > Select a country > click Start New Assessment button
   • error occurred:
   • SQLSTATE[23000]: Integrity constraint violation: 1452 Cannot add or update a child row: a foreign key constraint fails (ae_policy_tool_staging.assessment_user, CONSTRAINT assessment_user_assessment_id_foreign FOREIGN KEY (assessment_id) REFERENCES assessments (id) ON DELETE CASCADE)
   • insert into assessment_user (assessment_id, user_id) values (12, 1)
   • assessment is created

---

2. click Agroecology Policy Tracking, it always link to assessment with ID 1
   • http://ae-policy-tracking-tool.test/app/1/assessment-overview
   • it looks like it is hardcoded to assessment 1 instead of the current assessment