Element Details: Procedure.Scheduler+Update+Task
 Back


Available in: Logi Info Source code name: Procedure.SchedulerUpdateTaskIntroduced in: v9.5.14

Updates an existing task in the scheduler. If the ScheduleXml sets a valid schedule, the task will be rescheduled to run at the next appropriate time.

Element Group:Task Scheduler



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
(Required) 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.
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.
SchedulerProcessUrl
UserDefined
SchedulerProcessUrl specifies the full URL of the Logi Info application that will run the scheduled task. The URL should specify the folder that contains the rdProcess.aspx file. For example: http://myWebServer/myApplcation The default value is the URL used to access the current web application.
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.
SchedulerSessionVariables
UserDefined
Set this attribute to pass session state to the scheduled task. The value may be set when creating or updating scheduler tasks, or in the Report Center Menu element. Specify a comma separated list of session variables that should be resolved and saved with the scheduled task. Before the task is eventually run by the scheduler, these variables along with their values are added to that session.
SchedulerTaskDisabled
True
False
When “True” the task will be disabled so that it is not run by the Scheduler's timer.
SchedulerTaskID
UserDefined
(Required) 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.
ScheduleXml
UserDefined
An XML string that represents a schedule. ScheduleXml specifies the schedule that initially appears. It may hard-coded to a specific value, or retrieved from a DataLayer.Scheduler, or passed in from a Report definition that has a Schedule element. To retrieve from a DataLayer, create a LocalData element with DataLayer.Scheduler below. Set the SchedulerTaskID to the ID of an existing scheduled task. Then set the ScheduleXml attribute to “@Local.ScheduleXml~” To hard-code the schedule, set the attribute ShowScheduleXml=”True”, then run the report. Make changes to the schedule with the Schedule element interface and see how the ScheduleXml is updated. Copy and paste the schedule xml text from the interface into the ScheduleXml attribute. Then set ShowScheduleXml back to “False”. To get the value from a Report definition into a Process definition, set ScheduleXml to a @Request token with the ID of the Report's Schedule element.



PARENT ELEMENTS

Click element to drill down for more information.

Procedure.Else
Procedure.File Exists
Procedure.Folder Exists
Procedure.If
Procedure.Run Datalayer Rows
Procedure.Run DataTable Rows
Procedure.Switch Case
Procedure.Switch Else
Task


CHILD ELEMENTS

Click element to drill down for more information.

If Error Target.Process


 Back to top


 Chart Debug