This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %iKnow.UI.KnowledgePortal


class %iKnow.UI.KnowledgePortal extends

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter AUTONS = 1;
Inherited description: If true, auto-switch namespace to whatever $NAMESPACE is passed in.
parameter CSSINCLUDES = bootstrap-3-3-5/dist/css/bootstrap.min.css;
Inherited description: 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 DOMAIN = %iKnow;
Inherited description: Localization domain
parameter JSINCLUDES = jquery-2.0.3.min.js,bootstrap-3-3-5/dist/js/bootstrap.min.js;
Inherited description: Comma-separated list of additional JS include files for the page.
parameter RESOURCE = %Development;
Inherited description: This is a comma-delimited list of system Resources and associated permissions. A user must hold the specified permissions on at least one of the specified resources in order to view this page or invoke any of its server-side methods from the client.
The format of each item in the list should be as follows:
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.

Properties (Including Private)

property blacklists as %ZEN.Datatype.string (ZENURL = "blacklists");
Property methods: blacklistsDisplayToLogical(), blacklistsGet(), blacklistsIsValid(), blacklistsLogicalToDisplay(), blacklistsLogicalToOdbc(), blacklistsNormalize(), blacklistsSet()
property domain as %ZEN.Datatype.integer (ZENURL = "domain");
Property methods: domainDisplayToLogical(), domainGet(), domainIsValid(), domainLogicalToDisplay(), domainLogicalToOdbc(), domainNormalize(), domainSet()
property drill as %ZEN.Datatype.string;
Property methods: drillDisplayToLogical(), drillGet(), drillIsValid(), drillLogicalToDisplay(), drillLogicalToOdbc(), drillNormalize(), drillSet(), drillSources()
property enableAutocomplete as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Property methods: enableAutocompleteDisplayToLogical(), enableAutocompleteGet(), enableAutocompleteIsValid(), enableAutocompleteLogicalToDisplay(), enableAutocompleteLogicalToOdbc(), enableAutocompleteLogicalToXSD(), enableAutocompleteNormalize(), enableAutocompleteSet(), enableAutocompleteXSDToLogical()
property filter as %ZEN.Datatype.string (ZENURL = "filter");
Property methods: filterDisplayToLogical(), filterGet(), filterIsValid(), filterLogicalToDisplay(), filterLogicalToOdbc(), filterNormalize(), filterSet(), filtermodeDisplayToLogical(), filtermodeGet(), filtermodeIsValid(), filtermodeLogicalToDisplay(), filtermodeLogicalToOdbc(), filtermodeNormalize(), filtermodeSet()
property filtermode as %ZEN.Datatype.integer (ZENURL = "filtermode") [ InitialExpression = $$$FILTERALLANDSORT ];
Property methods: filtermodeDisplayToLogical(), filtermodeGet(), filtermodeIsValid(), filtermodeLogicalToDisplay(), filtermodeLogicalToOdbc(), filtermodeNormalize(), filtermodeSet()
property includeOtherNamespaces as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Property methods: includeOtherNamespacesDisplayToLogical(), includeOtherNamespacesGet(), includeOtherNamespacesIsValid(), includeOtherNamespacesLogicalToDisplay(), includeOtherNamespacesLogicalToOdbc(), includeOtherNamespacesLogicalToXSD(), includeOtherNamespacesNormalize(), includeOtherNamespacesSet(), includeOtherNamespacesXSDToLogical()
property languageMode as %ZEN.Datatype.string (VALUELIST = ",en,ja", ZENURL = "langmode") [ InitialExpression = "en" ];
Property methods: languageModeDisplayToLogical(), languageModeGet(), languageModeIsValid(), languageModeLogicalToDisplay(), languageModeLogicalToOdbc(), languageModeNormalize(), languageModeSet()
property pageSize as %ZEN.Datatype.integer (ZENURL = "pagesize") [ InitialExpression = 10 ];
Property methods: pageSizeDisplayToLogical(), pageSizeGet(), pageSizeIsValid(), pageSizeLogicalToDisplay(), pageSizeLogicalToOdbc(), pageSizeNormalize(), pageSizeSet()
property source as %ZEN.Datatype.integer (ZENURL = "source");
Property methods: sourceDisplayToLogical(), sourceGet(), sourceIsValid(), sourceLogicalToDisplay(), sourceLogicalToOdbc(), sourceNormalize(), sourceSet()
property summaryPct as %ZEN.Datatype.integer [ InitialExpression = 100 ];
Property methods: summaryPctDisplayToLogical(), summaryPctGet(), summaryPctIsValid(), summaryPctLogicalToDisplay(), summaryPctLogicalToOdbc(), summaryPctNormalize(), summaryPctSet()
property term as %ZEN.Datatype.string (ZENURL = "term");
Property methods: termDisplayToLogical(), termGet(), termIsValid(), termLogicalToDisplay(), termLogicalToOdbc(), termNormalize(), termSet()

Methods (Including Private)

method %OnAfterCreatePage() as %Status
Inherited description: This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
method AddFilter(pString As %String, pLocation As %String = "") as %Status [ ZenMethod ]
method DrawBlacklistsPane(pSeed As %String) as %Status
method DrawButtons(pSeed As %String) as %Status
private method DrawEntities(ByRef pEntities, pID As %String, ByRef pPanes) as %Status
method DrawFilterPane(pSeed As %String) as %Status
private method DrawPagingFooter(pID, pCount As %Integer = 0)
method DrawPaths(pSeed As %String) as %Status
method DrawRelEntities(pSeed As %String) as %Status
method DrawSettingsPane(pSeed As %String) as %Status
method DrawSimEntities(pSeed As %String) as %Status
method DrawSourceListModal(pSeed As %String) as %Status
method DrawSourceModal(pSeed As %String) as %Status
method DrawTopEntities(pSeed As %String) as %Status
method ErrorHandler(pSC As %Status) as %Status
private method GetBlacklists() as %CacheString
method GetFilter() as %iKnow.Filters.Filter
method InputTerm(pBase As %String) as %String [ ZenMethod ]
method NextPage(pID As %String, pPage As %Integer) as %Status [ ZenMethod ]
method RemoveFilter(pLocation As %String = "") as %Status [ ZenMethod ]
method ResetPages() as %Status [ ZenMethod ]
method ShowInfo() as %Boolean [ ZenMethod ]
method ToggleFilter(pLocation As %String, pLogic As %String = "", pNegation As %Boolean = -1) as %Status [ ZenMethod ]
method TogglePane(pID As %String, pPane As %Integer) as %Status [ ZenMethod ]
clientmethod applyPane(pane) [ Language = javascript ]
clientmethod closeInfo() [ Language = javascript ]
clientmethod drillSources(spec) [ Language = javascript ]
clientmethod explore(string, fromField) [ Language = javascript ]
clientmethod fixHighlighting(type) [ Language = javascript ]
clientmethod inputTermClient(text) [ Language = javascript ]
clientmethod onTermKeyUp() [ Language = javascript ]
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod openSource(srcID) [ Language = javascript ]
clientmethod refreshAll() [ Language = javascript ]
clientmethod resetFilter() [ Language = javascript ]
clientmethod setFilterLocation(location) [ Language = javascript ]
clientmethod submitFilter() [ Language = javascript ]
clientmethod summarize(pct) [ Language = javascript ]
clientmethod toggleBlacklist(id) [ Language = javascript ]
clientmethod toggleHighlighting(type) [ Language = javascript ]
clientmethod updateFilter(seed) [ Language = javascript ]

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)