Test and Tag reference

This section identifies the tests and tags that are available in System Health Check. Test names are bold headings in this topic and are listed under Executed Tests when running System Health Check in the WFM application.

Checking for conflicting Job Scheduler affinities

This test determines if multiple Job Scheduler instances are assigned to the same Task Affinity name. This test will fail if the user configures the same Task Affinity name for multiple Job Scheduler instances.

With multiple Job Schedulers, each scheduler should be unique and individually named. The Task Affinity names serve to identify each unique Job Scheduler instance.

Tags: Job Scheduler, Affinity
Checking Java version

This test determines if the specification version for Java (for example, "1.8") is supported for the application.

On failure, this test issues an error.

See the Infor Workforce Management Release Notes for more information on the supported Java version for your release.

Tags: Application Server, Version
Checking for recent Job Schedulers
This test checks if there were any active Job Schedulers in the past 24 hours.
Tags: Job Scheduler
Checking application's initial heap size

This test checks that the -Xms JVM parameter is greater than or equal to the supported value for the application based on deployment size.

On failure, an error message is issued with recommendations based on the number of employees in your deployment and are classified as follows:
  • XXS: Less than or equal to 1000 employees.
  • XS: 1000 to 2000 employees.
  • S: 2000 to 5000 employees.
  • M: 5000 to 15000 employees.
  • L: 15000 to 45000 employees.
  • XL: 45000 to 75000 employees.
  • XXXL: 75000 to 250000 employees.

Refer to your application server vendor documentation for information on how to change the heap size of your deployment. Heap size is often specified in the startup scripts for the application server.

Tags: Application, Heap Size, Deployment Size
Checking Job Scheduler's initial heap size

This test checks that the -Xms JVM parameter is greater than or equal to the supported value for the Job Scheduler based on deployment size.

On failure, an error message is issued with recommendations based on the number of employees in your deployment and are classified as follows:
  • XXS: Less than or equal to 1000 employees.
  • XS: 1000 to 2000 employees.
  • S: 2000 to 5000 employees.
  • M: 5000 to 15000 employees.
  • L: 15000 to 45000 employees.
  • XL: 45000 to 75000 employees.
  • XXXL: 75000 to 250000 employees.

The process ID of the Job Scheduler and the machine name are also identified in the message.

See Infor Workforce Management Installation and Configuration Guide for information on how to change the heap size of your deployment. Heap size is specified in the startup scripts for the Job Scheduler.

Tags: Job Scheduler, Heap Size, Deployment Size
Checking application's maximum heap size

This test checks that the -Xmx JVM parameter is greater than or equal to the supported value for the application based on deployment size.

On failure, an error message is issued with recommendations based on the number of employees in your deployment and are classified as follows:
  • XXS: Less than or equal to 1000 employees.
  • XS: 1000 to 2000 employees.
  • S: 2000 to 5000 employees.
  • M: 5000 to 15000 employees.
  • L: 15000 to 45000 employees.
  • XL: 45000 to 75000 employees.
  • XXXL: 75000 to 250000 employees.

Refer to your application server vendor documentation for information on how to change the heap size of your deployment. This is often changed in the startup scripts for the application server.

Tags: Application, Heap Size, Deployment Size
Checking Job Scheduler's maximum heap size

This test checks that the -Xmx JVM parameter is greater than or equal to the supported value for the Job Scheduler based on deployment size.

On failure, an error message is issued with recommendations based on the number of employees in your deployment and are classified as follows:
  • XXS: Less than or equal to 1000 employees.
  • XS: 1000 to 2000 employees.
  • S: 2000 to 5000 employees.
  • M: 5000 to 15000 employees.
  • L: 15000 to 45000 employees.
  • XL: 45000 to 75000 employees.
  • XXXL: 75000 to 250000 employees.

The process ID of the Job Scheduler and the machine name are also identified in the message.

See Infor Workforce Management Installation and Configuration Guide for information on how to change the heap size of your deployment. Heap size is specified in the startup scripts for the Job Scheduler.

Tags: Job Scheduler, Heap Size, Deployment Size
Checking if SQL fields are visible

This test checks if SQL fields are visible in the application and issues a warning if the wb.show.fields.containing.sql Java system property is set to true in the application server startup script:

-Dwb.show.fields.containing.sql=true

See the Infor Workforce Management Installation and Configuration Guide for more information on configuring this Java system property.

