Versions Compared

Key

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

This tag is used to define a field on the page. A field can be a filter, a summary field, or both.

Attributes

...

NameDescriptionValues
fieldfunctionThe value that the field will take.Valid sql SQL field or statement.
fieldnameThe value that the field will take if there is no fieldfunction tag or the is not defined. / The name of the variable that will hold the field's value if fieldfunction tag is defined.Valid sql field OR any.SQL field / Any
captionThe name that will appear on the label next to the filter box if it's a filter field and/or on the top of the column if it's a summary field.Any.
filterDefines if the field is a filter field or not.true , or false
summaryDefines if the field is a summary field or not.true , or false
filteravailableDefines if the field is available to addbe added/remove it removed from the filters in the preferences section.true , or false
availableDefines if the summary field is available to addbe added/remove it removed from the summary fields in the preferences section.true , or false
filterlookupnameDefines the dataset search file that will be used to search for available values for the field.[[datapathdataset;containingsearch_folder.xmlfilepage;serachsearch_field;display_field]] *****
mouseoverDefines if the field will appear when you mouseover hover the mouse over the field that links to the data entry page.true , or false
expandDefines if the field will appear when the expand button is clicked.true , or false
fieldtypeDefines the data type of the field.integer, string, date,  label, float, datetime, sharednote
filtercaseinsensitiveDefines if the field is case insensitive or not.true , or false
filtertextoptionDefines if the filter field must begin with a value, end with a value, be equal to value, between two values, like a value, contain a value, show a checkbox and filter with value 1 when is checked or show a checkbox and filter by 0=unchecked, 1=checkedbeginwith, endwith, equal, range, ge, le, like, contains, checkbox, checkboxonoff
linkTurns the field into a link. If it has no prefix it opens in the current browser window. If it has the newwindow prefix it  opens it opens in a new window. If it has the drilldown prefix it opens a drilldown xml under the selected row. If it has the drilldownwithparentparams it passes all the filters of the parent xml to the drilldown.[[prefix:path;*****]]
fixedlookupUsed to retrieve the value options for the field and put them in a drop down list.'[[class.method]]' : '(All,N/A)' *****
filterconditionFilters the results of the filter.Valid sql SQL statement.
filteronexpandDefines if the filter field will appear when the expand button is clicked.true , or false
dateonlyDefines if the field will be of date type only and ignore the time.true , or false
labelThe name that will appear on the field's link.Any
formattingThe field formatting setting.

Examples

For fieldtype double - the number of digits

For fieldtype string - "glossary" to translate the field's value

For fieldtype date - "persian" to convert to Persian date (Jalali), "msec" to convert the date to milliseconds

caseinsensitivefieldnameThe case insensitive field name (applies only to fields that have a case insensitive field name)A valid field name

Examples

filteronexpand
Expand
titlefilterfieldfunction
title
Code Block
themeEclipse
languagexml
titlefilterfieldfunction
<fieldlist>
 <field>
	<fieldname>NAME</fieldname>
		...
 <fieldfunction> 
	CASE 
		<!-- fields -->WHEN CONTACTINFORMATION.CITYPE = 'COMPANY' 
		<field>THEN CONTACTINFORMATION.CICOMPANYNAME
			<fieldname>PRODUCTS.PRODCODE</fieldname>
			<caption>Code</caption>
			<filter>true</filter>
			<filtercaseinsensitive>true</filtercaseinsensitive>
			<link>page.do?xml=products/product&amp;act=itm&amp;jndi=ejb/CRMUIProduct&amp;fc=loadForm&amp;pv0=((PRODUCTS.PRODID))&amp;pvc=1</link>
		</field>

		<field>
			<fieldname>PRODUCTTYPES.PRODTYPEID</fieldname>
			<caption>Type</caption>
			<filter>true</filter>
			<filterlookupname>dataset;products.loadtypes;prodtypeid;prodtypename</filterlookupname>
		</field>
 
		...
 
</fieldlist>

Image Removed

 

