Message specific documentation



Root element





Name Description Type
UserDefinedDataInstruction The root element of the User Defined Data Instruction message UserDefinedDataInstructionType


User defined types

UserDefinedDataInstructionType





Name Description Unit Type OldVarNo
Elements
UserDefinedDataInstructionHeader General information for message MessageHeaderType

UserDefinedDataDefinition Definition for user defined data UserDefinedDataDefinitionType

Extension Extension element can include whatever data the users want. The only requirement is that it is well-formed XML i.e. it is tagged ExtensionType

Attributes
areaUnit Unit of area information in StanForD 2010 messages.Only allowed value: ha list AreaUnitType

diameterUnit Unit of diameter information in StanForD 2010 messages.Only allowed value: mm list DiameterUnitType

lengthUnit Unit of length information in StanForD 2010 messages.Only allowed value: cm list LengthUnitType

volumeUnit Unit of volume information in StanForD 2010 messages. Only allowed value: m3 list VolumeUnitType

weightUnit Enumeration list of file extensions of StanForD 2010 messages.Only allowed value: kg list WeightUnitType

version The version number of the message in format: "major"."minor", where "major" is a sequential number of the major version (start from 1) and "minor" is a sequential number of the minor version.> version number StanForD2010VersionType

versionDate Date of version yyyy-mm-dd xsd:date

messageType Enumeration list of file extensions of StanForD 2010 messages: Allowed value in user defined data message is: "udi" list MessageCategoryType


MessageHeaderType



Name Description Unit Type OldVarNo
Elements
SenderApplication Name and version of application sending the message free text xsd:string

CreationDate Date when message was created and saved yyyy-mm-ddThh:mm:ss[+|-]hh:mm StanForD2010DateTimeType V12

ModificationDate Date when message was last modified and saved yyyy-mm-ddThh:mm:ss[+|-]hh:mm ModificationDateType V12

ApplicationVersionCreated Name and version of software application that created and saved a message free text xsd:string V5_t1

ApplicationVersionModified Name and version of software application that modified and saved message free text xsd:string V5_t1

CountryCode Country code for computer generating message Country code: numerical code as per Swedish Std. SS-ISO 3166. Eg. Australia=036, Finland=246, France=250, Germany=276, Sweden=752 code xsd:string V6_t1

CreationCoordinates Coordinates of machine when creating file, ie position at the time register in CreationDate. CoordinatesType


ModificationDateType

Base type: StanForD2010DateTimeType





Name Description Unit Type OldVarNo
Attributes
modificationAuthor Author of modification free text xsd:string


CoordinatesType





Name Description Unit Type OldVarNo
Elements
Latitude Latitude, absolute value.Registered according to coordinateReferenceSystem and receiverPosition.. degrees LatitudeType V522_t1

Longitude Longitude, absolute value. Registered according to coordinateReferenceSystem and receiverPosition.. degrees LongitudeType V522_t3

Altitude Altitude, height above sea level, registered according to CoordinateReference and CoordinateType. m xsd:decimal V522_t5

CoordinateDate Date and time when recording coordinate data yyyy-mm-ddThh:mm:ss[+|-]hh:mm StanForD2010DateTimeType V522_t6

Attributes
receiverPosition Position of coordinate registration in file: "Base machine position", "Crane tip position when felling the tree" list ReceiverPositionType V520_t1

coordinateReferenceSystem Coordinate system used in StanForD file: WGS84 list CoordinateReferenceSystemType V521_t2


LatitudeType

Base type: LatitudeLongitudeValueType





Name Description Unit Type OldVarNo
Attributes
latitudeCategory Allowed values: "North", "South". Registered according to coordinateReferenceSystem and receiverPosition. list LatitudeCategoryType V522_t2


LongitudeType

Base type: LatitudeLongitudeValueType





Name Description Unit Type OldVarNo
Attributes
longitudeCategory Allowed values: "East", "West". Registered according to coordinateReferenceSystem and receiverPosition. list LongitudeCategoryType V522_t4


UserDefinedDataDefinitionType



Name Description Unit Type OldVarNo
Elements
DataTableGroupDefinition Definition of user defined data tables registered in the some output file. DataTableGroupDefinitionType


DataTableGroupDefinitionType





Name Description Unit Type OldVarNo
Elements
DataTableDefinition Definition user defined data table DataTableDefinitionType

DataEnumDefinition List of user defined enumerations DataEnumDefinitionType

Attributes
tableGroupID Identity of table group xsd:string

