Configuration and health check
Validation via Control Tower
Control Tower as a central component provides validation of it's own configuration and gather configuration checks from connected components by default from out of the box configuration.
Trigger validation
- Validation is going during startup tomcat by default. The result of
that can be accessible in
catalina.outandconfiguration.logfiles. To turn it off, in theworkfusion.properties, sethealth.check.startup.enabled=false. - Validation status can be fetched with REST
/v1/health-check(no authentication needed). The result is in response and in theconfiguration.logfile. For more informationn, see swagger-ui.
Validation checks
| Component | Validation |
|---|---|
| Control Tower Database | db connection, changelog version |
| Secret Management Service | Check required fields for SMS (serverApi, platformId, safe, and so on); check client certificate and keypass for it. |
| LDAP Authentication | url, bind DN, bind password, users and groups base dirs, user and groups filters |
| Single Sign On Authentication | Service Provider identifier, username attribute, SP metadata file, additionally check SignOn and LogOut service locations in metadata file |
| Crowd Licenses | Configured licenses are available. |
| S3 Storage | Check access with default keys, access with additional keys |
| Nexus Repository | url, password, ping, try to get artifact list |
| Mail Server | url, port, validate and ping |
| OCR | url, jwt issuer and secret. Internal OCR Monitoring |
| RPA Bot Manager | url, ping, access. |
| AutoML | url, ping. |
| SQC | url, ping, get project info |
| Tableau | url, username, password, site, workbook, new workbook, try sign in |
| ImageMagick | version if it is installed |
| Ghostscript | version if it is installed |
Additional options
If Workspace is deployed to the same tomcat server with Control Tower
and it is no active yet during validation, you can skip Crowd Licenses
validation on start up with health.check.crowd.license.startup.enabled=true in workfusion.properties file.
Connection timeout during check external components is 10000
milliseconds by default. To change this value, in workfusion.properties file, set the health.check.connect.timeout property.
Health check status example
Health check status in the JSON format...
{
"name": "Control Tower",
"status": "OK",
"projectInfo": {
"version": "10.0.0-SNAPSHOT",
"path": "develop",
"revision": "eb21349b8ee31d36fb535dd2d97f4f01a32a3bab",
"shortRevision": "eb21349b"
},
"errorCount": 0,
"warningCount": 0,
"errors": [
],
"warnings": [
],
"infos": [
],
"components": [
{
"name": "Secret Management Service",
"status": "OK",
"projectInfo": {
"version": "1.1.0.1",
"path": "release/1.1.0.1",
"revision": "8b2cabc9836ed7bba3b8bc0d4a927b8660a46f77",
"shortRevision": "8b2cabc9"
},
"errorCount": 0,
"warningCount": 0,
"errors": [
],
"warnings": [
],
"infos": [
],
"components": [
]
},
{
"name": "Control Tower Database",
"status": "OK",
"projectInfo": null,
"errorCount": 0,
"warningCount": 0,
"errors": [
],
"warnings": [
],
"infos": [
],
"components": [
]
},
{
"name": "OCR",
"status": "OK",
"projectInfo": null,
"errorCount": 0,
"warningCount": 0,
"errors": [
],
"warnings": [
],
"infos": [
],
"components": [
]
},
{
"name": "ImageMagick",
"status": "WARN",
"projectInfo": null,
"errorCount": 0,
"warningCount": 1,
"errors": [
],
"warnings": [
"The ImageMagick image conversion library is not found. The OCR pre-processing step cannot be executed correctly. Please, setup the ImageMagick library"
],
"infos": [
],
"components": [
]
},
{
"name": "Ghostscript",
"status": "OK",
"projectInfo": {
"version": "GPL Ghostscript 9.07 (2013-02-14)",
"path": null,
"revision": null,
"shortRevision": null
},
"errorCount": 0,
"warningCount": 0,
"errors": [
],
"warnings": [
],
"infos": [
],
"components": [
]
},
{
"name": "Tableau",
"status": "ERROR",
"projectInfo": null,
"errorCount": 1,
"warningCount": 1,
"errors": [
"Host velcom2-bi1.workfusion.com:443 is NOT reachable"
],
"warnings": [
"Tableau:Automation is not configured. You should specify following parameter(s): tableau.automation.host,tableau.automation.username,tableau.automation.password"
],
"infos": [
],
"components": [
]
},
{
"name": "AUTOML-SERVICES",
"status": "OK",
"projectInfo": null,
"errorCount": 0,
"warningCount": 0,
"errors": [
],
"warnings": [
],
"infos": [
],
"components": [
]
},
{
"name": "RPA Bot Manager",
"status": "ERROR",
"projectInfo": null,
"errorCount": 1,
"warningCount": 0,
"errors": [
"Error during check RPA Bot Manager. java.lang.IllegalStateException: Expected BEGIN_OBJECT but was STRING at line 1 column 1 path $"
],
"warnings": [
],
"infos": [
],
"components": [
]
},
{
"name": "SQC",
"status": "OK",
"projectInfo": {
"version": "10.0.0.2-SNAPSHOT",
"path": "develop",
"revision": "a82efe4065ef9b05fdb22b3304c1503418687c45",
"shortRevision": null
},
"errorCount": 0,
"warningCount": 0,
"errors": [
],
"warnings": [
],
"infos": [
],
"components": [
]
},
{
"name": "Crowd Licenses",
"status": "OK",
"projectInfo": null,
"errorCount": 0,
"warningCount": 0,
"errors": [
],
"warnings": [
],
"infos": [
],
"components": [
]
},
{
"name": "Mail Server",
"status": "OK",
"projectInfo": null,
"errorCount": 0,
"warningCount": 0,
"errors": [
],
"warnings": [
],
"infos": [
],
"components": [
]
},
{
"name": "S3 Storage",
"status": "OK",
"projectInfo": null,
"errorCount": 0,
"warningCount": 0,
"errors": [
],
"warnings": [
],
"infos": [
],
"components": [
]
},
{
"name": "Single Sign On Authentication",
"status": "OK",
"projectInfo": null,
"errorCount": 0,
"warningCount": 0,
"errors": [
],
"warnings": [
],
"infos": [
"Single Sign On Authentication is not enabled. Use following parameter for enabling: wf.sso.saml.enable"
],
"components": [
]
},
{
"name": "Nexus repository",
"status": "OK",
"projectInfo": null,
"errorCount": 0,
"warningCount": 0,
"errors": [
],
"warnings": [
],
"infos": [
"Found 0 artifact(s) in the Nexus repository. https://velcom2-int1.workfusion.com:443/nexus/"
],
"components": [
]
},
{
"name": "LDAP Authentication",
"status": "OK",
"projectInfo": null,
"errorCount": 0,
"warningCount": 0,
"errors": [
],
"warnings": [
],
"infos": [
"LDAP Authentication is not enabled. Use following parameter for enabling: ldap.enabled"
],
"components": [
]
}
]
}
Health Check Business Process
WorkFusion provides a health (sanity) check BP to run on environment to ensure that environment is functional. For more information, see Environment health check.