Customize Fields Metadata

Fields metadata file is used to define the fields of a specific entity along with their properties and characteristics

 

What does this section cover?

Fields File

Each entity's custom fields and each custom entity's fields are declared in a fields file which is created under  <custom_project>/web/WebContent/metadata/fields directory.

The name of the file to create should be the one defined, using <metadatafile> tag, in entities metadata file.

Define custom fields

All fields defined in a custom fields file should have a field id starting with CUSTOM.

In the following example, a new custom contact information field is defined in contactinformation.xml file under  <custom_project>/web/WebContent/metadata/fields directory.

contactinformation.xml
<fields>
	<field>
			<id>customhometype</id>
			<name>key_home_type</name>
			<xpath>homeType</xpath>
			<qlfieldname>contact_information.home_type</qlfieldname>
			<csrexcluded>false</csrexcluded>
			<plarexcluded>true</plarexcluded>
			<acrexcluded>true</acrexcluded>
			<audittrailexcluded>false</audittrailexcluded>
	</field>
<fields>

 

For a full list of metadata fields attributes, go to Fields Metadata.