Issue Number | 509 |
---|---|
Summary | [Literature] Internal Citations Queue |
Created | 2019-04-17 16:26:03 |
Issue Type | New Feature |
Submitted By | Juthe, Robin (NIH/NCI) [E] |
Assigned To | Kline, Bob (NIH/NCI) [C] |
Status | Closed |
Resolved | 2019-09-08 18:04:22 |
Resolution | Fixed |
Path | /home/bkline/backups/jira/oceebms/issue.242861 |
We would like to use the EBMS to review and store citations that are "internal" in nature, meaning they are not to be distributed to the Boards and more relevant to the PCIB team. These citations may cover topics such as health communication, information seeking behaviors, or PDQ (articles written about PDQ). Here are some general thoughts. Bob, I'd like to discuss this one a bit more with you in order to hone in on the detailed requirements.
General purpose is to have a repository of these citations
Would like to be able to review them as a batch on queue page
Would like to be able to add comments to summarize main point or note something interesting
Might need a report to view comments (at a later time; search database should work for now)
Don’t need approve/reject – all articles treated the same – but we’ll need a way to check off that we’ve seen them (“archive” possibly)
Queue page should be able to be filtered by topic, date range, and tags
Queue page should display comments
Should be imported to a state requiring full text retrieval and then published to review queue as an "FYI" (we'd probably want to call them something other than "FYI" since we already have FYI in the system, but it's the same general idea that these are for information purposes only and they should have a terminal state)
We might need to update the search database page to be able to search for these citations by their new state
Bob, I'd like to discuss this one a bit more with you in order to hone in on the detailed requirements.
When would be a good time to have this discussion, ~juther?
We could
use a separate table (only makes sense if these will share very little functionality in common with the member-reviewable articles)
store in the ebms_article
table and use an article
tag ("internal
" )
store in the ebms_article
table and use special
state(s)
use the ebms_article
table but have a separate state
table
???
Are these board-specific? Topic-specific? If not, option #4 (or #1) might be appropriate. Do we create new topics just for these?
How many of these do we expect to import? Used by all the boards, or just one or two? Does only one board manager review each of these? Or do they go on everyone's queue page (requiring that we track "has she seen this?" for each of the board managers)?
The most straight-forward approach might be to combine options #2 and
#3 above, attaching to the imported internal articles a
non-topic-specific article tag of "internal" and assigning a terminal
state of internal
. We don't need a separate state to
indicate that they can go into the review queue, as the presence of the
full text file takes care of that. We can create a separate queue page
for reviewing these. One of the tricky bits is deciding what to do with
the boards and topics, as the use cases you've described (e.g.,
articles about PDQ) make it seem like these would be of general interest
to all the board managers, not just the manager of one particular
board.
Decisions from meeting with Robin and Margaret.
We would like to track archiving from the queue on a
per-manager basis (nice-to-have)
We want a queue form which lets the manager specify tag, date imported
We need to be able to tag these articles, might use a different name/table (for example, "category")
Users need to be able to add new internal-article tags and to deactivate them
I will determine whether it's possible to use the existing
ebms_article
table for these citations, without putting
rows into the ebms_article_state
table
Managers would like to be able to store comments (nice to have) - searchable
Exclude internal articles from search page results
Link from internal article queue to "full citation" page
Looks good - thanks for capturing this!
I just wanted to add a few items we discussed related to the business practice, as notes to myself mainly.
We plan to use the queue page to search for the articles. It will essentially be our complete repository of internal articles. We can add additional search parameters to the page down the road, if necessary. We will filter the results by tags & date in order to see the articles we are interested in.
We plan to use the Full Citation page (most likely) to send the article into the Board process (adding a Board & topic) or, conversely, to add the article to the internal queue (by adding an internal article tag).
Internal article tags might include values such as: Important, Risk Factors for Bladder Cancer, and PDQ.
~juther: for #6 above, are the internal article comments per-article? Or per article/internal-article-tag combination?
First piece is in place (#4 on the list above).
The fields needed/allowed for importing an article for internal use are so different from what's on the existing import form, that I have decided I will implement a separate form for the internal version of import. I'll need the answer to my question above about the scope of an internal article comment before I'll be able to get it rolling.
Making progress.
https://ebms-dev.nci.nih.gov/import-internal-articles
If I don't hear back for my question about how the comments should be stored, I'm going to proceed with the following assumptions:
each internal article comment is associated with the article, not with a specific internal article tag (though of course the text of the comment can make it clear which tag(s) – if any – the comment refers to)
there can be more than one internal article comment for a given article (new ones added on the "Full Citation" page)
it must be possible to edit an existing internal article comment from the "Full Citation" page
it must be possible to delete an existing internal article comment from the "Full Citation" page
Bob, these assumptions are all fine. I wanted to discuss this with a couple of other Board managers before responding so I did that this afternoon. We are all in agreement that the comments should be on the article level. I also want to be sure that the comments will not seen by Board members - they are for internal purposes. Thanks.
👍
The internal import request handler has been implemented. I'm moving on to modifications to the monster "full citation" page to allow adding internal tags, comments, and full text.
~juther: I was puzzled that there was no way to post the full text PDF for any of my internally-imported articles on the "full citation" page. It took me a while to figure out that this action was represented on the "full citation" form as a "decision" tied to a specific board and topic. Help me to understand why this makes sense. 🙂
I think it was designed that way because the presence of a PDF (in combination with an approved abstract review) puts the article into a different state for that topic. In any case, it has always seemed a bit strange to me, too, but it works well so I haven't bothered to request a change. Fortunately, it's clear that the PDF was uploaded under the citation history for each Board/topic so it isn't a step that gets repeated. It would probably make more sense (and require fewer clicks) to have that be an option in the citation actions menu. If that wouldn't be a huge story point task, I'll add a ticket to the backlog.
Well, that's not captured in the state table (even if the users think of it as a "state"), and unless I add it to the actions menu you wouldn't be able to post the PDF for one of the purely internal articles if you didn't have the PDF when the article was imported (because currently, if there are no boards or topics, the Upload the PDF "decision" doesn't show up anywhere on the page). I think your idea to add a backlog ticket for displaying the full-text file information in a single non-topic-dependent location is a good one, and no, it wouldn't be a huge story point task. 🙂
Added OCEEBMS-524. Thanks.
Summary of components/features for this ticket (so I'll have a punch list to make sure everything's done – at least at a high level – and so you'll have a rough outline of what needs to be tested):
✔ Form for managing internal tags (https://ebms-dev.nci.nih.gov/admin/internal-tags)
✔ Form for importing internal articles (https://ebms-dev.nci.nih.gov/import-internal-articles)
✔ Internal article queue (https://ebms-dev.nci.nih.gov/internal-articles)
✔ Form for filtering internal article queue (https://ebms-dev.nci.nih.gov/internal-articles)
✔ Links from internal articles in queue to "full citation" page
✔ Display of internal tags and comments on "full citation" page
✔ Action (with form) added to "full citation" page for adding an
internal comment
✔ Action (with form) added to "full citation" page for editing the
article's set of internal tags
✔ Removal of "Download Full Text" link from "full citation" page's
actions block
✔ Pencil icon for editing an existing internal comment from the "full
citation" page
✔ Deletion icon for removing an existing internal comment from the "full
citation" page (with confirmation dialog)
✔ Display of full text information on the "full citation" page hoisted
from separate per-topic sections to single display above
✔ Action (with form) added to "full citation" page for uploading the
full-text PDF without needing a topic
✔ Exclusion of purely internal articles from search results
~juther: Have I forgotten anything? We ran into a bug on Thursday, and I'm trying to remember what that was. 🙂
We talked about adding a ticket for enhancing the internal article queue in a future release to add display of the article's abstract.
Have you had a chance to think about which flavor of the queue page you prefer (list or table)?
I remembered the bug we stumbled on in the Thursday status meeting — the Cancel button wasn't responding on one of the forms. Fixed now.
Thanks, Bob. This list looks good to me! Could you please remind me what the URL is for the second flavor of the queue (table version)? I personally prefer the table option, but I will run both options by our group when we meet on Wednesday and let you know what the group decides.
Another potential enhancement we talked about is the ability to import a batch of internal articles.
Keep in mind, however, that if we want to add display of the abstract in an upcoming release, the table format would be awkward.
Right. Thanks.
Reviewing this on DEV, and I have a couple of requests related to the queue page. The citation format is a little different from what we're used to on the regular queue page, and I think they should be consistent where possible.
Could you please have the title of the article link to the Full Citation page as opposed to linking from the EBMS ID?
Could you please add links to VIEW ABSTRACT and DOWNLOAD FULL TEXT (if applicable) beneath each citation?
There are a few other things that are inconsistent with our regular queue (e.g., bold author names, number of authors displayed, numbering of articles), but I'll wait until we decide which flavor to go with before posting any requests related to those items. They are also less important than the items mentioned above. Thanks.
... ability to import a batch of internal articles.
I think we said we'd put that into a future enhancement. By the way, I
noticed that NLM lets you click a link which just gives you the PMIDs
for your search, which can be pasted into the PMID field.
Right, I meant to say "future"! Good to know about the PMID field.
We reviewed this in our meeting yesterday and it looks really good! We have a few comments/requests:
On the Internal Import page:
Please change the label "TAG(S)" to "INTERNAL TAG(S)".
On the Internal Articles page:
We've decided to go with the table format for this page.
Please change "ARTICLE QUEUE" to "ARTICLES". (We're going to try to get away from calling this a "queue" page since it really isn't functioning as a queue but more of a repository of these internal articles.)
Please add an option to search/filter the results by comment.
Please change "CITATION" to "ARTICLE" in the table header of the filter results.
Would it be possible to change the date imported (in the results and in the filtering options) to date tagged (referring to the date the article received its first internal tag)? We discussed this quite a bit and realized this would be a better way to track these citations than date imported, since we could import something for Board purposes and make it an internal article months down the road. This may need to go in a future release.
We also discussed whether it would be possible to show which internal articles were also reviewed by a Board from this page. Let's discuss this one.
As I mentioned above, the format of citations on this page is a little different from our usual queue page. In addition to the two items I mentioned in my comment above regarding the link to the full citation page and the display of the abstract/full text links, could you please treat the display of the citation information as it is on the queue page (limit the number of author names, unbold the author names, add numbers beside the citations)?
On the Full Citation page:
Could the wording in the citation action box read "ADD/EDIT INTERNAL TAGS" as opposed to "EDIT INTERNAL TAGS"?
Thank you!
change the label "TAG(S)" to "INTERNAL TAG(S)"
✔ Done.
go with the table format for this page
✔ Done.
change "ARTICLE QUEUE" to "ARTICLES"
✔ Done.
add an option to search/filter the results by comment
✔ Done.
change "CITATION" to "ARTICLE" in the table header of the filter results
✔ Done.
Would it be possible to change the date imported (in the results and in the filtering options) to date tagged (referring to the date the article received its first internal tag)?
❌ This would be for a future release, as you suspected. We're not tracking when the tags were assigned.
show which internal articles were also reviewed by a Board from this page
❌ Future release.
have the title of the article link to the Full Citation page as opposed to linking from the EBMS ID
✔ Done.
add links to VIEW ABSTRACT and DOWNLOAD FULL TEXT (if applicable) beneath each citation?
✔ Done.
limit the number of author names
✔ Done.
unbold the author names
✔ Done.
add numbers beside the citations
✔ Done.
Could the wording in the citation action box read "ADD/EDIT INTERNAL TAGS" as opposed to "EDIT INTERNAL TAGS"?
✔ Done.
I'm getting an error when I try to pull up the Internal Articles page on DEV. (Same thing happens when I try to pull up the queue page.) I'll post a screenshot.
Good catch. The database scripts for this ticket (and for OCEEBMS-496) had been omitted from the deployment script. Fixed.
I believe I've done the tasks for this ticket. Let me know if I've missed something.
Looks great. Verified on QA.
Verified on PROD.
File Name | Posted | User |
---|---|---|
EBMS internal articles page.png | 2019-09-04 16:18:37 | Juthe, Robin (NIH/NCI) [E] |
Elapsed: 0:00:00.000528