Versions Compared

Key

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

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

Any, collectionThe path related entity (if one exists).Any valid The method that will be used to set the field's value valid method name, mainfield, collection
NameDescriptionValueApplicable for

id

Unique Identifier.

Anyfield, mainfield, collection
nameA name that describes the main field/collection.field,
mainfieldxpath

The

xpath

main field

/collection name.
Anyfield, mainfield, collectionrelatedentityxpath

of the

entity

field, mainfield, collectionmethod

.

Any field tagThe tag that will be used to refer to this field in query language and communication texts.The path of the valuefield, mainfield, collection
csrexcludedIndicates if the field should be excluded from the conditional security restrictions mechanism.true, falsefield, mainfield, collection
plarexcludedIndicates if the field should be excluded from the privacy level assignment rules.true, falsefield, mainfield, collection
acrexcludedIndicates if the field should be excluded from the added conditional restrictions.true, falsefield, mainfield, collection
audittrailexcludedIndicates if the field should be excluded from the audit trailed fields.true, falsefield, mainfield, collection
mainfield

The main field of the collection.

Any field of the collectioncollection
fieldA collection field.Any field of the collectioncollection
sqlThe SQL statement.Any SQL statementfield, mainfield, collection

qlfieldname

The query language field name used in segmentsThe name of the valuefield,mainfield, collection
qlfilterSQL conditions, that the collection that are added to, will be filtered out by, when retrieved by a segmentAny valid SQL criterionfield,mainfield, collection
segmentpreviewname  field,mainfield, collection
workflowruleactionincludedIndicates if the entity should be included in workflow rule actions.true or falsefield,mainfield, collection
workflowruleconditionincludedIndicates if the entity should be included in workflow rule conditions and in which condition type to be selected
The name of the condition typefield,mainfield, collection
typeThe type of the fieldAny valid typefield,mainfield, collection

Attributes

NameDescriptionValueApplicable for
mainfield

The main field of the entity.

Any field of the entity 
fieldAn entity field.Any field of the entity 
collectionAn entity collection.Any collection of the entity 

Example

...

titleMetadata Fields
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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../xsd/fields.xsd">
Code Block
themeEclipse
languagexml
title
Metadata Fields
rentals.xml
collapsetrue
<entityfieldconfig>
	<mainfield>
		
<id>number<
<id>custom_number</id>
		
<name>Number<
<name>key_number</name>
		<xpath>number</xpath>
		
<tag>accounts_receivable
<qlfieldname>rental.number</
tag>
qlfieldname>
		
<csrexcluded>true<
<segmentpreviewname>ENTITYNUMBER</
csrexcluded>
segmentpreviewname>
	
<plarexcluded>true</plarexcluded> <acrexcluded>true</acrexcluded>
</mainfield>
	
<fields>
		<field>
			
<id>name<
<id>custom_type</id>
			
<name>Name<
<name>key_type</name>
			
<xpath>name<
<relatedentityxpath>type</
xpath>
relatedentityxpath>
			
<tag>accounts_receivable.name</tag> <csrexcluded>true</csrexcluded> <plarexcluded>true</plarexcluded> <acrexcluded>true</acrexcluded> </field>   <field> <id>type</id> <name>Type</name> <relatedentityxpath>type</relatedentityxpath> <xpath>name</xpath> <qlfieldname>activity.type</qlfieldname> <tag>activity.type</tag> <csrexcluded>false</csrexcluded> <plarexcluded>true</plarexcluded> <acrexcluded>true</acrexcluded> <audittrailexcluded>true</audittrailexcluded> <workflowruleactionincluded>false</workflowruleactionincluded>
<xpath>name</xpath>
			<workflowruleconditionincluded>FIELD_CONTAINS_VALUE</workflowruleconditionincluded>
<type>com.crm.dataobject.activities.CRMDOActivityType</type>
		</field>
		...
 

	</fields>
 
		
	<collections>
		<collection>
			
<id>subscriptions<
<id>custom_items</id>
			
<name>Account subscriptions<
<name>key_items</name>
			
<relatedentityxpath><
<relatedentityxpath/
relatedentityxpath>
>
			
<xpath>subscriptions<
<xpath>items</xpath>
			
<tag>accounts_receivable
<qlfieldname>rental.
subscription</tag> <csrexcluded>true</csrexcluded> <plarexcluded>true</plarexcluded>
items</qlfieldname>
			
<acrexcluded>true</acrexcluded>
<method>
				
<ejbname>CRMUIAccountReceivable<
<ejbname>CUSTOMCRMUIRental</ejbname>
				
<methodname>loadSubscriptionsTab<
<methodname>loadItemsTab</methodname>
				<parameters>
					<parameter>
						<xpath>[DTO]</xpath>
					</parameter>
				</parameters>
			</method>
			<mainfield>
				
<id>number<
<id>custom_serialNumber</id>
				
<name>Subscription Number<
<name>key_serialNumber</name>
				
<relatedentityxpath><
<relatedentityxpath>installedItem</relatedentityxpath>
				
<xpath>number<
<xpath>altCode</xpath>
				
<tag>accounts_receivable
<qlfieldname>rental.
subscription
items.serial_number</
tag>
qlfieldname>
			</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>
					
<tag>accounts_receivable
<qlfieldname>rental.
subscription
items.
type<
product_code</
tag>
qlfieldname>
				</field>
				...
			
...  
</fields>
		</collection>
	</collections>
</entityfieldconfig>