Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / EnsPortal.CSVRecordWizard
Private  Storage   

EnsPortal.CSVRecordWizard


class EnsPortal.CSVRecordWizard extends
EnsPortal.Template.standardPage

Wizard to create a RecordMap definition based on a sample file which contains delimited data, possibly with a header row.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 8 13


Summary


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

Properties
%ComponentClasses %ComponentNames %Components %CompositeList
%DeletedIds %NotifyList %RenderList %UserPackageList
%condition %import %includeFiles %page
%partial %resource %xmlOutputMode HelpAddress
ISREADONLY LocatorHeader ParentURL SVGClassList
StdTitle UserSVGPackageList aboutPage align
aux backgroundTimerInterval canEdit canViewFileSystem
cellAlign cellSize cellStyle cellVAlign
children composite contactPage containerStyle
cssLevel currSortMode currStep currViewMode
designMode disabled dragAndDrop dragEnabled
dropEnabled dynamic enableAutoRefresh enclosingClass
enclosingStyle error groupClass groupStyle
height hidden hint hintClass
hintStyle home homePage id
index inlineSVG isPopup isSoftModal
keepAliveInterval label labelClass labelDisabledClass
labelPosition labelStyle lastModalIndex layout
lblTitle limitPopups msgClassExists msgErrCreating
msgNotPermitted msgReqRecTerm msgReqRecordMap msgReqSample
msgReqSeparator name nextIndex onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onoverlay onrefresh onshow
onupdate overlayMode pageModified parent
popupParent renderFlag sampleFile searchKey
showLabel slice title tuple
useSVG useSoftModals valign visible
width window zenPersistentPopup

Methods
%%OIDGet %AddCSPShareHyperevents %AddChild %AddChildAfter
%AddChildBefore %AddComponent %AddEnsExceptionHandler %AddImportedComponents
%AddLocatorLinks %AddToSaveSet %ApplyURLParms %Attr
%BindExport %BuildObjectGraph %ClassIsLatestVersion %ClassName
%Close %ConstructClone %CreateApplication %CreatePage
%DetermineCSSLevel %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%DrawAutoLogout %DrawClassDefinition %DrawClassDefinitions %DrawComponentHTML
%DrawHTML %DrawHTMLPage %DrawJSGetSettings %DrawJSSerialize
%DrawJSStrings %DrawObjectDefinitions %DrawObjectProperties %DrawSVGDef
%DrawStyleDefinitions %DrawStyleHTML %DrawStyleSVG %EnclosingDivId
%EndBackgroundMethod %EndScript %Eval %EvalC
%Extends %ForceClientRender %GenerateCode %GetAllNamespaces
%GetChildIndex %GetClassCRC %GetClassDepth %GetComponent
%GetComponentById %GetComponentByName %GetComponentPropertyById %GetDependentComponents
%GetEventHandlers %GetHomePage %GetHomeParam %GetIncludeFiles
%GetIncludeInfo %GetLinks %GetLocatorInfo %GetLocatorLinks
%GetPageName %GetPaneContents %GetParameter %GetProductName
%GetRootLink %GetSuperClassList %GetValueById %GetValueByName
%GetXMLName %IncrementCount %IsA %IsEmbedded
%IsModified %Link %LinkCSS %LinkScript
%MakeId %New %NormalizeObject %ObjectModified
%ObjectSynch %OnAddToPage %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 %ReallyAddChild %Register
%RemoveChild %RemoveChildren %RemoveComponent %RemoveFromSaveSet
%RunBackgroundMethod %Self %SerializeObject %SetBackgroundMethodStatus
%SetErrorById %SetErrorByName %SetModified %SetValueById
%SetValueByName %SetValuesByName %StartScript %ValidateObject
%XMLGenerate %ZENDeserialize %ZENVersion BuildMenu
CheckAllBlanks CheckContextLinks CheckEnterpriseManager ClassExists
ConvertParameter Decrypt DoLogout DrawLocator
DrawRibbon DrawTitle Encrypt EncryptBroker
EscapeHTML EscapeURL EvalResult GetCSPURL
GetContextLinks GetDefaultDir GetDocURL GetHomePage
GetHyperEventResources GetNewURL GetQuickLinks HyperEventBody
HyperEventCall HyperEventFrame HyperEventHead Include
InsertHiddenField InsertHiddenFields InvokeClassMethod InvokeInstanceMethod
IsPrivate Link LoadZenComponent MonitorBackgroundTask
OnDrawRibbon OnGetRibbonInfo OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page ProcessCSVFile QuoteJS
ReallyRefreshContents RegisterRecent RewriteURL SaveSampleFilename
SetDefaultDir ShowError SimpleKeepAlive StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
XMLAfterExport XMLBeforeExport XMLDTD XMLExport
XMLExportInternal XMLExportToStream XMLExportToString XMLGetSchemaImports
XMLImport XMLImportInternal XMLIsObjectEmpty XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore addPopupSuffix arrowClick
backgroundTimerHandler cancelPopup changePassword changeURLNamespace
checkEdit childrenMutated clearBackgroundTask clientKeepAlive
correctIELayering createComponent createComponentNS createRecordMap
deleteComponent disableCommandButton dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
enableCommandButton endModal exposeComponent findElement
fireOnLoadEvent fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent
firePopupAction getChildIndex getComponent getComponentById
getEnclosingDiv getHidden getHintElement getLabelElement
getOpener getPageTitle getProperty getSettings
getTargetPage getTitleAreaHeight getType goHome
goMenu gotoNamespace gotoPage hideCommandButton
inResizeLoop initPopupSuffix invokeSuper isOfType
launchPopupWindow logout makeId navigate
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRecTermChange onRefreshContents onSerialize
onServerMethodCall onServerMethodError onServerMethodReturn onStartModalHandler
ondisabledHandler onkeydownHandler onkeyupHandler onlayoutHandler
onloadHandler onlogoutHandler onoverlayHandler onresizeHandler
onunloadHandler onupdateHandler popupActionHandler progressBarHandler
refreshContents removeChild removePopupSuffix render
renderContents renderSVG searchBlur searchBoxHandler
searchFocus searchKeyDown searchKeyPress selectFile
setBackgroundTask setComponentId setConnectivityStatusMsg setHidden
setModified setOverlayMode setPageTitle setProperty
setPropertyAll setSortMode setSortModeHandler setTraceOption
setViewMode setViewModeHandler showAbout showCommandButton
showContact showDocumentation showHelp startKeepAlive
startModal startProgressBar stopKeepAlive stopProgressBar
switchNamespace testConnectivity updateControlsInGroup


