You are on page 1of 13

Installation Guide

MineScape 2021
Installation Guide

© Copyright 2021 Datamine Software

All Rights Reserved

Confidential and Proprietary

Legal Disclaimer
The product described in this documentation may be connected to, and/or communicate information and
data via, a network interface, which should be connected to a secure network. It is your sole
responsibility to ensure a secure connection to the network and to establish and maintain appropriate
measures (such as but not limited to the installation of firewalls, application of authentication measures,
encryption of data, installation of antivirus programs, etc.) to protect the product, the network, your
systems, and the interface against any kind of security breach, unauthorised access, interference,
intrusion, leakage, damage, or corruption or theft of data. We are not liable for damages or losses related
to any such security breach, unauthorised access, interference, intrusion, leakage, damage, or corruption
or theft of data.

2
Installation Guide

Contents
Software Distribution Portal ............................................................................................................................................ 4
Installation Files ................................................................................................................................................................... 5
MineScape System Services............................................................................................................................................... 5
MineScape Client ................................................................................................................................................................... 5
MineScape Design File Server .......................................................................................................................................... 6
MineScape License Server .................................................................................................................................................. 6
MineScape Help ..................................................................................................................................................................... 6
Download Installation Files ............................................................................................................................................... 7
Install MineScape ................................................................................................................................................................. 7
Install MineScape System Services ................................................................................................................................. 7
Install MineScape Client...................................................................................................................................................... 8
Install MineScape Design File Server ............................................................................................................................. 8
Install MineScape Help ........................................................................................................................................................ 9
Silent Installation ................................................................................................................................................................... 9
Install MineScape System Services ......................................................................................................................... 9
Install MineScape Client .......................................................................................................................................... 10
Install MineScape Design File Server .................................................................................................................. 11
Language Settings ............................................................................................................................................................. 11
Appendix 1: Known SubscribeNET Errors ................................................................................................................ 13
Incorrect login details ....................................................................................................................................................... 13
Appendix 2: Known Download and Installation Errors......................................................................................... 13
Installation............................................................................................................................................................................. 13
Another version of this product is already installed ...................................................................................... 13
Not enough disk space .............................................................................................................................................. 13
Installation is slow ...................................................................................................................................................... 13

3
Installation Guide

Software Distribution Portal


The MineScape Software Distribution website is a secure website that provides you with 24/7 access to
your software and licenses.
Note: The MineScape Software Distribution website is best viewed with Microsoft Internet Explorer.

Activity Steps
1. Open a web browser and browse to the MineScape Software Distribution site:
https://minescape.flexnetoperations.com
The login page displays:
2. Enter your Login ID and Password
Your login and password details can be found in the welcome email from
minescape@flexnetoperations.com. The Password Finder tool can be used to retrieve your login
details.
3. Click Login.

4
Installation Guide

Installation Files
MineScape installation files can be downloaded from the official Software Distribution website. A valid
login ID and password is needed in order to access the website. Please check your SubscribeNET
welcome email for your login details.
The following installation files are available for download:
• MineScape System Services (MineScapeSystemServices-2021-[Version].[Build].exe)
• MineScape Client (MineScape-2021.[Version].[Build].exe)
• MineScape Design File Server (MineScapeDesignFileServer-2021-[Version].[Build].exe)
• MineScape License Server (MineScapeLicenseServer-2021-[Version].[Build].exe)
• MineScape Help (MineScapeHelp-[Version].[Build].exe)
MineScape installers can be run silently through a command line window. For MineScape Client, a
separate Windows installer file (MineScape2021-[Version].[Build].msi) needs to be run through the
command line window.

MineScape System Services


The MineScape System Services installer is responsible for installing the following components:
• a local MineScape Design File service
• a local MineScape Monitor service
• the MineScape System Services version of the MineScape Diagnostics tool
(MineScape.DiagnosticsTool.exe)
The MineScape System Services installer also checks to ensure that the following third-party
components are available and current:
• Microsoft Visual Studio C++ Redistributables
• Microsoft .NET Framework
Refer to the System Requirements section for more information on the third-party requirements.
The MineScape System Services installer needs to be run by a user with administrative privileges and
only needs to be installed once for each machine with a MineScape Client installation. MineScape
System Services cannot be installed on a machine with an existing MineScape Design File Server
installation.

