TOLOGIX - ISLG App Rebuild

Create ability to edit excerpts and analysis data directly through the Document Text and Analysis List view

Assigned to
Melissa Cowell, General Manager at Industrial Melissa C. Naomi Joanis, UX Team Lead at Industrial Naomi J.
Notes
This is a post-launch requirement request, but further to the video below, I would like to create the ability to edit excerpts and analysis data directly through the Document Text and Analysis List views within a dispute document. Could you please write user stories with the requirements in Open status.

Note I think only admin users with full task permissions (see screenshot below), should have the ability to make these edits in these views:
Thanks,

Morgan



Comments & Events

Harsh Parikh, Tech Lead at DevIT
Hi Morgan Maguire, CEO Morgan , Melissa Cowell, General Manager at Industrial Melissa and Naomi Joanis, UX Team Lead at Industrial Naomi ,

We need specific requirements or user story to cover this task so please provide criteria directly on Azure Devops. 
Morgan Maguire, CEO
Hi Harsh Parikh, Tech Lead at DevIT Harsh , Melissa Cowell, General Manager at Industrial Melissa and Naomi Joanis, UX Team Lead at Industrial Naomi ,

Paul Moon Paul , Irit Weinfeld Irit , Martin Laporte, CTO at Tologix Martin and I had a discussion about this issue, and we decided that we would like to deal with this issue as follows:
  1. Create new level of permissions for certain admin users that gives them special access to a Dispute Document that allows them to bypass the tasks and document state process so that they can make quick edits to HTML documents and analysis data (this is causing a significant headache for the content team).
  2. The idea is that when an admin user with special permissions creates a draft of a published dispute document, the user would be presented with two options:
    1. Create draft within task/state process
    2. Create draft with direct edits
  3. If the second option is selected this would create a draft that would allow the admin user to make edits to the HTML and the analysis data without going through the formal document state process. The admin users would be able to make the following changes within the same document state:
    1. Correct typos in HTML documents without removing analysis tags that may exist within a tagged excerpt.
    2. Make changes to the analysis data both within the HTML and directly through the analysis list.
    3. Make changes to any of the other meta fields associated with the document.
We understand that this request has the potential for significant technical and design challenges. As a result, I propose that Irit Weinfeld Irit  and  Paul Moon Paul have a meeting with Naomi Joanis, UX Team Lead at Industrial Naomi to describe the changes we need and then Naomi Joanis, UX Team Lead at Industrial Naomi  draft requirements that will create the least significant changes to the UI of the application.
Naomi Joanis, UX Team Lead at Industrial
Hi Morgan Maguire, CEO Morgan , Paul Moon Paul and Irit Weinfeld Irit ,

That sounds like a good idea to have a meeting and discuss the issue in more detail. Is anytime Thursday after 1pm EST available? 

Thanks, 

Naomi
Morgan Maguire, CEO
Sounds good, Naomi Joanis, UX Team Lead at Industrial Naomi . Does 1:30pm EST (10:30am PST) work for everyone?

Morgan 
Martin Laporte, CTO at Tologix
1:30pm EST works for me.
Paul Moon
Yes, 10:30 a.m. PST works for me on Thursday.
Irit Weinfeld
Thursday 1:30pm EST works for me as well.
Naomi Joanis, UX Team Lead at Industrial
Hi Morgan Maguire, CEO Morgan

This is what I captured from today's call:
  • Only certain admins should have the ability do perform a “quick edit”
  • "Quick edit" option will only be available from published documents
  • This should not create a draft version of the document
  • "Quick edit" should allow admins to edit document text, analysis, analysis list and document meta fields
Considerations:
  • Migrated documents seem to have more limitations on them in terms of what admins can and can’t do (for example, they can’t replace pdfs of migrated documents). Will need to understand from devIT what these possible limitations are to be sure the "quick edit" solution can apply to both migrated and uploaded documents.
  • There are limitations on editing text that has tags applied to it. Need to understand what these are in order to design a solution that will allow admins to quickly edit text without needing to delete and replace many tags.