Tags: Application, SQL Fields
Checking application's logger appenders

This test checks for a valid appender in the log4j configuration for the application. This test checks that the root logger appender for the application is set to a valid class.

For more information on configuring log4j for the application and the Job Scheduler, see Infor Workforce Management Installation and Configuration Guide.

Tags: Application, Logging
Checking Job Scheduler's logger appenders

This test checks for a valid appender in the log4j configuration for the Job Scheduler. This test checks that the root logger appender for the Job Scheduler is set to a valid class.

For more information on configuring log4j for the application and the Job Scheduler, see Infor Workforce Management Installation and Configuration Guide.

Tags: Job Scheduler, Logging
Checking Job Scheduler's logging levels

This test checks the logging level configuration for the Job Scheduler and checks all the loggers configured. This is set using log4j.rootLogger in the log4j.properties file. Additional loggers can be configured by adding the property log4j.Logger.<class to add the logger to>=<value>.

This test issues a warning if the logging level for the Job Scheduler is at the DEBUG level. All other levels are acceptable.

For more information on configuring the logging levels of the application and the Job Scheduler, see Infor Workforce Management Installation and Configuration Guide.

Tags: Job Scheduler, Logging
Checking application's logging levels

This test checks the logging level configuration for the application. This is set using log4j.rootLogger in the log4j.properties file. You can also use the log4j.rootlogger registry parameter under system/log4j/.

This test issues a warning if the logging level for the application is at the DEBUG level. All other levels are acceptable. The warning message identifies the name of the logger that failed the test.

For more information on configuring the logging levels of the application and the Job Scheduler, see Infor Workforce Management Installation and Configuration Guide.

Tags: Application, Logging
Checking for slow page load times

This test checks the page load times and issues a warning for each page that is not within the maximum allowed load time. This rule checks the slowest page load time (per page visited) from the last hour. The warning message also contains this information:

  • Name of the page that failed.
  • Date and time when the page was loaded.
  • Time to load the page in milliseconds.

The maximum allowed load time is specified in the MAX_PAGE_GEN_TIME_MILLISECONDS registry parameter (/system/WORKBRAIN_PARAMETERS/SYSTEM_HEALTH_CHECK_PARAMETERS/MAX_PAGE_GEN_TIME_MILLISECONDS) which has a default setting of 10000 milliseconds or 10 seconds. For more information on this registry parameter, see Infor Workforce Management Registry Parameter Reference Guide.

Note: Page load times are only recorded if the Metrics registry parameter (/system/WORKBRAIN_PARAMETERS/Metrics) is set to On.
Tags: Application, Page Metrics
Checking if Page Metrics is turned on

This test checks if the Metrics registry parameter (/system/WORKBRAIN_PARAMETERS/Metrics) is set to ON and issues a failure if it is not set to ON.

For more information on updating this parameter, see Infor Workforce Management Registry Parameter Reference Guide.

Tags: Page Metrics
Checking if system is overloaded

This rule calculates the total number of active sessions and will issue a warning if the average active session count in the past hour is greater than 85% of the supported value specified in the /system/WORKBRAIN_PARAMETERS/SYSTEM_HEALTH_CHECK_PARAMETERS/MAX_SUPPORTED_ACTIVE_SESSIONS registry parameter.

This rule will fail if the average active session count in the past hour is greater than the maximum supported value specified in the MAX_SUPPORTED_ACTIVE_SESSIONS registry parameter.

For more information on updating this registry parameter, see Infor Workforce Management Registry Parameter Reference Guide.

Tags: Application
Checking server load balance

This rule checks for the number of active sessions per server in your deployment. This rule will issue a warning if a server has 25% more sessions than average number of sessions across all servers.

This rule will fail if a server has a 25% more sessions than the amount calculated by this formula: Supported sessions as per MAX_SUPPORTED_ACTIVE_SESSIONS registry parameter / number of servers.

For more information on updating the registry parameter, see Infor Workforce Management Registry Parameter Reference Guide.

Tags: Application
Checking for customer JAR in application

This test checks for the existence of the customer.jar file in the application. The customer.jar file is often used for customizations and custom code in the application.

This test issues a warning if customer.jar cannot be found.

Tags: Application, Customer JAR
Checking for application customer JAR name

This test checks if a name is retrievable for the customer.jar file by checking the signature-version in the JAR's manifest. This test only executes if the JAR exists.

