Presentation on theme: "This Morning's Road Map System Documentation Overview Query System Diagram Review Query Front End Components How the Front End Works Query Front End UI."— Presentation transcript:
This Morning's Road Map System Documentation Overview Query System Diagram Review Query Front End Components How the Front End Works Query Front End UI File Types Query Module File Introduction to XML Review Sample Query Module XML
Module XML Sample Walk Through The approach is to walk through each element type of the QUERY/MODULE element and show how/where it is used. First the element diagram and overview will be shown. Next, a screen shot will be shown (if applicable). Followed by the elements' XML code needed to produce that part of the user interface. The XML module source file we are going through is PopMain_Example.xml (located on the desktop). Reminder: The "Q Module Elements" document contains a description of each element.
Query Front End Module XML Main Elements Review Root Container Element named "QUERY" Basic Structure Diagram Focusing on the "MODULE" element only.
Module's MODULE Element
Main MODULE Elements NAME. Name of the module. This should match the filename sans the ".xml" and path. Used to keep track of module file. TITLE. Shown as the browser's page title and is also shown at the top of the page. DESCRIPTION. Optional text which is used for the HTML meta data "description" tag. KEYWORDS. Optional text which is used for the HTML meta data "keywords" tag.
TITLE, DESCRIPTION, KEYWORDS HTML Snippet IBIS-PH Population Query Module
TITLE, DESCRIPTION, KEYWORDS XML Snippet PopMain_Example Population Query Module This is the description of PopMain_Example population esimates, age, utah...
IBISQ_APPLICATION_ PARAMETERS Element IBISQ_APPLICATION_PARAMETERS. Contains common IBISQ configuration and control info. Each PARAMETER element contains two elements. NAME. Name of the parameter passed to IBISQ. VALUE. The value of the parameter. Example of part of the URL which these specify: ?form=21&sas=2&&func=1&debug=true&test=0 &htmlhead=ibisq_head.xml&stdpop=2000 &htmltail=ibisq_tail.xml&config= %2Fhealth%2Fwww%2Fibisq%2Fpopulation%2Fquery.cfg
IBISQ_APPLICATION_PARAMETERS XML Snippet debug true config /health/www/ibisq/population/query.cfg htmlhead ibisq_head.xml htmltail ibisq_tail.xml sas 2 test 0 form 21 stdpop 2000
MEASURE Definition Element Measures are an advanced topic and will not be covered in any level of detail. The following results screen shot shows where some of this information is used.
OVERVIEW Element The OVERVIEW element contains the text shown at the top of the module page giving the user a basic introduction to what this module is about. Each overview contains sections. Each section can contain a title for that section and the actual paragraph of text.
OVERVIEW and SECTION XML Snippet Overview The population data in this IBIS-Q query module were produced by the Utah Governor's Office of Planning and Budget, and are considered the most accurate available for Utah counties. They are the official estimates and projections used in Utah state government. They include numbers for future years (projections) based on the Utah Process Economic and Demographic (UPED) model. Numbers for past years (estimates) were produced by the Utah Population Estimates Committee (UPEC). If you want to modify your query interface display options, click on "options," above, right. Getting Started Follow the steps to narrow your query and display your results. When you are done forming your query, click "Submit" bottom of the screen (last step) to get your query result.
DIMENSION Element Definition The DIMENSION elements define the available ways the IBISQ system can group or summarize the queried data values by (examples are year, age group, gender, county, etc).
DIMENSIONS XML Snippet year Year gender Gender geo_f Geographic area geo2 Local Health District agegrp_f Age Group agegrp1 agegrp9
STEP Element Definition The STEPS/STEP element contains all the data to define that step's Questions and Answers.
STEPS XML Snippet year Select year... agegrp Select age......
QUESTION Element Definition The QUESTION element contains all the data to define a step's Question (and contains that question's answers).
QUESTION XML Snippet First choose a coding scheme to use for age groups. (Default is age adjustment age groups, all ages.) Filter by sub population group agegrp_f SINGLE Four age groups (0-14, 15-44, 45-64, 65+) 1 Which age group(s) do you want to include in the analysis:...
ANSWERS Element Definition The ANSWERS element contains the data to define a question's answers.
ANSWERS XML Snippet Select years. Selecting years. (Default is all years.) Select a range of years.\nHold down Ctrl key to make multiple selections.\nSelect Year in Step 5. to display population estimates for individual years selected. year MULTIPLE
ANSWER Element Definition The ANSWER element contains the data needed to define a question's answer.
ANSWER geo_f SINGLE Local health district 2 SINGLE All local health districts Select from list of local health district MULTIPLE geo2 Bear River LHD 1... Weber/Morgan LHD 12...