MineScape Client
The MineScape Client installer is responsible for installing the front-end user interface where all of your
work with MineScape will be done. It is here that you will be taking advantage of MineScape's wide array
of plugins and functionality. The MineScape Client installer will also install MineScape's update and
rollback functionality, allowing each user to control their application updates and version configuration
for their account.
MineScape Client needs to be installed on each machine that will be running MineScape. If a single
machine has multiple users, MineScape Client needs to be installed for each user. The MineScape Client
installer does not need to be run by a user with administrative privileges.

5
Installation Guide

MineScape Design File Server


The MineScape Design File Server installer is responsible for installing the following components:
• a local MineScape Design File service
• a local MineScape Design File Monitor service
• the MineScape Design File Server version of the MineScape Diagnostics tool
(DesignFile.DiagnosticsTool.exe)
MineScape Design File Server cannot be installed on a machine with an existing MineScape System
Services installation. In a multi-user environment, MineScape Design File Server should be installed
onto a designated server or host machine, i.e. the machine that will be accessed by MineScape users.
MineScape System Services and MineScape Client should be installed on the machines where
MineScape is running.

MineScape License Server


The MineScape License File Server installer is responsible for installing the following components:
• MineScape License Server
• the MineScape License Server web interface
• a local MineScape License Server Monitor service
• the MineScape License Server version of the MineScape Diagnostics tool
(LicenseServer.DiagnosticsTool.exe)
The MineScape License Server installer also checks to ensure that the following third-party components
are available and current:
• Microsoft Visual Studio C++ Redistributables
• Microsoft .NET Framework
• Java Runtime
Refer to the System Requirements section for more information on the third-party requirements.
In a multi-user environment, MineScape License Server should be installed on a designated server or
host machine, i.e. the machine that will be accessed by MineScape users. The designated server or host
machine should also have MineScape Design File Server installed on it. In a single-user environment,
MineScape License Server should be installed on the same machine as MineScape Client and MineScape
System Services.

MineScape Help
MineScape provides online and offline versions of the MineScape help. MineScape's online help content
is stored on an official MineScape help server and can only be accessed using an internet connection.
MineScape's offline help refers to the help content installed using the MineScape Help installer.
MineScape Help should be installed on the same machine as the MineScape Client installation. While a
MineScape Help installation is not required to successfully run MineScape, it should still be available in
case internet connection issues or a local network outage prevents you from accessing MineScape's
online help.
The MineScape Help installer does not need to be run by a user with administrative privileges.

6
Installation Guide

Download Installation Files


Activity Steps
1. Log in to the MineScape Software Distribution site.
The Product Information page displays.
2. Click the MineScape version hyperlink.
The Software Terms and Conditions page displays.
3. Click I Agree to accept the terms and conditions.
4. Locate the MineScape version entry. Click the hyperlink to download the installation file.
The installation file is downloaded using your browser's current download settings. If the Mass
Download check box is selected, you are able to download multiple files at once by clicking the
Download Selected Files button.
Note: The Download Manager option and the Mass Download check box require the Java Runtime
Environment. The latest Java Runtime Environment can be downloaded from the official Java web
site.

Install MineScape
Install MineScape System Services
The following topic covers the installation of MineScape System Services.
MineScape System Services is installed under the following directory:
C:\Program Files\Datamine\MineScape\System Services\

Up to 210 MB of free disk space is needed for the MineScape System Services installation. The
MineScape System Services installer needs to be run by a user with administrative privileges and only
needs to be installed once for each machine with a MineScape Client installation.
Note: MineScape System Services cannot be installed on a machine with an existing MineScape Design
File Server installation.

Activity Steps
1. Locate the folder that was used to store the downloaded MineScape installation package.
2. Double-click on the installation file.
The MineScape installation splash screen displays.
3. Click Install System Services.
4. Click Exit.

7
Installation Guide

Install MineScape Client


The following topic covers the installation of MineScape Client.
MineScape Client is installed under the following directory:
C:\Users\<user name>\AppData\Local\Datamine\MineScape2021\app-[Version][Build]

Up to 450 MB of free disk space is needed for the MineScape Client installation. MineScape Client
needs to be installed on each machine that will be running MineScape. If a single machine has multiple
users, MineScape Client needs to be installed for each user.
The MineScape Client installer does not need to be run by a user with administrative privileges.

Activity Steps
1. Locate the folder that was used to store the downloaded MineScape installation package.
2. Double-click on the installation file.
The MineScape installation splash screen displays.
3. Click Exit.

