Dashboard Service editor
This section provides a detailed description of the Dashboard Service editor. This editor provides a means for you to configure a Dashboard Service installed on your Database server.
- Note that a Dashboard Service is used to store Snapshots generated from analysis results and Assessment Models used for managing Metrics and Quality Rules.
- Dashboard Services are automatically defined using the Discover option following the addition of a database server
- The user name and password used to access the Dashboard Service will be the same as used in the parent Database server, although they can be overridden using the Credentials section below. Please see CAST Management Studio - Rights for more information about how server access rights and permissions are handled in the CAST Management Studio.
Main field headings
This table lists the field headings that are always visible:
|-||Name||Displays the name of your service. |
Because the service has been "discovered" either:
...the name will be identical to the name of the corresponding database on your Database server.
It is NOT possible to modify the name of a service.
|-||Credentials||This option enables you to override the username and password defined in the Database server editor for the service's parent server. In other words, if the username and password used in the Database server editor is not appropriate or has unrestricted rights (for example), you can use this option to input another username and password that will be used whenever the CAST Management Studio interacts with the Dashboard Service. |
To enable the option, place a check mark in the Credentials tick box and then enter an appropriate username and password. You can test the connection using theTest Connection option.
|Synchronize||Please see Synchronize.|
|Cleanup desynchronized applications||This option enables you to cleanup any Applications that are no longer referenced in the CAST Management Service (and thus not visible in the Applications view), but which are still referenced in the current Dashboard Service. At some point in time a Stop Managing an Application action will have been applied to these Applications: |
Select the Applications you wish to cleanup and click Finish to completely remove them.
|Remove database lock|| Use this option to remove any locks that may have been set on the snapshot computation engine in the current Dashboard Service. |
For example, if the connection between the client and server is lost for whatever reason during the snapshot generation process, then a lock will be set by the server preventing any further snapshot processing (you will see the error message: "Compute Metrics REJECTED: A snapshot is already being processed - the operation requested can not be completed now.").
The option is indented to reset this type of lock so that you can continue processing your snapshots.
The General tab displays various options for your Dashboard Service:
|-||Version||Displays the version of your Dashboard Service as installed in CAST Server Manager. This field is read-only.|
|Site Unique ID||The Site Unique ID refers to the unique ID of your Dashboard Service as registered in the CAST Management Service (MNGT database). |
This ID is determined automatically by the CAST Management Studio when you use the Discover option on a Database Server in the Services view (or when you first connect to the CAST Management Studio following a combined installation of all CAST database services).
Please let the CAST Management Studio manage this ID - as such, you should only modify this ID if requested to do so by CAST Support.
|Test connection||Use this option to test the connection to the server hosting the service as defined in the Database server editor. |
If the Credentials option is activated, then the Test connection option will use the User and Password defined in the relevant fields in this editor to test the connection to the server hosting the service.
|URL||This option has multiple uses: |
keytool -importcert -alias [server_host_name] -keystore ..\lib\security\cacerts -file [path to your server_host_name.cer]
|Open Url||Click this option to open the URL defined in the URL field in your default browser.|
|Add URL to Measurement Service|| |
Note you may need a specific license that enables drill down into the CAST Engineering Dashboard or the legacy CAST Engineering Dashboard. Please do NOT configure this URL unless you specifically have this license.
The CAST Health Dashboard enables users (via the "microscope" icon) to access directly the underlying data in the CAST Dashboard Service database via the CAST Engineering Dashboard or the legacy CAST Engineering Dashboard. Both dashboards provide detailed information about the top level data displayed in the CAST Health Dashboard.
Access to the underlying data is provided via a URL (pointing to the required dashboard) that is stored in the Measurement Service.
Uploading a URL
Although you can activate a Measurement Service to store all snapshot data for the current Management Service (see Measurement Service editor), users will not be able to drill down into the underlying CAST Engineering Dashboard unless you specifically add the URL of your CAST Engineering Dashboard or legacy CAST Engineering Dashboard into the Measurement Service.
This option allows you to do so:
Embedded Web Server section
|Open Dashboard||When clicked, the CAST Management Studio will launch a temporary CAST Engineering / Security Dashboard. This is primarily for validating a Snapshot. The portal is run on a JVM launched by the CAST Management Studio, hence an additional "java.exe" process will be displayed in Windows Task Manager. The JVM is killed when the CAST Management Studio is closed. |
This section provides options for managing the set of Applications associated with the current Service:
|Corporate name||By default, this field will be pre-populated with "My Corporate". You can change this if you require - it is only visible in the CAST Engineering Dashboard and refers to the "corporate" entity (consisting of a System, Applications and Modules): |
Changes will not be visible in the CAST Engineering Dashboard until you generate a Snapshot.
Systems are entities that "sit under" the Corporate entity. They are only visible in the CAST Engineering Dashboard and consist of Applications and Modules:
- By default, a Dashboard Service that has been installed as part of a "combined" installation will have one System created by default (My System).
- A Dashboard Service that has been installed as a standalone will not contain any Systems.
- A Dashboard Service that has been migrated/upgraded to the current version will contain the Systems as they were prior to migration/upgraded.
You can add multiple Systems to a Dashboard Service if you want, for example, Application A to belong to System 1 and Application B to belong to System 2. To do so, use the Add button as described below.
|Add System||Use this button to add a new System to the Dashboard Service: |
A hidden section under the list of Systems will be displayed enabling you to rename the System if you require (you will need to generate a Snapshot before any changes are taken into account).
This hidden section also lists the Applications that are associated to the System (see Assign Applications to Systems for more information about this).
|Delete System||Use this button to delete the selected System. Any Applications that are associated to the System will not themselves be deleted, but you should be aware that deleting a System and then using the Synchronize option will cause the following: |
This tab provides a means to manage existing Snapshots stored on the current Dashboard Service. Snapshots govern the generation of data that can be exploited in the CAST dashboards and are derived from data created during the analysis process.
Once you have successfully generated a Snapshot for an Application associated to the current Dashboard Service you will see it listed in this tab. You can then manage it:
|Edit||Use this option to edit an existing Snapshot. The Snapshot editor will then be displayed, allowing you to change the Capture Date (amongst other things).|
|Delete snapshot||Use this option to completely remove the selected Snapshot from the Dashboard Service and from the Measurement Service (if the snapshot has been uploaded there). |
This will start the deletion process and can take some time if the Snapshot contains a large amount of data.
Please note that:
|Consolidate||Use this option to consolidate an existing Snapshot (i.e. one that has already been generated). This consolidation process can take some time if the Snapshot contains a large amount of data. |
This process will re-generate all existing information for the snapshot. Consolidating an existing Snapshot will cause all metrics/quality rule information associated to the Snapshot to be removed from the Dashboard Service and replaced with the new information created during the new consolidation.
|Upload snapshot to Measurement Service||Use this option to upload the selected snapshot to the Measurement Service. Doing so will ensure that the data contained in the snapshots will be made available to those using the CAST Health Dashboard. |
Note that if the selected snapshot has already been uploaded to the Measurement Service, this option will perform a delete and and then an update. In other words, the snapshot will be deleted and then re-uploaded to the Measurement Service.
This option is particularly useful if you have chosen not to upload a snapshot to the Measurement Service when you Generate a Snapshot.
|Generate Report||Please see Generate a Report for more information.|
|Take a snapshot for each application||This option will generate a snapshot for each Application that is assigned to the current Dashboard Service. Please see Generate a Snapshot for more detailed information about the snapshot generation process.|
|-||Check consistency of snapshot results||This option will check the consistency and integrity of the snapshot results stored in the current Dashboard Service. Below is a list of the checks that are carried out: |
Check Object consistency
Check Metric consistency
Check Result consistency
Check Status consistency
The Migration tab is only to be used in specific circumstances, i.e. when requested to do so by CAST Support.
Assessment Model tab
The Assessment Model tab enables you to manage the Assessment Model used for metric/Quality Rule processing during the snapshot generation process. Currently the following Assessment Models are delivered when CAST is installed or upgraded to the current version:
- a CAST Management Studio managed Assessment Model - i.e. the Assessment Model provided by default in file format when CAST is installed (located in the assessmentModels folder at the root of the CAST installation folder)
- an Assessment Model is also delivered embedded in the Dashboard Service to ensure continuity for some services that rely on the presence of an Assessment Model before the initial snapshot generation process. Please do not import this Assessment Model (before generating a snapshot) and assign it to a Dashboard Service. This Assessment Model must not be used to generate data.
- you may also have an Assessment Model from a previous version of CAST if you have upgraded to the current version.
As such, the following behavior is true:
|If the current Dashboard Service was installed as part of a "combined" installation, then the CAST Management Studio managed Assessment Model - i.e. the Assessment Model provided by default in file format when CAST is installed (located in the assessmentModels folder at the root of the CAST installation folder) will be assigned to the current Dashboard Service.||When you generate a Snapshot or use the manual Synchronize Assessment Model option, the CAST Management Studio managed Assessment Model will be transferred and embedded into the Dashboard Service and used during the snapshot generation. Any existing Assessment Model in the Dashboard Service will be overwritten.|
|If the current Dashboard Service was installed as a "standalone", then no Assessment Model will be associated to the Dashboard Service.||You cannot generate a Snapshot on this Dashboard Service until you assign an Assessment Model to it - see below.|
Name of Assessment Model
|<Change>||Use this option to choose an Assessment Model to assign to the current Dashboard Service. A dialog box will be displayed enabling you to select the Assessment Model you want to assign - only models that are present in the Assessment Models view will be available for selection: |
Choose the Assessment Model you require and click Finish to proceed. The selected Assessment Model will now be assigned to the current Dashboard Service.
|Import Assessment Model||This option will import the Assessment Model that is currently embedded in your Dashboard Service and display it as Assessment model imported from <dashboard_service_name> in the Assessment Models view. |
In addition, the imported Assessment Model will be assigned to the current Dashboard Service.
|Synchronize Assessment Model||Use this option to synchronize and embed the current Assessment Model in the current Dashboard Service. |
In other words, this option will overwrite the existing Assessment Model in the Dashboard Service with any changes you may make using the Assessment Models editor. The next snapshot generation process will then use this Assessment Model.
Background Facts upload file
Choose the XML file that contains your Background Facts data (previously known as Productivity data) to measure the productivity of your organization, teams and developers. For more information about this, please see: Configuring the Background Facts upload file.
This section enables you to exclude an Application(s) and/or Module(s) assigned to the current Dashboard Service from a specific Health Factor, Quality Rule and/or Technical Criterion. In other words, the selected Application/Module will not be included in the chosen Health Factor, Quality Rule and/or Technical Criterion the next time a Snapshot is generated using the associated Assessment Model.
To add a new Exclusion:
- Make sure that an Assessment Model has been imported for the current Dashboard Service (i.e. if <None> is displayed in the drop down list above, you can still add a new exclusion, however, you cannot fully configure it)
- Then click the
button to add a new exclusion - a new line will appear in the list of exclusions and a hidden configuration section will appear:
- In this section you need to configure:
- Portfolio (either an Application or a Module) > Click the Select option and a new dialog box will be displayed enabling you to select the Application or Module you require. This option defines which Application or Module (assigned to the current Dashboard Service) will be excluded. If you have no Applications/Modules defined, then you will need to first create them.
- Metric (Health Factor or Quality Rule or Technical Criterion) > Click the Select option and a new dialog box will be displayed enabling you to select the metric you require. This option defines which Health Factor, Quality Rule or Technical Criterion the chosen Application or Module will be excluded from.
- Once the configuration is complete, the new exclusion will appear in the list:
To edit an existing Exclusion:
- Select the item in the list
- Edit the item using the list
To remove an existing Exclusion:
- Select the item in the list
- Click the button
The Notes tab is simply an area that you can use to make notes or remarks about the selected item.
The following buttons are available in the view:
|Minimize > Minimize the entire window|
|Maximize > Maximize the entire window|