| CMDB Analyzer for SDE User Guide | |||||||||||||||||||||||||||||||||||||||||||||||||||
|
This user guide describes CMDB Analyzer for SDE version 5.0 and later. Installing CMDB Analyzer For SDE Run the CMDB Analyzer for SDE installer and follow the instruction of the installer. CMDB Analyzer for SDE is written in 100% Java. The memory requirement depends on the size of SDE data you are viewing. The application's maximum heap size is set to 512M.To change the application's maximum heap size,
edit file sdeAnz.l4j.ini. Supported BMC Service Desk Express (SDE) Version CMDB Analyzer for SDE supports Service Desk Express 9.2, 9.6 and up with Microsoft SQL Database or Oracle Database. It also supports BMC Alignability for SDE (APM). More Information If you need more information, please contact support@bluelineG.com, or go to BlueLine Graphics, Inc. web site www.bluelineG.com.
Getting to Know CMDB Analyzer For SDE The following diagram describes function areas in CMDB Analyzer for SDE main window:
A workspace is a directory that contains configurations for projects and views. Only one workspace is activated at a time but you can switch between workspaces. You can switch workspaces at any time. If there are unsaved views, you will be prompted to save them. To switch a workspace, click the "Switch Workspace" tool button in the project panel toolbar.
To create a new workspace, click the "Switch Workspace" tool button and enter a directory path. If the specified workspace directory doesn't exist, once the "OK" button is pressed, a new directory with the workspace name will be created. NOTE: It is highly recommended that you create your workspace outside of the CMDB Analyzer installation directory.
A project is a folder in the file system that contains SDE data views. When you create a new project, depending on project type, the following views may be created as default:
You can create either a server project or an off-line project. Project Panel organizes projects and views in a tree structure for the current workspace. The followings are the basic mouse operations available in the Project Panel:
To create a server project you need to have a SDE database administrator account. Steps to create a server project:
NOTE: You have to go to MS SQL configuration manager console to enable TCP/IP protocol which is disabled by default. Also set a static port number if dynamic port is used (SQL Server 2005). You need to restart SQL for this to take effect. Save Password If you uncheck "Save Password" option, the password will not be saved - you have to enter the password every time you open the project. Off-line project connects to a CSV data store in your local file system instead to a SDE database. A CSV data store is a directory that contains database files in CSV format. You can generate a CSV data store from a server project by selecting "Export Database..." option in the project popup menu. The data store directory is what you need to specify in the off-line project creation wizard. Steps to create an off-line project:
Tip: To change project settings after project has been created, right-mouse click on a project in Project Panel and then select "Preference...". To delete a project, right-mouse click on the project tree node and select “Delete”. If you have any unsaved views, you will be given options to save the views or cancel the delete operation. To close a project, right-mouse click on the project tree node and
select "Close". If you have any unsaved views, you will be given options
to save the views or cancel the operation.
Closing a project removes all views and cleans data store from the project
and releases resources it holds. Project preference panel is accessed via right-mouse click on a project tree node and then click "Preference...". From the preference panel, you can change the project connectivity settings, such as the SDE database server name, port, user name, password, etc., and configure data refresh settings for server projects. Refreshing is only available for server projects. For off-line projects, you can simply close/open the project to load new data. For one-time only refresh, right-mouse click on a project tree node and then select "Refresh"; for scheduled auto refresh, open the Project Preference Panel and choose the refresh frequency.
NOTE: Frequencies in seconds should be only used in your testing environment as it might impact the performance of the SDE database.
Understanding Project Hierarchy CMDB Analyzer organizes views under projects and projects under workspace. This workspace-project-view structure is represented in the project panel as well as in your computer's file system. When you create a workspace, CMDB Analyzer creates a directory with the name of the workspace. Each project and view also has its own folder. The following pictures show the representations of workspace-project-view in the file system and in the project panel:
CMDB Analyzer retrieves SDE data directly from SDE database. As long as a SDE database is running, you can create project to connect to it. You can create any number of projects to connect to different SDE database or create multiple projects connecting to a single SDE database. You can simply load a backup SDE database and create a server project for it. CMDB Analyzer only retrieves SDE data in a project when you first time open a view (any view) or refresh the project (either manually or automatically). This is to ensure that CMDB Analyzer has minimum impact on the performance of your SDE database. What data to retrieve from database is controlled by the "query.xml", which can be found in your project directory. See Customizing Database Query for more information about how to modify this file. CMDB Analyzer also performs some data validation tasks when retrieving data from SDE database. The following is a list of validation tasks:
CI Category View is listed under "CI Views" and is one of the default views when a new project is created. It shows all CI categories and provides a summary of CI in each Category. Since BMC Alignability for SDE has a hierarchical CI Category structure, you have extra options to switch between the hierarchical view and the flat view. Click on one category item, all CIs belonging to that category get listed in the CI detail table, where you can then right-mouse click to open one of the CI Views to view this CI.
CMDB Analyzer defines two additional Categories for internal use:
These two internal defined Categories are also listed as filterable categories in the graph filter panel. See Applying Graph Filter for how to use graph filters.
CI Type View is listed under "CI Views" and is one of the default views when a new project is created. It shows all CI types and provides a summary of CI in each Type. Click on one type item, all CIs belonging to that type get listed in the CI detail table, where you can then right-mouse click to open one of the CI Views to view this CI.
CMDB Analyzer defines two additional Types for internal use:
At the data loading time, if CMDB Analyzer detects a CI with undefined or invalid type, a warning dialog will pop up. You have options to exit the application, ignore this warning only or ignore all similar warnings. These two internal types are also listed as filterable types in the graph filter panel. See Applying Graph Filter for how to use graph filters.
Double-click on “Main View” opens a graph that displays CI and their relationships. If you have defined Service in SDE, you will also see services hierarchy and Service to CI relationships in the same integrated graph. By default, CMDB Analyzer for SDE loads all active CIs, Services and relationships. If you want to limit the number of CI to load, you can modify the queries for selecting CI, Service or Relationships. See Customizing Database Query for more details.
CI Graph View is your main working view. CI Flat View and CI Tabular View are companions of CI Graph View. "Main View" is a default view and can't be renamed or deleted. However, you can always create your views by duplicating an existing view or by creating a sub-graph. Duplicating a CI View creates an exact copy of the view. To create a duplication:
Each CI View is created as a directory in the file system. The name of the CI View is used as the directory name. The creation of a new CI View could fail if
Except "Main View", you can rename CI Views via "Rename..." menu item in the CI View popup menu. This operation could fail for the same reason as creating a new CI View. Except "Main View", you can delete CI Views via "Delete" menu item in the CI View popup menu.
CI Graph View basic mouse operations
CI Graph View toolbar The following is the fully expanded toolbar seen in Graph View: ![]() Toolbar action table
Graph Filter allows you to display only the CIs, Services and Relationships that you want to see to reduce the complexity of the graph. You can use the Graph Filter window to change the filter settings. You can filter the graph by Relationships, CI Categories and CI Types.
If the "Instance Graph Update" option is checked, the graph is updated instantly when a filter item is selected or deselected. Otherwise, you have to click the "Apply" button to force the graph to update. If you don't want to display CIs and Services that have no relationships in the view, uncheck the option "Show dangling CI".
You have options to layout the graph in these three ways:
Top-to-bottom and left-to-right trees are good choices for simple graph. Radial tree is more suitable when there is a large number of nodes and complex relationships. You might need to try all three layouts in order to pick the best layout option.
You can use Graphics Properties window to change graphics attributes of CI nodes including graph background and grid fill color. Once the CI View is saved, these graphics properties are saved too.
When a CI or Service node is selected, its attributes are displayed in the CI Detail Panel "Attribute" tab. There are three different CI attribute panes:
You can change the content of Custom Attribute by editing database query, see Customizing Database Query. To hide the CI Detail Panel: One of the following actions hides the CI Detail Panel:
To show the CI Detail Panel: One of the following actions shows the CI Detail Panel:
To float the CI Detail Panel:
To dock the CI Detail Panel:
The graphics attributes for relationships, such as the line color and the line width, can be modified by editing an xml file "relationshipTypes.xml" in the project folder. The following is a sample entry that defines the "Physical" relationship type: <type id="Physical" desc="Physical Relationship"> The "desc" field defines the mouse hover tooltip for the relationship type. The supplied relationshipTypes.xml supports default SDE relationship types. If you have user defined relationship types, you need to add new entries into the file. The "id" field must match the relationship type name. There is a master copy of "relationshipTypes.xml" in the "system/bridges/com.blg.bmc.sde/config" folder. When a new project is created, the master file is copied to the project folder. If you modified the master file, new projects will inherit the modified version.
When a CI View is created, the CI node tooltip is configured to show only the CI Type and Category information. You can customize CI tooltips by following these steps:
When a new project is created, CI icons and an icon configuration file are copied from system director "system\bridges\com.blg.bmc.sde\config" to the project directory. If you want project specific CI icons, follow these steps:
You can also create views that show only a subset of CI instances and relationships. It is called a sub-graph. You can create a sub-graph by following these steps:
The creation of a new Sub-graph View could fail if
A sub-graph type defines the directions that your sub-graph is going to traverse. The picture below shows the difference in these three sub-graph types.
Tight Sub-graph A sub-graph can be "loose" or "tight". "Loose" means there are branches in the sub-graph that travels in the opposite direction. For example, an outbound sub-graph (going downstream) has some upstream branches because some nodes have multiple parent nodes. "Tight" sub-graph, on the other hand, can not have these extra branches. For example, a tight inbound sub-graph (going upstream) should not have more than one outbound (downstream) path. The picture below explains the difference between a "loose" sub-graph and a "tight" sub-graph.
Click "Relationship View" tool button to display the view that only shows the immediate upstream and downstream relationships of the selected CI node.
The middle node is the current selected node. The left side nodes are the upstream (parents) nodes and the right side nodes are the downstream (children) nodes. Click the arrow buttons at left or right side to drill up or drill down.
Incident, Change or Problem information can be superposed on top of a Graph View or Flat View. To superpose the Incident information, follow these steps:
The Color Bar Editor allows you to define the number of colors you use (Color Steps), what colors you use (Start Color and End Color) and the mapping between incident count and the color (Incidents per Step).
Follow similar steps to superpose the Change or Problem information. Tip: To display the count number on top of the graph in radial layout (there could be many overlapped nodes), close and then open the Incident Color Bar again so that the incident numbers can be redrawn on top of the graph. Impact Path is a very useful tool to perform impact analysis.Steps to show an impact path:
To remove all impact path, open view popup menu and select "Clear All Impact Path". Cross
referencing allows users to quickly jump from one view to anothe
If a CI has associated Incidents, then you can map incident priority to CI status ("Critical", "Warning" and "OK") which will be propagated all the way to the root node. If you connect to a APM database, then the Incident Impact value is used instead of Incident Priority value.
To enable the displaying of Incident priority,
NOTE: "Graph View Preferences" is only available on "Main View" and is a global setting that affects all CI Views, CI Explorers, SLA Views and Service Maps in the project. You can set CI status manually by right-mouse click on the CI and select either "OK", "Warning" or "Critical" status. Manual status propagates to the top node in the Graph View. The manual status setting also affects Service Maps as well as SLA Views. If you have "Show Incident Priority" turn on, the CI status mapped from Incident are overridden by manual status. NOTE: Manual status setting also has global affect on all CI Views, CI Explorers, SLA Views and Service Maps in the project. SmartZoom allows you to spread out otherwise crowded graph nodes and relationship lines in the graph instead of just changing the size of the graph nodes. You can use the mouse wheel or the zoom buttons in the toolbar to perform smart zoom. SmartZoom is only available in the radial layout.
![]()
You can use Object Magnifier to view parts of the graph in great detail, or use it as an overview window to have a bird view of the whole graph. The CIs and relationships in the Object Magnifier window are alive - you can perform any mouse or keyboard actions as if you are working in the main view window.
Zoom out and turn magnifier into an overviewer:
Basic Object Magnifier Mouse Operations :
Click "Snapshot" button on the CI View toolbar to take a snapshot of the view and copy it to the clipboard. The snapshot image only covers the visible view area. Tip: Use "Export Image" option to export the whole graph to an image file. To export the whole graph to an image file, click "Export" on the CI Graph View toolbar and select "Export Image...". You can either export to a gif file or to a TIF file. The following table shows the difference between these two image file formats:
Open the "Search CI" window to search for a CI or service. Search is done using full text search by the CI key attributes including CI label, CI type, CI category, asset tag, serial number, etc. Click "Print" on the CI View toolbar to pop up the print preview window.
Options in the print preview window:
Click the "Flat View" tab to view all CI nodes including Service node in a flat format without overlapping.
CI Tabular View lists CIs in a tabular format in a CI View. To open a CI Tabular View, simply click the "Tabular View" tool button in the CI View toolbar. CI Tabular View lists only the visible CI nodes in the CI View, not all the CIs loaded in the application. If you have applied graph filter, you will not see CIs filtered out by the graph filter. CI Tabular View doesn't display Services.
The table columns in the CI Tabular View can be customized. Follow these steps to customize table columns:
NOTE: CI Tabular View always displays these columns: Icon, CI Type, Description and Category. The customized columns will appear in other CI related tables, such as in the CI Type View and in the CI Category View. The selectable CI attribute fields in the "Configure Table Column" window are defined in the project "query.xml" file. You can modify the query to add your customized CI attribute fields. See Customizing Database Query for details. You can export the CI table to a CSV file by clicking the "Export As CSV File" tool button.
CI Explorer is very similar to CI View. The only difference is the Graph View in the CI Explorer has the ability to expand/collapse graph on the fly. You create CI Explorer from CI Graph View just like to create a sub-graph view by right-mouse click on a CI node or Service node and select "Show In CI Explorer" and then "New CI Explorer...". You can rename and delete CI Explorers in the same way as to rename and delete a CI View. Sticky nodes (with a distinguish yellow color background) are special nodes that are always visible in the CI Explorer. Your exploration starts from sticky nodes by expanding upstream and downstream. When you collapse its upstream connections (parents), a sticky node becomes one of the root node in the graph. Non-sticky nodes are only visible through the expanding of sticky nodes. Sticky nodes can be added from other CI graph views by opening node popup menu, selecting "Show In CI Explorer" and then selecting a CI explorer (or creating a new CI Explorer). You can also set or remove stick nodes through the node popup menu. The CI Explorer only saves the sticky nodes not the entire graph. CI Explorer gives you the control of expand/collapse a CI graph. You start with one sticky node and you walk through the graph by expanding specific levels either upstream (parents) or downstream (children). Or you can work on one level at a time by click the expand/collapse symbols on CI nodes. You have the following navigation options in the node popup menu:
CI Assembly View displays CI assembly hierarchy information and has similar user interface as CI View.
Incident related views are grouped under Incident Views. Incident Summary View lists all incidents in a tabular format. Cross referencing to CI View and Category View are available through right-mouse click on an incident row.
Customize Summary View Table Columns The table columns in the Incident Summary View can be customized. Follow these steps to customize table columns:
The customized columns will appear in other Incident related tables, such as in Incident Category View and in the Incident tab of CI View Detail Panel. The selectable Incident attribute fields in the Config Incident Attribute window are defined in the project query.xml file. You can modify the query to add your customized Incident attribute fields. See Customizing Database Query for details. Incident category view organizes incidents in categories. "Total Incident #" is the incident count of the specified category including all incidents of its descendents. Click the "Flat View" button in the toolbar to flat the table, so that sorting of columns is enabled.
Incident Group View groups incidents in Clients, Category and Staff&Group. If you choose "Show Open Incident Age", the group box displays the aging information of current open incidents.
If you choose "Show Incident Status", the group box displays the open incident count and closed incident count.
Change related views are grouped under Change Views. Change Summary View lists all changes in a tabular format. Cross referencing to Category View is available through right-mouse click on a change.
Customize Summary View Table Columns The table columns in the Change Summary View can be customized. Follow these steps to customize table columns:
The customized columns will appear in other Change related tables, such as in Change Category View and in the Change tab of CI View Detail Panel. The selectable Change attribute fields in the Config Change Attribute window are defined in the project query.xml file. You can modify the query to add your customized Change attribute fields. See Customizing Database Query for details. Change category view organizes changes in categories. "Total Change #" is the change count of the specified category including all changes of its descendents. Click the "Flat View" button in the toolbar to flat the table, so that sorting of columns is enabled.
The Change Calendar View provides a grand view of all changes in a user defined period. A colored box represents the number of changes in a particular day. Different color indicates different number of changes.
Click the colored box to display the Change details for that day. You can configure the color map and other Calendar View properties by clicking the "Configure Calendar View" toolbar button.
A SLA View displays the relationships between SLAs, Services and Organizations.
The attribute pane displays the detail information of the selected SLA, Service or Organization. NOTE: If a SLA is associated with more than one Service, multiple SLA nodes are created for the same SLA to avoid drawing multi-parents relationships.
If you have services defined in SDE, you can create a service map that graphically displays services on top of any image you choose. Service maps also display the total number of incidents for each service propagated from all descend services and CIs.
Configuring Graphic Properties To change service node graphic attributes and service map image, click "Graphics Options" on the service map toolbar.
You can launch SDE ConfigItem, Service, Incident, Change and Problem pages from CMDB Analyzer, and you can also launch CMDB Analyzer from SDE page by using the CMDB Analyzer's command line interface. Launching SDE Pages Within CMDB Analyzer Note: this feature is only available for Server projects. URLs that are used to launch SDE pages are defined in the project creation window. You can modify these URLs by opening the project's preference window. Steps to launch the SDE ConfigItem page:
Steps to launch the SDE Incident page:
Steps to launch the SDE Change page:
Steps to launch the SDE Problem page:
Launching CMDB Analyzer Within SDE CMDB Analyzer for SDE supports a command line interface which you can use to launch CMDB Analyzer from other applications. For example, run command in the CMDB Analyzer installation directory: "sdeAnz.exe -workspace workspace/demo -project myProject -dbserver myServer -dbname sde -user administrator -instanceId 1107" to launch CMDB Analyzer to create a server project "myProject" in workspace "demo" and to open CI View with CI (sequence 1107) highlighted in the center of the view. The following is a list of available arguments:
NOTE: You must first "cd" to the CMDB Analyzer installation directory and then run the command. You can write a batch file to accomplish this. A batch file can be launched by a correct path name from anywhere in the system.
SDE database queries that are used by CMDB Analyzer are defined in the file "query.xml" in the project folder. A master copy of this file is in the "system\bridges\com.blg.bmc.sde\config" folder. The master query file gets copied into the project folder once a project is created. If you modified the master copy, all new created project will inherit the modified query file. You can use an xml editor or any text editor to edit the query file. You have to make sure that the xml syntax is valid before save the file. The following is a sample query for CI:
<query id="ConfigItem"> <query id="ConfigItem"> <select> <field id=""
label="" enabled="" custom=""> (Database Table Column Name) </field> Field types:
Field attributes:
<from> (Database Table Name) </from> <other> (SQL statements
after "From") </other> <other>where "Seq.Catalog" = 1005</other>
NOTE: A query must have at least one system core field, but default fields and custom fields are optional.
Using the CI query as an example, the followings are typical scenarios that you have to modify the query file: If you want to see more CI fields in the CI custom attribute tab in CI View: Add more custom field entries in the Custom Fields block of the query If you want to exclude a default or a custom field: Set enabled="false" in the field you want to exclude If you want to have a different column label in the CI View detail pane: Change the "label" attribute in the field If you have customized the CI database table and changed column names: Modify the <field> tag to reflect the column name change If you have changed the CI database table name, or you want to query CI data from a different table: Change the table name in the <from> tag If you want to define query search criteria: Add SQL "Where" clause in the <other> tag Customizing Query File Best Practice:
NOTE: Each exported data directory contains a copy of query.xml file along with the data files. Don't modify this query file, as it stores the data field definitions for all exported data files.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||