ConfigurationMonitor

Scope

The configuration monitor is a pre-processor Java class that implements the spooler_process_before() APÍ method. It performs the following operations:

Reading parameters from a configuration file
The name of the configuration file is <job_chain_name>.config.xml
The parameters are only available to the node they are defined for.
The values of the parameters can contain patterns to identify values that are to be substituted
The default pattern is ${param}

The configuration monitor makes use of an extra configuration file. The location of the configuration file is

The default location is the file <jobchain>.config.xml in the folder that contains the job chain.

The location can be change with the parameters configurationMonitor_configuration_path and configurationMonitor_configuration_file.

With configurationMonitor_configuration_path the live folder can be changed.
With configurationMonitor_configuration_file the name of the configuration file can be changed.

It is possible to define a configuration file for a specific order id. The naming convention for this is

<live_folder>,<orderId>.config.xml

Attention:

Please note that node parameters are not shown in JOC when using the function "start order parameterized"

Please note that with JOE it is only possible to handle the default file <jobchain>.config.xml

When using the configuration monitor with the Universal Agent please see the hints here.

New Implementation since 1.11.

Since release 1.11 a new implemetation for the configuration monitor has been introduced. The new implementation is much faster than the old one. It is compatible for the standard use of the monitor.

Feature	Optimized Implementation since release 1.11	"Classic" Implementation up to release 1.10
Name of the implentation class	`com.sos.jitl.jobchainnodeparameter.monitor.JobchainNodeSubstituteMonitor`	`sos.scheduler.managed.configuration.ConfigurationOrderMonitor`
Multi substitution	yes	yes
Substitution source	Environment variables Task parameters Global JobScheduler parameters Node parameters System properties	Environment variables Task parameters Global JobScheduler parameters Node parameters file content (with file_content:)
Substitution patterns	${param} %param%	${param}
Integration with JOE	JOE uses the new class name when inserting a configuration monitor from the favourite list if never bevor a configuration monitor has been used. If JOE has been updated from an older version and already a configuration monitor has been assigned JOE uses the old implementation You can change this behaviour in the configuration file $scheduler_data/config/scheduler_editor.ini `monitor_favorite_java_configuration_monitor=com.sos.jitl.jobchainnodeparameter.monitor.JobchainNodeSubstituteMonitor`	JOE uses the old class name when inserting a configuration monitor from the favourite list See in the configuration file $scheduler_data/config/scheduler_editor.ini `monitor_favorite_java_configuration_monitor=com.sos.jitl.jobchainnodeparameter.monitor.JobchainNodeSubstituteMonitor`
Configuration file name	The default configuration file name is <job_chain>.config.xml The name of the file can be changed by using the parameter `configurationMonitor_configuration_file`	The default configuration file name is <job_chain>.config.xml The name of the file can be change by using the parameter `configurationMonitor_configuration_file` Based on a naming convention there can be different configuration file names
Configuration Path	The default configuration path is the live folder coming from api call spooler.configuration_directory() The name of the configuration path can be changed by using the parameter `configurationMonitor_configuration_path`
Substitution algorithm	Uses implentation of org.apache.commons.lang3.text.StrSubstitutor	Uses Code from SOS.
Parameter for configuration Path	configurationMonitor_configuration_path Default: folder where the job chain is located	ConfigurationBaseMonitor.configuration_path Default: folder where the job chain is located
Parameter for configuration file	configurationMonitor_configuration_file Default: <job_chain>.config.xml	ConfigurationBaseMonitor.configuration_file Default: <job_chain>.config.xml
Use with Agents	The first job of the job chain has to be executed with the Master and has to be assigned the configuration monitor	The first job of the job chain has to be executed with the Master and has to be assigned the configuration monitor
Attribute name in elemen <job_chain>	The attribute name in the element <job_chain> in the configuration file is not considered	The value of the attribute name in the element <job_chain> in the configuration file must be the same as the name of the job chain that uses this configuration file
Parameter scheduler_order_additional_envvars	Not implemented

Space shortcuts

Page tree

Scope

New Implementation since 1.11.

References