Class Reference
%iKnow.UI.LoadingWizard
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [BASEXML] >  [%iKnow] >  [UI] >  [LoadingWizard]
Private  Storage

class %iKnow.UI.LoadingWizard extends %iKnow.UI.AbstractPortal

This is a sample User Interface grouping some common iKnow loading tasks typically implemented through COS scripts. In the top section, you can add, edit and delete domains and configurations, which can then be used to load data in the three tabs below:

  1. In the first tab, you can load text files from a directory into the selected domain using the selected configuration object.
  2. The second tab shows how you can easily add metadata for sources already added to the domain. First select the CSV file containing the metadata and then click the 'read file' button to be able to select which columns correspond to which field
  3. In the third tab, you can load dictionary information from a CSV file into the current domain to be used for the iKnow Smart Matching components. First select the file and then click the 'read file' button to choose the columns containing the dictionary data.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 49


Summary

This is a Zen Page class. 

Properties
%condition %import %includeFiles %page
%resource align aux backgroundTimerInterval
cellAlign cellSize cellStyle cellVAlign
children composite containerStyle cssLevel
disabled dragAndDrop dragEnabled dropEnabled
enclosingClass enclosingStyle error groupClass
groupStyle height hidden hint
hintClass hintStyle id index
label labelClass labelDisabledClass labelPosition
labelStyle layout name onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onrefresh onshow onupdate
parent showLabel slice title
tuple useSVG useSoftModals valign
visible width window zenPersistentPopup

Methods
%%OIDGet %AddChild %AddChildAfter %AddChildBefore
%AddComponent %AddImportedComponents %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 %Extends
%ForceClientRender %GetChildIndex %GetComponent %GetComponentById
%GetComponentByName %GetEventHandlers %GetLinks %GetPageName
%GetParameter %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 %OnMonitorBackgroundTask %OnMutateChildren
%OnObjectSynch %OnPreHTTP %OnSubmit %OnUseSoftModals
%OnZENDeserialize %OriginalNamespace %PackageName %QuoteValue
%QuoteValueL10N %RemoveChild %RemoveChildren %RemoveComponent
%RemoveFromSaveSet %RunBackgroundMethod %Self %SerializeObject
%SetBackgroundMethodStatus %SetErrorById %SetErrorByName %SetModified
%SetValueById %SetValueByName %SetValuesByName %StartScript
%ValidateObject %ZENVersion AddFilter BuildInfoPane
ChangeFilterMDField ChangeFilterMDOp ChangeFilterType CheckFilePath
ClearFilter ConvertParameter CreateConfig CreateDomain
Decrypt DeleteConfig DeleteDomain DrawFilter
EmptyDomain Encrypt EndSession EscapeHTML
EscapeURL ExecuteQuery GetAndEraseServerMessage GetConfig
GetConfigName GetCurrentFilterMode GetCurrentFilterObject GetCurrentFilterString
GetDomain GetInfoPaneText GetMDColumnCount GetPage
GetRootPath GetSource GetSourceObject GetTerm
GetUrlForDomain HyperEventBody HyperEventCall HyperEventFrame
HyperEventHead Include InitPages InputTerm
InsertHiddenField InsertHiddenFields IsPrivate Link
MatchAll MetadataFieldNameExists NextPage OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent OnUpdateDomain OnUpdateFilter
OnUpdateSource OnUpdateTerm Page PreviousPage
QuoteJS RemoveFilterAt ResetPages RewriteURL
RunBackgroundMethod SetBackgroundTaskEndMessage SetBackgroundTaskStartMessage SetBlacklists
ShowError StartTimer StopTimer SubmitLoadData
SubmitLoadDict SubmitLoadMeta ThrowError ToggleGroupLogic
UnescapeHTML UnescapeURL UpdateConfig UpdateDictionaryFile
UpdateDomain UpdateMetadataFile UpdateSource UpdateTerm
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore addFilterClient
cancelPopup changeFilterMDFieldClient changeFilterMDOpClient changeFilterTypeClient
checkDataType checkFieldName checkFilePathClient childrenMutated
clearFilterClient clickLocalPaths correctIELayering createComponent
createComponentNS createConfigClient createDomainClient deleteComponent
deleteConfigClient deleteDomainClient disableDictionaryForm disableMetadataForm
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler emptyDomainClient endModal
exposeComponent findElement fireOnLoadEvent fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getChildIndex
getComponent getComponentById getEnclosingDiv getHidden
getHintElement getLabelElement getOpener getProperty
getSettings getType gotoPage ignoreColumn
inputTermClient invokeSuper isOfType launchPopupWindow
makeId nextPageClient onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onServerMethodCall onServerMethodError onServerMethodReturn
onStartModalHandler onTermKeyUp onUpdateFilterClient onUpdateSourceClient
onUpdateTermClient ondisabledHandler onkeydownHandler onkeyupHandler
onlayoutHandler onloadHandler onlogoutHandler onoverlayHandler
onresizeHandler onunloadHandler onupdateHandler popupActionHandler
previousPageClient refreshContents refreshMDFilterFields removeChild
removeFilterClient render renderContents renderSVG
selectDictionaryFileClient selectMetadataFileClient setBlacklistsClient setComponentId
setCurrentGroupClient setHidden setOverlayMode setProperty
setPropertyAll setTraceOption showBlacklists showFilterForm
startModal startProgressBar stopProgressBar toggleGroupLogicClient
updateConfigClient updateDirectory updateDomainClient updateFilterClient
updateSourceClient updateTermClient useTermClient


