namespace sap.ui.support.RuleAnalyzer

Visiblity: public
Available since: N/A
Module: sap/ui/support/RuleAnalyzer
Application Component:

The sap.ui.support.RuleAnalyzer namespace is the central entry point for the Support Assistant functionality.

Overview

sap.ui.support.RuleAnalyzer reveals an API for the Support Assistant which you can easily work with to analyze an application.

Usage

For more information, see Support Assistant API.


Nodes Overview

Node Description

Methods Overview

Method Description
sap.ui.support.RuleAnalyzer.addRule

Adds new temporary rule when in silent mode

sap.ui.support.RuleAnalyzer.analyze

Main method to perform analysis of a given running application.

Allows to choose a particular execution scope - desired part of the UI to be checked and a flexible way to specify the list of rules to be used.

sap.ui.support.RuleAnalyzer.getAnalysisHistory

Returns the history of all executed analyses.

sap.ui.support.RuleAnalyzer.getFormattedAnalysisHistory

Returns the history of all executed analyses into formatted output depending on the passed format.

sap.ui.support.RuleAnalyzer.getLastAnalysisHistory

Returns the result of the last analysis performed.

sap.ui.support.RuleAnalyzer.addRule

Adds new temporary rule when in silent mode

Param Type DefaultValue Description
oRule object

Settings for the new rule. For detailed information about its properties see Rule Property Values

sap.ui.support.RuleAnalyzer.analyze

Main method to perform analysis of a given running application.

Allows to choose a particular execution scope - desired part of the UI to be checked and a flexible way to specify the list of rules to be used.

Param Type DefaultValue Description
oExecutionScope object

The execution scope of the analysis (see Execution Scope).

type string global

Possible values are global, subtree or components.

parentId string

ID of the root element that forms a subtree. Use when the scope type is subtree.

components string[]

List of IDs of the components to be analyzed. Use only when the scope type is components.

vPresetOrRules object string object[] All rules

This optional parameter allows for selection of subset of rules for the analysis. You can pass:

  • A rule preset object containing the preset ID and the list of rules it contains.
  • A string that refers to the ID of a system preset.
  • An object array with a plain list of rules.

oMetadata object

Metadata in custom format. Its only purpose is to be included in the analysis report.

sap.ui.support.RuleAnalyzer.getAnalysisHistory

Returns the history of all executed analyses.

Param Type DefaultValue Description

sap.ui.support.RuleAnalyzer.getFormattedAnalysisHistory

Returns the history of all executed analyses into formatted output depending on the passed format.

Param Type DefaultValue Description
sFormat sap.ui.support.HistoryFormats sap.ui.support.HistoryFormats.String

The format into which the history object will be converted. Possible values are listed in sap.ui.support.HistoryFormats.

sap.ui.support.RuleAnalyzer.getLastAnalysisHistory

Returns the result of the last analysis performed.

Param Type DefaultValue Description