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.

Property Inventory

Method Inventory

Parameters

parameter CSSINCLUDES;
Inherited description: 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;
Inherited description: 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 methods: NAMESPACEDisplayToLogical(), NAMESPACEGet(), NAMESPACEIsValid(), NAMESPACELogicalToDisplay(), NAMESPACELogicalToOdbc(), NAMESPACENormalize(), NAMESPACESet()
property canDeployLocalFile as %Boolean [ InitialExpression = $classmethod($classname(),"canDeployFromLocalFile") ];
Is the user permitted to deploy from their local file system.
Property methods: canDeployLocalFileDisplayToLogical(), canDeployLocalFileGet(), canDeployLocalFileIsValid(), canDeployLocalFileLogicalToDisplay(), canDeployLocalFileLogicalToXSD(), canDeployLocalFileNormalize(), canDeployLocalFileSet(), canDeployLocalFileXSDToLogical()
property canViewFileSystem as %Boolean [ InitialExpression = $system.Security.Check("%Ens_ViewFileSystem","USE") ];
Is the user permitted to access the fileSelect popup.
Property methods: canViewFileSystemDisplayToLogical(), canViewFileSystemGet(), canViewFileSystemIsValid(), canViewFileSystemLogicalToDisplay(), canViewFileSystemLogicalToXSD(), canViewFileSystemNormalize(), canViewFileSystemSet(), canViewFileSystemXSDToLogical()
property currItem as %ZEN.Datatype.integer [ InitialExpression = -1 ];
ID (index number, 0-based) of current selected item.
Property methods: currItemDisplayToLogical(), currItemGet(), currItemIsValid(), currItemLogicalToDisplay(), currItemLogicalToOdbc(), currItemNormalize(), currItemSet()
property deploymentFile as %ZEN.Datatype.string (ZENURL = "DFILE");
Name of deployment export file (on server).
Property methods: deploymentFileDisplayToLogical(), deploymentFileGet(), deploymentFileIsValid(), deploymentFileLogicalToDisplay(), deploymentFileLogicalToOdbc(), deploymentFileNormalize(), deploymentFileSet()
property deploymentName as %ZEN.Datatype.string (ZENURL = "DNAME");
Name of Deployment package being viewed.
Property methods: deploymentNameDisplayToLogical(), deploymentNameGet(), deploymentNameIsValid(), deploymentNameLogicalToDisplay(), deploymentNameLogicalToOdbc(), deploymentNameNormalize(), deploymentNameSet()
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 methods: inProgressDisplayToLogical(), inProgressGet(), inProgressIsValid(), inProgressLogicalToDisplay(), inProgressLogicalToOdbc(), inProgressNormalize(), inProgressSet()
property logFile as %ZEN.Datatype.string (ZENURL = "LOGFILE");
Name of log file (on server).
Property methods: logFileDisplayToLogical(), logFileGet(), logFileIsValid(), logFileLogicalToDisplay(), logFileLogicalToOdbc(), logFileNormalize(), logFileSet()
property msgCannotChangeTargetProduction as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Unable to change target production since production class included in deployment file.") ];
Property methods: msgCannotChangeTargetProductionDisplayToLogical(), msgCannotChangeTargetProductionGet(), msgCannotChangeTargetProductionIsValid(), msgCannotChangeTargetProductionLogicalToDisplay(), msgCannotChangeTargetProductionLogicalToOdbc(), msgCannotChangeTargetProductionNormalize(), msgCannotChangeTargetProductionSet()
property msgHelp as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Help") ];
Property methods: msgHelpDisplayToLogical(), msgHelpGet(), msgHelpIsValid(), msgHelpLogicalToDisplay(), msgHelpLogicalToOdbc(), msgHelpNormalize(), msgHelpSet()
property msgLocalFileNotAllowed as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Not allowed to deploy a file local via your browser.") ];
Property methods: msgLocalFileNotAllowedDisplayToLogical(), msgLocalFileNotAllowedGet(), msgLocalFileNotAllowedIsValid(), msgLocalFileNotAllowedLogicalToDisplay(), msgLocalFileNotAllowedLogicalToOdbc(), msgLocalFileNotAllowedNormalize(), msgLocalFileNotAllowedSet()
property msgNoDeploymentFile as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please open a deployment file first.") ];
Property methods: msgNoDeploymentFileDisplayToLogical(), msgNoDeploymentFileGet(), msgNoDeploymentFileIsValid(), msgNoDeploymentFileLogicalToDisplay(), msgNoDeploymentFileLogicalToOdbc(), msgNoDeploymentFileNormalize(), msgNoDeploymentFileSet()
property msgNoRollbackFile as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please enter a rollback file name.") ];
Property methods: msgNoRollbackFileDisplayToLogical(), msgNoRollbackFileGet(), msgNoRollbackFileIsValid(), msgNoRollbackFileLogicalToDisplay(), msgNoRollbackFileLogicalToOdbc(), msgNoRollbackFileNormalize(), msgNoRollbackFileSet()
property msgNoTargetProduction as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please enter a target production.") ];
Property methods: msgNoTargetProductionDisplayToLogical(), msgNoTargetProductionGet(), msgNoTargetProductionIsValid(), msgNoTargetProductionLogicalToDisplay(), msgNoTargetProductionLogicalToOdbc(), msgNoTargetProductionNormalize(), msgNoTargetProductionSet()
property msgOpenServer as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Click Open to select a deployment file from the Server's file system") ];
Property methods: msgOpenServerAndLocalDisplayToLogical(), msgOpenServerAndLocalGet(), msgOpenServerAndLocalIsValid(), msgOpenServerAndLocalLogicalToDisplay(), msgOpenServerAndLocalLogicalToOdbc(), msgOpenServerAndLocalNormalize(), msgOpenServerAndLocalSet(), msgOpenServerDisplayToLogical(), msgOpenServerGet(), msgOpenServerIsValid(), msgOpenServerLogicalToDisplay(), msgOpenServerLogicalToOdbc(), msgOpenServerNormalize(), msgOpenServerSet()
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 methods: msgOpenServerAndLocalDisplayToLogical(), msgOpenServerAndLocalGet(), msgOpenServerAndLocalIsValid(), msgOpenServerAndLocalLogicalToDisplay(), msgOpenServerAndLocalLogicalToOdbc(), msgOpenServerAndLocalNormalize(), msgOpenServerAndLocalSet()
property msgUnableToIdentifyTargetProduction as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Unable to identify a target production.") ];
Property methods: msgUnableToIdentifyTargetProductionDisplayToLogical(), msgUnableToIdentifyTargetProductionGet(), msgUnableToIdentifyTargetProductionIsValid(), msgUnableToIdentifyTargetProductionLogicalToDisplay(), msgUnableToIdentifyTargetProductionLogicalToOdbc(), msgUnableToIdentifyTargetProductionNormalize(), msgUnableToIdentifyTargetProductionSet()
property productionClassInExport as %ZEN.Datatype.boolean (ZENURL = "PRODINEXP");
Whether production class is in the deployment file
Property methods: productionClassInExportDisplayToLogical(), productionClassInExportGet(), productionClassInExportIsValid(), productionClassInExportLogicalToDisplay(), productionClassInExportLogicalToOdbc(), productionClassInExportLogicalToXSD(), productionClassInExportNameDisplayToLogical(), productionClassInExportNameGet(), productionClassInExportNameIsValid(), productionClassInExportNameLogicalToDisplay(), productionClassInExportNameLogicalToOdbc(), productionClassInExportNameNormalize(), productionClassInExportNameSet(), productionClassInExportNormalize(), productionClassInExportSet(), productionClassInExportXSDToLogical()
property productionClassInExportName as %ZEN.Datatype.string (ZENURL = "PRODINEXPNAME");
Whether production class in the deployment file already exists in target
Property methods: productionClassInExportNameDisplayToLogical(), productionClassInExportNameGet(), productionClassInExportNameIsValid(), productionClassInExportNameLogicalToDisplay(), productionClassInExportNameLogicalToOdbc(), productionClassInExportNameNormalize(), productionClassInExportNameSet()
property rollbackFile as %ZEN.Datatype.string (ZENURL = "BCKFILE");
Name of rollback file (on server).
Property methods: rollbackFileDisplayToLogical(), rollbackFileGet(), rollbackFileIsValid(), rollbackFileLogicalToDisplay(), rollbackFileLogicalToOdbc(), rollbackFileNormalize(), rollbackFileSet()
property rollbackProduction as %ZEN.Datatype.string (ZENURL = "TARGETPROD");
Name of last target production for rollback
Property methods: rollbackProductionDisplayToLogical(), rollbackProductionGet(), rollbackProductionIsValid(), rollbackProductionLogicalToDisplay(), rollbackProductionLogicalToOdbc(), rollbackProductionNormalize(), rollbackProductionSet()
property rollbackforDeploymentFile as %ZEN.Datatype.string;
Property methods: rollbackforDeploymentFileDisplayToLogical(), rollbackforDeploymentFileGet(), rollbackforDeploymentFileIsValid(), rollbackforDeploymentFileLogicalToDisplay(), rollbackforDeploymentFileLogicalToOdbc(), rollbackforDeploymentFileNormalize(), rollbackforDeploymentFileSet()
property targetProduction as %ZEN.Datatype.string (ZENURL = "TARGETPROD");
Name of target production for code changes
Property methods: targetProductionDisplayToLogical(), targetProductionGet(), targetProductionIsValid(), targetProductionLogicalToDisplay(), targetProductionLogicalToOdbc(), targetProductionNormalize(), targetProductionSet()
property tempPortalNode as %ZEN.Datatype.string [ InitialExpression = "ToBeInitialised" ];
Property methods: tempPortalNodeDisplayToLogical(), tempPortalNodeGet(), tempPortalNodeIsValid(), tempPortalNodeLogicalToDisplay(), tempPortalNodeLogicalToOdbc(), tempPortalNodeNormalize(), tempPortalNodeSet()
property updateTimeout as %ZEN.Datatype.integer (ZENURL = "UPDATETO") [ InitialExpression = ##class(Ens.Director).GetRunningProductionUpdateTimeout() ];
Used to show production update timeout - defaults to running production
Property methods: updateTimeoutDisplayToLogical(), updateTimeoutGet(), updateTimeoutIsValid(), updateTimeoutLogicalToDisplay(), updateTimeoutLogicalToOdbc(), updateTimeoutNormalize(), updateTimeoutSet()

Methods

method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Inherited description: Decorate the page.
method %OnGetPageName() as %String [ Language = objectscript ]
Get the (localized) name of the page.
method %OnGetTitle() as %String [ Language = objectscript ]
Get the (localized) title string for the page.
classmethod %OnSubmit(pSubmit As %ZEN.Submit) as %Status [ Language = objectscript ]
Inherited description: 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) [ Language = objectscript, ZenMethod ]
method DrawTableHeader(pSeed As %String) as %Status [ Language = objectscript ]
Draw the contents of the Header section.
method FileExists(pFilename) as %Boolean [ Language = objectscript, ZenMethod ]
method GenerateFilenames(pFilename) as %String [ Language = objectscript, ZenMethod ]
method GetDirectory(pFilename) as %String [ Language = objectscript, ZenMethod ]
method GetFilename(pFilename) as %String [ Language = objectscript, ZenMethod ]
method GetItemContents(pItemNumber, pItemName As %String = "", pItemType As %String = "") as %String [ Language = objectscript, ZenMethod ]
method GetLog() [ Language = objectscript, ZenMethod ]
method OnDrawRibbon() as %Status [ Language = objectscript ]
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 [ Language = objectscript ]
Get information to display in the ribbon bar.
method RollbackCodeAsynch() [ Language = objectscript, ZenMethod ]
classmethod UIDeployCode(pDeploymentFile, pTargetProduction, pCreateRollback, pRollbackFile, pWhereToLog, pLogFile, pAllowDeployToSource, pAutoRevert, pTempPortalNode, pUpdateTimeout) as %Status [ Language = objectscript ]
clientmethod adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
method checkIfOverwriteProd(pSourceProductionClass As %String, pTargetProduction As %String) as %Boolean [ Language = objectscript, ZenMethod ]
method checkIfTargetActive(pTargetProduction As %String) as %Boolean [ Language = objectscript, ZenMethod ]
clientmethod deployCode(pCreateRollbackFirst) [ Language = javascript ]
clientmethod disableButtons() [ Language = javascript ]
clientmethod getCSSForType(type) [ Language = javascript ]
Find the css class for the given row type.
clientmethod loadPackage(deploymentFile, targetProduction, rollbackFile, logFile) [ Language = javascript ]
Load the page for the specified Deployment.
clientmethod localFileSelectOnChange() [ Language = javascript ]
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod onloadHandler() [ Language = javascript ]
This client event is fired when the page is loaded. &&&
clientmethod openDeploymentFile() [ Language = javascript ]
Launch the file dialog to select deployment file
clientmethod openLocalDeploymentFile() [ Language = javascript ]
Launch the browser file dialog to select a local deployment file
clientmethod rollbackCode() [ Language = javascript ]
clientmethod selectItem(type, row, differences, itemdetails, itemdescription, itemname, itemtype) [ Language = javascript ]
Select an item in the table.
clientmethod selectLogFile() [ Language = javascript ]
Launch the file dialog to select log file
clientmethod selectProduction() [ Language = javascript ]
Launch the open Production dialog.
clientmethod selectRollbackFile() [ Language = javascript ]
Launch the file dialog to select rollback file
clientmethod startDeployCode(pMode) [ Language = javascript ]
clientmethod timeout(timer) [ Language = javascript ]
This function controls the timer on showing the deployment log.

Inherited Members

Inherited Properties

Inherited Methods

Feedback