Access Window

From SysCAD Documentation
Jump to: navigation, search

Navigation: User Guide -> Windows -> Access Window

This Page is for SysCAD 9.3 Build 137 only. For earlier version of SysCAD 9.3, please see Access Window 9.3, for SysCAD 9.2, please See Access Window 9.2

Introduction

The access window is used to display information about the SysCAD unit such as configuration data, flow information and connectivity with other units.

  • The displayed information is different for each unit type.
  • The view for the unit will change as the simulation changes from ProBal to Dynamic.
  • Up to TWO Access Windows may be opened at any one time :
    1. RIGHT click on a unit operation's graphics symbol to open its Access window.
    2. SHIFT + RIGHT click on the unit operation graphics symbol will open a second instance of the access window. Or alternatively, SHIFT + LEFT click on the unit operation, and select the Access Alt "Name" from the pop up menu.
  • For information on how to configure different unit types, see Models help.

Video Link

Please see this YouTube video link for a brief description of some of the Access Window buttons and functionality.

Example

The Access Window for a Feeder/Cross Page Connector is shown below. This window is for SysCAD 9.3 There are minor layout differences for earlier versions.
(Please see Feeder-Cross Page Connector for more information about this unit.)

Access Window 93.png Button Small 1.png Each of these tabs represents a separate page with information about the unit.
The first Tab is the Unit Type, in this case Feeder / Sink / Cross Page Connector.
Button Small 2.png These are access window buttons, they will be explained in detail in Selection Buttons
Button Small 3.png These White Fields are INPUT files, the user may change these values. Accessing Data Fields
Button Small 4.png Fields with an arrow on the left contain drop-down lists. Click on the arrow to see the available selection.
Button Small 5.png These grey fields are CALCULATED fields, the user may NOT change these values. Accessing Data Fields

Data Entry in SysCAD

Some Access Window display / behaviour options can be set in Tools - General Options - Access Tab.

The various options for the access window are described here: General Options Access.

The way values are entered into the access window input fields (replace / override) can be set by the option: Excel Style Field Editing (Trend and Access)

DataEntryAccessWindow1.png
  1. Option Excel Style Field Editing On - behaves as per data entry in Excel.
    • single click on an access input field, the value entered will completely replace the old value
    • double click on an existing input value, the value at the cursor position is in override mode.
  2. Option Excel Style Field Editing Off - original SysCAD behaviour.
    • click to the left of the existing value, the value entered will completely replace the old value
    • click on an existing input value, the value at the cursor position is in override mode.

For Example:

DataEntryAccessWindow2.png

Accessing Data Fields

  1. AccessWhiteField.pngThe Data Fields that appear in White are changeable and user inputs are normally required.
    • These fields can be number boxes; text boxes with or without pull down lists or check boxes.
    • All required fields come with default values.
    • The SysCAD Models Documentation offers more help on Data input for individual models.
  2. AccessGreyField.png The Data Fields that appear in Grey are NOT changeable by the user. These fields are calculated or derived by SysCAD internally.
  3. Some Data Fields are only changeable when SysCAD is not solving. That is, when a flowsheet is solving (steady state) or running (dynamic state), some originally changeable data fields can be greyed out also.
    • AccessSolvingGreyField.png Examples of such are solving methods or Unit Operation On Tickbox.
  4. If the calculated values appear in black font colour, it means that the project has been solved and the current solution is valid. If the calculated values appear in dark grey font colour, it means either the project has not been solved or some configuration data has since been changed. In such case, the current solution is not valid and project solve is required.
  5. Most Data Fields can be copied and pasted into changeable data fields (white cells), trends, MS Excel or Notepad by using the <Ctrl + T> and <Ctrl + V> key strokes. For more information, see section Copy and Paste.
  6. Most data fields are displayed with a conversion unit - e.g. Mass Flow may be displayed in t/h. The user may change either the Default conversion units, or the conversion units for the individual data field, at any time. Please see Conversions.
  7. When entering data into SysCAD data fields, the default mode is Override. It is represented by a thick cursor. If the cursor is placed away from the number towards the left of the box, the new value entered will replace the old value. If the cursor is placed on the number, then the normal overwrite rule will apply. Pressing the <Ins> key will activate the insert mode. This is represented by a thin line cursor. Alternatively, the Excel Editing Style can be used, where the default is to replace the old value.
  8. While solving or running, data is not updated on the Access Window, to update, press User Guide image044.jpg as required. The Access Window data is updated when SysCAD is stopped.

