Skip to end of banner
Go to start of banner

Metadata Fields

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

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.

Attributes

NameDescriptionValue
mainfield

The main field of the entity.

Any field of the entity
fieldsAn entity field.Any field of the entity
collectionsAn entity collection.Any collection of the entity

Example

 Metadata Fields
Metadata 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>

Main Field

NameDescriptionValue

id

Unique Identifier.

Any
nameA name that describes the main field.Any
xpathThe xpath main field name.Any
tag  
csrexcluded true or false
plarexcluded true or false
acrexcluded true or false

Example

 Main Field
Main Field
<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>

 

 

 

 

 

NameDescriptionValue
id

Unique Identifier.

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

Example

 Fields
Fields
<entityfieldconfig>
	<fields>
		<field>
			<id>number</id>
			<name>Number</name>
			<xpath>number</xpath>
		</field>
 
		<field>
			<id>name</id>
			<name>Name</name>
			<xpath>name</xpath>
		</field>

		<field>
			<id>type</id>
			<name>Type</name>
			<relatedentityxpath>type</relatedentityxpath>
			<xpath>name</xpath>
		</field>
 
		...

	</fields>
</entityfieldconfig>
  • No labels