Citect SCADA 7​.20 Release Notes

New features and enhancements

• Control SCADA Client Connections

• Dynamically Optimized Writes

• Environment Variable Changes

• Graphics Enhancements

• Improved Installation Process

• Improved Citect SCADA Security

• Microprocessor Support in Demo Mode

• New Example Project

• New Web-based Help

• OPC Factory Server (OFS) Driver

• Performance Improvements

• Persisted I/O Memory Mode

• Post Compile Commands

• Improved Client Side Online Changes

• Server Side Online Changes

• Microsoft Windows 7 Support

• Supportability Enhancements

• Tab Menu Templates

• Tag Extensions

Citect.ini parameter updates

The following Citect.ini parameters have been introduced or modified in this release.

New Parameters

• Alarm Parameters

  [Alarm.ClusterName.ServerName]DisableConnection	Specifies if a client will not connect to a server.
  [Alarm.ClusterName.ServerName]Priority	Specifies the client priority for the server connection.
  [Alarm]ReloadBackOffTime	Back-off time configured to control the pace of the reload on an alarm server.

• Client Parameters

  [Client]AutoLoginClearPassword	When set to 1 the cache is cleared of any client login credentials.
  [Client]DisableDisplay	Sets whether to allow the client process to run in the background without a visible window.
  [Client]EvictTimeout	Sets the amount of time a tag reference is cached before it is evicted.
  [Client]PartOfTrustedNetwork	Tells a Client process to attempt to authenticate using the stored server password. It is automatically set by the Setup Wizard.
  [Client] StalenessPeriod	Number of seconds to use for tag staleness period.
  [Client]StalenessPeriodTolerance	Staleness period tolerance

• CtAPI Parameters

  [CtAPI]RoundToFormat

  Indicates to the user if values rounded to format.

• CtDraw.RSC Parameters

  [CtDraw.RSC]AllowEditSuperGeniePage

  When set enables the user to choose whether or not to open and edit a Super Genie page.

• CtEdit Parameters

  [CtEdit]CompileSuccessfulCommand	Indicates to the compiler an optional command, script or batch file to execute after a successful compile.
  [CtEdit]CompileUnsuccessfulCommand	Indicates to the compiler an optional command, script or batch file to execute after an unsuccessful compile.
  [CtEdit]Starter	Specifies the directory where the starter projects are located.

• Debug Parameters

  [Debug]ArchiveFiles	Archives log files once the size specified by [Debug]MaximumFileSize is reached.
  [Debug]CategoryFilter	Allows you to filter logging messages by component category.
  [Debug]CategoryFilterMode	Enables logging of categories declared by the [Debug]CategoryFilter value.
  [Debug]EnableLogging	Enables or disables the logging mechanism.
  [Debug]MaximumFileSize	Sets the maximum size for a log file.
  [Debug]Priority	Allows you to filter logging messages according to their priority.
  [Debug]SeverityFilter	Allows you to filter logging messages according to their severity.
  [Debug]SeverityFilterMode	Enables logging of severities declared by the [Debug]SeverityFilter value.

• General Parameters

  [General]MiniumlUpdateRate	Specifies the time period (sec) at which a DataSource will send tag update value notifications to the subscription clients.
  [General]StalenessPeriod	Specifies the time period (sec) after which a tag value is considered to be "stale" if it was not updated during this period.

• IOServer Parameters

  [IOServer]EnableEventQueue	Enables the event queue.
  [IOServer]MaxEventsDrop	Sets the number of events that are dropped when too many are queued.
  [IOServer]MaxEventsQueued	Sets the total number of events that can be queued.
  [IOServer]MaxTimeInQueueMs	Sets the total time for which an event can be queued.

• LAN Parameters

  [LAN]AllowRemoteReload	Enables remote reloading of servers from a client.
  [LAN]ClientRetryTime	Sets the length of time between connection attempts by a client.
  [LAN]EarliestLegacyVersion	Specify the minimum legacy version from which the current version will accept connections.
  [LAN]HighWaterMark	The number of messages waiting to be sent on a particular network connection at which the high water mark event will occur.
  [LAN]KeepAliveInterval	Sets the length of time between two keep alive transmissions by the client.
  [LAN]KeepAliveTime	Sets the length of time between two keep alive transmissions in idle conditions.
  [LAN]ListenerRetryTime	Sets the length of time a server waits between attempts to listen for a client connection.
  [LAN]LowWaterMark	After the high water mark has been reached on a particular network connection, the low water mark represents the number of messages waiting to be sent at which we will resume normal operations.
  [LAN]NoSocketDelay	Switches off the delay on a socket caused by the use of the Nagle algorithm.
  [LAN]ReadOnlyLegacyConnections	When set to 1 version 7.10 clients can only communicate in read-only mode.This parameter overrides 'EarliestLegacyVersion' .

