Versions Compared

Key

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


Panel
id0

Summary pages are XML files used to display multiple records in a tabular form based on search criteria.


What does this section cover?

Table of Contents

Creating Summary Pages

To create a new summary page, you need to create a single XML file under ../pages/summary/<module_name> directory. 

An SQL or an EJB method at the beginning of the file determines the information that will be retrieved and displayed on the summary page. 


In the following example, warehouses.xml is created under ../pages/summary/inventory and uses an SQL statement to retrieve the information.

Ui expand
titleWarehouses Summary Page Example


Code Block
languagexml
themeEclipse
firstline1
titlewarehouses.xml
collapsetrue
<summary xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../xsd/summary.xsd">
	<message>Physical locations where traceable and non-traceable items are stored.</message>
	<title>Warehouses</title>
	<sql>FROM WAREHOUSE
		LEFT JOIN USERS CREATEDBY ON CREATEDBY.USERID = WAREHOUSE.WRHCREATEDBYUSERID
		LEFT JOIN USERS UPDATEDBY ON UPDATEDBY.USERID = WAREHOUSE.WRHLASTUPDBYUSERID
		LEFT JOIN OUUNITS CREATEDBYUNIT ON CREATEDBYUNIT.OUUID = WAREHOUSE.WRHCREATEDBYOUUID
		LEFT JOIN OUUNITS UPDATEDBYUNIT ON UPDATEDBYUNIT.OUUID = WAREHOUSE.WRHUPDATEDBYOUUID
		LEFT JOIN WAREHOUSETYPES ON WAREHOUSETYPES.WRHTYPEID = WAREHOUSE.WRHTYPEID
		LEFT JOIN OUGROUPS ON OUGROUPS.OUGID = WAREHOUSE.OWNEROUGID
		LEFT JOIN PRIVACYLEVELS ON WAREHOUSE.PRIVACYLEVELID = PRIVACYLEVELS.PRIVACYLEVELID
		WHERE WAREHOUSE.WRHDELETED = 0
	</sql>
	<rowsperpage>20</rowsperpage>
	<primaryfield>WAREHOUSE.WRHID</primaryfield>
	<mainlinkfield>WAREHOUSE.WRHNAME</mainlinkfield>
	<orderbyfields>WAREHOUSE.WRHNAME</orderbyfields>
	<allownocriteria>true</allownocriteria>
	<multiselect>true</multiselect>
	<module>INVENTORY_MANAGEMENT</module>
	
	<fieldlist>
		<!-- external filters -->
		 <field>
			<fieldname>WAREHOUSE.WRHID</fieldname>
			<filtertextoption>equal</filtertextoption>
		</field>
 
		...
		<!-- fields -->
		<field>
			<fieldname>WAREHOUSE.WRHNAME</fieldname>
			<caption>Name</caption>
			<summary>true</summary>
			<filter>true</filter>
			<filtercaseinsensitive>true</filtercaseinsensitive>
			<link>page.do?act=itm&amp;xml=inventory/warehouse&amp;jndi=ejb/CRMUIWarehouse&amp;fc=loadForm&amp;pv0=((WAREHOUSE.WRHID))&amp;pvc=1</link>
		</field>
 
		...
 
		<!-- drilldowns -->
		<field>
			<fieldname>BALANCE</fieldname>
			<fieldfunction>''</fieldfunction>
			<caption>Balance</caption>
			<summary>true</summary>
			<available>true</available>
			<fieldtype>label</fieldtype>
			<label>Balance</label>
			<link>drilldown:inventory/warehouse_balance;WRHID~((WAREHOUSETRANSACTIONS.WRHID))</link>
		</field> 
 
		...
 
	</fieldlist>
 
	<actions>
		<action>
			<caption>New</caption>
			<topmenu>true</topmenu>
			<link>page.do?act=new&amp;xml=inventory/warehouse&amp;fc=createButton&amp;pvc=0&amp;jndi=ejb/CRMUIWarehouse</link>
		</action>
 
		...

	</actions>
</summary>


Expand
titleWarehouses Summary Page
Image Added



For more information on customising summary pages, go to Customize Summary Pages. For a full list of summary page attributes, go to Summary Pages Documentation.

To continue implementing the view layer, go to Developing data entry pages (Deprecated)