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

Summary: Instructions for configuring your standalone Health Dashboard to allow export of a detailed breakdown of the AEP/EFP function point data to Excel/CSV. Note that this configuration change is ONLY applicable when using the standalone Health war file (see Standalone Health Dashboard deployment) - when using the combined Health/Engineering war file, the export to Microsoft Excel/CSV icons are visible out of the box.

Introduction

The export to Microsoft Excel/CSV icons (as shown below) are NOT active (they are greyed out) by default in an "out of the box" Health Dashboard setup when using the standalone Health war file (see Standalone Health Dashboard deployment). This is because the information resides in the Dashboard schema (central) and not the Measure schema used by the Health Dashboard. In a combined Health and Engineering Dashboard, the dashboard schema is referenced in the connection property files for the dashboard, so the Health Dashboard already knows where the information is located. To enable these export icons in a standalone Health war file, a configuration change must be made to the Health Dashboard to inform the dashboard where the information is located. This page explains how to make this change.

Options greyed out:

AEP

EFP/AFP

Activating the export icons

To enable the icons when using the standalone Health war file a CAST Administrator needs to make a configuration change as follows:

Determine the Dashboard schema name

First determine which Dashboard schema the snapshot containing the relevant Application has been generated in. You can do so by first looking at the Application and Snapshot name in the Health Dashboard:

Open AIP Console and browse to the Admin Center (a user with the ADMIN role is required). Ensure you have selected the Applications tab, find your Application in the list and then click the hamburger options menu:

Choose the View Details option

Expand the Database Schemas section and note the name of the "central base":

This information is also located in CAST Management Studio in the Execution tab of the Application editor - the Dashboard Service is highlighted below:

Configure connection properties

WAR 1.x

When you have the name of the Dashboard schema that stores the required information, open the following file with a text editor:

CATALINA_HOME\webapps\CAST-Health\META-INF\context.xml

You now need to add an additional resource which points to the Dashboard schema you identified above. The following example shows the resource pointing to the Measurement schema (as defined as part of the initial configuration of the Health Dashboard - see Standalone Health Dashboard deployment) and a second resource pointing to the Dashboard schema:

       <Resource name="jdbc/domains/AAD" url="jdbc:postgresql://192.168.200.104:2282/postgres"
                           initConnectionSqls="SET search_path TO general_measure;"
                           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/uuid_55800ce6_03f7_49d0_971c_eb6f18ff2c94_central" url="jdbc:postgresql://192.168.200.104:2282/postgres"
                           initConnectionSqls="SET search_path TO uuid_55800ce6_03f7_49d0_971c_eb6f18ff2c94_central;"
                           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"/>    

Please ensure that you:

  • Define a unique "name" (unique within the file). In the above example, we have used jdbc/domains/uuid_55800ce6_03f7_49d0_971c_eb6f18ff2c94_central- this is different to the default "name" provided by CAST: jdbc/domains/AAD and reuses the name of the Dashboard schema (note that you can use any name you like but please retain the jdbc/domains/ part).
  • Define a "url" that points to the CAST Storage Service/PostgreSQL instance on which the Dashboard schema is installed. In most situations, this will be identical to the "url" used for the Measurement schema
  • Define a "initConnectionSqls" that references the name of the CAST AIP schema used for the Dashboard Service: initConnectionSqls="SET search_path TO uuid_55800ce6_03f7_49d0_971c_eb6f18ff2c94_central;" in the example above.
  • Check that the "username" and "password" entries are correct.
  • Following any changes you make, save the context.xml file and then restart your application server so that the changes are taken into account.
  • Now when you access the relevant pages, the export icons will be visible.

WAR/ZIP ≥ 2.x

When you have the name of the Dashboard schema that stores the required information, you need to modify two files:

Modify application.properties

This file is located here:

WAR ≥ 2.x
CATALINA_HOME\webapps\<deployed_war>\WEB-INF\classes\application.properties

ZIP ≥ 2.x
<unpacked_zip>\configurations\application.properties

Find the following section in the file:

## DATASOURCE
# Resource1 is the datasource name used in domains.properties
# Adapt server name (localhost) and port (2282) if required
# You can add multiple datasources if you want to connect to multiple CSS Servers. Datasource name must be unique
# You have to configure your domains names and relative schema names in domains.properties
restapi.datasource[0].url=jdbc:postgresql://192.168.200.104:2282/postgres
restapi.datasource[0].username=operator
restapi.datasource[0].password=CastAIP
restapi.datasource[0].poolname=Resource1
restapi.datasource[0].minimumIdle=10
restapi.datasource[0].maximumPoolSize=20

If the Dashboard schema you identified above is already hosted on the CAST Storage Service/PostgreSQL instance listed in the section, there is nothing further to do with this file. However, If the Dashboard schema you identified above is hosted on a different CAST Storage Service/PostgreSQL instance, add the new server in. For example:

  • Ensure that you modify the url, usernamepassword and resource entries to match your target CAST Storage Service/PostgreSQL. In particular, the resource entry must be unique within the application.properties file.
  • The [0] must also be incremented for additional CAST Storage Service/PostgreSQL instances, for example, use restapi.datasource[1].
## DATASOURCE
# Resource1 is the datasource name used in domains.properties
# Adapt server name (localhost) and port (2282) if required
# You can add multiple datasources if you want to connect to multiple CSS Servers. Datasource name must be unique
# You have to configure your domains names and relative schema names in domains.properties
restapi.datasource[0].url=jdbc:postgresql://192.168.200.104:2282/postgres
restapi.datasource[0].username=operator
restapi.datasource[0].password=CastAIP
restapi.datasource[0].poolname=Resource1
restapi.datasource[0].minimumIdle=10
restapi.datasource[0].maximumPoolSize=20

restapi.datasource[1].url=jdbc:postgresql://192.168.200.105:2282/postgres
restapi.datasource[1].username=operator
restapi.datasource[1].password=CastAIP
restapi.datasource[1].poolname=Resource2
restapi.datasource[0].minimumIdle=10
restapi.datasource[0].maximumPoolSize=20

Save the file before proceeding.

Modify domains.properties

WAR ≥ 2.x
CATALINA_HOME\webapps\<deployed_war>\WEB-INF\classes\domains.properties

ZIP ≥ 2.x
<unpacked_zip>\configurations\domains.properties

Add a new line to the file that specifies the Resource2 added in application.properties specific to "AED1" and the Dashboard schema you identified above, ensuring that there are no empty lines:

# Domains for HD
# empty lines in this file lead to connection error, remove all empty lines
# - AAD domain is mandatory for the portal
# - You can only connect one measure schema and domain must be "AAD"
# - You have to align [Resource1] with the resource name configured in application.properties
# - You have to replace [Measure Schema] by your measure schema name you want to connect
# AAD=Resource1,[Measure Schema]
AAD=Resource1,my_measure
AED1=Resource2,my_dashboard_schema

Save the file and then restart the web application. Now when you access the relevant pages, the export icons will be visible.

  • No labels