runJobByCron
Looking for the documentation on the newest versions of SIL Engine and the Simple Issue Language for Jira 8 for Server/Data Center? Click here !
Availability
This routine is available starting with Power Scripts for Jira 3.0.8.
This routine is available for Jira server and cloud deployment options.
Syntax
runJobByCron(silFile, args, cronExpr)
Description
Runs the job according to the specified cron schedule.Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
silFile | string | Yes | The sil file name. |
| args | array string | Yes | The list of the arguments of the job. |
| cronExpr | string | Yes | The cron expression |
| user | string | No | The user which will be used to run the script. Availability This param is available starting with version 4.8.0.10 of Power Scripts . |
Note
You can find more details about using the cron expression according to the used API at www.quartz-scheduler.org/documentation/quartz-1.x/tutorials/crontrigger
Return type
none
The returned value has no meaning.
Example
runJobByCron("script.sil", {project, key}, "0 0 12 * * ?");
The SIL script above will create a job that will run the script "script.sil" at 12pm (noon) every day.
In "script.sil" you can access the args using the next syntax:
string issueKey = argv[1];
No user provided
This routine doesn't assume any user when executed because of the nature of this action(the execution of the script can be scheduled at any point in time and that cannot guarantee the user is authenticated). Therefore, the script will NOT have the required permissions to interact with Jira tickets, unless the project allows for anonymous access or the script explicitly calls out the user to use within in the script using the runAs routine.
It is highly recommended to provide a user to the scheduled job when interacting with Jira tickets.
Starting with version 4.8.0.10 of Power Scripts an optional param will be available that will give the possibility to assume an user when executing the script.
See also