Configuring the Actuate BIRT Viewer toolbar using iv_config.xml

Actuate BIRT Viewer provides a toolbar and context menus that support many of the formatting, sorting, and grouping tasks you perform on data. The toolbar and menus also support adding or deleting columns or groups, and working with fonts and text alignment. You also can print reports and export content or data. Enable or disable each of these features using the configuration file iv_config.xml. Its location is:

<context root>\WEB-INF\iv_config.xml

The iv_config.xml file contains lists of features that are enabled or disabled based on security roles as defined in Actuate iHub. The default roles included for iv_config.xml are:

All

Active Portal Intermediate

Active Portal Advanced

Active Portal Administrator

The Active Portal roles are created when iHub is installed. You can add additional iHub roles as needed. Each set of features for a role is called a feature control. Each feature control contains the user role being described, and the set of features that are marked individually as available or not available. The following section of iv_config.xml shows the default feature control for the Active Portal Advanced role:

<FeatureControl>

  <Role>Active Portal Advanced</Role>

  <Features>

    <Feature>

      <FeatureName>SaveDesign</FeatureName>

      <Availablity>false</Availablity>

    </Feature>

    <Feature>

      <FeatureName>SaveDocument</FeatureName>

      <Availablity>true</Availablity>

    </Feature>

    …

  </Features>

</FeatureControl>

All <FeatureControl> tags are placed within the <FeatureConfiguration> element. Each feature is described by the <Feature> tag, and its availability is described with the <Availability> tag. If a particular feature is available to a role, availability is set to true. If the feature is not available, it is set to false.

Exception stack trace display is also controlled in the iv_config.xml file. When an exception occurs, the viewer can display a stack trace can be displayed in the exception dialog. The trace is used for support purposes, and is set to false by default. This value is not associated with user roles and is placed outside the <FeatureControl> tag. The format of the iv_config.xml file appears as shown in the following code:

<IVConfig>

 <!-- flag to sign the report is running in iportal or BRDPro -->

<RunningMode>Iportal</RunningMode>

 <!-- customize file name generator -->

  <ExportNameConfig>
com.actuate.iv.utility.filename.DefaultFileNameGenerator
</ExportNameConfig>

 <!-- Config features -->

  <FeatureConfiguration>

    <!-- All -->

    <FeatureControl>

      …

    </FeatureControl>

    <FeatureControl>

      …

    </FeatureControl>

      …

  </FeatureConfiguration>

</IVConfig>

Table 12-1 lists the features that can be set, and how the availability tag affects them.

Table 12-1

Actuate BIRT Viewer feature set

Feature	Availability tag description
AdvancedSort	Shows or hides the Advanced Sort item in the context menu
Aggregation	Shows or hides the Aggregation item in the context menu
Analyze	Enables or disables the Analyze item in the cross tab toolbar and context menu
AutoEnableIV	Enables or disables interactivity by default
CalculatedColumn	Shows or hides the New Computed Column and Edit Computed Column items in the context menu
ChartSubType	Shows or hides the Chart Subtype item in the context menu
ChartProperty	Shows or hides the Chart Property item in the context menu
ColumnEdit	Shows or hides the Hide Column, Show Column, and Delete Column items in the context menu
CollapseExpand	Shows or hides the Hide Detail and Show Detail items in the context menu
ColumnResize	Shows or hides the Column Width item in the context menu
ConditionalFormat	Shows or hides the Conditional Formatting item in the context menu
EditReport	Shows or hides the Enable Interactivity item in the toolbar main menu
ExportData	Shows or hides the Export Data menu item in the toolbar main menu
ExportElement	Shows or hides the Export Content menu item in the context menu
ExportElementData	Shows or hides the Export Data menu item in the context menu
ExportReport	Shows or hides the Export Content menu item in the toolbar main menu
FacebookComments	Shows or hides the Facebook Comment menu item in the toolbar main menu
FlashGadgetFormat	Shows or hides the Format Flash Gadget item from the gadget context menu
FlashGadgetType	Shows or hides the Change Type from the gadget context menu
Filter	Shows or hides the Filter item in the context menu
Format	Shows or hides the Format, Change Font, and Alignment items in the context menu
GrandTotal	Enables or disables the Grand Total option in the aggregation dialog
GroupEdit	Shows or hides the Move To Group, Add Group, and Delete Group items in the context menu
HideShowItems	Shows or hides the Hide/Show Item menu item in the toolbar main menu
Highlight	Shows or hides highlighting
HoverHighlight	Shows or hides the mouse over rectangles on page elements
LinkToThisPage	Shows or hides the Link To This Page item in the main menu
MainMenu	Enables or disables the toolbar’s main menu
MoveColumn	Shows or hides the Move to Left and Move to Right items in the context menu
PageBreak	Shows or hides the Page Break item in the context menu
PageNavigation	Shows or hides the page navigation icons in the navigation bar
Parameter	Shows or hides the Parameter item in the toolbar
Print	Shows or hides the Print menu item in the toolbar main menu
Resize	Enables or disables the Resize feature
ReorderColumns	Shows or hides the Reorder Columns item in the context menu
SaveDesign	Shows or hides the Save Design menu item in the toolbar main menu
SaveDocument	Shows or hides the Save Document menu item in the toolbar main menu
ScrollControl	Shows or hides the scroll control panel in page content
ServerPrint	Shows or hides the Server Print menu item in the toolbar main menu
ShareFormat	Shows or hides the Copy Format menu item in the context menu
ShareStyle	Shows or hides the Copy Style menu item from the context menu
ShowTooltip	Shows or hides tooltips
Sort	Shows or hides the Sort Ascending and Sort Descending items in the context menu
SubTotal	Enables or disables the SubTotal option in the aggregation dialog
SuppressDuplicate	Shows or hides the Repeat Values and Do Not Repeat Values items in the context menu
SwitchView	Shows or hides the Switch View item in the context menu
Toc	Shows or hides the TOC menu item in the toolbar main menu
TextEdit	Shows or hides the edit text icon on text elements
Toolbar	Shows or hides the toolbar
ToolbarHelp	Shows or hides the toolbar Help menu item
TopBottomNFilter	Shows or hides the Top/BottomN item in the context menu

© Copyright OpenText Corp. All rights reserved. Privacy Policy | Cookie Policy

BIRT iHub 2