Sorry, your browser does not support JavaScript or JavaScript is disabled. Please enable JavaScript or use another browser to have a better experience.

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

Thanks for your feedback!
Need to tell us more? Click here or use the Feedback button.

Is this page helpful?

Class Details

Properties (43)
Methods (9)
Queries (3)
Indexes (4)
Inherited Members
Storage

Show private members

%BI.PivotTable

persistent class %BI.PivotTable extends %Library.Persistent, %XML.Adaptor

SQL Table Name: %BI.PivotTable

Property Inventory

Properties

property ChartAttrib as %Library.Stream;

Property methods: ChartAttribDelete(), ChartAttribGet(), ChartAttribGetObject(), ChartAttribGetObjectId(), ChartAttribGetStored(), ChartAttribGetSwizzled(), ChartAttribIsValid(), ChartAttribNewObject(), ChartAttribOid(), ChartAttribOpen(), ChartAttribSet(), ChartAttribSetObject(), ChartAttribSetObjectId(), ChartAttribUnSwizzle()

property ChartFormat as %String (MAXLEN = 32000, TRUNCATE = 1);

Property methods: ChartFormatDisplayToLogical(), ChartFormatGet(), ChartFormatGetStored(), ChartFormatIsValid(), ChartFormatLogicalToDisplay(), ChartFormatLogicalToOdbc(), ChartFormatNormalize(), ChartFormatSet()

property ColCustomGroup as %String (MAXLEN = 32000, TRUNCATE = 1);

Property methods: ColCustomGroupDisplayToLogical(), ColCustomGroupGet(), ColCustomGroupGetStored(), ColCustomGroupIsValid(), ColCustomGroupLogicalToDisplay(), ColCustomGroupLogicalToOdbc(), ColCustomGroupNormalize(), ColCustomGroupSet()

property ColMeasure as %String (MAXLEN = 32000, TRUNCATE = 1);

Property methods: ColMeasureDisplayToLogical(), ColMeasureGet(), ColMeasureGetStored(), ColMeasureIsValid(), ColMeasureLogicalToDisplay(), ColMeasureLogicalToOdbc(), ColMeasureNormalize(), ColMeasureSet()

property DataMart as %String (MAXLEN = 2000, TRUNCATE = 1);

Property methods: DataMartDisplayToLogical(), DataMartGet(), DataMartGetStored(), DataMartIsValid(), DataMartLogicalToDisplay(), DataMartLogicalToOdbc(), DataMartNormalize(), DataMartSet()

property DataMartName as %String (TRUNCATE = 1) [ Calculated ];

Property methods: DataMartNameCompute(), DataMartNameDisplayToLogical(), DataMartNameGet(), DataMartNameIsValid(), DataMartNameLogicalToDisplay(), DataMartNameLogicalToOdbc(), DataMartNameNormalize(), DataMartNameSQLCompute()

property DrillDownReport as %String (MAXLEN = 32000, TRUNCATE = 1);

Property methods: DrillDownReportDisplayToLogical(), DrillDownReportGet(), DrillDownReportGetStored(), DrillDownReportIsValid(), DrillDownReportLogicalToDisplay(), DrillDownReportLogicalToOdbc(), DrillDownReportNormalize(), DrillDownReportSet()

property EffQuery as %String (TRUNCATE = 1) [ Calculated ];

Property methods: EffQueryCompute(), EffQueryDisplayToLogical(), EffQueryIsValid(), EffQueryLogicalToDisplay(), EffQueryLogicalToOdbc(), EffQueryNormalize(), EffQuerySQLCompute()

property ExcelDrillDownInfo as %String (TRUNCATE = 1);

Property methods: ExcelDrillDownInfoDisplayToLogical(), ExcelDrillDownInfoGet(), ExcelDrillDownInfoGetStored(), ExcelDrillDownInfoIsValid(), ExcelDrillDownInfoLogicalToDisplay(), ExcelDrillDownInfoLogicalToOdbc(), ExcelDrillDownInfoNormalize(), ExcelDrillDownInfoSet()

property ExcelFilterInfo as %String (TRUNCATE = 1);

