File Commands in 9.1

From SysCAD Documentation

Jump to: navigation, search

Navigation: User Guide -> Menu Commands -> File Commands

This section shows the File Commands in SysCAD 9.1. Refer to File Commands in 9.2 for SysCAD 9.2.

Contents

New - Project

Command Button Image:User Guide image096.jpg

Command Path File, New, Project

Short Cut Key Ctrl + N

If a project is currently opened:

User will be able to save and close the current project before the Creating a New Project Dialog box is displayed.

If no projects are currently opened:

The New | Project command will bring up the Creating a New Project Dialog box, from which a new project will be created.

Image:User Guide image097.gif

The user must select a project configuration file either from the list provided or use the Browse button to find an existing cfg file. If the configuration file has not been created, the user can use the New or Copy commands to generate one.

To create a new configuration file, click on the NEW button.

Image:User Guide image098.gif

Enter the name of the configuration file and check the Folder path is correct. Click OK when finished.

FOR EXAMPLE: If the above configuration file was added and a project was created, then the following will be created:

  • A folder under SysCAD90 called NewCfg, configuration file NewCfg.cfg will be stored in this folder.
  • A subfolder cfgfiles (SysCAD.mdb will be created and stored in this folder. This database will only contain steam/water information.)

You may also use an existing configuration file as a template and save it as another file. To do this, highlight the configuration file you would like to copy from and press the COPY button.

Image:User Guide image099.gif

Enter the name of the configuration file and type in a folder name (must have full path). You may use the Browse button to help locate the folder. Click OK when finished.

FOR EXAMPLE: If the above configuration file was added and a project was created, then the following will be created:

  • A folder under SysCAD90\Tutorial called CopyCfg, configuration file Copy of Tutorial.cfg will be stored in this folder.
  • A subfolder cfgfiles (SysCAD.mdb will be created and stored in this folder. This database will be an exact copy of the one existed in the Tutorial\General tutorial folder.)

If you are upgrading SysCAD from a previous version or starting SysCAD from a new location and would like SysCAD to find all available configuration files for you, you can use Auto-Find. This will open the Auto-find project configurations dialog box:

Image:User Guide image100.gif

You are required to enter the root folder for search. For example, if your SysCAD project files are located under C:\SysCAD90 then type this path in the dialog box above. SysCAD will then search for *.cfg files present in all sub-folders under the C:\SysCAD90 folder. SysCAD will add all cfg files in the new format automatically into the list. However, when SysCAD finds a cfg file in the old format, it will prompt you with the following message to confirm the upgrade.

Image:User Guide image101.gif

If you no longer require a configuration file to appear in the list, highlight the unwanted file and use Remove to remove it from the list.

SysCAD also allows the user to edit the configuration file prior to starting the new project, this can be done using Edit button, once again, select the configuration file you would like to edit first. For more information on editing the configuration file, see Models Configuration (.cfg File).

To open the new project, select the correct models configuration file by highlighting it and press OK on the Create a New Project Dialog box. You will be prompt to type in the name of the project. When all is complete, SysCAD will then bring up the New Project Setting Dialogue box for user to define some default project settings.

Image:NewProjectSettings.gif

Selected the appropriate project settings and press OK.

The new project is created; a default windows will be created if the Create new Graphics Window and Create New Trend Window options were selected.

New - File

Command Path File, New, File

Short Cut Key Ctrl + N

If no SysCAD project were opened, this command would be the same as New | Project. If a project is already opened, SysCAD will display the following dialog box:

Image:User Guide image102.gif

Choosing Graphics or Trend from the list will open a new Graphics Window Grf_x.scg or a Trend Window Trend_x.trn respectively. You may also open a controls trend page by selecting Trend with Controllers.


Note this is not available if SysCAD is solving or running.


Open - File

Command Button Image:User Guide image104.jpg

Command Path File, Open, File

Short Cut Key Ctrl + O

This allows you to open any closed Graphics Window or Trend Window. This option is not available when SysCAD is solving or running.


Open - Project

Command Button Image:User Guide image104.jpg

Command Path File, Open, Project

Short Cut Key Ctrl + O

This allows you to open an existing project, Graphics Window or Trend Window. This option is not available when SysCAD is solving or running.

  • If an existing SysCAD project is not yet loaded, then you will be given the option to load a project. Find the required project.spf folder using the Look in pull down list, click on the project.spj file and press Open.
  • If a SysCAD project is already opened, you can open any closed graphics window or trend windows. Selected the required files and press Open.

Image:User Guide image105.gif


Open - Open Project (Alt Cfg)

Command Button Image:User Guide image107.jpg

Command Path Project, Open (Alt Cfg)


