properties.schema

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "id": "http://jsonschema.net",
  "required": false,
  "properties": {
    "pluginLocations": {
      "type": "object",
      "required": true,
      "properties": {
        "config": {
          "type": "object",
          "properties": {
            "_xapi": {
              "type": "object",
              "required": false,
              "legend": "xAPI",
              "properties": {
                "_isEnabled": {
                  "type": "boolean",
                  "required": true,
                  "default": true,
                  "title": "Is Enabled",
                  "inputType": "Checkbox",
                  "validators": [],
                  "help": "If enabled, the course will be tracked by xAPI. Please keep this disabled at all times until you publish the course for delivery. Keeping this enabled in the Adapt Authoring Tool will record unwanted data to the LRS."
                },
                "_isRestoreEnabled": {
                  "type": "boolean",
                  "required": true,
                  "default": false,
                  "title": "Restore Progress from LRS",
                  "inputType": "Checkbox",
                  "validators": [],
                  "help": "If enabled, the course will use xAPI data to restore course progress."
                },
                "_isDebugModeEnabled": {
                  "type": "boolean",
                  "required": true,
                  "default": false,
                  "title": "Developer Mode",
                  "inputType": "Checkbox",
                  "validators": [],
                  "help": "If enabled, the course will continue to generate statements for testing but it will instead post the statement to the console instead of the LRS."
                },
                "_activityId": {
                  "type": "string",
                  "required": true,
                  "title": "Activity ID",
                  "default": "https://example.com/unique_identifier",
                  "inputType": "Text",
                  "validators": [],
                  "help": "Unique identifier for this xAPI activity. Used to populate the Activity id included in _tincan.xml_ and for use in the Statement and State API. The value will be overriden if changed on the hosting environment. Where data has changed significantly, a new Activity id is recommended."
                },
                "_revision": {
                  "type": "string",
                  "required": false,
                  "title": "Revision",
                  "default": "",
                  "inputType": "Text",
                  "validators": [],
                  "help": "If blank, this field auto-populates using the plugin’s `package.json` version number."
                },
                "_contentRelease": {
                  "type": "string",
                  "required": false,
                  "title": "Revision",
                  "default": "",
                  "inputType": "Text",
                  "validators": [],
                  "help": "Identifies the version of the content. Increment this when releasing new builds."
                },
                "_tracking": {
                  "type": "object",
                  "required": false,
                  "title": "Tracking",
                  "properties": {
                    "_storeQuestionResponses": {
                      "type": "boolean",
                      "required": false,
                      "default": true,
                      "title": "Store question responses",
                      "inputType": "Checkbox",
                      "validators": [],
                      "help": "If enabled, the course will store the user's question responses across sessions."
                    },
                    "_questionInteractions": {
                      "type": "boolean",
                      "required": false,
                      "default": true,
                      "title": "Record question responses",
                      "inputType": "Checkbox",
                      "validators": [],
                      "help": "If enabled, the course will send statements recording the user's question responses."
                    },
                    "_assessmentsCompletion": {
                      "type": "boolean",
                      "required": false,
                      "default": false,
                      "title": "Record assessments completion",
                      "inputType": "Checkbox",
                      "validators": [],
                      "help": "If enabled, the course will send a statement for each assessment that is completed. Recommended only for courses containing multiple assessments."
                    },
                    "_assessmentCompletion": {
                      "type": "boolean",
                      "required": false,
                      "default": true,
                      "title": "Record assessment completion",
                      "inputType": "Checkbox",
                      "validators": [],
                      "help": "If enabled, the course will send a statement when the assessment have been completed. If using multiple assessments, the statement will be sent when all assessments have been completed."
                    },
                    "_focusedStates": {
                      "type": "boolean",
                      "required": false,
                      "default": false,
                      "title": "Focused States",
                      "inputType": "Checkbox",
                      "validators": [],
                      "help": "Tracks when the course is visible or hidden in the browser."
                    },
                    "_navbar": {
                      "type": "boolean",
                      "required": false,
                      "default": false,
                      "title": "Navigational Bar",
                      "inputType": "Checkbox",
                      "validators": [],
                      "help": "Tracks clicks on Adapt’s navigation bar."
                    },
                    "_video": {
                      "type": "boolean",
                      "required": false,
                      "default": false,
                      "title": "Media Analytics",
                      "inputType": "Checkbox",
                      "validators": [],
                      "help": "Tracks interactions with adapt-contrib-media throughout the course. Requires adapt-mediaAnalytics to function."
                    },
                    "_visua11y": {
                      "type": "boolean",
                      "required": false,
                      "default": false,
                      "title": "Visua11y",
                      "inputType": "Checkbox",
                      "validators": [],
                      "help": "Logs accessibility settings changes made via adapt-visua11y's settings."
                    },
                    "_connectionErrors": {
                      "type": "boolean",
                      "required": false,
                      "default": false,
                      "title": "Connection Errors",
                      "inputType": "Checkbox",
                      "validators": [],
                      "help": "Logs LMS connection issues reported by adapt-contrib-spoor."
                    },
                    "_inactivityTimout": {
                      "type": "boolean",
                      "required": false,
                      "default": false,
                      "title": "Inactivity Timeout",
                      "inputType": "Checkbox",
                      "validators": [],
                      "help": "Tracks inactivity warnings triggered by adapt-kineo-inactivityPopup."
                    }
                  }
                },
                "_errors": {
                  "type": "object",
                  "required": false,
                  "title": "Error Notifications",
                  "properties": {
                    "_launch": {
                      "type": "object",
                      "required": false,
                      "title": "Launch",
                      "properties": {
                        "title": {
                          "type": "string",
                          "required": true,
                          "title": "Title",
                          "default": "xAPI could not be initialized",
                          "inputType": "Text",
                          "validators": [],
                          "help": ""
                        },
                        "body": {
                          "type": "string",
                          "required": true,
                          "title": "Body",
                          "default": "This activity will not be tracked.",
                          "inputType": "Text",
                          "validators": [],
                          "help": ""
                        },
                        "_classes": {
                          "type": "string",
                          "required": false,
                          "title": "Classes",
                          "default": "",
                          "inputType": "Text",
                          "validators": [],
                          "help": "List any CSS classes to attach to the notification pop-up."
                        },
                        "_isCancellable": {
                          "type": "boolean",
                          "required": false,
                          "default": true,
                          "title": "Cancel notification",
                          "inputType": "Checkbox",
                          "validators": [],
                          "help": "If enabled, the user can close the notification and continue with an untracked session."
                        }
                      }
                    },
                    "_lrs": {
                      "type": "object",
                      "required": false,
                      "title": "LRS",
                      "properties": {
                        "title": {
                          "type": "string",
                          "required": true,
                          "title": "Title",
                          "default": "LRS could not be found",
                          "inputType": "Text",
                          "validators": [],
                          "help": ""
                        },
                        "body": {
                          "type": "string",
                          "required": true,
                          "title": "Body",
                          "default": "There was a problem communicating with the LRS. Tracking data may be lost if you continue with this session.",
                          "inputType": "Text",
                          "validators": [],
                          "help": ""
                        },
                        "_classes": {
                          "type": "string",
                          "required": false,
                          "title": "Classes",
                          "default": "",
                          "inputType": "Text",
                          "validators": [],
                          "help": "List any CSS classes to attach to the notification pop-up."
                        },
                        "_isCancellable": {
                          "type": "boolean",
                          "required": false,
                          "default": true,
                          "title": "Cancel notification",
                          "inputType": "Checkbox",
                          "validators": [],
                          "help": "If enabled, the user can close the notification and continue with an untracked session."
                        }
                      }
                    },
                    "_activityId": {
                      "type": "object",
                      "required": false,
                      "title": "LRS",
                      "properties": {
                        "title": {
                          "type": "string",
                          "required": true,
                          "title": "Title",
                          "default": "Missing Activity IRI",
                          "inputType": "Text",
                          "validators": [],
                          "help": ""
                        },
                        "body": {
                          "type": "string",
                          "required": true,
                          "title": "Body",
                          "default": "An Activity id has not been set. This activity will not be tracked.",
                          "inputType": "Text",
                          "validators": [],
                          "help": ""
                        },
                        "_classes": {
                          "type": "string",
                          "required": false,
                          "title": "Classes",
                          "default": "",
                          "inputType": "Text",
                          "validators": [],
                          "help": "List any CSS classes to attach to the notification pop-up."
                        },
                        "_isCancellable": {
                          "type": "boolean",
                          "required": false,
                          "default": true,
                          "title": "Cancel notification",
                          "inputType": "Checkbox",
                          "validators": [],
                          "help": "If enabled, the user can close the notification and continue with an untracked session."
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "course": {
          "type": "object"
        },
        "contentobject": {
          "type": "object"
        },
        "article": {
          "type": "object"
        },
        "block": {
          "type": "object"
        },
        "component": {
          "type": "object"
        }
      }
    }
  }
}