Watershed can receive data from any xAPI conformant Activity Provider. Many Watershed cards are flexible and you can configure Watershed to display useful visualizations and metrics from almost any xAPI data set. To help you get the most out of your data, we’re working with a number of product vendors to ensure that the data they send is optimized to produce the best possible results in Watershed. We want to help you to configure Watershed cards in the best way possible to display that data.

The RISC VTA LMS offers tracking of events such as registering for, launching, completing, passing and failing lessons. RISC VTA LMS will also generate xAPI tracking data from SCORM courses. The quality and completeness of this translated SCORM tracking data depends on the quality and completeness of data sent by the original SCORM course. Forums and discussion groups are also tracked.

The PDF annotator tool (launched from RISC VTA LMS) offers a way for learners to markup PDF documents with notes, underlines, highlights and other annotations. These annotations are stored in a Learning Record Store like Watershed and can be shared across devices and reported on in order to evaluate both the PDF documents themselves and learner engagement with the documents.

This guide tells you how to connect the RISC VTA PDF annotator to Watershed and configure Watershed to get the best results.

This guide has 2 sections:

Connecting to RISC VTA
Configuring cards for RISC VTA LMS
Configuring cards for RISC VTA PDF Annotator

Connecting to RISC VTA

Please note: You’ll need to be a Watershed Admin or Owner to connect RISC to Watershed.

To connect to RISC VTA, you need to get your Watershed Endpoint, Key and Secret and then contact RISC’s support team with that information to have them set up the connection.

Configuring cards for RISC VTA LMS

Data from the LMS works best with the Activity Card. Simply create a new Activity Card configured for the lesson or SCORM course activity id.

You can also use the following custom measures to create various measures based cards. See the Measure Editor guide for more details on how to configure Watershed using these measures.

Measure	Details	How to configure
Registration Count	Counts the number of times a user registered for a lesson.	Use a verb filter for the verb http://adlnet.gov/expapi/verbs/registered and a COUNT aggregation for the statement property id.
Launch Count	Counts the number of times a lesson is launched.	Use a verb filter for the verb http://adlnet.gov/expapi/verbs/launched and a COUNT aggregation for the statement property id.
Open Count	Counts the number of times a file or link is opened.	Use a verb filter for the verb http://activitystrea.ms/schema/1.0/open and a COUNT aggregation for the statement property id.
Read Count	Counts the number of times a file or link is read.	Use a verb filter for the verb http://activitystrea.ms/schema/1.0/read and a COUNT aggregation for the statement property id.
Pass Count	Counts the number of times a lesson is passed.	Use a verb filter for the verb http://adlnet.gov/expapi/verbs/passed and a COUNT aggregation for the statement property id.
Fail Count	Counts the number of times a lesson is failed.	Use a verb filter for the verb http://adlnet.gov/expapi/verbs/failed and a COUNT aggregation for the statement property id.
Completion Count	Counts the number of times a lesson is completed.	Use a verb filter for the verb http://adlnet.gov/expapi/verbs/completed and a COUNT aggregation for the statement property id.
Post Count	Counts the number of times a forum topic is posted. This does not include posts that are subsequently deleted.	Use a verb filter for the verb https://w3id.org/xapi/acrossx/verbs/posted and a COUNT aggregation for the statement property id.
Reply Count	Counts the number of times a topic is replied to. This does not include replies that are subsequently deleted.	Use a verb filter for the verb http://id.tincanapi.com/verb/replied and a COUNT aggregation for the statement property id.
Join Count	Counts the number of times a forum is joined.	Use a verb filter for the verb http://activitystrea.ms/schema/1.0/join and a COUNT aggregation for the statement property id.
Leave Count	Counts the number of times a forum is left.	Use a verb filter for the verb http://activitystrea.ms/schema/1.0/leave and a COUNT aggregation for the statement property id.
Accept Count	Counts the number of times an answer is marked as the accepted answer. This does not include answers that are subsequently unmarked as the accepted answer.	Use a verb filter for the verb http://activitystrea.ms/schema/1.0/accept and a COUNT aggregation for the statement property id.
Up Vote Count	Counts the number of times a response is voted up.	Use a verb filter for the verb http://id.tincanapi.com/verb/voted-up and a COUNT aggregation for the statement property id.
Down Vote Count	Counts the number of times a response is voted down.	Use a verb filter for the verb http://id.tincanapi.com/verb/voted-down and a COUNT aggregation for the statement property id.

Configuring cards for RISC VTA PDF Annotator

You can use Watershed to analyze the number, type and location of annotations using measures, dimensions and filters. This section of the guide outlines the measures, dimensions and filters that work well RISC VTA PDF Annotator data. Measures and dimensions are used by a number of different cards. See the Advanced Configuration guide for more details on how to configure Watershed using these measures, dimensions and filters.

