Versions Compared

Old Version 17

changes.mady.by.user Former user

Saved on

compared with

New Version 18

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 containIn the definition file we define the components and tabs of the definition file.

Attributes

NameDescriptionValue
id

Unique Identifier.

Any.
nameThe name of the data entry page. This is displayed as the title of the page.Any.
datapathThe 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.
moduleThe identifier of the module the page belongs to.Any of the module ids defined in the modules metadata file.
functioncallThe methods that are called to load the datasource object.Any functioncall that loads the datasource object.
datasourcesThe classes of the objects displayed on the page.

com.crm.web.generator.datasource.DTODatasource

flowcontrolThe definition of the steps of a wizard page.The list of the wizard steps.
mainmenuThe definition of the page's toolbar.The list of components that will be displayed on the toolbar.
mainThe definition of the page's main area.The list of components that will be displayed in the main area.
detailsThe 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.

Image Removed

...

Example

Data Entry PageImage Added

Code Block
languagexml
titleData entry page
linenumberstrue
<page>
  	<id>fintranstypeDetailBody</id>
  	<name>Financial Transaction Type<<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../xsd/dataEntry.xsd">
	<id>financialtransactions/type</id>
	<name>Type</name>
	<datapath>name</datapath>
	<module>FINANCIAL_TRANSACTIONS</module>

	<datasources><functioncall>
		<functions>
			<function>
			</function>		
		</functions>
	<datasource></functioncall>
	
	<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>tabPaymentMethods</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>tabCategories</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.

Image Removed

 

Code Block
languagehtml/xml
titleWizard data entry page
linenumberstrue
<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&amp;act=itm&amp;jndi=ejb/CRMUIOrder&amp;fc=loadForm&amp;pv0=[[getValue,java.lang.String,order/id]]&amp;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>