How can we help?

My Cases

Imports: Schedule V2
Last Updated: Feb 18, 2019 11:30AM EST

This article applies to:  Echo360 Admins

Version 2 Schedule Imports work very much like Version 1 Schedule imports, except that you can now use the "Name" for objects in the import fields rather than the ID. Because the Name is often only unique in combination with other fields however, the fields requested in the Version 2 (V2) Schedule import are slightly different, and there are more of them. For example, Room Name is not necessarily unique by itself, but in combination with Campus Name and Building Name, it is. Section Name is also not necessarily unique except within a specified Term and Course. This means that these additional fields are required in the V2 Schedule Import.

The only time you MUST use the system-generated ID in a V2 Schedule import is on Update; the Update import must include the UUID for the Schedule you want to change. Requiring the UUID allows you to use the Update to change the External ID for the schedule if necessary.

The other major difference between a V1 and V2 Schedule import is that External ID is now REQUIRED for each schedule. If your schedules do not already have them, you will need to create or add them in order to use the V2 Import.

Schedule Delete imports can use either the UUID for the schedule OR the External ID for the schedule. Both are unique values for a schedule.

Generating a Version 2 Schedule Export provides all the data you need for an import. Simply change the field values where needed then re-import. This is another change from V1 to V2; V2 exports are identical in structure (same fields, same order) as the correlated import. NOTE that if you are using a V2 Schedule Export to generate a V2 Create-Schedule import, you must REMOVE THE ID field; new IDs are created with each new schedule.

IMPORTED FILES MUST HAVE ALL FIELDS/COLUMNS REQUESTED: If the Update-import example contains a field, you should include that field in the final import, even if you are not making changes to the values for that field. As cited in the Update Schedule section below, if a value is blank for an optional field, any value that currently exists for that item is removed. Similarly, if the FIELD itself is missing from the import file for an optional field, that value will be removed from ALL of the items in the update file. If the field is required but the column or a value is missing, the import will generate an error, either for the whole import or for the row missing the required value.

Create Schedule

Download a sample CSV file and enter the values for your new sections into the fields provided. Then import your new file. Alternately you can perform a Schedule export, copy the relevant data (do not copy the Schedule ID; a new one is created for the new schedule) and make changes to the data in each row to generate new schedules. Be SURE to generate a Version 2 Export to create a Version 2 Import.

You must use Name for the fields in the import; you cannot use ID. If you want to use ID for the objects in the import, use a Version 1 Schedule Import.

As with all CSV Imports, multiple values in a single field must be separated with semi-colons (;). For example, multiple days in a recurring schedule would be listed as MO;WE;FR, separating each day with a semi-colon.

For the Availability field, separate the parameter from its value using a bar (|). For example, a relative delay of 5 days in a capture's availability would be entered as relative|5. For a concrete availability date (non-recurring captures only), the field entry would be concrete|2019-04-12. Concrete availability dates use the yyyy-mm-dd format used by all dates in the import. For tips on how to format dates in a spreadsheet program and KEEP them properly formatted, see Formatting Dates for CSV Imports.

Creating Schedules that publish to multiple sections

Here's a tricky bit when it comes to the V2 Schedule Import. The Version 1 Schedule Create import uses the system generated Section ID to identify the section to publish to. This allows for the entry of multiple sections into the field (separated by semi-colons) and could therefore identify multiple sections to publish the capture schedule's generated captures to. However the V2 Create Schedule import uses Section Name, and using Section Name requires the use of Term Name and Course ID in addition to Section Name to uniquely identify the section. This eliminates the ability to identify more than one section per row of the import.

THIS is where the required External ID field comes in.

Once you establish a new External ID for a capture schedule you are creating, you can USE that External ID on subsequent rows of the Import in order to identify additional sections (and their associated availability) for this one capture schedule to publish to. In order to work this way, the External ID needs to be established in the same Create spreadsheet where the additional section-identifying rows are provided. The first instance of the External ID and the new capture schedule is considered the "master" and MUST contain all of the necessary field data for a new capture schedule. To identify additional sections for publishing, the ONLY fields that need to be completed are the External ID (same as the master) and the Publishing information (Term, Course ID, Section Name, and Availability).

