Versions Compared

Old Version 1

changes.mady.by.user Hannah Petty

Saved on

compared with

New Version 2

changes.mady.by.user Hannah Petty

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • There is one schedule record per row/line of the file;
  • The first row/line of the file must have the column names (a header row);
  • If you are using a comma-delimited-text file, each field (record value) must separated be separated by a comma;
  • If you are using a spreadsheet program such as Microsoft Excel to generate the CSV file, each field must reside in a different column;
  • Multiple values within a single field must be separated by a bar. For example, Mon|Wed|Fri to indicate multiple days of the week;
  • All fields must contain only UTF-8 ascii ASCII characters.

The column headers and field values are as follows; use UTF-8 ascii ASCII characters only:

Field NameDescription
Schedule-IDSystem Identifier for the schedule. This cell must be empty for new schedules and is only required if you are updating an existing schedule.
Term-NameName of the existing term associated with the schedule. Maximum 50 characters.
Course-NameName or Course ID of the existing course associated with the schedule.
Section-NameName of the existing section associated with the schedule.
TitleTitle to be given to the schedule being created (or updated). Maximum 200 characters.
DescriptionDescription to be given to the schedule being created (or updated). Maximum 1000 characters.
Campus-NameName of the existing campus associated with the schedule.
Building-NameName of the existing building associated with the schedule.
Room-NameName of the existing room where the scheduled capture is to take place.
RecurringIndicates whether the schedule is recurring or not. Valid values: TRUE and FALSE (not case sensitive).
Start-DateDate the schedule is to begin. Valid formats include yyyy-mm-dd and mm/dd/yy.
Start-TimeStart time for the scheduled capture. Enter in 24-hour format: hh:mm:ss

End-Time

OR

Duration

Can either be the time the scheduled capture must end OR the duration of the capture. Enter only one as follows:

    • Enter End-Time in 24-hour format: hh:mm:ss. For example 13:00:00 for 1pm.
    • Enter Duration (length of time) for the capture. To use Duration instead of End-Time be advised of the following:
      1. You MUST change the column header to Duration.
      2. You must enter an h to indicate hours, or an m to indicate minutes. Any number entered without an indicator is recognized as "seconds" by default.
      3. You can only enter a single unit of measure for each schedule, using either minutes OR hours OR seconds.
      For example:
      • To indicate a schedule lasting 50 minutes, enter 50m into the field.
      • For a schedule lasting an hour and a half, enter 90m in the field. Do NOT enter "1h 30m". Mixing units will cause the import to fail.
      • For a schedule lasting two hours, you could enter either 2h or 120m into the field.

NOTE: You cannot create a schedule longer than four hours. Any schedules longer than four hours will not be imported.

End-DateRequired only for recurring schedules. Date of the last day for the schedule. Valid format: yyyy-mm-dd or mm/dd/yy.
Days-of-Week

Required only for recurring schedules. Days that the scheduled capture must run.

Valid values are three-letter day abbreviations: sun, mon, tue, wed, thu, fri, sat, sun. Separate multiple values with a bar. For example, a Monday, Wednesday, Friday schedule is entered as mon|wed|fri.

Note
titleUse English Values for Days of the Week

You MUST use the English values for days as listed above. Using localized language versions for days of the week will cause the import to fail.

Excluded-Dates

Used for recurring schedules only but not required if not applicable. Specific dates or date range(s) when the schedule should not run. These might include exam dates for a course, school holidays, or spring break. Valid format: yyyymmdd for a single day; yyyymmdd-yyyymmdd for a range. Separate multiple entries with a bar.

For example, the entry: 20130218|20130324-20130331|20130506-20130510 would exclude February 18 (for President's Day), March 24-31 (for Spring Break), and May 6-10 (for final exams).

Status

Indicates the desired status for the schedule being created. Valid values (not case sensitive):

    • Draft - Schedule exists but will not run until activated.
    • Active - Schedule exists and will run according to configured parameters.
    • Complete - Schedule end-date has passed or is non-recurring and has already happened.
    • Trashed - Deletes the schedule from the system. Allows for bulk deletions of schedules. 

This field is required. For any record where Status is blank, that schedule will not be imported to the system.

Note
titleUse English Values for Status

You MUST use the English values for Status as listed above. Using localized language versions for the Status field will cause the import to fail.

Presenters

Identifies the presenters for the schedule. Typically this includes the Academic Staff member teaching the course, and possibly one or more Teaching Assistants. Separate multiple values with a bar. Valid formats include:

    • Email address - Email address is recommended as it is less prone to variation and error.
    • lastname:firstname
    • Username
Product-Group

Product Group Name for the schedule. To reduce the possibility of entry error, use one of the following two methods to enter this information:

    • Navigate to Configuration > Product Groups, select the name of the group you want to use, then copy the title of the group from the top of the page.
    • Perform an export of your existing schedules, and copy the desired Product Group information from the export.

Properties

 

Not required, but can be used to specify additional capture properties that are not indicated or are different from those provided through the Product Group defaults. Separate multiple properties/values with a bar. For example: Live=true|echo-initally-unavailable=false|Aspect-ratio-override-channel-1=widescreen

It does not matter what order the values are entered into this field.

Property values and formats are as follows:

  • live: Indicates if the schedule is set for live streaming. Valid values are True or False (not case sensitive). Sample entry: live=true. Setting to "true" means schedule will be streamed live if otherwise supported by the assigned room and product group.
  • Echoes-initially-unavailable: Use to mark the echoes captured by this schedule as initially unavailable. Valid values are True or False (not case sensitive). Sample entry: echoes-initially-unavailable=true. NOTE: If you are using Live streaming, do NOT mark this as "true".
  • aspect-ratio-override-channel-1: Specifies the aspect ratio to use for channel 1 (Primary Display/Secondary Video). Applicable for SCHD captures only. Sample entry: aspect-ratio-override-channel-1=widescreen. Valid values are Standard or Widescreen (not case sensitive).
    Standard aspect ratio for display and video = 4:3. Widescreen aspect ratio for video = 16:9. Widescreen aspect ratio for display = 16:10.
  • Aspect-ratio-override-channel-2: Specifies the aspect ratio to use for channel 2, (Primary Video/Secondary Display). Applicable for SCHD captures only. Sample entry: aspect-ratio-override-channel-2=widescreen. Valid values are Standard or Widescreen (not case sensitive).
  • Display-input-resolution-override: Specifies the resolution to be used for non-SCHD captures that capture Display input (not applicable for audio/video-based captures). Sample entry: display-input-resolution-override=1280x720. Valid values are:
    • 800x600
    • 1024x768
    • 1280x720
    • 1280x768
    • 1280x800
    • 1280x1024
    • 1366x800
    • 1440x900
    • 1600x1200
    • 1680x1050

...