Let me know if there is anything else that should be added there. Would you like us to schedule a call to discuss further with devIT, and if so who should be there?

Thanks, 

Naomi
Morgan Maguire, CEO
Perfect. Thanks Naomi Joanis, UX Team Lead at Industrial Naomi .

Martin Laporte, CTO at Tologix Martin and Harsh Parikh, Tech Lead at DevIT Harsh , could you please discuss the considerations Naomi Joanis, UX Team Lead at Industrial Naomi has highlighted above during your next meeting and we'll determine next steps based on the technical constraints.

Thanks,

Morgan
Harsh Parikh, Tech Lead at DevIT
Hi Naomi Joanis, UX Team Lead at Industrial Naomi , Morgan Maguire, CEO Morgan and Martin Laporte, CTO at Tologix Martin ,

Following my answers for your questions.


  • Migrated documents seem to have more limitations on them in terms of what admins can and can’t do (for example, they can’t replace pdfs of migrated documents). Will need to understand from devIT what these possible limitations are to be sure the "quick edit" solution can apply to both migrated and uploaded documents.

After Publish the document, We can allow functionality to replace the PDF file but we can not replace the html file due to tagging functionality. Also, we need to check certain parameters like Document is published and admin create the draft version and then admin will replace the PDF file in Published version then what will affect on draft version PDF ?


  • There are limitations on editing text that has tags applied to it. Need to understand what these are in order to design a solution that will allow admins to quickly edit text without needing to delete and replace many tags.

We Should not allow to edit the text after publish the document as if admin user by mistake remove any element from html file or remove any Id or data-key then it will affect the tagging data. But we can discuss what admin user want to edit in html file and will find another way to achieve this functionality.
 
Morgan Maguire, CEO
Hi Harsh Parikh, Tech Lead at DevIT Harsh ,

Your answers above don't address the specific issues we're asking about. I've clarified the issues further below: 
  • Migrated documents seem to have more limitations on them in terms of what admins can and can’t do (for example, they can’t replace pdfs of migrated documents). Will need to understand from devIT what these possible limitations are to be sure the "quick edit" solution can apply to both migrated and uploaded documents.

After Publish the document, We can allow functionality to replace the PDF file but we can not replace the html file due to tagging functionality. Also, we need to check certain parameters like Document is published and admin create the draft version and then admin will replace the PDF file in Published version then what will affect on draft version PDF?

The issue is that there is a difference in what can be edited between documents that were migrated to the application from the legacy application and documents that were manually uploaded into the application. We want to resolve this and ensure that all the migrated documents have all the editing functions (including replacing the PDF).


  • There are limitations on editing text that has tags applied to it. Need to understand what these are in order to design a solution that will allow admins to quickly edit text without needing to delete and replace many tags.

We Should not allow to edit the text after publish the document as if admin user by mistake remove any element from html file or remove any Id or data-key then it will affect the tagging data. But we can discuss what admin user want to edit in html file and will find another way to achieve this functionality.

We understand the risk and limitations in editing the HTML file within the application; however, the key issue we want to understand is whether there is are technical limitation that prevents us from making minor edits (e.g., correcting typos) to the HTML after tagging has been added to the document. Does tagging the document alter the document in any way that prevents us from making these minor edits to the HTML?

Could you please comment further on these issues.

Thanks,

Morgan
Irit Weinfeld

Hi Harsh Parikh, Tech Lead at DevIT Harsh ,

From Morgan's message above, here is an example of a design limitation for migrated files.  In the UIN Master List sent for Migration (dated 3 December 2020), Grey highlighted BITs and Treaties were part of the migration. They were uploaded as Placeholders.

We are able to change the Placeholder toggle button from "Yes" to "No":

However, we are NOT able to upload PDFs or HTMLs.  Currently, we send a Basecamp request to DevIT to upload the PDF and HTML for these BITs and Treaties.

Treaties that we upload internally as Placeholders do not have this same issue.