If you try to use an External ID that already exists when the import is performed, the row will error out as the ID is not unique. You cannot UPDATE based on External ID; to update a schedule you must use the system generated Schedule ID, and an Update-type import.
 

Field Name Description Example
External ID (required) An External Identifier for the Capture Schedule. Can be used in place of the Schedule ID for Deletes via CSV import.
Is ALSO used for creating capture schedules that publish to multiple sections, as described above.
This ID MUST BE UNIQUE. You can make it any value you like, but it must uniquely identify this capture schedule. We recommend using only UTF-8 characters however.
CHEM103_SPR2019_MWF
Name (optional) Name or title of the capture schedule you are creating.
All captures generated from this schedule will also have this name.
Often this is also the name of the course/section for which the capture schedule is being created (if applicable).
CHEM-101 or Wednesday Special Lecture
Start Date (required) Start date for capture schedule in format YYYY-MM-DD 2019-01-15
Start Time (required) Start time for the capture (to the minute) in ISO 8601 (24-hour) Time format HH:MM 09:00 or 14:30 (for 2:30pm)
End Time (required) End time for the capture (to the minute) in ISO 8601 (24-hour) Time format HH:MM 09:50 or 16:00 (for 4pm)
End Date (optional) End date for capture in Date format YYYY-MM-DD.
Required for recurring captures. LEAVE BLANK if capture schedule is NOT recurring.
2019-04-30
Days of Week (optional) Days the recurring capture should occur: SU, MO, TU, WE, TH, FR, SA. 
Required for recurring captures (an End Date is specified).
MO;WE;FR
Separate multiple values with a semi-colon
Exclusion Dates (optional) Dates a recurring capture should not occur in format YYYY-MM-DD.
If publishing to a section, these are in addition to exclusion dates for the section's term.
2019-02-21;2019-04-19
Separate multiple values with a semi-colon
Campus Name (required) The Name of the Campus where the room where the capture will take place is configured Main Campus
Building Name (required) The Name of the Building where the room where the capture will take place resides. Taylor Hall
Room Name (required) The Name of the Room where the capture will take place.
Note that the Room also identifies the capture appliance that will be used to generate the capture.
TH-131 or Taylor Auditorium
Presenter (optional) Email address of the instructor for the capture; becomes the owner for all captures generated by this schedule.
If no Presenter provided, capture owner will be None. An admin can assign ownership later if necessary.
jdowling@myuniversity.edu
Guest Presenter (optional) Name of any guest instructor or presenter for this capture who should be associated with this schedule but who may not have an account. Dr. Michio Kaku; Dr. P. Venkman
Term Name (optional) Name of the Term in which the section to be published to exists.
Required if you are auto-publishing completed captures from this schedule.
Spring 2019
Course Identifier (optional) The Course ID in which the section to be published to exists.
Required if you are auto-publishing completed captures from this schedule.
CHEM-1XX
Section Name (optional) Name of the Section to which you are publishing the captures generated by this schedule. 
Required if you are auto-publishing completed captures from this schedule.
CHEM-103
Availability (optional) Defines an availability setting for student access to the completed capture if published. Valid availability values include: immediateunavailablerelative, or concrete.
If left blank, availability defaults to Immediate.
For Relative, include a bar (|) and the number of days to delay after completion that each capture is to be made available to students.
For Concrete, include a bar (|) and the date on which the completed capture is to be made available to students. ONLY available for non-recurring capture schedules.
For Unavailable, the completed captures are published but not visible to students until an instructor or administrator manually makes them available.
immediate  or
relative|5  or
concrete|2019-03-13  or
unavailable
Should Caption (optional) Boolean value for whether the capture should be captioned.
Defaults to False (not captioned) if left blank.
Valid values: True, False
Should Stream Live (optional) Boolean value for whether the capture should be streamed live
Defaults to False (not streamed live) if left blank.
Valid values: True, False
Input 1 (optional) Identifies the input type to be captured through Channel 1 
NOTE: This field is for visual input identifier only; audio is always captured. If both input fields are left blank, the resulting capture will be audio-only.
Valid values: video, display, altvideo
(altvideo is for SCHD only)
Input 2 (optional) Identifies the input type to be captured through Channel 2
NOTE: This field is for visual input identifier only; audio is always captured. If both input fields are left blank, the resulting capture will be audio-only.
Valid values: video, display, altvideo
(altvideo is for SCHD only)
Capture Quality (optional) Quality setting for the capture output. Currently this will be the SAME setting used for the Live stream if the capture is set for live streaming.
Defaults to High if left blank.
Valid values: medium, high, highest
Stream Quality (optional) Quality of the live stream if Should Stream Live is set to "true" **SEE NOTE BELOW** Valid values: medium, high, highest **SEE NOTE BELOW**