Selection Buttons

AccessWindowButtons.png The access window buttons are displayed at the top of every unit Access Window.
OK Button.png OK Button This is used to accept all changes made to the Access Window. When a user types in a value, it will be displayed as Blue until the OK button has been clicked. At that point the change is accepted and the value will change to black.
  1. If the user makes changes and does NOT click on the OK button before closing the Access Window, or changing to another command then a dialog box will be displayed to alert the user to save or cancel the unsaved changes.
  2. If AutoSave (see Options Button) is on, then any changes made will be saved automatically without user confirmation. Key setting done via the General Options More dialog.
  3. Pressing [Enter] or [Ctrl+Enter] key is the same as pressing the OK button. Key setting done via the General Options More dialog.
AcceptChanges137.png
Options Button.png Options Button The options are listed under the Options Button heading.
Cancel Button.png Cancel Button This is used to cancel all the unaccepted changes made to the Access Window (i.e. all values still displayed as Blue) and close the Access Window.
MoreButton.png or
LessButton.png
Display More or Display Less Buttons The MoreButton.png button will display ALL the fields on an Access Window. A number of fields may be Hidden, either by default or the user may have chosen to hide them to keep the Access Window uncluttered. The normally Hidden fields are marked by User Guide image049.jpg. By clicking on MoreButton.png these hidden fields will be visible. While all fields are visible, user may click on the individual User Guide image049.jpg mark or Dot (just to the left of the variable) to toggle the show/hide status for the variable.

Once this button has been clicked and all the fields are displayed, the button changes to LessButton.png. Clicking on this button will only display those fields that are not Hidden.

QuickViewButton.png Quick View Button This will open the quick view dialog box. Please see Quick View.
TagLong.png or
TagShort.png
Tag:Long and Tag:Short Button This allows the user to toggle variable tags between Long and short.

Examples of differences between Symbols and Tags for a Pipe is shown:

Short Long
Qm MassFlow
Qv VolFlow
Ti TemperatureIn
Rho Density
SrcIO SourceLink
Unit Help Button93.png or UnitHelpIcon.png Model Help Button Clicking on this will open the Online SysCAD Help to the section for the unit model associated with the open Access Window.

Note: This will only access the Online Help file if the user has access to the Internet.

Change Tag Button93.png or ChangeTagIcon.png Change Tag Button This allows you to change the unit model's tag name from the Access Window.

Old Tag will display the unit's current tag and the user may type in the required tag into New Tag. Please observe SysCAD tag naming rules when specifying the new tag name. Press OK to change the tag. The tag will be changed in the model and any other place where it is referred to within SysCAD, such as PIDs and trend windows.

Please also see Change Tag for more information.

Notes:

  1. User will be warned if the new tag names "already exist", "contain illegal characters" or "too long". Please see Model Tags for information on tag naming rules.
  2. If user types in Space between words, they will be replaced with _ when the tag is changed. For example, "PLANT FEED" will be changed to "PLANT_FEED" when the OK button is pressed.
  3. The Change Tag command will also result in tags changes to all PGM files in the project if the "Apply Tag Change in PGM files" tickbox has been selected from the General Options Project dialog box.
  4. The Change Tag command will also result in tags changes to all CSV and TXT files in the project if the "Apply Tag Change in CSV and TXT files" tickbox has been selected from the General Options Project dialog box.
ChangeTag137.png
Refresh.png Refresh Access Window Button When a project is being solved, the access window data is not updated until the solver stops. To force an access window display update manually during a project solve, user can click on this refresh button. User may need to click this repeatedly to keep receiving updated information. Alternatively, the quick view pop up window or Trend Window can be used to get continuously updated information on selected variables.
PreviousUnit.png and NextUnit.png Browsing Graphics buttons