NOTE: This option is not available when SysCAD is solving or running.

This function allows the user to choose different customised project configurations when loading the project. If a project is already opened, you can use this command to open a different project. If an alternative configuration is needed for the current project, close the project first, and then use the Open Project (Alt Cfg) command to load the project with the new configuration file.

From the Open dialog box, choose the project, from the Loading Project dialog box, press browse to add in the new configuration file(xxxx.cfg) or choose one from the list. Select the configuration file by highlighting it and press OK.


NOTE: By changing the project configuration like this, you are essentially creating a new project. Therefore, if species are missing in the new configuration file, model data that is associated with the missing species will not be loaded. To avoid permanent data lost, it is recommended that you do a Save Project As if you intend to keep both versions of the project.


The advantage of this feature is that you can use subsets of the species database for smaller projects and you can revert back to the full list if required.


Save - Save Project

Command Button Image:User Guide image109.jpg

Command Path File, Save, Save Project

Short Cut Key Ctrl+S

This is used to save the project. See Save Project.


Save - Save Project As...

Command Path File, Save, Save Project As...


NOTE: A project save cannot be performed if SysCAD is running or solving.

This command saves the entire project in a new project folder and copies all referenced files if requested. With the project save as dialog box opened, find the correct folder to put the new project and type in a name for the project. Press Save.

A Project Save Options dialog box will be opened requesting for user input on what referenced files to copy if present. See Save Project Version... for the various options.

BEWARE:

Make sure to choose a correct location for the new project folder, as this will help with file management.


Save - Save Project Version...

Command Path File, Save, Save Project Version...

This command saves the project with a version number. See Save Project Version...


Save - Save Project Layout

Command Path File, Save, Save Project Layout

This will save the position and size of all the windows as well as the position and arrangement of the toolbars. The layout is automatically saved when a project is saved. This command is useful if you want to save the layout of the project without saving the entire project.


Save - Rename Graphics As

Command Path File, Save, Rename Graphics As

Short Cut Key Ctrl+Shift+A

This command is only available if the active window is a graphics window.

This creates a new copy of the graphics window, closes the old window and saves it with a new name. This is not available if SysCAD is solving or running. WARNING

This action only makes a copy of the Graphics Symbols on the page but does not save/copy any project or models information, thus it CANNOT be used to save model data NOR can it be used to make a copy of the models on the graphics page.


Save - Save Trend

Command Path File, Save, Save Trend

Short Cut Key Ctrl+Shift+S

This command is only available if the active window is a trend window.

This saves the active trend window only. This command cannot be performed if SysCAD is running or solving.


Save - Save Trend As

Command Path File, Save, Save Trend As

Short Cut Key Ctrl+Shift+A

This command is only available if the active window is a trend window.

This creates a new copy of the trend window, closes the old window and saves it with a new name. This is not available if SysCAD is solving or running.


Close - Close Project

Command Path File, Close, Close Project

This closes the current project. This command is not available if SysCAD is running or solving. Before closing the project, SysCAD will prompt for save of the project.


Close - Close Active

Command Path File, Close, Close Active

This closes the active window. This is not available if SysCAD is solving or running. The Message, Command, Plantmodel And Access Windows cannot be closed. If the Project.SpjWindow is closed, the project is closed. SysCAD will prompt for save of the project before closing.


WARNING

If a graphics or Trend Window is closed, it will NOT be automatically opened when the project is loaded the next time. To reopen closed Graphics or Trend Windows, use the Open command.

This closes the current Active Graphics Window or Trend Window. This command is not available if SysCAD is running or solving. Before closing the window, SysCAD will prompt for reconfirmation.

It is recommended to keep all the graphics windows opened in SysCAD. The reason being if a window is closed, it will not be saved when the Save Project command is used. Worst still, if a Save Project version or Save Project As is used, the closed graphics window will not be copied over thus may result in missing graphics pages permanently. Closed graphics window will also cause problems during project merge because the graphics page is not available for tag name changes.

As a general rule, ALWAYS use the MINIMISE button if the pages are not being used and only close the graphics pages if the models on the pages are being represented by another page or the models on the page have been deleted.


Open Project

Command Path File, Open Project

Short Cut Key Ctrl + O

This allows you to open an existing project. This option is not available when SysCAD is solving or running.


Save Project

Command Button Image:User Guide image109.jpg

Command Path File, Save Project

Short Cut Key Ctrl+S

This is used to save the project. This action will save the entire project using the existing project name overwriting the existing data. If you wish to save to a new project name use the Project Save | Save Project As... or Save Project Version... command. Before closing a project or exiting SysCAD, you will be prompted to save the project. A project save cannot be performed if SysCAD is running or solving.

