Advanced Quality Insight configuration

This section includes some advanced Quality Insight configurations.

Monitor the indexing status

Indexing a large project for the first time can take several hours. Changing the data location after Quality Insight is installed will require a similar amount of time as initial indexing, since all the data will be re-indexed and the indexing process will start over. You may want to monitor the progress of the indexing process.

To monitor the status of the indexing process:

  1. Send an HTTP GET request to the URL:

    http://<quality insight server>:<port>/alm-fetcher-service/api/health/
  2. When the indexing process has finished, the status changes from "RUNNING" to "WAITING". This indicates that the indexing has finished and is waiting for the next time new data is pooled. Every few hours, the system will query if there is new data to index.

    Note: When _nextRuntime has a value other than "-1", this indicates that the indexing process has completed and the project data is ready to be searched with Quality Insight. (If _nextRuntime is "-1", this indicates that the indexing has not yet started or is still in progress, and has not yet completed for the first time.)

Back to top

(Optional, for Windows only) Modify Quality Insight configurations

After Quality Insight is installed, you can modify configuration settings, such as data location or ALM server URL, as required.

For example, you may decide to store the data in a shared location, or in a folder outside the installation directory to prevent it from being deleted upon Quality Insight upgrade or uninstallation.

Note: Changing configuration settings may cause some downtime until the Quality Insight service restarts. If you change the data location after Quality Insight is installed, all the data will be re-indexed. The indexing process will start over and will take a similar amount of time as when indexing the project for the first time.

To modify and update Quality Insight configurations:

  1. From the Windows Start menu, select All Programs > Micro Focus > Quality Insight - Update Configurations.

    The Quality Insight - Configurations page opens.

  2. Edit the required settings.

  3. Click Save. The Quality Insight service restarts.

    You may have to wait a few moments for Quality Insight to be available. A message is displayed, indicating that the Quality Insight service is ready.

Back to top

(Optional, for Windows only) Change the user that runs the Quality Insight service

By default, the Quality Insight service is run by the local system user. You can change the user that runs the Quality Insight service to a different Windows user. Make sure that the Windows user has permissions to run services.

Note: If you decide change the location where Quality Insight data is stored, such as to a shared location, make sure that the Windows user running the Quality Insight machine has permissions to access the specified location.

To change the Quality Insight service user:

  1. On the machine where Quality Insight is running, press Win+R, and in the Run command box, type services.msc and press Enter. The Services window opens.

  2. Stop both the MF Quality Insight and MF Quality Insight ES services.
  3. Double-click each service. The Search Properties dialog box opens.
  4. In the Log On tab, change the user for each service.
  5. Start both services.

Back to top

Run Quality Insight over SSL or HTTPS

After installing Quality Insight, you can configure trust on the Quality Insight server. This is required when Quality Insight connects to the ALM server through the HTTPs protocol.

To run Quality Insight over SSL or HTTPS:

  1. Prepare the keystore file with your certificate chain and place it in the relevant folder (for example, <quality insight install path>\apache-tomcat-9.0.22\conf). To learn more, see the Certificate Authority (CA) documentation.
  2. Configure Apache Tomcat to use HTTPS:
    1. Navigate to <quality insight install path>\apache-tomcat-9.0.22\conf and open server.xml.
    2. Add the following:

      Copy code
      <Connector port="8443" protocol="org.apache.coyote.http11.Http11NioProtocol"
      maxThreads="150" SSLEnabled="true" scheme="https" secure="true"
      clientAuth="false" sslProtocol="TLS" keystoreFile="conf/keystore.jks" keystorePass="changeit"
      sslEnabledProtocols="TLSv1,TLSv1.1,TLSv1.2"/>

      The following table describes the above properties:

      Property

      Description

      port

      The SSL port that will be used to connect from ALM

      protocol

      For protocol details, see Apache Tomcat documentation

      keystoreFileThe path to your keystore
      keystorePassThe password to your keystore
      sslEnabledProtocols The allowed SSL protocols
  3. Add the primary, intermediate, and CA certificates used in ALM to the Quality Insight keystore. The default location is <JDK install path>\jre\lib\security\cacerts.

    • Windows

      Copy code
      "%JAVA_HOME%\bin\keytool" -import -trustcacerts -alias mydomain -file sertificate.crt -keystore "<JDK install path>\jre\lib\security\cacerts"
    • Linux

      Copy code
      "%JAVA_HOME%/bin/keytool" -import -trustcacerts -alias mydomain -file sertificate.crt -keystore "<JDK install path>\jre\lib\security\cacerts"
  4. Restart Quality Insight and verify the installation:

    https://<quality_insight_server>:<PORT>/iris-service/

    A message is displayed, confirming that the configuration is correct.

  5. Add the primary, intermediate, and CA certificates used in Quality Insight to the ALM keystore. The default location is <JDK install path>\jre\lib\security\cacerts.

    • Windows

      Copy code
      "%JAVA_HOME%\bin\keytool" -import -trustcacerts -alias mydomain -file sertificate.crt -keystore "<JDK install path>\jre\lib\security\cacerts"
    • Linux

      Copy code
      "%JAVA_HOME%/bin/keytool" -import -trustcacerts -alias mydomain -file sertificate.crt -keystore "<JDK install path>\jre\lib\security\cacerts"
  6. Restart ALM and configure Quality Insight using SSL.

    For more details, see https://tomcat.apache.org/tomcat-8.0-doc/ssl-howto.html.

