Element Details: DataLayer.Scheduler
 Back


Available in: Logi Info Source code name: DataLayer.SchedulerIntroduced in: v9.5.14

DataLayer.Scheduler queries the Scheduler service to return a list of scheduled tasks.

If certain attribute values are entered, then the query results will be filtered on those values. These attributes are:

SchedulerTaskID
SchedulerApplicationID
SchedulerTaskName
SchedulerRunAs
SchedulerCustomColumn1
SchedulerCustomColumn2

For example, to retrieve just the scheduled task with TaskID = 10, set the TaskID attribute to 10.

The DataLayer returns columns from the scheduler for each task, including:

TaskID
ApplicationID
TaskName
RunAs
CustomColumn1
CustomColumn2
IsDisabled (True or False)
ScheduleXml
ProcessXml
TimeCreated
TimeModified
TimeNextRun
TimeLastRun
IsRunning (True or False)
WasSuccessfulLastRun
TaskResults (a filename)
ScheduleDescription (an English description of the scheduled times)

The ProcessParams for the schedule, if any, are also included for each scheduler task.

Element Group:Info DataLayers



ATTRIBUTES

Click attribute Name to drill down for more information.

NamePossible ValuesDescription
ConnectionID
UserDefined
(Required) Specifies a connection to a data source that is defined in the Settings. For elements connecting to relational databases, default is the first Connection element in _settings.lgx.
ID
UserDefined
The ID attribute is a pervasive attribute that uniquely identifies an element within a definition file. The ID needs to be a unique value within the definition.
IncludeTaskResultErrorMessage
True
False
Set this attribute to True in order to populate the ErrorMsg column in the list of Scheduler tasks. ErrorMsg is retrieved from failed tasks. If left blank then ErrorMsg will not be returned.
SchedulerApplicationID
UserDefined
The name of an application using the Scheduler. The developer may use this for any purpose, but should generally use it to store the name of the application using the Scheduler service. The value may be set when creating or updating Scheduler tasks. SchedulerApplicationIDs can be used to query, and are returned with the Datalayer.Scheduler element. The maximum length is 20 characters.
SchedulerCustomColumn1
UserDefined
This is a custom column that can be used for any purpose by the developer to track Scheduler tasks. The value may be set when creating or updating Scheduler tasks. Column1 and Column2 can be used to query, and are returned with the Datalayer.Scheduler element. The maximum length is 4000 characters.
SchedulerCustomColumn2
UserDefined
This is a custom column that can be used for any purpose by the developer to track Scheduler tasks. The value may be set when creating or updating Scheduler tasks. Column1 and Column2 can be used to query, and are returned with the Datalayer.Scheduler element. The maximum length is 4000 characters.
SchedulerRunAs
UserDefined
Sets the UserName that will be used when the scheduled task is executed. When there is a Security element in the _settings.lgx definition file, reports are by default run with the value set in the Security element's SchedulerUsername attribute. Alternatively, each scheduled item can run with a different Username and security rights by setting the SchedulerRunAs atribute. The maximum length is 50 characters.
SchedulerTaskID
UserDefined
The unique ID of a task in the Scheduler. IDs are created and returned when new Scheduler tasks are created.
SchedulerTaskName
UserDefined
The name of a Scheduler task. The developer may use this for any purpose, but should generally use it to store a readable name. The value may be set when creating or updating Scheduler tasks. TaskNames can be used to query, and are returned with the Datalayer.Scheduler element. The maximum length is 50 characters.



PARENT ELEMENTS

Click element to drill down for more information.

Analysis Chart
Crosstab Table
Data Calendar
Data List
Data Menu
Data Multi-Column List
Data Table
Data Tree
DataLayer.Cached
Email List
If Data Error
Input Checkbox List
Input Radio Buttons
Input Select List
Join
Json Data
Local Data
Lookup
Procedure.Data
Procedure.Run Datalayer Rows
Sparkline.Area
Sparkline.Bar
Sparkline.Line
Sparkline.WinLoss
Xml Data


CHILD ELEMENTS

Click element to drill down for more information.

Aggregate Column
Analysis Filter Insert
Calculated Column
Color Range Column
Color Spectrum Column
Compare Filter
Comparison Filter
Condition Filter
Contain Filter
Crosstab Filter
Data Layer Link
Data Layer Plugin Call
DeDuplicate Filter
Difference Column
File Column
Forecast.Current Time Period
Forecast.Regression
Forecast.Time Series Decomp
Formatted Column
Group Filter
HierarchicalLookup.SP
HierarchicalLookup.SQL
HierarchicalLookup.WebService
If Data Error
Join
Lookup
Lookup.SP
Lookup.SQL
Lookup.WebService
Moving Average Column
Percent of Total Column
Rank Column
RegEx Filter
Relevance Filter
Running Total Column
Security Filter
Sequence Column
Sort Filter
Switch Column
Time Period Column
UnCrosstab Filter
Unit Conversion Column
Unpivot


 Back to top


 Chart Debug