Player data

There are some specific UIM pages related with Agenda Player:

Navigation page: Each Player requires a navigation page that will become the navigation panel of the Agenda Player. This page has two required characteristics. First, the root PAGE element has a TYPE of SPLIT_WINDOW. This indicates that the page will form part of a frame-set. Second, the page contains a field with a single source connection and domain type AGENDA_XML. This field supplies the Agenda Player with the list of pages, parameters and other information that drives the Agenda Player.
Summary page: This page is optional and might just be a regular UIM page. However, summary page, specifically displaying summary of visited and unvisited pages is also available. If this information is to be displayed in a summary page, a WIDGET element with TYPE attribute set to WIZARD_SUMMARY should be present among page elements.
Exit page: This is a regular UIM page to which the user is forwarded after quitting the player.

The following is an example of the UIM used to specify the navigation page. It contains a single field which supplies the agenda XML data.

<PAGE PAGE_ID="WizardTest" TYPE="SPLIT_WINDOW">

  <PAGE_TITLE>
    <CONNECT>
      <SOURCE NAME="TEXT" PROPERTY="page.title"/>
    </CONNECT>
  </PAGE_TITLE>

  <SERVER_INTERFACE NAME="DISPLAY" CLASS="Agenda"
                    OPERATION="getAgenda"/>

  <PAGE_PARAMETER NAME="agendaRef"/>

  <CONNECT>
    <SOURCE NAME="PAGE" PROPERTY="agendaRef"/>
    <TARGET NAME="DISPLAY" PROPERTY="key$agendaRef"/>
  </CONNECT>

  <CLUSTER SHOW_LABELS="false">
    <FIELD>
      <CONNECT>
        <SOURCE NAME="DISPLAY" PROPERTY="agendaXML"/>
      </CONNECT>
    </FIELD>
  </CLUSTER>

</PAGE>

The following is an example of a specific summary page:

<PAGE PAGE_ID="WizardSummary">

  <PAGE_TITLE>
    <CONNECT>
      <SOURCE NAME="TEXT" PROPERTY="Page.Title"/>
    </CONNECT>
  </PAGE_TITLE>

  <CLUSTER SHOW_LABELS="false" TITLE="Cluster.Title">
     <WIDGET TYPE="WIZARD_SUMMARY"/>
  </CLUSTER>

</PAGE>

The agenda data that drives the Player looks like this:

<?xml version="1.0" encoding="UTF-8"?>
    <agenda>
      <page-flow>
        <section description="First section"
                 status="SCT1">
          <page id="Person_homePage" description="Home"
                status="SC1" initial="true"
                submitonnext="true"/>
        </section>
        <section description="Second section"
                 status="SCT2">
          <page id="Person_listAddress" status="SC2"
                description="Addresses"/>
          <page id="Person_listBankAccount" status="SC1"
                description="Bank Accounts"
                submitonnext="true"/>
          <page id="Person_listCommunication" status="SC3"
                description="Communications"/>
          <page id="Person_listTask" status="SC2"
                description="Tasks"/>
          <page id="Person_listCitizenship" status="SC2"
                description="Citizenships"/>
          <page id="Person_listFinancial" status="SC2"
                description="Financial"/>
          <page id="Person_listNote" status="SC4"
                description="Notes"/>
        </section>
        <summary id="WizardSummary"
                 description="Summary Page"
                 close-on-submit="true"
                 status="SCT3"/>
      </page-flow>
      <parameters>
        <parameter name="concernRoleID" value="101"/>
        <parameter name="dynamicParam" value="0"/>
      </parameters>
      <exit-page id="Person_homePage">
        <parameters>
          <parameter name="concernRoleID" value="101"/>
        </parameters>
      </exit-page>
    </agenda>

There is one page element per screen to be displayed in the Agenda Player. The attributes that can be used in this element are as follows.