Back to top

Change starting sync time of Quality Insight

Only data whose last modified date is later the starting sync time of Quality Insight will be synchronized from the ALM server to the Quality Insight server and then be fetched by Quality Insight. By default, the starting sync time is 2020-01-01 00:00:00.

To change the stating sync time of Quality Insight:

  1. Update alm.fetch.initial.date in the alm-fetcher-service.properties file, which is located in the {installation path}\apache-tomcat-9.0.22\webapps\alm-fetcher-service\WEB-INF\classes directory.

    The new date format should be the same as the default date: YYYY-MM-DD HH:MM:SS.

  1. For Windows: Open Windows Services, and restart the MF Quality Insight service.

    For Linux: Stop and start the Quality Insight service by using the following command:

    Copy code
    service <MF_QI> <start / stop>

Back to top

Change server port of Quality Insight

After the installation, the server port of Quality Insight is 8080. If 8080 has already been occupied, you should change the server port of Quality Insight.

For Windows:

  1. Update the port number in the alm-fetcher-service.properties file, which is located in the {installation path}\apache-tomcat-9.0.22\webapps\alm-fetcher-service\WEB-INF\classes directory.

    Copy code
    <Server port="8005" shutdown="SHUTDOWN">
       <Service name="Catalina">
         <Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000"
           redirectPort="8443" />

    By default, the path is C:\Program Files\MicroFocus\QualityInsight\apache-tomcat-9.0.22\webapps\alm-fetcher-service\WEB-INF\classes\alm-fetcher-service.properties.

  2. Update the port number in the server.xml file, which is located in the {installation path}\apache-tomcat-9.0.22\conf directory.

    Copy code
    iris.server.url=http://localhost:8080

    By default, the path is C:\Program Files\MicroFocus\QualityInsight\apache-tomcat-9.0.22\conf\server.xml.

For Linux:

  1. Update the port number in the alm-fetcher-service.properties file, which is located in the {installation path}/apache-tomcat-9.0.22/webapps/alm-fetcher-service/WEB-INF/classes directory.

    Copy code
    Server port="8005" shutdown="SHUTDOWN">
       <Service name="Catalina">
         <Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000"
           redirectPort="8443" />

    By default, the path is /var/opt/MicroFocus/QualityInsight/apache-tomcat-9.0.22/webapps/alm-fetcher-service/WEB-INF/classes/alm-fetcher-service.properties.

  2. Update the port number in the server.xml file, which is located in the {installation path}/apache-tomcat-9.0.22/conf directory.

     

    Copy code
    iris.server.url=http://localhost:8080

    By default, the path is /var/opt/MicroFocus/QualityInsight/apache-tomcat-9.0.22/conf/server.xml.

Back to top

Configure entity fields synched to Quality Insight

You can define which entity fields are synched from the ALM server to the Quality Insight server. By default, some requirement fields and all fields of other entity types are synched.

To define which entity fields are synched:

  1. Open the alm-fetcher-service-application-context.xml file that is located in the {installation path}\apache-tomcat-9.0.22\webapps\alm-fetcher-service\WEB-INF directory.

  2. Locate the <util:list> element for the entity type whose fields you want to specify.

    Example: If you want to specify fields for the defect entity type, locate the following element.

    <util:list id="defect-alm-fields" list-class="java.util.ArrayList" value-type="java.lang.String">    
    </util:list>
  3. In the target <util:list> element, add the names of the fields you want to sync to Quality Insight.

    Note: Entity field names are not necessarily the same as field labels. To obtain field names:

    1. Call the REST API: GET/qcbin/rest/domains/{domain}/projects/{project}/customization/entities/{entity name}/fields.

    2. The name of a field is the value of the Name attribute of the Field element.

      For example, <Field Label="Author" Name="owner" PhysicalName="RQ_REQ_AUTHOR">. The field name for the Author field is owner.

    Example: If you want to sync the defect fields such as Actual Fix Time, Assigned To, Closing Date, and Detected By to Quality Insight, you should add the following values to the <util:list> element for the defect entity type.

    <util:list id="defect-alm-fields" list-class="java.util.ArrayList" value-type="java.lang.String">
      <value>actual-fix-time</value>
      <value>owner</value>
      <value>closing-date</value>
      <value>detected-by</value>
    </util:list>
  4. Restart the MF Quality Insight service.

    For Windows: Open Windows Services, and restart the MF Quality Insight service.

    For Linux: Stop and start the Quality Insight service by using the following command:

    Copy code
    service <MF_QI> <start / stop>
  5. Re-index data by rebuilding dashboard cards. See Rebuild dashboard cards .

Back to top

Set maximum number of KPI cards

You can define the maximum number of KPI cards each user can create in Quality Insight > Executive Dashboard. By default, a user can create up to 100 KPI cards.

To set the maximum number of KPI cards:

  1. Open the iris.properties file that is located in the {installation path}\apache-tomcat-9.0.22\webapps\iris-service\WEB-INF\classes directory.

  2. Update the value of the iris-service.search.page-size.limit parameter.

  3. Restart the MF Quality Insight service.

    For Windows: Open Windows Services, and restart the MF Quality Insight service.

    For Linux: Stop and start the Quality Insight service by using the following command:

    Copy code
    service <MF_QI> <start / stop>

Back to top

See also: