1 / 30

This Morning's Road Map

Walkthrough of the elements in the Query Front End Module XML file, including diagrams, screenshots, and XML code.

tluckett
Download Presentation

This Morning's Road Map

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. 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 This Morning's Road Map

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

  3. Query Front End Module XML Main Elements Review • Root Container Element named "QUERY" • Basic Structure Diagram • Focusing on the "MODULE" element only.

  4. Module's MODULE Element

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

  6. TITLE, DESCRIPTION, KEYWORDS HTML Snippet <html> <head> <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>IBIS-PH Population Query Module</title> <meta content="text/css" http-equiv="Content-Style-Type; charset=ISO-8859-1"> <meta content="text/javascript" http-equiv="Content-Script-Type"> <meta content="RevealTrans (Duration=0, Transition=3)" http-equiv="Page-Enter"> <meta content="RevealTrans (Duration=0, Transition=2)" http-equiv="Page-Exit"> <meta content="ibis@utah.gov (IBIS Director)" http-equiv="Reply-to"> <meta content="Fri, 12 Dec 1980 23:23:23 GMT" http-equiv="Expires"> <meta content="Utah Deparment of Health" name="Author"> <meta name="Description" content="This is the description of PopMain_Example"> <meta name="Keywords" content="population esimates, age, utah">

  7. TITLE, DESCRIPTION, KEYWORDS XML Snippet <?xml version="1.0" encoding="ISO-8859-1"?> <QUERY> <MODULE> <NAME>PopMain_Example</NAME> <TITLE>Population Query Module</TITLE> <DESCRIPTION>This is the description of PopMain_Example</DESCRIPTION> <KEYWORDS>population esimates, age, utah</KEYWORDS> . . . </MODULE> </QUERY>

  8. 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: http://health.utah.gov/cgi-bin/hi_iq_func ?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

  9. IBISQ_APPLICATION_PARAMETERS XML Snippet <IBISQ_APPLICATION_PARAMETERS> <PARAMETER><NAME>debug</NAME><VALUE>true</VALUE></PARAMETER> <PARAMETER><NAME>config</NAME><VALUE>/health/www/ibisq/population/query.cfg</VALUE></PARAMETER> <PARAMETER><NAME>htmlhead</NAME><VALUE>ibisq_head.xml</VALUE></PARAMETER> <PARAMETER><NAME>htmltail</NAME><VALUE>ibisq_tail.xml</VALUE></PARAMETER> <PARAMETER><NAME>sas</NAME><VALUE>2</VALUE></PARAMETER> <PARAMETER><NAME>test</NAME><VALUE>0</VALUE></PARAMETER> <PARAMETER><NAME>form</NAME><VALUE>21</VALUE></PARAMETER> <PARAMETER><NAME>stdpop</NAME><VALUE>2000</VALUE></PARAMETER> </IBISQ_APPLICATION_PARAMETERS>

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

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

  12. OVERVIEW and SECTION XML Snippet <OVERVIEW> <SECTION> <TITLE>Overview</TITLE> <TEXT>The population data in this IBIS-Q query module were produced by the Utah Governor&#39;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 &#40;projections&#41; based on the Utah Process Economic and Demographic &#40;UPED&#41; model. Numbers for past years &#40;estimates&#41; were produced by the Utah Population Estimates Committee &#40;UPEC&#41;. </TEXT> </SECTION> <SECTION> <TEXT>If you want to modify your query interface display options, click on &#34;options,&#34; above, right.</TEXT> </SECTION> <SECTION> <TITLE>Getting Started</TITLE> <TEXT>Follow the steps to narrow your query and display your results. When you are done forming your query, click &#34;Submit&#34; bottom of the screen (last step) to get your query result. </TEXT> </SECTION> </OVERVIEW>

  13. 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).

  14. DIMENSIONS XML Snippet <DIMENSIONS> <DIMENSION name="year"><NAME>year</NAME><TITLE>Year</TITLE></DIMENSION> <DIMENSION name="gender"><NAME>gender</NAME><TITLE>Gender</TITLE></DIMENSION> <DIMENSION name="geo_f"> <NAME>geo_f</NAME> <TITLE>Geographic area</TITLE> <ASSOCIATED_NAMES> <NAME>geo2</NAME> <TITLE>Local Health District</TITLE> </ASSOCIATED_NAMES> </DIMENSION> <DIMENSION name="agegrp_f"> <NAME>agegrp_f</NAME> <TITLE>Age Group</TITLE> <ASSOCIATED_NAMES> <NAME>agegrp1</NAME> <NAME>agegrp9</NAME> </ASSOCIATED_NAMES> </DIMENSION> </DIMENSIONS>

  15. STEP Element Definition • The STEPS/STEP element contains all the data to define that step's Questions and Answers.

  16. STEPS XML Snippet <STEPS> <STEP> <NAME>year</NAME> <TITLE>Select year</TITLE> <QUESTION> . . . </STEP> <STEP> <NAME>agegrp</NAME> <TITLE>Select age</TITLE> <QUESTION> . . . </STEP> . . . </STEPS>

  17. QUESTION Element Definition • The QUESTION element contains all the data to define a step's Question (and contains that question's answers).

  18. QUESTION XML Snippet <QUESTION> <TITLE> First choose a coding scheme to use for age groups. (Default is age adjustment age groups, all ages.) </TITLE> <DESCRIPTION>Filter by sub population group</DESCRIPTION> <ANSWERS> <NAME>agegrp_f</NAME> <TYPE>SINGLE</TYPE> <ANSWER> <TITLE>Four age groups (0-14, 15-44, 45-64, 65+)</TITLE> <VALUE>1</VALUE> <QUESTION> <TITLE>Which age group(s) do you want to include in the analysis: </TITLE> <ANSWERS> ... </QUESTION>

  19. ANSWERS Element Definition • The ANSWERS element contains the data to define a question's answers.

  20. ANSWERS XML Snippet <QUESTION> <TITLE>Select years.</TITLE> <HELP><TITLE>Selecting years. (Default is all years.)</TITLE> <TEXT>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.</TEXT> </HELP> <ANSWERS> <NAME>year</NAME> <TYPE>MULTIPLE</TYPE> <ROWS_TO_SHOW>6</ROWS_TO_SHOW> <ANSWER><VALUE>2000</VALUE><TITLE>2000</TITLE></ANSWER> <ANSWER><VALUE>2001</VALUE><TITLE>2001</TITLE></ANSWER> <ANSWER><VALUE>2002</VALUE><TITLE>2002</TITLE></ANSWER> <ANSWER><VALUE>2003</VALUE><TITLE>2003</TITLE></ANSWER> <ANSWER><VALUE>2004</VALUE><TITLE>2004</TITLE></ANSWER> <ANSWER><VALUE>2005</VALUE><TITLE>2005</TITLE></ANSWER> </ANSWERS> </QUESTION>

  21. ANSWER Element Definition • The ANSWER element contains the data needed to define a question's answer.

  22. ANSWER <ANSWERS> <NAME>geo_f</NAME><TYPE>SINGLE</TYPE> <ANSWER><TITLE>Local health district</TITLE><VALUE>2</VALUE> <SELECTED/> <QUESTION><TITLE></TITLE> <ANSWERS> <TYPE>SINGLE</TYPE> <ANSWER><TITLE>All local health districts</TITLE> <SELECTED/> <VALUE></VALUE> </ANSWER> <ANSWER> <TITLE>Select from list of local health district</TITLE> <QUESTION><TITLE></TITLE> <ANSWERS> <TYPE>MULTIPLE</TYPE> <NAME>geo2</NAME> <ANSWER><TITLE>Bear River LHD</TITLE> <VALUE>1</VALUE></ANSWER> . . . <ANSWER><TITLE>Weber/Morgan LHD</TITLE> <VALUE>12</VALUE></ANSWER> </ANSWERS> </ANSWER> . . . </ANSWERS>

More Related