IBIS-PH View System Documentation - Module IBISQ Application PARAMETER Elements
Overview
This document discusses the special IBISQ_APPLICATION_PARAMETERS parameter elements and what these
contain and do. Listed below is a table that describes some of the common parameters; their name,
typical values and what it controls. Any value that must be sent to IBISQ but is common for that
measure or module and doesn't need to be selected/defined by user input should be implemented as a
PARAMETER. An example of this is for the population module. The standard population year (population
weight) needs to be defined but the user doesn't ever want/need/should be allowed to select it. So
it's implemented as a parameter (needs to be specified for IBISQ but isn't selectable). The parameter's
name must match the SAS variable name which is "stdpop". The desired standard weighting year is 2000
and so the parameter's value is "2000". Below is a table that shows the common parameters. All but
the last parameter are common global parameters which means that they apply to all measures defined for
that module. The last parameter is measure specific and thus needs to be defined within the
QUERY/MODULE/CONFIGURATIONS/CONFIGURATION/ IBISQ_APPLICATION_PARAMETERS/PARAMETER element.
| Name | Typical Values | Description |
|---|---|---|
| config | /health/www/ibisq/ population/query.cfg | Path and filename of the main configuration file. This file is the main file that IBISQ uses to store other filenames and base SAS procedure information. It must exist on the IBISQ server and be accessible by the app. Typically, this file (and all other related files) are stored in a directory structure based on the module dataset ("population" in this example). |
| htmlhead | ibisq_head.xml | This is a filename who's contents will be added before the query results. The data within
this file should be the XML declaration statement and the opening, main root XML container element.
Example:<?xml version="1.0" encoding="UTF-8"?> <IBISQ_QUERY_RESULT> |
| htmltail | ibisq_tail.xml | Same as above but the XML content to be added at the end of the query result elements. This
should be the closing tag of the main root element defined in the ibisq_head.xml. Example:</IBISQ_QUERY_RESULT> |
| sas | 0, 1, or 2 | Controls IBISQ returning SAS debug information. If the value is zero or if the parameter
element doesn't exist then no extra SAS type information is returned. The UI will display
this data on the query results page. This value should only be used by a module developer
to debug the back end SAS system. It should always be set to "0" for production deployments. Values: 1 - returns the actual SAS program generated/used. 2 - returns the SAS log file. |
| test | 0, 1, 2, 4 | Controls IBISQ returning paths, and variables' debug information. Also turns on the
debug mode for the new IBIS system UI. The results page will show the IBISQ variables and
some other information as well as the IBISQ URL used, and the submission count. If the
value is zero or if the parameter element doesn't exist then the normal output page is generated.
As in the sas parameter, this is used for module development and should be turned off for deployment. Core Values: 1 - returns the configuration file contents. 2 - returns the IBISQ variable definitions. 4 - returns the user's values sent to the IBISQ system. Derived Values (additive so that multiple data items can be returned): 3 - options 1 and 2 5 - options 1 and 4 6 - options 2 and 4 7 - options 1, 2, and 4. IMPORTANT NOTE: Currently this option causes the results to not be displayed. This is due an XML parsing problem. In the old system this information is returned as part of the HTML page and can be viewed simply by invoking the IBISQ query directly from the browser via the URL displayed on the confirmation page. |
| NOTE: When in debug mode, the user will also be required to press the [Proceed] button. | ||
| debug | Empty, 0, 1, true, false, yes, no, x | Controls the debug mode on the new IBIS system UI. This mode is turned on if the VALUE element's value is numeric and greater than "0" or the first character is a "t", "T", "y", "Y", "x" or "X". Otherwise the debug mode is NOT enabled. When enabled, the confirmation page (submit.xslt) is forced to show/use the proceed button and all parameter values submitted are displayed in a table. The results page (result.xslt) will show the IBISQ URL used, all parameter values submitted, and the submission count. The difference between this and the "test" or "sas" parameters described above is that no backend IBISQ information is gathered or shown. If not enabled then the normal output page is generated with the proceed button being controlled via the module user preferences. |
| form | 22 | This value must always be set to 22 which tells IBISQ to generate XML data. The value of 11 is used by the old system which tells IBISQ to generate HTML. |
| sequence | - | This parameter was needed by the old HTML based system for drill downs and it not used nor needed for the new UI |
| func | 1, 2, 3, 4 etc. | This value controls the type of data value to be returned in the query results. This parameter is measure specific. Typically, 1 = count, 2 = crude rate, 3 = percentage etc. Note that this value also corresponds to a func_num.def filename which is part of the IBISQ system. This func.def file contains specific value calculation information needed to build the SAS program. |