This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %BI.Docs

%BI.Docs

persistent class %BI.Docs extends %Library.Persistent

SQL Table Name: %BI.Docs

Property Inventory

Properties

property ClassName as %String (MAXLEN = 5000, TRUNCATE = 1);
Property methods: ClassNameDisplayToLogical(), ClassNameGet(), ClassNameGetStored(), ClassNameIsValid(), ClassNameLogicalToDisplay(), ClassNameLogicalToOdbc(), ClassNameNormalize(), ClassNameSet()
property Content as %String (MAXLEN = 32000, TRUNCATE = 1);
Property methods: ContentDisplayToLogical(), ContentGet(), ContentGetStored(), ContentIsValid(), ContentLogicalToDisplay(), ContentLogicalToOdbc(), ContentNormalize(), ContentSet()
property DisplayType as %String (DISPLAYLIST = ",HTML,Text", TRUNCATE = 1, VALUELIST = ",H,T");
Property methods: DisplayTypeDisplayToLogical(), DisplayTypeGet(), DisplayTypeGetStored(), DisplayTypeIsValid(), DisplayTypeLogicalToDisplay(), DisplayTypeLogicalToOdbc(), DisplayTypeNormalize(), DisplayTypeSet()
property DocId as %String (TRUNCATE = 1);
Property methods: DocIdDisplayToLogical(), DocIdGet(), DocIdGetStored(), DocIdIsValid(), DocIdLogicalToDisplay(), DocIdLogicalToOdbc(), DocIdNormalize(), DocIdSet()
property DocLanguage as %String (MAXLEN = 5000, TRUNCATE = 1);
Property methods: DocLanguageDisplayToLogical(), DocLanguageGet(), DocLanguageGetStored(), DocLanguageIsValid(), DocLanguageLogicalToDisplay(), DocLanguageLogicalToOdbc(), DocLanguageNormalize(), DocLanguageSet()
property DocName as %String (MAXLEN = 5000, TRUNCATE = 1);
Property methods: DocNameDisplayToLogical(), DocNameGet(), DocNameGetStored(), DocNameIsValid(), DocNameLogicalToDisplay(), DocNameLogicalToOdbc(), DocNameNormalize(), DocNameSet()
property DocType as %String (DISPLAYLIST = ",Dimension,Computation,Measure,Subject,Pivot Table,Report", TRUNCATE = 1, VALUELIST = ",D,C,M,S,P,R");
Property methods: DocTypeDisplayToLogical(), DocTypeGet(), DocTypeGetStored(), DocTypeIsValid(), DocTypeLogicalToDisplay(), DocTypeLogicalToOdbc(), DocTypeNormalize(), DocTypeSet()
property Ico as %String (TRUNCATE = 1);
Property methods: IcoDisplayToLogical(), IcoGet(), IcoGetStored(), IcoIsValid(), IcoLogicalToDisplay(), IcoLogicalToOdbc(), IcoNormalize(), IcoSet()
property URL as %String (MAXLEN = 5000, TRUNCATE = 1);
Property methods: URLDisplayToLogical(), URLGet(), URLGetStored(), URLIsValid(), URLLogicalToDisplay(), URLLogicalToOdbc(), URLNormalize(), URLSet()

Queries

query BySALangType(Cls As %String, Doc As %String, Lang As %String, Type As %String)
SQL Query:
SELECT DocId FROM %BI.Docs WHERE ClassName=:Cls AND DocName=:Doc AND DocType=:Type
query ListAll()
SQL Query:
SELECT ID,DocType,DocName,ClassName,DocLanguage FROM %BI.Docs
query ListAllByLanguage(DocLanguage As %String)
SQL Query:
SELECT ID,DocType,DocName,ClassName FROM %BI.Docs WHERE DocLanguage=:DocLanguage

Indexes

index (MainIdx on ClassName,DocType,DocName,DocLanguage,Ico);
Index methods: MainIdxExists()

Inherited Members

Inherited Methods

Storage

Storage Model: CacheStorage (%BI.Docs)

^BI.DocsD(ID)
=
%%CLASSNAME
ClassName
Content
DisplayType
DocName
DocType
URL
Language
DocLanguage
DocId
Ico