ECL Scheduler Boca Raton Documentation Team Lexis Nexis 2012 ECL Scheduler Component Installation and configuration The ECL Scheduler installs when you install the HPCC platform. It starts and stops using hpcc-init, just as all other HPCC components. Using the ECL Scheduler ECL Language Statements Used The Following ECL Language Statements are used: WHEN The WHEN service executes the action whenever the event is triggered. The optional COUNT option specifies the number of events to trigger instances of the action. NOTIFY The NOTIFY action triggers the event so that the WHEN workflow service can proceed with operations they are assigned to execute. EVENT The EVENT function returns a trigger event, which may be used within the WHEN workflow service or the NOTIFY action. EVENT is not really a statement, rather a parameter to WHEN/NOTIFY to describe what kind of event it is used for. CRON The CRON function defines a timer event for use within the WHEN workflow service. This is synonymous with EVENT(‘CRON’, time). CRON itself is not a statement, rather a parameter to WHEN/NOTIFY to describe what kind of event it is used for. WAIT The WAIT function is a string constant containing the name of the event to wait for. It is used much like the WHEN workflow service, but may be used within conditional code. Monitoring Functions in the Standard Library (STD.File) MonitorFile The MonitorFile function creates a file monitor job in the DFU Server for a physical file. MonitorLogicalFileName The MonitorLogicalFileName function creates a file monitor job in the DFU Server for a logical file. DFUPlus: Monitor Option dfuplus action=monitor event=MyEvent Note: DFUServer file monitoring (either using the Standard Library or DFUPlus) creates a DFU Workunit. While monitoring, the Workunit’s state is monitoring and once it triggers the event, it is set to finished. You can Abort a “monitoring” DFU Workunit to stop monitoring from ECL Watch. Interface in ECL Watch To access the ECL Scheduler interface in ECL Watch, click on the Event Scheduler link in the navigation sub-menu. The Scheduler interface displays and you can see the scheduled workunits, if any. The list of scheduled workunits has two significant columns, the EventName and the EventText.
ECL Scheduler Interface
The EventName is a created when scheduling a workunit. The EventText is an accompanying sub event. You can trigger an event by entering the EventName and Event Text in the entry boxes and then pressing the PushEvent button. This is the same as triggering an event using NOTIFY. Scheduler Workunit List You can search scheduled workunits by cluster or event name. To filter by cluster or event name, click on the Filter Action button. The Filter sub-menu displays. Fill in values for the filter criteria, Eventname or Cluster, then press the Apply button. When you specify any Filter options, the Filter Action button displays Filter Set.
Workunits in the Scheduler Interface
You can sort the workunits by clicking on the column header. To view the workunit details, click on the workunit ID (WUID) link for the workunit.
Pushing Events The Event Scheduler allow you to trigger or "push" an event to help manage and test your scheduled jobs. Press the PushEvent action button. The Push Event dialog opens. Enter the EventName: The EventName is a case-insensitive string constant naming the event to trap. See Also: EVENT Enter the EventText: The EventText is case-insensitive string constant naming the specific type of event to trap. It may contain * and ? to wildcard-match. See Also: EVENT Press the Apply button This is the equivalent of NOTIFY(EVENT(EventName,EventText)); See Also: NOTIFY, EVENT
PushEvent