• Multi-Monitor Parameters (CSV Include project)

  [MultiMonitor]DisableAutoStart

  Disables the new multi-monitor functionality.

• Page Parameters

  [Page]AddDefaultMenu	Determines whether to add the default menu items to the tabbed menu bar.
  [Page]BadDitheringColor	Sets the dithering color for graphics elements which are dithered if the value quality is "bad".
  [Page]BadDitheringDensity	Sets the dithering density for graphics elements which are dithered if the value quality is "bad".
  [Page]BadText	Text Objects can be displayed as #COM type errors, or as the text overlaid with a dithered pattern if the ‘display value’ expression has "bad" quality.
  [Page]BadTextBackgroundColor	Sets the background color for numeric / text graphics objects to indicate "bad" quality.
  [Page]EnableQualityToolTip	Set by default it controls the quality tooltip
  [Page]ErrorDitheringColor	Sets the dithering color for graphics elements which are dithered if an internal error occurs.
  [Page]ErrorDitheringDensity	Sets the dithering density for graphics elements which are dithered if an internal error occurs.
  [Page]ErrorTextBackgroundColor	Sets the background color for numeric / text graphics objects to indicate an internal error.
  [Page]IgnoreValueQuality	Defines the value quality handling by graphics pages.
  [Page]OverrideDitheringColor	Sets the dithering color for graphics elements which are dithered if their values are override ("forced").
  [Page]OverrideDitheringDensity	Sets the dithering density for graphics elements which are dithered if an internal error occurs.
  [Page]OverrideTextBackgroundColor	Sets the background color for numeric / text graphics objects to indicate that the value presented on the objects is override ("forced").
  [Page]ShowBadText	Text Objects can be displayed as #BAD text, or as the text overlaid with a dithered pattern if the "display value" expression has "bad" quality.
  [Page]ShowErrorText	Text Objects can be displayed as #COM type errors, or as the text overlaid with a dithered pattern if the ‘display value’ expression has "uncertain" quality.
  [Page]ShowUncertainText	Text Objects can be displayed as #UNC text, or as the text overlaid with a dithered pattern if the "display value" expression has "uncertain" quality.
  [Page]Splash	Specify the name of the Splash Screen page.
  [Page]SplashTimeout	Time in milliseconds for the Splash Screen to display.
  [Page]SplashWinName	Specify the label of the Splash Window for use with the Cicode function WinNumber().
  [Page]StartupDelay	Milliseconds between when Splash Screen and Start Screen are displayed.
  [Page]StartupHeight	Height of the Start Page on main display monitor.
  [Page]StartupMode	Mode of Start Page on main display monitor.
  [Page]StartupWidth	Width of the Start Page on main display monitor.
  [Page]StartupWinName	Specify the label of the Start Window for use with the Cicode function WinNumber().
  [Page]StartupX	X coordinate of Start Page on main display monitor.
  [Page]StartupY	Y coordinate of Start Page on main display monitor.
  [Page]UncertainDitheringColor	Sets the dithering color for graphics elements which are dithered if the value quality is "uncertain".
  [Page]UncertainDitheringDensity	Sets the dithering density for graphics elements which are dithered if the value quality is "uncertain".
  [Page]UncertainText	Text Objects can be displayed as #COM type errors, or as the text overlaid with a dithered pattern if the ‘display value’ expression has "uncertain" quality.
  [Page]UncertainTextBackgroundColor	Sets the background color for numeric / text graphics objects to indicate "uncertain" quality.
  [Page]WaitForValidData	Specifies whether the animation system will attempt to wait for valid data from subscriptions necessary to draw a graphics page before it is animated.

• Report Parameters

  [Alarm.ClusterName.ServerName]DisableConnection	Specifies if a client will not connect to a server.
  [Alarm.ClusterName.ServerName]Priority	Specifies the client priority for the server connection.

• Runtime Manager Parameters

  [RuntimeManager]AllowReload

  Enables or disables the reload option in the Runtime Manager menu.

• Security Parameters

  [Security]DisableDEP

  Set to turn off DEP protection for the Plant SCADA runtime.

• Server Parameters

  [Server]AutoLoginMode

  Determines the auto login method the server will use when establishing connections to other servers.

