This article describes the basics of creating an Occurrence Matrix view in the Explorer client. The definition is written using SystemWeaver XML and the swExplorer uses XML adapted editors for viewing and editing the configuration.
- Familiarity with SystemWeaver concepts such as Items, Parts and Attributes
- Familiarity with Config Items
- Knowledge of XML
- An installation of the SystemWeaver Explorer client (swExplorer)
- Assignment of the SW Architect role in the server if you wish to save your configurations.
- The meta model for the Config Item is installed.
The Definition Sandbox
To get started, select an item of the type for which the view will be configured. Then, select Sandbox under the Occurrence Matrix menu. In the below example, a view will be created for the Design Architecture item type.
The Sandbox Mode will display and include the basic elements of a configuration to get you started.
Enter your configuration on the Definition tab.
<OccurrenceMatrixConfiguration> <ListFields shouldShow=""/> <Tree shouldShowParts="ITFD;ITAP;ITFC"/> <ColumnLists path="/ITLD/9IES/9ICF/ARSC "/> <ColumnLists sid=""/> <ItemFields fields=""/> <ListOccurrence sid="ARCW"/> <PartAttributes sids="" defaultColumnWidth=""/> <ItemAttributes sids="" defaultColumnWidth=""/> <OccurrenceColumn width="150"/> <VersionCompare/> </OccurrenceMatrixConfiguration>
Explanation of the Configuration Elements
<OccurrenceMatrixConfiguration> builds the structure of the configuration.
<ListFields shouldShow=""/> defines the list of properties to be shown for the column items. Possible values for the shouldShow attribute are "Version" and "Status" separated by ; and with no space/blank characters.
<Tree shouldShowParts=""/> defines the part types to be visible in the tree view to the left hand side of the matrix. Values for the shouldShowParts attribute should be separated by ; and with no space/blank characters.
<ColumnLists sid=""/> used with the sid attribute, defines the list of part SIDs forming the part structure to the lists to be seen as columns. Values should be separated by ; and with no space/blank characters.
<ColumnLists path=""/> used with the path attribute, offers an alternative method to specify the parts, by using a SystemWeaver path expression.
<ItemFields fields=""/> lists properties for the items in the tree. Possible values for the fields attribute are "Version" and "Status" separated by ; and with no space/blank characters.
<ListOccurrence sid=""/> defines (the single) part SID of the part that is included in the column lists.
<PartAttributes sids="" defaultColumnWidth=""/> using the sids attribute, defines part attributes to be shown for the occurrences in the matrix. These attributes are part attributes of the ListOccurrences parts. Values should be separated by ; and with no space/blank characters. The defaultColumnWidth attribute can be used to define a specific column width.
<ItemAttributes sids="" defaultColumnWidth=""/> using the attribute sids, defines the list of attribute types for the items in the tree. Values should be separated by ; and with no space/blank characters. The defaultColumnWidth attribute can be used to define a specific column width.
<OccurrenceColumn width=""/> defines if the matrix should include columns that will (only) indicate existence of occurrences in the matrix. (As opposed to columns defined by PartAttributes which will also indicate attribute values). The width attribute can be used to define a specific column width.
<VersionCompare/> makes the version appear in the occurrence columns (OccurrenceColumn) in the following format: "(3)", with option to synchronize the versions occurrences in the columns with the tree, including color coding in yellow in tree for version mismatch.
Although we do publish configuration examples on our Support Portal, you'll find the complete Reference Manuals in the application Help to be an important resource during your configuration work. They contain all of the XML elements and field codes that you will need and are full-text searchable. To access the Help, press "F1" or click the ? in the top-right corner of swExplorer.
|Tip: Finding SystemWeaver Type Identifiers (SIDs)|
As you work, you can preview your view by switching to the View tab as needed. When you are satisfied with the view, click Save XML Definition.
Enter a name for the configuration in the New Config Item dialog, and click OK.
|Tip: The New Config Item dialog also allows the selection of any of the more abstract types, but you must then make sure that the configuration actually works for that item type, and all its sub-types.|
Once saved, the view is available for all items of this item type and any sub-types. Users can access all configured views from the View drop-down. In the below example, there are three Occurrence Matrix configurations for the selected item type.
|If you navigate away from the view, before saving your XML definition, your work will be lost.|
|Note: It is not possible to create a Config Item using the New Item option on the Items ribbon as they should be created in the context of their Configured Type so that proper testing of the view can be done simultaneously.|
Adding to Ribbon Group
Once you have saved the configuration, there is an option to add the Config item as a button to a new or existing ribbon group on the Items ribbon. Enter the ribbon group in the Ribbon Group field. If it does not already exist, a new group will be created.
Creating New Config Items via an Import
If your database has the same meta model as another SystemWeaver database, Config Items can be exported from the other database so that you can import them as new Config Items into your database rather than recreating them manually.
Check out the other how-to articles found in Configuring Config Items.