Property Reference M-N | Historian 8.1 Documentation

M

MaintainAutoRecoveryFiles Property (Server Object)

Returns or sets whether auto recovery files are maintained by the server. Auto recovery files are periodic backups of the the current .IHA and .IHC and protect against data loss due to ungraceful server shutdown.

Syntax

object.MaintainAutoRecoveryFiles[ = Boolean]

Parameters

None

MajorVersion Property (Server Object)

Returns the server or client major version number (1, 2, 3, and so on).

Syntax

object.MajorVersion([API])

Parameters

Name	Data Type	Description
API	Boolean	When True, the server version is returned. When False, the client version is returned. The default is False.

Remarks

MajorVersion is a read-only property of type Long.

Master Property (TagRecordset Object)

Returns the Master tag upon which bulk changes to tag configuration may be performed. When calling the WriteRecordset method, and supplying the "UserMasterTag" parameter, all changes made to the Master tag will be replicated to each tag in the TagRecordset whose Selected property is set to True.

Syntax

object.Master([ClearUpdates])

Parameters

Name	Data Type	Description
ClearUpdates	Boolean	Whether to clear all pending updates in the master tag (optional, default = False).

Remarks

Master is a read-only property of type Tag.

Example

Dim Recordset As TagRecordset Dim Master As Tag ' Get a new TagRecordset Set Recordset = MyServer.Tags.NewRecordset ' 
Fill in criteria, get all tags with collector compression on With Recordset.Criteria  
 .Tagname = "*"   .CollectorCompression = True End With Recordset.QueryRecordset 
Set Master = Recordset.Master ' Set Compression Percent to 0.5% Master.CollectorDeadbandPercentRange = 0.5 ' 
Select all tags in the recordset Recordset.SelectAll ' Commit Changes If Not Recordset.WriteRecordset(True) 
Then   MsgBox "Failed To Commit Tag Changes" End If

MaxReturnCells Property (DataRecordset Object)

Sets the Maximum number of cells to return in the DataRecordSet.

Syntax

object.MaxReturnCells([size])

Parameters

Name	Data Type	Description
Size	Long	Number of cells to return.

MaximumQueryIntervals Property (Server Object)

Returns or sets the maximum query intervals enforced by the server. This property restricts the maximum number of samples per tag that the server can return for non-raw data queries. Filtered and raw data queries are not throttled.

Syntax

object.MaximumQueryIntervals([Long])

Parameters

None

MaximumQueryTime Property (Server Object)

Returns or sets the maximum query time enforced by the server. The property restrict query times and provides balanced access to the server.

Syntax

object.MaximumQueryTime([Long])

Parameters

None

MessageNumber Property (Message Object)

Returns the message number of the Message. A message number is a unique identifier for each Message required for national language support.

Syntax

object.MessageNumber[Long]

Parameters

None

Remarks

MessageNumber is a read-only property of type Long.

MessageNumber Property (MessageCriteria Object)

Establishes which message number the MessageRecordset query will filter by. A message number is a unique identifier for each Message required for national language support.

Syntax

object.MessageNumber[Long]

Parameters

None

MessageNumber Property (MessageFields Object)

Determines whether the MessageNumber field should be returned in the MessageRecordset query.

Syntax

object.MessageNumber[=Boolean]

Parameters

None

