Admin Training 002

Overview

Resources for training.

Topics Covered

• Creating and editing report definitions

• Describe various fields

• Use of the "test" button and failure modes

• Generating a newly defined report (as a lead)

Video

• Admin Training 002 Video

Script

Following is a script for the attached video.

Open a browser and direct it to the landing page for the application

• Prerequisite : Copy the query for the 'Principles Applied' definition to notepad.  Delete the Principles Used definition.

• Preamble

  • Welcome to the IHTSDO map tool video tutorials. This administrator training video covers creating and editing report definitions.  It also covers generating a report based on those report definitions.

• Log in as an administrator user (map_adm)
  
  

  • RESULT: the glass pane comes up for a bit and takes the user to the main dashboard for map_adm
    
    
    

• Open the Report Definitions accordion.

• Explain the various fields:

  • Name: of the report definition

  • Frequency: schedule of when this test is auto-generated

  • Role Required: Privilege level required to generate and access this report

  • Result Type: Concepts or Map Records

  • Is Diff Report:
    
    

    • false produces a data point report (which is a snapshot that answers a question at a point of time); 

    • true reports the incremental differences or the comparison between two data point reports

  • Query Type:  SQL, HQL or LUCENE

  • Query: query in expected format

  • Description: plain language description of the query functionality

  • Diff Report Time Period: the required time period between the two data point reports (e.g. - weekly, monthly, daily)

  • Diff Report Base Definition: the report definition used  for the data point reports that will be compared

• Create a new Report Definition with an invalid query.  Use the 'Principles Applied' query without the itemName, itemId and ct fields.  Click the 'Test' button.

  • RESULT: error message will display

• Revise to create a valid New Report Definition by adding the itemName, itemId and ct fields.  Click the 'Test' button.  Click 'Submit' button.
  
  

  • RESULT: new report definition will immediately be displayed in the table of report definitions.

• Edit the frequency for the new report definition. Click the 'OK' button.

• Delete the new report definition by clicking on the 'X' button.  Click 'Cancel' on the confirmation dialog.

• Create a new diff Report definition using the 'Principles Applied' query as the Diff Report Base Definition

• Log-out as map_adm

• Log-in as a lead user

• Scroll down to Reports widget

• Confirm that report definition was added to pick-list

• Generate report

• Log-out
  
  
  

References/Links

• n/a