3.5.2.3. Automation

File: classes/Automation.php
The Automation class manages the task queue for automated tasks. Each task in the queue has an ID.

3.5.2.3.1. abort

Format: result = abort(id)
Example: $result = $automation->abort($id);

This method aborts a running task with the given ID.

3.5.2.3.2. aborted

Format: result aborted(id)
Example: $result = $automation->aborted($id);

This method sets the specified session varaible to the specified value.

3.5.2.3.3. add

Format: result = add(name,starttime,recurring,allowduplicates)
where name is the task to run, starttime is the time to run the task (0=now), recurring indicates how many seconds between recurring runs, and allowduplicates is true if more than one instance of the same name is allowed (otherwise an error is returned).
Example: $result = $automation->add($name,$start,0,TRUE);

This method adds a new task to the queue.

3.5.2.3.4. check_manager

Format: check_manager()
Example: check_manager();

This method checks that the automation manager process is running and starts it if not. If it fails to start the manager, it fails silently. The function returns no data.

3.5.2.3.5. delete

Format: result = delete(id)
Example: $result = $automation->delete($id);

This method deletes the task with the specified ID.

3.5.2.3.6. flag_task_start

Format: result = flag_task_start(name)
Example: $result = $automation->flag_task_start($name);

This method indicates that the specified task has started. This is typically called by a given task when it starts to indicate the fact.

3.5.2.3.7. flag_task_end

Format: result = flag_task_end(name)
Example: $result = $automation->flag_task_end($name);

This method indicates that the specified task has completed. This is typically called by a given task just before it exits.

3.5.2.3.8. get_tasks

Format: $result = get_tasks()
Example: $tasks = $automation->get_tasks();

Returns an array of information on the tasks in the queue.

3.5.2.3.9. get_task

Format: $result = get_task(id)
Example: $task = $automation->get_task($id);

This method returns information on the task with the specified ID.

3.5.2.3.10. register_master

Format: result = register_master(pid)
where "pid" is the process id of the caller
Example: $result = $automation->register_master($pid);

When the automation manager task starts, it calls this method to notify EWE that the process has started.

3.5.2.3.11. release

Format: result = release(id)
where "pid" is the process id of the caller
Example: $result = $automation->release($id);

This method releases the task with the specified ID so that it can run when scheduled.

3.5.2.3.12. reset_all

Format: result = reset_all()
Example: $result = $automation->reset_all();

This method releases all of the tasks so they can run when scheduled.

3.5.2.3.13. set_error

Format: result = set_error(name,flag)
Example: $result = $automation->set_error($name,$flag);

Sets the flag for the task with the given name. The values are:
ValueMeaning
1Abend
2On hold
3Aborting

3.5.2.3.14. reset_all

Format: result = set_task(id,name,recurring,nexttime)
where "id" is the task ID, "recurring" indicates the number of seconds between when the task runs (0=one-time), "nexttime" indicates the timestamp of the next time the task runs
Example: $result = $automation->set_task($id,$name,$recurring,$next=0);

This method changes the information of the task with the given ID.

3.5.2.3.15. start_next

Format: result = start_next()
Example: $result = $automation->start_next();

This method schedules the next task that is available to run to start running.