Install MineScape Design File Server


The following topic covers the installation of MineScape Design File Server.
MineScape Design File Server is installed under the following directory:
C:\Program Files\Datamine\MineScape\Design File Server

Up to 260 MB of free disk space is needed for the MineScape Design File Server installation.
In a multi-user environment, MineScape Design File Server should be installed onto a designated server
or host machine, i.e. the machine that will be accessed by MineScape users. MineScape System Services
and MineScape Client should be installed on the machines where MineScape is running.
Note: MineScape Design File Server cannot be installed on a machine with an existing MineScape
System Services installation.

Activity Steps
1. Locate the folder that was used to store the downloaded MineScape installation package.
2. Double-click on the installation file.
The MineScape installation splash screen displays.
3. Click Install Server.
4. Click Exit.

8
Installation Guide

Install MineScape Help


The following topic covers the installation of MineScape Help.
MineScape Help is installed under the following directory:
C:\Program Files\Datamine\MineScape\Help\2021\

Up to 300 MB of free disk space is needed for the MineScape Help installation.
A MineScape Help installation is not required to successfully run MineScape, however, it should still be
available in case internet connection issues or a local network outage prevents you from accessing the
MineScape online help.
The MineScape Help installer does not need to be run by a user with administrative privileges.

Activity Steps
1. Locate the folder that was used to store the downloaded installation file.
2. Double-click on the installation file.
The MineScape installation splash screen displays.
3. Click Install Help.
4. Click Exit.

Silent Installation
The MineScape System Services, Client, and Design File Server installers can be run silently through a
command line window.

Install MineScape System Services


The following topic covers the installation of MineScape System Services through a command line
window.
MineScape System Services is installed under the following directory:
C:\Program Files\Datamine\MineScape\System Services\

Up to 210 MB of free disk space is needed for the MineScape System Services installation. The
MineScape System Services installer needs to be run by a user with administrative privileges and only
needs to be installed once for each machine with a MineScape Client installation.
Note: MineScape System Services cannot be installed on a machine with an existing MineScape Design
File Server installation.

Activity Steps
1. Locate the folder used to store the downloaded installation package.
2. Open a command line window.
3. Through the command line window, locate the directory for the downloaded installation file.
4. Enter the appropriate installation command.
MineScapeSystemServices-[Version].[Build].exe -q -l [LOGFILE]
where -q performs a silent installation and -l outputs details to a nominated log file. Omit the -l
switch to create a default log file under your %TEMP% directory. The default log file is named
'MineScape[INSTALLNAME]_YYYYMMDDHHMMSS.log'.
Use –h or –help to see a full list of commands.
5. Press ENTER.

9
Installation Guide

Install MineScape Client


The following topic covers the installation of MineScape Client through a command line window. Unlike
other MineScape installers, MineScape Client requires a separate Windows installer file
(MineScape2021-[Version].[Build]-x64.msi) to perform the installation through the command line
window.
The MSI installer file allows local system administrators to deploy machine-wide installations. Refer to
https://msdn.microsoft.com/en-us/library/windows/desktop/cc185688(v=vs.85).aspx for more
information on Microsoft Windows Installer.
The MSI installer will add a copy of MineScape.exe to the following directory:
C:\Program Files (x86)\MineScape 2021 Installer\MineScape.exe

The MineScape.exe is run automatically when a user logs onto the machine for the first time. This
behaviour is controlled by adding the following registry entry:
Key -
KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Run\MineScape2021Machin
eInstaller
Value - #%%ProgramFiles%\MineScape Installer\MineScape2021.exe --checkInstall

Note: MineScape will automatically start after the machine-wide installation has finished.

Activity Steps
1. Locate the folder used to store the downloaded installation package.
2. Open a command line window.
3. Through the command line window, locate the directory for the downloaded installation file.
4. Enter the appropriate installation commands.
msiexec /i MineScape2021-[Version].[Build].msi /q /lv* logfile
where /i install and configures the product, /q performs a silent installation and /lv* creates a log file
for the installation. Refer to https://msdn.microsoft.com/en-
us/library/windows/desktop/aa367988(v=vs.85).aspx for a full listing of command line options.
5. Press ENTER.
Note: The installation will fail if an existing '%LOCALAPPDATA%\MineScape2021' folder is found.
Delete this folder to successfully complete the installation.

10
Installation Guide

Install MineScape Design File Server