Expand
WHEN CONTACTINFODEFINITIONS.CIDEFNAMEGENRULE = 1 
		THEN CONTACTINFORMATION.CIFIRSTNAME SQL_+ ' ' SQL_+ CONTACTINFORMATION.CILASTNAME 
		WHEN CONTACTINFODEFINITIONS.CIDEFNAMEGENRULE = 2 
		THEN CONTACTINFORMATION.CILASTNAME SQL_+ ' ' SQL_+ CONTACTINFORMATION.CIFIRSTNAME 
		WHEN CONTACTINFODEFINITIONS.CIDEFNAMEGENRULE = 3 
		THEN CONTACTINFORMATION.CIFIRSTNAME SQL_+ ' ' SQL_+ 
			COALESCE (CONTACTINFORMATION.CIMIDDLENAME SQL_+ ' ','') SQL_+ '' SQL_+ CONTACTINFORMATION.CILASTNAME 
		WHEN CONTACTINFODEFINITIONS.CIDEFNAMEGENRULE = 4 
		THEN CONTACTINFORMATION.CILASTNAME SQL_+ ' ' SQL_+ 
			COALESCE (CONTACTINFORMATION.CIMIDDLENAME SQL_+ ' ','') SQL_+ '' SQL_+ CONTACTINFORMATION.CIFIRSTNAME 
	END
	</fieldfunction>
	<caption>key_name</caption>
	<filter>true</filter>
	<filtercaseinsensitive>true</filtercaseinsensitive>
	<filtertextoption>contains</filtertextoption>
</field>
Expand
titlefieldname
Code Block
themeEclipse
languagexml
titlefieldname
<field>
	<fieldname>TRN_RENTALS.RENTALNOTES</fieldname>
	<caption>key_notes</caption>
	<summary>true</summary>
	<filteravailable>true</filteravailable>
</field>
summary
Expand
titlecaption
title
Code Block
themeEclipse
languagexml
titlefilteronexpandcaption
<fieldlist>
 
		...
 
		<!-- fields -->
		<field>
			<fieldname>PRODUCTS.PRODDESC</fieldname>
			<caption>Description</caption>
			<filter>true</filter>
			<filteronexpand>true</filteronexpand>
		</field>

		<field>
			<fieldname>PRICEPLAN_FILTER</fieldname>
			<fieldfunction>PRODUCTS.PRODID</fieldfunction>
			<caption>Price Plan</caption>
			<filter>true</filter>
			<filteravailable>true</filteravailable>
			<fieldtype>string</fieldtype>
			<filtercaseinsensitive>false</filtercaseinsensitive>
			<filtercondition>
				PRODUCTS.PRODID IN (
							SELECT PRICEPLANRATES.PRICEPLANRATEPRODID
							FROM  PRICEPLANRATES
							WHERE PRICEPLANRATES.PRICEPLANID IN ('#1') 
							AND PRICEPLANRATES.PRICEPLANRATEDELETED = 0 
				)
			</filtercondition>
			<filteronexpand>true</filteronexpand>			
			<filterlookupname>dataset;priceplan.load;priceplanid;priceplanname</filterlookupname>
		</field>
 
		...
 
</fieldlist>

Image Removed

 

Expand
<field>
	<fieldname>RENTAL_TYPE</fieldname>
	<fieldfunction>TRN_RENTALTYPES.RENTTYPENAME</fieldfunction>
	<caption>key_rental_type</caption>
	<summary>true</summary>
</field>
Expand
titlefilter
Code Block
themeEclipse
languagexml
titlefilter
<field>
	<fieldname>RENTAL_TYPE_FILTER</fieldname>
	<fieldfunction>TRN_RENTALTYPES.RENTTYPENAME</fieldfunction>
	<caption>key_rental_type</caption>
	<filter>true</filter>
	<filterlookupname>dataset;rentals.loadtypes;renttypeid;renttypename</filterlookupname>
</field>
Expand
titlesummary
Code Block
themeEclipse
languagexml
titlesummary
<field>
	<fieldname>RENTAL_TYPE</fieldname>
	<fieldfunction>TRN_RENTALTYPES.RENTTYPENAME</fieldfunction>
	<caption>key_rental_type</caption>
	<summary>true</summary>
</field>
Expand
titlefilteravailable
Code Block
themeEclipse
languagexml
titlefilteravailable
<field>
	<fieldname>TRN_RENTALS.RENTALNOTES</fieldname>
	<caption>key_notes</caption>
	<available>true</available>
	<filteravailable>true</filteravailable>
	<mousover>true</mousover>
</field>
Expand
titleavailable
Code Block
themeEclipse
languagexml
titleavailable
<field>
	<fieldname>TRN_RENTALS.RENTALNOTES</fieldname>
	<caption>key_notes</caption>
	<available>true</available>
	<filteravailable>true</filteravailable>
	<mousover>true</mousover>
</field>
Expand
titlefilterlookupname
Code Block
themeEclipse
languagexml
titlefilterlookupname
<field>
	<fieldname>CREATEDBY_FILTER</fieldname>
	<fieldfunction>CREATEDBY.USERID</fieldfunction>
	<caption>key_created_by_user</caption>
	<filter>true</filter>
	<filteronexpand>true</filteronexpand>
	<filterlookupname>dataset;users.load;userid;username:name</filterlookupname>