Hint:

A project should be saved regularly to avoid lost of information during building of a new project or when making major changes to existing projects.


Save Project Version...

Command Path File, Save, Save Project Version...


NOTE: A project save cannot be performed if SysCAD is running or solving.

This command is similar to the Project Save As... command with only one exception. Part of the file name will be prefixed with the old project name.

For Example:

If you have project - SteadySt.spf opened and want to save with the Save Version... command.

You will be presented with the Project Save Options dialog box.

Image:User Guide image110.gif

If you leave this Comment text blank and press OK, your new project will be saved in a folder called SteadySt-00.spf. If this is saved again with Save Version... the new project will be called SteadySt-01.spf.

Alternatively, you can type in a version Name, eg, Test. The New Project will then be saved in a folder SteadySt(test)-01.spf.

Database Format:

This allows the user to specify the Scd_mdls.mdb format. (File in which SysCAD stores all the models information.). The global default for this option can be set via Options - General - Global.

Database Options - Remove Previous Revisions:

This allows the user to specify the Scd_mdls.mdb save options. (File in which SysCAD stores all the models information.) The global default for this option can be set via Options - General - Defaults.


NOTE: It is recommended to select the Remove Previous Revision Option to keep the database small and more accessible. This will also shorten the save and load times.

Database Options - Copy DB Files:

This allows the user to specify the Scd_mdls.mdb save options. (File in which SysCAD stores all the models information.) The global default for this option can be set via Options - General - Defaults. If this field is not selected, SysCAD will build a new Scd_mdls.mdb file during save. This is necessary during project upgrades with SysCAD version change, in which the option is not selectable.


NOTE: This Option is no longer settable. SysCAD will always build a new Scd_mdls.mdb when a new project is created.

Close Project

Command Path File, Close Project

This closes the current project. This command is not available if SysCAD is running or solving. Before closing the project, SysCAD will prompt for save of the project.


Delete Project

Command Path File, Delete Project YET TO BE IMPLEMENTED.

Zip Project

Command Path - File, Zip Project YET TO BE IMPLEMENTED.

Snapshot/Scenario - Load Snapshot

Command Button Image:User Guide image112.jpg

Command Path File, Snapshot/Scenario, Load Snapshot

Once a project is loaded, previously saved snapshots can be loaded. See below for how to use command Snapshot/Scenario | Save .

To load a snapshot, just select the appropriate file from the list and press Open.

Image:User Guide image113.gif

When a snapshot is loaded, models that exist in the snapshot but not in the project are ignored, and models that exist in the project but not in the snapshot are left unchanged. The time taken to load a snapshot is significantly faster than a project load. SysCAD may be running while snap-shots are being loaded. However, for best results, pause the project before loading a snapshot.

Snapshot/Scenario - Save Snapshot

Command Button Image:User Guide image115.jpg

Command Path File, Snapshot/Scenario, Save Snapshot

Once a project is loaded, snapshots of the project can be saved. A snapshot of the project is just what the name suggests; it is a still picture of the current project, that is, a binary dump of the state of a project. It saves all the configuration data for all unit models in the project.

The time taken to save a snapshot is significantly faster than project save and the user can request a Save Snapshot while SysCAD is solving or running. However, for best results, pause the project before saving a snapshot.

All snapshot files have the extension snp. The naming of snapshots may be automated. This is done through the General options dialog box, tab page Snapshots as shown below:

Image:User Guide image116.gif

The Prompt for filename option generates the file save dialog box where a filename can be entered.

The Automatically incrementing filename option lets SysCAD generate a filename based on a combination of the Filename prefix and Next Snapshot number fields.

The Reuse same filename option always uses the filename specified in the Default fixed filename field, the old snap-shot is always overwritten.

The option Zip Snapshot/Scenario files will save the files in a ZIP format, reducing the file size for storage purposes.

Snapshot/Scenario - Load Scenario

Command Path File, Snapshot/Scenario, Load Scenario...

Once a project is loaded, previously saved scenarios can be loaded. The time taken to load a scenario is significantly faster than a project load, and slightly slower than a snapshot load. SysCAD may be running while a scenario is being loaded.

When a scenario is loaded, the models that exist in the scenario but not in the project are ignored, and models that exist in the project but not in the scenario are left unchanged. Scenarios can be used for Scenario Comparisons since a saved scenario saves all the calculated values, which are required for meaningful scenario comparisons. See Snapshot/Scenario | Compare Scenario.

Snapshot/Scenario - Save Scenario

Command Path File, Snapshot/Scenario, Save Scenario...

