App Manager IT Guide

Article last updated:

The App Manager Guide for IT Administrators is intended for individuals with IT experience who have the proper access to setup folders in a network environment and provide the necessary permission for file access. Individuals should also have knowledge for creating batch scripts or executing CLI commands from the DOS prompt. As support is limited for these features, if you are unfamiliar with how to build batch scripts or run CLI commands, please utilize the normal methods for using App Manager.

This Guide provides 2 main objectives.

  1. Allow the setup of a network software repository to update zSpace software over the internal network in place of the internet.
  2. Allow IT admin administrators to execute CLI commands to perform App Manager functions.  IT administrators can also use these CLI commands to create batch scripts to execute updates or changes to App Manager

App Manager IT Guide

The zSpace App Manager helps you install, uninstall, and update zSpace packages. This guide describes how to set up a repository on a local network, how to access this repository from App Manager, perform App Manager updates offline, and how to use the command line interface for App Manager. This document applies to App Manager 2.0 and greater. To continue, you should be familiar with Windows command line tools and batch file scripts. This document also assumes you have the permission levels required to access and modify the required folders and files.

Applications Not Supported by App Manager

App Manager displays all supported applications as available to Install, Update, or Uninstall.

The list of installed learning applications and content does not include files downloaded directly from the zSpace website. App Manager does not track these packages:

  • PC Operating System – Windows 10 Pro, free with zSpace system.
  • GPU Driver – Graphics driver for the zSpace System, free.
  • Motherboard BIOS – System firmware, free.
  • EDU Server – zSpace service, free.
  • Bonjour (used with EDU Server) – Third party application, free.
  • Cyber Anatomy 3D – Third party application, paid.
  • Geogebra – Third party application, free.
  • Human Anatomy Atlas Visible Body 3D – Third party application, paid.
  • NGRAIN DICOM Viewer – Third party application, paid.
  • Adobe Acrobat Reader – Third party application, free.
  • Chrome Browser – Third party application, free.
  • Teamviewer – Third party application, free.
  • Virtual ECG – Third party application, paid.
  • VLC Media Player – Third party application, free.

To download software not listed in App Manager, see https://zspace.com/downloads. For developer software such as zSpace SDKs and Unity Plugins, see https://developer.zspace.com/downloads.  

Set Up a Repository on a Local Network

The following figure depicts a server hosting a repository accessed by three clients. Most sites only need a single server (ServerX) and a single repository (RepoA). This document describes servers using standard Windows network notation: \\ServerX\RepoA

In this example, ServerX shares directory RepoA using standard Windows file sharing. This directory is an App Manager repository received from zSpace via USB drive or other media.

Note: The repository for local networks is available for customer download from zSpace Customer Support at Perform App Manager Updates Offline.

When App Manager starts, it scans for a repository where it is installed. If there is no local repository and there is an Internet connection, App Manager connects to the online repository. If App Manager cannot find a repository, it displays the error message Can't connect to Application Server.

Important: Follow standard IT operating procedures when creating local repositories. Configure the packages, index, and directory as Read Only to prevent users from deleting or corrupting the repository. Note that all users accessing the repository via symlink have direct access to the repository files.

View currently used repository

You can view what repository App Manager is currently set to using by pressing ctrl+shift+R. zSpace online repositories start with http://updates.zspace.com/repositories/. If any other location is displayed, then you are using a Local Network Repository. To enable or disable a Local Network Repository location, please see the following sections.

Enable Local Network Repository Access

You can configure enterprise clients to access a repository for local network updates. This allows groups to update software without connecting to the internet. This is also useful in locations like China where large downloads often fail.

The following steps configure enterprise clients for local network updates, allowing App Manager to have centralized access to a repository on your local network.

Create a symbolic link to a remote directory that hosts the repository and configure App Manager clients to use this repository.

Open a DOS Command Prompt window as Administrator. Navigate to the App Manager folder C:\Program Files\zSpace\App Manager. The following example uses ServerX from the previous example in this document. Make sure you can access the remote directory using the following command:

C:\Program Files\zSpace\App Manager> dir \\ServerX\RepoA M

Create a symlink to your remote directory:

C:\Program Files\zSpace\App Manager> mklink /D RepoA \\ServerX\RepoA

The command mklink /D [localFolderName] \\serverName\RepoLocation creates a local directory called localFolderName that becomes the remote server location. You must have permissions to access this server. In this example we create a directory named RepoA. This folder must contain an index.tar.gz file. This is the file that App Manager reads to determine what is in the repository. App Manager treats this folder as one of the repositories.

The command mklink /D [localFolderName] \\serverName\RepoLocation creates a local directory called localFolderName that becomes the remote server location. You must have permissions to access this server. In this example we create a directory named RepoA. This folder must contain an index.tar.gz file. This is the file that App Manager reads to determine what is in the repository. App Manager treats this folder as one of the repositories.