Measures

The standard measure Statement Count can be used in conjunction with the activity type dimension to compare the usage of different types of annotation for a given data set. Simply use the Activities, People and Dates filters to limit the data set and then configure the card to be organized by activity type and use the Statement Count measure.

The table below outlines the custom measures that can be used with PDF Annotator data to count different types of annotation

Measure	Details	How to configure
Free Text	Counts the number of Free Text annotations for the configured dimension.	Use an other filter with the statement property object.definition.type and the value http://www.risc-inc.com/annotator/activities/freetext. Use a COUNT aggregation for the statement property id.
Text Highlights	Counts the number of Text Highlight annotations for the configured dimension.	Use an other filter with the statement property object.definition.type and the value http://www.risc-inc.com/annotator/activities/highlight". Use a COUNT aggregation for the statement property id.
Notes	Counts the number of Note annotations for the configured dimension.	Use an other filter with the statement property object.definition.type and the value http://www.risc-inc.com/annotator/activities/note". Use a COUNT aggregation for the statement property id.
Underlines	Counts the number of Underline annotations for the configured dimension.	Use an other filter with the statement property object.definition.type and the value http://www.risc-inc.com/annotator/activities/underline". Use a COUNT aggregation for the statement property id.

Dimensions

The custom measures above can be used in conjunction with the standard person, group and time based dimensions to show frequency of different types of annotation for people, groups and time peroids (see the Organized By setting in Simple Configuration). You can use the custom dimensions below to organize data in different ways

Dimension	Details
Document	Count the number of annotations in each document.

{
  "type": "STATEMENT_PROPERTY",
  "statementProperty": "context.contextActivities.parent.id"
}

Dimension	Details
Page Number	Count the number of annotations for each page.

{ 
  "type": "STATEMENT_PROPERTY", 
  "statementProperty": "object.definition.extensions.[http://www.risc-inc.com/annotator/extensions/page]" 
}

Please note: this should normally be used on conjunction with a document filter or else results for page 2 of document A will be grouped with those of page 2 of document B.

Dimension	Details
Color	Count the number of annotations that use each hexadecimal color.

{
  "type": "STATEMENT_PROPERTY",
  "statementProperty": "object.definition.extensions.[http://www.risc-inc.com/annotator/extensions/color]"
}

Please note: this dimension if only useful if there is some consistency in colors used. In the browser based annotator, users can only select from a set of predefined colors, however the iOS app allows use of the Apple color picker and potentially nearly 17 million different distinct colors.

Filters

Cards reporting on PDF annotator data can be filtered using the standard Activity, People and Date filters. The following Advanced filters can also be used.

Please note: filters can be combined with one another to create very specific data sets.

Filter	Details
The RISC PDF annotator	Filters a dataset for just data about RISC PDF annotator annotations.

"activityIds": {
  "ids": [
    "http://www.risc-inc.com/annotator/.*"
  ],
  "regExp": true
}

Filter

Details

All annotations

Filters a dataset for just data about annotations.

This is functionally the same as the filter above.

"equals": [{
  "fieldName": "object.definition.type",
  "values": {
    "ids": [
      "http://www.risc-inc.com/annotator/activities/freetext",
      "http://www.risc-inc.com/annotator/activities/highlight",
      "http://www.risc-inc.com/annotator/activities/note",
      "http://www.risc-inc.com/annotator/activities/highlight"
    ],
    "regExp": false
  }
}]

Filter	Details
Specific annotation types	Filters a dataset for just data about certain types of annotations. This example will filter only free text annotations.

"equals": [{
  "fieldName": "object.definition.type",
  "values": {
    "ids": [
      "http://www.risc-inc.com/annotator/activities/freetext"
    ],
    "regExp": false
  }
}]

Filter	Details
Only new annotations	Only report on newly created annotations.

"verbIds": {
  "ids": [
    "http://www.risc-inc.com/annotator/verbs/annotated"
  ],
  "regExp": false
}

Filter	Details
Only annotation modifications	Only report on modifications to existing annotations.

"verbIds": {
  "ids": [
    "http://www.risc-inc.com/annotator/verbs/modified"
  ],
  "regExp": false
}

Filter	Details
A specific document	Filter only annotations made to a specific document (or a list of documents)

"parentActivityIds ": {
  "ids": [
    "http://www.risc-inc.com/annotator/document/pjm101.pdf",
    "http://www.risc-inc.com/annotator/document/pjm102.pdf"
  ],
  "regExp": false
}

Please speak to us for help with configuring your cards to report on PDF Annotator data using the measures, dimensions and filters above.

RISC VTA

Connecting to RISC VTA

Configuring cards for RISC VTA LMS

Configuring cards for RISC VTA PDF Annotator

Measures

Dimensions

Filters

Comments

Related articles