Table 1. Attributes of the `page` element
Attribute	Description
`id`	The page id for the page (as set in the `PAGE_ID` of the `PAGE` element in the page's UIM definition).
`description`	The description of the page that will be displayed in the Navigation Panel.
`status`	A status code that is mapped to an image.
`initial`	Set to `true` if this is the page that should be displayed when the Agenda Player is first opened.
`disableback`	Set to `true` if the Back button should be disabled on this page.
`disableforward`	Set to `true` if the Forward button should be disabled on this page.
`submitonnext`	Set to `true` if the Forward button should submit the form on this page.
`close-on-submit`	This attribute applies to `summary` element only and allows for alternative way of quiting the player, as described below.

The important features to note are:

The sequence of screens in the Agenda Player is exactly as listed in the agenda data.
One of the pages in the Agenda Player can be marked as the start page by setting the initial attribute to true. When the Agenda Player is first displayed, this page will be loaded but it will still be possible to navigate back to previous pages. If the Player is configured to use incremental mode, pages prior to the initial pages on the navigation panel will be rendered as hyperlinks; for a full navigation mode all the page items except current one will be hyperlinks.
In the XML sent back by the application server, the page elements might be contained within section elements or there might be no section element at all. The optional summary element, however, is to be always placed directly within page-flow.
All pages in the Agenda Player take the same set of parameters or a subset thereof. These parameters are specified in the agenda data.
Page parameters can also be dynamic. These parameters initially carry special value of 0 (note dynamicParam in the Agenda Player sample data above) and are intended to be initialized during user interaction with Agenda Player (e.g., user ID is only available after a user registers herself).
The exit-page denotes the page which the user will be taken to when the Cancel button is clicked. This page will completely replace the Agenda Player and can be any page in the application with any parameters (matching those specified by exit-page parameter sub-elements in agenda XML from the server).
When submitonnext is set for a page, the submit button on that page (there should only be one) will be hidden when it is displayed within the player. The player's Next button can be used to submit the form instead and will proceed to the next page if no validation error occurs. If there are validation errors, the page will return to itself displaying the validation errors on the top, as it would for any other application page.
To allow for pages where the record itself is optional (i.e. you could move on to the next screen without creating one), but some of the fields are mandatory, if you do try to create a record, the infrastructure will not perform mandatory field validations if no value has been entered/chosen for any field on the page. The appropriate server interface will still be called, so it is up to the application logic to work out what was intended (e.g. don't create a record, delete an existing record, etc.). This behavior only applies when using the submitonnext feature.
The summary page can provide an alternative way to quit the Player. In order to do this, the summary page should contain a submit button, and the summary element in the agenda XML from the server should have close-on-submit specified and set to be true. If the user clicks on the submit button on such a summary page and the submit succeeds, the player closes down and the user is forwarded to whatever page is specified by the link associated with the submit button.
Each page can be assigned a status code using the status. These status codes can be anything at all as long as they are mapped in the ImageMapConfig.xml file under the domain AGENDA_XML. When the list of pages is displayed in the left column, each will have an icon attached corresponding to its status code.

The following is an example of mapping status codes to images the ImageMapConfig.xml file.

<domain name="AGENDA_XML">
  <locale name="en">
    <mapping value="SC1" image="Images/Wizard/status1.gif"
             alt="English text..."/>
    ...
    <mapping value="SC4" image="Images/Wizard/status4.gif"
             alt="English text..."/>
  </locale>
  <locale name="fr">
    <mapping value="SC1" image="Images/Wizard/status1.gif"
             alt="French text..."/>
    ...
  </locale>
</domain>

The appearance of the Agenda Player control buttons, the summary screen and the navigation is defined in CSS. For details, please see Cascading Stylesheets.

The UIM CONDITION element allows for the conditional display of action controls, clusters or lists on a page that is displayed within an Agenda Player (see See CONDITION for more details on the condition element). To hide/display elements based on whether the page is in an Agenda Player or not, the NAME and PROPERTY attributes can only have the values CONTEXT and inWizard respectively.

Figure 1. Condition example:

<ACTION_SET ...>
  <CONDITION>
    <IS_TRUE NAME="CONTEXT" PROPERTY="inWizard"/>
  </CONDITION>
  ...
</ACTION_SET>

This indicates that the action set should be displayed only when that Action Set is on a page that is displaying within a Agenda Player.