Description
This XML is used to define the components of the data entry page. A data entry page consists of three areas, the main menu area, the main area and the details area.
For each one of these areas we can specify the components and tabs that they will contain.
Attributes
| Name | Description | Value |
|---|---|---|
| id | Unique Identifier. | Any. |
| name | The name of the data entry page. This is displayed as the title of the page. | Any. |
| datapath | The paths of the identifiers of the displayed object. This is also part of the page's title. | The paths of the object properties that hold the values to be displayed. |
| module | The identifier of the module the page belongs to. | Any of the module ids defined in the modules metadata file. |
| functioncall | The methods that are called to load the datasource object. | Any functioncall that loads the datasource object. |
| datasources | The classes of the objects displayed on the page. | com.crm.web.generator.datasource.DTODatasource |
| flowcontrol | The definition of the steps of a wizard page. | The list of the wizard steps. |
| mainmenu | The definition of the page's toolbar. | The list of components that will be displayed on the toolbar. |
| main | The definition of the page's main area. | The list of components that will be displayed in the main area. |
| details | The definition of the page's details area. | The list of tabs that will be displayed in the details area. |
Examples
Data entry page with a toolbar, a main area and a details area.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<page>
<id>fintranstypeDetailBody</id>
<name>Financial Transaction Type</name>
<datapath>name</datapath>
<datasources>
<datasource>
<key>form</key>
<classname>com.crm.web.generator.datasource.DTODatasource</classname>
</datasource>
</datasources>
<mainmenu>
<components>
<component/>
</components>
</mainmenu>
<main>
<components>
<component/>
<component/>
...
</components>
</main>
<details>
<tabs>
<tab>
<id>paymentMethods</id>
<name>Allowed Payment Methods</name>
<datasourcesetkey>...</datasourcesetkey>
<visibilityconditions>...</visibilityconditions>
<tipexpression>...</tipexpression>
<functioncall>
<functions>
<function/>
</functions>
</functioncall>
<tabmenu>
<components>
<component/>
<component/>
...
</components>
</tabmenu>
<components>
<component/>
<component/>
...
</components>
</tab>
<tab>
<id>Categories</id>
<name>Allowed Categories</name>
<datasourcesetkey>categories</datasourcesetkey>
<functioncall>
<functions>
<function/>
<function/>
</functions>
</functioncall>
<tabmenu>
<components>
<component/>
<component/>
...
</components>
</tabmenu>
<components>
<component/>
<component/>
...
</components>
</tab>
</tabs>
</details>
</page> |
Wizard data entry page.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<page>
<id>orders/orderTakingDetailBody</id>
<name>Order Taking</name>
<datapath>order/number</datapath>
<datasources>
<datasource>
<key>form</key>
<classname>com.crm.web.generator.datasource.DTODatasource</classname>
</datasource>
</datasources>
<flowcontrol>
<messageonsuccess>Order taking created successfully.</messageonsuccess>
<linkoncomplete>Click here to go to order detail page|page.do?xml=orders/orderDetailBody&act=itm&jndi=ejb/CRMUIOrder&fc=loadForm&pv0=[[getValue,java.lang.String,order/id]]&pvc=1</linkoncomplete>
<completedmenucompid>cmdSave</completedmenucompid>
<flowsteps>
<flowstep>
<name>Customer Information</name>
<description>Please specify customer information.</description>
...
</flowstep>
<flowstep>
<name>Order Main Information</name>
<description>Please specify Order main information</description>
...
</flowstep>
<flowstep>
<name>Delivery and Billing information</name>
<description>Please enter the delivery and billing information.</description>
...
</flowstep>
<flowstep>
<name>Payment Terms</name>
<description>Please enter the payment terms.</description>
...
</flowstep>
<flowstep>
<name>Order Preview</name>
...
</flowstep>
</flowsteps>
</flowcontrol>
<mainmenu>
<components>
<component/>
</components>
</mainmenu>
<main>
<components>
<component/>
<component/>
...
</components>
</main>
<details>
<tabs>
<tab/>
<tab/>
...
</tabs>
</details>
</page>
|