Parameters


• parameter EDITRESOURCE = "%Ens_Code:WRITE,%Ens_RecordMap:WRITE";
User needs WRITE permissions on either the %Ens_Code or the %Ens_RecordMap resource to make changes on this page.
• parameter PAGENAME = "CSV Record Wizard";
Displayed name of this page.
• parameter RESOURCE = "%Ens_Code:READ,%Ens_RecordMap:READ";
User needs READ permissions on either the %Ens_Code or the %Ens_RecordMap 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 msgClassExists as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Class '%1' already exists. Overwrite?") ];
• property msgErrCreating as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Error creating RecordMap:") ];
• property msgReqRecTerm as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Record Terminator is required") ];
• property msgReqRecordMap as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("RecordMap name is required") ];
• property msgReqSample as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Sample file is required") ];
• property msgReqSeparator as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Separator is required") ];
• property sampleFile as %ZEN.Datatype.string(ZENURL="SAMPLEFILE");

Methods


• method %OnGetPageName() as %String
Get the (localized) name of the page.
• method %OnGetTitle() as %String
Get the (localized) title string for the page.
• classmethod ClassExists(classname As %String) as %Boolean [ 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.
• 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 ProcessCSVFile(pFilename As %String, pRecordMapName As %String, pSep As %String = ",", pQuoteChar As %String = """", pHasHeaderRow As %Boolean = 0, pRecTerm As %String = "\x0d\x0a", pCharEncoding As %String = "UTF-8", pKeepSQLCols As %Boolean = 1) as %String [ ZenMethod ]
• classmethod SaveSampleFilename(recordMap="", filename) as %String [ ZenMethod ]
• classmethod SetDefaultDir(pPathname As %String) [ ZenMethod ]
• method createRecordMap() [ Language = javascript ]
• method onPopupAction(popupName, action, value) [ Language = javascript ]
Returning from dialogs
• method onRecTermChange(newValue, isRadio) [ Language = javascript ]
• method selectFile() [ Language = javascript ]