View System Documentation - Indicator Profile Content Management
This document discusses managing the Indicator Profile content. As the indicator profile's content is stored and maintained within the IBIS-PH Data Admin system there are only a few key items that need to be covered. They are:
- Indicator profile and related view XML files are all automatically published by the Data Admin System when the indicator profile has its status set to "Approved". If artifacting is enabled without the publishing deletion object setup (via the indicator.xml Spring configuration file) then the newly published indicator data will not be transformed. If this happens then the cached/artifacted indicator profile .HTML page needs to be manually deleted from the app's "artifact" directory. Also, some times these indicator profile pages are cached since they appear to be normal HTML files (the page's meta data is set to not cache unless artifacted but sometimes this data is ignored by the browser and/or an intermediate proxy).
- The xml/indicator/published_profiles.xml file is automatically maintained by the application when an indicator is published or deactivated via the Admin System. For an indicator to show up in the alphabetical listing it must be published which puts it in the XML file. If for some reason a file is not showing up this file can be checked to verify that the indicator resides within it.
- Similarly the xml/indicator/categorized_index.xml file is automatically created when the Publish Categorized Index option is selected on the Admin System. For an indicator to show up in the categorized index it must be published AND must be in the categorized index XML file. If for some reason a file is not showing up this file can be checked to verify that the indicator is listed and check that the indicator is published..
The indicator.xml Spring configuration file allows for an existing
indicator file to be versioned/backed up before overwriting when
that indicator is to be published via an Admin System publish request.
Listed below is the code needed for a backed up version (to not have
files backed up before publishing, simply remove or comment out the
"fileBackupFactory" property line):
<bean id="Indicator.PublishIndicator.Controller" class="org.ibisph.mvc.controller.indicator.PublishIndicator" > <property name="destinationXMLPath"> <ref bean="Indicator.Profile.XML.Path"/> </property> <property name="documentDAO"> <ref bean="GeneralXML.DAO"/></property> <property name="publishedIndicatorProfilesSystemID"> <ref bean="PublishedIndicatorProfiles.XML.SystemID"/> </property> <property name="fileBackupFactory"> <ref bean="Versioned.FileBackupFactory"/> </property> </bean>
There are two URL parameter available for indicator profile pages.
GraphicTypeThe "GraphicType" controls the type of chart graphic to generate. Valid values are: "svg" or "jpeg". If the GraphicType cookie is not set and nothing is specified on the URL then the system defaults to jpeg (note that this only affects charts). Example:
GraphicNameThe "GraphicName" URL parameter is the type of chart to be displayed. This overrides the view's defined chart name. Valid values are contained within the xml/charts.xml file. Example:
This value when used on a complete profile or a PHOM expanded view will cause ALL charts to be displayed as that type.
The Data Admin Preview and testing of an indicator profile can be
performed using the generic "view" request. This is where both the
xml and xslt are specified as part of the URL. An example of this
using an XML that resides on another machine looks like this (using
the "xmlURL" URL parameter):
http://localhost/view ?xslt=html/indicator/profile/CompleteProfilePage.xslt &xmlURL=http://ibisadmin.org/ibisph-admin/xml/CigSmokAdol.xml
Or using a local file:
http://localhost/view ?xslt=html/indicator/profile/CompleteProfilePage.xslt &xml=indicator/profile/CigSmokAdol.xml
Note that the "xml/" and "xslt/" path prefixes are not shown as these are properties set via the Spring configuration for the "view" request controller.