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 > ENSLIB namespace > %BI.Users

%BI.Users

persistent class %BI.Users extends %Library.Persistent

SQL Table Name: %BI.Users

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property AlphaNumPwd as %String (TRUNCATE = 1);
Property methods: AlphaNumPwdDisplayToLogical(), AlphaNumPwdGet(), AlphaNumPwdGetStored(), AlphaNumPwdIsValid(), AlphaNumPwdLogicalToDisplay(), AlphaNumPwdLogicalToOdbc(), AlphaNumPwdNormalize(), AlphaNumPwdSet()
property CanExpire as %String (TRUNCATE = 1);
Property methods: CanExpireDisplayToLogical(), CanExpireGet(), CanExpireGetStored(), CanExpireIsValid(), CanExpireLogicalToDisplay(), CanExpireLogicalToOdbc(), CanExpireNormalize(), CanExpireSet()
property Code as %String (MAXLEN = 30, TRUNCATE = 1);
Property methods: CodeCheck(), CodeCheckUnique(), CodeDelete(), CodeDisplayToLogical(), CodeExists(), CodeGet(), CodeGetStored(), CodeIsValid(), CodeLogicalToDisplay(), CodeLogicalToOdbc(), CodeNormalize(), CodeOpen(), CodeSQLCheckUnique(), CodeSQLExists(), CodeSQLFindPKeyByConstraint(), CodeSQLFindRowIDByConstraint(), CodeSet()
property CustomFn as array of %BI.CustomFunction;
Property methods: CustomFnBuildValueArray(), CustomFnCollectionToDisplay(), CustomFnCollectionToOdbc(), CustomFnDisplayToCollection(), CustomFnGet(), CustomFnGetObject(), CustomFnGetObjectId(), CustomFnGetStored(), CustomFnGetSwizzled(), CustomFnIsValid(), CustomFnOdbcToCollection(), CustomFnSet(), CustomFnSetObject(), CustomFnSetObjectId()
property DGSIG as %String (TRUNCATE = 1);
Property methods: DGSIGDisplayToLogical(), DGSIGGet(), DGSIGGetStored(), DGSIGIsValid(), DGSIGLogicalToDisplay(), DGSIGLogicalToOdbc(), DGSIGNormalize(), DGSIGSet()
property DefaultFolder as %String (MAXLEN = 30, TRUNCATE = 1);
Property methods: DefaultFolderDisplayToLogical(), DefaultFolderGet(), DefaultFolderGetStored(), DefaultFolderIsValid(), DefaultFolderLogicalToDisplay(), DefaultFolderLogicalToOdbc(), DefaultFolderNameDisplayToLogical(), DefaultFolderNameGet(), DefaultFolderNameIsValid(), DefaultFolderNameLogicalToDisplay(), DefaultFolderNameLogicalToOdbc(), DefaultFolderNameNormalize(), DefaultFolderNormalize(), DefaultFolderSet()
property DefaultFolderName as %String (TRUNCATE = 1) [ Calculated ];
Property methods: DefaultFolderNameDisplayToLogical(), DefaultFolderNameGet(), DefaultFolderNameIsValid(), DefaultFolderNameLogicalToDisplay(), DefaultFolderNameLogicalToOdbc(), DefaultFolderNameNormalize()
property DesktopItems as array of %BI.DashBoardItem;
Property methods: DesktopItemsBuildValueArray(), DesktopItemsCollectionToDisplay(), DesktopItemsCollectionToOdbc(), DesktopItemsDisplayToCollection(), DesktopItemsGet(), DesktopItemsGetObject(), DesktopItemsGetObjectId(), DesktopItemsGetStored(), DesktopItemsGetSwizzled(), DesktopItemsIsValid(), DesktopItemsOdbcToCollection(), DesktopItemsSet(), DesktopItemsSetObject(), DesktopItemsSetObjectId()
property DisplayDate as %String (TRUNCATE = 1);
Property methods: DisplayDateDisplayToLogical(), DisplayDateGet(), DisplayDateGetStored(), DisplayDateIsValid(), DisplayDateLogicalToDisplay(), DisplayDateLogicalToOdbc(), DisplayDateNormalize(), DisplayDateSet()
property DisplayFilterCount as %String (TRUNCATE = 1);
Property methods: DisplayFilterCountDisplayToLogical(), DisplayFilterCountGet(), DisplayFilterCountGetStored(), DisplayFilterCountIsValid(), DisplayFilterCountLogicalToDisplay(), DisplayFilterCountLogicalToOdbc(), DisplayFilterCountNormalize(), DisplayFilterCountSet()
property EightCharPwd as %String (TRUNCATE = 1);
Property methods: EightCharPwdDisplayToLogical(), EightCharPwdGet(), EightCharPwdGetStored(), EightCharPwdIsValid(), EightCharPwdLogicalToDisplay(), EightCharPwdLogicalToOdbc(), EightCharPwdNormalize(), EightCharPwdSet()
property EnbScript as %String (TRUNCATE = 1);
Property methods: EnbScriptDisplayToLogical(), EnbScriptGet(), EnbScriptGetStored(), EnbScriptIsValid(), EnbScriptLogicalToDisplay(), EnbScriptLogicalToOdbc(), EnbScriptNormalize(), EnbScriptSet()
property ExPasswords as array of %String (TRUNCATE = 1);
Property methods: ExPasswordsBuildValueArray(), ExPasswordsCollectionToDisplay(), ExPasswordsCollectionToOdbc(), ExPasswordsDisplayToCollection(), ExPasswordsDisplayToLogical(), ExPasswordsGet(), ExPasswordsGetObject(), ExPasswordsGetObjectId(), ExPasswordsGetStored(), ExPasswordsGetSwizzled(), ExPasswordsIsValid(), ExPasswordsLogicalToDisplay(), ExPasswordsLogicalToOdbc(), ExPasswordsNormalize(), ExPasswordsOdbcToCollection(), ExPasswordsSet(), ExPasswordsSetObject(), ExPasswordsSetObjectId()
property ExpiryDate as %String (TRUNCATE = 1);
Property methods: ExpiryDateDisplayToLogical(), ExpiryDateGet(), ExpiryDateGetStored(), ExpiryDateIsValid(), ExpiryDateLogicalToDisplay(), ExpiryDateLogicalToOdbc(), ExpiryDateNormalize(), ExpiryDateSet()
property FolderSuperUser as %Boolean;
Property methods: FolderSuperUserDisplayToLogical(), FolderSuperUserGet(), FolderSuperUserGetStored(), FolderSuperUserIsValid(), FolderSuperUserLogicalToDisplay(), FolderSuperUserNormalize(), FolderSuperUserSet()
property Folders as array of %BI.FolderAccess;
Property methods: FoldersBuildValueArray(), FoldersCollectionToDisplay(), FoldersCollectionToOdbc(), FoldersDisplayToCollection(), FoldersGet(), FoldersGetObject(), FoldersGetObjectId(), FoldersGetStored(), FoldersGetSwizzled(), FoldersIsValid(), FoldersOdbcToCollection(), FoldersSet(), FoldersSetObject(), FoldersSetObjectId()
property FullName as %String (MAXLEN = 100, TRUNCATE = 1);
Property methods: FullNameDisplayToLogical(), FullNameGet(), FullNameGetStored(), FullNameIsValid(), FullNameLogicalToDisplay(), FullNameLogicalToOdbc(), FullNameNormalize(), FullNameSet()
property FullScreen as %String (TRUNCATE = 1);
Property methods: FullScreenDisplayToLogical(), FullScreenGet(), FullScreenGetStored(), FullScreenIsValid(), FullScreenLogicalToDisplay(), FullScreenLogicalToOdbc(), FullScreenNormalize(), FullScreenSet()
property LimitUserPref as %String (TRUNCATE = 1);
Property methods: LimitUserPrefDisplayToLogical(), LimitUserPrefGet(), LimitUserPrefGetStored(), LimitUserPrefIsValid(), LimitUserPrefLogicalToDisplay(), LimitUserPrefLogicalToOdbc(), LimitUserPrefNormalize(), LimitUserPrefSet()
property LoginModule as %String (TRUNCATE = 1);
Property methods: LoginModuleDisplayToLogical(), LoginModuleGet(), LoginModuleGetStored(), LoginModuleIsValid(), LoginModuleLogicalToDisplay(), LoginModuleLogicalToOdbc(), LoginModuleNormalize(), LoginModuleSet()
property MailPassword as %String (TRUNCATE = 1);
Property methods: MailPasswordDisplayToLogical(), MailPasswordGet(), MailPasswordGetStored(), MailPasswordIsValid(), MailPasswordLogicalToDisplay(), MailPasswordLogicalToOdbc(), MailPasswordNormalize(), MailPasswordSet()
property MailUsrMtnAdd as %String (MAXLEN = 300);
Property methods: MailUsrMtnAddDisplayToLogical(), MailUsrMtnAddGet(), MailUsrMtnAddGetStored(), MailUsrMtnAddIsValid(), MailUsrMtnAddLogicalToDisplay(), MailUsrMtnAddLogicalToOdbc(), MailUsrMtnAddNormalize(), MailUsrMtnAddSet(), MailUsrMtnAddbookLimitDisplayToLogical(), MailUsrMtnAddbookLimitGet(), MailUsrMtnAddbookLimitGetStored(), MailUsrMtnAddbookLimitIsValid(), MailUsrMtnAddbookLimitLogicalToDisplay(), MailUsrMtnAddbookLimitLogicalToOdbc(), MailUsrMtnAddbookLimitNormalize(), MailUsrMtnAddbookLimitSet()
property MailUsrMtnAddbookLimit as %String (MAXLEN = 300);
Property methods: MailUsrMtnAddbookLimitDisplayToLogical(), MailUsrMtnAddbookLimitGet(), MailUsrMtnAddbookLimitGetStored(), MailUsrMtnAddbookLimitIsValid(), MailUsrMtnAddbookLimitLogicalToDisplay(), MailUsrMtnAddbookLimitLogicalToOdbc(), MailUsrMtnAddbookLimitNormalize(), MailUsrMtnAddbookLimitSet()
property MailUsrMtnSig as %String (MAXLEN = 300);
Property methods: MailUsrMtnSigDisplayToLogical(), MailUsrMtnSigGet(), MailUsrMtnSigGetStored(), MailUsrMtnSigIsValid(), MailUsrMtnSigLogicalToDisplay(), MailUsrMtnSigLogicalToOdbc(), MailUsrMtnSigNormalize(), MailUsrMtnSigSet()
property MailUsrName as %String (TRUNCATE = 1);
Property methods: MailUsrNameDisplayToLogical(), MailUsrNameGet(), MailUsrNameGetStored(), MailUsrNameIsValid(), MailUsrNameLogicalToDisplay(), MailUsrNameLogicalToOdbc(), MailUsrNameNormalize(), MailUsrNameSet()
property MinRowDrillDown as %Integer;
Property methods: MinRowDrillDownDisplayToLogical(), MinRowDrillDownGet(), MinRowDrillDownGetStored(), MinRowDrillDownIsValid(), MinRowDrillDownLogicalToDisplay(), MinRowDrillDownNormalize(), MinRowDrillDownSet()
property MyFolder as %String (MAXLEN = 1000);
Property methods: MyFolderDisplayToLogical(), MyFolderGet(), MyFolderGetStored(), MyFolderIsValid(), MyFolderLogicalToDisplay(), MyFolderLogicalToOdbc(), MyFolderNormalize(), MyFolderSet()
property MyMisStd as %String (TRUNCATE = 1);
Property methods: MyMisStdDisplayToLogical(), MyMisStdGet(), MyMisStdGetStored(), MyMisStdIsValid(), MyMisStdLogicalToDisplay(), MyMisStdLogicalToOdbc(), MyMisStdNormalize(), MyMisStdSet()
property NoReUse as %String (TRUNCATE = 1);
Property methods: NoReUseDisplayToLogical(), NoReUseGet(), NoReUseGetStored(), NoReUseIsValid(), NoReUseLogicalToDisplay(), NoReUseLogicalToOdbc(), NoReUseNormalize(), NoReUseSet()
property NoTimeOut as %String (TRUNCATE = 1);
Property methods: NoTimeOutDisplayToLogical(), NoTimeOutGet(), NoTimeOutGetStored(), NoTimeOutIsValid(), NoTimeOutLogicalToDisplay(), NoTimeOutLogicalToOdbc(), NoTimeOutNormalize(), NoTimeOutSet()
property Password as %String (MAXLEN = 30, TRUNCATE = 1);
Property methods: PasswordDisplayToLogical(), PasswordGet(), PasswordGetStored(), PasswordIsValid(), PasswordLogicalToDisplay(), PasswordLogicalToOdbc(), PasswordNormalize(), PasswordSet()
property PerfAlert as %String (TRUNCATE = 1);
Property methods: PerfAlertDisplayToLogical(), PerfAlertGet(), PerfAlertGetStored(), PerfAlertIsValid(), PerfAlertLogicalToDisplay(), PerfAlertLogicalToOdbc(), PerfAlertNormalize(), PerfAlertPopupDisplayToLogical(), PerfAlertPopupGet(), PerfAlertPopupGetStored(), PerfAlertPopupIsValid(), PerfAlertPopupLogicalToDisplay(), PerfAlertPopupLogicalToOdbc(), PerfAlertPopupNormalize(), PerfAlertPopupSet(), PerfAlertSet()
property PerfAlertPopup as %String (TRUNCATE = 1);
Property methods: PerfAlertPopupDisplayToLogical(), PerfAlertPopupGet(), PerfAlertPopupGetStored(), PerfAlertPopupIsValid(), PerfAlertPopupLogicalToDisplay(), PerfAlertPopupLogicalToOdbc(), PerfAlertPopupNormalize(), PerfAlertPopupSet()
property SecurityLevel as %Integer;
Property methods: SecurityLevelDisplayToLogical(), SecurityLevelGet(), SecurityLevelGetStored(), SecurityLevelIsValid(), SecurityLevelLogicalToDisplay(), SecurityLevelNormalize(), SecurityLevelSet()
property ShortCutDB as array of %BI.DashBoardItem;
Property methods: ShortCutDBBuildValueArray(), ShortCutDBCollectionToDisplay(), ShortCutDBCollectionToOdbc(), ShortCutDBDisplayToCollection(), ShortCutDBGet(), ShortCutDBGetObject(), ShortCutDBGetObjectId(), ShortCutDBGetStored(), ShortCutDBGetSwizzled(), ShortCutDBIsValid(), ShortCutDBOdbcToCollection(), ShortCutDBSet(), ShortCutDBSetObject(), ShortCutDBSetObjectId()
property ShortcutModule as %BI.WebSCM;
Property methods: ShortcutModuleGet(), ShortcutModuleGetObject(), ShortcutModuleGetObjectId(), ShortcutModuleGetStored(), ShortcutModuleGetSwizzled(), ShortcutModuleIsValid(), ShortcutModuleNewObject(), ShortcutModuleSet(), ShortcutModuleSetObject(), ShortcutModuleSetObjectId(), ShortcutModuleUnSwizzle()
property SysLanguage as %String (TRUNCATE = 1);
Property methods: SysLanguageDisplayToLogical(), SysLanguageGet(), SysLanguageGetStored(), SysLanguageIsValid(), SysLanguageLogicalToDisplay(), SysLanguageLogicalToOdbc(), SysLanguageNormalize(), SysLanguageSet()
relationship UserDashBoard as array of %BI.UserDashBoard [ InitialExpression = $listbuild("%BI.UserDashBoard","Users",+$this,"children",1,1) , Transient , Inverse = Users , Cardinality = children ];
Property methods: UserDashBoardGet(), UserDashBoardGetObject(), UserDashBoardGetObjectId(), UserDashBoardGetSwizzled(), UserDashBoardIsEmpty(), UserDashBoardIsValid(), UserDashBoardNewObject(), UserDashBoardRClose(), UserDashBoardRExec(), UserDashBoardRFetch(), UserDashBoardRelate(), UserDashBoardSQLCompute(), UserDashBoardSet(), UserDashBoardUnRelate()
relationship UserRole as array of %BI.UserRole [ InitialExpression = $listbuild("%BI.UserRole","Users",+$this,"children",1,1) , Transient , Inverse = Users , Cardinality = children ];
Property methods: UserRoleGet(), UserRoleGetObject(), UserRoleGetObjectId(), UserRoleGetSwizzled(), UserRoleIsEmpty(), UserRoleIsValid(), UserRoleNewObject(), UserRoleRClose(), UserRoleRExec(), UserRoleRFetch(), UserRoleRelate(), UserRoleSQLCompute(), UserRoleSet(), UserRoleUnRelate()
property lockOut as %String (TRUNCATE = 1);
Property methods: lockOutDisplayToLogical(), lockOutGet(), lockOutGetStored(), lockOutIsValid(), lockOutLogicalToDisplay(), lockOutLogicalToOdbc(), lockOutNormalize(), lockOutSet()
property screenHeight as %String (TRUNCATE = 1);
Property methods: screenHeightDisplayToLogical(), screenHeightGet(), screenHeightGetStored(), screenHeightIsValid(), screenHeightLogicalToDisplay(), screenHeightLogicalToOdbc(), screenHeightNormalize(), screenHeightSet()
property screenWidth as %String (TRUNCATE = 1);
Property methods: screenWidthDisplayToLogical(), screenWidthGet(), screenWidthGetStored(), screenWidthIsValid(), screenWidthLogicalToDisplay(), screenWidthLogicalToOdbc(), screenWidthNormalize(), screenWidthSet()
Property methods: shortcutLinksDisplayToLogical(), shortcutLinksGet(), shortcutLinksGetStored(), shortcutLinksIsValid(), shortcutLinksLogicalToDisplay(), shortcutLinksLogicalToOdbc(), shortcutLinksNormalize(), shortcutLinksSet()

