Page tree
Skip to end of metadata
Go to start of metadata

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.

Notes

  • 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:

-NameDisplays the name of your service.

Because the service has been "discovered" either:

  • from the information automatically defined during the installation process using the CAST Server Manager "Combined" option - see the CAST Installation Guide for more information
  • or via the Discover option when a new Database server is added via the Services view

...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 the Test Connection option.

Notes

  • This option is NOT available when editing a Dashboard Service installed on a CAST Storage Service.
  • The Trusted option, if selected, flags the connection as trusted - there is then no need to enter a user or password (these fields will be disabled).
  • Please see CAST Management Studio - Rights for more information about how server access rights and permissions are handled in the CAST Management Studio.
SynchronizePlease 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.

Notes

  • Before using the option, make sure that no connection is currently running a snapshot generation - running two concurrent computations on the same database will produce erratic results.
  • In most circumstances, locks will be removed from the server automatically (indeed this is the recommended action), but this process can take a long time. This option is designed to override this automatic unlocking process.
General tab

The General tab displays various options for your Dashboard Service:

-VersionDisplays the version of your Dashboard Service as installed in CAST Server Manager. This field is read-only.
Site Unique IDThe 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 connectionUse 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.

Portal section

URL
This option has multiple uses:
  • When clicking the Open Url option (see below), the URL you enter into the field will be opened in your default browser (useful if you want to define access to a specific dashboard easily.
  • When clicking the Add URL to Measurement Service option (see below), the URL you enter into the field will be uploaded to the Measurement Service and will be used when you click the "microscope" button in the CAST Health Dashboard in order to drill down either in to the CAST Engineering Dashboard or the legacy CAST Engineering Dashboard. Enter the URL of you wish to upload (see the option Add URL to Measurement Service below for more information about the required format of the URL).

Notes

  • When a snapshot is generated, the contents of this URL field are taken into account for the automatic PDF report generation feature in the legacy CAST Engineering Dashboard. You must therefore ensure that before a snapshot is generated:
    • The field is blank and does not contain any URL
    • Or that it contains a URL to your live legacy CAST Engineering Dashboard
  • If you have entered a URL to your live legacy CAST Engineering Dashboard using the secure http protocol (https) then you need to ensure that the CAST Management Studio can use your SSL certificate (whether self-signed or trusted) otherwise the snapshot will fail. To do so:
    • Obtain your legacy CAST Engineering Dashboard SSL certificate in .cer format - this is beyond the scope of this documentation, however, all modern browsers offer the possibility of exporting an SSL certificate to .cer file). Ensure the .cer file is named "server_host_name.cer".
    • When you have the certificate in .cer format, you need to import it into the truststore of JRE used by the CAST Management Studio (this is shipped with CAST AIP) using the keytool command. To do so, open a cmd prompt and navigate to <CAST AIP installation folder>\jre\bin
    • Then use the following command to import the .cer file:

keytool -importcert -alias [server_host_name] -keystore ..\lib\security\cacerts -file [path to your server_host_name.cer]

  • The snapshot will fail:
    • if the field is not blank and contains a URL other than your live legacy CAST Engineering Dashboard (i.e. for example to the CAST Health Dashboard or the CAST Engineering Dashboard).
    • if the URL to the live legacy CAST Engineering Dashboard uses the secure http protocol (https) and you have not imported your SSL cerrtificate as outlined above.
Open UrlClick 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.

