Skip to main content

Direct start and data folder in Scopevisio

Detailed supplement on direct start by customer number and a self-defined data folder: edge cases, typical problems and background for support and IT administration.

Internal, more detailed supplement to the customer page "Scopevisio on Citrix: Direct start by customer number & setting the data folder yourself". Purpose of this page: to enable support to assess edge cases of both functions on their own – without requiring developer background knowledge.

Who is this for?

  • IT administrators who deploy Scopevisio on a Citrix or terminal server where several people sign in at the same time, and who want to set up a separate application icon per instance.

  • Support staff who want to start quickly in a specific instance without re-entering the customer number every time.

For a normal installation on a single-user PC, neither function is needed: there, the user enters their own customer number once when signing in to the Scopevisio program, and it is suggested automatically from then on at the next sign-in.

Function 1: Start directly in a specific instance

Normally a user enters their own customer number once when signing in to the Scopevisio program; it is then suggested automatically for the next sign-in. The customer number identifies a single instance – a customer can also have several instances, each with its own customer number.

If it is known in advance which instance should be opened – for example because a separate program icon is provided for each instance – the customer number can instead be passed when the launcher starts. The manual entry at sign-in is then no longer needed.

Scopevisio --public-id=1234567
  • 1234567 is the customer number as shown in the customer portal.

  • This requires that the client used (the .exe on Windows or .dmg/.app on macOS) matches the right environment – the choice between "Standard environment" and "C5 environment" that is also offered when signing in at account.scopevisio.com. This is ensured if the IT administration downloads the client specifically for this environment from the customer portal – the environment is then already stored in the client, no additional information is needed at startup.

Important: If the wrong download (a client for a different environment) is used by mistake, the customer number is usually not found at all – the program then does not start. No understandable message appears for the user, only a technical error that is only visible in the terminal or in the log file. Only if the customer number happens to exist in the wrong environment too, the program starts there and shows the normal login; sign-in then usually fails because the user's own credentials do not exist in that other instance.

Typical use

  • The IT administration first downloads the client matching the environment from the customer portal (see above) and then sets up a separate desktop shortcut for each instance whose target contains the customer number. The user simply clicks the corresponding icon and lands directly in the right instance without any further selection.

  • Support staff who frequently switch between different instances can create similar shortcuts with the respective customer number instead of signing in again every time.

Example on Windows: With a normal desktop shortcut, the options are entered in the "Target" field after the path to the program, e.g.:

"C:\Program Files\Scopevisio\Scopevisio.exe" --public-id=1234567

Exactly the same command line is also stored for a Citrix-published application – technically that is also just a shortcut with a fixed target, displayed to users as an icon.

Example on macOS: There is no shortcut with command-line arguments as on Windows. Instead, the "Automator" program preinstalled on every Mac can be used to create a small application that runs exactly this command on double-click:

"/Applications/Scopevisio.app/Contents/MacOS/Scopevisio" --public-id=1234567

This Automator application behaves like a perfectly normal double-clickable program icon for the user. This is an interim solution until a proper macOS equivalent of a Windows shortcut link (a real per-instance .app) is available.

Function 2: Setting the data folder yourself

The launcher normally stores its own files in the standard user profile (%LOCALAPPDATA%/%APPDATA% on Windows): the Java runtime, the customer client's program file, the configuration of the set-up environments and log files. On many Citrix/terminal server systems, however, this profile is restricted, reset at every sign-out or located on a network drive with little space – the launcher then does not work reliably there or loses its settings at every sign-in.

For such environments, the IT administration can specify a fixed folder in which Scopevisio works instead. This is done via a one-time, system-wide setting – not by the user themselves, and not within the Scopevisio application.

The setting

The environment variable is called SCOPEVISIO_BASE_DIR. An example value:

SCOPEVISIO_BASE_DIR=D:\ScopevisioData\%USERNAME%

This one setting applies to the entire machine and is set once by the IT administration – usually when setting up the server or server image, e.g. via group policy or PowerShell.

Important when setting up: If the variable is set via setx in the command prompt, cmd already replaces the placeholder %USERNAME% with the name of the currently signed-in (administrating) account when typing – all people would then suddenly get the same folder. The variable should therefore be set via PowerShell or a group policy that stores the placeholder unchanged, and checked after setting.

Does this work automatically for several people?

Yes. The IT administration does not have to set the variable for each person individually. The one value shown above with the placeholder %USERNAME% is sufficient – it is replaced automatically at every start with the name of the person currently signed in. For example, when "j.mueller" signs in, their data automatically ends up under D:\ScopevisioData\j.mueller, and for "a.schmidt" accordingly under D:\ScopevisioData\a.schmidt – without any further action by the IT administration.

On a server where several people can sign in at the same time (Citrix, terminal server), the placeholder is mandatory: one identical folder shared by all people is not supported. On a single-user PC or a virtual machine that is only ever used by one person, a fixed path without a placeholder is also sufficient, e.g. D:\ScopevisioData.

Requirements for the folder

  • After the placeholder is substituted, the path must be absolute (no relative path).

  • The folder must be writable for every person who starts Scopevisio. If it is not, the program does not start and names the affected folder.

  • On a multi-user server, no person may be able to access the subfolders of the other people – each person needs full access to their own subfolder, but none to those of the others. Setting up such permissions is a normal Windows administration task and the responsibility of the respective on-site IT administration.

  • After the switch, Scopevisio starts from scratch in the new folder; nothing is automatically carried over from a previous location. The old folder is left untouched but is no longer used.

What this setting does not cover

A small number of personal settings – including the last customer number used at login (see function 1), the window position and any stored proxy settings – remain in a small configuration file (~/.erpclient.properties) in the classic user profile, independent of SCOPEVISIO_BASE_DIR. If the user profile itself is reset by a Citrix or profile management solution or not stored permanently, these few settings are still lost – even if SCOPEVISIO_BASE_DIR is set up correctly.

Both functions together: typical Citrix setup

In typical Citrix use, both functions are combined:

  • There is a separate shortcut with a fixed customer number for each instance (function 1), so that each person lands directly in the right instance.

  • The server is set up so that each signed-in person automatically gets their own data folder (function 2), so that several simultaneously signed-in people do not interfere with each other.

A single person can also use several such shortcuts (for different instances) – the data of the respective instance is automatically kept cleanly separate, even if the parent data folder is the same. Only things belonging to the installation of the launcher itself (e.g. the Java runtime) are shared between the instances of the same person – this is intended and unproblematic.

Typical problems and what they mean

What you see

Possible cause

The program does not start at all, without an understandable message (only visible in the terminal/log)

The wrong download (client for a different environment) was used; the customer number does not exist there

Sign-in fails although the credentials are actually correct

The wrong download was used, and the customer number happens to exist in this (wrong) environment too

Two people on the same server see the same (or missing) settings/data

The data folder was set up without a placeholder for the user name – each person needs their own folder

The launcher reports that a specified folder is unusable or not writable

The configured data folder does not exist or permissions are missing – the IT administration is needed here

Did this answer your question?