<timetable>
<job id="job1">...
<job id="job2">...
<group id="g1">
<job id="job3">...
<job id="job4">...
...
</group>
<group id="g2">
<job id="job5">...
</group>
</timetable>
23 August 2013
TIF provides support for running jobs at a scheduled time or period.
The scheduled jobs are defined within a file called timetable.xml
within the directory ${ROOT_DIR}/modules/enovia/etc
.
You can have instance specific timetable definitions. This is accomplished by adding more timetable files, within the same directory, following this naming convention:
timetable-{node-id}-{instance-id}.xml
timetable-{instance-id}.xml
timetable.xml
The file names are case insensitive |
TIF does not contain any timetable files per default.
However, a sample file called timetable.xml.sample
is provided in the same directory containing information and examples how to register scheduled jobs.
The root element of the XML file is <timetable>
.
Below this element you may have the following elements:
group
job
Jobs may be put into groups or un-grouped. Within the group element you may only have "job" elements.
The <group>
element must have an attribute called "id" containing the ID of the group (unique among all groups).
An example is shown below:
<timetable>
<job id="job1">...
<job id="job2">...
<group id="g1">
<job id="job3">...
<job id="job4">...
...
</group>
<group id="g2">
<job id="job5">...
</group>
</timetable>
The <job>
element defines the details of the scheduled job. You may configure a job to do one of the below
Execute a Java class
Execute a Script
Execute a MQL statement
Execute / Run a Job definition
The job element must have one attribute called "id" containing a unique identifier for the job.
The possible child elements for the job element is shown in the table below:
Child Element | Description | Required | Example |
---|---|---|---|
|
Used to provide the job with arguments |
No |
|
|
Defines when the job is executed. A cron format is used for specifying the time/period. See below for details. |
Yes |
|
|
Executes a Java class. See below for details |
|
|
|
Executes a script file. See below for details |
|
|
|
Executes a MQL statement (or statements) |
|
|
|
Executes a TIF job. Note that a TIF job typically requires an object as input, hence you need also some kind of "id provider" mechanism. See below for details |
|
One of java, script, mql or jobcfg is required. |
The arguments section are used to pass in arguments to the job. The syntax below is used.
<args>
<arg name="the name" value="the value" type="string | int | integer | long | real | double | bool | boolean | float"/>
...
</args>
The <schedule>
element defines when the job should be executed.
This element may have the following child elements.
<schedule>
<second>..</second>
<minute>..</minute>
<hour>..</hour>
<day-of-month>..</day-of-month>
<month>..</month>
<day-of-week>..</day-of-week>
<year>..</year>
</schedule>
|
Field Name | Allowed Values | Allowed Special Characters |
---|---|---|
second |
0-59 |
,-*/ |
minute |
0-59 |
,-*/ |
hour |
0-23 |
,-*/ |
day-of-month |
1-31 |
,-*?/LW |
month |
1-12 or JAN-DEC |
,-*/ |
day-of-week |
1-7 or SUN-SAT |
,-*?/L# |
year |
1970-2099 |
,-*/ |
Special characters:
* ("all values") - used to select all values within a field.
? ("no specific value") - useful when you need to specify something in one of the two fields in which the character is allowed, but not the other.
- Used to specify ranges. For example, "10-12" in the hour field means "the hours 10, 11 and 12".
, Used to specify additional values. For example, "MON,WED,FRI" in the day-of-week field means "the days Monday, Wednesday, and Friday".
/ Used to specify increments. For example, "0/15" in the seconds field means "the seconds 0, 15, 30, and 45".
L ("last") - has different meaning in each of the two fields in which it is allowed.
For example, the value "L" in the day-of-month field means "the last day of the month".
If used in the day-of-week field by itself, it simply means "7" or "SAT".
But if used in the day-of-week field after another value, it means "the last xxx day of the month" - for example "6L" means "the last friday of the month".
W ("weekday") - used to specify the weekday (Monday-Friday) nearest the given day.
As an example, if you were to specify "15W" as the value for the day-of-month field, the meaning is: "the nearest weekday to the 15th of the month".
# used to specify "the nth" XXX day of the month. For example, the value of "6#3" in the day-of-week field means "the third Friday of the month" (day 6 = Friday and "#3" = the 3rd one in the month).
Other examples: "2#1" = the first Monday of the month and "4#5" = the fifth Wednesday of the month.
The 'L' and 'W' characters can also be combined in the day-of-month field to yield 'LW', which translates to "last weekday of the month".
To execute a Java class, use the <java>
element to specify your class to be executed.
This class must implement the interface com.technia.tif.enovia.scheduling.ScheduledJob
,
which is defined like this:
package com.technia.tif.enovia.scheduling;
public interface ScheduledJob {
void execute(JobContext ctx) throws Exception;
}
The JobContext argument is defined like this:
package com.technia.tif.enovia.scheduling;
import java.util.Iterator;
import java.util.Map;
public interface JobContext {
String getId();
String getGroupId();
Iterator<String> getParamNames();
String[] getValues(String name);
String getValue(String name);
Integer getIntValue(String name);
Double getDoubleValue(String name);
Long getLongValue(String name);
Boolean getBoolValue(String name);
Map<String, String[]> toParamMap();
}
Custom classes are placed inside some JAR file within the ${TIF_HOME}/modules/enovia/lib/custom
directory.
You may instead of implementing a Java class implement the scheduled job in a script file.
Within the <script>
element, point out the script file to be executed. For example:
<script>tvc:script:background/Job1.js</script>
This would refer to the file
${TIF_ROOT}/modules/enovia/cfg/background/script/Job1.js
The script must have a function like below:
function execute(jobCtx, objectIds) {
}
The last argument may be optional and might be null depending on if an "idProvider" attribute has been set on the script element.
Example with id provider:
<script idProvider="tvc:dataset:background/FindSomeObjects.xml">
tvc:script:background/JobThatDoesSomethingWithObjectsInEnovia.js
</script>
The <mql>
element may be used if to execute MQL or MQL/TCL code in the ENOVIA™ database.
See below for configuration details:
<mql>
execute program BackgroundJob;
</mql>
or
<mql idProvider="tvc:dataset:background/SomeDataSet.xml" tcl="true">
mql delete bus ${OBJECTID}
</mql>
The attributes available on the <mql>
element are:
Points out an ID provider, for example a data set that returns the objects used as input.
Note the usage of the macro ${OBJECTID} in conjunction with the use of an idProvider. The MQL code is executed once for each object found by the "id provider" and the macro is replaced with the actual object-id value.
True if the code is MQL/TCL.
True if to resolve any symbolic names prior to running the code.
The <jobcfg>
element may be used to launch an existing Job configuration.
See below for configuration details:
<jobcfg idProvider="tvc:dataset/MyDataSet.xml">
tvc:jobcfg/SomeJobConfig.xml
</jobcfg>
The job defined by the configuration is executed once per object found by the "id provider".