Customizing functionality levels
Customize or add functionality levels by modifying or creating a level definition in functionality-level.config. A functionality level definition consists of five parts:
Level name
The level name must be a unique alphanumeric string, enclosed within <Name> and </Name> tags.
Matching security role
The name of the security role that corresponds to the functionality level. Both the security level and the functionality level must exist before the functionality level can be assigned to a user. Enclose the role name with <Role> and </Role> tags.
Available features
Table 1‑3 describes the five available features.
Table 1‑3 Features for functionality levels
Feature | Description |
Channels | Provides access to channels |
Customization | Provides access to skin customization |
Documents | Provides access to files and folders |
Jobs | Allows submitting and accessing jobs |
Mobile | Provides access to BIRT mobile viewing |
Search | Provides access to the file search facility |
Features are specified one per line and are enclosed within <FeatureID> and </FeatureID> tags. When a feature is omitted from a functionality level, the corresponding side menu or banner item is hidden to anyone assigned that functionality level. For example, the Search feature is not provided in the Basic functionality level, so the Search link does not appear for users with the Basic functionality level.
Available subfeatures
Subfeatures correspond to actions that you can perform through Actuate Information Console. Most subfeatures are associated with a feature. A subfeature cannot be included in a functionality level if its corresponding feature is not included. The subfeatures are described in
Table 1‑4.
Table 1‑4 Subfeatures for functionality levels
Subfeature | Feature | Description |
AddFile | Documents | Permits adding files when the user has the appropriate privileges |
AdvancedData | NA | Permits the modifying and synchronizing of data sets in BIRT Studio |
CreateFolder | Documents | Permits creating folders when the user has the appropriate privileges |
Dashboard
BusinessUser | NA | Permits use of dashboards |
Dashboard
Developer | NA | Permits design and administration of dashboards |
DeleteFile | Documents | Permits deleting files when the user has the appropriate privileges |
DeleteFolder | Documents | Permits deleting folders when the user has the appropriate privileges |
DownloadFile | Documents | Permits downloading files when the user has the appropriate privileges |
InteractiveViewing | NA | Permits opening Interactive Viewer |
JobPriority | Jobs | Permits setting job priority, up to the user’s maximum job priority |
SelfNotificationWithAttachment | Jobs | Activates e-mail notification for successful jobs |
ShareDashboard | NA | Permits sharing dashboards when the user has the appropriate privileges |
ShareFile | Documents | Permits sharing files when the user has the appropriate privileges |
SubscribeChannel | Channels | Permits subscribing to channels |
Subfeatures are specified one per line, enclosed within <SubfeatureID> and </SubfeatureID> tags.
The following code shows a sample functionality level entry:
<Level>
<Name>ViewAndSearch</Name>
<Role>All</Role>
<FeatureID>Jobs</FeatureID>
<FeatureID>Documents</FeatureID>
<FeatureID>Search</FeatureID>
<SubfeatureID>ShareFile</SubfeatureID>
<SubfeatureID>DeleteFile</SubfeatureID>
</Level>
The level is named ViewAndSearch and is available to all security roles. Users with ViewAndSearch functionality can run jobs, access documents, and search for files. In addition, they can share and delete their own files.