View source for SysCAD Installation Instructions

{{Navigation|[[User Guide]]|[[Getting Started]]|altname=Installation Instructions}}
{{Tutorial Header Table |currentpage=3}}

'''Related Links:''' [[Upgrading Projects]], [[SysCAD Installation Tests]], [[Licensing]]
----
{{TOC}}
== Introduction ==

SysCAD is a 32-bit Windows application that can be used with Microsoft Windows 32-bit and 64-bit operating systems including Windows 11 and Windows 10.  Please see [[#Hardware, Operating System, and Software Requirements|Hardware, Operating System, and Software Requirements]] section for more detail.

{{SysCAD Version}}

This page contains instruction for:
# [[#New SysCAD Installation|New Installation of SysCAD]] - when you are installing SysCAD for the first time.
# [[#Installing a different Version or Major Build of SysCAD|Installing a different Version or Major Build of SysCAD]] - if you are installing an additional copy of SysCAD as a separate standalone installation.
# [[#Updating SysCAD|Updating SysCAD]] - if you are updating the current SysCAD program files to the latest Minor Build update.

===Accessing SysCAD Installation Files===
SysCAD users with download rights can access the latest installation and update files from the [https://www.syscad.net/login/ syscad.net] download site.
*Each client account includes at least one [[Downloading_SysCAD_Software_and_Updates#Admin_User|Admin User]] with download privileges.
*The Admin User can manage access and grant additional users permission to download files on behalf of their company.
*To reassign Admin User privileges, please contact: [mailto:support@syscad.net support@syscad.net]

=== Download the Latest SysCAD Program Files ===

To download the latest SysCAD installation or update file:
# '''Check Download Privileges''': Ensure you have download access. Refer to [[#Accessing SysCAD Installation Files|Accessing SysCAD Installation Files]] for details.  
#'''Login to the SysCAD Download Site''': Visit the SysCAD downloads page (https://www.syscad.net/login/) and log in using your username and password.  
#'''Locate the Required Files''' (See [[Downloading SysCAD Software and Updates]] for more information.)
#*The SysCAD full installation file (SysCAD9.3InstallBuildXXX.yyyyy.exe) can be obtained from the "SysCADxxx Full Install" section.
#*The SysCAD update file can be obtained from the "SysCADxxx Update" section.

NOTE: 
#The SysCAD download website is not the same as the basecamp file sharing site.  See [[Downloading_SysCAD_Software_and_Updates#File_Transfers_.28Basecamp.29|File Transfers (Basecamp)]].  
#The two separate sites (SysCAD download and File Transfer) have different username and password.

==Hardware, Operating System, and Software Requirements ==

{{Hardware and Software requirements}}

== New SysCAD Installation ==

===Before You Begin===

Please ensure the following prerequisites are met before installing SysCAD:

#'''Extract the Installation File''':If you downloaded the SysCAD installer as a compressed (ZIP) file, extract it to a temporary folder before proceeding.
#'''Administrator Rights Required''':You must have Administrator or Local Administrator privileges to:
#*Install SysCAD
#*Register SysCAD files
#*Install the Crypkey Licensing Service
#:⚠️ Note: Simply using "Run as Administrator" may not be sufficient, as the installer launches other programs that also require elevated privileges.
#'''Avoid Sync Drives''':Do not install SysCAD on a sync-enabled drive (e.g., OneDrive). SysCAD requires a static folder path for licensing. Sync drives may alter the path and prevent the license from working correctly.

===Installation Steps===

Run the installation executable (e.g., SysCAD9.3InstallBuild139.37044.exe) and follow the on-screen instructions. The full installation includes:

#'''SysCAD Core Files''': including SysCAD application, library files, example/tutorial projects and utilities
#'''Microsoft Visual C++ Redistributable''': Installs ''vc_redist.x86.exe'' 
#'''Registry Updates''':Registers SysCAD OPC and COM interfaces via ''regall_direct.cmd''
#'''Reaction Editor''': Installs the SysCAD Reaction Editor (used for editing reaction files)
#'''Crypkey Licensing Service''': Installs [[SysCAD and Crypkey Licensing Software|Crypkey Licensing Service]] (setupex.exe)
#'''Shortcuts''': Adds a desktop shortcut and Start menu entry for SysCAD

NOTES:
*''Default Installation Path'': SysCAD installs to C:\SysCADxxx (e.g., C:\SysCAD139). Subfolders include: BaseFiles, Bin, Examples, License, Setup, Tutorial and so on. Please refer to [[SysCAD Files]] for more information.
*''Independent Installers'': Steps 2–5 are available as standalone installers in the \SysCADxxx\Setup folder. You can reinstall or repair them independently if needed.
*''User Permissions'': After installation, users must have full access rights to the SysCADxxx folder and all subfolders. This is essential for:Opening example/tutorial projects; Using the distributed database; Adding custom add-ons and Accessing the software license.
*''Verify Installation'': After setup, run basic tests to confirm SysCAD is installed correctly. Refer to [[SysCAD Installation Tests]] for guidance.

===Additional Recommended Installs===

#'''VS Code Extension''': It is strongly recommended to use Visual Studio Code (VS Code) for editing SysCAD .PGM and .MP files. 
#*If VS Code is not already installed on your system, you can download and install it from the official [https://code.visualstudio.com/Download VS Code website].
#*Once installed, you should also install the SysCAD PGM Language Extension for VS Code. This extension enables syntax highlighting and other features tailored for SysCAD scripting. Installing the extension is essential for it to appear as an option within SysCAD. For detailed setup instructions, refer to the [[Using VS Code]] guide. 
#'''Notepad++''': As an alternative to VS Code, Notepad++ can also be used to edit .PGM and .MP files. 
#*An installer is included in the \SysCADxxx\Setup folder. For installation and configuration instructions, see the [[Using Notepad++]] documentation.
#'''Network License Users''': If you are using a network license, ensure that the SysCAD License Server is correctly configured. This is necessary for license validation and access. For setup details, refer to the [[Licensing#Network Software License|Network Software License]] documentation.  
#'''.NET Framework Requirement''': The ''SysCAD Reaction Editor'' requires ''Microsoft .NET Framework 4.5'' or newer. If this is not already installed on your system, you will need to download and install it to ensure the Reaction Editor functions correctly.

=== Licensing ===

Once installed, SysCAD needs a valid license. This may be a USB License Key or a software key. Please refer to [[Licensing]] and [[Getting_Started#Licensing| Getting Started]] for more information.

== Updating SysCAD ==
To update SysCAD to a new minor build, you only need to replace the key files located in the SysCADxxx\Bin folder. These binary files include:
*SysCAD93.exe (main executable)
*Various .DLL files (dynamic-link libraries)
This method allows for a quick update without reinstalling the entire application.  

NOTE:
#Updating only the Bin folder will not affect other components such as example projects or BaseFiles. If you wish to use any newly released or updated examples, you will need to download and update those files separately.  
#If your current installation is more than six months old, it is recommended to perform a full installation rather than a simple update. This ensures that you receive the latest versions of all components, including BaseFiles, example projects, and supporting utilities, which may have undergone significant changes or improvements.

See [[Downloading SysCAD Software and Updates]] for more information.

=== Applying the Update Files ===
The following applies when user wants to apply a SysCAD minor update.  For example, from SysCAD 9.3 Build 139.'''27329''' to SysCAD 9.3 Build 139.'''27436'''
* The SysCAD update file (binXXX.yyyyy_SysCAD.zip) can be obtained by downloading it from the SysCAD downloads page (https://www.syscad.net/login/).
* Ensure SysCAD is closed (and any application that might be referencing SysCAD using COM).
* Unzip the update directly into the SysCADxxx\bin folder, replacing all previous files.  (For example, the Update file for Build 139.27436 can be unzipped into the C:\SysCAD139\bin folder).

=== Optional updates on other SysCAD files===

There are also updates for BaseFiles, Example projects, etc. that can be downloaded and unzipped in a similar way.

=== Keeping Multiple SysCAD Minor Versions ===

When applying the updates to SysCAD:
* If you wish to retain the old build for comparison purposes, you can make a copy of the existing bin folder before extracting update (this is optional).  
* For example, you can create a new folder to store each update (optional).  
:[[image:multiplebuilds139.png]]
* SysCAD can be started from any of the new bin locations. As these are located inside the same installation folder, they will use the same base files and license as the current build.

=== Re-installing SysCAD ===

The following applies when user re-installs a version of SysCAD with the same version and Major build.  For example, from SysCAD 9.3 Build 139.'''30599''' to SysCAD 9.3 Build 139.'''30613'''

Generally, full installation is not required for a minor update.  However, if the existing SysCAD installation files are corrupted, then user may re-install SysCAD "on top" of an existing installation (must have the same Major Build number, e.g.: Build139). 
*It is not necessary to uninstall SysCAD first, but this can be completed if you would like to remove the existing sample projects and BaseFiles.  
*it is not necessary to install to a new location.
*The new installation will not corrupt existing licenses, but in some cases you may need to check in SysCAD that the license location is pointing at the correct folder.
*The new installation would not delete any user files stored in \SysCADxxx\BaseFilesUser folder.
*You can also choose to retain a version of the previous Build by making a copy of the bin folder before installing (this is optional).  For example, if you are upgrading to Build 139.30613 and your current Build is 139.30599 you can copy and rename the folder "Bin139_30599" to retain the older version.  

'''Note''': Because the full SysCAD install calls the install for Microsoft Visual C++ Redistributables and these are likely already install it may ask if you wish to repair the install. You can skip or cancel this step or allow the "repair".

==SysCAD Script or Silent Install==

The normal method for installing SysCAD is described above, but it is possible to install SysCAD as part of a command script. This method is typically only implemented by IT and must be run with administrator privileges. There is a silent install option for SysCAD using command line option "/VerySilent". IMPORTANT: When using /VerySilent the third party tools used are not installed, so the script needs to install these components as shown in the example. The components that need to be installed are described [[#New SysCAD Installation|above]].

{{collapse | title = Example cmd script for Silent Install | content = <syntaxhighlight lang="bat">
@echo off
cd %~d0%~p0
Echo "Installing SysCAD"
Rem /? will provide further information
Rem /LOG="FileName" is optional and is used to generate an installation log file.
Rem /DIR="Path\Filename" is optional and is used to set the target installation location (if not set then default is used)
SysCAD9.3InstallBuild139.37016.exe /VerySilent /LOG="FileName" /DIR="Path\Filename"

Echo "Installing VC Redist"
Rem /norestart is optional
vc_redist.x86.exe /q:a /norestart

Echo "Installing Reaction Editor"
msiexec.exe /i "SysCADReactionEditor1.5.msi" /quiet
 
Echo "Installing Crypkey"
"Path\setupex.exe" \q

Echo Update registry for SysCAD OPC and COM interfaces
regall_direct.cmd
 
Rem The S is case sensitive 
Echo "Installing Notepad++"
npp8.5.2.Installer /S
 
Echo "Install script completed"
Pause
</syntaxhighlight>}}

== Installing a different Version or Major Build of SysCAD ==

The following applies when user upgrades a SysCAD version or Major Build (e.g.: SysCAD 9.3 Build '''138''' to SysCAD 9.3 Build '''139''')

*When upgrading to a new version or major build of SysCAD, full installation is required.
*Please follow the [[#New SysCAD Installation|New SysCAD Installation]] instruction to install the new build to a separate folder. 
*After upgrading to the new version of the software, it is important to also upgrade any projects to the new build.  For notes on upgrading projects between Builds see [[Upgrading Builds]].
*It is recommended to keep the different versions of SysCAD (e.g. SysCAD137, SysCAD138, SysCAD139) on your computer as side-by-side installations.  
:[[image:multiplebuilds139_2.png]]

This allows the user to:
#Open the existing projects in the build they are created.  This may be required if you are working with clients that are using a different version of SysCAD.
#compare project results during and after project upgrade process.

NOTES:
* These different Builds will NOT share the same base files, examples, etc.  Each installation has its own "BaseFiles" and "examples".
* For a shared software license you may need to check the settings for the license location.
* If [[COM Automation]] or [[OPC]] is used, then it needs to know which version of SysCAD to open. To force a particular build to be used, run the RegAll.cmd file in the corresponding bin folder.
* It is also possible to install multiple copies of the same SysCAD version and major build.