The Item ribbon tab feature enables you to add item view buttons to the Items ribbon tab and/or custom item ribbon tabs. A view button is defined using the <ItemView> tag. This article provides configuration examples of view buttons. For an explanation and examples of view button visibility options, see Visibility Options for Item View Buttons.
- Where to Find the View Name
- Config Item Views
- Configured Built-in Multi-instance Views
- Extension Views
- Standard Views
Prerequisites
Where to Find the View Name
Whenever you configure a view button, you will need to have the true name of the view. The name is obtained from the Name property on the Item views tab in Configure the explorer.
Extension view names are also listed there:
Config Item Views
This example illustrates the configuration of 2 custom ribbon groups on the Items tab. The first contains 2 config item reports for item type SI0239 and uses Ref id for both views. The second ribbon group contains 1 config item report and uses the xID of the config item. (Learn more about the difference between using Ref id and xID.)
Example Configuration
<ItemRibbonTabConfig> <ItemTabs> <ItemTab caption="Items"> <RibbonGroups> <RibbonGroup caption="Jira"> <ItemView name="Report" configItem="RBFN:JiraReportFunctionSpecification"/> <ItemView name="Report" configItem="RBFN:IssueReportFunctionSpecification"/> </RibbonGroup> <RibbonGroup caption="Process"> <ItemView name="XXXGraph" configItem="x340000000000A8B8" locked="true"/> </RibbonGroup> </RibbonGroups> </ItemTab> </ItemTabs> </ItemRibbonTabConfig>
Example Result
Configured Built-in Multi-instance Views
The below example shows a view button for a Coverage (mapping item) view in a custom ribbon group called "Mapping" on a custom tab called "Hardware".
Example Configuration
<ItemRibbonTabConfig> <ItemTabs> <ItemTab caption="Hardware"> <RibbonGroups> <RibbonGroup caption="Mapping"> <ItemView name="CoverageNoContext" configId="sip2"/> </RibbonGroup> </RibbonGroups> </ItemTab> </ItemTabs> </ItemRibbonTabConfig>
Example Result
Extension Views
The below example shows a button for a configured Safety Analysis view from the SWExtension.HazardIdentification extension added to a custom tab ("Safety/Quality Management").
The configId is found in the view's configuration:
Example Configuration
<ItemRibbonTabConfig> <Contexts> <Context caption="ISO26262" color="#33cc33"/> </Contexts> <ItemTabs> <ItemTab caption="Safety/Quality Management" context="ISO26262"> <RibbonGroups> <RibbonGroup caption="Safety Views"> <ItemView name="SWExtension.HazardIdentification.SafetyAnalysis.Views.ItemViewMappingContent" configId="1"/> </RibbonGroup> </RibbonGroups> </ItemTab> </ItemTabs> </ItemRibbonTabConfig>
Example Result
Note: Some of SystemWeaver's extension views have a hard-coded ribbon group. |
Standard Views
The below example shows shortcuts to 6 standard, built-in views in SystemWeaver added to a custom tab ("Safety/Quality Management)". These views are valid for all item types.
Standard views are indicated with "sid: B(Base Item)" in Configure the explorer:
Example Configuration
<ItemRibbonTabConfig> <Contexts> <Context caption="ISO26262" color="#33cc33"/> </Contexts> <ItemTabs> <ItemTab caption="Safety/Quality Management" context="ISO26262"> <RibbonGroups> <RibbonGroup caption="Standard"> <ItemView name="Overview"/> <ItemView name="Parts"/> <ItemView name="References"/> <ItemView name="Versions"/> <ItemView name="Libraries"/> <ItemView name="Issues"/> </RibbonGroup> </RibbonGroups> </ItemTab> </ItemTabs> </ItemRibbonTabConfig>