Apteryx Online Capture Install/Uninstall

Installing Apteryx Online Capture

Navigate to Apteryx (whether it be your test environment or the customer’s) and sign in.

(Note: The below steps will not be possible to complete unless the Cloud Capture Enabled option is turned on in the site’s Site Administration page in sites dash)

Click on the username in the upper-right corner and select “Capture” (capture privilege required)

Click “Download Apteryx Online Capture”

This will download the installer, titled Apteryx Online Capture.exe

Locate the downloaded executable file and double-click

The following window will launch:

Click Install and you will be prompted to select your plugins and install:

You will be notified that the installation is complete and you may now click Finish.

You may be prompted with the following window the first time you attempt to capture.

Click the Checkbox and click Open Apteryx Online Capture.

Ensure this is toggled on in Site Settings as well

If you get an error on first time launch stating access to Apteryx Online Capture was denied, refer to Enabling Local Access Permissions for Apteryx Online Capture - PlanetDDS - Internal Knowledge Base - Confluence to enable LNA permissions within the browser.

Uninstalling Apteryx Online Capture

Right-click > Quit the Apteryx Ambassador from the System Tray, or open Task Manager and look for Apteryx.Capture.Ambassador > right click and select End Task

Uninstall Apteryx Online Capture from Windows Control Panel

Verify the following folders no longer exist:

• C:\PlanetDDS

• C:\ProgramData\PlanetDDS

• C:\Users\YourUserName\AppData\Roaming\Apteryx.Capture

If any of the above folders still exist, manually delete them

Alternate Install Method

For Apteryx Online Capture releases that have issues updating current installed versions, please follow this process to update Apteryx Online Capture.

1. Stop the ambassador (system tray icon PDDS logo - right click > close)

2. Delete:
     C:\PlanetDDS
     C:\ProgramData\PlanetDDS
     C:\Users\YourUserName\AppData\Roaming\XVCapture
     C:\Users\YourUserName\AppData\Roaming\Apteryx.Capture

3. Uninstall Apteryx Online Capture from Windows Settings

4. Download newest version via Apteryx

5. Install only necessary plugins

Scripted Installs

Options:

You can use (case insensitive) /SILENT or /VERYSILENT

Generally, Apteryx recommends /SILENT since there is some indication that something is happening, /VERYSILENT attempts to force suppression upon the UI

There are multiple options for installing Apteryx Online Capture:

1. Via batch (Example batch file) - see Installing Apteryx Online Capture via Batch file (Scripted/Silent Installs) - PlanetDDS - Internal Knowledge Base - Confluence for detailed instructions

   @echo off
   setlocal
   
   set INSTALLER_PATH="<PATH TO INSTALL EXE>"
   
   set ARGS=/SILENT /INSTALLDIR="C:\temp" /PLUGINS="Simulator,TWAIN"
   
   %INSTALLER_PATH% %ARGS%
   
   endlocal
   pause

2. Via command line (Example command line)
   .\Apteryx Online Capture.exe /SILENT /INSTALLDIR="C:\temp" /PLUGINS="Simulator,TWAIN"

3. Or creating a shortcut and modifying the target
   /SILENT /INSTALLDIR="C:\temp" /PLUGINS="Simulator,TWAIN"
   

   

   Note that device names should be entered exactly as listed during the install process.

   

When installing via command line, the user should use the internal name of each plugin they want to add. The internal names are listed below:

Script Parameters

/SILENT - Attempts to suppress some UI. You will be notified of errors.

/VERYSILENT - Attempts to suppress all UI. This will not notify you if there is problem.

/PLUGINS - Allows you to set plugins to be install. These should be wrapped in quotes with commas as delimiters (e.x. /PLUGINS=”Gendex,TWAIN.Plugin"). Use the Internal Name of each plugin.

/INSTALLDIR - Sets the install path for Apteryx Online Capture