Skip to main content


class EnsPortal.PEXComponents extends EnsPortal.Template.viewerPage

Page for registering a PEX component

Property Inventory

Method Inventory


parameter PAGENAME = Production EXtensions;
Inherited description: Name of this page.
parameter RESOURCE = %Ens_Code:WRITE;
User needs WRITE permissions on the %Ens_Code resource to view this page.


property resultsTableId as [ InitialExpression = "resultsTable" ];
Inherited description: Id of the results tablePane
Property methods: resultsTableIdDisplayToLogical(), resultsTableIdGet(), resultsTableIdIsValid(), resultsTableIdLogicalToDisplay(), resultsTableIdLogicalToOdbc(), resultsTableIdNormalize(), resultsTableIdSet()
property searchCriteria as %ZEN.proxyObject [ InitialExpression = $$$NULLOREF ];
Search criteria from the client.
This is a proxy object whose contents are filled in from the search form by the doSearch() method. It is expected that the search query will use this information to determine what results to display.
Property methods: searchCriteriaGet(), searchCriteriaGetSwizzled(), searchCriteriaIsValid(), searchCriteriaNewObject(), searchCriteriaSet()
property tempPortalNode as %ZEN.Datatype.string;
Inherited description: This is the temp global used for cancelling search
Property methods: tempPortalNodeDisplayToLogical(), tempPortalNodeGet(), tempPortalNodeIsValid(), tempPortalNodeLogicalToDisplay(), tempPortalNodeLogicalToOdbc(), tempPortalNodeNormalize(), tempPortalNodeSet()


classmethod %OnFinishBackgroundTask(pTaskID As %String)
Inherited description: This server-side callback method is called whenever the client calls to monitor the current background task and the task is complete. Typically a subclass uses this to send back JavaScript to update 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.
method ClearTempPortalNode() [ ZenMethod ]
method DoDeleteComponent(pClassname As %String) as %String [ ZenMethod ]
classmethod DoRegisterClass(pClassname As %String, pELS As %String, pClasspaths As %String = "", pProxy As %String = "", pOverwrite As %Boolean = 0, pTempPortalNode As %String, pBounce As %Boolean = 0) as %Status
classmethod GetHyperEventResources(pMethod As %String = "") as %String
Callback to return a list of resources required for a specific HyperEvent. The user must have sufficient privileges on one of the resource/permission pairs to be permitted to execute the hyperevent. An empty string implies the user already has sufficient privileges for the ZenMethod specified in pMethod.
method GetMessage() as %String [ ZenMethod ]
method GetPEXComponent(ByRef pParms, Output pObject As %RegisteredObject) as %Status
method GetResultSet(Output pSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet
Callback that is executed to create the resultset for the main table.
method GetStatus() as %String [ ZenMethod ]
method GetTotalCount() as %Integer [ ZenMethod ]
clientmethod HTMLPopup(key) [ Language = javascript ]
Helper method to set up popup for each setting's online help
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 RegisterClassInBackground(pClassname As %String, pELS As %String, pClasspaths As %String = "", pProxy As %String = "", pOverwrite As %Boolean = 0, pBounce As %Boolean = 0) [ ZenMethod ]
This is called when the client clicks OK.
clientmethod deletePEXComponent() [ Language = javascript ]
Unregister a PEX component. This will delete the proxy class, but not the original remote class
clientmethod doRefresh() [ Language = javascript ]
clientmethod doSearch() [ Language = javascript ]
Inherited description: Invoke a search using values from the search form.
clientmethod doUpdateRegStatus() [ Language = javascript ]
clientmethod htmlToTooltip(input) [ Language = javascript ]
Helper method to interpret HTML setting descriptions for display as tooltips Taken from EnsPortal.ProductionConfig
clientmethod layoutTabGroup() [ Language = javascript ]
Handle the client-side rendering the of the right hand pane.
clientmethod newComponent() [ Language = javascript ]
Register a PEX component
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
Returning from file select and setting the value into the appropriate field.
clientmethod onSearchHandler() [ Language = javascript ]
User clicked the Search button
clientmethod onSelectItem() [ Language = javascript ]
populate detailTable for the selected row or no selected row
clientmethod onUpdate(table) [ Language = javascript ]
override resultsTable TablePane methods
clientmethod onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page. Do this differently for PEX than for other children of EnsPortal.Template.viewerPage (hence the override). In this case the details pane does not change size when the search pane is minimized.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod populateControls() [ Language = javascript ]
clientmethod renderClasspathsTable(classpaths) [ Language = javascript ]
Update the contents of the Attributes table.
clientmethod renderSettingsTable(settings) [ Language = javascript ]
Update the contents of the Attributes table.
clientmethod resetForm() [ Language = javascript ]
Reset the form programmatically
clientmethod selectRow(row, scroll, which) [ Language = javascript ]
Overrides TablePane method
clientmethod updateActions() [ Language = javascript ]
clientmethod updateComponent() [ Language = javascript ]
Register a PEX component
clientmethod updateCounts() [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab