| Name | Description | Type | Additional information |
|---|---|---|---|
| pointTag |
This point's tag. |
string |
Required |
| isActive |
Indicates whether or not this point is active. |
boolean |
Required |
| pointVersion |
The version of the point. |
date |
None |
| description |
This point's description. |
string |
Required |
| longDescription |
The extended description of this point. |
string |
Required |
| pointScheme |
The point's point scheme. |
unsigned integer |
Required |
| pointDataType |
The type of data in the point, Analog, Enumeration, String, or Digital and Input or Output. |
string |
Required |
| primaryUnits |
The abbreviated form of the point's primary units. |
string |
Required |
| alternateUnits |
The abbreviated form of the point's alternative units. |
string |
Required |
| systemName |
The system value for the point. System is a user-defined field in the PNT header record, which is a TRS entry in the CMSYS table. |
string |
Required |
| displayAttribute |
The point's display attribute, which is a TRS entry in the PNTDISP table. |
string |
Required |
| securityApp |
The point's security application. |
string |
Required |
| initialType |
The initial value configuration of the point. |
InitialValueType |
Required |
| initialValue |
The point's initial value. |
string |
Required |
| allowedUpdates |
The value that defines the allowed update types for the point. |
AllowedUpdates |
Required |
| manualInputEnabled |
Indicates whether or not manual input is forced for the point. |
boolean |
Required |
| suppressAlarms |
Indicates whether or not alarm suppression is enabled for the point. |
boolean |
Required |
| suppressAlarmsEndsOnNormal |
Indicates whether or not if alarm suppression will occur until the point state for the point is normal. |
boolean |
Required |
| suppressAlarmsEndsOnDateTime |
Indicates the time when alarm suppression will occur until. |
date |
Required |
| alarmCategory |
The alarm category of the point’s alarm. |
string |
Required |
| anyConfigBitEnabled |
Indicates whether or not a configuration bit is enabled for the point. |
boolean |
None |
| anyConfigBitReportingCAS |
Indicates whether or not the point has a configuration bit that is reporting to the CAS. |
boolean |
None |
| anyConfigBitReportingGNS |
Indicates whether or not the point has a configuration bit that is reporting to the GNS. |
boolean |
None |
| anyConfigBitHasGNSId |
Indicates whether or not the point has a configuration bit that has a GNS Id for the notification. |
boolean |
None |
| anyConfigBitHasReportingDelay |
Indicates whether or not the point has a configuration bit that has a reporting delay. |
boolean |
None |
| reportDelayUnits |
The alarm’s delay value units. |
ReportDelayUnits |
Required |
| reportVHS |
The report values to history option. |
boolean |
Required |
| historyOnLineDays |
Indicates the length of time in days the VHS has been online. |
unsigned integer |
Required |
| forceHistoryOnUpdate |
Indicates whether or not the value will sent to the VHS even if the value has not changed. |
boolean |
Required |
| forceHistory |
Indicates what value will be sent to the VHS every ForcePeriod minutes, even if a value update has not occurred. |
ForceHistoryAction |
Required |
| forcePeriod |
Indicates how frequently the VHS is forced to log. Limited in range from 0 to 999,999 minutes. Corresponds to the "Maximum reporting interval" field on the Point editor's History tab. |
time interval |
Required |
| minimumEvaluationTime |
The minimum evaluation time for processing values to send to the VHS. Limited in range from 0 to 65535 seconds. |
time interval |
Required |
| compressionType |
Indicates the type of data compression to be used. |
CompressionType |
Required |
| alarmDeadBand |
Defines a the minimum delta a point's value must change for the Minimum Value and Maximum Value alarm calculations to trigger. |
decimal number |
Required |
| historyDeadBand |
Defines a minimum delta a point's value must change to be sent to the Historian. |
decimal number |
Required |
| maxSetPoint |
The maximum setpoint for the point. |
decimal number |
Required |
| minSetPoint |
The minimum setpoint for the point. |
decimal number |
Required |
| scaleValue |
Indicates if scaling is enabled for the point's value. |
boolean |
Required |
| scaleCoefficientA0 |
The scale coefficient number for the point’s value when polynomial curve fit coefficients are used. |
decimal number |
Required |
| scaleCoefficientA1 |
The scale coefficient number for the point’s value when polynomial curve fit coefficients are used. |
decimal number |
Required |
| scaleCoefficientA2 |
The scale coefficient number for the point’s value when polynomial curve fit coefficients are used. |
decimal number |
Required |
| scaleCoefficientA3 |
The scale coefficient number for the point’s value when polynomial curve fit coefficients are used. |
decimal number |
Required |
| scaleCoefficientA4 |
The scale coefficient number for the point’s value when polynomial curve fit coefficients are used. |
decimal number |
Required |
| scaleCoefficientA5 |
The scale coefficient number for the point’s value when polynomial curve fit coefficients are used. |
decimal number |
Required |
| twoPointScale |
Indicates if two-point scaling in use for the point’s value. |
boolean |
Required |
| rawLow |
The raw low value used in two-point scaling. |
decimal number |
Required |
| rawHigh |
The raw high value used in two-point scaling. |
decimal number |
Required |
| engineeringLow |
The low engineering value used in two-point scaling. |
decimal number |
Required |
| engineeringHigh |
The high engineering value used in two-point scaling. |
decimal number |
Required |
| useDecimalPlaces |
Determines whether if the DecimalPlaces property will be used. |
boolean |
Required |
| decimalPlaces |
The number of decimal places that exist when scaling portion of the alarm record. Sixteen characters, including decimal digits, are allowed. The UseDecimalPlaces property must be true for this value to take effect. |
unsigned integer |
Required |
| digitalOnString |
The value that will be used when a digital point is considered to be ON. |
string |
Required |
| digitalOffString |
The value that will be used when a digital point is considered to be OFF. |
string |
Required |
| enumTableName |
The name of the Enum table used to translate numeric values to strings. |
string |
Required |
| pointReferenceType |
The type of the reference point. |
string |
Required |
| referenceSite |
The site of the reference point. |
string |
Required |
| referenceService |
The service of the reference point. |
string |
Required |
| referencePointId |
The Id of the reference point. |
string |
Required |
| referencePointIdLong |
The LongId of the reference point. |
string |
Required |
| anyVerifiedFlag |
Indicates whether or not any of the VerifiedFlags are set. |
boolean |
None |
| verifiedFlag1 |
The first verified user flag. |
boolean |
Required |
| verifiedFlag2 |
The second verified user flag. |
boolean |
Required |
| verifiedFlag3 |
The third verified user flag. |
boolean |
Required |
| verifiedFlag4 |
The fourth verified user flag. |
boolean |
Required |
| verifiedTimestamp |
The last time one of the VerifiedFlags changed. |
date |
None |
| questionableFlag |
A user-provided field indicating if the point is questionable or not. |
boolean |
Required |
| questionableTimestamp |
The timestamp indicating when the QuestionableFlag field changed. |
date |
None |
| anyUserFlag |
Indicates whether or not the point has any user flag set. |
boolean |
None |
| userFlag1 |
A general user-defined attribute from the PNT record for the point. |
boolean |
Required |
| userFlag2 |
A general user-defined attribute from the PNT record for the point. |
boolean |
Required |
| userFlag3 |
A general user-defined attribute from the PNT record for the point. |
boolean |
Required |
| userFlag4 |
A general user-defined attribute from the PNT record for the point. |
boolean |
Required |
| userFlag5 |
A general user-defined attribute from the PNT record for the point. |
boolean |
Required |
| userFlag6 |
A general user-defined attribute from the PNT record for the point. |
boolean |
Required |
| userFlag7 |
A general user-defined attribute from the PNT record for the point. |
boolean |
Required |
| userFlag8 |
A general user-defined attribute from the PNT record for the point. |
boolean |
Required |
| indexed1 |
A user-defined attribute from the PNT record for the point. The PNT service provides a database index on this field |
string |
Required |
| indexed2 |
A user-defined attribute from the PNT record for the point. The PNT service provides a database index on this field. |
string |
Required |
| indexed3 |
A user-defined attribute from the PNT record for the point. The PNT service provides a database index on this field. |
string |
Required |
| tableDriven1 |
A user-defined attribute from the PNT record for the point. The property is a field in the CMT1 table. |
string |
Required |
| tableDriven2 |
A user-defined attribute from the PNT record for the point. The property is a field in the CMT2 table. |
string |
Required |
| tableDriven3 |
A user-defined attribute from the PNT record for the point. The property is a field in the CMT3 table. |
string |
Required |
| general1 |
An application-defined attribute. |
string |
Required |
| general2 |
An application-defined attribute. |
string |
Required |
| general3 |
An application-defined attribute. |
string |
Required |
| externalIdType |
A table-driven field indicating the External Id type for the point. |
string |
Required |
| externalId |
The External Id for the point. |
string |
Required |
| comment |
The comment for the point. |
string |
Required |
| hasEnhancedAlarmConfig |
Whether or not this point has Enhanced Alarm Configuration defined. |
boolean |
None |
| hasEnhancedAlmarmConfigError |
Whether or not the Enhanced Alarm Configuration defined for this point has an error. |
boolean |
None |
| hyperPointEnabled |
Whether or not this point is a HyperPoint. |
boolean |
Required |
| scriptEnabled |
Whether or not the HyperPoint script is enabled for this point. |
boolean |
Required |
| scriptVersion |
The script version for the point. |
date |
Required |
| hyperPointType |
The HyperPoint type for the point. |
HyperPointType |
Required |
| hyperPointScriptFormat |
The HyperPoint script format for the alarm. |
string |
Required |
| hyperPointLibLongId |
The HyperPoint library long Id for the alarm. |
string |
Required |
| configurableBitParameters |
List of ConfigurableBitParametersDTO objects (1 - 15). |
Collection of ConfigurableBitParametersDTO |
Required |