Property methods: ExcelFilterInfoDisplayToLogical(), ExcelFilterInfoGet(), ExcelFilterInfoGetStored(), ExcelFilterInfoIsValid(), ExcelFilterInfoLogicalToDisplay(), ExcelFilterInfoLogicalToOdbc(), ExcelFilterInfoNormalize(), ExcelFilterInfoSet()

property ExcelLayout as %String (TRUNCATE = 1);

Property methods: ExcelLayoutDisplayToLogical(), ExcelLayoutGet(), ExcelLayoutGetStored(), ExcelLayoutIsValid(), ExcelLayoutLogicalToDisplay(), ExcelLayoutLogicalToOdbc(), ExcelLayoutNormalize(), ExcelLayoutSet()

property Folder as %String (TRUNCATE = 1);

Property methods: FolderDisplayToLogical(), FolderGet(), FolderGetStored(), FolderIsValid(), FolderLogicalToDisplay(), FolderLogicalToOdbc(), FolderNormalize(), FolderSet()

property FolderName as %String (TRUNCATE = 1) [ Calculated ];

Property methods: FolderNameDisplayToLogical(), FolderNameIsValid(), FolderNameLogicalToDisplay(), FolderNameLogicalToOdbc(), FolderNameNormalize()

property HideColumns as %String (MAXLEN = 32000, TRUNCATE = 1);

Property methods: HideColumnsDisplayToLogical(), HideColumnsGet(), HideColumnsGetStored(), HideColumnsIsValid(), HideColumnsLogicalToDisplay(), HideColumnsLogicalToOdbc(), HideColumnsNormalize(), HideColumnsSet()

property HideRows as %String (MAXLEN = 32000, TRUNCATE = 1);

Property methods: HideRowsDisplayToLogical(), HideRowsGet(), HideRowsGetStored(), HideRowsIsValid(), HideRowsLogicalToDisplay(), HideRowsLogicalToOdbc(), HideRowsNormalize(), HideRowsSet()

property LinkReport as %String (MAXLEN = 32000, TRUNCATE = 1);

Property methods: LinkReportDisplayToLogical(), LinkReportGet(), LinkReportGetStored(), LinkReportIsValid(), LinkReportLogicalToDisplay(), LinkReportLogicalToOdbc(), LinkReportNormalize(), LinkReportSet()

property MOLAPClass as %String (TRUNCATE = 1);

Property methods: MOLAPClassDisplayToLogical(), MOLAPClassGet(), MOLAPClassGetStored(), MOLAPClassIsValid(), MOLAPClassLogicalToDisplay(), MOLAPClassLogicalToOdbc(), MOLAPClassNormalize(), MOLAPClassSet()

property MOLAPColumn as %String (TRUNCATE = 1);

Property methods: MOLAPColumnDisplayToLogical(), MOLAPColumnGet(), MOLAPColumnGetStored(), MOLAPColumnIsValid(), MOLAPColumnLogicalToDisplay(), MOLAPColumnLogicalToOdbc(), MOLAPColumnNormalize(), MOLAPColumnSet()

property MetricStr as %String (TRUNCATE = 1) [ Calculated ];

Property methods: MetricStrCompute(), MetricStrDisplayToLogical(), MetricStrIsValid(), MetricStrLogicalToDisplay(), MetricStrLogicalToOdbc(), MetricStrNormalize(), MetricStrSQLCompute()

property Metrics as %String (MAXLEN = 32000, TRUNCATE = 1);

Property methods: MetricsDisplayToLogical(), MetricsGet(), MetricsGetStored(), MetricsIsValid(), MetricsLogicalToDisplay(), MetricsLogicalToOdbc(), MetricsNormalize(), MetricsSet()

property NestedReport as %String (MAXLEN = 32000, TRUNCATE = 1);

Property methods: NestedReportDisplayToLogical(), NestedReportGet(), NestedReportGetStored(), NestedReportIsValid(), NestedReportLogicalToDisplay(), NestedReportLogicalToOdbc(), NestedReportNormalize(), NestedReportSet()

property ObjectOwner as %BI.Users;

