Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
spec
.gitignore
.hound.yml
.rubocop.yml
.ruby-version
.travis.yml
Gemfile
Guardfile
LICENSE.txt
README.md
Rakefile
konbata.example.yml
konbata.gemspec

README.md

Konbata Converter

Konbata converts SCORM packages and zipped PDFs into Canvas courses. It can generate an .imscc file and also upload that .imscc to create a course in a Canvas instance.

Installation

After checking out the repo, run bundle install to install dependencies.

Create a konbata.yml file and add credentials for uploading to Canvas:

# e.g. http://<canvas-url>/api
:canvas_url: <canvas instance api url>

# Found in Account >> Profile >> Generate Access Token
:canvas_token: <canvas token>

# ID found at specific course url: http://<canvas-url>/accounts/_ID_
# This can be :self, :default, or an ID.
:account_id: <account id>

:scorm_url: <scorm manager url>
:scorm_launch_url: <scorm launch url>
:scorm_shared_auth: <scorm manager token>

# Leave empty for DEFAULT_TIMEOUT
:request_timeout: <request timeout seconds>

Usage

Any .zip files placed at the top level of the sources directory will be processed.

Konbata is designed to process two types of SCORM packages (interactive and non-interactive) along with zip archives containing PDF files.

Below is a breakdown of how each type is handled.

For Interactive SCORM Packages

  • During .imscc Creation
    • Create a Canvas course.
    • Add the original SCORM package to the Files section in Canvas.
    • Add any PDF files from the SCORM package to the Files section.
    • Add any images from the SCORM package to Files section.
    • Set default view to “Assignments”.
  • During Upload
    • Add the SCORM package to the SCORM player.
    • Create an assignment for the SCORM package.
    • For students, hide all tabs except "Home" and "Assignments".

For Non-Interactive SCORM Packages

  • During .imscc Creation
    • Create a Canvas course.
    • Add the original SCORM package to the Files section in Canvas.
    • Add any PDF files from the SCORM package to the Files section.
    • Add any images from the SCORM package to Files section.
    • Create a Canvas page for each primary PDF file.
    • Add all Canvas pages to a module.
    • Set the default view to “Modules”
  • During Upload
    • Add the SCORM package to the SCORM player.
    • For students, hide all tabs except "Home" and "Modules".

For Zipped PDFs

  • During .imscc Creation
    • Create a Canvas course.
    • Add all PDFs to the Files section in Canvas.
    • Create a module item for each PDF file.
    • Add all module items to a module.
    • Set the default view to “Modules”
  • During Upload
    • For students, hide all tabs except "Home" and "Modules".

Running

To run Konbata, use the following Rake tasks:

Convert files:

rake konbata:convert[interactive]
# or
rake konbata:convert[non_interactive]
# or
rake konbata:convert[pdfs]

Upload to Canvas:

rake konbata:upload[interactive]
# or
rake konbata:upload[non_interactive]
# or
rake konbata:upload[pdfs]

Delete the entire output folder and log folder:

rake konbata:clean

Note: If you are using Zsh as your shell, you will probably need to escape brackets when running these Rake tasks. e.g. rake konbata:upload\[interactive\] or rake 'konbata:upload[interactive]'. Check this article for more details.

Errors

If there are errors during processing, an error log is generated and added to the /log directory. It logs errors related to when a file is referenced inside the SCORM package manifest but said file doesn't actually exist inside the package or when Konbata expects a certain file in order to generate content but it can't find the file.

License

The gem is available as open source under the terms of the AGPL 3.0 License.

You can’t perform that action at this time.