Class Reference
IRIS for UNIX 2024.1.2
 InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [EnsPortal] >  [EDI] >  [X12] >  [SchemaMain]
Private  Storage   

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 5 43


Summary

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

Properties
%condition %import %includeFiles %page
%resource Category HelpAddress ISREADONLY
LocatorHeader ParentURL Status StdTitle
aboutPage align aux backgroundTimerInterval
canEdit canViewFileSystem cellAlign cellSize
cellStyle cellVAlign children composite
contactPage containerStyle cssLevel currSortMode
currStep currViewMode 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 msgNotPermitted name
onafterdrag onbeforedrag onclick ondrag
ondrop onhide onrefresh onshow
onupdate pageModified parent searchKey
showLabel slice tipRefresh title
tuple underway 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
CanDeleteCategory CheckAllBlanks CheckContextLinks CheckEnterpriseManager
ConvertParameter Decrypt DeleteCategory DoLogout
DrawCompositesContent DrawDocTypesContent DrawError DrawHoverTitle
DrawLocator DrawOldStyle DrawRibbon DrawSchemaList
DrawSegmentsContent DrawStd DrawTitle Encrypt
EscapeHTML EscapeURL EvalResult ExportCategory
FileExists GetCSPURL GetContextLinks GetDefaultDir
GetDocURL GetHomePage GetHyperEventResources GetImportStatus
GetNewURL GetQuickLinks GetRunningDuration HyperEventCall
HyperEventHead Import ImportInBackground Include
InsertHiddenField InsertHiddenFields IsPrivate JavaInstalled
KillImport KillImportStatus 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 addPopupSuffix
arrowClick cancelPopup changePassword changeURLNamespace
checkEdit childrenMutated clientKeepAlive correctIELayering
createComponent createComponentNS createTimeWarning deleteComponent
disableCommandButton displayCountDown doDelete doExport
doExportBrowse doImportBrowse doImportOldBrowse dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler drawTabDetails
dropHandler dropStartHandler enableCommandButton endModal
exposeComponent findCatRow findElement fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getChildIndex
getComponent getComponentById getEnclosingDiv getHidden
getHintElement getLabelElement getOpener getPageTitle
getProperty getSettings getTitleAreaHeight getType
goHome goMenu gotoNamespace gotoPage
hideCommandButton hideTimeoutWarning hideWarnContinue inResizeLoop
initPopupSuffix invokeSuper isOfType isOnlyOld
launchPopupWindow layoutTabGroup logout makeId
manualKeepAlive navigate onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onServerMethodCall onServerMethodError onServerMethodReturn
onStartModalHandler onTabChange ondisabledHandler onhandleAutoLogoutWarn
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler popupActionHandler progressSubmit refreshContents
removeChild removePopupSuffix render renderContents
renderSVG searchBlur searchBoxHandler searchFocus
searchKeyDown searchKeyPress setComponentId setConnectivityStatusMsg
setHidden setModified setOverlayMode setPageTitle
setProperty setPropertyAll setSortMode setSortModeHandler
setTraceOption setViewMode setViewModeHandler setWarnInnerHTML
showAbout showCommandButton showContact showDocumentation
showHelp showHideTabs showProgressDiv showTimeoutWarning
startKeepAlive startModal startProgressBar startStatusTimer
stopKeepAlive stopProgressBar switchNamespace timerStatus
updateCatGlobal updateRowVals warnclickListener


Parameters

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

Properties

• property Category as %ZEN.Datatype.string(ZENURL="CAT");
Id of selected Category row in results table.
• property Status as %String;
• property canViewFileSystem as %Boolean [ InitialExpression = $system.Security.Check("%Ens_ViewFileSystem","USE") ];
Is the user permitted to access the fileSelect popup.
• property tipRefresh as %String [ InitialExpression = $$$TextHTML("Refresh status") ];
• property underway as %String;
flag for background file import underway on load

Methods

• 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 whether we will be using 'Legacy' schemas
• 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 ]
• method doDelete() [ Language = javascript ]
• method doExport(filename) [ Language = javascript ]
• method doExportBrowse() [ Language = javascript ]
• method doImportBrowse() [ Language = javascript ]
• method doImportOldBrowse() [ Language = javascript ]
• method drawTabDetails(row As %String, tabName As %String) [ Language = javascript ]
• method findCatRow(table, cat) [ Language = javascript ]
• classmethod isOnlyOld(category) as %Boolean [ ZenMethod ]
• method layoutTabGroup() [ Language = javascript ]
Handle the client-side rendering the of the right hand pane.
• method 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.
• method onTabChange() [ Language = javascript ]
User clicked on a tab, or selected a new item, so we need to fetch the required content from the server.
• method 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.
• method progressSubmit() [ Language = javascript ]
• method showHideTabs(category) [ Language = javascript ]
• method showProgressDiv(title) [ Language = javascript ]
• method startStatusTimer(timeout) [ Language = javascript ]
• method timerStatus(timer, refresh) [ 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 ]
• method updateRowVals(table) [ Language = javascript ]

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