Versions Compared

Key

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

...

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

Create New Summary Pages

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

 

Expand
titleNew Summary Page Example
Code Block
languagexml
titlerentals.xml
<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	
	

Image Added

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. If not, it just has to have a unique file pathxml 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.

...

Expand
titleCustom Summary Page Example
Code Block
languagexml
titlecontactInformationCustom.xml
<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.

...