Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [EnsPortal] >  [EDIDocumentView]
Private  Storage   

class EnsPortal.EDIDocumentView extends EnsPortal.Template.standardPage

StartProduction

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 19 21


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 canViewFileSystem
categoryName cellAlign cellSize cellStyle
cellVAlign children composite contactPage
containerStyle cssLevel currSortMode currStep
currViewMode disabled displayRequested docClass
docFile docHeader docId docName
docNumber docSource docSpec docType
dragAndDrop dragEnabled dropEnabled dtChoice
dtClass dtDisplay 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 msgType
name onafterdrag onbeforedrag onclick
ondrag ondrop onhide onrefresh
onshow onupdate outFile pageModified
parent saveToFile searchKey serviceName
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 DoLogout DrawHTMLResult DrawLocator
DrawRibbon DrawTitle Encrypt EscapeHTML
EscapeURL EvalResult GetCSPURL GetContextLinks
GetDefaultDir GetDocPage GetHomePage GetHyperEventResources
GetNewURL GetQuickLinks HyperEventCall HyperEventHead
Include InsertHiddenField InsertHiddenFields IsPrivate
Link OnDrawRibbon OnGetRibbonInfo OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RegisterRecent RewriteURL SetDefaultDir SetUpForRedraw
ShowError SimpleKeepAlive StartTimer StopTimer
ThrowError UnescapeHTML UnescapeURL WriteMessage
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore addPopupSuffix
arrowClick browseSelect btnClear btnOK
cancelPopup changeDTChoice changeDocSource changeDocSpec
changePassword changeSaveToFile changeURLNamespace checkEdit
childrenMutated clientKeepAlive correctIELayering createComponent
createComponentNS deleteComponent disableCommandButton 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 inResizeLoop
initPopupSuffix invokeSuper isOfType launchPopupWindow
logout makeId navigate onCreate
onDelete onDisplayHandler onEndModalHandler onPopupAction
onRefreshContents onSerialize onServerMethodCall onServerMethodError
onServerMethodReturn onStartModalHandler ondisabledHandler onkeydownHandler
onkeyupHandler onlayoutHandler onloadHandler onlogoutHandler
onoverlayHandler onresizeHandler onunloadHandler onupdateHandler
popupActionHandler refreshContents removeChild removePopupSuffix
render renderContents renderSVG resolveDocType
searchBlur searchBoxHandler searchFocus searchKeyDown
searchKeyPress setComponentId setConnectivityStatusMsg setHidden
setModified setOverlayMode setPageTitle setProperty
setPropertyAll setSortMode setSortModeHandler setTraceOption
setViewMode setViewModeHandler showAbout showCommandButton
showContact showDocumentation showHelp startKeepAlive
startModal startProgressBar stopKeepAlive stopProgressBar
switchNamespace validateAll


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 PAGENAME = "EDI Document Viewer";
Displayed name of this page.
• parameter RESOURCE = "%Ens_MessageContent:USE";
User needs USE permissions on the %Ens_MessageContent resource to view this page.

Properties

• property canViewFileSystem as %Boolean [ InitialExpression = $system.Security.Check("%Ens_ViewFileSystem","USE") ];
Is the user permitted to access the fileSelect popup.
• property categoryName as %String;
• property displayRequested as %String(ZENURL="SHOW");
"yes" or "no" determines whether or not to display the contents of the current message of interest, in addition to the form.
• property docClass as %String(ZENURL="CLASS");
The class that represents this type of electronic document. The ZENURL parameter CLASS is used to pass this value to the page when referenced from other pages.
• property docFile as %String;
• property docHeader as %String(ZENURL="HDR");
The ID of the stored message header object for the message of interest. The ZENURL parameter HDR is used to pass this value to the page when referenced from other pages.
• property docId as %String(ZENURL="EDIDOCID");
The ID of the stored message body object for the message of interest. The ZENURL parameter EDIDOCID is used to pass this value to the page when referenced from other pages.
• property docName as %String(ZENURL="NAME");
Names the type of electronic document that we are working with: ASTM Document,HL7 Message,EDIFACT Document,X12 Document,XML Document. The ZENURL parameter NAME is used to pass this value to the page when referenced from other pages.
• property docNumber as %String;
• property docSource as %String(ZENURL="ORIGIN");
The data source for the message of interest: File,Header,Body. The ZENURL parameter ORIGIN is used to pass this value to the page when referenced from other pages.
• property docSpec as %String(ZENURL="DOCSPEC");
Identifies the message structure or document schema you want to use to analyze the message of interest: service,category,msgtype,doctype,declared,stored,none. The ZENURL parameter DOCSPEC is used to pass this value to the page when referenced from other pages.
• property docType as %String;
• property dtChoice as %String;
• property dtClass as %String;
• property dtDisplay as %String;
• property msgType as %String;
• property outFile as %String;
• property saveToFile as %String;
• property serviceName as %String;

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.
• method %OnGetTitle() as %String
Get the (localized) title string for the page.
• method DrawHTMLResult(pSeed As %String) as %Status
• classmethod GetDefaultDir() as %String [ 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 SetUpForRedraw(drw, nam, cls, src, fil, num, hdr, did, dsc, svc, cat, msg, doc, dto, dtl, dtd, sav, out) as %ZEN.Datatype.string [ ZenMethod ]
drw is "yes" or "no" - "yes" to draw the output and "no" to clear it. In either case we retain the values of all the input parameters in properties of the class.
• method WriteMessage(msg As %RegisteredObject)
• 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 btnClear() [ Language = javascript ]
• method btnOK() [ Language = javascript ]
• method changeDTChoice() [ Language = javascript ]
What to do when the user selects a new dtChoice value.
• method changeDocSource() [ Language = javascript ]
What to do when the user selects a new docSource value.
• method changeDocSpec() [ Language = javascript ]
What to do when the user selects a new docSpec value.
• method changeSaveToFile() [ Language = javascript ]
What to do when the user selects a new saveToFile 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 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 resolveDocType(pDocClass, pVer, pName, pDoc=$$$NULLOREF) as %String
• method validateAll() [ Language = javascript ]
Do validation of all fields on the form.


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