Class %DeepSee.UserPortal.Workflow

class %DeepSee.UserPortal.Workflow extends %DeepSee.UserPortal.standardPage

Workflow InBox page.
Shows the list of current workflow tasks for the current user.

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
4	5	33

Summary

This is a Zen Page class. It belongs to the application %DeepSee.UserPortal.Application.

Properties
%condition	%import	%includeFiles	%page
%resource	StdTitle	aboutPage	alertId
align	aux	backgroundTimerInterval	canWrite
cellAlign	cellSize	cellStyle	cellVAlign
chartSeriesColors	chartSeriesScheme	children	companyLogo
companyName	companyStyle	composite	containerStyle
cssLevel	currItemId	disabled	dragAndDrop
dragEnabled	dropEnabled	enableAutoRefresh	enclosingClass
enclosingStyle	error	groupClass	groupStyle
height	hidden	hint	hintClass
hintStyle	homePage	hzSplit	id
index	isEmbedded	label	labelClass
labelDisabledClass	labelPosition	labelStyle	lastMessage
lastUpdateMsg	layout	limitPopups	name
namespace	noBorder	noModify	noTitle
onafterdrag	onbeforedrag	onclick	ondrag
ondrop	onhide	onrefresh	onshow
onupdate	parent	searchKey	showLabel
slice	title	tuple	urlWorklistCount
useClientEmail	useSVG	useSoftModals	valign
viewerURL	visible	width	window
worklistCount	zenPersistentPopup

Methods
%AddChild	%AddChildAfter	%AddChildBefore	%AddComponent
%AddImportedComponents	%AddToSaveSet	%ApplyURLParms	%Attr
%BindExport	%ClassIsLatestVersion	%ClassName	%ConstructClone
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%DrawAutoLogout
%DrawClassDefinitions	%DrawComponentHTML	%DrawHTML	%DrawHTMLPage
%DrawJSStrings	%DrawObjectDefinitions	%DrawWorklist	%DrawWorklistHeader
%EnclosingDivId	%EndBackgroundMethod	%EndScript	%Eval
%EvalC	%Extends	%ForceClientRender	%GetChildIndex
%GetComponent	%GetComponentById	%GetComponentByName	%GetEventHandlers
%GetLinks	%GetPageName	%GetParameter	%GetValueById
%GetValueByName	%GetWorkflowTasksForUser	%GetXMLName	%IsA
%IsModified	%Link	%LinkCSS	%LinkScript
%MakeId	%New	%NormalizeObject	%ObjectModified
%OnAddToPageAfter	%OnAddToPageBefore	%OnAfterCreatePage	%OnBeforeCreatePage
%OnCreateApplication	%OnCreatePage	%OnDetermineCSSLevel	%OnDrawEnclosingDiv
%OnDrawHTMLBody	%OnDrawHTMLHead	%OnDrawHTMLMeta	%OnDrawObjectProperties
%OnFinishBackgroundTask	%OnGetPageName	%OnGetSmallMenu	%OnGetTitle
%OnGetWorklistOptions1	%OnGetWorklistOptions2	%OnMonitorBackgroundTask	%OnMutateChildren
%OnObjectSynch	%OnPreHTTP	%OnSubmit	%OnUseSoftModals
%OnZENDeserialize	%OriginalNamespace	%PackageName	%QuoteValue
%QuoteValueL10N	%RemoveChild	%RemoveChildren	%RemoveComponent
%RemoveFromSaveSet	%RunBackgroundMethod	%Self	%SerializeObject
%SetBackgroundMethodStatus	%SetErrorById	%SetErrorByName	%SetModified
%SetValueById	%SetValueByName	%SetValuesByName	%StartScript
%ValidateObject	%ZENVersion	AddFavorite	ConvertParameter
Decrypt	DoLogout	DrawTaskDetails	DrawTaskHeader
DrawTaskList	DrawTitle	DrawWorklist1	DrawWorklist2
DrawWorklistHeader1	DrawWorklistHeader2	DrawWorklistTitle	Encrypt
EscapeHTML	EscapeURL	GetQuickLinks	HyperEventCall
HyperEventHead	Include	InsertHiddenField	InsertHiddenFields
IsPrivate	JavaInstalled	Link	OnHTTPHeader
OnPage	OnPageError	OnPostHTTP	OnPostHyperEvent
OnPreHTTP	OnPreHyperEvent	Page	QuoteJS
RemoveAlert	RemoveFavorite	RemoveRecentItem	RewriteURL
SendItemToTrash	ShowError	ShowForm	StartTimer
StopTimer	ThrowError	UnescapeHTML	UnescapeURL
XMLDTD	XMLExport	XMLExportToStream	XMLExportToString
XMLNew	XMLSchema	XMLSchemaNamespace	XMLSchemaType
actionButtonHandler	activateSearchBox	addChild	addChildAfter
addChildBefore	addToFavorites	adjustSizes	cancelPopup
childrenMutated	clearSplitTimer	correctIELayering	createComponent
createComponentNS	deleteComponent	doSearch	downloadLink
dragFinishHandler	dragHandler	dragNotifyHandler	dragStartHandler
dropHandler	dropStartHandler	endModal	exposeComponent
findElement	fireOnResizeEvent	fireOnUnloadEvent	fireOnUpdateEvent
firePopupAction	getChildIndex	getComponent	getComponentById
getEnclosingDiv	getHidden	getHintElement	getLabelElement
getNavigator	getOpener	getProperty	getSettings
getTitleAreaHeight	getType	goHome	gotoAlert
gotoFavorite	gotoNamespace	gotoPage	gotoSMP
invokeAction	invokeSuper	isOfType	launchPopupWindow
listRefreshed	logout	makeId	navCloseButtonClick
navDataArrange	navDataChange	navExpand	navGetContentForLevel
navHeaderButtonClick	navPopupAction	navSelectItem	navigate
onAdjustSizes	onCreate	onDelete	onDisplayHandler
onEndModalHandler	onPopupAction	onRefreshContents	onSerialize
onServerMethodCall	onServerMethodError	onServerMethodReturn	onStartModalHandler
ondisabledHandler	onhandleAutoLogoutWarn	onkeydownHandler	onkeyupHandler
onlayoutHandler	onloadHandler	onlogoutHandler	onoverlayHandler
onresizeHandler	onunloadHandler	onupdateHandler	popupActionHandler
refreshContents	refreshTasks	refreshTimerHandler	reloadPage
removeChild	removeFromAlerts	removeFromFavorites	removeFromRecentList
render	renderContents	renderSVG	searchKeyPress
selectItem	sendAlert	sendMail	setCompanyCell
setComponentId	setConnectivityStatusMsg	setHidden	setOverlayMode
setPortalTitleMsg	setProperty	setPropertyAll	setSplit
setTraceOption	setWorklistView	showAbout	showHelp
splitTimerHandler	startModal	startProgressBar	startSplitTimer
stopProgressBar	toggleDetails	toggleWorklists	updateCompanyCell
updateDetails	updateWorklistTitle	updateWorklistType