A Project Scenario is very similar to a Project Snapshot. Once a project is loaded, a scenario can be saved. Unlike a snapshot, a scenario is a complete binary dump of the state of a project. That is, all configuration data and calculated data will be saved for all unit models. BEWARE: If the project is very large, this is then a very large file. User can save this file in a zip format, see Snapshot/Scenario | Save .

The time taken to save a scenario is significantly faster than a project save, and slightly slower than a snapshot save. SysCAD may be running while a scenario is saved. However, for best results, pause the project before saving a scenario. Once Scenarios are saved, it can be used for Scenario Comparisons for debugging purposes. See Snapshot/Scenario | Compare Scenario.


Snapshot/Scenario - Compare Scenario

Command Path File, Snapshot/Scenario, Compare Scenario...

This command can be used to

  • compare previously saved Scenarios,
  • compare previously saved Scenario with current values,
  • compare previously saved Snapshots,
  • compare previously saved Snapshot with current values.

These are done through the Compare Tag Values Dialog box.

Image:User Guide image117.gif

Use the Add... button to add in files for comparison:

Image:User Guide image118.gif

Use the browse button to find the 1st file, either a scenario or a snapshot. Enter the 2nd file name if required or you can choose to compare the 1st file with the current values. Enter the output file name or use the window as the output destination. Press OK when completed and you will be back to the Compare tag Values dialog box.

The Delete button allows you to delete a comparison entry.

The Edit button brings you back to the Compare dialog box.

The Done button closes the Compare Dialog box.

The Compare button performs the comparison of the files.

The Options button opens the Tag Value Comparison Options dialog box:

Image:User Guide image119.png

This dialog box lets you to customise the compare output file.

Another similar command is Compare Data.

Print

Command Button Image:User Guide image121.jpg

Command Path File, Print

Short Cut Key Ctrl+Shift+P

Used for printing the Graphics Window graphics, Access Window information and Trend Window trends.

When print is pressed, SysCAD will print the information on the active window only. When the Graphics Window is printed, all graphics will be printed in one colour depth. If the active window is the Trend Window, the following pop up dialog will appear:

Image:User Guide image122.gif

The Trend Window is separated in two sections; the user can print out either the Trend Line View or the Trend List View or Both. If use true colours is selected, the user can print out the Trend lines in colour if colour printing or in shades of grey if using a black and white printer.


Please NOTE that the Access Window cannot be printed from this command. To print the Access Window contents, open the Access Window for a selected Unit Operation, and select print from the Access Window Option button. When printed, each tab page will be on separate pages.


Hint:

Printing the file \SysCAD\SCD_Log.csv can print the error messages in the Message Window.

Print Multiple

Command Path File, Print Multiple

Short Cut Key Ctrl+Shift+P

Used for printing multiple Graphics Window pages. Any graphics page must be active to select this command. The user will then be given a dialog box that can be used to select any number of the graphics pages to be printed. The graphics will be printed in one colour depth.

Print Preview

Command Path File, Print Preview

This is currently not available for use.


Print Setup

Command Path File, Print Setup

Used for setting up the current print/printer options.


Import

Command Path File, Import


NOTE: SysCAD must be in the Edit mode for this command to be accessed.


Image:User Guide image123.gif

Selecting SysCAD Flowsheet from the above dialog box will activate the Project Merge command, which is used to merge two projects together. To do this, the projects must belong to the same project group, thus using the same species database, same dynamic libraries, and the same model configuration file.

For Example:

Open the SysCAD project to merge into; this is the master project.

From the File | Import and select SysCAD Flowsheet from the Import dialog.

In the Project Merge dialog box, (show below)

Enter the file name for the imported project in the project to import field. (Or use the browse button to find the file.) This is the slave project.

Image:User Guide image124.gif

The Tag Changing Method section of the dialog box can be used customised duplicate tags for the merged project.

Type in the path for Report file or use the default file name

Press OK.

SysCAD will now check if the two projects can be merged together. If so, it gives a detail report of what is going to happen when the projects are merged.

When satisfied, press continue to execute Merge of the two projects or cancel to go back to the previous dialog window.

When finished, use the Project Save | Save Project As... command to save the merged project as a new project.


NOTE: If the user is merging two projects each containing a reference file (for example reaction file) with the same name, then a merge problem will occur. Instead of giving the continue page, SysCAD will give a warning detailing the problem encounter. The user can then choose to go ahead with the merge, thus not copying the reference file in the slave project or to cancel the merge operation. WARNING: See also Close | Close Active for warning on implications of closed graphics window(s) in either projects.

Exit

Command Path File, Exit

Short Cut Key Alt F4

Exits SysCAD. Will prompt for save of opened project before exiting.

Personal tools
Document Sections