cloud-pipeline
cloud-pipeline copied to clipboard
[NGS Portal] Pipeline run's report documents
Background
During pipeline execution, many different auxiliary output documents may be generated. Once pipeline is completed, user might want to view/preview such documents or download them to work with later. As these documents can be located in different places of the pipeline working/output directory and it can be hard to find files of interest manually, it would be useful to implement a separate previewer for pipeline output documents.
Approach
On the Run logs page of the pipeline, a new tab shall be added - Reports. This tab shall have a view like:
Tab shall contain a list of documents from the pipeline's output directory:
- list shall include only documents loaded via
PipelineResultstorage rules (for more details see #3906) - documents shall be grouped by storage rules by which they were loaded
List shall have a table view with the following columns:
- Name - name of the
PipelineResultstorage rule by which documents were loaded - Path - list of full paths of documents loaded via the corresponding
PipelineResultstorage rule- each path shall be presented as hyperlink - by click it, a corresponding document shall be opened in a preview pop-up (see below)
- if the list of documents is too large (more then
Ndocuments for a rule, whereNis defined from preferences) then only several documents shall be shown, other documents shall hidden and a control with the count of hidden paths shall be shown. By click such control, list of hidden document shall be shown in a tooltip, e.g.:
Table shall support sorting by the Name column.
By click any document path, the pop-up with document preview shall be opened. This pop-up shall look like:
Pop-up shall include:
- details section:
- labels with the document name (name of the
PipelineResultstorage rule by which that document was loaded) and path - button to open current document in a new tab
- button to download a raw file of the current document to the user workstation
- labels with the document name (name of the
- preview section - main section with the document preview. At least the following types and viewer shall be supported:
TSV,CSV- shall be shown as a formatted table. Sorting by columns shall be supported. Pagination shall be supported for large tablesPDF- shall be shown in a web PDF-viewer inside a framePNG- shall be shown as image inside a frameHTML- shall be shown as formatted HTML-page inside a frame- for unsupported documents types:
- notification shall be shown about the impossibility of previewing and a suggestion to download the document
- button to open a document in a new tab shall be disabled