The following topic covers the installation of MineScape Design File Server through a command line
window.
MineScape Design File Server is installed under the following directory:
C:\Program Files\Datamine\MineScape\Design File Server

Up to 260 MB of free disk space is needed the MineScape Design File Server installation. MineScape
Design File Server cannot be installed on a machine with an existing MineScape System Services
installation. In a multi-user environment, MineScape Design File Server should be installed onto a
designated server or host machine, i.e. the machine that will be accessed by MineScape users.
MineScape System Services and MineScape Client should be installed on the machines where
MineScape will be running

Activity Steps
1. Locate the folder used to store the downloaded installation package.
2. Open a command line window.
3. Through the command line window, locate the directory for the downloaded installation file.
4. Enter the appropriate installation command.
MineScapeDesignFileServer-[Version].[Build].exe -q -l [LOGFILE]
where -q performs a silent installation and -l outputs details to a nominated log file. Omit the -l
switch to create a default log file under your %TEMP% directory. The default log file is named
'MineScape[INSTALLNAME]_YYYYMMDDHHMMSS.log'.
Use –h or –help to see a full list of commands.
5. Press ENTER.

Language Settings
MineScape supports the following language settings:
• English
• Polish
• Russian (Russia)
• Chinese (Simplified, PRC)
The MIN_LANGUAGE environment variable must be defined. The MIN_LANGUAGE environment
variable is used to translate all messages from the applications back end, for example, module logs, user
command feedback and reports. Front end translations for the user interface and forms are controlled
by the language setting set through Control Panel.
Note: When using the Chinese (Simplified, PRC) language setting, an additional language pack needs to
be installed.

11
Installation Guide

To set the MIN_LANGUAGE environment variable


1. Select Control Panel from the Windows Start button.
2. Select System and Security.
3. Select System.
4. Select Advanced System Settings.
The System Properties dialog displays.
5. Click Environment Variables.
6. The Environment Variables dialog displays.
There are two types of environment variables:
• User Variables - Only apply to each user’s setup. User variables take precedence over system
variables with the exception of PATH. The system path is inserted before the user variables.
• System Variables - System-wide variables that are inherited by all users. Most MineScape
variables belong to this category. Administrator privileges are required to create system
variables.
7. Click New.
The New System Variable dialog displays.
8. Complete the following fields:
• Variable Name - Enter MIN_LANGUAGE.
• Variable Value - Enter the variable value. Supported values are 'CHS' for Chinese, 'Polish' for
Polish, and 'Russian' for Russian (excluding quotes).
9. Click OK.
10. Click OK.

To set the display language


1. Select Control Panel from the Windows Start button.
2. Select Clock, Language, and Region.
3. Select Region and Language.
The Region and Language dialog displays.
4. Click the Formats tab.
5. Select a language from the Format list.
Note: For Windows 10 operating systems, ensure that the Use Unicode UTF-8 for worldwide
language support check box has been cleared. Selecting this check box results in Windows
overriding the language selected from the Formats list. The Use Unicode UTF-8 for worldwide
language support check box is accessed by clicking the Change system Locale button on the
Administrative tab.
6. Click OK.

12
Installation Guide

Appendix 1: Known SubscribeNET Errors


Incorrect login details
Ensure the user name and password details are entered correctly. Passwords are case-sensitive. A
temporary password can be requested via the Password Finder tool.
https://minescape.flexnetoperations.com/control/minc/password

Appendix 2: Known Download and


Installation Errors
Installation
Another version of this product is already installed
The existing MineScape installation needs to be removed.

Not enough disk space


You need to make more space available on the disk where you are installing the product.

Installation is slow
• Ensure enough RAM is available on the current machine. All open applications should be closed
before running the installation.
• Anti-virus software can result in slow installation speeds and should be temporarily disabled.
Note: Contact your local network administrator or support desk before attempting to disable anti-
virus software.
• Microsoft .NET Framework 4.6.2 and the Microsoft Visual C++ 2015 Redistributable are now
included with the MineScape installer. These components are automatically installed as part of the
MineScape installation process.
Note: In rare cases, Microsoft's KB2999226 update will need to be installed manually on systems
prior to Windows 10 (including Windows Server 2008/2012) before proceeding with the MineScape
and License Server installations. The absence of this update may result in the installation process
hanging for a period of time before reporting a failure to install. The update can be found at
http://support.microsoft.com/kb/2999226..

13

You might also like