Pressing PreviousUnit.png shows the model data for the upstream unit operation; Pressing NextUnit.png shows the model data for the downstream unit operation. If the model has more than one upstream or downstream connections, then a pop up list will appear, user needs to select one of the connections to keep going. This will also find the unit on the graphics window and brings into view.

For ShiftKey.png and / or CtrlKey.png key variations, see Access Window Scroll Short Cut Keys for more information.

Find Button93.png Find Unit Button If the user clicks on this button SysCAD will jump to the Graphics page containing the unit associated with the Access Window and it will highlight the unit.
Access2.png Access 2 Button If the user clicks on this button SysCAD will open a second Access Window for the unit. User can use the second window to view data on another Tab. The second access window is also useful for comparing data between two different unit operations.
AccessWindowHeight93.png Adjust Access Window Height Button Clicking on this will adjust the Access Window height to best fit the current screen resolution. This is useful when opening a project that was created on a different PC using a different screen resolution.
PrevUnit.png previous button Shows the model data for the previous (most recently) accessed unit operation, this is useful for filling in data for controllers. This will also find the unit on the graphics window and brings into view.

For ShiftKey.png and / or CtrlKey.png key variations, see Access Window Scroll Short Cut Keys for more information.

GoTo.png Go to recent... Drop Down List SysCAD keeps a record of the units you have accessed in the past, starting with the most recently accessed unit. You can access any of the listed units by clicking on it. This will also find the unit on the graphics window and brings into view.

For ShiftKey.png and / or CtrlKey.png key variations, see Access Window Scroll Short Cut Keys for more information.

Options Button

These options are available by pressing Options Button.png button on the Access Window.
AccessOptions.png
Note: The order shown here is for SysCAD 9.3 - it will be different for earlier versions of SysCAD.
  • Data Transfer:See section on Data Transfer.
  • Print:This command prints the Access Window data by performing screen captures of each access window tab pages.

  • Auto Save:If this option is selected, any changes made in the Access Window are automatically saved when switching to other unit operations' access window without clicking on the OK button.
  • Excel Field Edit Style: When editing values in writable fields, the new value will replace the old value. See General Options More

  • Default Fixed Format: User may specify the default number format based on the number of decimal or significant points
  • Default Floating Format: User may specify the default number format to be based on the number of decimal point, using scientific notation.
  • Reset formatting, conversions and visibility (for ModelX):This option resets the formatting, conversions and visibility (Show/Hide) of all tags in this model back to their default values. The formatting, conversions and visibility (Show/Hide) options for individual tags are set by right clicking on the variable in the Access Window.
  • Reset formatting, conversions and visibility for ALL models: This is the same as the option described above except it is for ALL models within the project.
  • Conversions Management:This allows the user to manage the Conversions units for the project.
  • Describe Indicators: This will add a section to the top of the access window, describing the status indicators, see Access Field Reference Tag Status Colour for more information.

  • Reset: complete Reset of for the current model only.
  • Reset Actions (Dynamic Only): :Please see Solver_Settings for more information.
  • Remove Qualities:* This option is used to remove any Qualities inherited in the model. Useful for cleaning up unwanted build-up values.
  • Content to Preset: Sets the content (where available) to the Preset settings. (Dynamic Only)

  • Show Network:This option is available only in Dynamic Transfer mode. It will open the Show Network Summary window, which lists all the process units in the local flow network. For more information see Setting up Transfer Pull Network

Other Buttons

CopytoClipboardButton.png or PasteFromClipboardButton.png
  • The CopytoClipboardButton.png button can be found on unit operations such as Pipe or Tank Feed/Prod pages, it copies the T, P and Component Mass Flow data to the Clipboard.
  • The PasteFromClipboardButton.png button can be found on FeederSink unit operation, it will paste the T, P and Component Mass Flow data from the Clipboard to the Feeder. User can choose to paste:
    1. Species Mass Flow - Only the mass flow data will be pasted, T and P are not used.
    2. Temperature & Pressure - Only T and P will be pasted, the mass flow data is not used.
    3. MassFlows and T & P - All data is used.
ViewPropertiesButton.png ViewProperties137.png User can select to see more or less groups of data. Please see Additional Properties Options for more information.
ShowZeroButton.png or HideZeroButton.png
  • ShowZeroButton.png can be found on the Sp Tabs, all species will be displayed, including those with no flow.
  • HideZeroButton.png can be found on the Sp Tabs, it will hide all species with no flow.
