Authoring Platform Version 6+ User Guide

Page tree

In this page:

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

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.

Report 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.