Create Custom Summary Pages

For an introduction to summary pages, go to Developing summary pages (Deprecated).

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

Create New Summary Pages

If the new summary page will not be used to override a release summary functionality must have a unique file path.

<summary>
	<title>key_rentals</title>
	<sql>FROM TRN_RENTALS
		LEFT JOIN USERS CREATEDBY ON CREATEDBY.USERID = TRN_RENTALS.RENTALCREATEDBYUSERID
		LEFT JOIN USERS UPDATEDBY ON UPDATEDBY.USERID = TRN_RENTALS.RENTALUPDATEDBYUSERID
		LEFT JOIN OUUNITS CREATEDBYUNIT ON CREATEDBYUNIT.OUUID = TRN_RENTALS.RENTALCREATEDBYOUUID
		LEFT JOIN OUUNITS UPDATEDBYUNIT ON UPDATEDBYUNIT.OUUID = TRN_RENTALS.RENTALUPDATEDBYOUUID
		LEFT JOIN ACCOUNTSRECEIVABLE ON ACCOUNTSRECEIVABLE.ACCRECID = TRN_RENTALS.ACCRECID
		LEFT JOIN TRN_RENTALTYPES ON TRN_RENTALTYPES.RENTTYPEID = TRN_RENTALS.RENTTYPEID
		WHERE TRN_RENTALS.RENTALDELETED = 0
	</sql>
	....
</summary	
	

Customise Existing Summary Pages

If the new summary page will be used to override a release summary page, must follow this naming convention: <page_filename>Custom.xml and must be defined in templates properties file.

In the following example, a new summary filter and field needs to be added to the existing contact information summary page. To do this, you have to copy release summary page contactInformation.xml in your custom projects directory under <custom_project>/web/WebContent/pages/summary/contactInfo, rename it to  contactInformationCustom.xml and add the new summary filter and field.

<summary>
	...
	<fieldlist>
		...
		<field>
			<fieldname>CONTACTINFORMATION.CIUSERFIELD2</fieldname>
			<caption>key_home_type</caption>
			<summary>true</summary>
			<filter>true</filter>
		</field>
		...
	</fieldlist>
	...
</summary	
	

Templates Properties File

The templates properties file (templates.properties) is used for defining the default summary page, generally or per community, when one or more custom summary pages exist per release summary page. Templates properties file must be created under <custom_project>/web/WebContent/pages/summary.

To define the default summary page, you have to add the following line to templates.properties file: <release_summary_page_file_path>~organisation~default=<directory_name>/<custom_summary_page_filename>

To define the default summary page for a specific community, you have to add the following line to templates.properties file:  <release_summary_page_file_path>~community~<community_id>=<directory_name>/<custom_summary_page_filename>

Note that .xml is omitted from summary_page_file_path. 

If no summary page is specified for a specific community, the default summary will be used by the system. If no default layout page is specified either, the release summary page will be used.

contactinfo/contactInformation~organisation~default=contactinfo/contactInformationCustom
contactinfo/contactInformation~community~E78B1947EBDA4ECAA38121A7F983571F=contactinfo/contactInformationCustom

For a full list of summary page attributes, go to Summary Pages Documentation.