Thanks,
Irit
Morgan Maguire, CEO
Hi Irit Weinfeld Irit

Is this the only issue? If so, we can deal with this separately, because I don't think it affects the proposed changes above.

Morgan
Irit Weinfeld
Hi Morgan Maguire, CEO Morgan ,

Yes. And yes, this can be dealt with separately. 

Thanks,
Irit
Morgan Maguire, CEO
Ok. Thanks Irit Weinfeld Irit ​.

Harsh Parikh, Tech Lead at DevIT Harsh ​, can you please comment on my second comment above then?

Thanks,

Morgan
Harsh Parikh, Tech Lead at DevIT
Hi Morgan Maguire, CEO Morgan ,

The typo correction you can do but if any admin user by mistake add/remove something then might be it will create issue.

The issue is not creating for tagging saved data. The issue will create to load the tagging in html document.
Paul Moon
Hi Harsh Parikh, Tech Lead at DevIT Harsh :

ISLG legacy admin site currently has a XML preview function where admin users could make minor changes (e.g., typo) and view the XML before publishing the changed XML.

Would it be possible to build something similar to HTML on app.islg where admin users are required to preview the edited HTML to ensure nothing is added or removed that may upset the whole HTML? If the preview function shows an error, admin users will contact you instead of proceeding with the change.

Thanks,

Paul
Morgan Maguire, CEO
Hi Paul Moon Paul ,

Further to Irit Weinfeld Irit 's comments above, could you please confirm that the placeholder issue is the only issue that differentiates migrated documents and manually uploaded documents (Note we need to confirm whether there any other differences with Disputes, Dispute Documents, Treaties, Arbitration Rules and Non-Investment Treaty Dispute Documents), because these could potentially affect the requirements that Naomi Joanis, UX Team Lead at Industrial Naomi writes to implement this to-do.

Thanks,

Morgan
Paul Moon
Hi Morgan Maguire, CEO Morgan :

I'll confirm with Irit Weinfeld Irit again to think of any other examples and report back here.

Thanks,

Paul
Morgan Maguire, CEO
Hi Harsh Parikh, Tech Lead at DevIT Harsh ,

Following-up on above and our discussion last Thursday, could you confirm whether it is possible to make edits to HTML text that has been tagged in analysis. As we discussed, the edits would be limited to correcting minor issues (e.g., typo) and would not affect the paragraph IDs within the document. Please confirm whether such edits are possible post analysis (and any technical limitations) so that we can start writing the requirements relevant to this to-do.

Thanks,

Morgan
Paul Moon
Hi Martin Laporte, CTO at Tologix Martin :

Could we follow up with this item? These issues affect Irit Weinfeld Irit Nafiseh Arghandehpour, Legal Content Manager at ISLG Nafiseh on a daily-basis. I know there are a lot of issues discussed, so we can break it further to actionable items if necessary.

Thanks,

Paul
Martin Laporte, CTO at Tologix
Hi Paul Moon Paul ,

With our current setup, there are definite risks associated with the Content team editing documents that have already been tagged.

There are 2 ways we can tag:
  1. When tagging entire paragraph(s) by using the auto drop-down, the tagging info is saved in the database based on the paragraph ID. Adding/removing/altering text within these types of tags is safe.
  2. When tagging by manually highlighting an excerpt or paragraph, the tagging info is saved differently into the database, as we now rely on text coordinates. Making an edit within one of these tags is unsafe and will lead to document issues. 

