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).
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)
This list is returned in ID order; the caller will sort it.
If pShowAll is true, list items for all users.
classmethod %GetPreferences(Output pPrefs) as %Status
Return an array containing the system preferences for the portal.
classmethod %GetRecentItemsForUser(Output pItems) as %Status
Return the recent items list for the current user:
pItems(n) = $LB(fullName,name,folder,title,type,icon,date,url)
classmethod %GetSettingsFromURL(Output pSettings) as %Status
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:
Supported parameters and values include:
TARGET:widgetName; ("*" if not specified)
VARIABLE:pivotVar; (default value for pivot variable)
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:
A VARIABLE (pivot variable) spec is of the form:
On return, pSettings will contain:
pSettings(target,parm) = "value"
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")
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.
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.