View source for SysCAD Files

[[Category:Project Files]]
{{Navigation|[[User Guide]]|[[Getting Started]]}}
{{Tutorial Header Table |currentpage=4}}

'''Related Links:''' [[Project Structure]]
----
{{TOC}}
== 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 'SysCADxxx'.

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:
{|
|[[Image:SysCADFiles138_1.png|450px]]
|
*The two folders that must be located in the main SysCAD folder on a PC for SysCAD to run on that PC are:
*# \BaseFiles
*# \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.
|}

== Base Files Folder ==
{|
|-
|Valign=top|[[File:SysCADFiles138_2.png]] ||Valign=top| 

This folder [[Image:Button Small 1.png]] '''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: 
*'''''Fonts''''' folder - The Fonts folder contains font shape(.shp) files that define the appearance of text in the Graphics commands [[Insert_Graphics_Commands#Insert_Text|Insert Text]] and [[Edit_Graphics_Commands#Change_Text|Change Text]]. These files are only compatible with SysCAD versions starting from Build 139.34893. Older versions of SysCAD do not use these files.
*'''''Symbols''''' folder - contains all the standard drawing symbols available in SysCAD.
*'''''TemplateReports''''' folder - contains the report templates.  These templates are used to auto create "02GeneralReport.xlsx" and "04DetailedReport.xlsx" for each project.  User can modify these templates to their reporting standards.  (If these are modified, please keep a backup in the BaseFilesUser Folder  so they do not get overridden in the event of re-installing SysCAD at the same location.)
*'''''Default.93.db3''''' - The default species database containing a species table that is available to all users.
*'''''IonList.txt''''' - This file is a backup file for TCE projects that need an ion list file. When the ion list.txt file is not in the TCE project group, this file will be added to the project automatically.
*'''''SysCADSymbolsList.pdf''''' - This file contains a list of the drawing symbols available in SysCAD (i.e.: 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.)

*'''''QuickViewDefaults.2.ini''''' - a file used to define default tag lists for Quick View 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 [[Image:Button Small 2.png]] 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.

== Bin Folder ==

This folder [[Image:Button Small 3.png]] '''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
* COM Type Libraries (tlb) files

Please see [[#SysCAD Files|SysCAD Files]] for a more detailed list of the files present in this folder.

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.

== Examples Folder ==

{|
|-
|[[File:SysCADFiles138_3.png]] ||Valign=top|

When SysCAD is installed a number of Example projects are stored in this folder [[Image:Button Small 4.png]].  

These projects have been setup to demonstrate features and functionalities in SysCAD, or to show some common circuits used by specific industries.

For example:
*The 02 Features sub-folder contains projects on how to set up or use solubility, makeup, or demand.
*The 03 UnitModels sub-folder contain projects on how to set up flash trains, solvent extraction circuits, counter current circuits, etc.
*The 10 Alumina sub-folder will show some common circuits used by the alumina industry.  
*The 40 Nickel sub-folder has a demonstration project for a simplified Ni-Cu plant.  

These projects may 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.

|}

Please NOTE that some projects would require additional add-on (and license option) to run.  See [[Example Projects]] and [[Project Structure]] for more information.

== License Folder ==

This folder [[Image:Button Small 6.png]] 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.  
*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 ==

{|
|-
|[[File:SysCADFiles138_7.png]] ||Valign=top|

This folder [[Image:Button Small 7.png]] contains files used during SysCAD set up or for future use. 

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.
*The '''LicenseUtility''' folder can be used to test/authorise the SysCAD license. Please see [[Licensing#License_Authorisation_using_Licensing_Utility|License Authorisation using Licensing Utility]] for more information.
*Network license Client/Server folders are for users with network licenses, please see [[Network License]] for instructions on how to use these files.
*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.
*OPC setup folder is for user with dynamic license and SysCAD Marshal (OPC) Add-on. See [[SysCAD_Marshal#Getting_Started_with_OPC_Server_and_Client|Getting Started with OPC Server and Client]] for more information.

This folder may be deleted or moved.

|}

== Tutorial Folder ==

{|
|-
|[[File:SysCADFiles138_8.png]] ||Valign=top|

This folder [[Image:Button Small 8.png]] contains files used as part of the standard SysCAD steady state training courses. 
*Various training and reference documents can be found in this folder, including the Introductory Tutorial, Getting Started and Quick Reference documents.  See [[Tutorial_Overview#Steady State Introductory_Tutorial|Steady State Introductory Tutorial]] for more information. 
*All the tutorial projects are using the same '''"CfgFiles"''' folder.
*Each project in this folder corresponds to a section of the tutorial documentation.
*These projects can be used as starting points during training if required.


This folder may be deleted or moved.

For more information on the Tutorial documentation, please see [[Tutorial Overview]]

|}

== CfgFiles Folder ==

Each "Project Group" should contain a Cfgfiles folder (An example of a project group is give above: [[#Tutorial Folder|Tutorial Folder]])

The CfgFiles Folder should contain:

#'''SysCAD.93.db3''' - The project Species database containing species data used by the project group.
#One or more configuration files with extension cfg.  For example: '''''Basic.cfg''''' or ''NickelCopper.cfg''

The project group Species data base file and the project configuration file used by the project must be stored in the same folder.
{|
|-
|[[image:cfgfile.png]]
|
Other files that maybe stored in the cfgfiles folder are:
*CnvDefaults.ini - to stored user selected conversion units (for access window display)
*Options.CopyBlockData.ini - for Data transfer
*QuickViewFormats.2.ini - to store user defined Quick View entries.
|}
== SysCAD Project Folder ==
{{SysCAD Project Folder}}

== 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'''
:SysCADxxx\bin\SysCADxxx.exe

'''Main SysCAD Files (Dynamic Link Libraries)'''
:SysCADxxx\Bin\DevLib.dll
:SysCADxxx\Bin\DevLibEx.dll
:SysCADxxx\Bin\DevUtils.dll
:SysCADxxx\Bin\FlwLib.dll
:SysCADxxx\Bin\FlwSlv.dll
:SysCADxxx\bin\KWDB.dll
:SysCADxxx\Bin\MdlBase.dll
:SysCADxxx\Bin\ScDDESrvr.dll
:SysCADxxx\Bin\ScdIF93.dll
:SysCADxxx\Bin\ScdLib.dll
:SysCADxxx\Bin\ScdOPCSrv.dll
:SysCADxxx\Bin\ScdSlv93.dll
:SysCADxxx\Bin\ScExec.dll
:SysCADxxx\Bin\ScHist.dll
:SysCADxxx\Bin\scOPCsrv.dll
:SysCADxxx\Bin\sqlite3.dll
:SysCADxxx\Bin\TagDocDB.dll
:SysCADxxx\Bin\UnZip32.dll
:SysCADxxx\Bin\Zip32.dll

:SysCADxxx\bin\xxx.dll (Model libraries e.g. Basic1.dll Control1.dll, Piping1.dll...)

'''Command to register SysCAD files '''  ([[COM_Automation]] and [[SysCAD_Marshal|SysCAD Marshal]])  
:SysCADxxx\Bin\Elevate.cmd
:SysCADxxx\Bin\RegAll.cmd
:SysCADxxx\Bin\RegAll_Direct.cmd
:SysCADxxx\Bin\RegAll_Verbose.cmd 
:SysCADxxx\Bin\UnregAll_Direct.cmd

:NOTE: This group of files are added during full SysCAD installation, they are not supplied with Bin update files.

'''SysCAD Files for COM Automation'''  ([[COM Automation]])
:SysCADxxx\Bin\ScdSlv93.tlb
:SysCADxxx\Bin\ScdIF93.tlb
:SysCADxxx\Bin\SysCADxxx.tlb

'''SysCAD Marshal files'''  ([[SysCAD_Marshal|SysCAD Marshal]])
:SysCADxxx\Bin\SysCADMarshal93.exe
:SysCADxxx\Bin\SysCADMarshal93_ps.dll

'''OPC Server Test files'''
:SysCADxxx\Bin\ScdIODB.exe

'''SysCAD data files'''
:SysCADxxx\Basefiles\Default.93.db3
:SysCADxxx\Basefiles\Symbols\*.*
:SysCADxxx\Basefiles\Template.inc.pgm
:SysCADxxx\Basefiles\Template.1.pgm
:SysCADxxx\Basefiles\Template.rct
:SysCADxxx\BaseFiles\TemplateReports\SteadyStateGeneral.xlsx 
:SysCADxxx\BaseFiles\TemplateReports\SteadyStateDetailed.xlsx
:SysCADxxx\BasefilesUser\Conversions.db3
:SysCADxxx\BasefilesUser\Symbols\*.*
:SysCADxxx\BasefilesUser\SysCAD.Machine.ini
:SysCADxxx\BasefilesUser\SysCAD.User.xxxx.ini

'''SysCAD License Files'''   ([[Licensing#Crypkey_Licensing_Software_Installation|Licensing]])
:SysCADxxx\License\README.TXT
:SysCADxxx\License\CKS.exe (Used by SetupEx.exe)
:SysCADxxx\License\SetupEx.exe  (The CrypKey License Service Setup Install program)
:SysCADxxx\License\SetupEx_Force.cmd (Force install, see [[SysCAD_and_Crypkey_Licensing_Software#Re-installing_the_Crypkey_Licensing_Software|Re-installing Crypkey]])
:SysCADxxx\License\SysCAD.exe (required) 
:SysCADxxx\License\crp32002.ngn (required)
:SysCADxxx\License\SysCAD.CIHS (created)
:SysCADxxx\License\SysCAD.ckn (created)