This article describes the different ways that you can view the XML definitions of Config Items, e.g., grids, graphs, including configuring a grid to display the XML definitions. Aside from searching and viewing one at a time, you can also configure a grid to view and even edit the definitions. The resulting grid can then be exported regularly as a means of tracking Config Item definitions. There are also other export options. This can be especially useful for Architect users. 


Prerequisites

  • Assignment of the SW Architect role in the database if you want to save the grid definition
  • An installation of the SystemWeaver Architect client (swArchitect)
  • An installation of the SystemWeaver Explorer client (swExplorer)

Viewing Config Items

Each configuration that is saved by an Architect exists as an item of a specific Config Item type in the database. Before exporting the Config Item meta data and the definitions themselves, you may want to view them. You can view them by type in the swExplorer or by Configured Type in the swArchitect. 


In swExplorer

In the swExplorer, search for and view the Config Item types by selecting Open item>Other item type. Then, check the Include Base Item checkbox in the Select Type dialog. The various Config Item types will display.


If you want to view the data itself, select the Config Item type for the definitions that you want to view, e.g., Grid definition for all grid definitions, and click OK.  You can only search for one type at a time. Your results will display on an Open Item page. Here, you can preview an item in your results, by clicking on it. A Preview pane will display to the right. In the Properties section, the Configured type will indicate which type of item in the server that the selected configuration item is defined for. In the Attributes section, you can view the XML Definition by clicking on the look-up button. Double-click on an item to open it. It is possible to include these XML definitions in a grid and export to Excel if needed, as described further down in this article.


In swArchitect

If you are working in the swArchitect client and want to view the definition items associated with a particular item type, go to the Metadata tab and select the item type in the meta data structure tree to the left. Then, click on the Config Items tab. Aside from viewing a list of the Config Items associated with the selected item, you can view each of their definitions (via the Definition attribute) as well as remove any Config Item. 



Creating a Config Items Work Area

To get started, use the swExplorer to create a structure where you can collect Config Items. In our example, we have used a "WorkArea" item type as the top item in the structure. Search for the Config Item types by selecting Open item>Other item type. Then, check the Include Base Item checkbox in the Select Type dialog. The various Config Item types will display along with their SIDs. All chart Config Items, for example, have the SID "XCHT".


Make a selection and click OK.  You can only search for one type at a time. Your results will display on an Open Item page. Select all of the Config Items that you want to include in your work area and copy them (or Ctrl+C). The below example is for the Report Config Item type. 



Next, paste your clipboard into your work area as Config Item



Repeat the above for each Config Item type that you want to include. You can combine them all under the same structure or create separate structures for each Config Item type. 


Note: In the example provided, the meta model includes a "WorkArea" item type with support for including Config Items as a part type. If your meta model does not support this, add it or use any other suitable item type for building your Config Items structure.


Example Work Area

In the below example, columns have been added to the structure tree grid to view the SID and Name of the item for which the Config Item is configured. 



Configuring a Grid

At this point, you can create a grid to view the definitions. For this, you will need to know the config item SID(s) and the SID for the XML attribute that is storing the definition. This can be found in Installing the SystemWeaver Config Items Meta Data. Below is an example grid definition to display grid (GRID) definitions stored in Attribute GRXM. 


Example for Grid Definitions

<Grid>
    <Options>
<!--Leave this out if you want the row height collapsed-->
        <CellAutoHeight/>
    </Options>
    <Columns> 
        <TextColumn caption="Configuration Type" width="200">#{ConfigType}</TextColumn>
        <ItemNameColumn width="200"/>
        <ItemAttributeColumn type="GRXM" caption="Definition" readOnly="false" width="auto"/>
    </Columns>
    <ForEachPart type="CONI">
        <DefObj>
            <Row/>
        </DefObj>
    </ForEachPart>
</Grid>


Example Result

The readOnly="false" attribute in the definition allows users to edit the config item definitions directly in the grid. 


The grid can also be exported to Excel. 



What's Next?

See Summary of XML Definition Export Options for other ways to export XML definitions.