Live Stream Quality is CURRENTLY the same as Capture Quality: The Live Stream Quality field appears in both the CSV Import as well as in the Public API, but is a placeholder for the FUTURE ability to set Live Stream quality (not yet implemented). For now, the Live Stream Quality is always the same as the configured Capture Quality regardless of what value is entered in this field.
IF you are having problems streaming Live captures, set your Capture Quality to Medium for captures that are also to be streamed live. This will reduce the size and bitrate of the stream. Also, be aware the both the PRO and POD devices stream lower bitrates than SCHD.

Update Schedule

Generate a V2 Schedule Export, then select and update the necessary information for the import file. Then import your new file.

Removing or Appending Field Values on update

Since you can use the V2 Export file for your V2 Update-type Import (with altered values), we expect that you will retain any values you do not want to change. This is important because the CSV Import cannot do partial updates to records (called a PATCH in API terminology); updates done are "PUT" calls meaning ALL fields are updated based on the values provided. This means that for updates:

  • To REMOVE the value(s) for a field where the value is optional, remove the existing value and leave the field blank.
    • If the value is required and the field is blank, the row will be rejected.
    • If the value is optional and the field is blank, the value will be removed from the object's properties.
    • If the value is optional and the field is missing (the column is not resident) from the import, that value will be removed from ALL of the items in the update.
  • To REPLACE the value for a field, remove the existing value and replace it with the new/updated value.
  • To APPEND the values in a field where multiple values are allowed, retain the existing values but add the new values into the field (separating with a semi-colon).
