Class %CSP.UI.Portal.Resources

class %CSP.UI.Portal.Resources extends %CSP.UI.Template.List

System Management Portal - System Administration - Resources

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
6	10	18

Summary

This is a Zen Page class. It belongs to the application %CSP.UI.Portal.Application.

Properties
%condition	%import	%includeFiles	%page
%resource	BeginDate	ClassURL	CurrentColumn
CurrentSort	DocPage	EndDate	FILETYPE
Filter	FirstFailed	GlobalURL	HelpAddress
ISREADONLY	InvalidParam	IsEMSReadOnly	IsEditForm
LocatorHeader	MaxRows	NamespaceList	OnclickArray
PID	ParentURL	PermissionNo	PermissionRead
PermissionUse	PermissionWrite	RoutineURL	ShowGen
ShowMap	ShowSys	Spec	StdTitle
TableMaxRows	TablePageSize	ValidationErrorMsg	aboutPage
align	aux	backgroundTimerInterval	captionLastUpdate
cellAlign	cellSize	cellStyle	cellVAlign
children	colDelete	composite	contactPage
containerStyle	cssLevel	currSortMode	currStep
currViewMode	disabled	dragAndDrop	dragEnabled
dropEnabled	enableAutoRefresh	enclosingClass	enclosingStyle
error	groupClass	groupStyle	height
hidden	hint	hintClass	hintStyle
home	homePage	id	index
label	labelClass	labelDisabledClass	labelPosition
labelStyle	layout	lblTitle	limitPopups
msgConfirm	msgDBDefault	msgDeleteMsgs	name
onafterdrag	onbeforedrag	onclick	ondrag
ondrop	onhide	onrefresh	onshow
onupdate	pageModified	parent	searchKey
showLabel	slice	title	tuple
useSVG	useSoftModals	valign	visible
width	window	zenPersistentPopup

Methods
%AddChild	%AddChildAfter	%AddChildBefore	%AddComponent
%AddImportedComponents	%AddLocatorLinks	%AddToSaveSet	%ApplyURLParms
%Attr	%BindExport	%ChangeNS	%ClassIsLatestVersion
%ClassName	%ConstructClone	%DispatchClassMethod	%DispatchGetModified
%DispatchGetProperty	%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty
%DispatchSetProperty	%DrawAutoLogout	%DrawClassDefinitions	%DrawComponentHTML
%DrawHTML	%DrawHTMLPage	%DrawJSStrings	%DrawObjectDefinitions
%EnclosingDivId	%EndBackgroundMethod	%EndScript	%Eval
%EvalC	%Extends	%ForceClientRender	%GetChildIndex
%GetComponent	%GetComponentById	%GetComponentByName	%GetEventHandlers
%GetHomePage	%GetHomeParam	%GetLinks	%GetLocatorLinks
%GetNavTableState	%GetPageName	%GetParameter	%GetProductName
%GetValueById	%GetValueByName	%GetXMLName	%IsA
%IsModified	%Link	%LinkCSS	%LinkScript
%MakeId	%New	%NormalizeObject	%ObjectModified
%OnAddToPageAfter	%OnAddToPageBefore	%OnAfterCreatePage	%OnBeforeCreatePage
%OnCreateApplication	%OnCreatePage	%OnDetermineCSSLevel	%OnDrawEnclosingDiv
%OnDrawHTMLBody	%OnDrawHTMLHead	%OnDrawHTMLMeta	%OnDrawObjectProperties
%OnFinishBackgroundTask	%OnGetPageName	%OnGetProductName	%OnGetSmallMenu
%OnGetTitle	%OnMonitorBackgroundTask	%OnMutateChildren	%OnObjectSynch
%OnPreHTTP	%OnSubmit	%OnUseSoftModals	%OnZENDeserialize
%OriginalNamespace	%PackageName	%QuoteValue	%QuoteValueL10N
%Register	%RemoveChild	%RemoveChildren	%RemoveComponent
%RemoveFromSaveSet	%RunBackgroundMethod	%Self	%SerializeObject
%SetBackgroundMethodStatus	%SetErrorById	%SetErrorByName	%SetModified
%SetValueById	%SetValueByName	%SetValuesByName	%StartScript
%ValidateObject	%ZENVersion	BuildMenu	BuildMeter
CheckAllBlanks	CheckContextLinks	CheckEnterpriseManager	ConvertParameter
Decrypt	Delete	DoLogout	DrawAutoRefresh
DrawLocator	DrawRibbon	DrawTableHeader	DrawTitle
Encrypt	EscapeHTML	EscapeURL	EvalResult
ExecuteRS	FindDBDir	FindDBName	GetCSPURL
GetContextLinks	GetDBList	GetDocURL	GetExpandState
GetHomePage	GetLastSearch	GetNSList	GetNewURL
GetQuickLinks	GetRecentList	HyperEventCall	HyperEventHead
Include	InsertHiddenField	InsertHiddenFields	IsPrivate
JavaInstalled	LastUpdateTime	Link	OnDrawRibbon
OnGetRibbonInfo	OnHTTPHeader	OnPage	OnPageError
OnPostHTTP	OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent
Page	PrepareAction	QuoteJS	RegisterRecent
RewriteURL	SaveExpandState	SaveSelections	ShowError
StartTimer	StopTimer	ThrowError	UnescapeHTML
UnescapeURL	UpdateAutoRefreshRate	UpdateAutoRefreshState	UpdateTableNavState
UpdateTableState	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	addChild	addChildAfter	addChildBefore
adjustSizes	afterSave	afterValidate	cancelPopup
changePassword	checkURLNamespace	childrenMutated	columnSort
correctIELayering	createComponent	createComponentNS	deleteComponent
disableCommandButton	doCancel	doDelete	doDoc
doEdit	doExport	doImport	doModified
doProfile	doSearch	dragFinishHandler	dragHandler
dragNotifyHandler	dragStartHandler	dropHandler	dropStartHandler
enableCommandButton	endModal	exposeComponent	findElement
findNSMatch	fireOnResizeEvent	fireOnUnloadEvent	fireOnUpdateEvent
firePopupAction	getChildIndex	getComponent	getComponentById
getEnclosingDiv	getHidden	getHintElement	getLabelElement
getOpener	getPageTitle	getProperty	getSelectedNamespace
getSettings	getTime	getTitleAreaHeight	getType
goHome	goMenu	gotoNamespace	gotoPage
hideCommandButton	invokeSuper	isButtonDisabled	isOfType
keyUp	launchPopupWindow	logout	makeId
navMaxRowsChanged	navPageSizeChanged	navigate	onCreate
onDelete	onDisplayHandler	onEndModalHandler	onPopupAction
onRefreshContents	onSerialize	onServerMethodCall	onServerMethodError
onServerMethodReturn	onStartModalHandler	ondisabledHandler	onhandleAutoLogoutWarn
onkeydownHandler	onkeyupHandler	onlayoutHandler	onloadHandler
onlogoutHandler	onoverlayHandler	onresizeHandler	onunloadHandler
onupdateHandler	popupActionHandler	refreshContents	refreshHandler
refreshkeyUp	reloadTable	removeChild	render
renderContents	renderSVG	resetMsg	searchBlur
searchBoxHandler	searchFocus	searchKeyDown	searchKeyPress
setComponentId	setConnectivityStatusMsg	setHidden	setModified
setOverlayMode	setPageTitle	setProperty	setPropertyAll
setRefreshMode	setRefreshRate	setSortMode	setSortModeHandler
setTraceOption	setViewMode	setViewModeHandler	showAbout
showCommandButton	showContact	showDocumentation	showExpand
showHelp	showMsg	startModal	startProgressBar
stopProgressBar	switchNamespace	toggleDetails	toggleSearch
trimSpace	updateTime	updateView	validateRequired
zeroFill