tableGroupName Name of user defined data table, to be used in the UI xsd:string

outputDataLocation Points to where the user defined data should be registered and then reported. Allowed values are: "ProductionObject" (in hpr, thp and fpr), "MonitoringObject" ( in mom), "MonitoringShift" (in mom) and "ProductionLocation" (in fpr>) OutputDataLocationType


DataTableDefinitionType





Name Description Unit Type OldVarNo
Elements
DataColumnDefinition Definition of columns in user defined data table DataColumnDefinitionType

DataRowDefinition Definition of fixed rows in user defined data table DataRowDefinitionType

Attributes
tableID Identity of user defined table xsd:string

tableName Name of user defined data table

minRowCount Minimum number of rows in user defined data table. xsd:nonNegativeInteger

maxRowCount Maximum number of rows in user defined data table. xsd:positiveInteger


DataColumnDefinitionType





Name Description Unit Type OldVarNo
Attributes
columnID Identity of column xsd:string

columnName Name of column xsd:string

dataCategory Defines data type of column. Allowed values are: =”enum”, “string”, “integer”, “decimal”, “date”, “boolean” or “sequentialInteger” DataCategoryType

optional Indicates if column must be filled in by operator. xsd:boolean

columnOrder Presentation order of column

enumListID Identity of enumeration list. xsd:string

unit Defines unit of column, eg mm, kg, m3, cm etc. Can be used in GUI to inform operator about unit. xsd:string


DataRowDefinitionType





Name Description Unit Type OldVarNo
Elements
DataCellDefintion Existing cell attributes overrides column attributes. DataCellDefintionType

Attributes
rowID Identity of row xsd:string

rowOrder Presentation order of row in GUI xsd:nonNegativeInteger


DataCellDefintionType

Base type: xsd:string





Name Description Unit Type OldVarNo
Attributes
cellID Identity of cell xsd:string

cellText Text in cell. E.g. a question to be answered by operator. xsd:string

dataCategory Defines data type of cell, overrides DataColumnDefinition. Allowed values are: enum, integer, string, decimal, date, boolean, sequential no per row. DataCategoryType

optional Indicates if cell must be filled in by operator. xsd:boolean

columnOrder Column order for current cell in GUI. xsd:nonNegativeInteger

enumListID Identity of enumeration list. xsd:string

unit Defines unit of column, eg mm, kg, m3, cm etc. Can be used in GUI to inform operator about unit. xsd:string

readOnly Indicates if cell can be edited by operator. xsd:boolean


DataEnumDefinitionType





Name Description Unit Type OldVarNo
Elements
EnumValue Enum value xsd:string

Attributes
enumListID Identity of enumeration list. xsd:string


ExtensionType





Name Description Unit Type OldVarNo
Attributes
extensionAction Enumeration list. Allowed values are: "Copy" and "Ignore". The purpose of this attribute is to inform the receiver of the message that sender want to get back the copy of the content of the extension structure. For example if we have product specifiic information in extension structure send in pin-message we might want that back in hpr-message. list ExtensionActionType


User defined simple types

