SQL Scheduler Setup

1. Initial Setup
2. Processes
   1. View Processes
   2. Add/Edit Process
      1. Purge Execution History
   3. View Process Detail
3. Schedules
   1. View Schedules
   2. Add/Edit Schedule
      1. Purge Execution History
   3. View Schedule Detail
4. Instances
   1. View Instances
   2. Add/Edit Instance
   3. View Instance Detail

Initial Setup

Doyle ITS SQL Scheduler relies upon the DotNetNuke Scheduler service to perform the work of executing and re-scheduling processes. It is recommended that the Scheduler use Timer Mode, not Request Mode. To verify, log in as the Super User (host) account, go to Host -> Host Settings, the look under Advanced Settings -> Other Settings, and confirm the value in the Scheduler Mode drop-down list.

On installation, Doyle ITS SQL Scheduler registers schedule information with the DotNetNuke Scheduler. This information can be modified by going to Host -> Schedule, and configuring the Doyle ITS SQL Scheduler Client entry.

Processes

A Process is a SQL statement or stored procedure call than is executed one or more times, at predetermined times. The statement is executed within the DotNetNuke database. Unless you have configured access to linked servers or other databases on the same server, the statement will only affect the DotNetNuke database.

View Processes

The initial display shows all processes configured within the module.

• Enabled/Disabled - The options here allow you to filter the list of processes - Enabled (processes which can run), Disabled (processes which cannot run), and All (both Enabled and Disabled processes)
• The process grid displays top-level information about the processes:
  • Process is the name of the process
  • Schedules is the count of schedules (occurrences) configured for the process
  • Enabled indicates whether the process is enabled
  • Updated is the date on which the process was last updated
  • allows you to view the details of the process
  • allows you to edit the process, if you are authorized
  • allows you to view the list of configured schedules for the process
• Add Process - Click to create a new process

Add/Edit Process

The Add/Edit Process page allows you to create or update a process. Future execution instances of the process will incorporate the changes.

• Process ID - The process database identifier. This will not be displayed until a new process is saved.
• Name - The process name. To prevent confusion, this should be meaningful
• Is Enabled - Select whether the process is enabled (runnable)
• SQL Statement - The SQL statement or stored procedure that will be executed. This should be tested manually prior to scheduling

Purge Execution History

This feature allows you to clear the execution history (instances) of all schedules for the current process

• Status - The status (Pending or Completed) of the instances to purge.
• Result - The result (Succeeded or Failed) of the instances to purge

View Process Detail

The process detail reveals all information about a process. Above the process name is a breadcrumb, which provides navigation 

• Process ID - The process database identifier
• Enabled - Indicates whether the process is enabled (runnable)
• SQL Statement - The SQL statement that will be executed for that process
• Enabled Schedules - Count of enabled (runnable) schedules for that process
• Disabled Schedules - Count of disabled (non-runnable) schedules for that process
• Total Schedules - Count of all schedules, both enabled and disabled for that process
• Created Date - The date on which the process was created
• Created By - The user who created the process
• Updated Date - The date on which the process was last updated
• Updated By - The user who last updated the process
• Schedules - Click to view the list of schedules for that process
• Edit/Edit Process - Click to edit the process, if you are authorized
• Add Schedule - Click to create a new schedule, if you are authorized

Schedules

A Schedule is a predetermined recurrence for a Process. A process can have any number of schedules, which can have a wide variety of frequencies.

View Schedules

The display shows all schedules configured for the previously-selected process.

