Authoring Platform Version 6+ User Guide

Page tree

Versions Compared

Old Version 1

changes.mady.by.user Steve Archbold

Saved on

compared with

New Version 2

changes.mady.by.user Steve Archbold

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info
titleIn this page:

How to find read an existing report which was previously generated using the Reporting Platform. Prerequisite steps: Find an existing report



Advanced Tables - Table Plus
classuser-guide-steps-references


StepsReference

Press the Run New Query button in the right-hand top corner of the report description panel. This opens the Report Details form in a pop-up dialogue box.


Each report type has a relevant set of query parameters which may be specified.

Example Report Details form: Term Contains X

This query takes the following values:

  • Subhierarchy - a constraining sub-hierarchy of SNOMED CT to limit the query scope.
  • Starts With - if this is checked the Words value must occur at the start of a term.
  • Words (mandatory field) - words to find within concept terms.
  • Attribute Type - a constraining attribute type to limit the query scope.

Note the Words field which is labelled as a mandatory field. If this is not populated, the report run will fail when the details are submitted, with Failed showing in the Status column of the reports list entry.

Later versions of the Reporting Platform will introduce deeper form validation to prevent submission with invalid report details (form validation varies according to the complexity and dependencies of the different report details).

Enter your desired query details.

Subhierarchy and Attribute Type are examples of type-ahead select fields - start typing a word in the field box and the form will present a drop-down list of matching options (it may take a few seconds to query the server and present the selection list). Press a list option to set the field value.

Complete your desired query details and then press the Run Query button in the lower right-corner of the Report Details dialogue box. This will submit the report for running on the server. If you wish to cancel, press the x in the upper right corner of the dialogue box to close it without running the query.

On submitting the Report Details, the report Status changes to Scheduled. At this point the report request is queued on the server.

When the queue processing reaches your scheduled report, the report Status changes to Running. At this point the report query is run against the mainline content on the Authoring Platform. The report run time depends on the complexity of the query and its related hierarchy size, available server resources and queue length.

Note
titleReport running time

The current query run time limit is 2 minutes on the server - sufficient for most reporting needs whilst preventing performance issues associated with "runaway" queries. Time to update the report list Status may be longer if there is significant concurrent server processing, and is also be influenced by network communications latency between the server and the requestor's web browser.

If the run time limit is exceeded, the report run will stop and be marked as Failed in the report list. This may happen with queries that would return excessively large result sets , for instance a query with unconstrained scope that returns everything below a high-level concept.


After successful completion of the report, its Status is updated to Complete, and the Google Sheet report is then available in Google Drive, linked from the report entry Status label/icon.




StepsReference
Find the report to run as described in … find an existing report.

Press the Run New Query button in the right-hand top corner of the report description panel. This opens the Report Details form in a pop-up dialogue box.


Each report type has a relevant set of query parameters which may be specified.

Example Report Details form: Term Contains X

This query takes the following values:

  • Subhierarchy - a constraining sub-hierarchy of SNOMED CT to limit the query scope.
  • Starts With - if this is checked the Words value must occur at the start of a term.
  • Words (mandatory field) - words to find within concept terms.
  • Attribute Type - a constraining attribute type to limit the query scope.

Note the Words field which is labelled as a mandatory field. If this is not populated, the report run will fail when the details are submitted, with Failed showing in the Status column of the reports list entry.

Later versions of the Reporting Platform will introduce deeper form validation to prevent submission with invalid report details (form validation varies according to the complexity and dependencies of the different report details).

Enter your desired query details.

Subhierarchy and Attribute Type are examples of type-ahead select fields - start typing a word in the field box and the form will present a drop-down list of matching options (it may take a few seconds to query the server and present the selection list). Press a list option to set the field value.

Complete your desired query details and then press the Run Query button in the lower right-corner of the Report Details dialogue box. This will submit the report for running on the server. If you wish to cancel, press the x in the upper right corner of the dialogue box to close it without running the query.

On submitting the Report Details, the report Status changes to Scheduled. At this point the report request is queued on the server.

When the queue processing reaches your scheduled report, the report Status changes to Running. At this point the report query is run against the mainline content on the Authoring Platform. The report run time depends on the complexity of the query and its related hierarchy size, available server resources and queue length.

Note
titleReport running time

The current query run time limit is 2 minutes on the server - sufficient for most reporting needs whilst preventing performance issues associated with "runaway" queries. Time to update the report list Status may be longer if there is significant concurrent server processing, and is also be influenced by network communications latency between the server and the requestor's web browser.

If the run time limit is exceeded, the report run will stop and be marked as Failed in the report list. This may happen with queries that would return excessively large result sets , for instance a query with unconstrained scope that returns everything below a high-level concept.


After successful completion of the report, its Status is updated to Complete, and the Google Sheet report is then available in Google Drive, linked from the report entry Status label/icon.


… create a new report and/or report category

In the current version this is achieved via service requests to the technical team. Please raise an INFRA project ticket in JIRA to request a new report (either in an existing category, or requesting a new one), as done for AP issues and improvement requests. This will be processed and prioritised along with other AP and RP feature/improvement requests for inclusion in a future release.

… remove a report (from the RP report listing)

StepsReference
Find the report to remove as described in … find an existing report.
Move your cursor over the report row entry (the row background will change shade when your cursor is in its context). A red “minus” icon will also appear to the right of the label link icon.

Press the red minus sign to remove the report from the list. This presents the Delete Report pop-up dialogue.

Press the Delete Report button in the lower right-corner of the Delete Report dialogue box to remove the report entry from the report listing. Press the x in the upper right corner of the dialogue box to close the box without changing the report listing.

Info
titleRemoves list entry - not the report itself

This action removes the report entry from the Reporting Platform listing but does not remove the Google sheet report saved in Google Drive, which can still be viewed directly from Google Drive if needed.

Any report removed from the listing can be added back simply by running that report again (although the date-time and account name will be those of the re-run rather than any previously run report).



… request a new feature

... request an improvement to an existing feature

... report an issue

To request a Reporting Platform new feature or improvement, or to report an issue, please use the existing Authoring Platform Raise an Issue process.

This can be done via the Raise an Issue button in the footer of the main Authoring Platform pages and completing the form dialogue presented in your web browser, or alternatively raise an INFRA project ticket directly in JIRA if preferred.

Info
titleA picture is worth a thousand words

Screen capture images are a very effective way to share issues and ideas, and often save much typing to convey the same level of understanding. Annotated screenshots can be particularly helpful when suggesting improvements or making feature requests. Please use the file attachment options in either the Raise an Issue form, or directly via JIRA in an associated INFRA ticket to include supporting screen captures.