Veracity Learning LRS Users Manual

Welcome to the Veracity Learning LRS Users Manual. This page should give you everything you need to get started using the tool. We're working hard to document all the features and functions of the LRS, plus add tips and tricks, explanations, and caveats to help you get the most our of the software.

In addition to this documentation, you can learn through our interactive tutorials. Check them out!

• Getting Started - A quick overview to setting up an LRS.
• Supporting xAPI Launch - Use xAPI Launch in your content.
• Using xAPI in Web Content - Learn how to integrate xAPI into a web app.

• Veracity Learning Basics
  • Creating an Account
  • Creating LRSs
  • xAPI Access Keys
  • Accessing the API with JWT
  • Viewing xAPI Data
  • Viewing xAPI Statements
  • Viewing xAPI Document Stores
  • The Analytics Page
  • Exporting Widget Data
• LRS Management
  • LRS Management Basics
  • Taking the LRS offline
  • Generating and Deleting Sample Statements
  • Clearing logs
  • Clearing xAPI data
  • System Messages
  • Deleting the LRS
  • Changing LRS settings
  • Import and Export
  • Exporting a Backup
  • Restoring a Backup
  • Exporting xAPI Statements as JSON
  • Pulling data from other LRSs
  • Sending data to other LRSs
  • Sharing Access
  • Database Upgrades and the Analytics Index
  • Rebuild Statements
  • Rebuild Mongo Indexes
  • Rebuild Analytics Cache
• Advanced Search and Aggregation
  • xAPI Advanced Search
  • Using Advanced Search
  • Regex
  • Using Aggregation
  • Special Operators
  • Restricted Pipeline Stages
  • Understanding the Schema
• Custom Dashboards, Graphs and Analytics Processors
  • Custom Dashboards
  • To Create a Custom Dashboard
  • The Chart Builder
  • An explanation of series options when in Chart Type is Pie or Bar:
  • Splitting Series
  • Split Series
  • Multi Series
  • An explanation of series options when in Chart Type is Time Series:
  • Split Time Series
  • Multi Time Series
  • The List Builder
  • The Notice Builder
• Versions of Veracity Learning
  • LRS.io
  • Service Tiers
  • Shared vs. Dedicated Infrastructure
  • On Site Options
  • Lite
  • Enterprise
  • Installation
  • Setup Steps
  • Explanation of Setup Questions
  • The .env File
• Content - Courses, Classes, Agents and Activities
  • Agents
  • Agents and xAPI
  • Creating Agents
  • Discovering Agents from xAPI
  • Linking to an actor
  • Managing Agent passwords
  • Activities
  • Creating Activities
  • Linking to External Activities
  • Upload a ZIP File
  • Discovering Activities from xAPI Statements
  • Activity Display
  • Classes
  • Create a Class
  • Editing a Class
  • Assignments
  • Courses
• LMS Integration
• Plugins
  • Types of plugins
  • Developing plugins
  • Defining a plugin
  • Importing other libraries
  • Importing system components
  • Plugin services (for LRS or system plugins)
  • Responding to events
  • Timing and scheduling
  • State
  • Routers, HTTP and HTML
  • Install and Uninstall
  • Settings
  • Configuration and Metadata
  • Custom Plugin Analytics Processors
  • map(val)
  • filter(val)
  • exec(results)
  • Processor Configuration
  • Parameter Types
  • Mapping functions
  • Chart Configuration
  • Chart Config Utilities
  • Other Widget Types
  • Using ElasticSearch
  • Overriding this.compute
• Branding
  • Replacing Static Files
  • Replacing Server Templates
  • Branding Plugins
• Saved Scripts
  • VQL Mode
  • Javascript Mode
• API Docs
• Admin API Docs
• VQL
  • About Veracity Query Language (VQL)
  • Table Of Contents
  • VQL Overview
  • Where to use VQL
  • Filters
  • Basic matching
  • Logical operators
  • Sorting and pagination
  • Advanced Filter Modifiers
  • Processing Commands
  • Paths
  • metrics
  • Common processes
  • $frequentValues
  • Sorting
  • Special metrics
  • $timeSeries
  • $punchCard
  • Spread
  • $paths
  • Special metrics
  • $ratio
  • $count
  • $expression
  • $min,$max,$avg,$sum, and $stdDev
  • $keys
  • $toCanonicalDisplay
  • $toCanonicalResponse
  • $addFields
  • $project
  • Control Flow
  • the $query command as a processing stage
  • $parallel
  • $mergeArrays
  • $explain
  • Language Features
  • the $inlineSubQuery command
  • $input
  • $each
  • $context
  • Reuse code with $def
  • Rendering
  • Split Series Rendering
  • Rendering commands
  • $barChart
  • Split Series
  • The difference between titlePath, categoryPath, stackCategory and stackTitle
  • $pieChart
  • $serialChart
  • $Notice
  • String interpolation
  • $list
  • $heatChart
  • $ganttChart
  • Rendering paths and chords
  • $pathsToNodes
  • $chordChart
  • $sankeyChart
  • $mergeCharts
  • Customizing colors in the render
  • Sending data to the renderer