Introduction
Once a Schedule has been created, it can be managed in the Schedule Management Activity.
All schedules will show, and will mainly be Reports and Half Hourly data.
The Activity has three sections:
- Schedule List
- Schedule Log
- Running Schedules
For each Schedule in the list, you can:
- Edit
- Delete
- View Schedule
- Run
- View the Run History
Opening Schedule Management
To open the Activity, click on the Schedule Management Activity
Schedule List section
This section shows:
- The name of the Schedule
- The date is was last run
- The date is is due to run next
- The type, ie Daily or Monthly
- The Run Status
- Whether the Schedule is Active
- Whether the Schedule has an end date
Available Columns
There are 7 columns available. These can be added/hidden by clicking on the downward arrow on the Column Header > clicking Columns and ticking or unticking
- Name
- Last Run Date
- Next Run Date
- Type
- Last Run Status
- Active
- End
List Options
There are three options at the top of the Activity:
Include run once? - tick to include Schedules there were only set to run once (for instance, when running a Report to the Document Library)
Include inactive? - tick to include Schedules that have been ended (for instance, a Report that is not longer required)
Run History - Highlight a Report to view the run history, ie all the times/dates the report has run. This option is also available by right clicking on the report. For more information, see below
Right Click Options
Right click on a Schedule, and you have the following options:
- Edit
- Delete Item
- Show Schedule
- Run Now
- Run History
Edit
Right click > Click Edit
This allows you to view/edit the details of the Schedule such as the Name, Description, Configuration, Email Address, File Format, etc.
If any changes are made, click OK
Alternatively, click Cancel to return to the Schedule Management Activity
Delete
Right click > Delete
This will delete the Schedule are remove it from the list
View Schedule
Right click > Show schedule
This will show the next 25 occurrences
Click OK to return to the Schedule Management Activity
Run Now
Right click > Run Now
This will run the Schedule. For example, you may have a Schedule to import your Half Hourly data. The report is set to collect the date on the 1st of the month, but the data hadn't wasn't sent to the email account until the 2nd. Instead of waiting for Sigma to import it the following month, click Run Now and the Schedule will be run immediately.
View the Run History
Right click > Run History
This will open the Run History for Schedule Editor showing a list of each time the Schedule has run in the last six months.
See below for more details.
Available Columns
There are 16 columns available. These can be added/hidden by clicking on the downward arrow on the Column Header > clicking Columns and ticking or unticking
- Importer
- Run Start Date
- Run End Date
- Duration
- Error Log
- Schedule Status
- Item Type
- File Transfer Duration
- File Transfer End Time
- Data Store Duration
- Total Files
- Failed Files
- Successfully Loaded Files
- Partially Loaded Files
- Duplicate Files
- Total File Size
Run History
Once you have opened the Run History for Schedule Editor, you have 5 options
- Filter
- Refresh
- Run Details
- Download Error
- Log
- Export
Filter
Click Filter to show at the top of the screen. Start to type a word and the filter will start working. For example, if you put an Y in the Error Log filter, you will only see Runs that have had an error.
Refresh
Click Refresh to refresh the popup
Run Details
If the Schedule has been successful, select a line and click Run Details to show the Run Details pop up
Again, there is a Filter and a Refresh button.
Diagnostics
This will give you an explanation of what hasn't worked and why.
There are four status options:
- Success - if all data in the file loaded as expected
- Failed - if no data could be loaded
- Partial - if some but not all of the data was imported
- Duplicate - if the same file has already been loaded
Highlight the line and click Diagnostics to see a breakdown of the content of the file
Each line details the Item Name (for example the Channel name), the Item Type, Earliest and Latest data from the File and the Site Name.
Click to open the Channel Editor
Click to export the data
Click Cancel, and Cancel again to return to the Run History
Download Error Log
If a Schedule has not been successful, ie in the Schedule Status it shows as Failure, you can see the details of the failure by clicking on Download Error Log.
Highlight the line > click Download Error Log
A text file will show the reason for the error
Export
Click Export to export the list to Excel
Schedule Log section
The Schedule Log section will show details of the last Schedules run, giving the time, and message details
Running Schedules section
The Running Schedules section will show any Schedules that are currently running.