Versions Compared

Key

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

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

Attributes

NameDescriptionValue

id

Unique Identifier.

Any
nameA name that describes the main field/collection.Any
xpathThexpathmain field/collection name.Any
relatedentityxpathThe path of the related entity (if one exists).Any valid entity
methodThe method that will be used to set the field's value.Any valid method name
tagThe tag that will be used to refer to this field in query language and communication texts.The path of the value
csrexcludedIndicates if the field should be excluded from the conditional security restrictions mechanism.true, false
plarexcludedIndicates if the field should be excluded from the privacy level assignment rules.true, false
acrexcludedIndicates if the field should be excluded from the added conditional restrictions.true, false
audittrailexcludedIndicates if the field should be excluded from the audit trailed fields.true, false
mainfield

The main field of the collection.

Any field of the collection
fieldA collection field.Any field of the collection
sqlThe SQL statement.Any SQL statement

qlfieldname

The query language field name used in segmentsThe name of the value
qlfilterSQL conditions, that the collection that are added to, will be filtered out by, when retrieved by a segmentAny valid SQL criterion
segmentpreviewnameDefines whether the field is to be displayed when previewing a segment as the entity's number, name, alternative code or description.ENTITYNUMBER, ENTITYNAME, ENTITYALTCODE, ENTITYDESC
workflowruleactionincludedIndicates if the entity should be included in workflow rule actions.true or false
workflowruleconditionincludedIndicates if the entity should be included in workflow rule conditions and in which condition type to be selectedThe name of the condition type
typeThe type of the fieldAny valid type