Vocabulary used to capture user interaction

This page explains the format of the data stored to record user interactions with the Widget (these are captured through the HTTP API). This data is stored using the Tin Can API. When possible, existing vocabulary from the registry has been used.

References:

• Best practices

Verbs

• initialized
• Description: Widget or command line session is started.
• URI: http://adlnet.gov/expapi/verbs/initialized
• terminated
• Description: Command line session is ended (i.e., the dialog is closed).
• URI: http://adlnet.gov/expapi/verbs/terminated
• created
• Description: Creation of a device or a link in the network map.
• URI: http://activitystrea.ms/schema/1.0/create
• deleted
• Description: Removal of a device or a link in the network map.
• URI: http://activitystrea.ms/schema/1.0/delete
• updated
• Description: Updating details of a device or a link in the network map.
• URI: http://activitystrea.ms/schema/1.0/update
• used
• Description: Using command line.
• URI: http://activitystrea.ms/schema/1.0/use

Activities

• Widget
• Description: Use of a PTAnywhere widget
• URI: Widget URI
• Type: http://adlnet.gov/expapi/activities/simulation
• Device
• Description: a device in the network
• URI: http://ict-forge.eu/widget/packerTracer/{device-type}
• Type: http://adlnet.gov/expapi/activities/simulation
• Link
• Description: a link between two devices
• URI: http://ict-forge.eu/vocab/activities/link
• Type: http://adlnet.gov/expapi/activities/simulation
• Command line
• Description: A command line session within a device
• URI: [Widget URI]/device/[has of the device name]/console
• Type: http://ict-forge.eu/vocab/activities/command-line

Result

• response
• Description: A String which is the main outcome of the associated activity.
• extensions
• Description: PTAnywhere specific information.
• http://pt-anywhere.kmi.open.ac.uk/extensions/device/type
  • Description: Type of device.
  • Example: pcDevice
• http://pt-anywhere.kmi.open.ac.uk/extensions/device/name
  • Description: Name of device.
  • Example: PC0
• http://pt-anywhere.kmi.open.ac.uk/extensions/device/uri
  • Description: URI of the device in the web application.
  • Example: http://192.168.34.202:8080/api/v1/sessions/FsKBvJz2QJ6ZqFenNrUXuw--/devices/6_XQ47bDTs.aEov.uV4d4g--/
• http://pt-anywhere.kmi.open.ac.uk/extensions/device/position
  • Description: Position of the device in the application.
  • Example: { "x": 1.10, "y": 10.2 }
• http://pt-anywhere.kmi.open.ac.uk/extensions/device/link/uri
  • Description: URI of the link in the web application.
  • Example: http://192.168.34.202:8080/api/v1/sessions/FuTzAesoRdm8gb7QVt2Yqw--/links/dn2ODbueTo2csHaCCQaaHQ--
• http://pt-anywhere.kmi.open.ac.uk/extensions/endpoints
  • Description: Endpoints of a link.
  • Example: [ { "device": "Switch0", "port": "FastEthernet0/3" }, { "device": "MySwitch", "port": "FastEthernet0/9" } ]

Context

• registration
• Description: session id associated to the use
• context activities
  • parent: Device, Link and Command line are subactivities of the widgets where they are embedded.