Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [EnsPortal] >  [Setting] >  [Report] >  [ProductionPorts]
Private  Storage   

class EnsPortal.Setting.Report.ProductionPorts extends EnsPortal.Template.listPage

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 20 72


Summary

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

Properties
%condition %import %includeFiles %page
%resource HelpAddress ISREADONLY LocatorHeader
ParentURL StdTitle aboutPage align
aux backgroundTimerInterval canEdit canEditAuxTables
canViewFileSystem cellAlign cellSize cellStyle
cellVAlign children colDelete colEdit
composite contactPage containerStyle cssLevel
currSortMode currStep currViewMode defaultExpiryLength
disabled dragAndDrop dragEnabled dropEnabled
enableAutoRefresh enclosingClass enclosingStyle error
groupClass groupStyle height hidden
hint hintClass hintStyle home
homePage id index keepAliveInterval
label labelClass labelDisabledClass labelPosition
labelStyle layout lblTitle limitPopups
msgCannotImportPortData msgEditingNotAllowed msgNotPermitted msgSelectItemToExport
name onafterdrag onbeforedrag onclick
ondrag ondrop onhide onrefresh
onshow onupdate pageModified parent
searchKey showLabel showRefresh slice
title tuple 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 DoLogout DrawInboundOutbound DrawLocator
DrawRibbon DrawTitle DrawYesNo Encrypt
EnumerateClose EnumerateExecute EnumerateFetch EscapeHTML
EscapeURL EvalResult Export FileExists
GetCSPURL GetContextLinks GetDefaultDir GetDefaultFile
GetDocURL GetHomePage GetHyperEventResources GetNewURL
GetQuickLinks HyperEventCall HyperEventHead Import
Include InsertHiddenField InsertHiddenFields IsPrivate
JavaInstalled Link OnDrawRibbon OnGetRibbonInfo
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
QuoteJS RegisterRecent RewriteURL SetDefaultDir
ShowError SimpleKeepAlive StartTimer StopTimer
ThrowError UnescapeHTML UnescapeURL XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore addConsecutive addEndRange
addEntry addHelpButton addLabelRow addPopupSuffix
arrowClick cancelPopup cancelsaveEntry changePassword
changeRefresh changeURLNamespace checkEdit checkEditAux
childrenMutated clientKeepAlive convertToCSV correctIELayering
createComponent createComponentNS createInputBox createLabel
createTable createTimeWarning csvParse currentPortspageExport
currentTable defaultForColumn deleteComponent deleteEntry
disableCommandButton displayCountDown doExport doImport
doRefresh dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler drawDataEntryForm dropHandler dropStartHandler
editEntry editingOnThisTab enableCommandButton endModal
executeTableQueryAndClearCache exposeComponent filterPortsInUseOrReserved findBoundary
findElement findIfUsedOrReserved findRange fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getChildIndex
getColumnValues getComponent getComponentById getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getPageTitle getParseAndImportData getProperty getSettings
getTitleAreaHeight getType goHome goMenu
gotoNamespace gotoPage hideCommandButton hideTimeoutWarning
hideWarnContinue importAuxData inResizeLoop indicateIfCanUseImportButton
initPopupSuffix invokeSuper isOfType launchPopupWindow
logout makeId manualKeepAlive modifyinputWithEvents
modifyinputWithvalue navigate onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onServerMethodCall onServerMethodError onServerMethodReturn
onStartModalHandler onTabChange ondisabledHandler onhandleAutoLogoutWarn
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler parseAndImportData populateRangeRequestObject popupActionHandler
portFieldonBlur refreshContents refreshTable refreshTimeout
removeChild removePopupSuffix render renderContents
renderSVG resetDataField resetFilters saveEntry
searchBlur searchBoxHandler searchFocus searchKeyDown
searchKeyPress setComponentId setConnectivityStatusMsg setEndPort
setHidden setModified setOverlayMode setPageTitle
setProperty setPropertyAll setSortMode setSortModeHandler
setTraceOption setViewMode setViewModeHandler setWarnInnerHTML
showAbout showCommandButton showContact showDataEntry
showDataEntryHelp showDocumentation showHelp showTimeoutWarning
sortPortsFromFilteredDocuments startKeepAlive startModal startProgressBar
stopKeepAlive stopProgressBar switchNamespace validDataToSave
validEndPort validNumber validPort validRangeRequest
warnclickListener


Parameters

