Manual Installation of Apty Client

It is recommended that instructional elements are embedded into the hosting application by connecting Apty Studio with the Chrome browser, but once embedded and published, Workflows, Validations, Tooltips, etc. can be seen by the end users in the Apty Client extension available for: Google Chrome & Microsoft Edge

Note:

As of March 2023, support for the Apty Client Extension on Mozilla Firefox has been discontinued. Please note that this change does not apply to the Apty Player in Injected mode.

Manual Installation in Google Chrome

PREREQUISITES:

  • Unarchiving software (for example, 7-zip / WinRAR / Unarchiver, etc.)
  • Chrome Browser

Accessing Editor and Player download page

1.  Log into the Admin Console.

2.  On the the bottom of the left side panel click Settings.

3.  In the System Settings panel select Downloads. A source page for downloading an Editor and Player extensions for various browsers opens.

Installing the Apty Client Extension

On the Downloads page > Apty Assist Client section find the Browser Extension for Google Chrome option.

1.   Click Download(.zip)

2.   The apty_assist_client_chrome.zip file is downloaded.

3.   Unzip and extract the files into the new folder. 

4.   Upload the extracted file to the Browser Extensions:

  • Open the Extension Management page by navigating to chrome://extensions. Alternatively, the Extension Management page can also be opened by clicking on the Chrome menu, hovering over More Tools then selecting Extensions.       
  • Enable Developer Mode by clicking the toggle switch next to Developer mode.     
  • Click the LOAD UNPACKED button and select the extension directory.

The widget is now displayed at the bottom of the application page. The location of the Widget on the border of the screen of the hosting application can be customized.

 

Manual Installation in Microsoft Edge

PREREQUISITES:

  • Edge browser
  • apty Player Edge extension package (APPX file)

To access the download page in the Admin Console

1.   Log into the Admin Console.

2.   On the the bottom of the left side panel click the Settings icon. The System Settings page opens.

3.   In the System Settings page select Downloads. A source page for downloading an Editor and Player extensions for various browsers opens.


Installation steps

Follow the steps below to add the Apty Client to the Microsoft Edge browser. Make sure that Edge browser is closed before installing the Apty Client extension.

Install as a ZIP file

1.   Save apty_assist_client_edge (ZIP file) at desired location in your machine.

2.   Extract the files to a folder on your desktop.

3.   Open Edge browser, visit about:flags and under Developer Settings, check ‘Enable extension developer features‘ option.

4.   Click on More actions button, select Extensions, click on Load Extension button and select the folder which you’ve downloaded and extracted before.

Install as an APPX file

1.   Save apty_assist_client_edge (APPX file) at desired location in your machine.

2.   Right click on the file and select Install from the context menu.

3.   The Welcome page opens. Click Next to continue with the setup wizard configurations.

4.   Launch the Edge browser. At the top right corner of the screen, the Assist Client extension icon appears. This indicates that Apty Client extension is installed on your machine.


Note: You may need to turn on the extension manually to enable it. If a warning pop-up appears on the browser, click Turn on anyway to enable the extension and reload the page to view it on the hosting application.

 

Manual Installation in Mozilla Firefox

PREREQUISITES:

  • Mozilla Firefox Browser

Accessing the Apty Client download page

1.  Log into the Admin Console.

2.  On the the bottom of the left side panel click the Settings icon.

3.  In the System Settings menu select DownloadsA source page for downloading an Apty Studio and Client extensions for various browsers opens.

4.  On the Downloads page find the Browser Extension for Mozilla Firefox option and download the package. 

Signing the Apty Client package

STEP 1: Add unique ID to the Apty Client extension file. To provide the unique ID for the Apty Client, follow the steps below:

  1. Download Apty Client for Mozilla Firefox extension from the Apty admin console at Admin > System Settings > Downloads.
  2. The player-firefox.xpi file is downloaded. Convert this file to .zip format by changing the extension: rename “player-firefox.xpi” to “player-firefox.zip”.
  3. Right-click the folder and select Extract All to extract the files from the archive.
  4. Open the manifest.json file inside the folder, find the “id” attribute and change it to a unique value, for example, “apty@apty.org” to “youradminnumber@apty.org”.
    Note: Make sure that the given ID is unique to your organization and contains @apty.org at the end.
  5. Save the changes in the updated manifest.json file.
  6. Select all the files inside the folder and create the zip archive again.

This zipped file is used during the signing of the Apty Client package.

STEP 2: Signing the package. Follow the steps below to sign Apty Client player package for the Firefox browser:

1.   Access or create your developer account at the Addons for Firefox (AMO) portal at  https://addons.mozilla.org:

  • If you have a Firefox Account: at the top right corner of the page click Register or Log in, then provide your credentials to log in to your account.
  • If you don't have a Firefox Account: at the top right corner of the page select Register or Log in > Create an account.

2.   Once you logged into your account, select Submit Your First Add-on or Submit a New Add-on. You'll be redirected to the following page:

3.   Choose on you own and click Continue. You are redirected to the following page:

4.   Click Select a file..., find the updated zip file on your local machine, and when the file is successfully loaded and passes all the checks, you receive the following message:

5.   At the bottom of the page click Sign Add-on.

Click Select a file, select and upload your updated zip file above and upon successful upload and If the add-on passes all the checks, you receive the following message:

Click Sign Add-on

6.  You’ll reach the following page:

7.  Select Yes. To provide source code, click Browse and locate and upload your zipped package and click Continue

8. Download the Signed .xpi file

9.   Once the file is downloaded, make sure to rename the file with the id given before and you can use this signed .xpi file to add it to your browser and you can also provide the same .xpi file to other users to get Apty Client Extension added to their Firefox browser.

Installing  the Apty Client Extension

Follow the steps below to add Apty Client as an add-on to the Firefox browser:

1.   Launch Firefox browser(latest version recommended).

2.   At the top right corner of the browser screen, click the Open Menu icon. A drop-down menu appears with multiple options. Choose Add-ons from the available options.

3.   Add-ons Manager page opens, select Extensions tab.

4.   At the right corner click the Settings icon and select Install Add-on from file option.

5.   Upload the signed Apty .xpi package from the saved location.

6.   Once the file is uploaded, a confirmation pop up appears. Click Add.

 

Verification process

Open respective application and Apty Client widget should appear on the application as shown below.

IMAGE