Technical Overview: Form Storage -- SDMX CrossSectional

This is a form storage mechanism designed to read data from an SDMX-HD code list file. This form storage mechanism is present in version >= 4.0.5.

This is a read-only form storage mechanism.

This form storage mechanism requires PHP 5.3 or greater

Form Storage Options

The options specifying a SDMX Cross Sectional storage for $form are stored at:

/modules/forms/forms/$form/storage_options/SDMX_CrossSectional

It has the following structure:

• file: Required scalar node. The SDMX file that the data should be read from. This can either be an absolutely given file path, or a relative file path. If it is a relative file path, then it uses the SDMXHD file search category.
• namespace: Optional scalar node. defaults to 'ns'.
• id: Optional parent node. The data defining how to associate an id <namespace:OBS_VALUE/>.
  • attribute: Optional scalar node. The name of the attribute which contains the id. If not set the id is the numeric document order of OBS_VALUE nodes starting at 1.
  • eval. Optional scalar node. If set it is a code php code which modifies the id, stored in the $id variable. For example '$id = strtoupper($id);'
  • form_prepended: Optional scalar node. Defaults to true. If true, it means the form name (with a |) has been prepended to the id and we need to strip it out to get the id. If ieval is also set, and this is true, the form is stripped before passing to the eval.
• parent: optional parent node. The data defining how to associate a parent id DOM Node
  • attribute: Optional scalar node. The name of the attribute which contains the parent. If not set, there is not parent data.
  • eval. Optional scalar node. If set it is a code php code which modifies the id, stored in the $parent variable. For example '$parent = strtoupper($parent);'
• fields: Optional parent node. Specifies how the data of the your form is associate to a row of your table. Each child of this node is the name of a field $field of your form.
  • $field: Optional parent node with the following child nodes.
    • attribute: Optional scalar node. The name of the attribute which contains the parent. If not set, there is not parent data.
    • eval. Optional scalar node. If set it is a code php code which modifies the id, stored in the $parent variable. For example '$parent = strtoupper($parent);'

Global Options

There are global options for SDMX-HD form storage. They are specified at:

/modules/forms/storage_options/SDMX-HD

This has the structure:

• closeFile: defaults to false. If true, we close the file between access. Otherwise, we allow PHP to handle closing the file resource at the end of the script's call.

Form Definition

To use SDMX-HD storage for a form use the following configuration. Replace $form, $form_name, $file_location and $CL_ID with the appropriate values. <source lang="xml"> <configurationGroup name="$form">

 <displayName>SDMX-HD Code List: $form</displayName>
 <description>The SDMX-HD Code List: $form_name</description>
 <configuration name="class" values="single">
   <value>I2CE_SimpleList</value>
 </configuration>
 <configuration name="display" values="single" locale="en_US">
   <value>$form_name</value>
 </configuration>
 <configuration name="storage" values="single">
   <value>SDMXHD</value>
 </configuration>
 <configurationGroup name="storage_options" path="storage_options/SDMXHD">
   <configuration name="file" values="single">
     <values>$file_location</value>
   </configuration>
   <configuration name="CodeListID" values="single">
     <value>$CL_ID</value>
   </configuration>
 </configurationGroup>

</configurationGroup> </source>

An example for gender may be:

<source lang="xml"> <configurationGroup name="cl_gender">

 <displayName>SDMX-HD Code List: cl_gender</displayName>
 <description>The SDMX-HD Code List: Gender</description>
 <configuration name="class" values="single">
   <value>I2CE_SimpleList</value>
 </configuration>
 <configuration name="display" values="single" locale="en_US">
   <value>Gender</value>
 </configuration>
 <configuration name="storage" values="single">
   <value>SDMXHD</value>
 </configuration>
 <configurationGroup name="storage_options" path="storage_options/SDMXHD">
   <configuration name="file" values="single">
     <values>CL_GENDER+SDMX-HD+1.0.xml</value>
   </configuration>
   <configuration name="CodeListID" values="single">
     <value>CL_GENDER</value>
   </configuration>
 </configurationGroup>

</configurationGroup> </source>