</field>
Expand
titlemouseover
<fieldlist>   ...   <!-- fields -->
Code Block
themeEclipse
languagexml
titlesummary
mouseover
<field>
			<fieldname>PRODUCTS.PRODALTCODE<<fieldname>TRN_RENTALS.RENTALNOTES</fieldname>
			<caption>Alternative Code<<caption>key_notes</caption>
	<available>true</available>
	<filteravailable>true</filteravailable>
	<summary>true<<mouseover>true</summary>mouseover>
		</field>
		
Expand
titleexpand
Code Block
themeEclipse
languagexml
titleexpand
<field>
			<fieldname>CLASSIFICATION<<fieldname>UPDATEDBYUNITOUUNAME</fieldname>
			<fieldfunction>PRODUCTTYPES<fieldfunction>UPDATEDBYUNIT.PRODTYPECLASSIFICATION<OUUNAME</fieldfunction>
			<caption>Classification<<caption>key_updated_by_unit</caption>
			<summary>true</summary>
			<fixedlookup>ejb/CRMUIProductType.getClassificationOptions:N/A</fixedlookup>
		</field>
 
		...
 
</fieldlist>

Image Removed

 
<expand>true</expand>
</field>
Expand
titlefieldtype
Code Block
themeEclipse
languagexml
titlefieldtype
<field>
	<fieldname>TRN_RENTALS.RENTALEFFECTIVEDATE</fieldname>
	<caption>key_effective_date</caption>
	<expand>true</expand>
	<filter>true</filter>
	<fieldtype>date</fieldtype>
	<filtertextoption>range</filtertextoption>
	<filteronexpand>true</filteronexpand>
	<dateonly>true</dateonly>
</field>
mouseover
Expand
titleexpandfiltercaseinsensitive
title<fieldlist>  
Code Block
themeEclipse
languagexml
titleexpand
filtercaseinsensitive
<field>
	<fieldname>NAME</fieldname>
	<fieldfunction> 
	CASE 
		WHEN CONTACTINFORMATION.CIISCOMPANY = 1 
		THEN CONTACTINFORMATION.CICOMPANYNAME
	 	WHEN CONTACTINFODEFINITIONS.CIDEFNAMEGENRULE = 1  
		<!-- fields -->
		<field>
			<fieldname>PRODUCTFAMILIES.PRODFAMILYNAME</fieldname>
			<caption>Family</caption>
			<expand>true</expand>
		</field>

		<field>
			<fieldname>PRODUCTBRANDS.PRODBRANDNAME</fieldname>
			<caption>Brand</caption>
			<expand>true</expand>
		</field>
 
		...
 
</fieldlist>

Image Removed

 

Expand
THEN CONTACTINFORMATION.CIFIRSTNAME || ' ' || CONTACTINFORMATION.CILASTNAME 
	 	WHEN CONTACTINFODEFINITIONS.CIDEFNAMEGENRULE = 2 
		THEN CONTACTINFORMATION.CILASTNAME|| ' ' || CONTACTINFORMATION.CIFIRSTNAME 
	 	WHEN CONTACTINFODEFINITIONS.CIDEFNAMEGENRULE = 3 
		THEN CONTACTINFORMATION.CIFIRSTNAME || ' ' || 
			COALESCE (CONTACTINFORMATION.CIMIDDLENAME || ' ','') || '' || CONTACTINFORMATION.CILASTNAME 
	 	WHEN CONTACTINFODEFINITIONS.CIDEFNAMEGENRULE = 4 
		THEN CONTACTINFORMATION.CILASTNAME|| ' ' || 
			COALESCE (CONTACTINFORMATION.CIMIDDLENAME || ' ','') || '' || CONTACTINFORMATION.CIFIRSTNAME 
	END
	</fieldfunction>
	<caption>Name</caption>
	<summary>true</summary>
	<mouseover>true</mouseover>
	<filter>true</filter>
	<filteravailable>true</filteravailable>
	<filtercaseinsensitive>true</filtercaseinsensitive>
	<filtertextoption>contains</filtertextoption>
	<link>page.do?xml=contactinfo/contactInformation&amp;act=itm&amp;bh=bind&amp;fc=loadForm&amp;jndi=ejb/CRMUIContactInformation&amp;pv0=((CONTACTINFORMATION.CIID))&amp;pvc=1</link>
</field>
Expand
titlefiltertextoption
Code Block
themeEclipse
languagexml
titlemouseoverfiltertextoption
<fieldlist><field>
 
		...
 
		<!-- fields -->
		<field>
			<fieldname>PRODUCTTYPES.PRODTYPENAME</fieldname>
			<caption>Type</caption>
		<fieldname>TRN_RENTITEMS.RENTALID</fieldname>
	<filtertextoption>equal</filtertextoption>
