Configuring the <sections> element

Creating or configuring forms > Configuring the <pages> element > Configuring the <sections> element

6.2.2 Configuring the <sections> element

Every page must have a <sections> element. The <sections> element has one or more child <section> elements. Each section contains a description visible to the user and an ordered list of components that are defined in the <components> element.

To configure the sections element

Open the desired xml file located in the Viewpoint home directory. Locate the <sections> element.
Place at least one <section> within it. Give the section a unique id and set a permission if desired.

<section id="section1" permission="advancedvpc">

The "section1" section is viewable only by users with the "advancedvpc" permission.

Use the <description> child element to specify the section title displayed to the user in the Viewpoint interface.
Set at least one <component> element per section to designate options for the user. Specify a unique id for each component.

<page>
  <sections>
    <section id="s1" permission="advancedvpc">
      <description>Environment Options</description>
      <component id="starttime" order="1" />
      <component id="duration" order="2" />
      <component id="securityZone" order="3" permission="advanced-user-2" />
    </section>
  </sections>
</page>

Set any desired optional attributes of <component> to meet your needs.

Set description to give a label to the component in the interface. Any string is a valid description.
Set required to specify whether the component must enter data into this field to pass page validation. The default is "false".
Set editable to specify whether the user can edit the component. The default is "true".
Set permission to specify which permissions are required to view the component. This is supported by all components in Viewpoint 1.1 and later. See Setting permissions.

Optional: Set the child element <help-text> to specify the text to appear immediately beneath the component. This is only valid in Viewpoint 2.0 and later.

<component id="class" required="false">
  <description>Class</description>
  <help-text>This is the help text</help-text>
  <text-value />
</component>

HTML tags are accepted within the help-text tag, but must be wrapped in a CDATA tag, as in the example below:

<component id="class" required="false">
    <description>Class</description>
    <help-text>
        <![CDATA[Desired <a href="http://www.desired-web-page.com">Web Page</a>]]>
    </help-text>
    <text-value />
</component>