Apteryx Online Capture can be installed via Batch file (.bat), which allows us, the user, or the IT provider to perform installations silently (with no or minimal UI prompts during the installation process), as well as quickly deploy Apteryx Online Capture to numerous workstations.

The steps to create a batch file and run a scripted installation correctly are as outlined below.

Necessary Components

• A template batch file

• The latest Apteryx Online Capture installer

Obtaining Apteryx Online Capture.exe (Apteryx Online Capture Installer)

• Navigate to the client’s Apteryx URL and have them log in

  • If unable to have them log in, log into customercare.Apteryx.net on your own workstation instead

• Click on the Username and select Capture from the menu

  

• Select Download Installer - the installer will download to the Downloads folder

  

• If you had downloaded the installer to your own workstation, transfer it over to the client’s workstation and place it in a location of your choice, or where the IT provider would like to be placed. The path where Apteryx Online Capture.exe is placed will be specified in and used by the batch file during installation.

Batch File Setup

1. Download the following Batch File Template -> and save it to your workstation, then transfer it to a client’s workstation to a folder of choice.

   1. You can also create the batch file on your own workstation if you know what plugins and paths will be used, then transfer the completed batch file over at a later point.

2. Right click the batch file > Edit with Notepad (Windows 10: Right click > Open with > Notepad). You’ll see the following contents:

   

3. Specify a pathway for Apteryx Online Capture’s install directory within the quotes next to set INSTALL_DIR= - this will be where Apteryx Online Capture is installed.

   1. Brackets should be removed. Quotes should remain.

   2. C:\PlanetDDS should always be used unless completely necessary to install somewhere else.

Example:

4. Specify which Plugins to install within the quotes next to set PLUGINS=/PLUGINS= - this is what will tell the installer which Plugins need to be installed once invoked by the batch file.

   1. Brackets should be removed. Quotes should remain.

   2. The use of this field is only necessary if /SILENT or /VERYSILENT is specified in set ARGS=/. set PLUGINS=/PLUGINS= is ignored if the installation is not silent as the installer will simply prompt the user to manually select which plugins they want to install instead.

   3. Each Plugin name should be separated by a comma, without spaces.

   4. List of Plugin names:

Dexis

E2VII

Gendex

Hamamatsu

Kavo

Schick

Simulator

Tuxedo A-Series

TWAIN

Intraoral Camera

Air Techniques

Carestream

Planmeca

Promantix/TuxDeluxe

Example:

5. Specify the full filepath to where the installer (Apteryx Online Capture.exe) is located within the quotes next to set INSTALLER_PATH=. This tells the batch file where the installer is.

   1. Brackets should be removed. Quotes should remain.

Example:

NOTE: I placed the installer on my desktop for this example, but the installer can be placed anywhere as long as it is a local path.

6. Specify if you’d like the installation to be /SILENT or /VERYSILENT next to set ARGS=.

   1. Brackets should be removed.

   2. There should be no space between set ARGS= and the argument you are choosing.

   3. /SILENT attempts to suppress some UI and requires no user interaction aside from allowing the batch file to run. You will be notified of errors if any occur during the installation process.

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

   5. If you don’t want the installation to be silent, leave this field empty (set ARGS= )

Example:

Example of a completed, working syntax where the installer exe exists in C:\Users\NigelKneisley\OneDrive - Planet DDS\Desktop\Apteryx Online Capture.exe:

7. OPTIONAL: Rename the finished batch file to a filename of choice, it does not matter or need to match anything.

   1. Make sure not to accidentally save it as a .txt file, it must remain a .bat file. (Do not use “File > Save As” - use “File > Save” to keep the file extension the same)

Performing the installation

1. If the finished batch file wasn’t created on the client’s workstation, transfer it to their workstation within a folder of your choice or onto the desktop

2. Make sure the installer (Apteryx Online Capture.exe) exists in the filepath specified next to set INSTALLER_PATH= in the batch file

3. Double-click the batch file, allow the installation to complete

4. Verify installation was successful by confirming:

   1. The installation directory was created

   2. The Apteryx Ambassador is running

   3. The Plugins specified within the batch file are installed

Video example of a successful installation:

Deploying on other workstations

1. Copy the finished batch file and Apteryx Online Capture.exe to each workstation

2. Make sure the installer (Apteryx Online Capture.exe) exists in the filepath specified in the batch file, next to set INSTALLER_PATH=

3. Double-click the batch file, allow the installation to complete

Some IT providers or DSO management teams may prefer to use a 3rd party deployment software to deploy the batch installation.

If this is the case, the deployment tool needs to place the batch file and Apteryx Online Capture.exe on each workstation, with Apteryx Online Capture.exe being placed in the filepath specified in set INSTALLER_PATH=, then launch the batch file via elevated cmd prompt. As long as this occurs, the installation should be successful.

Planet DDS does not directly support the use of 3rd party deployment tools - the IT provider or admin of said tool would need to configure it and ensure the above occurs during deployment.

NOTE: If a deployment tool is in use, the /SILENT argument should always be used to allow Apteryx Online Capture to install without user interaction.

Attachments

• Install Script - Template.bat
• explorer_lrbxixDu3V.mp4