Property methods: ObjectOwnerGet(), ObjectOwnerGetObject(), ObjectOwnerGetObjectId(), ObjectOwnerGetStored(), ObjectOwnerGetSwizzled(), ObjectOwnerIsValid(), ObjectOwnerNewObject(), ObjectOwnerSet(), ObjectOwnerSetObject(), ObjectOwnerSetObjectId(), ObjectOwnerUnSwizzle()

property PivotCat as %String (TRUNCATE = 1);

Property methods: PivotCatDisplayToLogical(), PivotCatGet(), PivotCatGetStored(), PivotCatIsValid(), PivotCatLogicalToDisplay(), PivotCatLogicalToOdbc(), PivotCatNormalize(), PivotCatSet()

property PivotClass as %String (TRUNCATE = 1);

Property methods: PivotClassDisplayToLogical(), PivotClassGet(), PivotClassGetStored(), PivotClassIsValid(), PivotClassLogicalToDisplay(), PivotClassLogicalToOdbc(), PivotClassNormalize(), PivotClassSet()

property PivotName as %String (MAXLEN = 300, TRUNCATE = 1) [ Required ];

Property methods: PivotNameDisplayToLogical(), PivotNameGet(), PivotNameGetStored(), PivotNameIsValid(), PivotNameLogicalToDisplay(), PivotNameLogicalToOdbc(), PivotNameNormalize(), PivotNameSet()

property PivotNotes as %String (MAXLEN = 32000, TRUNCATE = 0);

Property methods: PivotNotesDisplayToLogical(), PivotNotesGet(), PivotNotesGetStored(), PivotNotesIsValid(), PivotNotesLogicalToDisplay(), PivotNotesLogicalToOdbc(), PivotNotesNormalize(), PivotNotesSet()

property QueryCom as %String (MAXLEN = 2000, TRUNCATE = 1);

Property methods: QueryComDisplayToLogical(), QueryComGet(), QueryComGetStored(), QueryComIsValid(), QueryComLogicalToDisplay(), QueryComLogicalToOdbc(), QueryComNormalize(), QueryComSet()

property QueryVariable as %String (MAXLEN = 2000, TRUNCATE = 1);

Property methods: QueryVariableDisplayToLogical(), QueryVariableGet(), QueryVariableGetStored(), QueryVariableIsValid(), QueryVariableLogicalToDisplay(), QueryVariableLogicalToOdbc(), QueryVariableNormalize(), QueryVariableSet()

property RankRemain as %String (MAXLEN = 2000, TRUNCATE = 1);

Property methods: RankRemainDisplayToLogical(), RankRemainGet(), RankRemainGetStored(), RankRemainIsValid(), RankRemainLogicalToDisplay(), RankRemainLogicalToOdbc(), RankRemainNormalize(), RankRemainSet()

property Ranking as %String (MAXLEN = 2000, TRUNCATE = 1);

Property methods: RankingDisplayToLogical(), RankingGet(), RankingGetStored(), RankingIsValid(), RankingLogicalToDisplay(), RankingLogicalToOdbc(), RankingNormalize(), RankingSet()

property RecreateMOLAPClass as %Boolean;

Property methods: RecreateMOLAPClassDisplayToLogical(), RecreateMOLAPClassGet(), RecreateMOLAPClassGetStored(), RecreateMOLAPClassIsValid(), RecreateMOLAPClassLogicalToDisplay(), RecreateMOLAPClassLogicalToXSD(), RecreateMOLAPClassNormalize(), RecreateMOLAPClassSet(), RecreateMOLAPClassXSDToLogical()

property RowAggregateOption as %Integer;

Property methods: RowAggregateOptionDisplayToLogical(), RowAggregateOptionGet(), RowAggregateOptionGetStored(), RowAggregateOptionIsValid(), RowAggregateOptionLogicalToDisplay(), RowAggregateOptionNormalize(), RowAggregateOptionSet(), RowAggregateOptionXSDToLogical()

property RowCustomGroup as %String (MAXLEN = 32000, TRUNCATE = 1);

Property methods: RowCustomGroupDisplayToLogical(), RowCustomGroupGet(), RowCustomGroupGetStored(), RowCustomGroupIsValid(), RowCustomGroupLogicalToDisplay(), RowCustomGroupLogicalToOdbc(), RowCustomGroupNormalize(), RowCustomGroupSet()

