MyScript Server Administration Guide

This documentation will help you use the UI to administrate Myscript server.

The URL to access the UI depends on your reverse proxy configuration and installation parameters. By default, it is http://[your adminserver IP]:8895/

To access the Administration view, administrator or supervisor users must first login to above UI. Then, they can switch to the Administration view, by clicking on the icon on the top right of the screen and selecting Administration. They can go back to their Account view, by following the above procedure and selecting Account.

Account management

How to add a new account

From the Administration view > Accounts > Create account.

When creating an account, the Expiration date field is mandatory.

Please be careful with the expiration date you define when creating an account and keep in mind that you can extend the expiration date of an account at any time.

To create an account with limited rights, check the Read only box. The label will be displayed in the list of accounts. In this scenario, the user will not be able to edit his or her account information.

How to change an account password

From the Administration view > Accounts.

Select the appropriate account and click on , then click on ... and select Re-activate.

The user will receive a mail containing a new password and indicating his or her account has been reactivated.

How users can reset their password

From the login UI, they click on Forgot my password?. They will receive a mail containing a new password and indicating their password has been regenerated.

How users can change their password

From their Account view, they click on Change password.

How to search for an account

From the Administration view > Accounts.

Fill out the empty fields to search for one or several accounts. The list of accounts is automatically updated depending on your search parameters.

How to edit an account

From the Administration view > Accounts.

Select the appropriate account and click on , then click on Edit.

If you wish to edit your own account, just go to your Account view, then click on Edit.

How to enable or disable an account

If needed, you can momentarily disable an account.

From the Administration view > Accounts.

Select the appropriate account and click on , then click on ... and select Disable. The label will be displayed in the list of accounts.

To enable it again, follow the above procedure and click Enable at the last step.

How to delete or purge an account

From the Administration view > Accounts.

Select the appropriate account, then click on to archive it.

Once archived, click on to Purge the account, if you need to erase all traces of the account.

The administrator can only archive an account. To purge it, you need supervisor rights

Applications and application keys

To use the recognition service, you need at least:

  • one application,
  • one application key and hmac key.
Each application needs at least one application key to work properly.

How to create and manage an application

  1. From the Account view > Applications, click Create application.
  2. Fill out the fields Name and Description. Your application is then displayed in the list.
  3. Click Open, Disable or Delete to edit, disable or delete your application.

How to create an application key

  1. From the Account view > Applications, select the application and click Open.
  2. From Keys, click Generate application key.

How to revoke an application key

  1. In Account > Applications, select the application and click Open.
  2. From Keys, select the appropriate application key and click Revoke.
Revoking an application key is permanent and leads to all related applications to be revoked as well, and unable to perform any recognition.

How to test an application key

If you wish to test the application key and confirm it is working properly, follow this procedure:

  1. Click on the Test button of the application key you just created.
  2. Choose the Backend URL, protocol, recognition and language to test and then click Apply.
  3. Write something.

Counters

Counters are accessible per account or per application. You can select a year or a month period, and the data type (Requests, Bytes or Strokes).

As reports are also sent to MyScript on a regular basis, an Internet connection is necessary.

Account counters

In Account > Counters

Application counters

In Account > Applications, select the application and click Open.

Exporting counters

To display counters as a data view, click on Data view at the top right of your counters view.

To download a counters report, click on Export at the top right of your counters view.

Per-server administration

The following administration features are located in the recognition servers. Thus they are not part of the administration UI. You can access them directly and individually on each recognition backend using its address and port. For example, if you installed a recognition backend setting the port 8897 on server whose ip address is 10.0.6.90, you can access its administration UI using the address http://10.0.6.90:8897/

License key status

A valid license key is essential to use MyScript Server. It contains information about your contract: data type, languages and ink consumption.

To obtain a license key, contact our support team.

Go to the Licenses tab.

This section displays information about licenses: name, start and expiration date, status. Select a license to display more information (path, features, languages, etc.).

Resources status

  • Go to the Licenses tab.
  • Click on a license to display the list of related resources.
IconExplanation
This resource is included in your contract.
This resource is uploaded in the database.
This resource is not included in your contract.
This resource has not been uploaded in the database yet.

Examples

  • If and are displayed, it means that you have uploaded an unauthorized resource.
  • If and are displayed, it means that your contract includes a resource that you have not uploaded yet.
  • If and are displayed, it means the resource has been properly uploaded and is part of your contract.