This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%BI.DashBoard

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

SQL Table Name: %BI.DashBoard

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties

property Appearance as %Integer;
Property methods: AppearanceDisplayToLogical(), AppearanceGet(), AppearanceGetStored(), AppearanceIsValid(), AppearanceLogicalToDisplay(), AppearanceNormalize(), AppearanceSet(), AppearanceXSDToLogical()
property AutoFind;
Property methods: AutoFindDisplayToLogical(), AutoFindGet(), AutoFindGetStored(), AutoFindIsValid(), AutoFindLogicalToDisplay(), AutoFindLogicalToOdbc(), AutoFindNormalize(), AutoFindSet()
property BackColor as %String (TRUNCATE = 1);
Property methods: BackColorDisplayToLogical(), BackColorGet(), BackColorGetStored(), BackColorIsValid(), BackColorLogicalToDisplay(), BackColorLogicalToOdbc(), BackColorNormalize(), BackColorSet()
property BoardItems as array of %BI.BoardObject;
Property methods: BoardItemsBuildValueArray(), BoardItemsCollectionToDisplay(), BoardItemsCollectionToOdbc(), BoardItemsDisplayToCollection(), BoardItemsGet(), BoardItemsGetObject(), BoardItemsGetObjectId(), BoardItemsGetStored(), BoardItemsGetSwizzled(), BoardItemsIsValid(), BoardItemsOdbcToCollection(), BoardItemsSet(), BoardItemsSetObject(), BoardItemsSetObjectId()
property BoardPicture as %GlobalBinaryStream;
Property methods: BoardPictureDelete(), BoardPictureGet(), BoardPictureGetObject(), BoardPictureGetObjectId(), BoardPictureGetStored(), BoardPictureGetSwizzled(), BoardPictureIsValid(), BoardPictureNewObject(), BoardPictureOid(), BoardPictureOpen(), BoardPictureSet(), BoardPictureSetObject(), BoardPictureSetObjectId(), BoardPictureUnSwizzle()
property Caption as %String (MAXLEN = 25000, TRUNCATE = 1);
Property methods: CaptionDisplayToLogical(), CaptionGet(), CaptionGetStored(), CaptionIsValid(), CaptionLogicalToDisplay(), CaptionLogicalToOdbc(), CaptionNormalize(), CaptionSet()
property DetailListID as %String (TRUNCATE = 1);
Property methods: DetailListIDDisplayToLogical(), DetailListIDGet(), DetailListIDGetStored(), DetailListIDIsValid(), DetailListIDLogicalToDisplay(), DetailListIDLogicalToOdbc(), DetailListIDNormalize(), DetailListIDSet()
property Folder as %String (TRUNCATE = 1);
Property 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()
property FolderName as %String (TRUNCATE = 1) [ Calculated ];
Property methods: FolderNameDisplayToLogical(), FolderNameGet(), FolderNameIsValid(), FolderNameLogicalToDisplay(), FolderNameLogicalToOdbc(), FolderNameNormalize()
property Height as %String (TRUNCATE = 1);
Property methods: HeightDisplayToLogical(), HeightGet(), HeightGetStored(), HeightIsValid(), HeightLogicalToDisplay(), HeightLogicalToOdbc(), HeightNormalize(), HeightSet()
property ImageID as %String (TRUNCATE = 1);
Property methods: ImageIDDisplayToLogical(), ImageIDGet(), ImageIDGetStored(), ImageIDIsValid(), ImageIDLogicalToDisplay(), ImageIDLogicalToOdbc(), ImageIDNormalize(), ImageIDSet()
property ImageName as %String (TRUNCATE = 1) [ Calculated ];
Property methods: ImageNameDisplayToLogical(), ImageNameGet(), ImageNameIsValid(), ImageNameLogicalToDisplay(), ImageNameLogicalToOdbc(), ImageNameNormalize()
property NotActive as %Boolean;
Property methods: NotActiveDisplayToLogical(), NotActiveGet(), NotActiveGetStored(), NotActiveIsValid(), NotActiveLogicalToDisplay(), NotActiveLogicalToXSD(), NotActiveNormalize(), NotActiveSet(), NotActiveXSDToLogical()
property PicturePos as %Integer;
Property methods: PicturePosDisplayToLogical(), PicturePosGet(), PicturePosGetStored(), PicturePosIsValid(), PicturePosLogicalToDisplay(), PicturePosNormalize(), PicturePosSet(), PicturePosXSDToLogical()
property Remarks as %String (MAXLEN = 2000, TRUNCATE = 1);
Property methods: RemarksDisplayToLogical(), RemarksGet(), RemarksGetStored(), RemarksIsValid(), RemarksLogicalToDisplay(), RemarksLogicalToOdbc(), RemarksNormalize(), RemarksSet()
property Style as %Integer;
Property methods: StyleDisplayToLogical(), StyleGet(), StyleGetStored(), StyleIsValid(), StyleLogicalToDisplay(), StyleNormalize(), StyleSet(), StyleXSDToLogical()
property SubjectAreaID as %String (TRUNCATE = 1);
Property methods: SubjectAreaIDDisplayToLogical(), SubjectAreaIDGet(), SubjectAreaIDGetStored(), SubjectAreaIDIsValid(), SubjectAreaIDLogicalToDisplay(), SubjectAreaIDLogicalToOdbc(), SubjectAreaIDNormalize(), SubjectAreaIDSet()
property Width as %String (TRUNCATE = 1);
Property methods: WidthDisplayToLogical(), WidthGet(), WidthGetStored(), WidthIsValid(), WidthLogicalToDisplay(), WidthLogicalToOdbc(), WidthNormalize(), WidthSet()

Methods

method FolderNameGet() as %String
method ImageNameGet() as %String

Queries

query FolderAll(iFolder As %String)
SQL Query:
SELECT ID,Caption FROM %BI.DashBoard WHERE Folder=:iFolder ORDER BY Caption
query ListAll(iUser As %String)
SQL Query:
SELECT ID,Caption,Remarks,Folder FROM %BI.DashBoard ORDER BY Caption
query StrategyMapAll(iFolder As %String)
SQL Query:
SELECT ID,Caption,Remarks,Folder FROM %BI.DashBoard /*WHERE StrategyMap=1 ORDER BY Caption*/

Indices

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()

Inherited Members

Inherited Methods (Including Private)

Storage

Storage Model: CacheStorage (%BI.DashBoard)

^BI.DashBoardD(ID,"I",n)
=
BoardItems(n)

Storage Model: CacheStorage (%BI.DashBoard)

^BI.DashBoardD(ID,"X")
=
%%CLASSNAME

Storage Model: CacheStorage (%BI.DashBoard)

^BI.DashBoardD(ID)
=
Caption
Remarks
Folder
NotActive
AutoFind
Appearance
BackColor
Style
PicturePos
ImageID
Height
Width
SubjectArea
SubjectAreaID
DetailListID
StrategyMap

Storage Model: CacheStorage (%BI.DashBoard)

^BI.DashBoardD(ID,"P")
=
BoardPicture
Feedback