Class %CSP.UI.Portal.Journal

class %CSP.UI.Portal.Journal extends %CSP.UI.Portal.Template

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
6	1	12

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	FirstFailed	HelpAddress	ISREADONLY
InvalidParam	IsEMSReadOnly	IsEditForm	LocatorHeader
OnclickArray	PID	ParentURL	StdTitle
ValidationErrorMsg	aboutPage	align	aux
backgroundTimerInterval	cellAlign	cellSize	cellStyle
cellVAlign	children	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
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	%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	%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	CheckAllBlanks	CheckContextLinks	CheckEnterpriseManager
ConvertParameter	Decrypt	DoLogout	DrawLocator
DrawRibbon	DrawTitle	Encrypt	EscapeHTML
EscapeURL	EvalResult	GetCSPURL	GetContextLinks
GetDocURL	GetHomePage	GetNewURL	GetQuickLinks
HyperEventCall	HyperEventHead	Include	InsertHiddenField
InsertHiddenFields	IsPrivate	JavaInstalled	Link
OnDrawRibbon	OnGetRibbonInfo	OnHTTPHeader	OnPage
OnPageError	OnPostHTTP	OnPostHyperEvent	OnPreHTTP
OnPreHyperEvent	Page	QuoteJS	RegisterRecent
RewriteURL	SaveData	ShowError	StartTimer
StopTimer	ThrowError	UnescapeHTML	UnescapeURL
XMLDTD	XMLExport	XMLExportToStream	XMLExportToString
XMLNew	XMLSchema	XMLSchemaNamespace	XMLSchemaType
addChild	addChildAfter	addChildBefore	afterSave
afterValidate	cancelPopup	changeArchiveName	changePassword
changePurgeArchived	childrenMutated	correctIELayering	createComponent
createComponentNS	deleteComponent	disableCommandButton	doBrowse
doCancel	doModified	doNewArchive	doSave
dragFinishHandler	dragHandler	dragNotifyHandler	dragStartHandler
dropHandler	dropStartHandler	enableCommandButton	endModal
exposeComponent	findElement	fireOnResizeEvent	fireOnUnloadEvent
fireOnUpdateEvent	firePopupAction	getChildIndex	getComponent
getComponentById	getEnclosingDiv	getHidden	getHintElement
getLabelElement	getOpener	getPageTitle	getProperty
getSettings	getTitleAreaHeight	getType	goHome
goMenu	gotoNamespace	gotoPage	hideCommandButton
invokeSuper	isButtonDisabled	isOfType	launchPopupWindow
logout	makeId	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	removeChild
render	renderContents	renderSVG	resetMsg
searchBlur	searchBoxHandler	searchFocus	searchKeyDown
searchKeyPress	setComponentId	setConnectivityStatusMsg	setHidden
setModified	setOverlayMode	setPageTitle	setProperty
setPropertyAll	setSortMode	setSortModeHandler	setTraceOption
setViewMode	setViewModeHandler	showAbout	showCommandButton
showContact	showDocumentation	showHelp	showMsg
startModal	startProgressBar	stopProgressBar	switchNamespace
trimSpace	validate	validateRequired

Parameters

• parameter AUTONS = 0;

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

• parameter CSPURL = "/csp/sys/mgr/%CSP.UI.Portal.Journal.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 = "Config";

• parameter HELPADDRESS = "Home,Journal Settings";

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

• parameter PAGENAME = "Journal Settings";

Displayed name of this page.

• parameter RESOURCE = "%Admin_Manage,%Admin_Journal";

Security requirement

Properties

• property IsEditForm as %Boolean [ InitialExpression = 1 ];

If set to 1 then the generic Save and Cancel button will be shown on the ribbon bar.

Methods

• method %OnAfterCreatePage() as %Status

Be sure to do ##super() when overriding.

• method %OnGetPageName() as %String

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

• classmethod %OnPreHTTP() as %Boolean

Zen page notification of an HTTP request. This method can be overwritten by subclasses.
This is called before the standard Zen pre-HTTP processing occurs.

• classmethod SaveData(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]

Call server save method.

• method changeArchiveName(newvalue) [ Language = javascript ]

• method changePurgeArchived(newvalue) [ Language = javascript ]

• method doBrowse(fieldID) [ Language = javascript ]

Launching a file selector window.

• method doNewArchive() [ Language = javascript ]

• method doSave() [ Language = javascript ]

Save current item.

• method getPageTitle() as %String [ Language = javascript ]

Get the title string to add to the locator row.

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

Returning from file select OR qualifers dialog and setting the value into the appropriate field. The id of the field that needs to be updated is saved in "dialogClicked".

• method validate() as %Boolean [ Language = javascript ]

Class Reference IRIS for UNIX 2024.1.2
Documentation Search