Versions Compared

Key

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

...

Panel
name

Description

The xml files that are located in the fields folder (/Crm/WebContent/metadata/fields) 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.

blue

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

Examples

...

languagexml

...

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

Code Block
themeEclipse
languagexml
titlerentals.xml
collapsetrue
<entityfieldconfig>
	<mainfield>
		<id>custom_number</id>
		<name>key_number</name>
		<xpath>number</xpath>
		</field>
 <qlfieldname>rental.number</qlfieldname>
		<field>
			<id>name</id>
			<name>Name</name>
			<xpath>name</xpath>
		</field>

		<segmentpreviewname>ENTITYNUMBER</segmentpreviewname>
	</mainfield>
	<fields>
		<field>
			<id>type<<id>custom_type</id>
			<name>Type<<name>key_type</name>
			<relatedentityxpath>type</relatedentityxpath>
			<xpath>name</xpath>
			<workflowruleconditionincluded>FIELD_CONTAINS_VALUE</workflowruleconditionincluded>
		</field>
 
		...
 
	</fields>
		
	<collections>
		<field><collection>
			<id>createdByUser<<id>custom_items</id>
			<name>Created By User<<name>key_items</name>
			<relatedentityxpath>createdByUser<<relatedentityxpath/relatedentityxpath>>
			<xpath>username<<xpath>items</xpath>
			<<qlfieldname>rental.items</field>qlfieldname>

			<field><method>
				<id>updatedByUser<<ejbname>CUSTOMCRMUIRental</id>ejbname>
				<name>Updated By User</name><methodname>loadItemsTab</methodname>
			<relatedentityxpath>updatedByUser</relatedentityxpath>	<parameters>
			<xpath>username</xpath>
		</field><parameter>

			<field>
			<id>createdByUnit</id>
			<name>Created By Unit</name>
<xpath>[DTO]</xpath>
					<relatedentityxpath>createdByUnit<</relatedentityxpath>parameter>
				<xpath>name<</xpath>parameters>
			</field>method>

			<field><mainfield>
			<id>updatedByUnit<	<id>custom_serialNumber</id>
				<name>Updated By Unit<<name>key_serialNumber</name>
			<relatedentityxpath>updatedByUnit<	<relatedentityxpath>installedItem</relatedentityxpath>
			<xpath>name<	<xpath>altCode</xpath>
				<qlfieldname>rental.items.serial_number</qlfieldname>
			</field>mainfield>
			<fields>
				<field>
					<id>createdDate<<id>custom_code</id>
			<name>Created Date<		<name>key_product_code</name>
					<xpath>createdDate<<relatedentityxpath>installedItem</xpath>relatedentityxpath>
		</field>

		<field>
			<xpath>product/code</xpath>
					<qlfieldname>rental.items.product_code</qlfieldname>
				<id>updatedDate<</id>field>
				<name>Updated Date</name>
...
			<xpath>updatedDate<</xpath>fields>
		</field>
collection>
	</fields>
collections>
</entityfieldconfig>