Skip to main content

HS.HC.ChangeControl.EnvVar.Storage.Variable

persistent class HS.HC.ChangeControl.EnvVar.Storage.Variable extends %Library.Persistent, HS.HC.ChangeControl.XML.Adaptor, %Library.GlobalIdentifier

SQL Table Name: HS_HC_ChangeControl_EnvVar_Storage.Variable

Change control environment variable name

Property Inventory

Parameters

parameter %JSONIDFIELD = id;
Inherited description: %JSONIDFIELD specifies the field name to use for the ID in representations of the object, if enabled by %JSONINCLUDEID
parameter %JSONINCLUDEID = 1;
Inherited description: %JSONINCLUDEID allows the ID to be included (output-only) in representations of the object.
parameter GUIDENABLED = 1;
Inherited description: If this parameter is set to 1 then a GUID will be assigned (to the %GUID property) to each new object. When the object is saved for the first time this GUID value will be recorded in a namespace index which will allow GUID to be resolved to OIDs.
parameter XMLCONFIGITEM = 1;
Inherited description: Configuration Items are discrete elements whose development is to be controlled and tracked.

Properties

property Description as HS.HC.DataType.AnyString [ Required ];
Description of this variable
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property Disabled as %Boolean [ InitialExpression = 0 ];
Whether this variable has been marked inactive across the environments and no longer in use.
Property methods: DisabledDisplayToLogical(), DisabledGet(), DisabledGetStored(), DisabledIsValid(), DisabledLogicalToDisplay(), DisabledLogicalToXSD(), DisabledNormalize(), DisabledSet(), DisabledXSDToLogical()
property Name as HS.HC.DataType.SysEnvVarName [ Required ];
Variable name across all environments
Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property Type as HS.HC.DataType.SysEnvVarType [ InitialExpression = "String" , Required ];
Data type for this variable across system. See allowed types in HS.HC.DataType.SysEnvVarType
Property methods: TypeDisplayToLogical(), TypeGet(), TypeGetStored(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()
relationship Value as array of HS.HC.ChangeControl.EnvVar.Storage.Value (%JSONFIELDNAME = "values", XMLREFERENCE = "COMPLETE") [ InitialExpression = $listbuild("HS.HC.ChangeControl.EnvVar.Storage.Value","Key",+$this,"children",1,1) , Transient , Inverse = Key , Cardinality = children ];
Link to resloved values in different enviroments
Property methods: ValueGet(), ValueGetObject(), ValueGetObjectId(), ValueGetSwizzled(), ValueIsEmpty(), ValueIsValid(), ValueNewObject(), ValueRClose(), ValueRExec(), ValueRFetch(), ValueRelate(), ValueSQLCompute(), ValueSet(), ValueUnRelate()

Indexes

index ($Variable on ) [Extent, Type = bitmap];
index (DisabledIdx on Disabled) [Type = bitmap];
Bitmap index for quick lookup of disabled flag
index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
index (NameIdx on Name) [Unique];
Use a unique index. Should not be IdKey to ensure collation is not exact and matching is done in a case insensitive manner.
Index methods: NameIdxCheck(), NameIdxCheckUnique(), NameIdxDelete(), NameIdxExists(), NameIdxOpen(), NameIdxSQLCheckUnique(), NameIdxSQLExists(), NameIdxSQLFindPKeyByConstraint(), NameIdxSQLFindRowIDByConstraint()

Triggers

trigger DeleteEnvVarTrigger (BEFORE event DELETE);
If change control is enabled, throw error for deletion, only support setting Disabled
trigger TypeFixed (BEFORE event UPDATE);
Do not allow Type to change if its not an insert (once set cannot be changed unless disabled)

Inherited Members

Inherited Properties

Inherited Methods

Storage

Storage Model: Storage (HS.HC.ChangeControl.EnvVar.Storage.Variable)

^HS.HC.ChangeContro1F4.VariableD(ID)
=
%%CLASSNAME
Name
Type
Description
Disabled
FeedbackOpens in a new tab