FormSettings

From GeoMedia Smart Client
Jump to: navigation, search
Settings WorkflowSetting FormSetting CommonSetting



Contents

1 FormList
2 Include
3 Offline Form
4 Form
5 FormReport
6 FormFilter
7 FormTab
8 FormGroup
9 FormSingleRow
10 FormField
11 FormMap
12 FormFile
13 FormTable/FormTableField
14 FormAction & Parameters


The forms enable the user to inspect, create, or edit data. While the Workflow-XML mainly defines the logical structure of the HTML-Workflow, the Form-XML defines the user-interaction through the GUI-definition.

The validation of the user input is done on two sides. Validation of the user input in FormFields can be handled through client-side scripting (for example, JavaScript), which can be done for a certain FormField when focus is lost. But the user-input is also always validated at the server-side.

The definition of all forms occurs by using an XML-File, which should be stored at the following path:

  • Intergraph\GeoMedia SmartClient\Program\Workflows\FormSettings


Example:

  • MyNewProject.xml



Blue.pngThe file name and the Workflow-XML name must be identical.



Relation between the distinct hierarchical layers:

  • FormList: Root element of the Form-XML has to appear only once.
Parentelement Childelement Cardinality
FormList Include 0 .. n
Form 0 .. n
OfflineForm 0 .. n


  • Include: Container element for the inclusion of external Form-XML files.


  • Form: element used for the creation of a form.
Parentelement Childelement Cardinality
Form FormAction 0 .. n
FormFilter 0 .. n
FormGeometry 0 .. 1
FormReport GMSC 2014 0 .. n
FormTab 1 .. n


  • GMSC 2014 FormReport : Element used for the generation of a Report.


  • OfflineForm: element used for the creation of a offline form.
Parentelement Childelement Cardinality
OfflineForm FormGeometry 0 .. 1
FormTab 1 .. n
FormAction 0 .. n


  • FormFilter: Element used to specify the FormFilter for the List-Controller.


  • FormTab: Element used for the generation of a FormTabulator.
Parentelement Childelement Cardinality
FormTab
FormGroup 1 .. n
FormAction 0 .. n


  • FormGroup: Element used for the grouping of FormFields inside the form.
Parentelement Childelement Cardinality
FormGroup FormAction 0 .. n
FormField 1 .. n
FormFile 0 .. n
FormMap GMSC 2014 0 .. n
FormSingleRow 0 .. n
FormTable 0 .. n


  • FormFile: Element used for the generation of File-upload-UI and File-download-UI in a form.


  • GMSC 2014 FormMap: Element used for the generation of a live view of a specific map segment.


  • FormSinglerow: Element used for the generation of several FormFields in one row.
Parentelement Childelement Cardinality
FormSingleRow FormField 1 .. n


  • FormField: Element used for the generation of FormFields.
Parentelement Childelement Cardinality
FormField FormAction 0 .. n


  • FormTable: Element used for the generation of FormTables.
Parentelement Childelement Cardinality
FormTable FormAction 0 .. n
FormTableField 1 .. n


  • FormTableField: Element used for the design of FormTable fields.


  • FormAction: Element used for the integration of buttons inside a form.
Parentelement Childelement Cardinality
FormAction Param 0 .. n


  • Param: Element used for the definition of additional FormAction parameters.


Example: General structure of a Form.xml

  1. <?xml version="1.0" encoding="utf-8"?>
  2. <FormList>
  3.  <Form name="RPI_PUBLISHORDER" table="RPI_PUBLISHORDER" idfield="ID" pagesize="20" order="PUBLISHSTARTDATE DESC">   
  4.    <FormTab name="RPI_PUBLISHORDER_Tab">
  5.      <FormGroup name="RPI_PUBLISHORDER_Group">
  6.         <FormField name="ID" label="Publishorder ID:" type="textfield" datatype="guidstring" required="false" visible="hidden"/>
  7.           <FormSingleRow name="NameSR" template="FormSingleRowMiddleTemplate">
  8.             <FormField name="NAME" label="Name:" type="textfield" datatype="string" required="false" visible="list,form,filter" maxlength="64" editable="false"
  9.               filter="SQL[UPPER(NAME) LIKE UPPER(dbo.STRINGJOIN('','%',{FILTER.NAME},'%',NULL)]"/>
  10.             <FormField name="OWNER" label="Owner:" type="textfield" datatype="string" required="false" visible="list,form,filter" editable="false"
  11.               filter="SQL[UPPER(OWNER) LIKE UPPER(dbo.STRINGJOIN('','%',{FILTER.OWNER},'%',NULL)]"/>
  12.           </FormSingleRow>
  13. ...
  14.      </FormGroup>
  15.      <FormGroup name="PublishFeature_Group" label="Select Features">
  16.        <FormTable name="FEATUREGRID" label=" " idfield="ID" multiselect="true" datatype="string" type="table" rowcount="5" required="false" persisted="false" 
  17.          lov="SQL[SELECT ID,NAME FROM RPI_FEATURE WHERE ID IN (SELECT FEATURE_ID FROM RPI_THEME_FEATURE WHERE THEME_ID={FORM.THEME_ID}) 
  18.          AND ID NOT IN (SELECT FEATURE_ID FROM RPI_PUBLISHORDER_FEATURE WHERE PUBLISHORDER_ID={FORM.ID}) ORDER BY UPPER(NAME)]" editable="SCRIPT[IG.hasValue('ALLOWEDIT')]">
  19.          <FormTableField name="NAME" label="Feature" width="400"/>
  20.          <FormAction name="TriggerPublishFeatures" label="Assign Feat." editable="SCRIPT[IG.hasValue('ALLOWEDIT')]" action="SCRIPT[IG.trigger
  21.                ({triggerName:'TriggerPublishFeatures',reloadFields:['PUBLISHFEATUREGRID','FEATUREGRID']})]" help="Assign selected Features to Publish-Order"/>                   
  22.        </FormTable>             
  23.      </FormGroup>                         
  24. ...
  25.    </FormTab>  
  26.    <FormAction name="NewPO" label="New Publish" action="SCRIPT[IG.navigate(10230)]" visible="list" />                                                                        
  27.  </Form>
  28. </FormList>



Pfeil new.png To the top Pfeil new.png

FormList

The element FormList is the root element of the Form.xml. It has no attributes, but it can have none or any number of child elements of the type Form, and it can have one or any number of child elements of the type Include.



Language: English