• Trend Parameters

  [Trend]AcquisitionTimeout	Sets a timeout to stop a trend server infinitely acquiring a valid data sample from an I/O device.
  [Trend.ClusterName.ServerName]DisableConnection	Specifies if a client should not connect to a server.
  [Trend.ClusterName.ServerName]Priority	Specifies the client priority for the server connection.
  [Trend]ReloadBackOffTime	Back-off time configured to control the pace of the reload on an Trend server.

Modified Parameters

• CtEdit Parameters

  [CtEdit]Copy

  Supports runtime changes, it enables you to switch the SCADA node to use a new runtime configuration by pointing to a new location.

Re-instated Parameters

• IOServer Parameters

  [IOServer]BlockWrites

  Determines whether Plant SCADA will try to block optimize writes to I/O devices.

Obsolete Parameters

• AnmCursor Parameters

  [AnmCursor]Colour

  Replaced with [AnmCursor]Color. Sets the color of the cursor.

• General Parameters

  [General]TagAssMode

  Validates the tag name in the Association Function. Refer to [General]TagDB instead.

• LAN Parameters

  [LAN]AllowLegacyConnections	Set to allow previous versions of client to connect to the server. Replaced with [LAN]EarliestLegacyVersion and the new trusted network authentication between SCADA servers. The Setup Wizard now allows a server password to be set on each server on your network.
  [LAN]ServerLoginEnabled	Set to disable default server login. Replaced with [LAN]EarliestLegacyVersion and the new trusted network authentication between SCADA servers. The Setup Wizard now allows a server password to be set on each server on your network.

• Page Parameters

  [Page]BackgroundColour	Replaced with [Page]BackgroundColor. Specifies the color used to fill in the background when a page is smaller than the minimum width of a window.
  [Page]ComBreak	Determines whether an error status is displayed on the screen if a communication error occurs. Replaced with new page quality settings such as [Page]IgnoreValueQuality, [Page]BadText,[Page]BadDitheringDenisty.
  [Page]ComBreakText	Determines the display of text objects if a communication error occurs that affects the text. Replaced with new page quality settings such as [Page]IgnoreValueQuality, [Page]BadText,[Page]BadDitheringDenisty.
  [Page]DynamicComBreakColour	Replaced with [Page]DynamicComBreakColor. Sets the color of the ComBreak dithering.
  [Page]DynamicComBreakDensity	Sets the density of the ComBreak. Replaced with new page quality settings such as [Page]IgnoreValueQuality, [Page]BadText,[Page]BadDitheringDenisty.

• Time Parameters

  [Time]Deadband	The deadband time checked by the Time Server before it adjusts the time on the client(s).
  [Time]Disable	Enables/disables the processing of time messages from the Time Server.
  [Time]Name	Enables the time synchronization functionality.
  [Time]PollTime	The period that the Time Server uses to synchronize other Plant SCADA computers on the network.
  [Time]RTsync	Determines whether the Time Server will synchronize with the hardware clock.
  [Time]Server	Determines whether this computer is a Time Server.

• Trend Parameters

  [Trend]CursorColour

  Replaced with [Trend]CursorColor. Allows the cursor color to be specified.

Cicode function updates

The following Cicode functions have been introduced or modified in this release.

New Functions

• Alarm Functions

  AlarmCatGetFormat	Returns the display format string of the specified alarm category.
  AlarmDspClusterAdd	Adds a cluster to a client's alarm list.
  AlarmDspClusterInUse	Determines if a cluster is included in a client's alarm list.
  AlarmDspClusterRemove	Removes a cluster from a client's alarm list.

• Display Functions

  DspAnGetMetadata	Retrieves the field value of the specified metadata entry.
  DspAnGetMetadataAt	Retrieves metadata information at the specified index.
  DspAnSetMetadata	Non-blocking function, that sets the value of the specified metadata entry.
  DspAnSetMetadataAt	Sets the value of a metadata entry.
  DspPopupConfigMenu	Displays the contents of a menu node as a pop-up (context) menu, and run the command associated with the selected menu item.

• Format Functions

  FmtGetFieldCount	Retrieves the number of fields in a format object.
  FmtGetFieldName	Retrieves the name of a particular field in a format object.
  FmtGetFieldWidth	Retrieves the width of a particular field in a format object.