</field>
hidefindbutton
Expand
titlelink
title
Code Block
themeEclipse
languagexml
titlelink
<field>
	<fieldname>TRN_RENTALS.RENTALNUM</fieldname>
	<caption>key_number</caption>
	<summary>true</summary>
	<filter>true</filter>
	<fieldtype>string</fieldtype>
	<mouseover>true<<filtertextoption>equals</mouseover>
		</field>

		<field>
			<fieldname>CLASSIFICATION</fieldname>
			<fieldfunction>PRODUCTTYPES.PRODTYPECLASSIFICATION</fieldfunction>
			<caption>Classification</caption>
			<summary>true</summary>
			<mouseover>true</mouseover>
			<fixedlookup>ejb/CRMUIProductType.getClassificationOptions:N/A</fixedlookup>
		</field>
 
		...
 
</fieldlist>

Image Removed

 

Expand
filtertextoption>
	<link>page.do?xml=rentals/rental&amp;act=itm&amp;jndi=ejb/CUSTOMCRMUIRental&amp;fc=loadForm&amp;pv0=((TRN_RENTALS.RENTALID))&amp;pvc=1</link>
</field>
Expand
titlefixedlookup
Code Block
themeEclipse
languagexml
titlefixedlookup
<field>
	<fieldname>STATE_FILTER</fieldname>
	<fieldfunction>TRN_RENTALS.RENTALSTATE</fieldfunction>
	<caption>key_state</caption>
	<summary>false</summary>
	<filter>true</filter>
	<filtertextoption>equal</filtertextoption>
	<fixedlookup>ejb/CUSTOMCRMUIRental.getStateOptions:key_all</fixedlookup>
</field>
Expand
titlefiltercondition
Code Block
themeEclipse
languagexml
titlehidefindbutton
<hidefindbutton>true</hidefindbutton>  
Image Removed
filtercondition
<field>
	<fieldname>CONTACT_INFO_PHONE_FILTER</fieldname>
	<fieldfunction>CONTACTINFORMATION.CIID</fieldfunction>
	<caption>key_phone_number</caption>
	<filter>true</filter>
	<filtercondition> 
	CONTACTINFORMATION.CIID IN (
		SELECT CONTACTINFOPHONES.CIID FROM CONTACTINFOPHONES
		WHERE CONTACTINFOPHONES.CIPHONEID IN ('#1') 
		AND CONTACTINFOPHONES.CIPHONEDELETED = 0
	)
	</filtercondition>
	<filterlookupname>dataset;contactinfo.loadphones;ciphoneid;ciphonenum</filterlookupname>
</field>
Expand
titlehidetitlebarfilteronexpand
Code Block
themeEclipse
languagexml
titlehidetitlebar
<hidetitlebar>true</hidetitlebar>  

Image Removed

filteronexpand
<field>
	<fieldname>TRN_RENTALS.RENTALEFFECTIVEDATE</fieldname>
	<caption>key_effective_date</caption>
	<expand>true</expand>
	<filter>true</filter>
	<fieldtype>date</fieldtype>
	<filtertextoption>range</filtertextoption>
	<filteronexpand>true</filteronexpand>
	<dateonly>true</dateonly>
</field>
Expand
titlemessagedateonly
Code Block
themeEclipse
languagexml
titlemessagedateonly
<message>Contact information related with persons or companies is retrieved and any details such as addresses, emails, and phones are displayed.</message>
Image Removed
<field>
	<fieldname>TRN_RENTALS.RENTALEFFECTIVEDATE</fieldname>
	<caption>key_effective_date</caption>
	<expand>true</expand>
	<filter>true</filter>
	<fieldtype>date</fieldtype>
	<filtertextoption>range</filtertextoption>
	<filteronexpand>true</filteronexpand>
	<dateonly>true</dateonly>
</field>
Expand
titlemultiselectlabel
Code Block
themeEclipse
languagexml
titlemultiselect
<multiselect>true</multiselect>
Image Removed
label
<field>
	<fieldname>ITEMS</fieldname>
	<fieldfunction>''</fieldfunction>
	<caption>key_items</caption>
	<summary>true</summary>
	<fieldtype>label</fieldtype>
	<label>key_items</label>
	<link>drilldown:rentals/items;hidefilters~true~TRN_RENTITEMS.RENTALID~((TRN_RENTALS.RENTALID))</link>
</field>
Expand
titleorderbyfieldsformatting
Code Block
themeEclipse
languagexml
titleorderbyfieldsformatting
<field>
	<fieldname>BALANCE</fieldname>
	<caption>key_balance</caption>
 <orderbyfields>SUBSCRIPTIONS.SUBNUM</orderbyfields>
Image Removed
	<formatting>2</formatting>
	<summary>true</summary>
</field>