Field Name Description Example
ID The system generated ID for the capture schedule you want to update. f4c464be-dc8-43a3-a748-00345b90ac6d
External ID (required) An External Identifier for the Capture Schedule. Can be used in place of the Schedule ID for Deletes via CSV import.
Is ALSO used for creating capture schedules that publish to multiple sections, as described above.
This ID MUST BE UNIQUE. You can make it any value you like, but it must uniquely identify this capture schedule. 
CHEM103_SPR2019_MWF
Name (optional) Name or title of the capture schedule you are creating.
All captures generated from this schedule will also have this name.
Often this is also the name of the course/section for which the capture schedule is being created (if applicable).
CHEM-101 or Wednesday Special Lecture
Start Date (optional) Start date for capture schedule in format YYYY-MM-DD 2019-01-15
Start Time (optional) Start time for the capture (to the minute) in ISO 8601 (24-hour) Time format HH:MM 09:00 or 14:30 (for 2:30pm)
End Time (optional) End time for the capture (to the minute) in ISO 8601 (24-hour) Time format HH:MM 09:50 or 16:00 (for 4pm)
End Date (optional) End date for capture in Date format YYYY-MM-DD.
Required for recurring captures. LEAVE BLANK if capture schedule is NOT recurring.
2019-04-30
Days of Week (optional) Days the recurring capture should occur: SU, MO, TU, WE, TH, FR, SA. 
Required for recurring captures (an End Date is specified).
MO;WE;FR
Separate multiple values with a semi-colon
Exclusion Dates (optional) Dates a recurring capture should not occur in format YYYY-MM-DD.
If publishing to a section, these are in addition to exclusion dates for the section's term.
2019-02-21;2019-04-19
Separate multiple values with a semi-colon
Campus Name (optional) The Name of the Campus where the room where the capture will take place is configured Main Campus
Building Name (optional) The Name of the Building where the room where the capture will take place resides. Taylor Hall
Room Name (optional) The Name of the Room where the capture will take place.
Note that the Room also identifies the capture appliance that will be used to generate the capture.
TH-131 or Taylor Auditorium
Presenter (optional) Email address of the instructor for the capture; becomes the owner for all captures generated by this schedule.
If no Presenter provided, capture owner will be None. An admin can assign ownership later if necessary.
jdowling@myuniversity.edu
Guest Presenter (optional) Name of any guest instructor or presenter for this capture who should be associated with this schedule but who may not have an account. Dr. Michio Kaku; Dr. P. Venkman
Term Name (optional) Name of the Term in which the section to be published to exists.
Required if you are auto-publishing completed captures from this schedule.
Spring 2019
Course Identifier (optional) The Course ID in which the section to be published to exists.
Required if you are auto-publishing completed captures from this schedule.
CHEM-1XX
Section Name (optional) Name of the Section to which you are publishing the captures generated by this schedule. 
Required if you are auto-publishing completed captures from this schedule.
CHEM-103
Availability (optional) Defines an availability setting for student access to the completed capture if published. Valid availability values include: immediateunavailablerelative, or concrete.
If left blank, availability defaults to Immediate.
For Relative, include a bar (|) and the number of days to delay after completion that each capture is to be made available to students.
For Concrete, include a bar (|) and the date on which the completed capture is to be made available to students. ONLY available for non-recurring capture schedules.
For Unavailable, the completed captures are published but not visible to students until an instructor or administrator manually makes them available.
immediate  or
relative|5  or
concrete|2019-03-13  or
unavailable
Should Caption (optional) Boolean value for whether the capture should be captioned.
Defaults to False (not captioned) if left blank.
Valid values: True, False
Should Stream Live (optional) Boolean value for whether the capture should be streamed live
Defaults to False (not streamed live) if left blank.
Valid values: True, False
Input 1 (optional) Identifies the input type to be captured through Channel 1 
NOTE: This field is for visual input identifier only; audio is always captured. If both input fields are left blank, the resulting capture will be audio-only.
Valid values: video, display, altvideo
(altvideo is for SCHD only)
Input 2 (optional) Identifies the input type to be captured through Channel 2
NOTE: This field is for visual input identifier only; audio is always captured. If both input fields are left blank, the resulting capture will be audio-only.
Valid values: video, display, altvideo
(altvideo is for SCHD only)
Capture Quality (optional) Quality setting for the capture output. Currently this will be the SAME setting used for the Live stream if the capture is set for live streaming.
Defaults to High if left blank.
Valid values: medium, high, highest
Stream Quality (optional) Quality of the live stream if Should Stream Live is set to "true" **SEE NOTE BELOW** Valid values: medium, high, highest **SEE NOTE BELOW**

Live Stream Quality is CURRENTLY the same as Capture Quality: The Live Stream Quality field appears in both the CSV Import as well as in the Public API but is a placeholder for the FUTURE ability to set Live Stream quality (not yet implemented). For now, the Live Stream Quality is always the same as the configured Capture Quality regardless of what value is entered in this field.
IF you are having problems streaming Live captures, set your Capture Quality to Medium for captures that are also to be streamed live. This will reduce the size and bitrate of the stream. Also, be aware the both the PRO and POD devices stream lower bitrates than SCHD.

Delete Schedule

Generate a Schedule Export, then select and copy the rows for the sections you want to delete into a new file for the Delete-action import. You can retain additional fields in the file; all except ID are ignored. Then import your new file.

Field Name Description Example
ID (required) System ID or External ID of the schedule being deleted 69324a-315-4de-8dg-g75d42  or
CHEM103_SPR2019_MWF
c9f5f1d87ac29bd0c146e9565da3c739@echo360.desk-mail.com
https://cdn.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete