Skip to main content

%DeepSee.Model.node

Class %DeepSee.Model.node Extends abstractNode [ Abstract, System = 3 ]

Base class for DeepSee Cube Definition meta-data objects.

Parameters​

NAMESPACE​

Parameter NAMESPACE = "http://www.intersystems.com/deepsee";

XMLINCLUDEINGROUP​

Parameter XMLINCLUDEINGROUP = 1;

DOMAIN​

Parameter DOMAIN = "%DeepSee";

Properties​

name​

Property name As %DeepSee.Datatype.entityName(XMLPROJECTION = "attribute");

Logical name of this element.

displayName​

Property displayName As %DeepSee.Datatype.entityName(XMLPROJECTION = "attribute");

Localized name of this element. This is used by tools but not within actually queries.

description​

Property description As %DeepSee.Datatype.string(MAXLEN = 2500, XMLPROJECTION = "attribute");

Optional description for this node.

disabled​

Property disabled As %Boolean(XMLPROJECTION = "attribute") [ InitialExpression = 0 ];

Disabled flag. If true, then this member will be ignored when the DeepSee cube model is compiled.

isModified​

Property isModified(XMLPROJECTION = "none") [ InitialExpression = 0 ];

Client marker to track whether or not changes have been made too this item in the current session.

additionalDescription​

Property additionalDescription As %DeepSee.Datatype.string;

Methods​

%AtScaleExport​

Method %AtScaleExport(pStatus As %Status = {$$$OK}, ByRef pAuxiliaryIndex As %DynamicAbstractObject = {$$$NULLOREF}) As %DynamicAbstractObject

Produce the structures needed to emit the appropriate JSON and export this item to AtScale

%AtScaleInitIndex​

Method %AtScaleInitIndex(pIndex As %DynamicAbstractObject = {$$$NULLOREF}) As %DynamicAbstractObject

Initialize the arrays to collect information for post-processing. These items will get filled in as the export walks the elements of the model.

%AtScaleProduceDataSet​

Method %AtScaleProduceDataSet(pDataSource As %String, Output pStatus, pIsFact = 1) As %DynamicAbstractObject

Given the provided pDataSource as either a class or table name, produce the DataSet as a %DynamicObject with required parameters for import to AtScale. By default this will assume the dataset will have the setting isFact=true. Thas can be controlled using pIsFact.

%AtScaleProduceAttribute​

Method %AtScaleProduceAttribute(pProperty = "", pAuxiliaryIndex As %DynamicAbstractObject = {$$$NULLOREF}, pTimeFunction = "") As %DynamicAbstractObject

Produce an attribute definition for import to AtScale

%AtScaleProcessSourceRef​

Method %AtScaleProcessSourceRef(pSourceProperty As %String = "", pAuxiliaryIndex As %DynamicAbstractObject = {$$$NULLOREF}, pTimeFunction = "") As %Status

Unpack a source property into the datasets, joins and attributes needed to provide data for an AtScale cube. Incoming values for sourceProperty are expected to be correct class-reference syntax. In the case where the source is a simple property, it is added as a formal Attribute and placed in the pAuxiliaryIndex as a column to be later added to the primary dataset.

%AtScaleConvertType​

ClassMethod %AtScaleConvertType(pIRISType As %String = "", pStatus As %Status) As %String

Convert an IRIS column type to a best match to the AtScale dimension types.

%AtScaleConvertTimeFunction​

ClassMethod %AtScaleConvertTimeFunction(pIRISTimeFunction As %String = "", pStatus As %Status, Output pSQLFunction) As %String

Convert an IRIS time function to a best match for AtScale TimeUnit.

%AtScaleConvertAggregate​

Method %AtScaleConvertAggregate(pIRISAgg As %String, pIRISType As %String = "number", pStatus As %Status) As %String

Convert a measure aggregate from the IRIS definition to the best match from the AtScale aggregates.

%AtScaleCreateMessageObj​

Method %AtScaleCreateMessageObj(pMessageText = "", pType = {$$$msgInfo}) As %DynamicObject

Produce a Message object from the message text and a type string.