Deployment considerations

  • If you have deployed the combined "HD-ED" WAR file then the URL is configured automatically to point to the CAST Engineering Dashboard and cannot be overridden to point to a separate CAST Engineering Dashboard deplyoyment.
  • However, if you have separate standalone deployments using the standalone CAST-Health.war / CAST-Engineering.war / CAST-CED.war files, then access to the CAST Engineering Dashboard (ED) or legacy CAST Engineering Dashboard (CED) is not implemented automatically and you will need to manually upload a URL as decribed below.

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:

  • Uploading a URL for the legacy CAST Engineering Dashboard
    • Simply enter the URL in the field URL above, in the format http://<server>:[<port>]/CAST-CED
      • you should tailor the <server> and <port> entries to your environment
  • Uploading a URL for the CAST Engineering Dashboard
    • For each CAST Dashboard Service that you want to drill down into, you must first determine the context "name" of the Dashboard Service as defined in the context.xml file for the CAST Engineering Dashboard (ED).
    • First locate and open the following file in a text editor:
      %CATALINA_HOME%\webapps\CAST-Engineering\WEB-INF\context.xml
    • Then take the following example which shows three CAST Dashboard Services each with different context "names" (the context "name" is the value defined after the second forward slash in (for example) name="jdbc/domains/APP1" (i.e. APP1)). We will use the APP1 name defined for the V80_CENTRAL_APP1 Dashboard Service:
      <Resource name="jdbc/domains/APP1" url="jdbc:postgresql://NEFYN:2280/postgres"           initConnectionSqls="SET search_path TO V80_CENTRAL_APP1;"           username="operator" password="CastAIP"            auth="Container" type="javax.sql.DataSource" driverClassName="org.postgresql.Driver"           validationQuery="select 1"           initialSize="5" maxActive="20" maxIdle="10" maxWait="-1"/><Resource name="jdbc/domains/APP2" url="jdbc:postgresql://NEFYN:2280/postgres"           initConnectionSqls="SET search_path TO V80_CENTRAL_APP2;"           username="operator" password="CastAIP"            auth="Container" type="javax.sql.DataSource" driverClassName="org.postgresql.Driver"           validationQuery="select 1"           initialSize="5" maxActive="20" maxIdle="10" maxWait="-1"/><Resource name="jdbc/domains/APP3" url="jdbc:postgresql://NEFYN:2280/postgres"           initConnectionSqls="SET search_path TO V80_CENTRAL_APP3;"           username="operator" password="CastAIP"            auth="Container" type="javax.sql.DataSource" driverClassName="org.postgresql.Driver"           validationQuery="select 1"           initialSize="5" maxActive="20" maxIdle="10" maxWait="-1"/>
    • Enter the URL of the CAST Engineering Dashboard that runs from the current Dashboard Service into the URL field. This will take the following form http://<server>:<port>/CAST-Engineering/engineering/index.html#<context-name>
      • you should tailor the <server> and <port> entries to your environment.
      • The <context-name> value refers the value we determined earlier, in this example APP1. So we will add the following URL: http://server:8080/CAST-Engineering/engineering/index.html#APP1

    • Click the Add URL to Measurement Service option.
    • A progress dialog box will then display the results:

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.

Notes

  • When using the option you will be prompted for login credentials > admin/cast (case-sensitive): note that this user has the ADMIN role only.
  • CAST AIP schemas hosted in Microsoft SQL Server environment - please be aware that the CAST Engineering / Security Dashboard will fail to load if you carried out a combined installation in CAST Server Manager using a Trusted connection (i.e. using Windows authentication) and are still using the automatically configured connection profile in the CAST Management Studio.
Portfolio tab

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

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 SystemUse 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:
  • the CAST Health Dashboard/CAST Engineering Dashboard to stop displaying any existing snapshot results.
  • the current Dashboard Service to be removed from any Applications that were part of the deleted System.

You will need to create a new System, assign the Application to that System and generate a Snapshot.

Snapshots tab

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:

EditUse 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 snapshotUse 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:

  • following the deletion of a snapshot you may need to restart your web application server so that the dashboards that rely on the data get the most up-to-date information
  • you can use the CLI to remove a specific snapshot or a list of snapshots from the Dashboard Service and the Measurement Service.
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.

Notes

  • Note that this operation can sometimes cause data discrepancies with results computed when the quality model was different. To minimise this, the following items are taken into account when using the Consolidate option:
    • changes in aggregation weights
    • changes in the tree structure (new contributions between a Quality Rule and a Technical Criteria, new aggregations, new Technical Criteria etc.)
    • changes in the module weight
    • changes in the thresholds used to compute grades based on rule compliance ratios and distributions
    • changes in critical contributions
  • Note that computations executed on the Analysis Service are not taken into account by the Consolidate option:
    • it does not re-analyze the source code
    • it does not re-compute metrics
    • it does not re-run procedures associated with metrics
  • Note that the above options are executed immediately. A delete and a consolidation cannot be reversed.
Upload snapshot to Measurement ServiceUse 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 ReportPlease see Generate a Report for more information.
Take a snapshot for each applicationThis 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 resultsThis 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:

