Versions Compared

Key

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

Metadata Fields

The fields XML files are XML files that describe all the fields and datapaths of their respective entity (i.e. the accountsreceivable.xml describes the AccountReceivable entity). By including these fields in these XML files, we are stating that the restrictions isEditable, isViewable, and isMandatory can be applied to them, and can be configured in the Security Profiles. In order to apply the restrictions at a field, the field's filename should be included in entities metadata file in the corresponding entity's <metadatafile> tag.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?

Child pages (Children Display)

Attributes

NameDescriptionValue
id

Unique Identifier

Any
nameA name that describes the fieldAny
xpathThe xpath field nameAny
relatedentityxpathThe name of the related entity as it's defined in data class of the main entityAny

Example

...

titleFields
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

<entityfieldconfig>
Code Block
themeEclipse
languagexml
title
Fields
rentals.xml
collapsetrue
<entityfieldconfig>
	<mainfield>
		<id>custom_number</id>
		<name>key_number</name>
		<xpath>number</xpath>
		<qlfieldname>rental.number</qlfieldname>
		<segmentpreviewname>ENTITYNUMBER</segmentpreviewname>
	</mainfield>
	<fields>
		<field>
			
<id>number<
<id>custom_type</id>
			
<name>Number<
<name>key_type</name>
			
<xpath>number</xpath>
<relatedentityxpath>type</relatedentityxpath>
			<xpath>name</xpath>
			<workflowruleconditionincluded>FIELD_CONTAINS_VALUE</workflowruleconditionincluded>
		</field>
  <field> <id>name<
		...
	</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>Name<
	<name>key_serialNumber</name>
				
<xpath>name<
<relatedentityxpath>installedItem</relatedentityxpath>
				<xpath>altCode</xpath>
				<qlfieldname>rental.items.serial_number</qlfieldname>
			</
field>
mainfield>
			<fields>
				<field>
				
<id>type<
	<id>custom_code</id>
					
<name>Type<
<name>key_product_code</name>
					
<relatedentityxpath>type<
<relatedentityxpath>installedItem</relatedentityxpath>
					
<xpath>name<
<xpath>product/code</xpath>
					<qlfieldname>rental.items.product_code</qlfieldname>
				</field>
 
				...
			</fields>
		</collection>
	</
fields>
collections>
</entityfieldconfig>