About the Desktop SDK

Updated on June 2, 2019 Download PDFDownload as PDF
Download PDF

Brief Overview

A software development kit (SDK) is a set of software development tools that allows the creation of applications for a certain software package or similar development platform. It provides the integration between an external software platform and WalkMe.

If you are a software vendor, you can use the Desktop SDK to embed WalkMe on your desktop software, this will allow you to create content using the WalkMe Editor, and give you the ability to publish content to users without any additional coding to your software.

Examples of SDKs include the Windows 7 SDK and the Mac OS X SDK. Most SDKs contain sample code, which provides developers with example programs and libraries.

Please see the following articles for using an SDK with Mac and Windows.

Use Cases

  • It can assist you with onboarding new users.
  • Provides support.
  • Better user experience for your end users.
  • Announce new features.

How it Works

Player (SDK Client)

The WalkMe Player is an independent software module that overlays WalkMe’s interactive components on top of desktop applications and embeds WalkMe’s interactive components into digital platforms such as enterprise management systems and consumer applications.

WalkMe’s Player points to the Data files containing WalkMe’s elements and their configurations, which are then downloaded from the Akamai CDN. Once downloaded, the data files are stored in the SDK cache and are downloaded again only if changes were detected, ensuring minimal bandwidth overhead.

Scope of Solution

The WalkMe Desktop SDK solution targets applications that are distributed by the application developer (i.e., organizations that have access to the source code of the application).

Application + SDK

Main SDK Modules

Components:

WalkMe SDK –  a DLL file which is provided to the customer in order to load WalkMe to the application. As part of the WalkMe SDK, the UI Adapter DLL is loaded. The DLL executes inside the host application.

UI Adapter – UI framework-specific adapter loaded as a part of the SDK. This DLL integrates between the target application elements and WalkMe client.

WalkMe Client – A child process executed by the SDK to perform WalkMe logic and present UI components.

Was this article helpful?

Related Articles