SysCAD Files

From SysCAD Documentation
Jump to: navigation, search

Navigation: User Guide -> SysCAD Files

Related Link: Project Structure

This page is for SysCAD 9.3, for SysCAD 9.2, please see SysCAD Files 9.2


Introduction

When SysCAD is installed a number of folders and files are created and for SysCAD to function correctly, it is necessary to keep certain files at the correct locations. The default name for the main SysCAD folder given during install is 'SysCAD93'.

Please note that SysCAD is not a 'lean' client, and as such it must be installed on the computer that is to run SysCAD. A user may not install the software on another computer, or server, and then run SysCAD on their PC. (Of course, SysCAD can be installed on a remote computer and SysCAD can be run on the remote computer from another computer using Remote Desktop or similar software)

To illustrate the function and necessity of these folders and files, an example install is used and the sample file location tree is as follows:

SysCADFiles1.png

(Note: Not all the example folders are shown here)

SysCAD File Structure 2.png

The two folders that must be located in the main SysCAD folder on a PC for SysCAD to run on that PC are:

  • BaseFiles; and
  • bin.

All of the other folders may be moved to different locations, or deleted. (The user must be able to locate a valid SysCAD license elsewhere if the License folder is deleted)

The folders are explained in the following sections.

Bin Folder

This folder MUST always be present and must not be removed - SysCAD will not run if this folder is missing.

When SysCAD is installed, it places all the program files in the bin folder. These include:

  • SysCAD93.exe;
  • Dynamic Link Libraries (dlls);
  • DLLs for users with custom add-ons; and
  • COM Type Libraries (tlb) files.

If the user wishes to upgrade to the latest SysCAD version, but not run a full install, then they can unzip the upgraded SysCAD bin files into this folder.

Base Files Folder

This folder MUST always be present and must not be renamed. Full user access permissions are required in this folder.

When SysCAD is installed, it places all the distributed data files in the Basefiles folder. These include:

  • Default.93.db3 - The default species database containing a species table that is available to all users.
  • Symbols folder - contains all the standard drawing symbols available in SysCAD.
  • SysCADSymbolsList.pdf - This file contains a list of the drawing symbols available in SysCAD (ie: Basefiles\Symbols folder). The purpose of this file is for user to view the available symbols without having to scroll down the list one at a time. (NOTE: New Symbols maybe added to SysCAD from time to time, this file may not contain all the symbols.)
  • Fonts folder - contains some fonts file, not used by SysCAD.
  • QuickViewDefaults.2.ini - a file used to define default tag lists for Quickview for each model type.
  • In addition it contains a number of templates for the text based (controller and reaction) files.

All files stored in this folder should be treated as global data files, that is, any projects can access these reference files. No user specific files should be placed in this folder, they should go in BaseFilesUser.

These files are supplied by SysCAD and can be overwritten or updated at any time (a new install, SysCAD update, etc). A recommended practice before installing a major update is to delete the contents of the BaseFiles folder so that no "old" or "obsolete" files are unintentionally retained.

If this folder is deleted, SysCAD will not run.

Base Files User Folder

This folder is used to store user preferences, settings, custom conversions and user defined symbols. If SysCAD is re-installed, it will NOT overwrite any files stored in this folder.

This folder is used to store users defined Graphics Symbols. These symbols will be available for use in SysCAD in the same list as the standard symbols. When moving to a new computer, you can copy your Symbols between PCs.

Examples Folder

When SysCAD is installed a number of Example projects are stored in this folder. They have been developed to demonstrate various SysCAD features and to provide users with a basic starting point for new projects.

For example, if a user wishes to create a SysCAD model of an Ammonia plant, then they could create a copy of the Example Ammonia plant and use that as the basis for a more complex model.

This folder may be deleted or moved. A recommended practice before installing a major update is to delete the contents of the Examples folder so that no "old" or "obsolete" projects and files are unintentionally retained.

See Example Projects and Project Structure for more information.

License Folder

This folder contains files required for the SysCAD license. Full user access permissions are required in this folder.

This is the default license location and contains all of the licensing files. However, a user may move this folder to another location or rename it before the license is issued and then browse to the new location the first time that SysCAD is opened (thereafter the software will remember the location).

