Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
nameblue
Expand
titleReport Page

Report Pages Documentation

Report pages are used to display information in the system through SQL statements and criteria defined either in a single criteria file (.crxml) or both a criteria file in combination with a layout file (.jrxml). Note that in order to use the two files together, they must have the same name.

Child pages (Children Display)

Example

Image Removed.

Child pages (Children Display)

Attributes

Name
Description
Value
nameThe dashboard component name.Any
descriptionThe dashboard component description.Any
sqlThe dashboard component SQL statement (In the case the SQL is very simple).Any valid SQL statement
ejbThe ejb name.Any
methodThe method to call from the ejb.Any
typeThe dashboard component type.pie, stack, bar, summary
valuelabelsThe label values that the group by elements will have.<label_name>:<label_value>, ejb/<method_name>
primaryfieldThe primary field name.Any
primaryfieldlabelThe label that the primary field will have.Any
groupbyfieldThe group by field name(s).Any
groupbyfieldlabelThe label that the group by field will have.Any
summarypageThe summary page name to link to.Any
orientationThe dashboard component orientation.vertical, horizontal
settingThe dashboard component settings.Settings
fieldsThe dashboard component fields.Fields

 

Examples

Expand
titleBar Chart
Image Added

 

Code Block
themeEclipse
languagexml
titleparticipantsSignups.crxmlxml
<config>
    <name>PaymentsByUser</name>
    <description>Payments By Users</description>
    <defaultgroupby></defaultgroupby>
    <dataset></dataset>
    <sqlansi>
    SELECT p.PAYMENTID,
           p.PAYMENTNUM,
           p.PAYMENTAMT,
           p.PAYMENTCREATEDBYUSERID,
           p.PAYMENTCREATEDDATE,
           p.PAYMENTAMT,
           users.USERNAME,
           pm.PAYMETHODNAME,
           v.VOUCHERNUM,
           v.VOUCHEREXPIRATIONDATE,
           s.SUBNUM
    FROM PAYMENTS p
    INNER JOIN USERS ON USERS.USERID = p.PAYMENTCREATEDBYUSERID AND USERS.USERDELETED = 0
    INNER JOIN PAYMENTMETHODS pm ON pm.PAYMETHODID = p.PAYMETHODID AND pm.PAYMETHODDELETED = 0
    INNER JOIN VOUCHERS v on v.VOUCHERID = p.VOUCHERID AND v.VOUCHERDELETED = 0
    INNER JOIN ACCOUNTSRECEIVABLE acr on acr.ACCRECID = p.ACCRECID AND acr.ACCRECDELETED = 0
    INNER JOIN SUBSCRIPTIONS s on s.ACCRECID = acr.ACCRECID AND s.SUBDELETED = 0
    ORDER BY p.PAYMENTCREATEDDATE,
         users.USERNAME,
         p.PAYMENTCREATEDBYUSERID,
         p.PAYMETHODID
    </sqlansi>
    <copysqltosubreports>true</copysqltosubreports>
    <hql></hql>
    <criterialist>
        <criteria>
            <ordernum>1</ordernum>
            <criteriatype>0</criteriatype>
            <label>User Name</label>
            <entitytablename>users</entitytablename>
            <entityfieldname>USERNAME</entityfieldname>
            <fieldtype>ftXString</fieldtype>
            <fieldsize>32</fieldsize>
            <displaytable>USERS</displaytable>
            <displaylabel>Person Name</displaylabel>
            <displayfield>UserPersonName</displayfield>
            <sourcealias>UserName</sourcealias>
            <displayalias>UserPersonName</displayalias>
            <datasetname>users.load</datasetname>
        </criteria>
        <criteria>
            <ordernum>2</ordernum>
            <criteriatype>0</criteriatype>
            <label>Creation Date</label>
            <entitytablename>p</entitytablename>
            <entityfieldname>PAYMENTCREATEDDATE</entityfieldname>
            <fieldtype>ftXdatetime</fieldtype>
            <fieldsize>32</fieldsize>
        </criteria>
        <criteria>
            <ordernum>3</ordernum>
            <criteriatype>0</criteriatype>
            <label>Payment Method</label>
            <extralabel>Payment Method</extralabel>
            <tooltip></tooltip>
            <hibernatefield></hibernatefield>
            <entitytablename>p</entitytablename>
            <entityfieldname>paymethodid</entityfieldname>
            <displaytable>Payments</displaytable>
            <displaylabel></displaylabel>
            <displayfield>paymethodname</displayfield>
            <fieldtype>ftXString</fieldtype>
            <fieldsize>32</fieldsize>
            <sourcealias>paymethodid</sourcealias>
            <displayalias>paymethodname</displayalias>
            <datasetname>financialtransactions.loadpaymentmethods</datasetname>
            <treename></treename>
            <multiselect>1</multiselect>
        </criteria>
    </criterialist>
</config> 
.jrxmlImage Removed
<dashboardcomponent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../xsd/dashboards.xsd">
	<name>Rewards Participants Signups</name>
	<description>Rewards Participants Signups Bar Chart</description>
	<ejb>CRMUIRewardDashboard</ejb>
	<method>loadParticipantsSignups</method>
	<type>bar</type>
	<orientation>horizontal</orientation>
	<primaryfield>REWARDPARTICIPANTS.REWPARTID</primaryfield>
	<primaryfieldlabel>Number of Rewards Participants</primaryfieldlabel>
	<groupbyfield>MONTH_SIGN_UP_DATE_FILTER</groupbyfield>
	<summarypage>rewards/participants</summarypage>
</dashboardcomponent>