On failure, this test issues a warning.

The customer.jar file is often used for customizations and custom code in the application.

Tags: Application, Customer JAR
Checking for Job Scheduler customer JAR name

This test checks if a name is retrievable for the customer.jar by checking the signature-version in the JAR's manifest. This test only executes if the JAR exists.

On failure, this test issues a warning.

The customer.jar file is often used for customizations and custom code in the application.

Tags: Customer JAR, Job Scheduler
Checking if customer JAR names match

This test determines if the customer.jar in the application and Job Scheduler match. A warning is issued if the names do not match.

This test only executes if both the application and the Job Scheduler have a customer.jar.

The customer.jar file is often used for customizations and custom code in the application.

Tags: Application, Customer JAR, Job Scheduler
Checking for customer JAR in Job Scheduler

This test checks for the existence of the customer.jar file in the Job Scheduler by looking at the JAR files listed in the scheduler classpath.

This test issues a warning if customer.jar cannot be found.

The customer.jar file is often used for customizations and custom code in the application.

Tags: Customer JAR, Job Scheduler
Checking if Job Scheduler customer JAR should be available

This test checks if the application has a customer.jar and the Job Scheduler does not. The customer.jar file is often used for customizations and custom code in the application.

On failure, this test issues an error.

Tags: Customer JAR, Job Scheduler
Comparing Job Scheduler build date to application build date

This test determines if the build date for the Job Scheduler is within 3 hours of the application build date. This test will issue an error if the difference is greater than 3 hours.

The number of hours between builds is controlled by the JS_APP_BUILD_DATE_MAX_DIFFERENCE_HOURS registry parameter (/system/WORKBRAIN_PARAMETERS/SYSTEM_HEALTH_CHECK_PARAMETERS/JS_APP_BUILD_DATE_MAX_DIFFERENCE_HOURS) which has a default setting of 3 hours. For more information on updating this parameter, see Infor Workforce Management Registry Parameter Reference Guide.

Tags: Application, Job Scheduler, Build Date
Comparing Job Scheduler version to application version
This test validates that the version for all Job Schedulers is equal to the application version.
Tags: Application, Job Scheduler, Version
Weblogic - Checking initial connection pool size

This test validates that the initial connection pool size configuration for Oracle Weblogic is greater than the supported value. This test is executed for every configured datasource in Weblogic.

For more information on changing the connection pool size for Weblogic, see your Oracle Weblogic documentation.

For best practice information on the JDBC connection pool settings in your application server, see Infor Workforce Management Installation and Configuration Guide.

Tags: Connection Pool, Weblogic Only, Deployment Size
Weblogic - Checking maximum connection pool size

This test validates that the maximum connection pool size configuration for Weblogic is greater than the supported value. This test is executed for every configured datasource in Weblogic.

For more information on changing the connection pool size for Weblogic, see your Oracle Weblogic documentation.

For best practice information on the JDBC connection pool settings in your application server, see Infor Workforce Management Installation and Configuration Guide.

Tags: Connection Pool, Weblogic Only, Deployment Size
Checking if Flyway migrations were applied to the application

The Flyway database migration tool is a requirement for a valid deployment and is used after a major installation or upgrade. It is also used to apply patches between major releases.

This test determines if the Flyway database migration tool has been used to apply migrations to your database after installing a major release, upgrading to a major release, or installing a maintenance patch.

Tags: Database, Flyway
Checking database version

This test checks for a supported version of the database in your deployment.

See the Infor Workforce Management Release Notes for more information on the supported database version for your release.

Tags: Database, Version
Checking application server version

This test checks for a supported version of the application server in your deployment.

See the Infor Workforce Management Release Notes for more information on the supported application server version for your release.

Tags: Application Server, Version
Checking for old entries in WORKBRAIN_SYS_STATE

This test checks for entries older than 8 days in the WORKBRAIN_SYS_STATE table. If this test fails it probably indicates that the WORKBRAIN SYS STATE archiving task with the Aging Days - For Purge Only option is not running.

For more information on configuring and enabling this archiving task, see Infor Workforce Management Tools Administration Guide.

Tags: Database, Job Scheduler
Checking that input validation is on

This test validates that input validation is enabled by checking the INPUT_VALIDATION registry parameter (/system/WORKBRAIN_PARAMETERS/INPUT_VALIDATION) for a value of TRUE. Input validation is turned on by default for all WFM deployments.

