The entity's fields metadata required by the application's core mechanisms such as the security restrictions, query language, collaboration rules and workflow mechanisms.

Attributes

Name	Description	Value
id	Unique Identifier.	Any
name	A name that describes the main field/collection.	Any
xpath	Thexpathmain field/collection name.	Any
relatedentityxpath	The path of the related entity (if one exists).	Any valid entity
method	The method that will be used to set the field's value.	Any valid method name
tag	The tag that will be used to refer to this field in query language and communication texts.	The path of the value
csrexcluded	Indicates if the field should be excluded from the conditional security restrictions mechanism. The default value is false.	true, false
audittrailexcluded	Indicates if the field should be excluded from the audit trailed fields. The default value is false.	true, false
sql	The SQL statement.	Any SQL statement
qlfieldname	The query language field name used in segments	The name of the value
segmentpreviewname	Indicates if the field should be displayed when previewing a segment and whether it's going to be displayed as the entity's number, name, alternative code or description.	ENTITYNUMBER, ENTITYNAME, ENTITYALTCODE, ENTITYDESC
workflowruleactionincluded	Indicates if the entity should be included in workflow rule actions. The default value is false.	true, false
workflowruleconditionincluded	Indicates if the entity should be included in workflow rule conditions and in which condition type to be selected.	FIELD_CHANGE, FIELD_CONTAINS_VALUE, FIELD_FROM_TO_VALUE_CHANGE
type	The type of the field	Any valid type

Example

rentals.xml

<fields>
	<field>
		<id>custom_type</id>
		<name>key_type</name>
		<relatedentityxpath>type</relatedentityxpath>
		<xpath>name</xpath>
		<workflowruleconditionincluded>FIELD_CONTAINS_VALUE</workflowruleconditionincluded>
		<qlfieldname>rental.type.name</qlfieldname>
	</field>
	<field>
		<id>custom_type_alt_code</id>
		<name>key_type_alt_code</name>
		<relatedentityxpath>type</relatedentityxpath>
		<xpath>altCode</xpath>
  		<qlfieldname>rental.type.alternative_code</qlfieldname>
	</field>
	<field>
		<id>custom_account</id>
		<name>key_account</name>
		<relatedentityxpath>accountReceivable</relatedentityxpath>
		<workflowruleconditionincluded>FIELD_CHANGE</workflowruleconditionincluded>
		<xpath>name</xpath>
		<qlfieldname>rental.accounts_receivable.name</qlfieldname>
	</field>
	<field>
		<id>custom_state</id>
		<name>key_state</name>
		<xpath>state</xpath>
		<workflowruleconditionincluded>FIELD_CHANGE,FIELD_CONTAINS_VALUE,FIELD_FROM_TO_VALUE_CHANGE</workflowruleconditionincluded>
		<workflowruleactionincluded>true</workflowruleactionincluded>
		<qlfieldname>rental.state</qlfieldname>
	</field>
	<field>
		<id>custom_effective_date</id>
		<name>key_effective_date</name>
		<xpath>effectiveDate</xpath>
		<workflowruleconditionincluded>FIELD_FROM_TO_VALUE_CHANGE</workflowruleconditionincluded>
		<qlfieldname>rental.effective_date</qlfieldname>
	</field>
	<field>
		<id>custom_expiration_date</id>
		<name>key_expiration_date</name>
		<xpath>expirationDate</xpath>
		<workflowruleactionincluded>true</workflowruleactionincluded>
		<qlfieldname>rental.expiration_date</qlfieldname>
	</field>
	
	<field>
		<id>custom_notes</id>
		<name>key_notes</name>
		<xpath>sharedNotes</xpath>
	</field>
	
	<field>
		<id>custom_createdByUser</id>
		<name>key_created_by_user</name>
		<relatedentityxpath>createdByUser</relatedentityxpath>
		<xpath>username</xpath>
		<audittrailexcluded>true</audittrailexcluded>
	</field>
	<field>
		<id>custom_updatedByUser</id>
		<name>key_updated_by_user</name>
		<relatedentityxpath>updatedByUser</relatedentityxpath>
		<xpath>username</xpath>
		<audittrailexcluded>true</audittrailexcluded>
	</field>
	<field>
		<id>custom_createdByUnit</id>
		<name>key_created_by_unit</name>
		<relatedentityxpath>createdByUnit</relatedentityxpath>
		<xpath>name</xpath>
		<audittrailexcluded>true</audittrailexcluded>
	</field>
	<field>
		<id>custom_updatedByUnit</id>
		<name>key_updated_by_unit</name>
		<relatedentityxpath>updatedByUnit</relatedentityxpath>
		<xpath>name</xpath>
		<audittrailexcluded>true</audittrailexcluded>
	</field>
	<field>
		<id>custom_createdDate</id>
		<name>key_created_date</name>
		<xpath>createdDate</xpath>
		<audittrailexcluded>true</audittrailexcluded>
	</field>
	<field>
		<id>custom_updatedDate</id>
		<name>key_updated_date</name>
		<xpath>updatedDate</xpath>
		<audittrailexcluded>true</audittrailexcluded>
	</field>
</fields>

CRM.COM Development

Field

Attributes

Example