customFieldTemplateDto Data Type

The Class CustomFieldTemplateDto.

Namespace
(Default)
Properties
name data type type namespace min/max occurs constraints wrapped by description
accountLevel string element 0/1     The account level.
allowEdit boolean element 0/1     Can value be changed when editing a previously saved entity.
applicableOnEl string element 0/1     EL expression (including #{}) to evaluate when field is applicable.
appliesTo string element 0/1     PROVIDER - Provider, Seller - Seller, Customer - customer, CustomerAccount - Customer account, BillingAccount - Billing Account, UserAccount - User account, Subscription - subscription, Access - access, ChargeTemplate - charge template, ServiceInstance - service instance, ServiceTemplate - service template, OfferTemplateCategory - Offer template category, OfferTemplate - Offer template, JOB_XX - Job instance, CE_ - Custom entity instance.
cacheValue boolean element 0/1     Should value be cached. As of v.4.7 not used anymore
cacheValueTimeperiod int element 0/1     How long versionable values be cached past the period end date. As of v.4.7 not used anymore
calendar string element 0/1     Calendar associated to value versioning periods.
defaultValue string element 0/1     Default value.
displayFormat string element 0/1     display format.
entityClazz string element 0/1     Entity class and CET code for a reference to entity or child entity type fields.
fieldCode string element 0/unbounded   childEntityFieldsForSummary A list of child entity fields to be displayed in a summary table of child entities.
fieldType customFieldTypeEnum element 1/1 required   Value type.
guiPosition string element 0/1     Where field should be displayed. Format: tab:<tab name>:<tab relative position>;fieldGroup:<fieldgroup name>:<fieldgroup relative position>;field:<field relative position in fieldgroup Tab and field group names support translation in the following format: <default value>|<language3 letter key=translated value> e.g. tab:Tab default title|FRA=Title in french|ENG=Title in english:0;fieldGroup:Field group default label|FRA=Field group label in french|ENG=Field group label in english:0;field:0 OR tab:Second tab:1;field:1
hideOnNew boolean element 0/1     Do not show/apply field on new entity creation.
indexType customFieldIndexTypeEnum element 0/1     If and how custom field values should be indexed in Elastic Search.
languageDescriptions languageDescriptionDto element 0/unbounded     The language descriptions.
listValues (custom) element 0/1     List of values for LIST type field.
mapKeyType customFieldMapKeyEnum element 0/1     Key format of a map for map type fields.
matrixColumn customFieldMatrixColumnDto element 0/unbounded   matrixColumns A list of columns matrix consists of.
maxValue long element 0/1     Maximum value to validate long and double values OR maximum length of string value.
minValue long element 0/1     Minimum value to validate long and double values.
nbDecimal int element 0/1     The digit's number of a decimal for a double type.
regExp string element 0/1     Regular expression to validate string values.
roundingMode roundingModeEnum element 0/1     The rounding mode.
storageType customFieldStorageTypeEnum element 1/1 required   Value storage type.
tags string element 0/1     Tags assigned to custom field template.
triggerEndPeriodEvent boolean element 0/1     Should Period end event be fired when value period is over.
useInheritedAsDefaultValue boolean element 0/1     Shall inherited value be used as default value instead if available.
valueRequired boolean element 0/1     Is value required.
versionable boolean element 0/1     Is value versionable.
Properties inherited from enableBusinessDto
code string attribute 1/1     The code
description string attribute 0/1     The description
id long attribute 0/1     The id.
auditable auditableDto element 0/1      
auditableField auditableFieldDto element 0/unbounded   auditableFields  
disabled boolean element 0/1     Is entity disabled. Value is ignored in Update action - use enable/disable API instead.
updatedCode string element 0/1     The updated code.

Example

<CustomFieldTemplate code="..." description="..." id="...">
  <languageDescriptions>
    <languageCode>...</languageCode>
    <description>...</description>
  </languageDescriptions>
  <fieldType>...</fieldType>
  <appliesTo>...</appliesTo>
  <defaultValue>...</defaultValue>
  <useInheritedAsDefaultValue>...</useInheritedAsDefaultValue>
  <storageType>...</storageType>
  <valueRequired>...</valueRequired>
  <versionable>...</versionable>
  <triggerEndPeriodEvent>...</triggerEndPeriodEvent>
  <calendar>...</calendar>
  <entityClazz>...</entityClazz>
  <listValues>...</listValues>
  <allowEdit>...</allowEdit>
  <hideOnNew>...</hideOnNew>
  <maxValue>...</maxValue>
  <minValue>...</minValue>
  <regExp>...</regExp>
  <nbDecimal>...</nbDecimal>
  <roundingMode>...</roundingMode>
  <guiPosition>...</guiPosition>
  <mapKeyType>...</mapKeyType>
  <applicableOnEl>...</applicableOnEl>
  <matrixColumns>
    <matrixColumn code="..." columnUse="..." keyType="..." label="..." position="..."/>
  </matrixColumns>
  <childEntityFieldsForSummary>
    <fieldCode>...</fieldCode>
  </childEntityFieldsForSummary>
  <indexType>...</indexType>
  <tags>...</tags>
  <displayFormat>...</displayFormat>
  <disabled>...</disabled>
  <auditable created="..." creator="..." updated="..." updater="..."/>
  <auditableFields>
    <auditableField actor="..." changeOrigin="..." code="..." created="..." currentState="..." description="..." entityClass="..." fieldName="..." id="..." originName="..." previousState="...">
      <auditable/>
      <auditableFields>
        <auditableField/>
      </auditableFields>
      <updatedCode>...</updatedCode>
    </auditableField>
  </auditableFields>
  <updatedCode>...</updatedCode>
</CustomFieldTemplate>