The sap.ui.support.RuleAnalyzer
namespace is the central entry point for the Support Assistant functionality.
sap.ui.support.RuleAnalyzer
reveals an API for the Support Assistant which you can easily work with to analyze an application.
sap.ui.support.RuleAnalyzer.addRule
method allows adding a new rule.sap.ui.support.RuleAnalyzer.analyze
starts the analysis of the application.sap.ui.support.RuleAnalyzer.getAnalysisHistory
, sap.ui.support.RuleAnalyzer.getLastAnalysisHistory
or sap.ui.support.RuleAnalyzer.getFormattedAnalysisHistory
. For more information, see Support Assistant API.
Node | Description |
---|
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. |
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 |
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 |
parentId | string |
ID of the root element that forms a subtree. Use when the scope type is |
|
components | string[] |
List of IDs of the components to be analyzed. Use only when the scope type is |
|
vPresetOrRules | object string object[] | All rules |
This optional parameter allows for selection of subset of rules for the analysis. You can pass:
|
oMetadata | object |
Metadata in custom format. Its only purpose is to be included in the analysis report. |
Returns the history of all executed analyses.
Param | Type | DefaultValue | Description |
---|
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. |
Returns the result of the last analysis performed.
Param | Type | DefaultValue | Description |
---|