adTempus API
ArcanaDevelopment.adTempus.Client Namespace / DataContext Class / GetJobMonitorData Method
Options specifying which data to return
Query parameters for selecting the instances to return
The earliest date/time to fetch data for. Specify in the time zone of the adTempus server (available from Scheduler.ServerTimeZone).
The latest date/time to fetch data for. Specify in the time zone of the adTempus server (available from Scheduler.ServerTimeZone).
Indicates the latest date/time for which the scheduler has calculated runtimes. If the endDateTime is later than the calculatedRangeEnd, the calculatedRangeEnd is used instead of the endDateTime.
Set to a null reference (Nothing in Visual Basic) on first call. On return, will contain a reference timestamp that should be passed in the next call. See Remarks.
On return, contains information about scheduled executions, if fetchOptions contains ArcanaDevelopment.adTempus.Shared.JobMonitorViewFetchOptions.ScheduledExecutions. If this flag is not included, scheduledExecutions will be a null reference (Nothing in Visual Basic).
Contains the instances representing current executions (fetchOptions contains ArcanaDevelopment.adTempus.Shared.JobMonitorViewFetchOptions.ActiveInstances) and/or past executions (fetchOptions contains ArcanaDevelopment.adTempus.Shared.JobMonitorViewFetchOptions.PastInstances). If neither flag is set, instances may be a null reference (Nothing in Visual Basic).


In This Topic
    GetJobMonitorData Method
    In This Topic
    Gets information about past, current, and future executions of jobs
    Syntax

    Parameters

    fetchOptions
    Options specifying which data to return
    queryParameters
    Query parameters for selecting the instances to return
    startDateTime
    The earliest date/time to fetch data for. Specify in the time zone of the adTempus server (available from Scheduler.ServerTimeZone).
    endDateTime
    The latest date/time to fetch data for. Specify in the time zone of the adTempus server (available from Scheduler.ServerTimeZone).
    calculatedRangeEnd
    Indicates the latest date/time for which the scheduler has calculated runtimes. If the endDateTime is later than the calculatedRangeEnd, the calculatedRangeEnd is used instead of the endDateTime.
    lastFetchTimeUTC
    Set to a null reference (Nothing in Visual Basic) on first call. On return, will contain a reference timestamp that should be passed in the next call. See Remarks.
    scheduledExecutions
    On return, contains information about scheduled executions, if fetchOptions contains ArcanaDevelopment.adTempus.Shared.JobMonitorViewFetchOptions.ScheduledExecutions. If this flag is not included, scheduledExecutions will be a null reference (Nothing in Visual Basic).
    instances
    Contains the instances representing current executions (fetchOptions contains ArcanaDevelopment.adTempus.Shared.JobMonitorViewFetchOptions.ActiveInstances) and/or past executions (fetchOptions contains ArcanaDevelopment.adTempus.Shared.JobMonitorViewFetchOptions.PastInstances). If neither flag is set, instances may be a null reference (Nothing in Visual Basic).
    Remarks

    This method supports the Job Monitor view in the Console. It can return information about past, current, and future executions of specified jobs.

    The queryParameters specifies which jobs to select instances for.

    The lastFetchTimeUTC is used to limit the return of redundant data. On first call of the method, set this parameter to a null reference (Nothing in Visual Basic). On return, it will contain a timestamp from the server. On each subsequent call, pass the value returned from the previous call. The server will generally return only instances with state changes since the specified timestamp. However, in some cases (such as a clock change on the server) the server may still perform a full refresh. On the client, therefore, you must maintain state information between calls and merge the returned data with the previous data. If the client cannot maintain state, set this parameter to a null reference (Nothing in Visual Basic) on each call to force a full data fetch.

    The calculatedRangeEnd indicates how far into the future the scheduling engine has calculated runtimes for (generally this is slightly more than 1 year from the current time). If your endDateTime is later than this, the calculatedRangeEnd will be used as the end of the range (it is not possible to force the scheduler to calculate a longer range from the client).

    See Also