Variable

Class Name:
com::liquent::insight::manager::publisher::data::Variable
Field Name Field Type Matching UI Field Req (Y/N) Description Acceptable Values Default Value
activeFlag string Is Active? N Defines if the variable is active or not.
  • Y
  • N
Y
changeReasonComment string N This field is not used for import.
changeReasonTypeId long N This field is not used for import.
code string Variable Code Y The variable code that is used in the document or tree structure. The Variable Code - Output Channel combination must be unique within the Publishing Settings Library. The Variable Code must not be the one defined in Assembly Repository Variables, Assembly System Defined Variables, Assembly User Defined Variables, and Calyx RIM Assembly Variables.
description string Description N A description of the variable.
documentType string N This field is not used for import.
id long Y The unique Variable ID represented by a numerical value. This value will be used to populate corresponding fields in child classes. This ID will be replaced by the database ID in the imported assembly.
name string Variable Name Y The human readable name of the variable code.
outputChannelTypeId long N This field is not used for import.
publishingSettingsLibraryId long Publishing Settings Library Y The value of the ID field of the PublishingSettingsLibrary class. Example:

370515

typeId long Y See fixed value. Fixed value is USER
variableStampType string Variable Type N The type of variable being configured.
  • S - Single-Line Variable
  • M - Multiple-Line Variable
S
variableValue string Variable Value Y The value to which the variable will resolve. This could be free text or another variable.