Instrument import

Instrument

Field name	Value	Description
positionId	1-65 characters	Unique identifier for the position
positionName	Max 50 characters	A more descriptive name for the Position
positionLocation	Max 50 characters	Field for describing the exact location of the position
positionPath	Free text	Full plant structure path to position. Each plant node is separated with a '\' character e.g. "plantNode1\plantNode2\plantNode3"
deviceId	1-65 characters	Unique identifier for the device
deviceModel	Free text	Device model name "Beamex"
deviceModelManufacturer	Free text	Device model manufacturer name e.g. "MC6"
deviceSerialNumber	Max 25 characters	Device serial number e.g. "1234"
functionName	Max 50 characters	Name of the function
functionNumber	Incremental number	Automatically incremented, not part of the excel import
instrumentXmtr	InstrumentXmtr	Use Excel file for xmtr instrument import
	or
instrumentSwitch	InstrumentSwitch	Use Excel file for switch instrument import

Instrument types

InstrumentXmtr

Field name	Value	Description
input	IOBlock	Use the IOBlock
output	IOBlock	Use the IOBlock
transferFunction	Value	Use a value from the transfer function table
calibrationProcedure	CalibrationProcedure	Use the CalibrationProcedure type fields

InstrumentSwitch

Field name	Value	Description
functionName	Max 50 characters	Name of the function
functionNumber	n/a	This field is not part of the import.
input	IOBlock	Use the IOBlock
output	IOBlockState	Use the IOBlockState
calibrationProcedure	CalibrationProcedure	Use the CalibrationProcedure

IOBlock

Field name	Value	Description
low	number	Span low limit
high	number	Span high limit
unit	Unit	Use the Unit
quantity	Value	IOBlock quantity
category	Value	Category describes the type of the output signal. Input category is always Analog variable.
pressure	IOBlockPressure	Use the IOBlockPressure
	or
electrical	IOBlockElectrical	Use the IOBlockElectrical
	or
frequency	IOBlockFrequency	Use the IOBlockFrequency
	or
temperatureTC	IOBlockTemperatureTC	Use the IOBlockTemperatureTC
	or
temperatureRTD	IOBlockTemperatureRTD	Use the IOBlockTemperatureRTD
	or
digital	IOBlockDigital	Use the IOBlockDigital
	or
digitalReadout	IOBlockDigitalReadout	Use the IOBlockDigitalReadout
	or
analogReadout	IOBlockAnalogReadout	Use the IOBlockAnalogReadout

Unit

Field name	Value	Description
symbol	Value	Use a value from the unit type table. If anything else is used it will become a custom unit (Max 15 characters).

IOBlockPressure

Field name	Value	Description
pressureType	Value	Use a value from the pressure type table

IOBlockElectrical

Field name	Value	Description

IOBlockFrequency

Field name	Value	Description

IOBlockTemperatureTC

Field name	Value	Description
sensor	Value	Use a value from the sensor type table. Only TC types can be used.

IOBlockTemperatureRTD

Field name	Value	Description
sensor	Value	Use a value from the sensor type table. Only RTD types can be used.

IOBlockDigital

Field name	Value	Description

IOBlockDigitalReadout

Field name	Value	Description
reqResolution	Value	Use a value from the resolution type table.

IOBlockAnalogReadout

Field name	Value	Description
reqReadability	Value	Use a value from the resolution type table.

IOBlockState

Field name	Value	Description
setState	Value	The state of device after set action
setPoint		The value where state changes.
resetPoint		The reset value.
contactType	Value
triggerLevel	number	Trigger level in voltage (V), only required when contactTypes is Wet (1).
invertOpenClose	boolean	Inverts switch Open/Closed states.

CalibrationProcedure

Field name	Value	Description
errorType	Value	Type of measurement error
asFoundCount	number	Recommended number of test repeats on instrument before adjustment.
asLeftCount	number	Recommended number of test repeats on instrument after adjustment.
calibrationPeriodUnit	Value	Calibration period unit.
calibrationPeriodDisplayValue	number	Calibration period according to the period unit.
calibrationDueDate	Timestamp	Calibration Due Date
beforeNote	Free text	Before calibration note
adjustNote	Free text	Before adjustment note
afterNote	Free text	After calibration note
rejectIfCalibratorOverdue	true/false	Do not accept references whose calibration is overdue for this instrument.
calibrationProcedureXmtr	CalibrationProcedureXmtr
	or
