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 certain restrictions 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 in entities metadata file in the corresponding entity's <metadatafile> tag.

...

 
NameDescriptionValue

id

Unique Identifier.

Any
nameA name that describes the main field/field/collection.Any
xpathThe xpath main field/field/collection name.Any
relatedentityxpath  The path of the related entity (if one exists).Any valid entity
method  
tag  
csrexcludedThe method name.Any valid method name
tagUsed to fill in necessary information in templates. They indicate what values to be loaded when using the Referring To in communications.The path of the value
csrexcludedIndicates if the entity should be excluded from the conditional security restrictions.true or false
plarexcluded Indicates if the entity should be excluded from the privacy level assignment rules.true or false
acrexcluded Indicates if the entity should be excluded from the added conditional restrictions.true or false
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
sql  The SQL statement.Any SQL statement

Example

Expand
titleMetadata Fields
Code Block
themeEclipse
languagexml
titleMetadata Fields
<entityfieldconfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../xsd/fields.xsd">
	<mainfield>
		<id>number</id>
		<name>Number</name>
		<xpath>number</xpath>
		<tag>accounts_receivable.number</tag>
		<csrexcluded>true</csrexcluded>
		<plarexcluded>true</plarexcluded>
		<acrexcluded>true</acrexcluded>
	</mainfield>
		
	<fields>
		<field>
			<id>name</id>
			<name>Name</name>
			<xpath>name</xpath>
			<tag>accounts_receivable.name</tag>
			<csrexcluded>true</csrexcluded>
			<plarexcluded>true</plarexcluded>
			<acrexcluded>true</acrexcluded>
		</field>
 
		...
 
	</fields>
 
	<collections>
		<collection>
			<id>subscriptions</id>
			<name>Account subscriptions</name>
			<relatedentityxpath></relatedentityxpath>
			<xpath>subscriptions</xpath>
			<tag>accounts_receivable.subscription</tag>
			<csrexcluded>true</csrexcluded>
			<plarexcluded>true</plarexcluded>
			<acrexcluded>true</acrexcluded>
			<method>
				<ejbname>CRMUIAccountReceivable</ejbname>
				<methodname>loadSubscriptionsTab</methodname>
				<parameters>
					<parameter>
						<xpath>[DTO]</xpath>
					</parameter>
				</parameters>
			</method>
			<mainfield>
				<id>number</id>
				<name>Subscription Number</name>
				<relatedentityxpath></relatedentityxpath>
				<xpath>number</xpath>
				<tag>accounts_receivable.subscription.number</tag>
			</mainfield>
			<fields>
				<field>
					<id>type</id>
					<name>Type</name>
					<relatedentityxpath>type</relatedentityxpath>
					<xpath>name</xpath>
					<tag>accounts_receivable.subscription.type</tag>
				</field>
				
				...
 
			</collection>
	</collections>
</entityfieldconfig>