Class EnsPortal.Deployment.DeployProductionChanges

class EnsPortal.Deployment.DeployProductionChanges extends EnsPortal.Template.standardPage

Deployment Apply Page This pages lets users import a deployment package and apply changes to a production.

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
4	25	44

Summary

This is a Zen Page class. It belongs to the application EnsPortal.Application.

Properties
%condition	%import	%includeFiles
%page	%resource	HelpAddress
ISREADONLY	LocatorHeader	NAMESPACE
ParentURL	StdTitle	aboutPage
align	aux	backgroundTimerInterval
canDeployLocalFile	canEdit	canViewFileSystem
cellAlign	cellSize	cellStyle
cellVAlign	children	composite
contactPage	containerStyle	cssLevel
currItem	currSortMode	currStep
currViewMode	deploymentFile	deploymentName
disabled	dragAndDrop	dragEnabled
dropEnabled	enableAutoRefresh	enclosingClass
enclosingStyle	error	groupClass
groupStyle	height	hidden
hint	hintClass	hintStyle
home	homePage	id
inProgress	index	keepAliveInterval
label	labelClass	labelDisabledClass
labelPosition	labelStyle	layout
lblTitle	limitPopups	logFile
msgCannotChangeTargetProduction	msgHelp	msgLocalFileNotAllowed
msgNoDeploymentFile	msgNoRollbackFile	msgNoTargetProduction
msgNotPermitted	msgOpenServer	msgOpenServerAndLocal
msgUnableToIdentifyTargetProduction	name	onafterdrag
onbeforedrag	onclick	ondrag
ondrop	onhide	onrefresh
onshow	onupdate	pageModified
parent	productionClassInExport	productionClassInExportName
rollbackFile	rollbackProduction	rollbackforDeploymentFile
searchKey	showLabel	slice
targetProduction	tempPortalNode	title
tuple	updateTimeout	useSVG
useSoftModals	valign	visible
width	window	zenPersistentPopup

Methods
%AddCSPShareHyperevents	%AddChild	%AddChildAfter	%AddChildBefore
%AddComponent	%AddEnsExceptionHandler	%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
%GetRootLink	%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	DeployCodeAsynch	DoLogout	DrawLocator
DrawRibbon	DrawTableHeader	DrawTitle	Encrypt
EscapeHTML	EscapeURL	EvalResult	FileExists
GenerateFilenames	GetCSPURL	GetContextLinks	GetDirectory
GetDocURL	GetFilename	GetHomePage	GetHyperEventResources
GetItemContents	GetLog	GetNewURL	GetQuickLinks
HyperEventCall	HyperEventHead	Include	InsertHiddenField
InsertHiddenFields	IsPrivate	JavaInstalled	Link
OnDrawRibbon	OnGetRibbonInfo	OnHTTPHeader	OnPage
OnPageError	OnPostHTTP	OnPostHyperEvent	OnPreHTTP
OnPreHyperEvent	Page	QuoteJS	RegisterRecent
RewriteURL	RollbackCodeAsynch	ShowError	SimpleKeepAlive
StartTimer	StopTimer	ThrowError	UIDeployCode
UnescapeHTML	UnescapeURL	XMLDTD	XMLExport
XMLExportToStream	XMLExportToString	XMLNew	XMLSchema
XMLSchemaNamespace	XMLSchemaType	addChild	addChildAfter
addChildBefore	addPopupSuffix	adjustSizes	arrowClick
cancelPopup	changePassword	changeURLNamespace	checkEdit
checkIfOverwriteProd	checkIfTargetActive	childrenMutated	clientKeepAlive
correctIELayering	createComponent	createComponentNS	createTimeWarning
deleteComponent	deployCode	disableButtons	disableCommandButton
displayCountDown	dragFinishHandler	dragHandler	dragNotifyHandler
dragStartHandler	dropHandler	dropStartHandler	enableCommandButton
endModal	exposeComponent	findElement	fireOnResizeEvent
fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction	getCSSForType
getChildIndex	getComponent	getComponentById	getEnclosingDiv
getHidden	getHintElement	getLabelElement	getOpener
getPageTitle	getProperty	getSettings	getTitleAreaHeight
getType	goHome	goMenu	gotoNamespace
gotoPage	hideCommandButton	hideTimeoutWarning	hideWarnContinue
inResizeLoop	initPopupSuffix	invokeSuper	isOfType
launchPopupWindow	loadPackage	localFileSelectOnChange	logout
makeId	manualKeepAlive	navigate	onCreate
onDelete	onDisplayHandler	onEndModalHandler	onPopupAction
onRefreshContents	onSerialize	onServerMethodCall	onServerMethodError
onServerMethodReturn	onStartModalHandler	ondisabledHandler	onhandleAutoLogoutWarn
onkeydownHandler	onkeyupHandler	onlayoutHandler	onloadHandler
onlogoutHandler	onoverlayHandler	onresizeHandler	onunloadHandler
onupdateHandler	openDeploymentFile	openLocalDeploymentFile	popupActionHandler
refreshContents	removeChild	removePopupSuffix	render
renderContents	renderSVG	rollbackCode	searchBlur
searchBoxHandler	searchFocus	searchKeyDown	searchKeyPress
selectItem	selectLogFile	selectProduction	selectRollbackFile
setComponentId	setConnectivityStatusMsg	setHidden	setModified
setOverlayMode	setPageTitle	setProperty	setPropertyAll
setSortMode	setSortModeHandler	setTraceOption	setViewMode
setViewModeHandler	setWarnInnerHTML	showAbout	showCommandButton
showContact	showDocumentation	showHelp	showTimeoutWarning
startDeployCode	startKeepAlive	startModal	startProgressBar
stopKeepAlive	stopProgressBar	switchNamespace	timeout
warnclickListener

