Setup and Installation
Your Rustici Cross Domain deliverable contains three folders:
pkg/
- which contains files used to build and configure proxy packages that will be exported to LMSsrxd/
- which contains files that have to be hosted online that assist the proxy package and your contentrxd-sample/
- which contains an HTML file that demonstrates how content should leverage the RXD API
To complete a successful RXD integration, you will need to include the RXD files and relevant API calls in your content and create a SCORM, AICC, cmi5 or Tin Can (xAPI) package for the host LMS corresponding to each individual course.
Testing the Sample Content
The sample file (located in the rxd-sample
folder) is available for testing and debugging your setup.
It's a good idea to test the sample in order to confirm that remotely hosted content can communicate with a target LMS. If your target LMS (or LMSs) are not yet available for testing, you can easily use Rustici Software's hosted SCORM Cloud product for testing by setting up a free trial account.
To set up a test of the sample content:
- Place the files from
rxd
in a shared location on the server to be used by your courses. We recommend that your content server serve files over https rather than http. - Open the
pkg
folder and choose a learning standard template folder. Within the learning standard template folder copy therxd/configuration.js.template
file and save it asrxd/configuration.js
. Update the values, minimally replacing thecontentUrl
andrxdHostUrl
parameters with your content server hostname and path to the content. - Update the
imsmanifest.xml
(for SCORM) or the*.crs
and*.des
files (for AICC) or thecmi5.xml
(for cmi5) or thetincan.xml
andtc-config.js
(for Tin Can) to replace the{MANIFEST_IDENTIFIER}
and{COURSE_TITLE}
values with your information. Note that the{MANIFEST_IDENTIFIER}
for cmi5 andtincan.xml
packages must be an IRI for use in xAPI requests. ThelaunchMethod
andmoveOn
values may also need to change in thecmi5.xml
file. - Select all the files in the template folder, and package them as a ZIP archive. Note: your zip should have these files at its root, not in a subfolder.
- Import the zip package into your target LMS, and then launch it.
If the launch works, you should be able to see a rendered version of /server/rxd-sample/index.html
, which includes buttons that test the RXD API calls. Click whichever pieces of functionality you wish to test, and then click the "ConcedeControl (Exit Course)" button to close the content. You should be able to verify that data was captured in the LMS.
Outfit Your Own Content
Now that you have a proof of concept of hosted content using the RXD API to send SCORM, AICC or xAPI data to a host LMS, it's time to make that content your own.
There are a few basic steps to this:
- Update the
contentUrl
value in theconfiguration.js
in the proxy package to point to your own content's location. - Within your content add JavaScript that accesses the RXD API at
window.parent.RXD
(see content sample source) - Make calls to the RXD API's functions as necessary via the
RXD
object as accessed above
Once you are satisfied that your content is functioning with RXD you should remove the rxd-sample/
files.