Inheritance diagram for Utils:

[legend]

Collaboration diagram for Utils:

[legend]

Static Public Member Functions
_.Library.Status	AddWidgetKeys (_.DeepSee.Dashboard.Definition pDashboard)
	Look through all of the widgets in a dashboard and make sure each that has a logical name also has a defined key.

_.Library.Status	AddWidgetNames (_.DeepSee.Dashboard.Definition pDashboard, pNewWidgetNames)
	Inspect an open dashboard definition object and add names to any widgets that do not have names. More...

Static Private Member Functions
_.Library.Status	ClearDashboardSettings (_.Library.String pDashboard, _.Library.String pUser, _.Library.Boolean pSaveLocalDataSource)
	Clear dashboard settings for the given dashboard (If pUser is "", then for all users).

_.Library.Status	ClearLocalDataSource (_.Library.String pDashboard, _.Library.String pWidgetKey)
	Clear the localDataSource for a specific user and widget.

_.Library.Status	ClearUserIcons ()
	Delete the current user icons for the current namespace.

_.Library.Status	ClearUserSettings ()
	Delete the current user settings for the current namespace.

_.Library.Status	DeleteAlert (_.Library.String pAlertId)
	Delete the given alert.

_.Library.Status	FindDependencies (_.Library.String pName, _.Library.String pList, _.Library.Boolean pVerbose)
	For the given folder item, pName, return a list of other items it depends upon.

_.Library.Status	FindIsUsedBy (_.Library.String pName, _.Library.String pList, _.Library.Boolean pVerbose)
	For the given folder item, pName, return a list of other items that use it. More...

_.Library.String	FormatDate (_.Library.String pDate, _.Library.Boolean pUTCtoLocal)
	Format a $H value.

_.Library.Status	GetAlertsForUser (pAlerts, _.Library.Integer pNewCount, _.Library.Integer pMaxItems)
	Return the current alerts list for the current user: More...

_.Library.Status	GetChartSeriesSchemeInfo (_.Library.String pScheme, pSchemeName, pColorList)
	Find info on the given chart series color scheme.

_.Library.Status	GetChartSeriesSchemes (pScheme)
	Return an array of the defined chart series color schemes: More...

_.Library.Status	GetColorSchemeInfo (_.Library.String pScheme, pInfo)
	Find info on the given dashboard color scheme.

_.Library.Status	GetColorSchemes (pScheme)
	Return an array the list of defined dashboard color schemes: More...

_.Library.Status	GetColorSets (pSet)
	Return an array of the defined color sets. More...

_.Library.String	GetErrorPageURL (_.Library.String pError)
	Return the URL for the user portal error page.

_.Library.Status	GetFavoritesForUser (pFavorites)
	Return the current favorites list for the current user: More...

_.Library.Status	GetFolderItemsForUser (pItems, _.Library.String pFolderName, _.Library.String pSearchKey, _.Library.Boolean pIncludePrivate, _.Library.Boolean pShowAll)
	Return a list of folder items for the current user: More...

_.Library.Status	GetPreferences (pPrefs)
	Return an array containing the system preferences for the portal.

_.Library.Status	GetRecentItemsForUser (pItems)
	Return the recent items list for the current user: More...

_.Library.Status	GetSettingsFromURL (pSettings)
	Get the values of any SETTINGS parameters within the current URL and pull them apart. More...

_.Library.String	GetUserHomePageURL ()
	Return the URL for the user portal home page.

_.Library.String	GetUserIcon (_.Library.String pName, _.Library.Status pSC)
	Get the path of the given user-defined icon.

_.Library.Status	GetUserIconList (pData)
	Return a list of the current user icons in the form: More...

_.Library.Status	GetUserList (pUsers, _.Library.String pSearchKey, _.Library.Boolean pAlertsEnabled)
	Return a list of DeepSee users. More...

_.Library.String	GetUserName (_.Library.String pUserName)
	Return the name of the current user (or given user name). More...

_.Library.String	GetUserSetting (_.Library.String pName, _.Library.Status pSC)
	Get the value of the given user-defined setting. More...

_.Library.Status	GetUserSettingsList (pData, _.Library.String pContext)
	Return a list of the current user settings in the form: More...

_.Library.String	GetViewerURL ()
	Return the URL for the dashboard viewer.

_.Library.Status	KillAlerts ()
	Delete all alerts in this namespace.

_.Library.Status	ListFolderItems (_.Library.String pSearchKey)
	Print a list of all folder items to the console. More...

_.Library.String	LoadDashboardSettings (_.Library.String pSettings, _.Library.String pDashboard, _.Library.String pUser)
	A dashboard setting is a set of name/value pairs saved for a specific. More...

