For the Brightspace Learning Repository Bulk Upload utility, setup files are text files placed in the input directory. Once a setup file is processed, it is moved to the output directory. Assets and other files remain in the input directory.
Each setup file begins with a line that denotes the type of setup file, followed by one or more lines pointing to the asset files or content packages to import. Optionally, you can include a line pointing to an external metadata file or specify metadata to apply during import (depending on the type of setup file used).
There are three different types of setup files you can create:
-
Type 1: Upload content packages containing internal metadata
-
Type 2: Upload assets or content packages with external metadata in an XML file
-
Type 3: Upload assets or content packages and apply metadata based on information in the setup file
Each type uses a different format for the lines pointing to import files. You cannot combine these types in a single file; all lines pointing to a file to upload must be in the same format, identified at the beginning of the file.
Note the following:
-
The utility doesn’t perform “asset scanning” during upload. If you upload an HTML file as an asset via a Type 2 or Type 3 setup file, links to images or other internal components do not work; only the HTML file is uploaded. The same applies to HTM, JS, and INC files.
-
You can insert comments in a setup file by starting a line with // (double slash).
-
The utility ignores empty lines and all other whitespace in set-up files.
Type 1: Content package with internal metadata
First line: LoadType=Package
Subsequent lines: <repository ID>, <path to file>
Fields to include:
-
<repository ID> - The repository ID that the object should be created in. IDs are displayed on the LOR Properties page under Admin Tools > Manage Repositories > Repository name > ID.
-
<path to file> - The path and file name for the file to upload. Files must be SCORM 1.2 compliant content packages.
Example
LoadType=Package
2,"\\myserver\BulkUpload\input\package1.zip"
2,"\\myserver\BulkUpload\input\package2.zip"
1,"\\myserver\BulkUpload\input\package3.zip"
Type 2: Asset or content package with external metadata
First line: LoadType=XMLMetadata
Subsequent lines: <repository ID>, <path to file>, <path to metadata>
Fields to include:
-
<repository ID> - The repository ID that the object should be created in. IDs are displayed on the LOR Properties page under Admin Tools > Manage Repositories > Repository name > ID.
-
<path to file> - The path and file name for the file to upload. Files can be SCORM 1.2 compliant content packages or individual asset files.
-
<path to metadata> - The path and file name for the metadata file to use. Metadata files must be IMSMD 1.2.1 compliant XML files.
Note: If you import a content package this way, any metadata in the package is discarded and the metadata in the external file is used exclusively.
Example
LoadType=XMLMetadata
3,"\\myServer\BulkUpload\input\package10.zip","\\myServer\BulkUpload\metadata1.xml"
6,"\\myServer\BulkUpload\input\asset15.gif","\\myServer\BulkUpload\metadata2.xml"
Type 3: Asset or content package with metadata in set-up file
First line: LoadType=CSVMetadata
Subsequent lines: <repository ID>, <path to file>, <title>, <description>, <keyword>, <contributor role>, <contributor first name>, <contributor last name>, <format>
Fields in a type-3 set-up file:
-
<repository ID> - The repository ID that the object should be created in. IDs are displayed on the LOR Properties page under Admin Tools > Manage Repositories > Repository name > ID.
-
<path to file> - The path and file name for the file to upload. Files can be SCORM 1.2 compliant content packages or individual asset files.
-
<title> - The value for the IMSMD field general.title.
-
<description> - The value for the IMSMD field general.description.
-
<keyword> - The value for the IMSMD field general.keyword (single keyword only).
-
<contributor role> - The value for the IMSMD field lifecycle.contribute.role*.
-
<contributor first name> - The value for the IMSMD field lifecycle.contribute.entity*.
-
<contributor last name> - The value for the IMSMD field lifecycle.contribute.entity*.
-
<format> - The value for the IMSMD field technical.format.
* The role, first name, and last name are wrapped into a single lifecycle.contribute element.
Note the following:
-
Enclose all metadata values in double or single quotes, especially if the value contains a comma, an apostrophe, or quotation marks. In the latter two cases, be sure to use the type of punctuation to enclose the value that is not used in the value itself; you can use a single quote or apostrophe in the value if you enclose the string in double quotes, and you can use double quotes in the value if it is enclosed in single quotes.
-
Any metadata in a content package is discarded and the metadata specified in the setup file is used exclusively.
-
All metadata values are optional and can be left empty (see the example).
Example
LoadType=CSVMetadata
2,"\\myServer\BulkUpload\input\Asset12.gif","Pomegranate","Photograph of a pomegranate","fruit",,
"Jonathan","Bernstein",
6,"\\myServer\BulkUpload\input\Asset27.mp3","L'inno di Mameli","Italian National Anthem","Italy","Composer","Michele","Navaro",
3,"\\myServer\BulkUpload\input\Asset21.wmv",'"Beat" Takeshi Kitano',,"movies",,,,
Note: The third object in this example uses single quotes around the title so that double quotes can be used in the value.