General Checks

  • Info: Lists the status number for the existing snapshots
  • Info: Lists the status number for the next snapshot
  • Info: Lists the ADG procedures that are not referenced in the metrics
  • Warning: A metric whose name does not match its technology category

Check Object consistency

  • Error: Checks that only one CORPORATE object exists
  • Error: Checks the coherence of the technological objects via parent objects
  • Error: Checks the direction of the links - Corporate > System > Application > Module and Organization > Team > Dev > Module

Check Metric consistency

  • Error: Checks all references in the Assessment Model
  • Error: Searches for orphans
  • Warning: Searches for business/technical criteria without any contributions
  • Error: Checks that all the metrics calculate a value
  • Warning: Checks that all the parameters have a value
  • Error: Checks that all the parameter values are defined
  • Warning: Checks that the count operator for a Quality Rule is distinct
  • Error: Checks that UA languages have the necessary configuration
  • Error: Checks that the thresholds are only ascending or descending
  • Error: Checks for the absence of obsolete metric groups (7, 8 and 9)
  • Error: Checks the coherence of the metric execution locations
    Group = 1, 4, 5, 10, 13 > Type = 3
    Group = 2 > Type = 2
  • Warning: For types that equal 0 (deactivated)
  • Error: Metrics without a description in the metric tree
  • Warning: Checks for metrics whose description is identical to the name*
  • Error: Tests the existence of metric procedures (only on the Dashboard Service)
  • Error: Tests that the metric procedures have four NUMBER parameters

Check Result consistency

  • Error: Checks that all the snapshots are consolidated, except, possibly the last one
  • Warning: Checks for any repetitions in the RESULTS
  • Checks for the Quality Rule 'Total' result impose 'Detail' result
  • Quality Rule: 'Total' result impose 'Grade' result
  • Distribution: 'Category' result impose 'Grade' result
  • Distribution (5.6+): no flat distribution
  • Measure: 'Measure' result impose 'Grade' result
  • Quality Rule non-regression: number of executed Quality Rules
  • Quality Rule: ratio of executed Quality Rules per technology
  • Quality Rule: 'Grade' results for module impose 'Grade' results for containers

Check Status consistency

  • Checks for the absence of status on deleted snapshots
  • Error: Checks for the absence of repetitions in the STATUS
  • Error: Checks that the status of the object correctly reflects the last change of status
  • Error: Check the consistency of the object IDs
Migration tab

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:

BehaviorAction
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.

Available options

<None>

or

Name of Assessment Model

  • <None>: This indicates that no Assessment Model is assigned to the Dashboard Service. This is the case if you are using a Dashboard Service that was installed as a "standalone".

    If you leave the drop down list set to <None>, then you cannot generate a Snapshot on this Dashboard Service until you associate an Assessment Model to it.

  • Name of Assessment Model: If you see the name of an Assessment Model instead of <None>, this indicates that the Model in question is assigned to the current Dashboard Service. A name will be displayed:
    • if you have imported an Assessment Model
    • if you have used the <Change> option (see below) to select an Assessment Model to assign to the current Dashboard Service
<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.

Notes

  • If you are using the Change option to select <None> then a warning will be displayed as follows:

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 viewIn addition, the imported Assessment Model will be assigned to the current Dashboard Service.

Notes

  • CAST recommends that you do not import more than five Assessment Models into the Assessment Models view. The performance of the CAST Management Studio can be adversely affected if you import more than this.
  • After upgrading AIP, or installing/upgrading an extension, the Assessment Model is installed on both the Dashboard Service schema and on the Management Service schema. The Management Service schema is the only "repository" that preserves user customizations (rule activations, contribution, weights, rule parameters etc.), and MUST therefore be considered as the PRIMARY repository for the Assessment Model. As a consequence, it is STRONGLY advised to ensure that the Assessment Model in the Dashboard Service schema is aligned with the Management Service schema by generating a Snapshot or using the Synchronize Assessment Model action (see below) before transferring metrics with the "Import assessment model" from a Dashboard Service schema to a Management Service schema.

Synchronize Assessment ModelUse 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.

Exclusions

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
Notes tab

The Notes tab is simply an area that you can use to make notes or remarks about the selected item.

Editor buttons

The following buttons are available in the view:

Minimize > Minimize the entire window
Maximize > Maximize the entire window
See Also

Analysis Service editor | Measurement Service editor


CAST Website

  • No labels