Class EnsPortal.EDI.SEF.SchemaMain

class EnsPortal.EDI.SEF.SchemaMain extends EnsPortal.EDI.Template

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
2	3	28

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	Family	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	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	DoImport	DoImportInBackground	DoLogout
DoRemove	DrawContent	DrawError	DrawLocator
DrawRibbon	DrawStatus	DrawTitle	Encrypt
EscapeHTML	EscapeURL	EvalResult	GetCSPURL
GetCompletionValue	GetContextLinks	GetDefaultDir	GetDocURL
GetHomePage	GetHyperEventResources	GetImportStatus	GetJobStatus
GetNewURL	GetQuickLinks	GetRunningDuration	GetRunningFileName
GetRunningStartTime	GetRunningStatus	HyperEventCall	HyperEventHead
Include	InsertHiddenField	InsertHiddenFields	IsPrivate
JavaInstalled	Link	OnDrawRibbon	OnGetRibbonInfo
OnHTTPHeader	OnPage	OnPageError	OnPostHTTP
OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent	Page
QuoteJS	RegisterRecent	RewriteURL	SetCompletionValue
SetDefaultDir	ShowError	SimpleKeepAlive	StartTimer
StopTimer	ThrowError	UnescapeHTML	UnescapeURL
XMLDTD	XMLExport	XMLExportToStream	XMLExportToString
XMLNew	XMLSchema	XMLSchemaNamespace	XMLSchemaType
addChild	addChildAfter	addChildBefore	addPopupSuffix
arrowClick	browseSelect	btnOK	cancelPopup
changeAction	changePassword	changeURLNamespace	checkEdit
childrenMutated	clientKeepAlive	correctIELayering	createComponent
createComponentNS	createTimeWarning	deleteComponent	disableCommandButton
displayCountDown	doStatus	dragFinishHandler	dragHandler
dragNotifyHandler	dragStartHandler	dropHandler	dropStartHandler
enableCommandButton	endModal	exposeComponent	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
launchPopupWindow	logout	makeId	manualKeepAlive
navigate	onCreate	onDelete	onDisplayHandler
onEndModalHandler	onPopupAction	onRefreshContents	onSerialize
onServerMethodCall	onServerMethodError	onServerMethodReturn	onStartModalHandler
ondisabledHandler	onhandleAutoLogoutWarn	onkeydownHandler	onkeyupHandler
onlayoutHandler	onloadHandler	onlogoutHandler	onoverlayHandler
onresizeHandler	onunloadHandler	onupdateHandler	popupActionHandler
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	showTimeoutWarning	startKeepAlive
startModal	startProgressBar	stopKeepAlive	stopProgressBar
switchNamespace	timeout	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 = "View Schemas";

Displayed name of this page.

Properties

• property Family as %String(ZENURL="FAMILY");

• property Status as %String;

• property canViewFileSystem as %Boolean [ InitialExpression = $system.Security.Check("%Ens_ViewFileSystem","USE") ];

Is the user permitted to access the fileSelect popup.

Methods

• method %GetLocatorLinks(Output pLink) as %Status

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)

• method %OnAfterCreatePage() as %Status

Decorate the page.

• method %OnGetPageName() as %String

Get the (localized) name of the page.

• classmethod DoImport(pFilename As %String, pFamily As %String) as %String

Designed to run in a background job using the method DoImportInBackground which invokes %RunBackgroundMethod(). Based on a similar method in EnsPortal.ArchiveManager.

• classmethod DoImportInBackground(pFilename As %String, pFamily As %String) as %ZEN.Datatype.string [ ZenMethod ]

Run method DoImport() in a background job. Return 1 if this works out ok, an error string if there is an error in running the job (regardless of the results of the method DoImport() itself).

• method DoRemove(pCategory As %String) as %Boolean [ ZenMethod ]

• classmethod DrawContent(pSeed As %String) as %Status

Draw main HTML content for this page.

• method DrawStatus(seed As %ZEN.Datatype.string) as %Status

Draw current import status; intended for use with background import jobs.

• classmethod GetCompletionValue() as %Boolean

• 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 either "running" or "idle" or "done".

• classmethod GetJobStatus() as %String [ ZenMethod ]

Use when the import job is running in the background to check on error status. An empty string means no error; otherwise it is an error message.

• 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 GetRunningFileName() as %String

Use when the import job is running in the background to check on status.

• classmethod GetRunningStartTime() as %String

Use when the import job is running in the background to check on status.

• classmethod GetRunningStatus() as %String

Use when the import job is running in the background to check on running status. Returns either "running" or "idle" or "done".

• 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 SetCompletionValue(pValue As %Integer) as %Boolean

• classmethod SetDefaultDir(pPathname As %String) [ ZenMethod ]

• method browseSelect(name, wild) [ Language = javascript ]

User clicked one of the Browse buttons. Save the name of the textfield so that when you return you know which textfield to update.

• method btnOK() [ Language = javascript ]

• method changeAction() [ Language = javascript ]

What to do when the user selects a new actionSpec value.

• method changeURLNamespace(value) as %String [ Language = javascript ]

The input value is the name of the new namespace to switch to. This method will need to be overridden for classes such as EnsPortal.EDIDocumentView which cannot work without a URL parameter provided.

• method doStatus() [ Language = javascript ]

This timer method calls a server method to get the current background import job status and update the UI.

• 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 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 timeout(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).

Class Reference IRIS for UNIX 2024.1.2
Documentation Search