@playkit-js/omniture-on-page NPM

playkit-js-omniture-on-page

playkit-js-omniture-on-page is a kaltura player which allows to monitor player event and report them into Omniture (Adobe Analytics)

It relies on kaltura player core API for managing UI features.

playkit-js-plugin-example is written in ECMAScript6 and TypeScript (strongly typed superset of ES6), and transpiled in ECMAScript5 using Babel and the TypeScript compiler.

Webpack is used to build the distro bundle and serve the local development environment.

Prerequisites

The plugin requires Kaltura Player and playkit-ui-managers to be loaded first.

Features

Getting started with development

# First, checkout the repository and install the required dependencies
git clone https://github.com/Kaltura-PS/playkit-js-omniture-on-page.git

# Navigate to the repo dir
cd playkit-js-omniture-on-page

# Run dev-server for demo page (recompiles on file-watch, and write to actual dist fs artifacts)
yarn
yarn build
yarn dev

# Before submitting a PR - Run the pre commit command
npm run pre:commit

# this command will run:

# 1. types check
# 2. lint check
# 3. generate/update types
# 4. generate/update docs

The dev server will host files on port 8000. Once started, the demo can be found running at http://localhost:8000/.

Before submitting a PR, please see our contribution guidelines.

Linter (ESlint)

Run linter:

npm run lint:check

Run linter with auto-fix mode:

yarn run lint:fix

Formatting Code

Run prettier to format code

yarn run prettier:fix

Type Check

Run type-check to verify TypeScript types

yarn run types:check

Automated tests (Mocha/Karma)

Run all tests at once:

yarn test

Run unit tests in watch mode:

yarn run test:watch

Design

An overview of this project's design, can be found here.

API docs

How to config at Prod

plugins: {
  {
    "omnitureOnPage": {
    "dynamicMediaName": true,
      "s_codeVarName": "s",
      "monitorEventInterval": 0,
      "trackMilestones": "25,50,75",
      "autoTrack": true,
      "trackWhilePlaying": true,
      "referer": "Kaltura Referer",
      "customEvents": "ENTER_FULLSCREEN,EXIT_FULLSCREEN,FIRST_QUARTILE,SECOND_QUARTILE,THIRD_QUARTILE,PLAYBACK_ENDED",
      "FIRST_QUARTILEEvent": "event45",
      "FIRST_QUARTILEEvar1": "eVar45",
      "FIRST_QUARTILEEvar1Value": "entryName",
      "ENTER_FULLSCREENEvent": "event50",
      "ENTER_FULLSCREENEvar1": "eVar50",
      "ENTER_FULLSCREENEvar1Value": "entryId",
      "ENTER_FULLSCREENEvar2": "eVar51",
      "ENTER_FULLSCREENEvar2Value": "entryName",
      "ENTER_FULLSCREENProp1": "prop50",
      "ENTER_FULLSCREENProp1Value": "referer",
      "EXIT_FULLSCREENEvent": "event40",
      "EXIT_FULLSCREENEvar1": "eVar40",
      "EXIT_FULLSCREENEvar1Value": "entryId",
      "EXIT_FULLSCREENEvar2": "eVar41",
      "EXIT_FULLSCREENEvar2Value": "entryName",
      "EXIT_FULLSCREENProp1": "prop40",
      "EXIT_FULLSCREENProp1Value": "referer",
      "additionalEvarsAndPropsValuesDelimiter": ",",
      "additionalEvarsAndProps": "eVar4,eVar6,eVar7,eVar8,eVar9,eVar16,eVar19,eVar24,eVar27,eVar28,eVar29,eVar37,eVar43,eVar45,eVar46,eVar61,eVar62,eVar63,eVar64,eVar65,eVar68,eVar71,prop4,prop6,prop7,prop8,prop9,prop13,prop28",
      "additionalEvarsAndPropsValues": "referenceId,trDataLoad.categoryRefId,trDataLoad.categoryName,trDataLoad.companyId,trDataLoad.companyName,eud,preferedFlavorBR,trDataLoad.flashVersion,trDataLoad.location,riuid,jobrole,trDataLoad.playerName,pn,wtype,euid,entryId,trDataLoad.kalturaChannelId,trDataLoad.kalturaCompanyId,trDataLoad.instanceId,trDataLoad.content,rootEntryId,t1uid,referenceId,trDataLoad.categoryRefId,trDataLoad.categoryName,trDataLoad.companyId,trDataLoad.companyName,trDataLoad.screen,riuid",
      "mediaName": "{trDataLoad.categoryName}>{entryName}>{rootEntryId}",
      "s_codeUrl": "https://www.kaltura.com/html5/html5lib/kwidget-ps/ps/modules/tr/resources/s_code_prod.js",
      "eud": 1000,
      "euid": 1005,
      "jobrole": 1002,
      "pn": 1003,
      "riuid": 1007,
      "t1uid": 1006,
      "wtype": 1004
  }
}