Install Gainsight PX Xamarin

Download and Install Gainsight PX Xamarin Plugin

This subsection outlines the procedure to use Gainsight PX on a Xamarin application. 

Following steps are required:

1. Download gainsight-px-x.x.x.zip from Gainsight PX dashboard. This file is a prerequisite to use Gainsight PX. 
2. Un-zip the file and extract the contents of Android Plugin/iOS Plugin folders to your Xamarin Droid/iOS root folder.
3. Add the respective folder DLL’s as references to your Droid/iOS project.
   • iOS - PXKit.dll & GPXXamarinPlugin.dll
   • Android - GPXAndroid.dll & GPXXamarinPlugin.dll

Integrate Gainsight PX Editor 

Gainsight PX Mobile Editor helps you manage PX engagements and Product Mapper from your mobile application. 

The In-app Editor allows you to:

• Preview engagements in the mobile app
• View the Product Tree
• Create, edit and delete Module/Features 
• Add Tap Rules for Module/Features

To use the in-app editor, copy the Scheme to integrate your mobile application with the your platforms that Gainsight supports.

You can activate the editor using deep linking and forwarding the link to the SDK. While forwarding the information, you as a developer have the ability to implement your own logic and permissions before launching the editor.

[Activity(Label = "{Your App Name}", MainLauncher = true, Icon = "@mipmap/icon")]
public class MainActivity : Activity {...}

 [Activity(Label = "{Your App Name}", MainLauncher = true, Icon = "@mipmap/icon")]
 [IntentFilter(new [] { Intent.ActionView },
         Categories = new[] { Intent.CategoryBrowsable, Intent.CategoryDefault },
          DataScheme = “{Gainsight PX SCHEME}”)]
  public class MainActivity : Activity {...}         

Intent intent = this.Intent;
if ((null != intent) && (null != intent.Data))
{
   Gainsight.EnterEditingMode(intent.Data.ToString());
 }   

[Export("application:openURL:options:")]
  public override bool OpenUrl(UIApplication app, NSUrl url, NSDictionary options)
{ 
          Gainsight.EnterEditingMode(url.AbsoluteString);
          return true;
}
[Export("application:continueUserActivity:restorationHandler:")]
public override bool ContinueUserActivity(UIApplication application,
    NSUserActivity userActivity,
    UIApplicationRestorationHandler completionHandler)
{
    NSUrl incomingURL = userActivity.WebPageUrl;
     if (incomingURL == null)
     {
             Return false;
     }
     Gainsight.EnterEditingMode(incomingURL.AbsoluteString);
     return true;
}                  
             

Initialize 

This section explains the procedure to initialize Gainsight PX in your application to track data. Gainsight recommends using shared project to write the common code of all Gainsight PX events. The code used in this section is platform-independent and can be used in Android, iOS, or Windows-based mobile applications. 

To track data with Gainsight PX:

1. Insert the following statement in the header section:

using GPXXamarinPlugin;

2.  Use the following code to initialize Gainsight PX. You must use the initialization code only once in your entire application. Gainsight recommends using this `Initialize` code from the shared project in Android MainActivity.cs and iOS AppDelegate.cs, so that tracking can be initialized from the first page of your application.

public static void Initialize()
{       
         AnalyticsConfiguration configuration = new
AnalyticsConfiguration("<#PRODUCT_KEY#>");
            configuration.Enable = true;
            configuration.CollectDeviceId = true;
            configuration.ShouldTrackTapEvents = true;
            Gainsight.Initialize(configuration, (functionName, properties, error) =>
            {
                 System.Diagnostics.Debug.WriteLine(error);
            });       
}  

Note:  All the Gainsight PX methods return an error callback Action<string, Dictionary<string, object>, string>.

ExceptionCallback

All exceptions that occur when creating events are passed into the catch as errors using error callback Action<string, Dictionary<string, object>, string>.

For example, you can make the calls using:

Gainsight.CustomEvent(eventName: <#string#>, properties:<#Dictionary<string,
object>#>, (functionName, properties, error) => {

         if (error != null) {
                     //Success
         } else {
                     //Failure
         }
});         

Create Events

Events are actions associated with your application and allow you to track various actions performed by users in your app. This section explains how to create events that can track data from your mobile application.

Gainsight PX SDK supports the following four types of events:

•  Screen Events
• Identify Events
• Custom Events
• Set Global Context

Gainsight.Screen(eventName: <#string#>, eventClass: <#string#> = “”, <#Dictionary<string, object>#> properties = null, Action<string, Dictionary<string, object>, string> errorBlock = null);
Gainsight.Screen(ScreenEvent <#screenEvent#>, <#Dictionary<string, object>#> properties = null, Action<string, Dictionary<string, object>, string> errorBlock = null);

Gainsight.Identify(userID: <#string#>, Action<string, Dictionary<string, object>, string> errorBlock = null);

User User = new User(UserID: <#string#>);
Account User = new Account(AccountID: <#string#>);
Gainsight.Identify(user: <#User#>, Account <#Account#> = null, Action<string, Dictionary<string, object>, string> errorBlock = null);

User.CustomAttributes = <#string, object#>
Account.CustomAttributes = <#string, object#>

Gainsight.CustomEvent(eventName: <#string#>, <#Dictionary<string, object>#> properties = null, Action<string, Dictionary<string, object>, string> errorBlock = null);

General Methods

This section describes the general methods (functions) of Gainsight PX SDK. There are three general methods as described in the table below:

Global Context 

You can set events with a global context after you create all the required events. Set a global context with key-value pairs and send them with the payload. Global context can be set on Date, String, Double, and Boolean data types. Global Context data is stored at the memory level and not disk-level. If an application is terminated, all the key-value pairs are erased. 

Use the following code snippet to set the global context:

Gainsight.SetGlobalContext(keyValues: <#Dictionary<string, object>#>);

Use the following code snippet to check if the key is available:

Gainsight.HasGlobalContextKey(key: <#string#>);

Use the following code snippet to remove the key:

Gainsight.RemoveGlobalContextKeys(key: <#string[]#>);

EngagementCallBack 

Gainsight PX provides the Engagement Callback feature for mobile engagements that you create for mobile applications. This feature helps in receiving a callback for all button actions and URL clicks that the end-user performs on an engagement. Once you receive the callback, you can decide your next action like helping the user to navigate to a new screen, or perform an API call and so on.

Prerequisite

Ensure that you have installed/configured the Gainsight PX Mobile SDK v1.5.1 or above.

To use the Engagement Callback feature you need to implement the engagementCallback completion when initializing gainsightPX.

Example:

AnalyticsConfiguration configuration = new AnalyticsConfiguration("<#PRODUCT_KEY#>");
configuration.Enable = true;
configuration.CollectDeviceId = true;
configuration.ShouldTrackTapEvents = true;
Gainsight.Initialize(configuration, (functionName, properties, error) =>
{
   System.Diagnostics.Debug.WriteLine(error);
}, (engMetadata) => {
   if (engMetadata != null && engMetadata.ActionType.Equals("link"))
   {
       var text = $"EngagementMetaData: actionText: {engMetadata.ActionText}, actionType: {engMetadata.ActionType}, " +
       $"engagementId: {engMetadata.EngagementId}, engagementName: {engMetadata.EngagementName}, " +
       $"scope.screeenName: {engMetadata.Scope.ScreenName}, scope.screenClass: {engMetadata.Scope.ScreenClass}, ";
       Toast.ShowToast(text);
   }
});