Fields metadata

In fields metadata file, we define the entity's fields metadata required by the application's core mechanisms such as the security restrictions, query language, collaboration rules and workflow mechanisms.

 

What does this section cover?

Attributes

NameDescriptionValue
mainfield

The main field of the entity.

Any field of the entity
fieldsContains the fields of the entity and their metadata informationA list of entity fields
collectionsContains the collections of the entity and their metadata informationA list of entity collections

Example

rentals.xml
<entityfieldconfig>
	<mainfield>
		<id>custom_number</id>
		<name>key_number</name>
		<xpath>number</xpath>
		<qlfieldname>rental.number</qlfieldname>
		<segmentpreviewname>ENTITYNUMBER</segmentpreviewname>
	</mainfield>
	<fields>
		<field>
			<id>custom_type</id>
			<name>key_type</name>
			<relatedentityxpath>type</relatedentityxpath>
			<xpath>name</xpath>
			<workflowruleconditionincluded>FIELD_CONTAINS_VALUE</workflowruleconditionincluded>
		</field>
		...
	</fields>
		
	<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>
				...
			</fields>
		</collection>
	</collections>
</entityfieldconfig>