This documentation aims at helping you integrate our MyScript widgets and components into your applications. It is intended for developers with good knowledge of object-oriented programming.

For more information on Text, Math, Graphics, click on the corresponding tab in the top-right menu.

License Management

License

A license is defined as the first launch of one application on one device. It is discounted each time the registerCertificate method is called from a new device. A free starter pack is offered, containing 40 licenses to run the samples and discover our technology. This pack allows you to install and run one application on 40 devices (or n applications on 40/n devices). Note that your license account is deducted when running the samples.

An Internet connection is required to launch and run ATK applications. However, a 30-day grace period is offered, from the moment you first launch your application. A connection will then be mandatory.

Go to the Applications tab of the ATK Dashboard to see your remaining licenses. Go to the Developer Portal to buy additional licenses.

Certificate

A certificate is required to use the MyScript handwriting recognition engine and gives the right to use the ATK. Each certificate gives access to all widgets for a given platform.

Here is how to download the certificate for ATK Samples:

  1. Log in at https://atk.myscript.com.
  2. Click Open on the ATK Samples application.
  3. Click on the download icon to download MyCertificate.cs.

Sample Execution

To integrate MyScript widgets and components on Windows, you must be using the latest version of Visual Studio and running at least on Windows 10.
  1. Unzip MyScript_ATK_DevPortal-windows-*.zip to obtain this tree:

    • Docs - Contains the whole documentation (installation, functional, API).
    • Packages - Contains libraries.
    • Samples - Contains sample applications, showing basic use cases.
    • third_party - Contains ATK and third-party licenses.
    • atk-info.json - Contains information about the version numbers.
  2. Copy the downloaded certificate into Samples/MyCertificate/MyScript.Certificate/MyCertificate.cs to replace the existing one.

Then you have to reference the Packages directory as a NuGet source:

  1. Configure the NuGet source in Visual Studio, click Tools > NuGet Package Manager > Package Manager Settings and click Package Sources.

  2. Click the + sign to add a source package and name it (e.g. ATK).

  3. Browse towards the Packages folder containing the *.nupkg files and click OK.

Make sure to update your packages in Visual Studio to enjoy the latest version of nugets.

You can otherwise use the nuget command line to add a NuGet source.

> nuget sources Add -Name "ATK" -Source %USERPROFILE%\ATK\Packages
For more information on NuGet integration within Visual Studio, see the NuGet documentation.
  1. Open the MyScript Application ToolKit Samples.sln solution provided in the Samples folder of your package.

  2. Build and run your sample.

Online Accounts

Your email and password are the same for the Developer Portal and ATK Dashboard. Note that your profile can only be modified on the Developer Portal.

The below table describes the possibilities each account offers:

Developer Portal  ATK Dashboard
- Download development material and documentation. - Create and manage your applications and certificates.
- Access the forum and support pages. - See your purchase history and consumption of licenses.
- Purchase additional licenses.  

ATK Dashboard

The top menu contains 4 sections (Profile, Applications, Purchase History, Console), described below.

Profile

The Profile tab displays the following information: account email, creation date and expiration date.

Applications

The Applications tab displays:

  • your cartridge consumption,
  • a diagram of your license consumption for all your applications (or a filtered application) on a given period,
  • a list of your applications, that you can manage through the Create application, Open and Edit buttons.
Once created, the certificate identifier cannot be changed. The Edit button only allows you to add or update a description.

Click Open to open an application and thus access a page dedicated to the corresponding certificate(s).

This new page displays:

  • a diagram of your license consumption for the application (or a filtered certificate) on a given period,
  • your application name and creation date as well as a list of your certificates, that you can manage through the Create certificate, Edit, Disable and download icon buttons. This list can be filtered.
The Disable button allows you to temporarily suspend a certificate and thus the related application. Click Enable to re-activate the certificate.

Purchase History

The Purchase History tab lists the cartridges purchased on the Developer Portal with the following information: cartridge size (i.e. number of purchased licenses), transaction date and identifier.

Console

The Console tab displays various 30-day-old error logs from the server.