_.Library.Status	RegisterUser (_.Library.String pUserId, _.Library.String pUserName, _.Library.String pEMail, _.Library.Boolean pEnabled)
	Register a DeepSee user.

_.Library.Status	RemoveUserIcon (_.Library.String pName)
	Delete the given user icon for the current namespace.

_.Library.Status	RemoveUserSetting (_.Library.String pName)
	Delete the given user setting for the current namespace.

_.Library.String	ResolveText (_.Library.String pText)
	Resolve a localized text string at run time. More...

_.Library.String	ResolveTextList (_.Library.String pText)
	Resolve a csv-list of localized text strings at run time.

_.Library.Status	SaveDashboardSettings (_.Library.String pSettings, _.Library.String pDashboard, _.Library.String pUser)
	A dashboard setting is a set of name/value pairs saved for a specific. More...

_.Library.Status	SendAlert (_.DeepSee.UserPortal.Data.Alert pAlert)
	Send a new alert.

_.Library.Status	SetUserIcon (_.Library.String pName, _.Library.String pPath)
	Set the path for the given user-defined icon. More...

_.Library.Status	SetUserSetting (_.Library.String pName, _.Library.String pValue, _.Library.String pComment, _.Library.String pContext)
	Set the value and comment for the given user-defined setting. More...

Additional Inherited Members
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

APIs used by the UserPortal.

Member Function Documentation

◆ FindIsUsedBy()

_.Library.Status FindIsUsedBy	(	_.Library.String	pName,
		_.Library.String	pList,
		_.Library.Boolean	pVerbose
	)

staticprivate

For the given folder item, pName, return a list of other items that use it.

This method does a full scan of all dashboard items, so use sparingly.

◆ GetAlertsForUser()

_.Library.Status GetAlertsForUser	(		pAlerts,
		_.Library.Integer	pNewCount,
		_.Library.Integer	pMaxItems
	)

staticprivate

Return the current alerts list for the current user:

pAlerts(n) = $LB(alertId,from,subject,date,url,priority,icon,iconTip)

◆ GetChartSeriesSchemes()

_.Library.Status GetChartSeriesSchemes ( pScheme )

staticprivate

Return an array of the defined chart series color schemes:

pScheme(n) = $LB(name,caption,[colorList])

◆ GetColorSchemes()

_.Library.Status GetColorSchemes ( pScheme )

staticprivate

Return an array the list of defined dashboard color schemes:

pScheme(n) = $LB(name,caption,jsFile,cssFile)

◆ GetColorSets()

_.Library.Status GetColorSets ( pSet )

staticprivate

Return an array of the defined color sets.

A color set is a name list of up to 256 colors used by a color picker. pSet(n) = $LB(name,caption,;-delimited list of colors)

◆ GetFavoritesForUser()

_.Library.Status GetFavoritesForUser ( pFavorites )

staticprivate

Return the current favorites list for the current user:

pItems(n) = $LB(fullName,name,folder,title,type,icon,date,url)

◆ GetFolderItemsForUser()

_.Library.Status GetFolderItemsForUser	(		pItems,
		_.Library.String	pFolderName,
		_.Library.String	pSearchKey,
		_.Library.Boolean	pIncludePrivate,
		_.Library.Boolean	pShowAll
	)

staticprivate

Return a list of folder items for the current user:

pItems(n) = $LB(name,type,tip,date,url,icon,keywords,public,title,createdBy,resource,cover,category,owner,write,lastAccessed)
This list is returned in ID order; the caller will sort it. If pShowAll is true, list items for all users.

◆ GetRecentItemsForUser()

_.Library.Status GetRecentItemsForUser ( pItems )

staticprivate

Return the recent items list for the current user:

pItems(n) = $LB(fullName,name,folder,title,type,icon,date,url)

◆ GetSettingsFromURL()

_.Library.Status GetSettingsFromURL ( pSettings )

staticprivate

Get the values of any SETTINGS parameters within the current URL and pull them apart.

A dashboard URL may contain any number of parameters called SETTINGS. Each takes the form:
SETTINGS=parm:value;parm:value;
Supported parameters and values include:

TARGET:widgetName; ("*" if not specified)
FILTER:spec;
VARIABLE:pivotVar; (default value for pivot variable)
ROWCOUNT:#;
COLCOUNT:#;
ROWSORT:Measure;
COLSORT:Measure;
ROWSORTDIR:ASC|DESC;
COLSORTDIR:ASC|DESC;

For some items, such as FILTER, there can be multiple values separated by ~

;; is an escape for ";"
~~ is an escape for "~"

