This article describes the basics of creating the following types of Config Item views in the Explorer client.
- Configurable charts
- Configurable graph
- Configurable grids
- Configurable reports
- Configurable XML
All definitions are written using SystemWeaver XML and the swExplorer uses XML adapted editors for viewing and editing the configuration. The SystemWeaver Script Language is basically declarative, i.e., it tells what should be done, rather than how, for the input that is given. So, the output is controlled by both the input objects – item and part structures – and the config item configuration. A configuration, e.g., for a report, chart, etc., starts operating on the specific item that the report script is invoked for, and can then start operating on that item’s part structure. However, at any given moment, a report element operates on a specific object. The following topics will be covered in this article:
- A Note on Documentation
- The Definition Sandbox
- Adding to Ribbon Group
- Adding a Tooltip
- Adding a Description
- References in Item Ribbon Tab Configuration
- Creating New Config Items via an Import
- What's Next?
|Tip: If you already have an existing Config Item view that you prefer to copy to create a new Config Item view, you can do this as well.|
- 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.
A Note on Documentation
The creation of a good script can take many hours, and you should always document your configuration so that others (and yourself) can maintain it. As always, what should be documented is not what is evident in the scripts, but what is not: The purpose and principles behind it – why something is done, rather than how. (The ”how” is always evident from the script.). It can be a good idea to include a header where all changes are collected: who, what, when.
The Definition Sandbox
To get started, select an item of the type for which the view will be configured. Then, select Sandbox for the type of Config Item view that you want to create, e.g., Chart, Graph, Grid, Report, etc. In the below example, a Chart will be created for the Function requirements item type.
The Sandbox Mode will display which is where you enter a script to define a view. By default, the sandbox may include the basic elements of a configuration to get you started.
Enter your configuration on the Definition tab.
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: Remember, you can find the SID values for a part by either adding the Part SID column to your structure tree (Using the Structure Tree Grid) or by selecting the part, loading the Parts view and adding the SID column to the view. See Finding SystemWeaver Type Identifiers (SIDs) for more information.|
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.
The view is now available for all items of this item type. Users can access all configured views from the View drop-down. In the below example, there are two Charts configured for the selected item type.
|If you navigate away from the View, e.g., Charts, 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.
Adding a Tooltip
A tooltip is optional, and displays when a user hovers over the config item button on the ribbon. Enter the tooltip text in the Tooltip field.
Note: You may need to log out and back in to the client to view new or updated tooltip text.
Adding a Description
The Description of a Config item is optional, and is intended for the development of the Config item, and can be used to include information vital for the maintenance of the configuration, the revision history, etc. Navigate to the Description tab to enter information. Double-clicking in Description will open the full editor.
References in Item Ribbon Tab Configuration
If you plan to include a Config Item view in the Item Ribbon Tab configuration, you have the option of having the button reference a specific version of the Config Item or always reference the latest version. Referencing the latest version requires the use of a static Ref Id which is set on the Description tab.
To learn more about this option, see Referencing Latest vs Specific Version of Config Item.
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.
Find out more about Configuring Config Items.