Desktop Developer Guide

Updated on June 2, 2019
Download PDF

Brief Overview

The following document provides the steps required for developing a simple application using the WalkMe SDK.

Prerequisites

  1. 64-bit Windows 7 SP1 or newer Windows Operating System
  2. WalkMe for Windows Desktop MSI – Contact your Account Manager for the latest version
  3. WalkMe account settings file
  4. (For Editing content only) Download and install Walkme Editor

Steps

  1. Install Walkme MSI:
  2. Launch Visual Studio (or equivalent)
  3. Create an application (in this example: a C++ Windows Console Application that prints “Hello WalkMe!”)
  4. Add $(WALKMEDIR)include to the include directories of the project (right click on project in solution explorer -> Properties -> C/C++ -> General -> Additional Include Directories)
  5. Add $(WALKMEDIR)lib$(PlatformTarget) to library directories (right click on project in solution explorer -> Properties -> Linker -> General -> Additional Library Directories)
  6. Add WalkMe SDK library as a linker dependency (right click on project in solution explorer -> Properties -> Linker -> Input -> Additional Dependencies). For an SDK which supports Qt (For example: WalkMe Teams), the library is “WalkMe.Desktop.QtSDK.lib”. For other apps (for example: WalkMe Meetings) use “WalkMe.Desktop.SDK.lib”.
  7. Include “walkmeSdk.h” in HelloWalkme.cpp source file.
  8. Write code using the supplied methods in “walkmeSdk.h”

//HelloWalkme.cpp: example file for WalkMe SDK integration

#include “pch.h”

#include “walkmeSdk.h”

#include <iostream>

#include <conio.h>

int main()

{

    std::cout << “Hello WalkMe!n”;

WalkmeStartOptions::WALKME_START_OPTIONS wmOptions;

wmOptions.analyticsMode = WalkmeAnalytics::WALKME_ANALYTICS_MODE::On;

wmOptions.loggingMode = WalkmeLogging::WALKME_LOGGING_MODE::Stdout;

wmOptions.storageMode = WalkmeStorage::WALKME_STORAGE_MODE::Remote;

std::string endUserId(“<endUserId>“);

wmOptions.userId = endUserId.c_str();

wmOptions.language = NULL;

std::string m_startURL(“<settingsFileUrl>“);

std::string m_startWMDirectory(“<walkmeDir>“);

WalkmeSdk::Start(m_startURL.c_str(), m_startWMDirectory.c_str(), wmOptions);

int temp;

scanf_s(“%d”, &temp);

return 0;

}

Parameters

  • <endUserID> The relevant id used to identify the end-user (for testing purposes it can be any combination of letters and words).
  • <settingFileUrl> The relevant URL that matches your account
  • <walkmeDir>The directory that contains the file “WalkMe.Desktop.Client.Launcher.SDK.exe”. The default MSI installation path is “C:Program FilesWalkMeDesktop”.

Build the project and run – you will see the WalkMe outer process launched.

Note:

Project must be compiled in x64 architecture for QT support (Temporary limitation)

Was this article helpful?

Related Articles