• Enabled/Disabled - The options here allow you to filter the list of schedules - Enabled (schedules which can run), Disabled (schedules which cannot run), and All (both Enabled and Disabled schedules)
• Status - The options here allow you to filter the list of schedules by status - Active (the current date is within the schedule's Effective and Expires date), Pending (the current date is before the schedule's Effective date), Expired (the current date is after the schedule's Expires date), and All (Active, Pending, and Expired schedules) 
• The schedule grid displays top-level information about the schedules:
  • Schedule is the name of the schedule
  • Status is the status of the schedule (current date in relation to the Effective and Expires dates) 
  • Type is the frequency type of the schedule
  • Frequency is the actual frequency, relative to the frequency type, of the schedule
  • Effective is the date on which the schedule is able to run
  • Expires is the date as of which the schedule is no longer able to run
  • Next Execution is the date on which the schedule is to next run
  • Enabled indicates whether the process is enabled
  • Updated is the date on which the process was last updated
  • allows you to view the details of the process
  • allows you to edit the process, if you are authorized
  • allows you to view the list of instances for the schedule
• Add Schedule - Click to create a new schedule

Add/Edit Schedule

The Add/Edit Schedule page allows you to create or update a schedule. Future execution instances of the schedule will incorporate the changes.

• Process ID - The process database identifier to which this schedule belongs. 
• Process Name - The process name to which this schedule belongs 
• Schedule ID - The schedule database identifier. This will not be displayed until a new schedule is saved.
• Schedule Name - The schedule name. To prevent confusion, this should be meaningful
• Is Enabled - Select whether the schedule is enabled (runnable)
• Frequency Type - The frequency type, which determines how often the schedule elapses. This can be Hourly, Daily, Weekly, Weekdays, and Monthly
• Frequency - The frequency, which determines how often the schedule elapses, relative to the frequency type
• Days Of Week - Check-boxes for every weekday on which the schedule is to run, if the frequency type is Weekdays
• Effective Date - The date on which the schedule can begin to run 
• Expiration Date - The date on which the schedule can no longer run
• Execution Time - The time at which the schedule is to run
• Next Scheduled Date - The date on which the schedule will next run

Purge Execution History

This feature allows you to clear the execution history (instances) of this schedule

• Status - The status (Pending or Completed) of the instances to purge.
• Result - The result (Succeeded or Failed) of the instances to purge

View Schedule Detail

The schedule detail reveals all information about a schedule. Above the schedule name is a breadcrumb, which provides navigation 

• Process ID - The process database identifier to which the schedule belongs
• Process - The process name to which the schedule belongs
• Schedule ID - The schedule database identifier
• Schedule Status - The status of the schedule (current date in relation to the effective and expiration date)
• Is Enabled - Indicates whether the schedule is enabled (runnable)
• Frequency Type - The frequency type, which determines how often the schedule elapses
• Frequency - The frequency, which determines how often the schedule elapses, relative to the frequency type
• Effective Date - The date on which the schedule can begin to run 
• Expiration Date - The date on which the schedule can no longer run
• Execution Time - The time at which the schedule is to run
• Next Scheduled Date - The date on which the schedule will next run
• Created Date - The date on which the process was created
• Created By - The user who created the process
• Updated Date - The date on which the process was last updated
• Updated By - The user who last updated the process
• Instances - Click to view the list of instances for that schedule
• Edit/Edit Schedule - Click to edit the schedule, if you are authorized
• Add Instance - Click to create a new ad hoc instance, if you are authorized

Instances

An instance is a pending or completed execution of a process, as determined by a schedule.

View Instances

The display shows all instances pending or completed for the previously-selected process and schedule.

• Enabled/Disabled - The options here allow you to filter the list of instances - Enabled (instances which can run), Disabled (instances which cannot run), and All (both Enabled and Disabled instances)
• Status - The options here allow you to filter the list of instances by status - Pending (the scheduled execution time has not elapsed), Started (the scheduled execution has started), Completed (the scheduled execution has completed), and All (Panding, Started, and Completed instances) 
• The instance grid displays top-level information about the instances:
  • Ad Hock indicates whether the instance was user- or system-generated 
  • Status indicates the instance status 
  • Scheduled is the date on which the instance was scheduled to execute 
  • Started is the date on which the instance began execution
  • Ended is the date on which the instance completed execution
  • Result indicates whether the execution completed successfully or failed
  • Enabled indicates whether the instance is enabled (runnable)
  • Updated is the date on which the instance was last updated
  • allows you to view the details of the instance
  • allows you to edit the instance, if you are authorized and the instance is pending
• Add Instance - Click to create a new ad hoc instance

Add/Edit Instance

The Add/Edit Instance page allows you to create an ad hoc instance or update a pending instance.

• Process ID - The process database identifier to which this instance belongs. 
• Process Name - The process name to which this instance belongs.
• Schedule ID - The schedule database identifier to which this instance belongs. 
• Schedule Name - The schedule name to which this instance belongs. 
• Instance ID - The instance database identifier. This will not be displayed until a new instance is saved.
• Scheduled Date - The date on which the instance ad hoc will execute.
• Scheduled Time - The time at which the instance ad hoc will execute.
• Status - The status of the instance.
• Is Ad Hoc - Indicates whether the instance is ad hoc (user-generated).
• SQL Statement - The SQL statement that was or will be executed, taken as a snapshot from the process
• Is Enabled - Select whether the instance is enabled (runnable)
• Process Started - The date on which execution started
• Process Ended - The date on which execution completed
• Is Successful - Indicates whether the instance completed successfully

View Instance Detail

The instance detail reveals all information about an instance. Above the instance name is a breadcrumb, which provides navigation 

• Process ID - The process database identifier to which the instance belongs
• Process - The process name to which the instance belongs
• Schedule ID - The schedule database identifier to which the instance belongs
• Schedule Name - The schedule name to which the instance belongs
• Instance ID - The instance database identifier
• Status - The status of the instance (whether the instance has executed)
• Is Ad Hoc - Indicates whether the instance is user- or system-generated
• SQL Statement - The SQL statement that was or will be executed, taken as a snapshot from the process
• Is Enabled - Indicates whether the instance is enabled (runnable)
• Process Started - The date on which execution started
• Process Ended - The date on which execution completed
• Is Successful - Indicates whether the instance completed successfully
• Edit Instance - Click to edit the instance, if you are authorized and the instance is pending