Parameters

• parameter AUTONS = 0;

Do not switch namespace for this page: it needs to stay in %SYS

• parameter CSPURL = "/csp/sys/sec/%CSP.UI.Portal.Resources.zen";

This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.

• parameter EMSSERVICE = "Security";

• parameter HELPADDRESS = "System Administration,Security,Resources";

Each SMP page should set this link which points to the documentation anchor name.

• parameter PAGENAME = "Managing Resources";

Displayed name of this page.

• parameter RESOURCE = "%Admin_Secure";

Security requirement

Properties

• property FILETYPE as %String [ InitialExpression = "Resource" ];

• property PermissionNo as %ZEN.Datatype.boolean [ InitialExpression = 1 ];

No public permission on the Search pane. Default to checked.

• property PermissionRead as %ZEN.Datatype.boolean [ InitialExpression = 1 ];

Read public permission on the Search pane. Default to checked.

• property PermissionUse as %ZEN.Datatype.boolean [ InitialExpression = 1 ];

Use public permission on the Search pane. Default to checked.

• property PermissionWrite as %ZEN.Datatype.boolean [ InitialExpression = 1 ];

Write public permission on the Search pane. Default to checked.

• property Spec as %ZEN.Datatype.string [ InitialExpression = "*" ];

Resource Name Spec on the Search pane. User can enter any of the following:

Names - Comma separated list of resource names
"*" - All records match

"String,String1" - Any records matching one of these elements

"String*" - Any record starting with "String"

"String,String1*,String2" - Any record matching one of these elements, or starting with "String1"

• property colDelete as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Delete") ];

Store translated targetCol linkCaption for

• property msgConfirm as %String [ InitialExpression = $$$TextJS("Are you sure you want to delete resource code %1?") ];

• property msgDBDefault as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("(%DB_%DEFAULT cannot be deleted.)") ];

• property msgDeleteMsgs as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Are you sure you want to delete the selected %1 resource(s)?") ];

Methods

• method %GetLocatorLinks(Output pLink) as %Status

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)

• method %OnAfterCreatePage() as %Status

Subclass to override. Always include code in this method.

• method %OnGetPageName() as %String

Get the (localized) name of the page. This should be implemented in a subclass.

• classmethod Delete(resource As %String) as %String [ ZenMethod ]

Delete selected resource/s now.

• method DrawTableHeader(pSeed As %String) as %Status

Draw the contents of the Table Header (the region between the diagram and the table).

• method ExecuteRS(pRS As %Library.ResultSet, Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %Boolean

Method for executing the query.

• method GetLastSearch() as %String

• method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status

Get information to display in the ribbon bar.

• method doDelete(resource) [ Language = javascript ]

Delete selected resource(s).

• method doEdit(resource) [ Language = javascript ]

• method doExport() [ Language = javascript ]

• method doImport() [ Language = javascript ]

• method doProfile() [ Language = javascript ]

• method doSearch() [ Language = javascript ]

User clicked Go to start search.

• method keyUp(zenEvent) [ Language = javascript ]

Check if user hit [Enter].

• method onPopupAction(popupName, action, value) [ Language = javascript ]

This client event, if present, is fired when the a popup page launched from this page fires an action.

• method onloadHandler() [ Language = javascript ]

When page is loaded, check if this is a ReadOnly for EMS. If it is then disable the multiple select.
Else disable the checkbox for %DB_%DEFAULT.

• method reloadTable() [ Language = javascript ]

Class Reference IRIS for UNIX 2024.1.2
Documentation Search