| Tag Summary |
| clear |
Removes all flow charts, messages, publishers, users, and resets
the default administrator user account to its default settings. To force
early termination of a flow chart, use the <Interrupt> tag before using the
<Clear> tag. The returned result is the number of flow charts that
were removed.
|
| dispose |
Stops the engine, disposes all engine resources, and finally
shuts down the engine.
|
| expedite |
Forces the specified flow charts to be executed as soon as possible. If a
flow chart is already running and waiting on a trigger that can be
expedited, that trigger is fired as soon as possible and that flow chart
continues execution. If that flow chart is not already running, it starts
running as soon as possible and the first trigger encountered is fired
immediately, assuming that trigger can be expedited.
Not all triggers can be expedited. If a trigger cannot be expedited, it
ignores the expedite signal. Triggers that can be expedited include
TimerTrigger and ManualTrigger.
Technically, when a flow chart is expedited, all flow contexts on that flow
chart are expedited. For convenience, however, it is often simply said, "A
flow chart is expedited" when technically it is more accurate to say, "All
flow contexts on a flow chart are expedited".
Returns the number of flow charts that were expedited.
|
| forecast |
Returns an ordered result of flow charts, based on the next scheduled
firing time of each flow chart, given all flow charts in the specified
flow chart namespace and within the specified time range.
Only those flow charts that contain a timer trigger with a scheduled
trigger date within the specified time range are included in the result.
Note that if a timer trigger's scheduled trigger date has not been set,
that timer trigger is not included in the forecast.
Returns a ForecastElement for each timer trigger in each flow chart that
has a scheduled trigger date. Note that if a flow chart contains more
than one timer trigger with a scheduled trigger date set, there will
be more than one entry in the list for that flow chart.
Note that the actual firing of flow charts may not directly correspond with
the forecast due to a variety of factors.
|
| get |
Returns a flow chart whose name matches the specified flow chart name.
|
| getByState |
Returns all flow charts in the given state and namespace, ordered
first by flow chart super-state, then by flow chart sub-state.
|
| getConcurrencyLevel |
Returns the number that is the limit, which controls the number of
flow charts that may be executing concurrently.
|
| getConfiguration |
Returns the configuration for the specified engine instance.
|
| getFlowChartElements |
Returns the fundamental components of all flow charts, ordered by flow
chart name, whose names match the specified hierarchical flow chart
namespace expression.
|
| getFlowCharts |
Returns all flow charts, ordered by flow chart name, whose names match the
specified hierarchical flow chart namespace expression.
|
| getVersion |
Returns the version information for the current version of the engine.
|
| interrupt |
Interrupts the specified flow charts as soon as possible.
Using the interrupt tag, however, will only cause the engine to stop
executing the job and rollback the transaction. It will not prevent the job
from starting again. In this case, use the Engine.pause and then
Engine.interrupt tags. In the same manner, if the job is supposed to
stop executing and be deleted, use the Engine.remove tag, then the
Engine.interrupt tag.
|
| isDisposed |
Indicates whether the engine has been disposed and is no longer
usable. The returned result of this tag is either "true", if the engine
is disposed, or "false", if the engine is not disposed.
|
| isRunning |
Indicates if the engine has been started. The returned result of this
tag is either "true", if the engine is running, or "false", if the engine
is not running.
|
| isSecured |
Indicates if the engine has security enabled or not. The returned result
of this tag is either "true", if the engine is secure, or "false" if the
engine is not secure.
|
| makeJ2seSession |
Makes a session object for J2SE applications that can be used to
call multiple Engine methods within a single transaction.
|
| pause |
Pauses all flow charts specified by a hierarchical flow chart
namespace expression. Returns the number of flow charts that were paused.
|
| remove |
Removes executing flow charts from the engine. Note that using
the remove tag on a running job will fail, because at the next transaction
break, the engine will see that the job was deleted and rollback the
transaction. Rolling back the transaction will undo the work of this remove
tag. If a job is running when remove is used, that job will not terminate
until the next transaction break, at which point the job's transaction will
rollback and the job will terminate. To force early termination, interrupt
the job. Returns the number of flow charts that were removed
|
| rename |
Renames all flow charts in the old namespace to the new namespace. In
effect, a textual substitution is performed on each flow chart in the old
namespace so that within each flow chart name, the old namespace string is
replaced by the new namespace string. Returns the number of flow charts
that were removed.
|
| resume |
Resumes all flow charts specified by the hierarchical flow chart
namespace expression. Returns the number of flow charts that were resumed.
|
| scanAuditTrail |
Returns an ordered result of audit trail database transactions from the
Flux audit trail. Scanning the audit trail requires administrator
privileges.
|
| scanLogs |
Returns an ordered result of log entries from the Flux logs. Scanning the
logs requires administrator privileges.
|
| setConcurrencyLevel |
This limit controls the number of flow charts that may be executing
concurrently in the entire engine.
|
| size |
Returns the number of flow charts in the specified hierarchical
flow chart namespace within the engine.
|
| sizeByState |
Returns the number of flow charts in the specified state and
hierarchical flow chart namespace within the engine.
|
| start |
Instructs the engine to start executing flow charts.
|
| stop |
Instructs the engine to stop executing flow charts. This method blocks
until all running flow charts have stopped. Once stopped, the engine can
be restarted.
|