Documented user stories for the PDF2XML vendor
cc @ErinS
Updated 20211024 by @lathrops1
Items in italics could with negotiation be moved to Phase 2 to address other priority items
USER STORIES
-
PDF2XML taggers need to be able to find and track the status of content in the PDF tagging workflow to manager their workload and prioritize per submission details -
PDF2XML taggers should receive notifications when content is sent to them to tag (as confirmation per current working agreements), when there are errors in the tagged files they deliver or tagged files are successfully uploaded into the BCMS (as confirmation per current working agreements), as well as when notified via preview / errors with questions or feedback -
PDF2XML taggers should be able to download all files and file versions to avoid possible versioning issues when correcting / updating files -
PDF2XML taggers should be able to easily upload corrected / updated converted XML files directly to UI to avoid possible versioning issues when addressing errors_ -
PDF2XML taggers should have read-access to find information about how to tag content, but essential metadata and processing settings should be sent to them as part of FTP packages for accurate and complete tagging per agreed to technical specifications** -
Ability for PDF2XML taggers to communicate with submitters / Bookshelf staff about problems and questions with submitted source PDF files (such as content problems a submitter needs to resolve or how to tag content that a Bookshelf staff needs to provide guidance about) – #483 (closed) #508 (closed) #507 (closed)
Priorty for Phase 2
-
Ability for PDF2XML taggers to filter dashboard by organization -
Ability for PDF2XML taggers to filter dashboard by collection
We don't have any user stories detailed in the Epics for this role specifically. There is one epic (&20) that relates specifically to resolving queries from the vendor -- but this ins't in the initial release.
We have the PDF2XML vendor role description here which is a bit out-of-date. The role exists, a sys admin can apply this role.
TECHNICAL PROPOSALS FOR USER PERMISSIONS AND NOTIFICATIONS
User Permissions
The user permissions are defined on the BCMS role permissions sheet
Notifications
workflow actions that result in an email
See liked notification tracking sheet (#511 (closed))
-
when a sys admin gives a user the role "PDF2XML vendor" this user should get an email notification [row 10] -
When this user is mentioned by '@role' or '@username' he gets an email notification [row 28] -
As discussed in #566 (closed) here if Apex removes the job_id
(required) fromvendor-meta.xml
file in error, BCMS will get a kafka notification failed (status=3). In this case, send an email notification the notification vendor so they can trace the failed submission by the package name. [row 23] -
When the vendor submits a converted package that results in the status "Loading errors" they should get an email notification [row 24] -
**When a package is posted to FTP for Apex to tag they and System Admin should get an email notification that includes book / chapter title, book / chapter bcmsids, package name, link to content in bcmsid [row 37] -
When tagged files are successfully ingested to BCMS taggers and System Admin should get an email notification that includes book / chapter title, book / chapter bcmsids, package name, link to content in bcmsid** [row 38]
ACCEPTANCE CRITERIA
-
Bookshelf staff have the ability to assign one or more users to the BCMS as a "PDF2XML vendor" role via the Users page from the BCMS dashboard (note the user needs to sign up first, and can then be assigned the role) -
PDF2XML vendor users can:
-
See all PDF workflow Books in the PDF workflow via the Books and Collections page, including their accurate Status and critical details (last updated, organization, errors, etc) -
Click on all Book and Chapter Components in the PDF workflow and be able to easily see what Organization | Collection | Book they belong, information that will be communicated via packages sent to them for tagging -
See and be able to download all files for PDF Book and Chapter Components from those Component Files pages -
Upload Converted and Associated non-Source files for PDF Book and Chapter Components from those Component Files pages -
See Previews from Component page tabs -
See Errors from Component page tabs -
See but not update Metadata and Settings via those tabs for Components -
PDF2XML vendors will get notifications when:
-
Mentioned in Error, Vendor Issues, or Preview Chat panels -
There is a status change to PDF Book and Chapter components, including: package posted by BCMS to FTP for tagging (new and / or revised), all errors they must address, confirmation when packages they deliver are successfully ingested to the BCMS -
Email notifications include sufficient information to know the component details, its status, how to easily find the component in the BCMS, and what the PDF2XML user needs to do or confirmation that what they did was successful, including:
-
BCMSID AND Title for Book Component -
BCMSID AND Title for Chapter Component AND BCMSID and Title for the Book the Chapter belongs -
Status of the Component, including success or complete error details, or at minimum a correct and direct link to access content and error details