• parameter CSSINCLUDES = "ensemble/Ensemble_Wizards.css";
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 DOCDBNAME = "IRISInteroperabilityPorts";
• parameter PAGENAME = "Port Authority Report";
Displayed name of this page.
• parameter RESOURCE = "%Ens_PortSettingsReport:READ";
This is a comma-delimited list of system Resources and associated permissions. A user must hold the specified permissions on at least one of the specified resources in order to view this page or invoke any of its server-side methods from the client.
The format of each item in the list should be as follows:
Resource[:Permission]
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.

Properties

• property canEditAuxTables as %Boolean [ InitialExpression = $classmethod($classname(),"hasAuxEditPrivileges") ];
• property colDelete as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Delete") ];
• property colEdit as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Edit") ];
• property defaultExpiryLength as %ZEN.Datatype.integer [ InitialExpression = 45 ];
• property msgCannotImportPortData as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Only Reservation and Advice data can be imported") ];
• property msgEditingNotAllowed as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Not allowed to modify auxiliary tables") ];

Methods

• 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 DrawInboundOutbound(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
• method DrawYesNo(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
• 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. Override to include buttons.
• method addConsecutive(dataEntryBody) [ Language = javascript ]
• method addEndRange(dataEntryBody) [ Language = javascript ]
• method addEntry(tableId) [ Language = javascript ]
• method addHelpButton(dataEntryBody) [ Language = javascript ]
• method addLabelRow(dataEntryBody, text) [ Language = javascript ]
• method cancelsaveEntry(tableId) [ Language = javascript ]
• method checkEditAux() [ Language = javascript ]
• method convertToCSV(objArray) [ Language = javascript ]
• method createInputBox(colObj, value) [ Language = javascript ]
• method createLabel(colObj, tableid, edit) [ Language = javascript ]
• method createTable() [ Language = javascript ]
• method csvParse(csvToParse) [ Language = javascript ]
• method currentPortspageExport() [ Language = javascript ]
• method currentTable() [ Language = javascript ]
• method defaultForColumn(colObj, locationData) [ Language = javascript ]
• method deleteEntry(tableId, rowId) [ Language = javascript ]
• method drawDataEntryForm(frmdiv, table, edit) [ Language = javascript ]
• method editEntry(tableId, rowId) [ Language = javascript ]
• method editingOnThisTab(showAlert) [ Language = javascript ]
• method executeTableQueryAndClearCache(table) [ Language = javascript ]
• method filterPortsInUseOrReserved(requestObject) [ Language = javascript ]
• method findBoundary(rangeRequestObject) [ Language = javascript ]
• method findIfUsedOrReserved(inputObject) [ Language = javascript ]
• method findRange(rangeRequestObject) [ Language = javascript ]
• method getColumnValues(pColumn As %String, pTableName As %String = "", Output pSC As %Status = $$$OK, pCacheResults As %Boolean = 0) as %Library.DynamicArray
• method getParseAndImportData() [ Language = javascript ]
• method importAuxData() [ Language = javascript ]
• method indicateIfCanUseImportButton() [ Language = javascript ]
• method modifyinputWithEvents(input, colObj, tableid, edit) [ Language = javascript ]
• method modifyinputWithvalue(input, value, colObj) [ Language = javascript ]
• method onTabChange() [ Language = javascript ]
• method onlayoutHandler(load) [ Language = javascript ]
Adjust size of table on the page, so buttons don't scroll off page
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method parseAndImportData(csvOrJSON) [ Language = javascript ]
• method populateRangeRequestObject(rangeRequested) [ Language = javascript ]
• method portFieldonBlur(field, edit) as %String [ Language = javascript ]
• method refreshTable() [ Language = javascript ]
• method resetDataField(field) [ Language = javascript ]
• method resetFilters() [ Language = javascript ]
• method saveEntry(tableId) [ Language = javascript ]
• method setEndPort(startPortID, endPortID) [ Language = javascript ]
• method showDataEntry(table, state) [ Language = javascript ]
• method showDataEntryHelp() [ Language = javascript ]
• method sortPortsFromFilteredDocuments(filteredPortsInUseOrReserved) [ Language = javascript ]
• method validDataToSave(tableId, inputObject) [ Language = javascript ]
• method validEndPort(portInput, field) [ Language = javascript ]
• method validNumber(data, type, warn) [ Language = javascript ]
• method validPort(data, warn) [ Language = javascript ]
• method validRangeRequest(data, warn) [ Language = javascript ]


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.