• Menu Functions

  MenuGetChild	Returns the handle to the child node with the specified name.
  MenuGetFirstChild	Returns the handle to the first child of a menu node.
  MenuGetGenericNode	Returns the root node of the default menu tree.
  MenuGetNextChild	Returns the next node that shares the same parent.
  MenuGetPageNode	Returns the Base menu node of a specific page
  MenuGetParent	Returns the parent node of the menu item.
  MenuGetPrevChild	Returns the previous node that shares the same parent.
  MenuGetWindowNode	Returns the handle of the root menu node for a given window.
  MenuNodeAddChild	Dynamically adds a new item to the menu at runtime.
  MenuNodeGetProperty	Return the item value of the specified menu node.
  MenuNodeHasCommand	Checks whether the menu node has a valid Cicode command associated with it.
  MenuNodeIsDisabled	Checks whether the menu node is disabled by evaluating its DisabledWhen Cicode expression.
  MenuNodeIsHidden	Checks whether the menu node is hidden by evaluating its HiddenWhen Cicode expression.
  MenuNodeRemove	Remove the menu node from the menu tree.
  MenuNodeRunCommand	Run the associated command for a menu node.
  MenuNodeSetDisabledWhen	Set the DisabledWhen expression for a newly added node.
  MenuNodeSetHiddenWhen	Set the HiddenWhen expression for a newly added node.
  MenuNodeSetProperty	Set the item value of the specified menu node.
  MenuReload	Reload base Menu Configuration from the compiled database.

• Miscellaneous Functions

  GetLogging	Gets the current value for one or more logging parameters.
  SetLogging	Adjusts logging parameters while online.
  ProductInfo	Returns information about the Plant SCADA product.
  ProjectInfo	Returns information about a particular project, which is identified by a project enumerated number.

• Page Functions

  PageBack	Displays the previously displayed page in the Window.
  PageForward	PageForward() restores the previously displayed page in the window following a PageBack command.
  PageHistoryDspMenu	Displays a pop-up menu which lists the page history of current window.
  PageHistoryEmpty	Returns whether page history of the current window is empty.
  PageHome	Displays the predefined home page in the window.
  PagePeekCurrent	Return the index in the page stack for the current page.
  PageProcessAnalyst	Displays a Process Analyst page (in the same window) preloaded with the pre-defined Process Analyst View (PAV) file.
  PageProcessAnalystPens	Displays a Process Analyst page (in the same window) preloaded with the pre-defined Process Analyst View (PAV) file and specified trend or variable tags.
  PageRecall	Displays the page at a specified depth in the stack of previously displayed pages.
  PageTask	Used for running preliminary Cicode before displaying a page in a window.
  PageTransformCoords	Converts Page coordinates to absolute screen coordinates.

• Process Analyst Functions

  ProcessAnalystLoadFile	Loads the specified PAV file to a Process Analyst object, which is identified by parameter ObjName.
  ProcessAnalystPopup	Displays a Process Analyst page (in the same window) preloaded with the pre-defined Process Analyst View (PAV) file and specified trend or variable tags.
  ProcessAnalystSelect	Allows a set of pens to be selected before displaying the PA page.
  ProcessAnalystSetPen	Allows a new pen to be added to a PA display.
  ProcessAnalystWin	Displays a Process Analyst page (in a new window) preloaded with the pre-defined Process Analyst View (PAV) file.

• Quality Functions

  QualityCreate	Creates a quality value based on the quality fields provided.
  QualityGetPart	Extracts a requested part of the Quality value from the QUALITY variable.
  QualityIsBad	Returns a value indicating whether the quality is bad.
  QualityIsGood	Returns a value indicating whether the quality is good.
  QualityIsUncertain	Returns a value indicating whether the quality is uncertain.
  QualitySetPart	Sets a Quality part’s value to the QUALITY variable.
  QualityToStr	Returns a textual representation of the Plant SCADA quality.
  QualityIsOverride	Returns a value indicating whether the tag is in Override Mode.
  QualityIsControlInhibit	Returns a value indicating whether the tag is in Control inhibit mode.
  VariableQuality	Extracts the quality from a given variable.

• Server Functions

  ServerBrowseClose	This function terminates an active data browse session and cleans up resources associated with the session.
  ServerBrowseFirst	This function places the data browse cursor at the first record.
  ServerBrowseGetField	This function retrieves the value of the specified field from the record the data browse cursor is currently referencing.
  ServerBrowseNext	This function moves the data browse cursor forward one record.
  ServerBrowseNumRecords	This function returns the number of records that match the filter criteria.
  ServerBrowseOpen	This function initiates a new browse session and returns a handle to the new session that can be used in subsequent data browse function calls.
  ServerBrowsePrev	This function moves the data browse cursor back one record.
  ServerGetProperty	This function returns information about a specified server and can be called from any client.
  ServerReload	This function reloads the server specified by cluster and server name.
  ServerIsOnline	This function checks if the given server can be contacted by the client for giving the online/offline status of the server.