A FILTER spec is of the form:
Name.Value or [Name].[Value], [Name].&[Value]
For an MDX-based filter, Name may have multiple pieces:
[DIM].[Hier].[Level].[Value]

A VARIABLE (pivot variable) spec is of the form:
VarName.Value

On return, pSettings will contain:
pSettings(target,parm) = "value"

◆ GetUserIconList()

_.Library.Status GetUserIconList ( pData )

staticprivate

Return a list of the current user icons in the form:

pData(n) = $LB(name,path)

◆ GetUserList()

_.Library.Status GetUserList	(		pUsers,
		_.Library.String	pSearchKey,
		_.Library.Boolean	pAlertsEnabled
	)

staticprivate

Return a list of DeepSee users.

pUsers(n) = $LB(id,name,icon)
If pAlertsEnabled is true, then only return users that have enabled alerts.

◆ GetUserName()

_.Library.String GetUserName ( _.Library.String pUserName )

staticprivate

Return the name of the current user (or given user name).

Return their full name if registered, otherwise return the login name.

◆ GetUserSetting()

_.Library.String GetUserSetting	(	_.Library.String	pName,
		_.Library.Status	pSC
	)

staticprivate

Get the value of the given user-defined setting.

A user-setting is an expression. This method evaluates the expression and returns the result.

◆ GetUserSettingsList()

_.Library.Status GetUserSettingsList	(		pData,
		_.Library.String	pContext
	)

staticprivate

Return a list of the current user settings in the form:

pData(n) = $LB(name,value,comment,context)

◆ ListFolderItems()

_.Library.Status ListFolderItems ( _.Library.String pSearchKey )

staticprivate

Print a list of all folder items to the console.

◆ LoadDashboardSettings()

_.Library.String LoadDashboardSettings	(	_.Library.String	pSettings,
		_.Library.String	pDashboard,
		_.Library.String	pUser
	)

staticprivate

A dashboard setting is a set of name/value pairs saved for a specific.

dashboard and user. This lets the user save filters values, positions, etc.

◆ ResolveText()

_.Library.String ResolveText ( _.Library.String pText )

staticprivate

Resolve a localized text string at run time.

A localized string can take the following forms:
"String" – not localized.
"$$$String" – equivalent to $$$Text("String","DeepSeeUser")
"$$$String/Domain" – equivalent to $$$Text("String","Domain")

◆ SaveDashboardSettings()

_.Library.Status SaveDashboardSettings	(	_.Library.String	pSettings,
		_.Library.String	pDashboard,
		_.Library.String	pUser
	)

staticprivate

A dashboard setting is a set of name/value pairs saved for a specific.

dashboard and user. This lets the user save filters values, positions, etc.

◆ SetUserIcon()

_.Library.Status SetUserIcon	(	_.Library.String	pName,
		_.Library.String	pPath
	)

staticprivate

Set the path for the given user-defined icon.

pName is the name of the icon. This must be unique.
pValue is the path for the icon.

◆ SetUserSetting()

_.Library.Status SetUserSetting	(	_.Library.String	pName,
		_.Library.String	pValue,
		_.Library.String	pComment,
		_.Library.String	pContext
	)

staticprivate

Set the value and comment for the given user-defined setting.

pName is the name of the setting. This must be unique.
pValue is the value of the setting. This is in ObjectScript expression that is evaluated at run-time.
pComment is a comment.
pContext is the name of the context in which this setting is expected to be used. This allows the user to be presented with a limited set of settings.

◆ AddWidgetNames()

_.Library.Status AddWidgetNames	(	_.DeepSee.Dashboard.Definition	pDashboard,
			pNewWidgetNames
	)

static

Inspect an open dashboard definition object and add names to any widgets that do not have names.

All widgets

that are assigned new names will have a name of the form WidgetXXX that is unique to the dashboard assigned. All names assigned in this manner will be returned in an index available through the by reference argument
pNewWidgetNames(widgetPosition) = newName
This method will not change the stored dashboard definition DFI document.

Static Public Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ FindIsUsedBy()

◆ GetAlertsForUser()

◆ GetChartSeriesSchemes()

◆ GetColorSchemes()

◆ GetColorSets()

◆ GetFavoritesForUser()

◆ GetFolderItemsForUser()

◆ GetRecentItemsForUser()

◆ GetSettingsFromURL()

◆ GetUserIconList()

◆ GetUserList()

◆ GetUserName()

◆ GetUserSetting()

◆ GetUserSettingsList()

◆ ListFolderItems()

◆ LoadDashboardSettings()

◆ ResolveText()

◆ SaveDashboardSettings()

◆ SetUserIcon()

◆ SetUserSetting()

◆ AddWidgetNames()