Class %CSP.UI.Portal.ObjectGateway

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

Zen page for System Management Portal - Edit an Object Gateway Server

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5	9	16

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	GatewayType	HelpAddress	ISREADONLY
IsEnsemble	IsRunning	IsUnix	LocatorHeader
PID	ParentURL	StdTitle	aboutPage
align	aux	backgroundTimerInterval	cellAlign
cellSize	cellStyle	cellVAlign	children
composite	containerStyle	cssLevel	currSortMode
currStep	currViewMode	disabled	dragAndDrop
dragEnabled	dropEnabled	enclosingClass	enclosingStyle
error	groupClass	groupStyle	height
hidden	hint	hintClass	hintStyle
home	homePage	id	index
isNew	label	labelClass	labelDisabledClass
labelPosition	labelStyle	layout	lblTitle
msgActionsDisplay	msgActionsValue	msgConfirmRunning	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
%%OIDGet	%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
%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	ConvertParameter	Decrypt
DoLogout	DrawLocator	DrawRibbon	DrawTitle
Encrypt	EscapeHTML	EscapeURL	GetCSPURL
GetContextLinks	GetDocPage	GetHomePage	GetNewURL
GetQuickLinks	HyperEventBody	HyperEventCall	HyperEventFrame
HyperEventHead	Include	InsertHiddenField	InsertHiddenFields
IsPrivate	Link	LoadData	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	ZStripW
addChild	addChildAfter	addChildBefore	browseSelect
cancelPopup	cancelSetting	changePassword	changeType
checkIsRunning	childrenMutated	correctIELayering	createComponent
createComponentNS	deleteComponent	dragFinishHandler	dragHandler
dragNotifyHandler	dragStartHandler	dropHandler	dropStartHandler
endModal	exposeComponent	findElement	fireOnLoadEvent
fireOnResizeEvent	fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction
formValidationHandler	getChildIndex	getComponent	getComponentById
getEnclosingDiv	getHidden	getHintElement	getLabelElement
getOpener	getProperty	getSettings	getTitleAreaHeight
getType	goHome	goMenu	gotoNamespace
gotoPage	invokeSuper	isOfType	launchPopupWindow
logout	makeId	navigate	onCreate
onDelete	onDisplayHandler	onEndModalHandler	onPopupAction
onRefreshContents	onSerialize	onServerMethodCall	onServerMethodError
onServerMethodReturn	onStartModalHandler	ondisabledHandler	onkeydownHandler
onkeyupHandler	onlayoutHandler	onloadHandler	onlogoutHandler
onoverlayHandler	onresizeHandler	onunloadHandler	onupdateHandler
popupActionHandler	refreshContents	removeChild	render
renderContents	renderSVG	resetMsg	saveSetting
searchBlur	searchBoxHandler	searchFocus	searchKeyDown
searchKeyPress	setComponentId	setHidden	setModified
setOverlayMode	setProperty	setPropertyAll	setSortMode
setSortModeHandler	setTraceOption	setViewMode	setViewModeHandler
showAbout	showDocumentation	showGatewayType	showHelp
showMsg	startModal	startProgressBar	stopProgressBar
switchNamespace	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.ObjectGateway.cls";

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 PAGENAME = "Object Gateway";

Displayed name of this page.

• parameter PARENTPAGE = "%CSP.UI.Portal.ObjectGateways.cls";

This parameter defines the parent page for this page.
If the name ends in .csp, then the parent is assumed to be an autopage-enabled CSP page.
If the name ends in .cls, then the parent is assumed to be a Zen page.
This is used to automate the construction of the locator bar for this page and to build the index between portal pages and documentation.
The %GetLocatorInfo method is used to get this information.

• parameter RESOURCE = "%Admin_Manage";

Security requirement

Properties

• property GatewayType as %ZEN.Datatype.string;

Gateway type display string (.NET or Java)

• property IsEnsemble as %Boolean;

Is Ensemble-enabled

• property IsRunning as %Boolean [ InitialExpression = "0" ];

Is the current gateway running

• property IsUnix as %Boolean [ InitialExpression = "0" ];

Is this a Unix system

• property PID as %String(ZENURL="PID");

ID for edit.

• property isNew as %ZEN.Datatype.boolean(ZENURL="isNew") [ InitialExpression = "0" ];

• property msgActionsDisplay as %String [ InitialExpression = $$$Text("None,Restart,Alert,Restart and Alert") ];

• property msgActionsValue as %String [ InitialExpression = "N,R,A,RA" ];

• property msgConfirmRunning as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Gateway is currently running! In order to save, you must stop the Gateway first.") ];

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

Decorate the page.

• classmethod CheckAllBlanks(string) as %Boolean [ ZenMethod ]

• method LoadData(PID As %String, IsEnsemble As %Boolean) as %String

Load values into fields. Special cases:
If Ensemble is not enabled, then
on Windows: .NET only
on Unix: Java only

• classmethod SaveData(PID, Type, Name, Server, Port, LogFile, HeartbeatInterval, HeartbeatFailureTimeout, HeartbeatFailureAction, HeartbeatFailureRetry, InitializationTimeout, ConnectionTimeout, J1, J2, J3, J4) as %ZEN.proxyObject [ ZenMethod ]

Save Object Gateway Server definition to server

• method browseSelect(name, wildcard) [ Language = javascript ]

User clicked one of the Browse buttons. Save the name of the textfield so that when you return you know which textfield to update.

• method cancelSetting() [ Language = javascript ]

User clicked Cancel. Return to list page.

• method changeType() [ Language = javascript ]

User changed Type. Show/hide client/server credentials related fields.

• method checkIsRunning() [ Language = javascript ]

Check if gateway is running.

• method formValidationHandler() [ Language = javascript ]

Validation handler for form.

• 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 ]

If it is Edit, then enable/disable fields based on Type and do not show radioSet for Type because it is not clear. Show the label. For Unix, you are here only if Ensemble is enabled and Java is the only Type available. Therefore the radio buttons for Type will be hidden.

• method saveSetting(isStart) [ Language = javascript ]

Get user input and send to server to save settings.

• method showGatewayType() [ Language = javascript ]

Hide Type radiow buttons and show type as label

• method validateRequired(ctl, pass, type) as %Boolean [ Language = javascript ]

validate the control value. pass is either "true" or "false" indicating if there is already a field failed pass validation.


[BASEXML] > [%CSP] > [UI] > [Portal] > [ObjectGateway]		Private Storage