property RowMeasure as %String (MAXLEN = 32000, TRUNCATE = 1);

Property methods: RowMeasureDisplayToLogical(), RowMeasureGet(), RowMeasureGetStored(), RowMeasureIsValid(), RowMeasureLogicalToDisplay(), RowMeasureLogicalToOdbc(), RowMeasureNormalize(), RowMeasureSet()

property SQLClause as %String (MAXLEN = 32000, TRUNCATE = 1);

Property methods: SQLClauseDisplayToLogical(), SQLClauseGet(), SQLClauseGetStored(), SQLClauseIsValid(), SQLClauseLogicalToDisplay(), SQLClauseLogicalToOdbc(), SQLClauseNormalize(), SQLClauseSet()

property ShowColumnAvg as %Boolean;

Property methods: ShowColumnAvgDisplayToLogical(), ShowColumnAvgGet(), ShowColumnAvgGetStored(), ShowColumnAvgIsValid(), ShowColumnAvgLogicalToDisplay(), ShowColumnAvgLogicalToXSD(), ShowColumnAvgNormalize(), ShowColumnAvgSet(), ShowColumnAvgXSDToLogical()

property ShowColumnTotal as %Boolean;

Property methods: ShowColumnTotalDisplayToLogical(), ShowColumnTotalGet(), ShowColumnTotalGetStored(), ShowColumnTotalIsValid(), ShowColumnTotalLogicalToDisplay(), ShowColumnTotalLogicalToXSD(), ShowColumnTotalNormalize(), ShowColumnTotalSet(), ShowColumnTotalXSDToLogical()

property StaticReport as %Boolean;

Property methods: StaticReportDisplayToLogical(), StaticReportGet(), StaticReportGetStored(), StaticReportIsValid(), StaticReportLogicalToDisplay(), StaticReportLogicalToXSD(), StaticReportNormalize(), StaticReportSet(), StaticReportXSDToLogical()

property SuppressNullRows as %Boolean;

Property methods: SuppressNullRowsDisplayToLogical(), SuppressNullRowsGet(), SuppressNullRowsGetStored(), SuppressNullRowsIsValid(), SuppressNullRowsLogicalToDisplay(), SuppressNullRowsLogicalToXSD(), SuppressNullRowsNormalize(), SuppressNullRowsSet(), SuppressNullRowsXSDToLogical()

property SyncOption as %Integer;

Property methods: SyncOptionDisplayToLogical(), SyncOptionGet(), SyncOptionGetStored(), SyncOptionIsValid(), SyncOptionLogicalToDisplay(), SyncOptionNormalize(), SyncOptionSet(), SyncOptionXSDToLogical()

property TableClass as %String (TRUNCATE = 1) [ Calculated ];

Property methods: TableClassCompute(), TableClassDisplayToLogical(), TableClassIsValid(), TableClassLogicalToDisplay(), TableClassLogicalToOdbc(), TableClassNormalize(), TableClassSQLCompute()

property TableQuery as %String (MAXLEN = 32000, TRUNCATE = 1);

Property methods: TableQueryDisplayToLogical(), TableQueryGet(), TableQueryGetStored(), TableQueryIsValid(), TableQueryLogicalToDisplay(), TableQueryLogicalToOdbc(), TableQueryNormalize(), TableQuerySet()

property UnionReport as %String (MAXLEN = 32000, TRUNCATE = 1);

Property methods: UnionReportDisplayToLogical(), UnionReportGet(), UnionReportGetStored(), UnionReportIsValid(), UnionReportLogicalToDisplay(), UnionReportLogicalToOdbc(), UnionReportNormalize(), UnionReportSet()

Methods

final method %OnAfterSave(insert As %Boolean) as %Status

Inherited description: This callback method is invoked by the %Save() method to provide notification that the object is being saved. It is called after the object's data has been successfully written to disk.

insert will be set to 1 if this object is being saved for the first time.

If this method returns an error then the call to %Save() will fail.

method EffQueryGet() as %String

method FolderNameGet() as %String

classmethod GetDataMartName(dmid As %String) as %String