calibrationProcedureSwitch	CalibrationProcedureSwitch

Timestamp

Field name	Value	Description
utc	number	Time in Unix Time, number of seconds since 00:00:00 (UTC)
localOffset	number	Time zone local offset in seconds.

CalibrationProcedureXmtr

Field name	Value	Description
errorCalcSide	Value	Error calculation side
adjustLimit	number	Adjust if error is over this limit, must be given in relative value (e.g. 60% => 0.6)
dontAdjustIfLimit	number	Do not adjust if error is under this limit, must be given in relative value (e.g. 60% => 0.6)
adjustToLimit	number	Adjust to some error below this limit, must be given in relative value (e.g. 60% => 0.6)
asymmetricMultiplierSide	Value	The error limit multiplier will create asymmetric error limits.
errorLimits	ErrorLimit	Error limits, multiple ranges can be defined.
testPoints	NominalTestPoint	Nominal test points
testPointsRepeatFormat	Value	Determines how calibration points are scaled according to the span of the function.
testPointsAmount	Value	Determines how many points will be calculated to the span of the function, within the repeat format scheme.
testPointsOnOutput	boolean	If a user enters 'true'in the 'testPointOnOutput' field, then test points will be calculated from the output. The default value is 'false,' which means if the user doesn't enter any data in the field, the value is automatically set to 'false'.

Custom test points

Custom test points can be set after the testPointsRepeatFormat is set to “customized”, and the testPointAmount value is within the range of 1-21. Then the user needs to assign values to testPointValue[1-21]. The number of required testPointValue fields is determined by the testPointAmount value. For example, if the testPointAmount is set to 5, then values need to be configured for testPointValue[1-5], where the index indicates the point number.

The optional field testPointRemark[1-21] can be set regardless of the selected testPointRepeatFormat. For instance, if testPointRepeatFormat is set to “Up” and testPointAmount is set to 3, the user can set remarks for points 1-3."

Field name	Value	Description
testPointValue[1-21]	number	Set custom test point value.
testPointRemark[1-21]	string	Optional calibration message for test point.

Note!

Custom calibration point limit is set to 21 test points.

ErrorLimit

Field name	Value	Description
rejectIfBase	number	Constant Error limit, set to 0 if not used.
rejectIfRelative	number	Relative Error limit, set to 0 if not used.
resolution	Value	Use a value from the resolution type table.

NominalTestPoint

Field name	Value	Description
value	number	Calibration point value (relative to span).

CalibrationProcedureSwitch

Field name	Value	Description
scanLowLimit	number	Switch scan low limit.
scanHighLimit	number	Switch scan high limit.
testRepeatCount	number	Number of times to repeat the switch test
resetErrorMultiplier	number	Reset Error Multiplier
errorDirectionSet	Value	Error direction for set value (positive, negative etc.)
errorDirectionReset	Value	Error direction for set value (positive, negative etc.)
errorLimit	number	Either rejectifbase or rejectifreleative is used with switches.
adjustLimit	number	Adjust if error is over this limit, must be given in relative value (e.g. 60% => 0.6)
dontAdjustIfLimit	number	Do not adjust if error is under this limit, must be given in relative value (e.g. 60% => 0.6)
adjustToLimit	number	Adjust to some error below this limit, must be given in relative value (e.g. 60% => 0.6)

Custom fields

There are 30 different custom field columns in the Excel file. They are named according to the following formula: [position/device/function] + [CustomField/CustomCheckbox] + index [1-5].

The CustomField columns can be text or list fields. Any string value is valid if you refer to a text field. If the user want to select a list option, he/she must type it exactly right.

Note! CustomCheckbox columns accept only boolean (true/false) values.

Field name	Value	Description
Text	string	Field for adding custom string value
List	string (list option)	Field for adding custom list value
checkbox	true/false	Field for adding custom boolean value