SpeciesLongButton.png or SpeciesShortButton.png Toggles between long / short Species Names. For Example: LongShortTag.png
ShowECPageButton.png or HideECPageButton.png Toggles between showing/Hiding the Elemental information. See Hide / Show Elements + Components Button
ShowComponentsButton.png or HideComponentsButton.png Toggles between showing/Hiding the Component information. See Hide / Show Elements + Components Button

Right click on Access Window variables

Right clicking Pop Up Menu for Access Winodw:
User RightClickAccessWindow2.png
  • Conversions:Internally SysCAD stores all data in SI units but you can change the engineering units for the data as they are displayed on screen or reported elsewhere, please see Changing Conversion units for a Data Field.
  • Format:The number format of the value displayed can be changed to a Fixed or Floating format.

  • Send to Quick View:This will add the selected variable(s) to the Quick View List. See Quick View.
  • Send to Trend : Adds the highlighted variable(s) to the Trend window. The project must contain at least one Trend window. If the project contains multiple trend windows, this command will send the tag to the most recently opened Trend window. The placement of the Tag on the trend window will be:
    1. On the highlighted line if it is blank; or
    2. On the line below the highlighted line if it is not blank; or
    3. Below the most recently accessed line.
  • Open Find Results: This will open the Find Results List, the Find Query used to generate the result is the current Field you have right clicked on.
  • ReOpen Find Results: This option will only be visible if the Find Results window is already open. Selecting this option will close and reopen the Find results window, thus clearing any previous search results.
  • Extend Find Results: This option will only be visible if the Find Results window is already open. Selecting this option will append the results to the previous search results.

  • Record in Historian:This can add/remove tags to/from the Historian. User can choose to add/remove the selected tag belong to the active unit operation only; or add/remove the selected tag for all unit operations of the same type (eg, all pipes or all tanks); or add/remove the selected tag for unit operation types.

  • Show / Hide: Toggles the visibility of the variable. If all fields are displayed (by pressing MoreButton.png), the normally hidden variable(s) will be marked with User Guide image049.jpg. In SysCAD 9.3 Build137, while all fields are displayed, user may click on the individual User Guide image049.jpg mark to directly toggle the show/hide status for the variable.

  • Copy Full Tag:This will copy the full tag name(s) of the variable(s) you have highlighted on to the clipboard. This must be used if variable being copied is part of a Table. (Eg. Sp Tab, where multiple columns of data are being displayed)
  • Copy Alt Tag:
  • Copy Tag :This will copy the field name(s) - without the unit operation tag name - you have highlighted on to the clipboard. This is used for building excel reports where secondary tags are required. For more information on excel reports see Basic Format of a simple Get Tag Report.
  • Copy :This is used when a copy of the actual value of a field is required. Choosing Copy will copy the values of the highlighted data fields. NOTE: This will only work if the values are highlighted. If the variable tags are highlighted instead, tag names will be copied.
  • Paste :This will paste the information from the clipboard onto the selected fields. This is the same as pressing <Ctrl+V>.
  • Paste Special :
  • Data Transfer: This will open the Data Transfer Dialogue box with the selected field(s) marked (tick) for transfer. NOTE: User must right click on a "writeable" (white background) field to see the data transfer option. Block variables selection are allowed, all writeable variables in the selected block will be marked for data transfer.

Control Tags: See Controlled and Referenced Variables

Right click on the Access Window Back Ground

Right clicking on the background of the Access Window, away from the variable names will give you a pop up box similar to this:

RightClickBackground.png
  • Refresh: The Access Window values are not updated as SysCAD solves, pressing Refresh will update the Access Window display once
  • Find (name of unit operation): Finds the graphics symbol for the active unit model on the Graphics Window.
  • Model Help Access Models help for the current unit model, if exists.

  • Access Input: Name of Unit operation, This is open the access window of the connected source unit.
  • Access Output: Name of Unit operation, This is open the access window of the connected Destination unit.

Left click on the Access Window Back Ground Symbols