For more information on this registry parameter, see Infor Workforce Management Registry Parameter Reference Guide.

Tags: Input Validation, Application
Checking for weak/default passwords

This test checks for weak and default passwords for users in your deployment. It checks against the default values that are set by Workforce Management and compares all the passwords against a list of passwords that have been defined as weak by industry standards. By default, WFM has strict password requirements which can be configured using registry parameters.

If you need more information on how to change and configure passwords and the registry parameters that control password requirements, see Passwords.

Tags: Password Check
Checking for encrypt on startup flag

This test checks if the encryptOnStartUp flag is set on the application server. The encryptOnStartUp flag should only be set after an upgrade in a legacy (on-premises) deployment. When the flag is set to true, configuration data (for example, certificates and private keys) that was migrated in plain text during the upgrade is re-encrypted in the database on application startup. This flag should be set to false or removed after the application server has been restarted.

If the encryptOnStartUp flag is still set on the application server, this test issues a warning.

For more information, see the Infor Workforce Management Upgrade Guide.

Tags: Application
Checking expiry dates for sensitive configurations

This test checks the expiry dates for the keys configured in Maintenance > System Administration > Sensitive Data Configuration. This includes the WFM system key, SAML private key and certificate, and the PGP key.

An error is issued if the key for a configuration type (for example, GLOBALSYSTEMKEY) has expired. A warning is issued if the key for a configuration type will expire within the next month.

Note: If a key for a configuration type contains multiple entries, the highest (latest) expiry date is used for the comparison.

For information on sensitive configuration data, see the Infor Workforce Management Installation and Configuration Guide.

Tags: Application
Checking if SAML and cloud mode are configured

This test checks if SAML is configured in Maintenance > System Administration > Sensitive Data Configuration when using a cloud deployment of WFM.

If WFM is running in a cloud mode and SAML is not configured, this test issues an error.

For information on configuring SAML for a cloud deployment, see the Infor Workforce Management Configuration Guide for Infor Operating Service – Cloud Edition.

Tags: Application
Checking if PGP is configured

This test checks if PGP is configured in Maintenance > System Administration > Sensitive Data Configuration. PGP is used to import files into WFM that are encrypted using a WFM generated PGP public key and supported third-party encryption tools that support PGP (Pretty Good Privacy).

If PGP is not configured, this test issues a warning.

For information on generating the PGP key in the WFM application, see the Infor Workforce Management Installation and Configuration Guide.

Tags: Application
Checking if SystemKey is configured

This test checks if the WFM system key is configured in Maintenance > System Administration > Sensitive Data Configuration. The system key is created when the WFM application is first started.

If the system key is not configured, this test issues an error. To generate a new system key, restart any node in the WFM application.

Tags: Application
Checking if application KMS alias is set

This test checks if the KMS alias is set on all the application servers when using a cloud deployment of WFM. AWS Key Management Service (AWS KMS) is used to encrypt the keys that are used in the application to encrypt your data.

If WFM is running in a cloud mode and the KMS alias is not set on all the application servers, this test issues an error.

For information on passing the AWS KMS alias to the application server, see the Infor Workforce Management Cloud Implementation Guide.

Tags: Application
Checking if Job Scheduler KMS alias is set

This test checks if the KMS alias is set on the Job Scheduler when using a cloud deployment of WFM. AWS Key Management Service (AWS KMS) is used to encrypt the keys that are used in the application to encrypt your data.

If WFM is running in a cloud mode and the KMS alias is not set on the Job Scheduler, this test issues an error.

For information on passing the AWS KMS alias to the Job Scheduler, see the Infor Workforce Management Cloud Implementation Guide.

Tags: Application
Comparing Job Scheduler to application KMS alias

This test determines whether the Job Scheduler and application servers have the same value for the KMS alias. An error is issued if the values of the wb.tenant.aws.kms.alias parameter do not match.

For information on passing the AWS KMS alias to the application on startup, see the Infor Workforce Management Cloud Implementation Guide.

Tags: Application
Comparing Job Scheduler to application cloud mode

This test determines whether the Job Scheduler and application servers are running in the same cloud mode (aws or gov-cloud). An error is issued if the application servers and Job Scheduler are running in a different cloud mode.

For information on configuring the deployment mode that WFM operates in, see the Infor Workforce Management Cloud Implementation Guide.

Tags: Application