• String Functions

  StrCalcWidth	Retrieves the pixel width of a string using a particular font.
  StrTruncFont	Returns the truncated string using a particular font (specified by name) or the specified number of characters.
  StrTruncFontHnd	Returns the truncated string using a particular font (specified by font number) or the specified number of characters.

• Super Genie Functions

  AssMetadata	Performs Super Genie associations using the "Name" and "Value" fields.
  AssMetadataPage	Uses the metadata information from the current animation point for the page associations for a new Super Genie page, and displays the new Super Genie in the current page.
  AssMetadataPopup	Uses the metadata information from the current animation point for the associations for a new Super Genie page, and displays the new Super Genie in a new pop up window.
  AssMetadataWin	Uses the metadata information from the current animation point for the associations for a new Super Genie page, and displays the new Super Genie in a new window.

Tag Functions

• Task Functions

  TaskCall

  Calls a Cicode function by specifying the function name and providing an arguments string.

• Timestamp Functions

  TimestampToStr	Converts a TIMESTAMP variable into a string.
  TimestampDifference	Returns a difference between two TIMESTAMP variables as a number of milliseconds.
  TimestampCreate	Returns a timestamp variable created from the parts.
  TimestampFormat	Format a TIMESTAMP variable into a string.
  TimestampGetPart	Returns one part (year, month, day, etc) of the timestamp variable.
  TimestampToTimeInt	Converts a TIMETSTAMP variable into a time INTEGER which is represented as a number of seconds since 01/01/1970.
  TimeIntTo Timestamp	Converts a time INTEGER which is represented as a number of seconds since 01/01/1970 to a TIMETSTAMP
  TimestampCurrent	Returns the current system date and time as a TIMESTAMP variable.
  TimestampAdd	Adds time (in milliseconds) to a TIMESTAMP variable.
  TimestampSub	Subtracts time (in milliseconds) from a TIMESTAMP variable.
  VariableTimestamp	Extract the TIMESTAMP from a given variable.

• Window Functions

  MultiMonitorStart	Displays a Plant SCADA window on each of the configured monitors when a display client starts up.
  WinSetName	Associates a name with a particular window by its window number.
  WndMonitorInfo	Returns information about a particular monitor.

Modified Functions

• Accumulator Functions

  AccumBrowseOpen

  Opens an accumulator browse session.

• Alarm Functions

  AlarmDsp	Displays alarms.
  AlarmDspLast	Displays the latest, unacknowledged alarms.
  AlmSummaryOpen	Opens an alarm summary browse session.
  AlmTagsOpen	Opens an alarm tags browse session.

• Display Functions

  DspStr	Displays a string at an AN.
  DspText	Displays text at an AN.

• Format Functions

  FmtOpen

  Creates a format template.

• Miscellaneous Functions

  Shutdown

  EndsPlant SCADA operation.

• Page Functions

  PageGetInt	Gets a local page-based integer.
  PageGetStr	Gets a local page-based string.
  PageInfo	Gets information about the current page.
  PagePeekLast	Gets any page on the PageLast stack.
  PageSetInt	Stores a local page-based integer.
  PagesetStr	Stores a local page-based string.

• Security Functions

  Login

  Logs an operator into the Plant SCADA system. Not available when logged in as Windows user.

• Super Genie Functions

  The following functions were updated to accept string identifiers for substitution parameters.

  Ass	Associates a variable tag with a Super Genie.
  AssGetProperty	Retrieves association information about the current Super Genie from the datasource.
  AssGetScale	Gets scale information about the associations of the current Super Genie from the datasource (that is scale information about a variable tag that has been substituted into the Super Genie)
  AssInfo	Gets association information about the current Super Genie (that is information about a variable tag that has been substituted into the Super Genie).
  AssInfoEx	Retrieves association information about the current Super Genie (that is information about a variable tag that has been substituted into the Super Genie).
  AssScaleStr	Gets scale information about the associations of the current Super Genie (that is scale information about a variable tag that has been substituted into the Super Genie).

• Tag Functions

  SubscriptionGetAttribute	Reads an attribute value of a tag subscription.
  TagRead	Reads the value of a particular tag element.
  TagWrite	Writes a tag element value for the tag elements which have read/write access.
  TagSubscribe	Subscribes to a particular tag element.

• Window Functions

  WinNumber	Gets the window number of the active Plant SCADA window.
  WndInfo	Gets the Windows system metrics information.

Reinstated Functions

• Time and Date Functions

  TimeSet

  Sets the new system time. Requires UAC to be disabled in order for the time to be set.