Object attributes

Attributes that are common to all objects are not included in the following attribute table. For information on common attributes, see the Configuration Help. To access this Help file, click the Configuration Help link, which is located in the fixed header area that appears at the top of this Help file window.

Hidden attributes are not included in the following attribute table. Hidden attribute names are prefixed with an underscore ( _ ) and may be visible within certain applications, such as the Object Viewer. Hidden attributes are generally used for internal ArchestrA functionality, and should be ignored.

Table Legend:

The Config column specifies whether the attribute can be configured using an option in the object editor.

The RT Access column describes how the attribute value can be accessed at runtime. Values for this column include:

• Supervisory- The attribute value can be changed using a script.

• User- The attribute value can be modified by the user.

• Read-Only-The attribute value cannot be changed.

• None- The primitive is being deployed; however, the attribute is not deployed at runtime (package only).

  Attribute	Description	Config	RT Access
  AttrToDBAppendCmd	If set to TRUE, a transfer of values will be initiated from the assigned attributes to a new database record in the SQL Server database (append new database record). The SQLData object resets this attribute after it executes. The values from the new database record are transferred to the dynamically created runtime attributes to reflect the record selected. If an assigned attribute quality is not GOOD, and the AttrToDBQualityIgnore attribute is FALSE, the transfer of values is prevented so that bad data is not written to the database. An error is generated. When the AttrToDBQualityIgnore attribute is TRUE, all attribute values are written to the database as a new record. Attribute values with quality other than GOOD are written to the databasename_status database with the following information: attribute name, attribute quality, and foreign key value for the associated record.	No	Supervisory, User
  AttrToDBQualityIgnore	If set to TRUE, assigned attributes with a quality other than GOOD will be allowed to be transferred to the database using the AttrToDBAppendCmd and AttrToDBReplaceCmd command attributes. Assigned attribute values with quality other than GOOD are written to the databasename_status database with the following information: attribute name, attribute quality, and foreign key value for the associated record.	Yes	Read-Only
  AttrToDBReplaceCmd	If set to TRUE, a transfer of values will be initiated from the assigned attributes to the selected database record in the SQL Server database. The SQLData object resets this attribute after it executes. The new values from the database record are transferred to the dynamically created runtime attributes to reflect the record selected. If an assigned attribute quality is not GOOD, and the AttrToDBQualityIgnore attribute is FALSE, the transfer of values is prevented so that bad data is not written to the database. An error is generated. If the RecordCnt attribute value is not equal to 1, the AttrToDBReplaceCmd attribute functionality is disabled. When the AttrToDBQualityIgnore attribute is TRUE, the values in selected database record are replaced with the attribute values. Attribute values with quality other than GOOD are written to the databasename_status database with the following information: attribute name, attribute quality, and foreign key value for the associated record.	No	Supervisory, User
  AttrToTempCmd	If set to TRUE, a transfer of values and quality is initiated from the assigned attributes to the dynamically created runtime attributes. This attribute resets itself after execution.	No	Supervisory, User
  AttrWriteComplete	If TRUE, a successful transfer has occurred of values from the database to the assigned attributes within the time period specified by the DBWriteTimeout attribute after initiation of the TempToAttrCmd and DBToAttrCmd command attributes. The AttrWriteComplete attribute is reset after the AttrWriteCompleteResetCmd command attribute is set or after subsequent setting of the TempToAttrCmd and DBToAttrCmd command attributes.	No	Read-Only
  AttrWriteCompleteResetCmd	If set to TRUE, the AttrWriteComplete attribute will be reset. This command is optional, as the AttrWriteComplete attribute is reset automatically by subsequent TempToAttrCmd and DBToAttrCmd command attributes. This attribute resets itself after execution.	No	Supervisory, User
  AttrWriteInhibitDelay	The time preset, in milliseconds, that maintains the SemaphoreAttrWrite attribute as TRUE once a transfer to the assigned attributes has been initiated. This applies to both the TempToAttrCmd and DBToAttrCmd command attributes.	Yes	Supervisory, User
  AuthenticationMode	The authentication method used for connecting to the SQL Server database. Valid values are ArchestrA User, Windows User, or SQL User. When the authentication method is set to Window User, the _Domain, _UserName, and _UserPassword hidden attributes are used for authentication. When the authentication method is set to SQL User, the _UserName, and _UserPassword hidden attributes are used for authentication. When the authentication method is set to ArchestrA User, the ArchestrA network account is used for authentication.	Yes	Read-Only
  AutoUpdateSelection	Determines when the currently selected recordset is updated. If FALSE, the current selected recordset is only affected by the commands DBtoAttrCmd or DBtoTempCmd. If TRUE, the current selected recordset is updated whenever: The QueryString is modified. New records are appended that meet the conditions of the QueryString Where clause (they are added). Existing records are updated that no longer meet the conditions of the QueryString Where clause (they are removed).	Yes	Supervisory, User
  CommandTimeout	Sets the CommandTimeout property exposed by the DCM Command object. A value of '0' indicates infinite timeout. Make sure the value is not negative.	Yes	Supervisory, User
  DatabaseConnectionTimeout	Sets the ConnectionTimeout property exposed by the DCM Connection Object. A value of '0' indicates infinite timeout. The default is 15 seconds. The value cannot be negative.	Yes	Supervisory, User
  DBAutoConnect	If set to TRUE, automatic connection to the SQL Server database will be enabled. When TRUE, the SQLData object establishes a connection to database upon initial deployment and upon demand if the connection is lost.	Yes	Supervisory, User
  DBConnectionUpTime	The database connection up time.	No	Read-Only
  DBConnectState	If TRUE, the SQLData object is connected to the SQL Server database. If FALSE, the SQLData object is disconnected.	No	Read-Only
  DBConnectStateCmd	If set to TRUE, the SQLData object performs a manual connect to the SQL Server database. If set to FALSE, the SQLData object performs a manual disconnect from the SQL Server database. When the DBAutoConnect attribute is TRUE, the DBConnectStateCmd attribute is TRUE, and you cannot set the DBConnectStateCmd attribute to FALSE.	No	Supervisory, User
  DBName	The name of the SQL Server database to which the object is configured to connect.	Yes	Read-Only
  DBReadCnt	The total number of database reads performed by the SQLData object. This count can be reset by using the DiagnosticsResetCmd attribute.	No	Read-Only
  DBReadFailedCnt	The total number of failed database reads performed by the SQLData object. This count can be reset by using the DiagnosticsResetCmd attribute.	No	Read-Only
  DBReadOnly	If set to TRUE, read-only access is allowed for the SQL Server database. The SQLData object will not be able to modify either the database schema or the data. No write commands (AttrToDBAppendCmd, AttrToDBReplaceCmd, TempToDBAppendCmd, TempToDBReplaceCmd, and RecordDeleteCmd attributes) can be performed against the SQL Server database. Reading values from the database is permitted. The DBReadOnly attribute requires a valid database, as the option does not create a new database on initial deployment.	Yes	Read-Only
  DBServerName	The name of the SQL Server to which the object is configured to connect, along with the port number, if a non-default port is used. Named server instances are not supported. If a non-default port is used, DBServerName will include the port number in the format <SQLServerName>,<port #> Default SQL Server port is 1433; if the default port is used, the number is not appended to DBServerName.	Yes	Read-Only
  DBTableName	The name of the SQL Server database table to which the object is configured to connect.	Yes	Read-Only
  DBToAttrCmd	If set to TRUE, a SQL query is initiated to select a database record and then transfer the values of the selected database record to the assigned attributes. The SQLData object resets this attribute after it executes. The values from the database record are transferred to the dynamically created runtime attributes to reflect the record selected. The record selection uses the runtime query. The runtime query can be configured to use either the SQL query string attribute or the combination of column name and column value attributes. If the QueryStringEnable attribute is TRUE, then the query is: "WHERE QueryString" If the QueryStringEnable attribute is FALSE, the query is: "WHERE QueryColumnName = QueryColumnValue" If more than one record is returned by the query, an error is generated, and the transfer is terminated. An error is generated if any value fails to transfer.	No	Supervisory, User
  DBToTempCmd	If set to TRUE, a SQL query is initiated to select a database record and then transfer the values of the selected database record to the dynamically created runtime attributes. The SQLData object resets this attribute after it executes. The record selection uses the runtime query. The runtime query can be configured to use either the SQL query string attribute or the combination of column name and column value attributes. If the QueryStringEnable attribute is TRUE, then the query is: "WHERE QueryString" If the QueryStringEnable attribute is FALSE, the query is: "WHERE QueryColumnName = QueryColumnValue" If more than one record is returned by the query, an error is generated, and the transfer is terminated.	No	Supervisory, User
  DBWriteCnt	The total number of database writes performed by the SQLData object. This count is reset by the DiagnosticsResetCmd attribute.	No	Read-Only
  DBWriteFailedCnt	The total number of failed database writes performed by the SQLData object. This count is reset by the DiagnosticsResetCmd attribute.	No	Read-Only
  DBWriteTimeout	The error time out period, in milliseconds. The ErrorDBWrite attribute is set to TRUE when the time out delay period expires.	Yes	Supervisory, User
  DiagnosticsResetCmd	If set to TRUE, the DBWriteCnt, DBWriteFailedCnt, DBReadCnt, DBReadFailedCnt, LastCmdExecutionDuration, and DBConnectionUpTime attributes are set to zero. The DiagnosticsResetCmd attribute resets itself after execution.	No	Supervisory, User
  ErrorCode	A representation of the active error as an integer number.	No	Read-Only
  ErrorDBRead	If set to TRUE, an error has occurred during data transfer from the database to the dynamically created runtime attributes or the assigned attributes. The following events represent a transfer error: The query returns no record. The record cannot be read due to security access restrictions. The record cannot be read due to a database failure. The values have failed to transfer to the assigned attributes within the period specified by the DBWriteTimeout attribute.	No	Read-Only
  ErrorDBWrite	If set to TRUE, an error has occurred during the modification of a record in the database. The following events represent a edit error: The record cannot be modified due to security access restrictions. The record cannot be modified due to a database failure. The record has been deleted by another application after the record has been selected.	No	Read-Only
  ErrorDeletingDBRecord	If set to TRUE, an error has occurred during deletion of a record(s) from the database. The following events represent a transfer error: The record cannot be read due to security access restrictions. The record cannot be read due to a database failure.	No	Read-Only
  ErrorDesc	A representation of the active error as a string. The string describes the last error obtained in the SQLData object. For example, if a database read error occurred, a database read error message is displayed.	No	Read-Only
  ErrorSelectNextRecord	If set to TRUE, an error has occurred during an attempt to move to a record that does not exist using the RecordSelectNextCmd command attribute. (That is, attempting to scroll past the last record in the database.)	No	Read-Only
  ErrorSelectPreviousRecord	If set to TRUE, an error has occurred during an attempt to move to a record that does not exist using the RecordSelectPreviousCmd command attribute. (That is, attempting to scroll before the first record in the database.)	No	Read-Only
  ErrorSelectFirstRecord	If set to TRUE, an error has occurred during an attempt to move to a record that does not exist using the RecordSelectFirstCmd command attribute. (That is, the database does not contain any records.)	No	Read-Only
  ErrorSelectLastRecord	If set to TRUE, an error has occurred during an attempt to move to a record that does not exist using the RecordSelectLastCmd command attribute. (That is, the database does not contain any records.)	No	Read-Only
  ErrorsResetAllCmd	If set to TRUE, the following attributes will be reset: ErrorCode, ErrorDeletingDBRecord, ErrorDBRead, ErrorDBWrite, ErrorSelectNextRecord, ErrorSelectPreviousRecord, and ErrorDesc. When the ErrorsResetAllCmd attribute is TRUE, the following values are set: ErrorCode = 0 ErrorDeletingDBRecord = false ErrorDBRead = false ErrorDBWrite = false ErrorSelectNextRecord = false ErrorSelectPreviousRecord = false ErrorDesc = ""	No	Supervisory, User
  LastCmdExecutionDuration	The time, in milliseconds, taken to execute a database access command (such as the AttrToDBAppendCmd, AttrToDBReplaceCmd, DBToAttrCmd, DBToTempCmd, RecordDeleteCmd, RecordSelectNextCmd, RecordSelectPreviousCmd, TempToDBAppendCmd, and TempToDBReplaceCmd attributes).	No	Read-Only
  MaxConnections	Gets or Sets the maximum number of actual active connections allowed to the physical database for the specified connection string.	Yes	Supervisory, User
  MaxRecords	MaxRecords is inserted into the "Select TOP ..." query, and also limits the behavior of AutoUpdateSelection when an append exceed MaxRecords. The default is 1,000. MaxRecords can be used as a filter to use either a free format string or the combination of a column name and column value. If using a free format query string as a query to a string attribute, it executes as: SELECT * TOP MaxRecords FROM <TableName> WHERE QueryString When using the combination of a column name and column value, write the column name (typically set at configuration time) and lookup value to separate string attributes. The query executes as: SELECT TOP MaxRecords* FROM <TableName> WHERE QueryColumnName = <QueryColumnValue>	Yes	Supervisory, User
  QueryColumnName	The column name used by the runtime query. If the QueryStringEnable attribute is FALSE, the query is: "WHERE QueryColumnName = QueryColumnValue" The query is used by the DBToTempCmd, RecordDeleteCmd, and DBToAttrCmd command attributes.	Yes	Supervisory, User
  QueryColumnValue	The default column value used by the runtime query. If the QueryStringEnable attribute is FALSE, the query is: "WHERE QueryColumnName = QueryColumnValue" The query is used by the DBToTempCmd, RecordDeleteCmd, and DBToAttrCmd command attributes.	Yes	Supervisory, User
  QueryString	The runtime SQL query. This query will execute at runtime if the QueryStringEnable attribute has been set to TRUE. The query is executed by the RecordDeleteCmd, DBToTempCmd, and DBToAttrCmd command attributes. The SQL method when using this string is: "WHERE QueryString" Incorrect queries will return an error on execution. No error checking of the string provided.	No	Supervisory, User
  QueryStringEnable	Used to determine the method for creating the query executed by the RecordDeleteCmd, DBToTempCmd, and DBToAttrCmd command attributes. If the QueryStringEnable attribute is TRUE, the query is: "WHERE QueryString" If the QueryStringEnable attribute is FALSE, the query is: "WHERE QueryColumnName = QueryColumnValue"	Yes	Read-Only
  RecordCnt	The total number of records in the active query at runtime.	No	Read-Only
  RecordDeleteCmd	If set to TRUE, a SQL query will be initiated to select a database record(s) and then deletes the selected record(s). The SQLData object resets this attribute after it executes. The values in the dynamically created runtime attributes are cleared to reflect that no record is selected in the database. The record selection uses the runtime query. The runtime query can be configured to use either the SQL query string attribute or the combination of column name and column value attributes. If the QueryStringEnable attribute is TRUE, then the query is: "WHERE QueryString" If the QueryStringEnable attribute is FALSE, the query is: "WHERE QueryColumnName = QueryColumnValue"	No	Supervisory, User
  RecordFirstSelected	Set to TRUE when the first record in the database has been selected.	No	Read-Only
  RecordLastSelected	Set to TRUE when the last record in the database has been selected.	No	Read-Only
  RecordSelectFirstCmd	If set to TRUE, the first record in the database will be selected, the values of the selected database record will be transferred to the dynamically created runtime attributes (no reference is made to the query or dynaset created by the query). This attribute resets itself after execution.	No	Supervisory, User
  RecordSelectLastCmd	If set to TRUE, the last record in the database will be selected, the values of the selected database record will be transferred to the dynamically created runtime attributes (no reference is made to the query or dynaset created by the query). This attribute resets itself after execution.	No	Supervisory, User
  RecordSelectNextCmd	If set to TRUE, the next record in the database will be selected, the values of the selected database record will be transferred to the dynamically created runtime attributes (no reference is made to the query or dynaset created by the query). This attribute resets itself after execution. An error is generated when an attempt is made to go past the last record in the database. If no record has been selected, then the first record in the database is selected.	No	Supervisory, User
  RecordSelectPreviousCmd	If set to TRUE, the next record in the database will be selected, and the values of the selected database record will be transferred to the dynamically created runtime attributes (no reference is made to the query or dynaset created by the query). This attribute resets itself after execution. An error is generated when an attempt is made to go past the first record in the database. If no record has been selected, then the first record in the database is selected.	No	Supervisory, User
  RecordSingleSelected	Set to TRUE when the query returns a single record.	No	Read-Only
  SemaphoreAttrWrite	Set to TRUE for a time period (specified by the AttrWriteInhibitDelay attribute) after a transfer to the assigned attributes has been initiated to prevent simultaneous writes to the assigned attributes.	No	Read-Only
  SemaphoreDBWrite	If set to TRUE, the object will be prevented from performing simultaneous edits of the database records.	No	Read-Only
  TempAttrQualityResetCmd	If set to TRUE, the quality status of all temporary attributes will be set to GOOD. This attribute resets itself after execution.	No	Supervisory, User
  TempToAttrCmd	If set to TRUE, the values of the dynamically created runtime attributes will be transferred to the assigned attributes. The SQLData object resets this attribute after it executes. If a temporary attribute quality is not GOOD, and the TempToAttrQualityIgnore attribute is FALSE, the transfer of values is prevented so that bad data is not written to the assigned attributes. The temporary attribute quality can be manually set to GOOD by setting the TempAttrQualityResetCmd command attribute to TRUE.	No	Supervisory, User
  TempToAttrQualityIgnore	If set to TRUE, temporary attributes with a quality other than GOOD will be allowed to be transferred to the assigned attributes using the TempToAttrCmd command attribute.	Yes	Read-Only
  TempToDBAppendCmd	If set to TRUE, the values from the dynamic attributes will be transferred to a new database record (append new database record). The SQLData object resets this attribute after it executes. If a temporary attribute quality is not GOOD (that is, BAD or UNCERTAIN), and the TempToDBQualityIgnore attribute is FALSE, the transfer of values is prevented so that bad data is not written to the database. The temporary attribute quality can be manually set to GOOD by setting the TempAttrQualityResetCmd command attribute to TRUE.	No	Supervisory, User
  TempToDBQualityIgnore	If set to TRUE, temporary attributes with a quality other than GOOD will be allowed to be transferred to the database using the TempToDBAppendCmd and TempToDBReplaceCmd command attributes.	Yes	Read-Only
  TempToDBReplaceCmd	If set to TRUE, the values of the dynamically created runtime attributes will be transferred to the selected database record. The SQLData object resets this attribute after it executes. If a temporary attribute quality is not GOOD (that is, BAD or UNCERTAIN), and the TempToDBQualityIgnore attribute is FALSE, the transfer of values is prevented so that bad data is not written to the database. The temporary attribute quality can be manually set to GOOD by setting the TempAttrQualityResetCmd command attribute to TRUE. If the RecordCnt attribute value is not equal to 1, the TempToDBReplaceCmd attribute is not available.	No	Supervisory, User