Parameters

• parameter PAGENAME = "Sample iKnow Loading Portal";
Optional. This is the display name used for this page. If not provided, the class name is used.

Methods

• method %OnAfterCreatePage() as %Status
Initializes some of the panes and session variables used by this page, fetching domain, source and term variables from the request (if present).
• classmethod %OnFinishBackgroundTask(pTaskID As %String)
This server-side callback method is called whenever the client calls to monitor the current background task and the task is complete. Typically a subclass uses this to send back JavaScript to update the page.
• classmethod %OnMonitorBackgroundTask(pTaskID As %String, pStatus As %String, pPercentComplete As %Float)
This server-side callback method is called whenever the client calls to monitor the current background task. Typically a subclass uses this to send back JavaScript to update a progress bar.
• method CheckFilePath(filenameCol As %Integer, delimiter As %String, localPaths As %Boolean, rootPath As %String) as %String [ ZenMethod ]
• method CreateConfig(configName As %String, detectLanguage As %Boolean, languages As %String, userDictionary As %String) as %Status [ ZenMethod ]
• method CreateDomain(domainName As %String) as %Integer [ ZenMethod ]
• method DeleteConfig(configName As %String) as %Status [ ZenMethod ]
• method DeleteDomain() as %Status [ ZenMethod ]
• method EmptyDomain() as %Status [ ZenMethod ]
• method GetAndEraseServerMessage() as %String [ ZenMethod ]
• classmethod GetConfig() as %String [ ZenMethod ]
• method GetConfigName(configId) as %String [ ZenMethod ]
• method GetInfoPaneText() as %String
Returns the text to be displayed in infoPane. To be overridden by the subclass using it.
• classmethod GetMDColumnCount() as %String [ ZenMethod ]
• method GetRootPath(metadataFile As %String) as %String [ ZenMethod ]
• method MatchAll() as %Status [ ZenMethod ]
• method MetadataFieldNameExists(name As %String) as %Boolean [ ZenMethod ]
• method RunBackgroundMethod(methodName As %String, methodParams...) as %Status
• classmethod SetBackgroundTaskEndMessage(finishMessage As %String) as %Status
• classmethod SetBackgroundTaskStartMessage(busyMessage As %String) as %Status
• method SubmitLoadData() as %Status [ ZenMethod ]
• method SubmitLoadDict() as %Status [ ZenMethod ]
• method SubmitLoadMeta(pSubmit As %ZEN.Submit) as %Status [ ZenMethod ]
• method UpdateConfig(configName As %String) as %Status [ ZenMethod ]
• method UpdateDictionaryFile(dictionaryFile As %String, delimiter As %String, hasHeader As %Boolean = 1) as %Status [ ZenMethod ]
• method UpdateMetadataFile(metadataFile As %String, delimiter As %String, hasHeader As %Boolean = 1) as %Status [ ZenMethod ]
• method checkDataType(i) [ Language = javascript ]
• method checkFieldName(i) [ Language = javascript ]
• method checkFilePathClient() [ Language = javascript ]
• method clickLocalPaths() [ Language = javascript ]
• method createConfigClient() [ Language = javascript ]
• method createDomainClient() [ Language = javascript ]
• method deleteConfigClient() [ Language = javascript ]
• method deleteDomainClient() [ Language = javascript ]
• method disableDictionaryForm() [ Language = javascript ]
• method disableMetadataForm() [ Language = javascript ]
• method emptyDomainClient() [ Language = javascript ]
• method ignoreColumn(i, leaveName, force) [ Language = javascript ]
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method selectDictionaryFileClient() [ Language = javascript ]
• method selectMetadataFileClient() [ Language = javascript ]
• method updateConfigClient() [ Language = javascript ]
• method updateDirectory() [ Language = javascript ]