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.

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.

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>zSpace_AppManager.exe --command <option>

Commands and supported options:

Argument Description
--silent Runs in silent mode (without UI). **Required** to use any of the install/update/remove arguments.
--selfupdate Checks for self-update then shuts down.
--local Asks for local directory to install from on session startup.
--install=package Install a package by name where "package" is the id value of the application as it appears in the library. **NOTE** Must use --silent in addition to this command for it to work.
--installAll Install all packages in the library. **NOTE** Must use --silent in addition to this command for it to work.
--update=package Perform update on package if there is an update available. **NOTE** Must use --silent in addition to this command for it to work.
--updateAll Performs all available updates.
--remove=package Uninstall the named package from the system. **NOTE** Must use --silent in addition to this command for it to work.
--debug Runs app manager in debug mode, where debug file is written to `C:\Users\USERNAME\AppData\Local\zSpace, Inc\zSpace AppManager\host.developer.log`
--debugfile Runs app manager in debug mode, where debug file is written to `C:\Users\USERNAME\Desktop\host.developer.log`
--debugdir=path Runs app manager in debug mode, where debug file is written to the path specified. Example: `--debugdir="C:\ProgramData\zSpace\Logs\App Manager\"`
--perday Logs all sessions for each day to a date-stamped log filename. Example: `host.developer.08.22.2019.log`
--maxdays=integer Maximum amount of "perday" logs to keep on machine. The oldest daily logs are deleted as new ones are written.
--balsa-machine-serial-override Sets the machine type for the session.

 

Have more questions? Submit a request

Comments