CustomFieldTemplate Data Type

Implemented Interfaces
IReferenceEntity, Serializable
Properties
name data type constraints description
appendGeneratedCode boolean  
regExp string  
applicableOnEl string  
customTableCodeEL string  
appliesTo string  
historized boolean  
versionable boolean  
hideInGUI boolean  
protectable boolean  
entityClazz string  
descriptionI18nNullSafe map of string  
fieldType CustomFieldTypeEnum  
listValuesSorted map of string  
referenceCode string  
indexType CustomFieldIndexTypeEnum  
listValues map of string  
matrixValueColumnCodes array of string  
parentEntityType object  
descriptionI18n map of string  
uniqueConstraint boolean  
parentEntity BusinessEntity  
calendar Calendar  
guiPosition string  
matrixColumns array of CustomFieldMatrixColumn  
allowEdit boolean  
valueRequired boolean  
codeChanged boolean  
auditableFields array of AuditableFieldHistory  
descriptionOrCode string  
active boolean  
disabled boolean  
transient boolean  
childEntityFieldsAsList array of string  
tags string  
auditable Auditable  
notified boolean  
useInheritedAsDefaultValue boolean  
mapKeyType CustomFieldMapKeyEnum  
matrixColumnCodes array of string  
anonymizeGdpr boolean  
matrixKeyColumnCodes array of string  
minValue number  
nbDecimal number  
roundingMode RoundingModeEnum  
dbFieldname string  
triggerEndPeriodEvent boolean  
childEntityFields string  
version number  
code string required, max size: 255, min size: 1
fieldsEL string  
maxValue number  
descriptionAndCode string  
id number  
storageType CustomFieldStorageTypeEnum  
hideOnNew boolean  
matrixKeyColumns array of CustomFieldMatrixColumn  
GUIFieldPosition number  
dataFilterEL string  
guiPositionParsed map of string  
defaultValueConverted object  
description string max size: 255, min size: 0
referenceDescription string  
entityClazzCetCode string  
defaultValue string  
matrixValueColumns array of CustomFieldMatrixColumn  
displayFormat string  

Example

