< Back to Package Overview

Key Concepts

The Data Store JavaScript SDK provides a client library allowing end users to write software that will interact with a deployed Context Store system or Customer Management API. The SDK exposes service interfaces via usage of a created instance AvayaDataStoreClient class. The SDK Context Store service provides Data Store operations access to all the standard Context Store interfaces.

Customer Management Services

Customer Management Services Client SDK package for JavaScript provides several operations for retrieving customer data

Get Operations

• get CRM Record by customer ID, CRM ID, phone, email or social media
• get Customer ID by CRM ID, phone, email or social media
• get Customer Journey by work Request Id
• get Customer Details by work Request Id or Customer ID
• get Customer History by work Request Id

Creation Operations

• create a Customer Journey element

Update Operations

• update a Customer Journey element

Context Store Services

Context Store Services Client SDK package for JavaScript provides several operations for manipulating, retrieving or removing context

For more information about Context Store, please refer to the following documents:

• Context Store Reference Guide
• Context Store Developer Guide

They can be downloaded from Context Store Snap-in Page

Creation Operations

• create context

Get Operations

• get Context Store Status
• get context by contextId
• get context by contextId with Meta Data
• get context by aliasId
• get context by aliasId with Meta Data
• get value by contextId
• get value by aliasId
• get group
• get contextId
• get aliasId
• get audit trail by contextId
• get audit trail by aliasId
• get EDM Entry
• get EDM Entry Audit Trail
• get EDM Group Audit Trail

Update Operations

• update context by contextId
• update context by aliasId
• update aliases by contextId
• update aliases by aliasId

Upsert Operations

• upsert context by contextId (updates the context or creates it if it does not exist)
  
• upsert context by aliasId (updates the context or creates it if it does not exist)

Delete Operations

• delete context by contextId
• delete context by aliasId
• delete value by contextId
• delete value by aliasId
• delete alias by aliasId

The {{=DataStoreTutorial}} demonstrates how to implement an operation via HTML and JavaScript.

Data Store Parameters

Context Data

Context data is a JSON object containing required key/value pairs (required), optional fields include contextId, groupId, tenantId etc.

Lease

Context will be stored for period specified in lease

Context Id

A context Id is the unique identifier for context data

Alias Id

An Alias Id is an additional, indexable identifier(s) for the Context

Session Id

A session id can be associated with a Context entry.

Routing Id

A routing id can be assigned to distinguish between Contexts in a geo-redundant deployment

Touchpoint

A Touchpoint can be added to the Context's audit trail if this feature is enabled.

Rules Enabled

Flag to enable rules

Short Id

Flag to request short auto generated contextId (less than 12 characters)

Group Id

The group Id for the context

Topic

The topic name which has been set for elements of a customer journey

Schema

Flag to request the return of the internal schema data associated with a Context (internal use only)

Customer Journey Services

Customer Journey Services Client SDK package for JavaScript provides several operations for retrieving customer data

Get Operations

• get Customer Journey by Customer Id
• get Customer Journey by Element Id (Context Id)
• get Customer Journey with Admin data by Element Id (Context Id)
• get Last Journey Element by Element Id (Context Id)
• get Customer Journey via Account Id

Creation Operations

• create a Customer Journey element

Update Operations

• update a Customer Journey element
• update Agent Note
• update Identifiers