Sign in using DevConnect ID

Forgot password?

Trouble logging in?

Submit a ticket for Registration Support.

I have an SSO ID

?
sign in

Don't have a DevConnect or SSO ID ?

Create a DevConnect account or join the program.

register now
^

Avaya Context Store Snap-in

See All Content
X

Interfaces

The Avaya Context Store Snap-in provides a set of ReST and SOAP-based Web services that enable client applications to integrate with the Context Store and share contextual data. The Context Store Java and JavaScript SDKs include a client-side Java and JavaScript version of the ReST API. The Context Store Pluggable Data Connector (PDC) enables Avaya Aura® Experience Portal to integrate with the Context Store with having to invoke the API directly. The SDK and PDC are available for download under Releases -> Downloads for the latest release of the Context Store Snap-in.

In addition, when the Context Store Snap-in is deployed in conjunction with Avaya Engagement Designer, interactions with the Context Store can be included as tasks in Workflow Definitions.

Context Store ReST API

The Context Store ReST API can be invoked by client applications that can sent HTTP requests. Client applications can use the API to:

  • Create a new Context instance and put it in the Context Store. The following properties are defined when creating a new Context:
    • A unique Context Id: this can be defined in the request or assigned by the Context Store on submission of the request.
    • At least one contextual data item in the form of a key/value pair.
    • Optionally, a Group Id that associates the new Context with other Contexts.
    • Optionally, that the Context data is to be be persisted to an external database.
    In addition, the default "lease" value can be overridden when putting the Context into the Context Store. The lease is the number of seconds the Context and its data will be kept in the Context Store.
  • Update the lease value and/or contextual data in a specified Context.
  • Update the value of a specified contextual data item (key) in a specified Context.
  • Get the contextual data from an existing Context.
  • Get the value of a specified data item from a specified Context.
  • Delete a specified Context.
  • Delete the value of a specified data item in a specified Context.
  • Get all Contexts with a specified Group Id.
  • Analyze a Context to find out the Context Store operations performed on the Context during its lifecycle.
  • Create a new Context or update an existing Context in a single API request.

Contextual data is defined and stored as a set of key/value pairs.

Context Store SOAP API

The SOAP API supports the same set of operations as the ReST API. A Web Service Definition Language (WSDL) file and schema define the interface.

Context Store Java SDK and API

The Java SDK includes the following resources to help developers build client applications that integrate with the Context Store via its ReST API:

  • The Context Store Java API, which provides a client-side interface to the REST API and supports the same set of capabilities.
  • Javadoc for the Java API.
  • ReST API documentation.
  • A sample Eclipse Java project that demonstrates use of the Java API.
  • A sample .NET application that demonstrates use of the ReST API.
  • Documentation for the sample applications.

Context Store JavaScript SDK and API

The JavaScript SDK includes the following resources to help developers build browser-based solutions that integrate with the Context Store via its ReST API:

  • The JavaScript API client libraries.
  • JavaScript code.
  • Instructions for use of the SDK.
  • A sample HTML/JavaScript application.

Context Store Pluggable Data Connector

The Context Store Pluggable Data Connector (PDC) for Avaya Aura® Orchestration Designer enables the integration of Context Store capabilities into Avaya Aura┬« Experience Portal applications and workflows, without having to invoke the APIs directly. The PDC supports the same set of capabilities as the ReST API.

Context Store Task in Avaya Engagement Designer

The Context Store task is available in Engagement Designer when both snap-ins are deployed and licensed on Avaya Breeze. The task can added to workflows and configured to use any of the capabilities provided by the ReST API. The Context Store task enables the Context Store to be used in business processes.

Release News

Latest Release

Avaya Snapp Store
Want this or other Avaya and third party snap-ins?
Visit the Snapp Store on the DevConnect Marketplace now