Methods (Including Private)

method DefaultFolderNameGet() as %String
final method Encrypt(inVal) as %String
classmethod IsValidLogin(UserName As %String, UserPasswd As %String) as %Boolean

Queries

query AllUsers()
SQL Query:
SELECT ID,Code,FullName,FolderSuperUser FROM %BI.Users ORDER BY FullName

Indexes

index (Code on Code) [Unique];
Index methods: CodeCheck(), CodeCheckUnique(), CodeDelete(), CodeDisplayToLogical(), CodeExists(), CodeGet(), CodeGetStored(), CodeIsValid(), CodeLogicalToDisplay(), CodeLogicalToOdbc(), CodeNormalize(), CodeOpen(), CodeSQLCheckUnique(), CodeSQLExists(), CodeSQLFindPKeyByConstraint(), CodeSQLFindRowIDByConstraint(), CodeSet()
index (ExactCode on Code:Exact);
Index methods: ExactCodeExists()

Inherited Members

Inherited Methods (Including Private)

Storage

Storage Model: CacheStorage (%BI.Users)

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

Storage Model: CacheStorage (%BI.Users)

^BI.UsersD(ID,"CF",n)
=
CustomFn(n)

Storage Model: CacheStorage (%BI.Users)

^BI.UsersD(ID,"D",n)
=
DesktopItems(n)

