Getting Started > What's New > What's New - Previous Releases > Cicode Functions

Cicode Functions in 7.30

Some Cicode functions have been introduced, modified, deprecated or removed. The following sections detail the changes made to these functions:

ClosedNew Functions
ClosedAlarm Functions
AlarmAckTag Acknowledge a specified alarm.
AlarmCount Counts the available alarms for the selected filter criteria.
AlarmCountList Counts the available alarms for the selected alarm list (selected by its animation).
AlmBrowseAck Acknowledges the alarm tag at the current cursor position in an active data browse session.
AlmBrowseClose Closes an alarm tags browse session.
AlmBrowseDisable Disables the alarm tag at the current cursor position in an active data browse session.
AlmBrowseEnable Enables the alarm tag at the current cursor position in an active data browse session.
AlmBrowseFirst Gets the oldest alarm tags entry.
AlmBrowseGetField Gets the field indicated by the cursor position in the browse session.
AlmBrowseNext Gets the next alarm tags entry in the browse session.
AlmBrowseNumRecords Returns the number of records in the current browse session.
AlmBrowseOpen Opens an alarm tags browse session.
AlmBrowsePrev Gets the previous alarm tags entry in the browse session.
AlarmFilterClose Removes named filter from memory.
AlarmFilterEditAppend Appends the provided expression to the current filter session content without any validation.
AlarmFilterEditClose Removes the session from the memory.
AlarmFilterEditCommit Validates the filter built in this session and, if valid, applies the filter to the list associated with the session.
AlarmFilterEditFirst Retrieves the first part of the filter.
AlarmFilterEditLast Retrieves the last part of the filter.
AlarmFilterEditNext Retrieves the next part of the filter.
AlarmFilterEditOpen Creates a session for the historical list associated with the provided animation number (aN).
AlarmFilterForm Displays a form for specifying filtering criteria for either an alarm list or a named filter.
AlarmFilterOpen Creates a named filter.
AlmFilterEditPrev Retrieves the previous part of the filter.
AlmFilterEditSet Replaces the current filter session content by the provided expression without any validation.
AlarmGetFilterName Retrieves the name of the linked filter for the supplied AN.
AlarmResetQuery Clears the filter of the specified filter source. Used to reset the filter set up by the Cicode function AlarmFilterForm().
LibAlarmFilterForm Displays a generic alarm filter pop-up for specifying filtering criteria for either an alarm list or a named filter.
ClosedEquipment Functions
EquipSetProperty Sets the property of an item of equipment.
EquipStateBrowseClose Terminates a browsing session and cleans up the resources used by the session.
EquipStateBrowseFirst Places the data browse cursor at the first record.
EquipStateBrowseGetField Returns the value of the particular field in a record to which the data browse cursor is currently referencing.
EquipStateBrowseNext Places the data browse cursor at the next available record.
EquipStateBrowseNumRecords Returns the number of records that match the current filter criteria.
EquipStateBrowseOpen Initiates a new session for browsing the equipment states configured.
EquipStateBrowsePrev Places the data browse cursor at the previous record.
ClosedPage Functions
PageSOE Displays a category of sequence of events (SOE) entries on the SOE page.
ClosedScheduler Functions
SchdClose Terminates a browsing session and cleans up the resources used by the session.
SchdConfigClose Terminates a browsing session and cleans up the resources used by the session.
SchdConfigFirst Places the data browse cursor at the first record.
SchdConfigGetField Returns the value of the particular field in a record to which the data browse cursor is currently referencing.
SchdConfigNext Places the data browse cursor at the next available record.
SchdConfigNumRecords Returns the number of records that match the current filter criteria.
SchdConfigOpen Initiates a new session for browsing the schedules configured.
SchdConfigPrev Places the data browse cursor at the previous record.
SchdFirst Places the data browse cursor at the first record.
SchdGetField Returns the value of the particular field in a record to which the data browse cursor is currently referencing.
SchdNext Places the data browse cursor at the next available record.
SchdNumRecords Returns the number of records that match the current filter criteria.
SchdOpen Initiates a new session for browsing the runtime schedules.
SchdPrev Places the data browse cursor at the previous record.
SchdSpecialAdd Adds a new special day group to the scheduler engine.
SchdSpecialClose Terminates a browsing session and cleans up the resources used in the session.
SchdSpecialDelete Deletes an existing special day group.
SchdSpecialFirst Places the data browse cursor at the first record.
SchdSpecialGetField Returns the value of the particular field in a record to which the data browse cursor is currently referencing.
SchdSpecialItemAdd Adds a new special day to the scheduler engine.
SchdSpecialItemClose Terminates a browsing session and cleans up the resources used in the session.
SchdSpecialItemDelete Deletes an existing schedule.
SchdSpecialItemFirst Places the data browse cursor at the first record.
SchdSpecialItemGetField Returns the value of the particular field in a record to which the data browse cursor is currently referencing.
SchdSpecialItemModify Modifies an existing special day.
SchdSpecialItemNext Places the data browse cursor at the next available record.
SchdSpecialItemNumRecords Returns the number of records that match the current filter criteria.
SchdSpecialItemOpen Initiates a new session for browsing the special days.
SchdSpecialItemPrev Places the data browse cursor at the previous record.
SchdSpecialModify Modifies an existing special day group
SchdSpecialNext Places the data browse cursor at the next available record.
SchdSpecialNumRecords Returns the number of records that match the current filter criteria.
SchdSpecialOpen Initiates a new session for browsing the special day groups.
SchdSpecialPrev Places the data browse cursor at the previous record.
ScheduleItemAdd Adds a new schedule to the scheduler engine.
ScheduleItemDelete Deletes an existing schedule.
ScheduleItemModify Modifies an existing schedule.
ScheduleItemSetRepeat Adds recurrence information for an existing schedule to the scheduler engine.
ClosedSequence of Event Functions
SOEArchive Archives event journal.
SOEDismount Use to dismount archive volume.
SOEEventAdd Inserts a new event into the event journal.
SOEMount Use to mount archive volume.
ClosedSQL Functions
SQLCall Executes an SQL query on a database
SQLClose Closes a SQL connection between the DB connection object specified by the function’s parameter and a database
SQLCreate Creates an internal DB connection object and returns a handle to the object for use by the other DB functions
SQLDispose Disposes the DB connection object
SQLGetRecordset Executes an SQL query on a database
SQLGetScalar Executes an SQL query on a database
SQLIsNullField Checks presence of null value in field from a recordset
SQLNumFields Gets the number of fields or columns that were returned by the last SQL statement
SQLOpen Opens an SQL connection between the DB connection object
SQLParamsClearAll Turns on a debug trace
SQLParamsSetAsInt Adds or replaces a parameterized query’s parameter as integer and its value in the specified connection
SQLParamsSetAsReal Adds or replaces a parameterized query’s parameter as real and its value in the specified connection
SQLParamsSetAsString Adds or replaces a parameterized query’s parameter as string and its value in the specified connection
SQLPrev Gets the previous database record from an SQL query.
SQLQueryCreate The function creates a new query and returns its handle
SQLQueryDispose The function disposes the query which handle is given as the argument
SQLRowCount Gets the number of rows in the recordset.
ClosedTimestamp Functions
StrToTimestamp Converts timestamp in a STRING format into a TIMESTAMP format
ClosedTag Functions
TagBrowseClose Close an existing browsing session
TagBrowseFirst Move to the first record
TagBrowseGetField Get the specified field of a record.
TagBrowseNext Move to the next record
TagBrowseNumRecords Get the number of records for a given browsing session.
TagBrowseOpen Opens a new browsing session.
TagBrowsePrev Move to the previous record

