Plant Model - Project

From SysCAD Documentation
Jump to navigation Jump to search

Navigation: User Guide ➔ View ➔ Plant Model ➔ Project

FlwSolve Tab Settings Tab Audit Tab Project Tab RC Tab Species Tab Views Tab Soluble Tab WaterQuality Tab Qualities Tab
Environment Tab System Tab ModelList Tab Flowsheets Tab PrjNetworks Tab Status Tab Statistics Tab States Tab EvalSeq Tab Globals Tab

Related Links: Plant Model Class


Introduction

This tab page on the Plant Model Access Window has three sections:

  1. Allows the user to input project related information. The Project Information section is only available in Build138 or later.
    • User can add various information that will describe the project, this includes two external links.
    • If a Hyperlink has been entered for "DescLink" (project description link), then user can jump to this link by (1) View - Project Description OR (2) Graphics Page's Right Click context menu - Project Description
    • For SysCAD distributed projects, the project description is available on Example Projects.
  2. Allows a number of user defined Global parameters that can be used in Custom Calculations, PGM OR Model Procedures (MP).
    • When the user wishes to access these tags, for example the first value, the tag is: PlantModel.PUV1.Value OR PM.PUV(1). (See Plant Model Class)
  3. Allows adding a Tag List to set before initialisation
    • This works the same as the Set Tag List except that the tags are set at the very start of the initialisation process. This can be used to set tags which need to be set prior to other logic which occurs during initialisation. Some examples are page activations, controllers on/off and variables which are referenced in the calculations/logic which is part of the "Initialise_Prestart" subroutine in a PGM.
Tag (Long/Short) Input / Calc Description / Calculated Variables / Options

Project Information

(The Project Information section is only available in SysCAD 138 or later)

Project ...
Name Text User Input Field. For Example: Nickel Copper Demo Project.
Location Text User Input Field. For Example: Local Drive - SysCAD\Examples
Version Text User Input Field. For Example: Project updated to SysCAD 138.
Date Date User Input Field. For Example: 15 April 2019.
Status Text User Input Field. For Example: Solved to sample data.
Manager Text User Input Field. For Example: KWA Team Manager.
Engineer Text User Input Field. For Example: KWA Team Engineer.
Other Text User Input Field. For Example: Example project for distribution with install.
Link Hyperlink Document link. This can be a hyperlink to a web address or a full-path to a file. If a hyperlink is entered, user can click on the Hyperlinkicon.png icon to access the file.
For Example: C:\SysCAD93\Examples\40 Nickel\Demo Nickel Copper Project.spf\Reports\Project Criteria Report.xlsx
DescLink Hyperlink Document link for project description. This can be a hyperlink to a web address or a full-path to a file. If a hyperlink is entered, user can click on the Hyperlinkicon.png icon to access the file.
  1. If a web address is entered, for example: https://help.syscad.net/index.php?title=Nickel_Copper_Project, then the "Project Description" menu command will open the web page.
  2. If a full path is entered for a file with a known file type, for example, "C:\SysCAD138\Examples\40 Nickel\Demo Nickel Copper Project.spf\Reports\Project Criteria Report.xlsx", then the "Project Description" menu command will open the file in MS Excel. (Note this may depend on file association and software installed on the user's computer.)
Description/Desc Text User Input Field. For Example: The "Link" document contains the model criteria. The "DescLink" document contains a brief description of the project.

Project User Values

To use these values in the PGM or MP files, please see Plant Model Class

PUV.Count Display The maximum number of Project User Values allowed.
PUV1 Input Description for the User Input Value
PUVx Input Description for the User Input Value
PUV12 Input Description for the User Input Value

Tag List to set before initialisation

On Tickbox Enables or disables the SetTagList Block.
Status Display The status of the SetTagList with a brief summary of the file.
Folder Display The full path of the Set Tag List file.
File Input The file name of the Set Tag List. Relative File Path can be used. Note: this file must be created first. File can be txt or csv format.
 
Edit Button Allow the user to edit the file.
Browse Button Use this button to Browse for the file.
LogTagSets None SysCAD will not log the tag sets.
Messages SysCAD will log the tag sets in the Messages window only.
EventLog SysCAD will log the tag sets in the Event Log only.
Messages and EventLog SysCAD will log the tag sets in both the Messages window and the Event Log.
 
SetTags Button Use this button to Set the Tags into SysCAD.
 
ColumnToSet Input This specifies which column of values will be used when the tag list is set. Default value is 1 which corresponds to the first column of values.
StopOnBlankTag Tickbox SysCAD will stop searching for tags to be set after the first blank row.