Type name Base type Enumeration values
AgencyType xsd:string Buyer, ForestOwner, LoggingContractor, LoggingOrganisation, MachineOwner, Other, Seller
AreaUnitType xsd:string ha
BarkFunctionCategoryType xsd:string None, Swedish Zacco, German, Skogforsk 2004, Scots pine, Skogforsk 2004, Norway spruce
BioEnergyAdaptionType xsd:string None, Logging residues, Stumps, Logging residues and stumps
BuckingCriteriaType xsd:string No limit, Forbidden to buck the log even manually, The log is excluded from apportionment bucking,only bucking according to value allowed, Only logs bucked manually allowed
ButtEndProfileExtrapolationFunctionCategoryType xsd:string Poikela 2007
ButtEndProfileExtrapolationMethodType xsd:string ExtrapolationFunction, ExtrapolationTable, Both
CoordinateReferenceSystemType xsd:string WGS84
CountryCodeCategoryType xsd:string ISO 3166
CuttingReasonSpecificationType xsd:string Outside cutting window, Quality change, Unclassified log
CuttingReasonType xsd:string Automatic, Decay, Damage, Crook, Sweep, Grade break, Pulpwood grade, Top break, Spinning, Other manual
DataCategoryType xsd:string enum, string, integer, decimal, date, boolean, sequentialInteger
DeliveryEstimationMethodType xsd:string Manual estimation by operator, Scale, Estimation through Harvested Production message, Other
DeliveryEstimationUnitType xsd:string Volume, m3sob, Volume, m3sub, Green mass, kg, Number of logs, Number of loads, Loose volume, m3, Solid volume including bark, branches and needles, m3, Solid volume of bundles (length*cross sectional area), m3, Number of bundles
DensityCategoryType xsd:string Under bark, On bark, Not specified
DiameterCategoryType xsd:string Over bark
DiameterClassAdjustmentType xsd:string DiameterClassAdjustment1, DiameterClassAdjustment2
DiameterClassCategoryType xsd:string Top, Midpoint, Calculated Norwegian mid, Calculated Estonian mid
DiameterMeasurementCategory xsd:string Average, First, Second
DiameterSectionUsageType xsd:string Buyer, Commercial
DiameterUnitType xsd:string mm
DistributionCategoryType xsd:string Number of logs, Volume of logs
ExtensionActionType xsd:string Copy, Ignore
ForestCertificationType xsd:string FSC, PEFC, Other, None, Not known
FormatFillStyleType xsd:string SolidFill, TransparentFill, HorizontalFill, VerticalFill, UpwardDiagonalFill, DownwardDiagonalFill, CrossFill, DiagonalCrossFill, LightGrayFill, GrayFill, DarkGrayFill, HalfTransparentFill
FormatLineStyleType xsd:string Solid, Dash, Dot, Dash-Dot, Double solid, HashLine
GISCoordinateReferenceSystemType xsd:string WGS84
LatitudeCategoryType xsd:string North, South
LatitudeLongitudeValueType xsd:decimal
LengthClassAdjustmentType xsd:string LengthClassAdjustment1, LengthClassAdjustment2
LengthUnitType xsd:string cm
LimitationCategoryType xsd:string No limitation, Total number, quantity per product, Total volume, m3 per product, Number per diameter class per product, Volume per diameter class per product, Number per length class per product, Volume per length class per product, Number per cell (log size class) per product and tree species, Volume per cell (log size class) per product and tree species
LimitationResultType xsd:string No action, Production is stopped, forbidden to buck logs, only manually bucked logs allowed, Production is stopped, forbidden to buck logs including manual bucking of logs
LoadNumberCategoryType xsd:string Estimated number of logs, Number of bundles
LogBunchVolumeCategoryType xsd:string NetVolOb, NetVolUb, GrossVolOb
LogDiameterCategoryType xsd:string Top ob, Top ub, Mid ob, Mid ub, Butt ob, Butt ub, Mid HKS ob, Mid HKS ub
LogMeasurementCategoryType xsd:string Machine, Operator, Auditor
LogVolumeCategoryType xsd:string m3 (price), m3sob, m3sub, m3sobEstimated, m3subEstimated
LongitudeCategoryType xsd:string East, West
MachineCategoryType xsd:string Harvester, Forwarder, Harwarder, Bundler, Scarifier, Other
MessageCategoryType xsd:string env, fdi, foi, fpr, fqc, hpr, hqc, ogi, ogr, oin, mom, pin, spi, udi, thp
NonNegativeDecimal xsd:decimal
OutputDataLocationType xsd:string ProductionObject, MonitoringObject, MonitoringShift, ProductionLocation
PositiveDecimal xsd:decimal
ProcessingCategoryType xsd:string SingleTreeProcessing, MultiTreeProcessing, SingleTreeFelling, MultiTreeFelling
ProductConditionType xsd:string Buck always, Buck butt-log only, Do not buck butt log
ReceiverPositionType xsd:string Base machine position, Crane tip position when felling the tree
ScaleCategoryType xsd:string Crane tip scale, Load bearer scale
StanForD2010DateTimeType xsd:dateTime
StanForD2010VersionType xsd:string
StemVolumeCategoryType xsd:string m3sob, m3sub, m3sobEstimated, m3subEstimated
TrackingCategoryType xsd:string Points tracking, Lines tracking, Polygons tracking, Tracking not required
VolumeDiameterAdjustmentType xsd:string Measured diameter in mm, Measured diameter rounded downwards to cm
VolumeDiameterCategoryType xsd:string All diameters (solid volume), Top, Mid, Calculated Norwegian mid, Calculated Estonian mid
VolumeLengthCategoryType xsd:string Physical length cm, Length as defined in LengthClasses, Rounded downwards to nearest dm-module, Rounded to nearest mid-dm
VolumeUnitType xsd:string m3
WeightUnitType xsd:string kg