Collection

Owned by Former user (Deleted)
Last updated: Dec 16, 2016
1 min read

The entity's collection metadata required by the application's core mechanisms such as the security restrictions, query language, collaboration rules and workflow mechanisms.

Attributes

NameDescriptionValue

id

Unique Identifier.

Any
nameA name that describes the main field/collection.Any
xpathThexpathmain field/collection name.Any
relatedentityxpathThe path of the related entity (if one exists).Any valid entity
methodThe method that will be used to set the field's value.Any valid method name
tagThe tag that will be used to refer to this field in query language and communication texts.The path of the value
csrexcludedIndicates if the field should be excluded from the conditional security restrictions mechanism.true, false
audittrailexcludedIndicates if the field should be excluded from the audit trailed fields.true, false
mainfield

The main field of the collection.

Any field of the collection
fieldA collection field.Any field of the collection
sqlThe SQL statement.Any SQL statement

qlfieldname

The query language field name used in segmentsThe name of the value
qlfilterSQL conditions, that the collection that are added to, will be filtered out by, when retrieved by a segmentAny valid SQL condition
segmentpreviewnameIndicates if the field should be displayed when previewing a segment and whether it's going to be displayed as the entity's number, name, alternative code or description.ENTITYNUMBER, ENTITYNAME, ENTITYALTCODE, ENTITYDESC
workflowruleactionincludedIndicates if the entity should be included in workflow rule actions.true, false
workflowruleconditionincludedIndicates if the entity should be included in workflow rule conditions and in which condition type to be selectedFIELD_CHANGE, FIELD_CONTAINS_VALUE, FIELD_FROM_TO_VALUE_CHANGE
typeThe type of the fieldAny valid type

Example

rentals.xml 
<collections>
	<collection>
		<id>custom_items</id>
		<name>key_items</name>
		<relatedentityxpath/>
		<xpath>items</xpath>
		<qlfieldname>rental.items</qlfieldname>
		<method>
			<ejbname>CUSTOMCRMUIRental</ejbname>
			<methodname>loadItemsTab</methodname>
			<parameters>
				<parameter>
					<xpath>[DTO]</xpath>
				</parameter>
			</parameters>
		</method>
		<mainfield>
			<id>custom_serialNumber</id>
			<name>key_serialNumber</name>
			<relatedentityxpath>installedItem</relatedentityxpath>
			<xpath>altCode</xpath>
			<qlfieldname>rental.items.serial_number</qlfieldname>
		</mainfield>
		<fields>
			<field>
				<id>custom_code</id>
				<name>key_product_code</name>
				<relatedentityxpath>installedItem</relatedentityxpath>
				<xpath>product/code</xpath>
				<qlfieldname>rental.items.product_code</qlfieldname>
			</field>
			<field>
				<id>custom_type</id>
				<name>key_product_type</name>
				<relatedentityxpath>installedItem</relatedentityxpath>
				<xpath>product/type/name</xpath>
				<qlfieldname>rental.items.product_type</qlfieldname>
			</field>
		</fields>
	</collection>
	...
</collections>