Storage Model: CacheStorage (%BI.Users)

^BI.UsersD(ID,"XP",n)
=
ExPasswords(n)

Storage Model: CacheStorage (%BI.Users)

^BI.UsersD(ID,"F",n)
=
Folders(n)

Storage Model: CacheStorage (%BI.Users)

^BI.UsersD(ID,"SCOL")
=
LoginModule

Storage Model: CacheStorage (%BI.Users)

^BI.UsersD(ID,"M",1)
=
MailUsrMtnAdd

Storage Model: CacheStorage (%BI.Users)

^BI.UsersD(ID,"M",2)
=
MailUsrMtnSig

Storage Model: CacheStorage (%BI.Users)

^BI.UsersD(ID,"M",3)
=
MailUsrMtnAddbookLimit

Storage Model: CacheStorage (%BI.Users)

^BI.UsersD(ID,"SD",n)
=
ShortCutDB(n)

Storage Model: CacheStorage (%BI.Users)

^BI.UsersD(ID,"SCM")
=
ShortcutModule

Storage Model: CacheStorage (%BI.Users)

^BI.UsersD(ID)
=
Code
FullName
Password
FolderSuperUser
DefaultFolder
SysLanguage
SecurityLevel
shortcutLinks
NoTimeOut
lockOut
AlphaNumPwd
CanExpire
EightCharPwd
ExpiryDate
NoReUse
MyMisStd
EnbScript
MailPassword
MailUsrName
DisplayFilterCount
DisplayDate
screenHeight
screenWidth
FullScreen
DGSIG
LimitUserPref
PerfAlert
PerfAlertPopup
MyFolder
MinRowDrillDown