Parameters

• parameter HOMEPAGE = "_DeepSee.UserPortal.Home.zen";

URL of home page (used in links).

• parameter PAGENAME = "Workflow Inbox";

Name of this page.

• parameter WORKLIST1VIEW;

Starting view for worklist 1.

• parameter WORKLIST2VIEW;

Starting view for worklist 2.

Properties

• property currItemId as %String(ZENURL="ID");

Item id of current item.

• property hzSplit as %Integer [ InitialExpression = 70 ];

Percentage height of task list.

• property lastMessage as %String(ZENURL="MSG");

Message from form submit handler.

• property lastUpdateMsg as %String;

Last update message.

• property namespace as %ZEN.Datatype.string [ InitialExpression = $namespace ];

Methods

• classmethod %GetWorkflowTasksForUser(Output pList, Output pColumns, pSearchKey As %String = "") as %Status

Return list of workflow tasks for the current user.

• method %OnAfterCreatePage() as %Status

Decorate the page.

• method %OnGetPageName() as %String

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

• method %OnGetTitle() as %String

Get the (localized) title string for the page. This should be implemented in a subclass.

• method %OnGetWorklistOptions1(Output pOptions, Output pDefaultMode) as %Status

Return list of options for work list 1.

• method %OnGetWorklistOptions2(Output pOptions, Output pDefaultMode) as %Status

Return list of options for work list 2.

• classmethod %OnSubmit(pSubmit As %ZEN.Submit) as %Status

Submit handler-- this processes submits of the task form.

• final method DrawTaskDetails(pSeed As %String) as %Status

Draw the contents of the Task Details area.

• final method DrawTaskHeader(pSeed As %String) as %Status

Draw the contents of the Task Header area.

• final method DrawTaskList(pSeed As %String) as %Status

Draw the contents of the Task List area.

• final method DrawWorklistTitle(pSeed As %String) as %Status

Draw the contents of the worklist title area.

• method ShowForm(pItem As %RegisteredObject, pState As %String) as %Status

Show form for this worklist item

• method actionButtonHandler(action, confirmMsg) [ Language = javascript ]

Called by action buttons on the detail form.

• method activateSearchBox() [ Language = javascript ]

Activate the search text box;

• method clearSplitTimer() [ Language = javascript ]

Stop the split timer.

• method doSearch() [ Language = javascript ]

Perform a search.

• method downloadLink() as %String [ ZenMethod ]

• method gotoSMP() [ Language = javascript ]

Show the System Management portal.

• method invokeAction(type, rowid) [ Language = javascript ]

Invoke an action on a row.

• method listRefreshed() [ Language = javascript ]

Called whenever task list is refreshed..

• method onAdjustSizes(load, contentWidth, contentHeight) [ Language = javascript ]

Adjust sizes of content area.

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

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

• method onloadHandler() [ Language = javascript ]

This client event, if present, is fired when the page is loaded.

• method refreshTasks() [ Language = javascript ]

Reload the task list.

• method refreshTimerHandler(timer) [ Language = javascript ]

Refresh timer has fired.

• method searchKeyPress(evt) [ Language = javascript ]

Key press in search box.

• method selectItem(id) [ Language = javascript ]

Click on item in task list.

• method setSplit(split) [ Language = javascript ]

Invoke an action on a row.

• method splitTimerHandler() [ Language = javascript ]

Action for split timer.

• method startSplitTimer() [ Language = javascript ]

Start the split timer.

• method toggleDetails() [ Language = javascript ]

Make details section big or little.

• method updateDetails(taskid) [ Language = javascript ]

Update the details panel if the taskid is not the same as URL

• method updateWorklistTitle() [ Language = javascript ]

Update the title for the dashboard.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search