Installing IMS web service

IMS web service is used for playing IMS learning object. The functionalities includes getting IMS package from repository or local disk, unzipping the package, playing the learning object and deleting the old packages.

Prerequisites

  • A Tomcat 5.x.x server.
  • Sun JDK 1.5.x
  • Apache Ant 1.5.1 or later

Instructions

To play your IMS learning object in the Fedora repository with IMS web service,you need to create a behavior definition object, a behavior mechanism object and a disseminator with the learning object. The instruction about how to create these objects in fedora can be found in the tutorial http://www.fedora.info/download/2.2.1/userdocs/tutorials/tutorial2.pdf

Below lists some values you must provide when you create those objects. You can find all these information in the attached example files as well. If you deploy IMS web service on the same machine which Fedora locates, then the example files can be ingested straightway for bDef and bMech objects. Note, before creating these objects, you should make Fedora support the PID name format ims:*. You can do this by looking for retainPIDs in fedora.fcfg and adding "ims" to it.

  • Behavior Definition:
    • PID: ims:bdef
    • Method Name: playImsObject
    • Method Parameter Definitions:
      • Parm Name: url
      • Parm Type: USER
      • Required: YES
      • Pass By: URL_REF
  • Behavior Mechanism
    • PID: ims:bmech
    • Behavior: ims:bdef
    • Messaging Protocol: HTTP GET
    • Input MIME Types: application/zip
    • Output MIME Types: text/http
    • Base URL: http://hostname:port/ims
    • HTTP URL(relative): imsdemo!play.action?url=(url)
    • Method Parameter Definitions:
      • Parm Name: url
      • Parm Type: DATASTREAM
      • Required: YES
      • Pass By: URL_REF
    • MIME types: text/html
    • DatastreamInput? Parms:
      • name: url
      • MIMEType: application/zip
      • Min Occurs: 1
      • Max Occurs: 1
      • Ordered: 1
      • Pretty Label: url Binding
  • Disseminators: If you ingested an IMS learning object with Fedora client, you need to new a Disseminator to play the IMS object. If you submit it from Muradora, it will be created automatically.
    • Disseminator ID: DISS1
    • Behavior:
      • defined by : ims:bdef
      • defines method: playImsObject
      • with parm: url
    • Mechanism: ims:bmech
    • Bindings: add the datastream of the IMS package for the url binding
  • Set up IMS web service
    • Download ims from http://drama.ramp.org.au/software/
    • Configuration. Set up a valid Fedora user name and a password in ims.properties. The user name and password should be the same as what is contained in your fedora.fcfg file for datastore credentials.
    • Build and deployment. Under the directory ims, run ant. Copy the generated ims.war under ims/dist to the web location.
    • The test url is http://hostname:port/ims/

Back to Deployment Guides

Attachments