Parameters

• parameter CSSINCLUDES;

Comma-separated list of additional CSS include files for the page. If this page is using CSS3 then the CSS3INCLUDES parameter is used (if defined).

• parameter JSINCLUDES = "zenCSLM.js";

Comma-separated list of additional JS include files for the page.

• parameter PAGENAME = "Deploy Production Changes";

Displayed name of this page.

• parameter RESOURCE = "%Ens_Deploy";

User needs use permissions on %Ens_Deploy to use this page.

Properties

• property NAMESPACE as %ZEN.Datatype.string(ZENURL="$NAMESPACE");

Namespace.

• property canDeployLocalFile as %Boolean [ InitialExpression = $classmethod($classname(),"canDeployFromLocalFile") ];

Is the user permitted to deploy from their local file system.

• property canViewFileSystem as %Boolean [ InitialExpression = $system.Security.Check("%Ens_ViewFileSystem","USE") ];

Is the user permitted to access the fileSelect popup.

• property currItem as %ZEN.Datatype.integer [ InitialExpression = -1 ];

ID (index number, 0-based) of current selected item.

• property deploymentFile as %ZEN.Datatype.string(ZENURL="DFILE");

Name of deployment export file (on server).

• property deploymentName as %ZEN.Datatype.string(ZENURL="DNAME");

Name of Deployment package being viewed.

• property inProgress as %ZEN.Datatype.string [ InitialExpression = 0 ];

Whether deployment started by this page is still in progress. Used to store log line for display. If 'done' then deployment finished.

• property logFile as %ZEN.Datatype.string(ZENURL="LOGFILE");

Name of log file (on server).

• property msgCannotChangeTargetProduction as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Unable to change target production since production class included in deployment file.") ];

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

• property msgLocalFileNotAllowed as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Not allowed to deploy a file local via your browser.") ];

• property msgNoDeploymentFile as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please open a deployment file first.") ];

• property msgNoRollbackFile as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please enter a rollback file name.") ];

• property msgNoTargetProduction as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please enter a target production.") ];

• property msgOpenServer as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Click Open to select a deployment file from the Server's file system") ];

• property msgOpenServerAndLocal as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Click Open to select a deployment file from the Server's file system or Open Local to select a deployment file from your file system") ];

• property msgUnableToIdentifyTargetProduction as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Unable to identify a target production.") ];

• property productionClassInExport as %ZEN.Datatype.boolean(ZENURL="PRODINEXP");

Whether production class is in the deployment file