The license does NOT normally need to be upgraded when SysCAD is upgraded.

Note: This folder may be deleted, moved or renamed, only if the license is NOT stored in this folder or it has not yet been issued. Once a license has been issued to this location, the folder must not be moved or renamed. If either of these steps is carried out the SysCAD license will be lost.

Setup Folder

This folder contains files used during SysCAD set up or for future use such as the LicenseUtility folder.

The setup folder has a number of sub-folders containing software that is used in tandem with SysCAD. Most of this software is installed when SysCAD is installed, but it is also available here if the user wishes to re-install it. We recommend that users install Notepad++ as it has a number of advantages over the standard text editor installed with Windows. This can then be set as the default text editor used for editing the control files, or PGM files.

This folder may be deleted or moved.

Tutorial Folder

This folder contains files used as part of the standard SysCAD training courses. They also show how different projects can use the same CfgFiles folder.

This folder may be deleted or moved.

SysCAD Files

Most of the SysCAD created files are essential and care should be taken to keep these files in the correct location.

The following files are required to run SysCAD or are used for related functionality:

Executable

SysCAD93\bin\SysCAD93.exe

Main SysCAD Files (Dynamic Link Libraries)

SysCAD93\Bin\DevLib.dll
SysCAD93\Bin\DevLibEx.dll
SysCAD93\Bin\DevUtils.dll
SysCAD93\Bin\FlwLib.dll
SysCAD93\Bin\FlwSlv.dll
SysCAD93\bin\KWDB.dll
SysCAD93\Bin\MdlBase.dll
SysCAD93\Bin\ScDDESrvr.dll
SysCAD93\Bin\ScdIF93.dll
SysCAD93\Bin\ScdLib.dll
SysCAD93\Bin\ScdOPCSrv.dll
SysCAD93\Bin\ScdSlv93.dll
SysCAD93\Bin\ScExec.dll
SysCAD93\Bin\ScHist.dll
SysCAD93\Bin\scOPCsrv.dll
SysCAD93\Bin\sqlite3.dll
SysCAD93\Bin\TagDocDB.dll
SysCAD93\Bin\UnZip32.dll
SysCAD93\Bin\Zip32.dll
SysCAD93\bin\xxx.dll (Model libraries eg. Basic1.dll Control1.dll, Piping1.dll...)

Command to register SysCAD files (COM_Automation and SysCAD Marshal)

SysCAD93\Bin\RegAll.cmd
SysCAD93\Bin\RegAll_Direct.cmd
SysCAD93\Bin\RegAll_Verbose.cmd
SysCAD93\Bin\UnregAll_Direct.cmd

SysCAD Files for COM Automation (COM Automation)

SysCAD93\Bin\ScdSlv93.tlb
SysCAD93\Bin\ScdIF93.tlb
SysCAD93\Bin\SysCAD93.tlb

SysCAD Marshal files (SysCAD Marshal)

SysCAD93\Bin\SysCADMarshal93.exe
SysCAD93\Bin\SysCADMarshal93_ps.dll

OPC Server Test files

SysCAD93\Bin\ScdIODB.exe

SysCAD data files

SysCAD93\Basefiles\Default.93.db3
SysCAD93\Basefiles\Symbols\*.*
SysCAD93\Basefiles\Template.inc.pgm
SysCAD93\Basefiles\Template.1.pgm
SysCAD93\Basefiles\Template.rct
SysCAD93\BasefilesUser\Conversions.db3
SysCAD93\BasefilesUser\Symbols\*.*
SysCAD93\BasefilesUser\SysCAD.Machine.ini
SysCAD93\BasefilesUser\SysCAD.User.xxxx.ini

SysCAD License Files (Licensing)

SysCAD93\License\READMEV7.TXT
SysCAD93\License\CKS.exe (Used by SetupEx.exe)
SysCAD93\License\SetupEx.exe (The CrypKey License Service Setup Install program)
SysCAD93\License\SetupEx_Force.cmd (Force install, see Re-installing Crypkey)
SysCAD93\License\SysCAD.exe (required)
SysCAD93\License\crp32002.ngn (required)
SysCAD93\License\SysCAD.CIHS (created)
SysCAD93\License\SysCAD.ckn (created)