Modified Functions

Alarm Functions

AlarmAck Acknowledges an active alarm.
AlarmCatGetFormat Returns the display format string of the specified alarm category. Type has been extended to include SOE format.
AlarmDisable Disables an alarm.
AlarmDsp Displays alarms.
AlarmDspNext Displays the next page of alarms. Works with new SOE display type.
AlarmDspPrev Displays the previous page of alarms. Works with new SOE display type.
AlarmEnable Enables a disabled alarm.
AlarmFirstTagRec
AlarmFirstCatRec
AlarmFirstPriRec
AlarmFirstQueryRec
AlarmNextTagRec
AlarmNextCatRec
AlarmNextPriRec
AlarmNextQueryRec
AlarmAckRec
AlarmEnableRec
AlarmDisableRec
AlarmGetDelayRec
AlarmSetDelayRec
AlarmGetThresholdRec
AlarmSetThresholdRec
AlarmGetFieldRec
 Alarm 'Rec' functions listed are now executed in the client process, with the function MsgRPC no longer required when called remotely to the Alarm Server.

AlarmGetDsp

 Retrieves field data from the alarm record that is displayed at the specified AN. Works with new SOE display type.
AlarmGetInfo Retrieves data on the alarm list displayed at a specified AN. New type 12 added.
AlarmSetInfo Controls different aspects of the alarm list displayed at a specified AN. Supports automatic refresh of the new SOE display type.
AlmSummaryGetField Gets the field indicated by the cursor position in the browse session. Now supports Equipment field.
AlmSummaryOpen Opens an alarm summary browse session. Now supports Equipment field. Will not return data for 'NODE' field name.
AlmTagsGetField Gets the field indicated by the cursor position in the browse session. Now supports Equipment field.
AlmTagsOpen Opens an alarm tags browse session. Now supports Equipment field. Will not return data for 'NODE' field name.

Accumulator Functions

AccumBrowseGetField Gets the field indicated by the cursor position in the browse session. Now supports Equipment field.
AccumBrowseOpen Opens an accumulator browse session. Now supports Equipment field.

Equipment Functions

