Versions Compared

Key

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

...

Name
Description
Value
titleThe title of the page.Any
messageDisplayed on top of the summary as a description.Any

SQL or

classname, functionname

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
rowsperpageDefines the limit of rows per page.Any numeric value

multiselect

If set, the user can select multiple records to pass them as parameters in summary actions.true or 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

groupbyUsed in order to retrieve the results grouped by the specified fields.Any SQL field
autosearchUsed in order to search the summary page automatically.true or false
hidefindbuttonUsed to hide the find buttontrue or false
orderbyfieldsUsed in order to retrieve the results ordered by the specified fieldsAny SQL field
groups

Used in order to create a group of expand fields. Multiple groups can be set separate by semicolons.

Any
entityfilterUsed in order to filter the results based on the business rules.Any entity
moduleThe related module name.Any module
fieldlistUsed 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 pagetrue or false
actionsUsed in order to open a new page through the summary page.Actions

...

Examples

Expand
titleSummary Page Using SQL

Code Block
themeEclipse
languagexml
titleSummary 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>

...