Getting Started

Get started by downloading the MyDataHelp.js SDK.

Access MyDataHelps.js

NPM

The MyDataHelps.js SDK can be found on NPM. NPM is a popular tool and resource for sharing code libraries. Download NPM with Node.js, and use it with your preferred command line interface.

Add MyDataHelps.js to your project by installing it with NPM:

Installing MyDataHelps.js in Your Npm Project
> npm i @careevolution/mydatahelps-js --save

CDN

A Content Delivery Network serves static content with high uptime and low latency.

Use one of the following <script> tags to retrieve MyDataHelps.js.

v2.0.0 (Latest) - Uncompressed
<script src="https://cdn.careevolution.com/mydatahelps-js/2.0.0/MyDataHelps.js" integrity="sha384-wg/PvWEihl333qwag7EP5kDrl+jLerWWEpGP/cmZc6K5aZIaGJGhae81igQm+uD6" crossorigin="anonymous"></script>
v2.0.0 (Latest) - Minified
<script src="https://cdn.careevolution.com/mydatahelps-js/2.0.0/MyDataHelps.min.js" integrity="sha384-kjq/+Z1i8vsuQ9ATLfDT70NCKkDHygiIc/B33ryIT5RCo6FjpHV3LCvARTkNM04b" crossorigin="anonymous"></script>

Use Cases

The MDH JS SDK lets you create custom experiences. It can be used in Apps, Embeddables, and Web View Steps. The way you incorporate the SDK into your app will vary depending on the type of app.

External Applications

Create a custom experience for your participants using external applications. Whether it’s a static webpage or an interactive dashboard, MyDataHelps can host your application seamlessly in it’s mobile apps and on it’s website.

An application can retrieve participants’ survey responses and device data, navigate them to surveys or other content, and even persist new data. To accomplish this, use NPM to download MyDataHelps.js and host it with your project. Reference MyDataHelps.js in your web application, and use this documentation to guide your use of its functions and features.

Most functionality, except for embedded functions, are available to external applications. Authentication is automatically handled for any operations that requires it, using the logged-in participant.

Embedding MyDataHelps

Present a RKStudio survey within your own application by using MyDataHelps.js embedded capabilities. Your participants can access and complete these embedded surveys without downloading MyDataHelps mobile apps or visiting the MyDataHelps.org site.

This capability will soon be available. Contact RKStudio support to learn more.

Web View Steps

While the RKStudio survey editor offers a variety of predefined survey steps, you can design your own with web view steps. Web view steps render like a web page, using HTML, CSS and Javascript, and can show complex controls or additional data.

Use a CDN link to add MyDataHelps.js to your web view step to make use of data retrieval methods.

Web view steps are mostly limited to methods that retrieve data. Methods that require authentication are handled automatically, using the logged-in participant.