classmethod GetEffQuery(dmid As %String, tabquery As %String) as %String

classmethod GetMetricStr(dmid As %String, iMetric As %String) as %String

classmethod GetTableClass(dmid As %String) as %String

method MetricStrGet() as %String

method TableClassGet() as %String

Queries

query ByTableClass(Class As %String)

SQL Query:
SELECT ID,PivotName FROM %BI.PivotTable WHERE TableClass=:Class

query FolderAll(iFolder As %String)

SQL Query:
SELECT ID,PivotName FROM %BI.PivotTable WHERE Folder=:iFolder ORDER BY PivotName

query ListAll()

SQL Query:
SELECT ID,PivotName,DataMartName,Folder,PivotNotes FROM %BI.PivotTable ORDER BY PivotName

Indexes

index (Folder on Folder:Exact);

Index methods: FolderAllClose(), FolderAllExecute(), FolderAllFetch(), FolderAllFetchRows(), FolderAllFunc(), FolderAllGetInfo(), FolderAllGetODBCInfo(), FolderAllPrepare(), FolderAllSendODBC(), FolderDisplayToLogical(), FolderExists(), FolderGet(), FolderGetStored(), FolderIsValid(), FolderLogicalToDisplay(), FolderLogicalToOdbc(), FolderNameDisplayToLogical(), FolderNameGet(), FolderNameIsValid(), FolderNameLogicalToDisplay(), FolderNameLogicalToOdbc(), FolderNameNormalize(), FolderNormalize(), FolderSet()

index (IDKEY on ) [IdKey, Type = key];

Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

index (MOLAP on MOLAPClass:Exact);

Index methods: MOLAPClassDisplayToLogical(), MOLAPClassGet(), MOLAPClassGetStored(), MOLAPClassIsValid(), MOLAPClassLogicalToDisplay(), MOLAPClassLogicalToOdbc(), MOLAPClassNormalize(), MOLAPClassSet(), MOLAPColumnDisplayToLogical(), MOLAPColumnGet(), MOLAPColumnGetStored(), MOLAPColumnIsValid(), MOLAPColumnLogicalToDisplay(), MOLAPColumnLogicalToOdbc(), MOLAPColumnNormalize(), MOLAPColumnSet(), MOLAPExists()

index (SYNC on PivotClass:Exact,SyncOption:Exact) [Data = MOLAPClass];

Index methods: SYNCExists()

Inherited Members

Inherited Methods

Storage

Storage Model: CacheStorage (%BI.PivotTable)

^BI.PivotTableD(ID,"A")

ChartAttrib

Storage Model: CacheStorage (%BI.PivotTable)

^BI.PivotTableD(ID,"F")

ChartFormat

Storage Model: CacheStorage (%BI.PivotTable)

^BI.PivotTableD(ID,"X")

%%CLASSNAME

Storage Model: CacheStorage (%BI.PivotTable)

^BI.PivotTableD(ID,"C")

ColMeasure

Storage Model: CacheStorage (%BI.PivotTable)

^BI.PivotTableD(ID,"M")

Metrics

Storage Model: CacheStorage (%BI.PivotTable)

^BI.PivotTableD(ID,"N")

PivotNotes

Storage Model: CacheStorage (%BI.PivotTable)

^BI.PivotTableD(ID)

PivotName

DataMart

QueryCom

QueryVariable

Ranking

RowAggregateOption

ShowColumnAvg

ShowColumnTotal

SuppressNullRows

TableQuery

StaticReport

ObjectOwner

Folder

RankRemain

LinkReport

HideColumns

DrillDownReport

MOLAPClass

SyncOption

PivotClass

MOLAPColumn

RecreateMOLAPClass

UnionReport

ColCustomGroup

RowCustomGroup

PivotThread

PivotCat

NestedReport

HideRows

ExcelLayout

ExcelDrillDownInfo

ExcelFilterInfo

Storage Model: CacheStorage (%BI.PivotTable)

^BI.PivotTableD(ID,"R")

RowMeasure

Storage Model: CacheStorage (%BI.PivotTable)

^BI.PivotTableD(ID,"S")

SQLClause

Feedback