Home > Class Reference > ENSLIB namespace > EnsPortal.EDI.X12.SchemaMain


class EnsPortal.EDI.X12.SchemaMain extends EnsPortal.EDI.Template

Property Inventory

Method Inventory


parameter CSSINCLUDES = ensemble/Ensemble_Wizards.css,ensemble/Ensemble_EDI.css;
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 PAGENAME = X12 Schemas;
Displayed name of this page.


property Category as %ZEN.Datatype.string (ZENURL = "CAT");
Id of selected Category row in results table.
Property methods: CategoryDisplayToLogical(), CategoryGet(), CategoryIsValid(), CategoryLogicalToDisplay(), CategoryLogicalToOdbc(), CategoryNormalize(), CategorySet()
property Status as %String;
Property methods: StatusDisplayToLogical(), StatusGet(), StatusIsValid(), StatusLogicalToDisplay(), StatusLogicalToOdbc(), StatusNormalize(), StatusSet()
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 underway as %String;
flag for background file import underway on load
Property methods: underwayDisplayToLogical(), underwayGet(), underwayIsValid(), underwayLogicalToDisplay(), underwayLogicalToOdbc(), underwayNormalize(), underwaySet()


method %OnAfterCreatePage() as %Status
Decorate the page.
method %OnGetPageName() as %String
Get the (localized) name of the page.
classmethod CanDeleteCategory(pCat As %String) as %String [ ZenMethod ]
method DeleteCategory(pCategory As %String) as %ZEN.Datatype.string [ ZenMethod ]
classmethod DrawCompositesContent(pCat As %String) as %Status
classmethod DrawDocTypesContent(pCat As %String) as %Status
method DrawHoverTitle(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
Draw name or name with description hover text if description is available
method DrawOldStyle(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
Draw Force or nothing in place of 1 or empty
classmethod DrawSchemaList(pCat As %String, pElement As %String, pTitle As %String) as %Status
classmethod DrawSegmentsContent(pCat As %String) as %Status
method DrawStd(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
Draw Yes or nothing in place of 1 or 0
method ExportCategory(pCategory As %String, pFilename As %String) as %ZEN.Datatype.string [ ZenMethod ]
classmethod FileExists(filename As %String) as %String [ ZenMethod ]
classmethod GetDefaultDir() as %String [ ZenMethod ]
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.
classmethod GetImportStatus() as %String [ ZenMethod ]
Use when the import job is running in the background to check on running status. Returns "running", "idle", "done" or "error".
classmethod GetRunningDuration() as %String
Use when the import job is running in the background to check on status. Gets the number of seconds job has been running (or ran, if complete) and formats it nicely as a string.
classmethod Import(pFilename As %String, pUseOld As %Boolean)
Runs in a background job launched from the method DoImportInBackground()
classmethod ImportInBackground(pFilename As %String, pUseOld As %Boolean) as %ZEN.Datatype.string [ ZenMethod ]
Run method Import() in a background job. Return 1 if this works out ok, an error string if there is an error in launching the job.
classmethod KillImport() [ ZenMethod ]
classmethod KillImportStatus() [ ZenMethod ]
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.
classmethod SetDefaultDir(pPathname As %String) [ ZenMethod ]
clientmethod doDelete() [ Language = javascript ]
clientmethod doExport(filename) [ Language = javascript ]
clientmethod doExportBrowse() [ Language = javascript ]
clientmethod doImportBrowse() [ Language = javascript ]
clientmethod doImportOldBrowse() [ Language = javascript ]
clientmethod drawTabDetails(row As %String, tabName As %String) [ Language = javascript ]
clientmethod findCatRow(table, cat) [ Language = javascript ]
classmethod isOnlyOld(category) as %Boolean [ ZenMethod ]
clientmethod layoutTabGroup() [ Language = javascript ]
Handle the client-side rendering the of the right hand pane. This is primarily due to IE as it shrinks the contents div without this intervention. The function only adjusts the size of the tab group if not hidden.
clientmethod 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.
clientmethod onTabChange() [ Language = javascript ]
User clicked on a tab, or selected a new item, so we need to fetch the required content from the server.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded. Start the timer so we can check the status. If there is a background import job currently running, you will see a periodic update until the job is finished.
clientmethod progressSubmit() [ Language = javascript ]
clientmethod showHideTabs(category) [ Language = javascript ]
clientmethod showProgressDiv(title) [ Language = javascript ]
clientmethod startStatusTimer(timeout) [ Language = javascript ]
clientmethod timerStatus(timer) [ Language = javascript ]
This function controls the timer on updating progress. It is called from onload as well (in case a background import job is currently being run when the page is opened).
classmethod updateCatGlobal(category As %String = "") [ ZenMethod ]
clientmethod updateRowVals(table) [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods