Record Contribution: Provide management interface for record contribution jobs in INN-Reach (Current Contribution, Enhanced)

Purpose:

Provide an interface to initiate and mange initial/bulk record contribution jobs for INN-Reach.

User story statement(s):

As a user with permission to initiate bulk record contribution for INN-Reach, I want to see if a bulk record contribution job has been started, what the current status of a running job is (records contributed, errors, records remaining, etc.), be able to pause/resume/cancel a running job, and see the results previously run contribution jobs, so that we can effectively manage record contribution to the central server.

Scenarios:

1. Scenario
   • Given that no previous record contribution job has been started
   • When the user selects the "Current contribution" (default)
   • Then The following information is displayed
     • The "Initial contribution status" is "not started"
     • Material to item type mapping is either valid or invalid
       • Depends on whether all FOLIO material types are currently mapped to an INN-Reach item type ("real-time" status)
     • FOLIO to INN-Reach locations is valid or invalid
       • Dependent on the presence of, at least, default mappings and all mapped locations are contributed to the central server
     • Contribution Started (datetime stamp) is empty
     • Started by is empty
     • Contribution paused is empty
     • Paused by is empty
     • Contribution resumed is empty
     • Resumed by is empty
     • Contribution cancelled is empty
     • Cancelled by is empty
     • Contribution complete is empty
     • Total FOLIO instance records is current number of instance records
     • A table listing "Records evaluated", "Contributed", "Updated", "De-contributed", and "Errors" is empty
     • An "Initiate contribution" button is at the bottom of the screenshots
       • If the "Material to item type mapping" and "FOLIO to INN-Reach locations" are valid, then the button is active. Otherwise, the button is inactive
         • Add some kind of tooltip to indicate that valid mappings are required to initiate contribution
2. Scenario
   • Given that at least one record contribution job has been initiated (and in-progress)
   • When the user selects the "Current contribution" (default)
   • Then The following information is displayed
     • The "Initial contribution status" is "in-progress"
     • Material to item type mapping is either valid or invalid
       • Depends on whether all FOLIO material types are currently mapped to an INN-Reach item type ("real-time" status)
     • FOLIO to INN-Reach locations is valid or invalid
       • Dependent on the presence of, at least, default mappings and all mapped locations are contributed to the central server
     • Contribution Started (datetime stamp) is set to when the contribution was initiated
     • Started by set to the user who initiated the contribution job
     • Contribution paused is empty
     • Paused by is empty
     • Contribution resumed is empty
     • Resumed by is empty
     • Contribution cancelled is empty
     • Cancelled by is empty
     • Contribution complete is empty
     • Total FOLIO instance records is the number of instance records to be evaluated
     • A table listing "Records evaluated", "Contributed", "Updated", "De-contributed", and "Errors" reflects the current status of the contribution job (see mockups)
       • Manual "Refresh" button for statistics table refresh
     • Some type of animated "in-progress" indicator is present below the table to show that some background activity is occurring
     • An "Pause" button is at the bottom-right of the screen
     • A "Cancel contribution" button is in the lower-left
3. Scenario
   • Given the previous scenario (and any other in-progress job scenario)
   • When the user activates the "Pause" button
   • Then the record contribution job is paused and the screen is updated to indicate
     • The "Initial contribution status" is "paused"
     • Material to item type mapping is either valid or invalid
       • Depends on whether all FOLIO material types are currently mapped to an INN-Reach item type ("real-time" status)
     • FOLIO to INN-Reach locations is valid or invalid
       • Dependent on the presence of, at least, default mappings and all mapped locations are contributed to the central server
     • Contribution Started (datetime stamp) is set to when the contribution was initiated
     • Started by set to the user who initiated the contribution job
     • Contribution paused is set to the datetime that the job was paused
     • Paused by is the user who paused the job
     • Contribution resumed is empty
     • Resumed by is empty
     • Contribution cancelled is empty
     • Cancelled by is empty
     • Contribution complete is empty
     • Total FOLIO instance records is the number of instance records being evaluated
     • A table listing "Records evaluated", "Contributed", "Updated", "De-contributed", and "Errors" reflects the current status of the contribution job (see mockups)
     • The in-progress indicator is disabled
     • An "Resume" button is at the bottom-right of the screen
     • A "Cancel contribution" button is in the lower-left
4. Scenario
   • Given that a record contribution is in a "paused" state
   • When a user activates the "Resume" button
   • Then the record contribution job is resumed and the screen is udpated to indicate
     • The "Initial contribution status" is "in-progress"
     • Material to item type mapping is either valid or invalid
       • Depends on whether all FOLIO material types are currently mapped to an INN-Reach item type ("real-time" status)
     • FOLIO to INN-Reach locations is valid or invalid
       • Dependent on the presence of, at least, default mappings and all mapped locations are contributed to the central server
     • Contribution Started (datetime stamp) is set to when the contribution was initiated
     • Started by set to the user who initiated the contribution job
     • Contribution paused is set to the datetime that the job was paused
     • Paused by is the user who paused the job
     • Contribution resumed is set to the datetime the job was resumed
     • Resumed by is set to the user who resumed the job
     • Contribution cancelled is empty
     • Cancelled by is empty
     • Contribution complete is empty
     • Total FOLIO instance records is the number of instance records being evaluated
     • A table listing "Records evaluated", "Contributed", "Updated", "De-contributed", and "Errors" reflects the current status of the contribution job (see mockups)
       • Manual "Refresh" button for statistics table refresh
     • The in-progress indicator is re-activated
     • An "Pause" button is at the bottom-right of the screen
     • A "Cancel contribution" button is in the lower-left
5. Scenario
   • Given that a record contribution is in a "in-progress" state
   • When a job completes (all records have been evaluated for contribution and all contributed records have been submitted to the central server)
   • Then the record contribution job complete and the screen is updated to indicate
     • The "Initial contribution status" is "complete"
     • Material to item type mapping is either valid or invalid
       • Depends on whether all FOLIO material types are currently mapped to an INN-Reach item type ("real-time" status)
     • FOLIO to INN-Reach locations is valid or invalid
       • Dependent on the presence of, at least, default mappings and all mapped locations are contributed to the central server
     • Contribution Started (datetime stamp) is set to when the contribution was initiated
     • Started by set to the user who initiated the contribution job
     • Contribution paused is set to the datetime that the job was paused
     • Paused by is the user who paused the job
     • Contribution resumed is set to the datetime the job was resumed
     • Resumed by is set to the user who resumed the job
     • Contribution cancelled is empty
     • Cancelled by is empty
     • Contribution complete is set to the datetime the job completed
     • Total FOLIO instance records is the number of instance records being evaluated
     • A table listing "Records evaluated", "Contributed", "Updated", "De-contributed", and "Errors" reflects the current status of the contribution job (see mockups)
     • The in-progress indicator is disabled
     • The "Pause" button is replaced with an inactive "Initiate contribution" button at the bottom-right of the screen
     • The "Cancel contribution" button is removed
     • "Success" toast is presented indicating that the job has been completed

Additional Information:

Mockup Slides: https://docs.google.com/presentation/d/1GVBJin8Ei3sFZdosLyxZc9OojqcylXZoHG7tOcxJIbU/edit?usp=sharing