For some variables, these symbols: User Guide image054.gif will be displayed to the right of the field. Clicking on the Binoculars symbol will find the Unit Operation on the Graphics Window, while pressing the Magnifying Glass symbol will open the Access Window for the corresponding Unit Operation.

Access Field Reference Tag Status Colour

A full list of the available status colour can be view by selecting the Options Button.png Button - Describe Indicators option. When this option is used, the following will be added to the top of the access window, describing the status indicators. The list shown below is for SysCAD 9.3 Build 137.

DescribeIndicators137.png

Detailed description of some of the most common status colours are described below:

Type Description SysCAD View
Stopped Fields with a thin Orange square block indicates the variable can only be changed if SysCAD is stopped (no simulation running). For example, Tank sub-model selections
PreStart Fields with a thin green square block indicates the variable will only be executed once during the PreStart Step of the simulation. This means when using these tags in a PGM file, they have to be put inside the Initialise PreStart Subroutine. For example, PlantModel - Flowsheets

See Initialise PreStart Examples for an example of how to set these in the PGM file.

Global Fields with a thin blue Rectangle block indicates the variable is global, changes to this variable will be applied to all access windows. For example, Pipe - Sp Tab, SpBasis is global
GlobalIndicator.png
Dependant Fields with Yellow Field Colour means something is setting the value, if the field has no triangle indicator, then it is likely due to Composition Fetch, Feeder Calculator (Bayer, Sugar, Potash) or Solubility.

For Example, If composition fetch is set to continuously fetching the composition from another unit, then the composition in the feeder is Linked to the other unit, these fields are presented with the yellow background. User should not change these fields as any changes will be overridden by SysCAD when the project is solved.

DepandantIndicator.png
QuickView Fields with a small turquoise square indicates the variable is displayed in QuickView. QuickviewIndicator.png
Set or Get Reference Tags
  • Yellow Forward Triangle and Yellow Field Colour: This Variable is being set by some logic. eg, PID, SetTag or General Controller.
  • Green Backward Triangle: This variable is being read by some logic. eg, PID, SetTag or General Controller.
  • Red Forward Triangle and Red Field Colour: This variable is being set by more than one logic, it is in conflict and should be looked into.
  • Placing the cursor on the field will bring out a help box, detailing which controls are trying to write to the field.

NOTE: If the triangle is not shaded (ie only the outline is shown) then the tag was not set or read for that particular iteration.

ReferenceTagStatusColour.png
Manual User Input Value Change Fields with a Blue Dot indicates the value has been changed by the user, but the change has not been applied yet. To apply the change, hit the OK Button.png button, or the Enter or Ctrl-Enter keys. ValueChangeIndicator.png
Inactive Tags Fields with values displayed in mustard colour indicates the model is NOT active, most likely due to the flowsheet being Deactivated. InactiveIndicator.png

NOTE:The above status colour will also appear on the trend window.

Zero Values Verses Small Number Display

SysCAD displays all data with two decimal points by default. The user can change the number format as needed anywhere on the Access Window or the trend window.

WARNING:

However, there is an exception; by default SysCAD displays zero values as 0 with no decimal points. If a number appears as 0.00, it means the number has a small value and the user may get its exact value by changing the number format. This is not to be confused with the true zero values.

Access Window Short Cut Keys

CtrlKey.png + Enter Same as pressing the OK button.
CtrlKey.png + Home Scrolls to the Top Left of the Current Access Window Tab Page
CtrlKey.png + End Scrolls to the Bottom Left of the Current Access Window Tab Page
CtrlKey.png + LeftRightArrow.png Pans the horizontal scroll bar left/right (1 character width at a time)
CtrlKey.png + UpDownArrow.png Pans the Vertical scrolls bar up/down (1 row at a time)
CtrlKey.png + PageUp Go to the next Access Window tab page
CtrlKey.png + PageDown Go to the Previous Access Window tab page.
CtrlKey.png + Various Selection Buttons Displays the model data on the Current Access Window without finding the unit on the Graphics Window.
ShiftKey.png + Various Selection Buttons Displays the model data on the other Access Window, and finds the unit on the Graphics Window.
ShiftKey.png + CtrlKey.png + Various Selection Buttons Displays the model data on the other Access Window without finding the unit on the Graphics Window.