UsageCategory Property

Version: Available or changed with runtime version 12.0.

Sets the department column for a searched page, report, or query in the web client.

Applies to

  • Query
  • Page
  • Report

Property value

ValueAvailable or changed withDescription
Noneruntime version 12.0The page, report or query is not included in a search.
Listsruntime version 12.0The page, report or query is listed as Lists under the Pages and Tasks category.
Tasksruntime version 12.0The page, report or query is listed as Tasks under the Pages and Tasks category.
ReportsAndAnalysisruntime version 12.0The page, report or query is listed as Reports and Analysis under the Reports and Analysis category.
Documentsruntime version 12.0The page, report or query is listed as Documents under the Reports and Analysis category.
Historyruntime version 12.0The page, report or query is listed as Archive under the Reports and Analysis category.
Administrationruntime version 12.0The query is listed as Administration under the Pages and Tasks category.

Remarks

If the UsageCategory is set to None, or if you don't specify UsageCategory:

  • The page or report won't show up when you use the search functionality.
  • Users won't be able to bookmark a link to the page or report object from the user interface.

The UsageCategory is also used to categorize pages and reports shown in the role explorer of the client. The role explorer includes two actions: Reports and Analysis and Administration. Pages and reports set to ReportsAndAnalysis will show when the Reports and Analysis action is selected. Pages and reports set to Administration will show when the Administration action is selected. For more information, see Finding Pages with the Role Explorer.

Syntax

UsageCategory = ReportsAndAnalysis;

Dependent Properties

The AccessByPermission property and ApplicationArea Property are optional properties, which can be applied to set restrictions on an object accessibility, when you add the UsageCategory property.

Add pages and reports to Tell me
Properties
Page Object
Report Object