MessageNumberSet Property (MessageCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.MessageNumberSet[=Boolean]

Parameters

Option	Description
MessageOnDataUpdate	Determines whether data updates generate a message.

MessageOptions Property (Messages Object)

Exposes the MessageOptions collection to control the behavior of the Historian message generation and archiving.

If the property is set to True, all applications connected to the archiver will cause the archiver to generate a message on a data update, not just the application that set the property. For instance, if you set the property with the SDK and the File Collector updates data (a single value) a message will be generated by the archiver.

An example of a message that appears in the Historian Administrator after you change a specified tag property through the SDK would be:

bsmith(MY_DOMAIN\bsmith) wrote 96 to tag aa at 01/10/2003 04:13:49.861 PM, Replaced 94.000

The message topic type would be Security.

The following table describes each of the messaging options:

Syntax

object.MessageOptions(OptionName)[=Variant]

Parameters

Name	Data Type	Description
OptionName	String	The name of the message option.

Remarks

MessageOptions is a read-only property of type Collection of options.

Example

 ConnectedServer.Messages.MessageOptions("MessageOnDataUpdate") = True

MessageString Property (Message Object)

Returns the translated text of the message, including any substitutions. Messages generally include translated fixed text and variable substitutions such as timestamps, usernames, and tagnames.

Syntax

object.MessageString[String]

Parameters

None

MessageString Property (MessageCriteria Object)

Establishes text search criteria the MessageRecordset query filters by. The MessageString may be any sub-string of the message. You should not include wildcard characters.

Syntax

object.MessageString[=String]

Parameters

None

MessageString Property (MessageFields Object)

Determines whether the MessageString field should be returned in the MessageRecordset query.

Syntax

object.MessageString[=Boolean]

Parameters

None

MessageStringSet Property (MessageCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.MessageStringSet[=Boolean]

Parameters

None

Messages Property (Server Object)

Returns the Messages Object for the current Server. Use the Messages Object to build queries for message data.

Syntax

object.Messages

Parameters

None

MessageOptions Property (Server Object)

Returns the server or client minor version number (0, 1, 2, and so on).

Syntax

object.MessageVersion([API])

Parameters

Name	Data Type	Description
API	Boolean	When True, the server version is returned. When False, the client version is returned. The default is False.

Remarks

MinorVersion is a read-only property of type Long..

N

Name Property (Archive Object)

Returns the name of the specified Archive.

Syntax

object.Name

Parameters

None

Name Property (Collector Object)

Returns the name of the specified Collector.

Syntax

object.Name

Parameters

None

Remarks

Name is a read-only property of type String.

Name Property (DataStore Object)

Returns the name of data store.

Syntax

object.Name

Parameters

None

Remarks

String.

Name Property (Option Object)

The name parameter of this option.

Syntax

object.Name[ = String]

Parameters

None

Name Property (UserCalcFunction Object)

Returns the name of the specified UserCalcFunction.

Syntax

object.Name[ = String]

Parameters

None

NodeFilter Property (OPCBrowse Object)

Some OPCAE Servers allow you to set a filter for the browse. The Areas Returned by the Browse operation will be only those that match the filter criterion. If this property is not set, no filtering takes place.

Syntax

object.NodeFilter[ = Variant]

Parameters

None

Remarks

Nodefilter is a read/write property of type Variant for script compatibility.

NumberOfElements Property (Tag Object)

Returns or sets the number of elements of a tag to specify if it is an array. If the value of the NumberOfElements is -1 then it is an array tag. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.NumberOfElements[ = Long]

Parameters

None

NumberOfElements Property (TagCriteria Object)

Sets the NumberOfElements property to search for in the TagRecordset query. For example you can set to -1 if you want only array tags to be returned or set to 0 if you want non-array tags.

Syntax

object.NumberOfElements[ = Long]

Parameters

None

NumberOfElements Property (TagFields Object)

Determines whether the NumberOfElements field should be returned in the TagRecordset query.

Syntax

object.NumberOfElements[ = Boolean]

Parameters

None

NumberOfFields Property (UserDefinedType Object)

Returns the number of fields in the User Defined Type.

Syntax

object.NumberOfFields

Parameters

Integer

NumberOfSamples Property (DataCriteria Object)

Returns or sets the number of samples to retrieve from the archive in the DataRecordset query. Samples will be evenly spaced within the time range defined by start time and end time for most sampling modes. For the "RawByNumber" sampling mode the NumberOfSamples determines the maximum number of values to retrieve. For the "RawByTime" sampling mode, the NumberOfSamples is ignored.

Syntax

object.NumberOfFields[ = Long]

Parameters

None

NumberOfSamplesSet Property (DataCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.NumberOfSamplesSet[ = Long]

Parameters

None

NumStateNames Property (EnumeratedState Object)

Returns the number of states in the set.

Syntax

object.NumStateNames

Parameters

None

Remarks

Long