After executing this command, RepoA appears in the same folder as App Manager.

Note: If there is a space in the name of the server path, enclose the path in quotes. Such as mklink /D “local Folder Name With Spaces” \\serverName\

No spaces are allowed in the repository name. You cannot rename RepoA to Repo A.

To confirm that the link is successful, run the command dir RepoA. If the output list includes an index.tar.gz file, the repository is linked.

Disable Local Network Repository Access

You can reset App Manager to access the Internet-based zSpace repository. This requires an active and reliable Internet connection.

In a DOS Command Prompt window, navigate to the App Manager folder C:\Program Files\zSpace\App Manager. From that folder, remove the symlink to your repository.

Use the command rmdir [localFolderName] to remove the local directory and link. You must have sufficient permissions to execute this command.

C:\Program Files\zSpace\App Manager> rmdir RepoA

After executing the command in the preceding example, RepoA no longer appears in the same folder as App Manager.

Follow the instructions for using the Internet repository at Updating zSpace STEM Applications.

Perform App Manager Update Offline

zSpace provides a repository for performing App Manager updates offline. The offline repository is ideal for customers who:

  • Have a slow or unreliable Internet connection.
  • Do not allow zSpace Systems to access the Internet.
  • Have large zSpace labs.

If none of these conditions apply to you, use the online version of App Manager.

Warning: The offline repository file is over 13GB in size. Some locations may have problems downloading a file this large.

Installation Instructions

  1. In the Chrome web browser, navigate to zSpace.com and log in to your zSpace account.
  2. Click here to download the offline repository.
  3. Wait for the download to complete. Unzip zSpaceOfflineRepository-vX.X-Release.zip to your desktop or a USB drive. Unzip to the desktop to update a single zSpace. Unzip to a USB drive if you need to update more than one zSpace.
  4. Open the folder and run zSpaceAppManager.
  5. Perform all available updates and installations. Wait for all applications to update and install.
  6. If you have Internet access, find the zSpace Update Service icon in the Windows Taskbar and click Open zSpace App Manager.
  7. Update or install applications as needed.
  8. When you are done, delete the zSpaceOfflineRepository-vX.X-Release folder.

Command Line Interface (CLI)

From a DOS Command Prompt window you can enter App Manager CLI arguments. You can install, update, remove (uninstall), and query package information. List output is in JSON format.

CLI arguments are case sensitive.

Syntax for App Manager in command line mode:

C:\Program Files\zSpace\App Manager> zSpaceAppManager.exe -command <option>

Commands and supported options:

Argument Description
 -install <package ...>  Install a package by name, where <package …> is the name of the package such as <>.
 -installAll  Install all available packages in the repository.
 -update <package ...>  Perform update on package if there is an update available.
 -updateAll  Performs all available updates.
 -remove <package ...>  Uninstall the named package from the system.
 -interactive  Run the application with default UI.
 -listAll  List all packages that are in the repository.
 -listUpdates  List updates that are available.
 -listInstalled  List installed packages.
 -listAvailable  List packages that are available for installation.
 -checkForUpdates  Returns the number of updates available.
 -version  Displays the application version.
 -help  Displays all arguments with descriptions.

Error Codes

zSpace command line functions return error codes that translate as follows:

Error Code Description
0 No Error.
1 Bad Parameter.
2 Already initialized.
3 Value is out of range.
4 Invalid data.
5 Data already exists.
7 Unsupported format.
8 Can't load.
9 Out of memory.

10

Not implemented.
11 Could not create user interface component.
12 GL error.
13 Generic failure.
14 Event not handled.
15 Busy.
16 User cancelled error.
17 LibPNG error.
18 No items to install.
19 Package failed validation.
20 Preconfiguration failed.
21 Unpack failed.
22 Configuration failed.
23 Post install failed.
24 Remove failed.
25 Package could not be found.
26 Can't add package
27 Install cannot start.
28 Can't create a start menu item.
29 Can't remove a start menu item.
30 Failed to start service.
31 Failed to remove service.
32 Cannot remove package due to dependency.
33 HTTP request failed.
34 HTTP reply unknown error code.
35 Too many redirects or missing location.
36 Cannot read content portion of HTTP reply.
37 Low-level connection error.
38 Can't create something.
39 User paused process.

Known Issues

When using command line functions that query the database such as listAll, listInstalled, listAvailable, and listUpdates, you cannot redirect the command output to a file.

Workarounds:

  • Copy and paste output from the command window into a file.
  • View the App Manager log file containing the command output at:

C:\ProgramData\zSpace\Logs\App Manager\zSpaceAppManager.log

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments