Summary Pages Documentation

Summary pages are used to display multiple records in a tabular form. A summary screen displays multiple records based on search criteria. An SQL or an EJB method at the beginning of the file determines the information that will be retrieved and will be able to be displayed on the summary page.

Attributes

Name	Description	Value
title	The title of the page.	Any
message	Displayed on top of the summary as a description.	Any
SQL	Defines the results that will be displayed. It can be used either with SQL or an EJB function.	Only valid SQL statements can be used
classname
functionname
rowsperpage	Defines the limit of rows per page.	Any numeric value
multiselect	If set to true, the user can select multiple records to pass them as parameters in summary actions.	true, false
primaryfield	The identifier of the main entity that will be retrieved through the SQL, used as a parameter in the actions using multi-select. Multiple records can be set, separated by commas. If there are no order-by-fields defined, by default the SQL will be ordered by the primary-field ascending.	Any SQL field
mainlinkfield	Used in order to define which fields the mouse over option will be applicable to. Multiple records can be set, separate by commas. If there are no order-by-fields defined, by default the SQL will be ordered by the main-link-field ascending.	Any SQL field
groupby	Used in order to retrieve the results grouped by the specified fields.	Any SQL field
autosearch	Used in order to search the summary page automatically.	true, false
hidefindbutton	Used to hide the find button	true, false
orderbyfields	Used in order to retrieve the results ordered by the specified fields	Any SQL field
groups	Used in order to create a group of expand fields. Multiple groups can be set separate by semicolons.	Any
entityfilter	Used in order to filter the results based on the business rules.	Any entity
module	The related module name.	Any module
fieldlist	Used to define the fields that will be retrieved from the SQL.	Any SQL field
hidetitlebar	Used in order to hide the title bar of the summary page	true, false
actions	Used in order to open a new page through the summary page.	Actions
savecriteria	If set to false, the search criteria will not be saved as the default criteria, otherwise they are always saved.	true,false
allownocriteria	Indicates if no criteria needs to be defined in order to search.	true, false
organisationdatabase	If set to true the SQL will run on the ecenter database, if set to false the SQL will run on the organisation database. The default value is false.	true, false
superuseraccess	If set to true only superusers have access to the page. The default value id false.	true, false

Examples

Summary Page Using SQL

Summary Page Using SQL

<summary xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../xsd/summary.xsd">

	<title>Accounts Receivable</title>

	<sql>FROM ACCOUNTSRECEIVABLE
		LEFT JOIN USERS CREATEDBY ON CREATEDBY.USERID = ACCOUNTSRECEIVABLE.ACCRECCREATEDBYUSERID
		LEFT JOIN USERS UPDATEDBY ON UPDATEDBY.USERID = ACCOUNTSRECEIVABLE.ACCRECUPDATEDBYUSERID
		LEFT JOIN OUUNITS CREATEDBYUNIT ON CREATEDBYUNIT.OUUID = ACCOUNTSRECEIVABLE.ACCRECCREATEDBYOUUID
		LEFT JOIN OUUNITS UPDATEDBYUNIT ON UPDATEDBYUNIT.OUUID = ACCOUNTSRECEIVABLE.ACCRECUPDATEDBYOUUID
		LEFT JOIN CONTACTINFORMATION ON CONTACTINFORMATION.CIID = ACCOUNTSRECEIVABLE.CIID
		INNER JOIN CONTACTINFODEFINITIONS ON CONTACTINFODEFINITIONS.CIDEFACTIVE = 1 AND CONTACTINFODEFINITIONS.CIDEFDELETED = 0
		LEFT JOIN ACCCLASSIFICATIONS ON ACCCLASSIFICATIONS.ACCCLASSID = ACCOUNTSRECEIVABLE.ACCCLASSID
		WHERE ACCOUNTSRECEIVABLE.ACCRECDELETED = 0
	</sql>

	<rowsperpage>20</rowsperpage>
	<primaryfield>ACCOUNTSRECEIVABLE.ACCRECID</primaryfield>
	<mainlinkfield>ACCOUNTSRECEIVABLE.ACCRECNUM</mainlinkfield>
	<orderbyfields>ACCOUNTSRECEIVABLE.ACCRECNUM</orderbyfields>
	<module>ACCOUNTS_RECEIVABLE</module>
	
	<fieldlist>
		<!-- external filters -->
		<field>
			<fieldname>ACCOUNTSRECEIVABLE.ACCRECID</fieldname>
			<filtertextoption>equal</filtertextoption>
		</field>

		<!-- fields -->
		<field>
			<fieldname>ACCOUNTSRECEIVABLE.ACCRECNUM</fieldname>
			<caption>No.</caption>
			<summary>true</summary>
			<filter>true</filter>
			<filteravailable>true</filteravailable>
			<filtertextoption>like</filtertextoption>
			<link>page.do?xml=accounts/accountReceivable&amp;act=itm&amp;jndi=ejb/CRMUIAccountReceivable&amp;fc=loadForm&amp;pv0=((ACCOUNTSRECEIVABLE.ACCRECID))&amp;pvc=1</link>
		</field>

		<field>
			<fieldname>ACCOUNTSRECEIVABLE.ACCRECNAME</fieldname>
			<caption>Name</caption>
			<summary>true</summary>
			<filter>true</filter>
		</field>
 
		... 
 
		<!-- drilldowns -->
		<field>
			<fieldname>BILLINGADDRESS</fieldname>
			<fieldfunction>''</fieldfunction>
			<caption>Billing Address</caption>
			<summary>true</summary>
			<fieldtype>label</fieldtype>
			<label>Billing Address</label>
			<link>drilldown:accounts/accountReceivable_billingAddress;hidefilters~true~CONTACTINFORMATION.CIID~((ACCOUNTSRECEIVABLE.CIID))</link>
		</field>
 
		...
 
	</fieldlist>

	<actions>
		<action>
			<caption>New</caption>
			<topmenu>true</topmenu>
			<link>page.do?xml=accounts/accountReceivable&amp;act=new&amp;fc=createButton&amp;jndi=ejb/CRMUIAccountReceivable</link>
		</action>
 
		...

	</actions>
</summary>

Summary Page Using EJB Method

Summary Page Using EJB Method

<summary xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../xsd/summary.xsd">
    <title>Warehouse Balances</title>
    <classname>ejb/CRMUIWarehouse</classname>
    <functionname>loadBalancesTab</functionname>
    <rowsperpage>20</rowsperpage>
    <primaryfield>ITEMID</primaryfield>
    <mainlinkfield>ITEMID</mainlinkfield>
    <autosearch>true</autosearch>
    <hidefindbutton>true</hidefindbutton>
    <module>INVENTORY_MANAGEMENT</module>
     
    <fieldlist>
        <!-- external filters -->
        <field>
            <fieldname>WRHID</fieldname>
            <filtertextoption>equal</filtertextoption>
        </field>
 
        <!-- fields -->
        <field>
            <fieldname>ITEMNAME</fieldname>
            <caption>Product Type</caption>
            <summary>true</summary>
            <available>true</available>
        </field>
 
        ...
 
        <!-- drilldowns -->
        ...
 
    </fieldlist>
</summary>