{
  "appendGeneratedCode" : true,
  "regExp" : "...",
  "applicableOnEl" : "...",
  "customTableCodeEL" : "...",
  "appliesTo" : "...",
  "historized" : true,
  "versionable" : true,
  "hideInGUI" : true,
  "protectable" : true,
  "entityClazz" : "...",
  "descriptionI18nNullSafe" : {
    "property1" : "...",
    "property2" : "..."
  },
  "fieldType" : "DATE",
  "listValuesSorted" : {
    "property1" : "...",
    "property2" : "..."
  },
  "referenceCode" : "...",
  "indexType" : "STORE_ONLY",
  "listValues" : {
    "property1" : "...",
    "property2" : "..."
  },
  "matrixValueColumnCodes" : [ "...", "..." ],
  "parentEntityType" : { },
  "descriptionI18n" : {
    "property1" : "...",
    "property2" : "..."
  },
  "uniqueConstraint" : true,
  "parentEntity" : {
    "referenceDescription" : "...",
    "descriptionAndCode" : "...",
    "version" : 12345,
    "description" : "...",
    "appendGeneratedCode" : true,
    "referenceCode" : "...",
    "id" : 12345,
    "codeChanged" : true,
    "descriptionOrCode" : "...",
    "auditable" : {
      "lastUser" : "...",
      "created" : 12345,
      "updater" : "...",
      "lastModified" : 12345,
      "updated" : 12345,
      "creator" : "..."
    },
    "parentEntityType" : { },
    "historized" : true,
    "transient" : true,
    "parentEntity" : { },
    "code" : "...",
    "notified" : true,
    "auditableFields" : [ {
      "notfiable" : true,
      "notified" : true,
      "auditType" : "OTHER",
      "currentState" : { },
      "fieldName" : "...",
      "previousState" : { },
      "historized" : true,
      "historable" : true
    }, {
      "notfiable" : true,
      "notified" : true,
      "auditType" : "STATUS",
      "currentState" : { },
      "fieldName" : "...",
      "previousState" : { },
      "historized" : true,
      "historable" : true
    } ]
  },
  "calendar" : {
    "codeChanged" : true,
    "description" : "...",
    "descriptionOrCode" : "...",
    "descriptionI18n" : {
      "property1" : "...",
      "property2" : "..."
    },
    "historized" : true,
    "initDate" : 12345,
    "referenceDescription" : "...",
    "calendarType" : "...",
    "initDateEL" : "...",
    "version" : 12345,
    "parentEntityType" : { },
    "transient" : true,
    "initializationRequired" : true,
    "parentEntity" : {
      "referenceDescription" : "...",
      "descriptionAndCode" : "...",
      "version" : 12345,
      "description" : "...",
      "appendGeneratedCode" : true,
      "referenceCode" : "...",
      "id" : 12345,
      "codeChanged" : true,
      "descriptionOrCode" : "...",
      "auditable" : { },
      "parentEntityType" : { },
      "historized" : true,
      "transient" : true,
      "parentEntity" : { },
      "code" : "...",
      "notified" : true,
      "auditableFields" : [ { }, { } ]
    },
    "id" : 12345,
    "auditableFields" : [ {
      "notfiable" : true,
      "notified" : true,
      "auditType" : "OTHER",
      "currentState" : { },
      "fieldName" : "...",
      "previousState" : { },
      "historized" : true,
      "historable" : true
    }, {
      "notfiable" : true,
      "notified" : true,
      "auditType" : "RENEWAL",
      "currentState" : { },
      "fieldName" : "...",
      "previousState" : { },
      "historized" : true,
      "historable" : true
    } ],
    "descriptionAndCode" : "...",
    "auditable" : {
      "lastUser" : "...",
      "created" : 12345,
      "updater" : "...",
      "lastModified" : 12345,
      "updated" : 12345,
      "creator" : "..."
    },
    "code" : "...",
    "referenceCode" : "...",
    "notified" : true,
    "appendGeneratedCode" : true,
    "calendarTypeWSubtypes" : "..."
  },
  "guiPosition" : "...",
  "matrixColumns" : [ {
    "columnUse" : "USE_VALUE",
    "code" : "...",
    "position" : 12345,
    "keyType" : "RON",
    "label" : "...",
    "columnForKey" : true
  }, {
    "columnUse" : "USE_VALUE",
    "code" : "...",
    "position" : 12345,
    "keyType" : "LONG",
    "label" : "...",
    "columnForKey" : true
  } ],
  "allowEdit" : true,
  "valueRequired" : true,
  "codeChanged" : true,
  "auditableFields" : [ {
    "notfiable" : true,
    "notified" : true,
    "auditType" : "OTHER",
    "currentState" : { },
    "fieldName" : "...",
    "previousState" : { },
    "historized" : true,
    "historable" : true
  }, {
    "notfiable" : true,
    "notified" : true,
    "auditType" : "OTHER",
    "currentState" : { },
    "fieldName" : "...",
    "previousState" : { },
    "historized" : true,
    "historable" : true
  } ],
  "descriptionOrCode" : "...",
  "active" : true,
  "disabled" : true,
  "transient" : true,
  "childEntityFieldsAsList" : [ "...", "..." ],
  "tags" : "...",
  "auditable" : {
    "lastUser" : "...",
    "created" : 12345,
    "updater" : "...",
    "lastModified" : 12345,
    "updated" : 12345,
    "creator" : "..."
  },
  "notified" : true,
  "useInheritedAsDefaultValue" : true,
  "mapKeyType" : "DOUBLE",
  "matrixColumnCodes" : [ "...", "..." ],
  "anonymizeGdpr" : true,
  "matrixKeyColumnCodes" : [ "...", "..." ],
  "minValue" : 12345,
  "nbDecimal" : 12345,
  "roundingMode" : "HALF_EVEN",
  "dbFieldname" : "...",
  "triggerEndPeriodEvent" : true,
  "childEntityFields" : "...",
  "version" : 12345,
  "code" : "...",
  "fieldsEL" : "...",
  "maxValue" : 12345,
  "descriptionAndCode" : "...",
  "id" : 12345,
  "storageType" : "MATRIX",
  "hideOnNew" : true,
  "matrixKeyColumns" : [ {
    "columnUse" : "USE_KEY",
    "code" : "...",
    "position" : 12345,
    "keyType" : "LONG",
    "label" : "...",
    "columnForKey" : true
  }, {
    "columnUse" : "USE_KEY",
    "code" : "...",
    "position" : 12345,
    "keyType" : "DOUBLE",
    "label" : "...",
    "columnForKey" : true
  } ],
  "GUIFieldPosition" : 12345,
  "dataFilterEL" : "...",
  "guiPositionParsed" : {
    "property1" : "...",
    "property2" : "..."
  },
  "defaultValueConverted" : { },
  "description" : "...",
  "referenceDescription" : "...",
  "entityClazzCetCode" : "...",
  "defaultValue" : "...",
  "matrixValueColumns" : [ {
    "columnUse" : "USE_KEY",
    "code" : "...",
    "position" : 12345,
    "keyType" : "DOUBLE",
    "label" : "...",
    "columnForKey" : true
  }, {
    "columnUse" : "USE_KEY",
    "code" : "...",
    "position" : 12345,
    "keyType" : "STRING",
    "label" : "...",
    "columnForKey" : true
  } ],
  "displayFormat" : "..."
}