ExecuteSchedule
Schedules are automated workflows that perform tasks on behalf of a user. They can be run from the Quintessence application but also initiated from a function, ExecuteSchedule(). Given the parameters that the Schedule requires, and the name of that Schedule, the process can be executed when the function is run.
ExecuteScheduleAsync() works the same way as the ExecuteSchedule() function but calculates in the background (asynchronously from third party applications). This is useful for longer Schedules, as work can continue while the Schedule runs computes. Once the data is ready, it is returned to the third party application.
Syntax
ExecuteSchedule(Schedule,Show Error,Parameters,Parameter Value n,…,Param)
Schedule | The schedule to execute. |
Show Error | Boolean to show the error message if the schedule fails. |
Parameters | An array of parameter names that will be set. This must match the order of parameters supplied and the order of parameters in the Schedule as viewed in Quintessence. |
Parameter Value n | The value for the nth parameter |
Param | The value for the thirteenth parameter. |
Examples
Example 1. Executing A Schedule on the Quintessence Scheduler
Note:
How your system administrator configured Quintessence determines which function parameters are required. In most implementations, administrators configure functions so that certain parameters default to specific values when left blank.
Example 1. Executing A Schedule on the Quintessence Scheduler
Assume the following Schedule, ‘User Upload’, takes an array of data and loads it into the database.
Input | ExecuteSchedule | ||||
User | CrawfordN | =ExecuteSchedule(”User Upload”,”TRUE”,”A1:A2”,”B1”,”B2:D10”) | |||
Data | ValueDate | EXX SJ Equity | Value | ||
01 Jan 2019 | EXX SJ Equity | 15167 | |||
02 Jan 2019 | EXX SJ Equity | 15175 | |||
03 Jan 2019 | EXX SJ Equity | 15258 | |||
04 Jan 2019 | EXX SJ Equity | 15256 | |||
05 Jan 2019 | EXX SJ Equity | 15158 | |||
06 Jan 2019 | EXX SJ Equity | 15279 | |||
07 Jan 2019 | EXX SJ Equity | 15448 | |||
08 Jan 2019 | EXX SJ Equity | 15498 |
With the function =ExecuteSchedule(”User Upload”,”TRUE”,”A1:A2”,”B1”,”B2:D10”), the Schedule can be run.
One thought on “ExecuteSchedule”