Use the following URL to access the Diagnostic page:

http://<server>:<port>/<dashboard>/static/diagnostic.html

This provides an indication of the violations index status based on the "domain":

• N/A - the domain is mapped to a Measurement Service schema or the Dashboard Service schema was installed with CAST AIP < 8.3.3)
• toCreate - no index has ever been created for this domain
• toUpdate - an index exists for this domain, but it is outdated because a new snapshot has been computed since the index creation
• upToDate - an index exists and is up-to-date. When this status is shown, the index for the Advanced Search feature is ready and available.

In the following example the index has never been generated since the status is set to "toCreate":

Click to enlarge

To generate the index, click the Create/Update Index button. During generation the status "Indexing" will be displayed and on completion, the status will change to "upToDate":

Click to enlarge

Use the RestAPI client:

http://<server>:<port>/<dashboard>/static/default.html

Using the following URI with a PUT will generate the index (where <domain> is more than likely set to AED, unless you have custom domains):

<domain>/violations-index

Then use the same URI with a GET will show the index status:

This method will force the violations index to be generated if its status is toUpdate (i.e. the index exists but is out-of-date because a new snapshot has been computed since the index creation) every time the web application is started, i.e.:

• When the web application host (e.g. Apache Tomcat) starts up or restarts
• When the web application is restarted through the Apache Tomcat management console

Edit the following file with a text editor:

%CATALINA_HOME%\webapps\<dashboard>\WEB-INF\web.xml

Set the following configuration to true:

<context-param>
	<param-name>rebuildViolationsSearchIndexesOnStart</param-name>
	<param-value>true</param-value>
</context-param>

Save the file. Next time the web application is started the index will be generated.

This method is to be used when you have a configuration in the domains.properties file - i.e. multiple "domains". The custom batch will generate the violations index for all the domains configured in the domains.properties file.

Create the following batch files in the %CATALINA_HOME%\webapps\<dashboard>\WEB-INF folder an then run the launch.bat file to start the index generation:

@echo off
@echo Computing Violations Indexes ...

util.bat > util.log
@echo --------------------------------

@echo off
setlocal enableDelayedExpansion
@echo Automated Violations Indexes Creation
@echo -------------------------------------
 
for /F "delims== eol=#" %%D in (domains.properties) do (
	@echo Process %%D/violations-index
	start /B titi.bat %%D
	@echo.
)

In the following file (titi.bat), you need to modify the line starting curl to match your environment:

• Replace user:pwd with a user that has the ADMIN role and their password.
• Replace http://localhost:8080/<dashboard>/rest/%domain%/violations-index with the URL to your dashboard.

@echo off
prompt $_
setlocal enableDelayedExpansion
set "domain=%~1"
 
@echo Start  %domain% !DATE!_!TIME!
curl -s -u user:pwd -X PUT http://localhost:8080/<dashboard>/rest/%domain%/violations-index
@echo  is the response from %domain%
@echo Finish %domain% !DATE!_!TIME!

The right hand panel list the results of the search. Key points:

• with no search criteria or filters enabled will show all violations available in the currently selected snapshot indicated by the following text:

• a search field is available for you to enter the object name you are searching for. Results in will be updated in real time.

• you can download the results to an Excel file for portability requirements:

• 20 results are shown. Use the Show More button to display additional results:

• the result lists uses the following columns:

	Option to add/remove the violation from the Action Plan or the Scheduled Exclusion List. Note that to interact with the Action Plan/Scheduled List, your user login must have the role QUALITY_MANAGER/EXCLUSION_MANAGER roles. These can be assigned at user level (when using Default Authentication mode) or via user or group (when using Standard LDAP authentication).
Action / Exclusions	Indicates whether the violation has been added to the Action Plan or the Scheduled Exclusion List: Item has been added to the Action Plan. Item has been added to the Scheduled Exclusion List.
Object Name Location	Displays the object name, and in the case of file based objects (as oppose to Database objects), the location on disk of the object.
Status	Displays the status of the object in comparison to the previous snapshot - e.g.: Added Updated Deleted Unchanged
	Clicking this icon will take you direct to the object in the Application Investigation view.