[dbo]​.[writeCommItemByName] stored procedure

@objectName

Y

T_nameType, nvarchar(32)

The name of the object. This value will be checked against the objectName in the objectDefine table. If the system has the CD_CONTACT module enabled and the @orgName is provided, the system will consider the @objectName to be the externally known name and lookup the name internal to AVEVA Measurement Advisor. For example, the organization 'Big Corp' calls our meter '12345-01' by the name 'FHILLS01'. In this case, the orgName is 'Big Corp' and the objectName is 'FHILLS01'. The system will use this to look up that the internal name is '12345-01'. The orgName will be compared to the column organizationName in the organizationDefine table. The objectName will be checked against the aliasName column in the objectOrgAlias table using the object type determined by the property being updated. If the @objectName is not found, the event data will be rejected.

@orgName

N

T_nameType, nvarchar(32)

The name of the organization. It will be compared to the column organizationName in the organizationDefine table. The @orgName is used when looking up the object alias. If the object alias is not found, the event data will be rejected.

@time

N

T_GMTtime, int

The time in seconds from Jan 1, 1970 in Greenwich Mean Time (GMT).

@offset

N

T_GMToffset, smallint

The timezone represented in minutes from GMT. For example, Mountain Standard timezone is -420. Mountain Daylight timezone is -360. It is calculated based on the time of the data and the timezone of the meter.

@localTime

N

T_nameType, nvarchar(32)

Either the @localTime or @time parameters must be provided. In order to use @localTime, @time must be set to null. If both parameters are provided, the system will use the value of @time. This value should be consistent with the @timeFormat that is used.

@timeFormat

N

T_nameType, nvarchar(32)

A string to let the system know how to interpret the @localTime string. The @timeFormat is the format you have used for the @localTime string. The default is '%m/%d/%Y %T'.

Additionally, the following timeFormats are also considered valid:

• '2/22/2021 5AM', '%m/%d/%Y %I'

• '2/22/21 17:32', '%m/%d/%y %R'

• '22/2/01 17:00:00', '%d/%m/%y %T'

• '21/02/22 7:32', '%y/%m/%d %R'

• '21/02/22 7:32', '%Y/%m/%d %R'

@subGroupName

Y

T_nameType, nvarchar(32)

The name of the sub group containing the property that will be updated.

@itemName

Y

T_nameType, nvarchar(32)

The name of the property that will be updated.

@numericValue

N

T_doublePrecisionType, float

The value to which the property should be set. Use @numericValue for numeric properties.

@booleanValue

N

T_booleanType, char(1)

The value to which the property should be set. Use @booleanValue for boolean properties. Valid values for boolean properties are 'Y' or 'N'.

@textValue

N

T_messageType, nvarchar(255)

The value to which the property should be set. Use @textValue for string properties.

@isSummer

Y

T_booleanType, char(1)

This is used when localTime is given to disambiguate the fall DST switch.

@propertyOrgName

Y

T_nameType, nvarchar(32)

This is used for the objItemOrgAliasDesc and objItemDomainOrgAliasDesc tables.

@objectTypeName

Y

T_nameType, nvarchar(32)

The type of object. This is not required but must be specified for propertyOrgName lookup.

@meteringMethod

Y

T_nameType, nvarchar(32)

The type of Metering Method in use. This is not required but must be specified for propertyOrgName lookup.

@volumetricCalc

Y

T_nameType, nvarchar(32)

The volumetric calculation type in use. This is not required but must be specified for propertyOrgName lookup.

@userName

N

T_nameType, nvarchar(32)

The name of the user or system that made the submission.