• property productionClassInExportName as %ZEN.Datatype.string(ZENURL="PRODINEXPNAME");

Whether production class in the deployment file already exists in target

• property rollbackFile as %ZEN.Datatype.string(ZENURL="BCKFILE");

Name of rollback file (on server).

• property rollbackProduction as %ZEN.Datatype.string(ZENURL="TARGETPROD");

Name of last target production for rollback

• property rollbackforDeploymentFile as %ZEN.Datatype.string;

• property targetProduction as %ZEN.Datatype.string(ZENURL="TARGETPROD");

Name of target production for code changes

• property tempPortalNode as %ZEN.Datatype.string [ InitialExpression = "ToBeInitialised" ];

• property updateTimeout as %ZEN.Datatype.integer(ZENURL="UPDATETO") [ InitialExpression = ##class(Ens.Director).GetRunningProductionUpdateTimeout() ];

Used to show production update timeout - defaults to running production

Methods

• method %OnAfterCreatePage() as %Status

Decorate the page.

• method %OnGetPageName() as %String

Get the (localized) name of the page.

• method %OnGetTitle() as %String

Get the (localized) title string for the page.

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

This callback is called when a form on this page is submitted. pSubmit is a %ZEN.Submit object containing details of the form submit.
Subclasses override this method.

• method DeployCodeAsynch(pDeploymentFile As %String, pTargetProduction As %String, pCreateRollback As %Boolean, pRollbackFile As %String, pLogFile As %String, pUpdateTimeout As %Integer) [ ZenMethod ]

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

Draw the contents of the Header section.

• method FileExists(pFilename) as %Boolean [ ZenMethod ]

• method GenerateFilenames(pFilename) as %String [ ZenMethod ]

• method GetDirectory(pFilename) as %String [ ZenMethod ]

• method GetFilename(pFilename) as %String [ ZenMethod ]

• method GetItemContents(pItemNumber, pItemName As %String = "", pItemType As %String = "") as %String [ ZenMethod ]

• method GetLog() [ ZenMethod ]

• method OnDrawRibbon() as %Status

Add to the contents of the tool ribbon.

• 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 RollbackCodeAsynch() [ ZenMethod ]

• classmethod UIDeployCode(pDeploymentFile, pTargetProduction, pCreateRollback, pRollbackFile, pWhereToLog, pLogFile, pAllowDeployToSource, pAutoRevert, pTempPortalNode, pUpdateTimeout) as %Status

• method adjustSizes() [ Language = javascript ]

Adjust sizes of components on the page.

• method checkIfOverwriteProd(pSourceProductionClass As %String, pTargetProduction As %String) as %Boolean [ ZenMethod ]

• method checkIfTargetActive(pTargetProduction As %String) as %Boolean [ ZenMethod ]

• method deployCode(pCreateRollbackFirst) [ Language = javascript ]

• method disableButtons() [ Language = javascript ]

• method getCSSForType(type) [ Language = javascript ]

Find the css class for the given row type.

• method loadPackage(deploymentFile, targetProduction, rollbackFile, logFile) [ Language = javascript ]

Load the page for the specified Deployment.

• method localFileSelectOnChange() [ Language = javascript ]

• 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 onlayoutHandler(load) [ Language = javascript ]

Adjust sizes of components on the page.

• method onloadHandler() [ Language = javascript ]

This client event is fired when the page is loaded. &&&

• method openDeploymentFile() [ Language = javascript ]

Launch the file dialog to select deployment file

• method openLocalDeploymentFile() [ Language = javascript ]

Launch the browser file dialog to select a local deployment file

• method rollbackCode() [ Language = javascript ]

• method selectItem(type, row, differences, itemdetails, itemdescription, itemname, itemtype) [ Language = javascript ]

Select an item in the table.

• method selectLogFile() [ Language = javascript ]

Launch the file dialog to select log file

• method selectProduction() [ Language = javascript ]

Launch the open Production dialog.

• method selectRollbackFile() [ Language = javascript ]

Launch the file dialog to select rollback file

• method startDeployCode(pMode) [ Language = javascript ]

• method timeout(timer) [ Language = javascript ]

This function controls the timer on showing the deployment log.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search