EquipBrowseGetField Gets the field indicated by the cursor position in the browse session. Now supports Parent and Composite fields.
EquipBrowseOpen Opens an equipment database browse session. Now supports Parent and Composite fields.
EquipGetProperty Reads a property of an equipment database record from the EQUIP.DBF file. Now supports Parent and Composite fields.

Format Functions

FmtOpen Opens a format template. mode has been extended to include SOE format.

Security Functions

Login Logs a user into the Citect SCADA system, using Citect SCADA security and gives users access to the areas and privileges assigned to them in the Users database. New sLanguage parameter added.
UserLogin Logs a user into the Citect SCADA system, using either Windows security or Citect SCADA security and gives users access to the areas and privileges assigned to them in the Users database. New sLanguage parameter added.

Server Functions

ServeGetProperty Returns information about a specified server and can be called from any client.
ServerReload Reloads the server specified by cluster and server name.

Super Genie Functions

AssGetProperty Gets association information about the current Super Genie from the datasource.
AssInfo Gets association information about the current Super Genie.
AssInfoEx Gets association information about the current Super Genie.

SQL Functions

SQLGetField Gets field or column data from a database record.
SQLInfo Gets information about a database connection. No longer supports type 3 and 4.
SQLNoFields Gets the number of fields or columns that were returned by the last SQL statement.

Tag Functions

TagGetProperty Gets a property for a variable tag from the datasource. Now supports Equipment field.
TagInfo Gets information about a variable tag. Now supports Equipment field.
TagInfoEx Gets information about a variable tag. Now supports Equipment field.

Trend Functions

TrnBrowseGetField Gets the field indicated by the cursor position in the browse session. Now supports Equipment field.
TrnBrowseOpen Opens a trend browse session. Now supports Equipment field.

Reinstated Functions

No functions have been reinstated for 7.30.

Deprecated Functions

AlmTagsEnable Enables the alarm tag at the current cursor position in an active data browse session.
AlmTagsDisable Disables the alarm tag at the current cursor position in an active data browse session.
AlmTagsNext Gets the next alarm tags entry in the browse session.
AlmTagsAck Acknowledges the alarm tag at the current cursor position in an active data browse session.
AlmTagsClear Clears the alarm tag at the current cursor position in an active data browse session.
AlmTagsClose Closes an alarm tags browse session.
AlmTagsFirst Gets the oldest alarm tags entry.
AlmTagsGetField Gets the field indicated by the cursor position in the browse session.
AlmTagsNumRecords Returns the number of records in the current browse session.
AlmTagsOpen Creates a session for the historical list associated with the provided animation number (aN).
AlmTagsPrev Gets the previous alarm tags entry in the browse session.

Removed Functions

AlmBrowseClear Clears the alarm tag at the current cursor position in an active data browse session. Now obsolete.
AlarmClear Clears acknowledged, inactive alarms from the active alarm list.
AlarmClearRec Clear an alarm by its record number. Now obsolete.
AlarmDelete Deletes alarm summary entries that are currently displayed. Now obsolete.
AlarmSetQuery Specifies a query to be used in selecting alarms for display. Now Obsolete. Use the new Alarm Filter Edit functions.
AlarmSumAppend Appends a new blank record to the alarm summary. Now obsolete.
AlarmSumCommit Commits the alarm summary record to the alarm summary device. Now obsolete.
AlmSummaryCommit Commits the alarm summary record to the alarm summary device. Now obsolete.
AlarmSplit Duplicates an alarm summary entry where the cursor is positioned. Now obsolete.

AlarmSumDelete

Deletes alarm summary entries. Now obsolete.
AlarmSumFind Finds an alarm summary index for an alarm record and alarm on time. Now obsolete.
AlarmSumFindExact Finds the alarm summary index for an alarm specified by the alarm record identifier and alarm activation time.

AlarmSumFirst

Gets the oldest alarm summary entry. Now obsolete.

AlarmSumGet

Gets field information from an alarm summary entry. Now obsolete.

AlarmSumLast

Gets the latest alarm summary entry. Now obsolete.

AlarmSumNext

Gets the next alarm summary entry. Now obsolete.

AlarmSumPrev

Gets the previous alarm summary entry. Now obsolete.

AlarmSumSet

Sets field information in an alarm summary entry. Now obsolete.

AlmSummarySetFieldValue Sets the value of the field indicated by the cursor position in the browse session. Now obsolete.

AlarmSumSplit

Duplicates an alarm summary entry. Now obsolete.

AlarmSumType

Retrieves a value that indicates a specified alarm's type. Now obsolete.
QueryFunction The user-defined query function set in AlarmSetQuery. Now obsolete.

Miscellaneous Functions

SetLanguage Sets the language database from which the local translations of native strings in the project will be drawn, and specifies the character set to be used. Now obsolete. Use the Login(), UserLogin() and LoginForm() to set the preferred language.

Published June 2018