Looking forward into next year, I think we could improve our HTML editor tool, so it is smart enough to adjust the tag coordinates (when dealing with scenario #2 above) whenever an admin makes a text edit. That is likely the be a complex project, but it is definitely possible to accomplish.

Thanks,
-Martin

CC: Harsh Parikh, Tech Lead at DevIT Harsh  
Paul Moon
Hi Nafiseh Arghandehpour, Legal Content Manager at ISLG Nafiseh and Irit Weinfeld Irit :

Please check this new feature on staging.islg admin and report any feedback here. If all looks good, we can proceed to deployment.

Nafiseh Arghandehpour, Legal Content Manager at ISLG Nafiseh : Irit Weinfeld Irit can guide you if you are unsure about the new implementation.

Thanks,

Paul
Nafiseh Arghandehpour, Legal Content Manager at ISLG
Hi Paul Moon Paul and Piyush Kanpariya, DevIT Piyush ,

I checked this new feature on staging.islg admin. It looks good to me. However, as you see in the videos below, there seems to be a bug as for "Generally" references:

1- I am not able to remove one (or some) of the paragraph numbers under "Paragraph(s) of Document Referenced" when "Generally" is selected under Article/Provision.

I get the following message: "Legal Instrument and Article/Provision is already exists."

2- I am not able to change specific references to "Generally" reference as  I get the following message: "Legal Instrument and Article/Provision is already exists."

In the example of BIT/0004, I first made sure that Generally reference has not been already entered.
When I tried to change the specific reference (Article 7(2)) to a "Generally" reference, I got the following message.

Thanks,

Nafiseh
Paul Moon
Hi Piyush Kanpariya, DevIT Piyush :

Please let us know when the two issues identified by Nafiseh Arghandehpour, Legal Content Manager at ISLG Nafiseh are addressed.

Thanks,

Paul
Harsh Parikh, Tech Lead at DevIT
Hi Nafiseh Arghandehpour, Legal Content Manager at ISLG Nafiseh , Paul Moon Paul and Irit Weinfeld Irit ,

The above issues are resolved on staging.islg.

Please check and confirm.


Cc : Martin Laporte, CTO at Tologix Martin  
Harsh Parikh, Tech Lead at DevIT
Hi Nafiseh Arghandehpour, Legal Content Manager at ISLG Nafiseh ,

This is not bug.

As per our discussion, We have finalized that if there is same source data while you update tagging data then will display warning message that this kind of data already available in Analysis List. Please go through it and update there.

For example in your case AC UIN BIT/1223 and Provision Generally already available in Analysis List. so find out that data and update there.

If you have any concern then please contact Paul Moon Paul or Irit Weinfeld Irit so they will guide you.

Cc : Martin Laporte, CTO at Tologix Martin  
Nafiseh Arghandehpour, Legal Content Manager at ISLG
You are right, Harsh Parikh, Tech Lead at DevIT Harsh . That was not a good example to check the issue. I checked a few other entries, and they function correctly.

Thanks,

Nafiseh
Paul Moon
Hi Nafiseh Arghandehpour, Legal Content Manager at ISLG Nafiseh :

If everything else looks good, please complete this item.

Harsh Parikh, Tech Lead at DevIT Harsh : when Nafiseh Arghandehpour, Legal Content Manager at ISLG Nafiseh   marks this item complete, please deploy it to app.islg.

Thanks,

Paul
Nafiseh Arghandehpour, Legal Content Manager at ISLG
Hi Paul Moon Paul ,

Yes, it looks good to me.

Irit Weinfeld Irit , could you please confirm if everything looks good for Subject Navigator as well, so I could l mark this to-do as complete?

Thanks,

Nafiseh
Irit Weinfeld
Nafiseh Arghandehpour, Legal Content Manager at ISLG Nafiseh Paul Moon Paul ,

Everything looks good for SN.  
Irit
Irit Weinfeld
Irit Weinfeld completed this to-do.
Irit Weinfeld
Irit Weinfeld re-opened this to-do.
Harsh Parikh, Tech Lead at DevIT
Hi Irit Weinfeld Irit ,

You have re-open this item. Do you find any issue ?

Cc : Paul Moon Paul Martin Laporte, CTO at Tologix Martin Piyush Kanpariya, DevIT Piyush  
Irit Weinfeld
Hi Harsh Parikh, Tech Lead at DevIT Harsh ,

No issues.  I will mark this to-do as complete.
Irit
Irit Weinfeld
Irit Weinfeld completed this to-do.