Check setup
Clicking the check setup link above the search field at the top right hand side of the web client opens the "Server setup diagnostics" dialog (figure 20.1). Click the Generate Diagnostics Report button in the dialog to run the checks.
The report contains a list of areas checked (figure 20.1). Those with no detected problems have a green checkmark (
) beside them. Those where problems were detected have a red exclamation mark (
) beside them. Each section can be expanded to reveal further details.
A red banner is also displayed at the top right of the web client if any problems were detected. Clicking the banner may jump focus to the relevant tab in the web client, depending on the problem that was identified.
Figure 20.1: The "Server setup diagnostics" dialog, opened by clicking the "check setup" link at the top right of the web client. Here, a problem relating to import/export directory configuration was found when the diagnostic checks were run. The expanded section contains details about the problem and a "Go to External data" link that can be used to open the relevant configuration tab. A red banner and warning message is displayed due to the problems detected.
The checks reported in the "Server setup diagnostics" dialog are also run when:
- An administrator logs into the web client. The red banner is displayed if problems are detected at this time.
- A bug report archive is generated. The results are written to a text file called
server-check-setup-result.txtthat is included in the zip archive.
Additional notes about the diagnostics report:
- The Licenses section includes results of checks relating to the CLC Server license. If the licensing mechanism is license files, the files that can be found are listed, with any that are expired license being noted.
- The "Trusted certificate validity" section shows a red exclamation mark if there are certificates in the trust store that are nearing or past their expiry date. A tool for certificate management is provided under Job processing | Server settings | SSL and certificate management (see SSL and encryption).
- The "Data location indexing" section contains a list of the enabled file system locations and the number of files indexed.
- On a job node setup, if there are communication issues between the job nodes and the master node, the status will indicate there is a problem.
- The message "No data locations indexed" indicates that either no locations have been configured, or that all configured locations have been disabled.
- If the number of files looks lower than expected, this can suggest that one or more CLC Server File System Locations should be re-indexed.
Information about indexes and rebuilding them is in CLC Server File System Location indexes.
- The following sections are relevant only for setups with job nodes:
- File system locations consistency
- Job nodes configuration integrity
- Job nodes plugin integrity
- A green check mark is presented beside "Grid setup status" when the setup includes grid presets and no problems were detected, or if the system does not have any grid presets configured.