Message specific documentation



Root element





Name Description Type
SpeciesGroupInstruction The root element of the Product Instruction message SpeciesGroupInstructionType



User defined types

SpeciesGroupInstructionType





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

SpeciesGroupDefinition Definition of species used in this production instruction message SpeciesGroupDefinitionSpeciesGroupInstructionType

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 Species Group Instruction message is: "spi" 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


SpeciesGroupDefinitionType



Name Description Unit Type OldVarNo
Elements
SpeciesGroupModificationDate Date when species group definition was last modified yyyy-mm-ddThh:mm:ss[+|-]hh:mm ModificationDateType

SpeciesGroupUserID Identity per species group defined by user of data, normally by logging organisation. free text UserIDType v120_t3

SpeciesGroupName Name per species group free text xsd:string V120_t1

SpeciesGroupInfo Free text information about species group free text xsd:string

SpeciesGroupVersion Additional identity information description of species groupt free text xsd:string V120_t3

DBHHeight Height above stump of DBH, when DBH is a measured value (normally 120 cm above stump in Sweden, 110cm in Norway), per species group. cm DBHHeightType v500_t1

StemTypeDefinition Structure for stem type definition (normally used with PMP-codes in Finland). StemTypeDefinitionType

LoggingOrganisation Contact information for organisation responsible for logging an object (normaly forest company or forest owners association), owner of the right to harvest a certain object. Old types Organisation, Region, District, Working team, Wood pile LoggingOrganisationType v31

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


UserIDType

Base type: xsd:string





Name Description Unit Type OldVarNo
Attributes
agency Enumeration list defining the agency who is responsible of the user ID. Allowed values are: "Buyer","ForestOwner","LoggingContractor","LoggingOrganisation","MachineOwner","Other","Seller" list AgencyType


DBHHeightType

Base type: xsd:positiveInteger





Name Description Unit Type OldVarNo
Attributes
modificationRestricted if attributes value is "true" then modification of the defintion is restricted, if "false" then modification is allowed true/false xsd:boolean


StemTypeDefinitionType



Name Description Unit Type OldVarNo
Elements
StemTypeCode Code for stem type free text (usually finish PMP-codes) xsd:string V124_t2

StemTypeName Name/Description of stem type free text xsd:string V124_t1


LoggingOrganisationType



Name Description Unit Type OldVarNo
Elements
ContactInformation Name and other contact information of logging organisation ContactInformationType

District Name of district free text xsd:string

Team Name of team free text xsd:string


ContactInformationType



Name Description Unit Type OldVarNo
Elements
FirstName First name of contact free text xsd:string

LastName Last name of contact free text xsd:string

Address Address of contact AddressType

Phone Phone number of contact free text xsd:string

Fax Fax number of contact free text xsd:string

Email email address of contact free text xsd:string

BusinessName Name of organisation/Company free text xsd:string

BusinessID The Business ID (Business Identity Code) is a code given to businesses and organisations by the authorities free text xsd:string


AddressType



Name Description Unit Type OldVarNo
Elements
Street Street address free text xsd:string

City Name of city free text xsd:string

Province Province/State free text xsd:string

Country Name of country free text 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


SpeciesGroupDefinitionSpeciesGroupInstructionType

Base type: SpeciesGroupDefinitionType



Name Description Unit Type OldVarNo
Elements
SpeciesDefinition Structure for species included in a species group. SpeciesDefinitionType

Grades Structure with alla grade data per species group GradesType

BarkFunction Structure for species included in a species group. BarkFunctionSpeciesGroupInstructionType

SoundKnotFunction Sound knot function used when calculating the diameter (ob) of the sound knot limit/cylinder. Soundknot function must be used if this structure is included. Observe that all diameters are over bark. The function is y = (a+b*x+c*x2)*d where the diameter of the sound knots cylinder = DBH*y. SoundKnotFunctionType

ButtEndProfileExtrapolation Structure for butt end profile extrapolation method. Extrapolation method must be used if this structure is included in spi. ButtEndProfileExtrapolationSpeciesGroupInstructionType

EstonianVolumeParameters Structure for parameters used in Estonian function for volume calculation. This function is also called Nilson's formula. See appendix EstonianVolumeParametersType

SpeciesGroupPresentationOrder Indicates the order of SpeciesGroups. May be used in presentation tools in order to show the SpeciesGroups in a certain order, for example if pine is always to be presented before spruce and birch in a printed report. The element should be considered as an optional hint given by forest company. sequential no xsd:positiveInteger


SpeciesDefinitionType



Name Description Unit Type OldVarNo
Elements
SpeciesName Name of species included in species group free text xsd:string

SpeciesUserID User id of species included in species group free text xsd:string


GradesType





Name Description Unit Type OldVarNo
Elements
StartGrade Default grade per species group when starting to process the stem in the harvester. xsd:positiveInteger v144_t1

MTHStartGrade Default grade for multi handled trees xsd:positiveInteger

Grade Structure for available grades per species group GradeType

Attributes
modificationRestricted if attributes value is "true" then modification of the defintion is restricted, if "false" then modification is allowed true/false xsd:boolean


GradeType



Name Description Unit Type OldVarNo
Elements
GradeNumber Grade number xsd:positiveInteger

GradeName Descriptive name for grade free text xsd:string v143_t1


BarkFunctionType





Name Description Unit Type OldVarNo
Elements
SwedishZacco Structure for Swedish Zacco bark function. SwedishZaccoType

German Structure for Swedish Zacco bark function. GermanType

Skogforsk2004ScotsPine Parameters for German bark function Skogforsk2004ScotsPineType

Attributes
barkFunctionCategory Allowed values:"None","Swedish Zacco","German",Skogforsk 2004, Scots pine" and "Skogforsk 2004, Norway spruce". If this attribute is "None" the BarkFunction element is empty. list BarkFunctionCategoryType V113_t7


SwedishZaccoType



Name Description Unit Type OldVarNo
Elements
ConstantA Constant a in the following linear function: Double bark thickness = a + b * diameter ob Bark thicknes and diameter in mm. positive decimal NonNegativeDecimal V113_t1

FactorB Factor b in the following linear function: Double bark thickness = a + b * diameter ob Bark thicknes and diameter in mm. positive decimal NonNegativeDecimal V113_t1


GermanType



Name Description Unit Type OldVarNo
Elements
BarkDeduction Deduction for double bark thickness per species group: Bark function based on diameterclasses with fixed bark deductions (double), based on German requirements. mm BarkDeductionType V113_t3


BarkDeductionType

Base type: NonNegativeDecimal





Name Description Unit Type OldVarNo
Attributes
lowerDiameterLimit Lower diameter limits per species group: Bark function based on diameterclasses with fixed bark deductions (double), based on German requirements mm xsd:nonNegativeInteger V113_t2


Skogforsk2004ScotsPineType



Name Description Unit Type OldVarNo
Elements
Latitude Latitude used in bark function Should be set in machine since it is specific for certain geographical area.. latitude PositiveDecimal V113_t4


BarkFunctionSpeciesGroupInstructionType

Base type: BarkFunctionType





Name Description Unit Type OldVarNo
Attributes
modificationRestricted if attributes value is "true" then modification of the defintion is restricted, if "false" then modification is allowed true/false xsd:boolean


SoundKnotFunctionType





Name Description Unit Type OldVarNo
Elements
ConstantA Constant "A" for determining the limit for sound knots per tree species (abbreviation "b" iny = (a+b*x+c*X2)*d,) where diameter of the sound knot cylinder = DBH*y xsd:decimal V147_t1

FactorB Factor for determining the limit for sound knots/tree species (abbreviation "b" in y = (a+b*x+c*X2)*d), where diameter of the sound knot cylinder = DBH*y xsd:decimal V148_t1

FactorC Factor for determining the limit for sound knots/tree species (abbreviation "c" in y = (a+b*x+c*X2)*d), where diameter of the sound knot cylinder = DBH*y xsd:decimal V148_t2

ToleranceD Tolerance for dead knots within calculated limit for sound knot diameter / tree species (abbreviation "d" in y = (a+b*x+c*X2)*d), where diameter of the sound knot cylinder = DBH*y xsd:decimal V148_t3

SoundKnotFunctionGrade Type of grade which extension is determined by a used sound knot function xsd:positiveInteger V141_t2

GradeIncluded Grades that can be replaced by the automatically calculated SoundKnotFunction grade. Means that if a section of stem does not have a grade included in this element the SoundKnotFunction will NOT affect the bucking optimization. All grades with a number below or equal to StartGrade and SoundKnotFunctionGrade should always be replaced if element GradeIncluded is missing xsd:positiveInteger

Attributes
modificationRestricted if attributes value is "true" then modification of the defintion is restricted, if "false" then modification is allowed true/false xsd:boolean


ButtEndProfileExtrapolationType





Name Description Unit Type OldVarNo
Elements
ReferenceHeight Height from stump to the diameter used for predicting the butt end diameters. Normally breast height (130 cm in Finland, 120 cm in Sweden) is used for extrapolation of butt end diameter values. cm xsd:nonNegativeInteger V170_t2

ButtEndProfileExtrapolationTable Structure for butt end profile extrapolation table. ButtEndProfileExtrapolationTableType

ButtEndProfileExtrapolationFunction Structure for butt end profile extrapolation function. ButtEndProfileExtrapolationFunctionType

Attributes
buttEndProfileExtrapolationMethod Enumeration list defining the butt end profile extrapolation method. Allowed values are: "ExtrapolationFunction","ExtrapolationTable" and "Both" list ButtEndProfileExtrapolationMethodType


ButtEndProfileExtrapolationTableType



Name Description Unit Type OldVarNo
Elements
ExtrapolationCoefficient Extrapolation coefficient tables: coefficient values (multiplying values) / distance class / diameter class / tree species: 1…var170_t4 / 1 … var170_t3 / 1…var111_t1. Example: Measured diameter at reference height (normally dbh) of stem = 23,3 cm. Distance to extrapolation point = 90 cm. Coefficient value in table at (23, 90) = 1.042. Estimated diameter value at 90 cm = 23,3 cm * 1.042 = 24,3 cm (243 mm). ExtrapolationCoefficientType V170_t7


ExtrapolationCoefficientType

Base type: xsd:decimal





Name Description Unit Type OldVarNo
Attributes
diameterClass Diameter class values for the reference height in extrapolation coefficient table / species group. cm xsd:nonNegativeInteger V170_t5

distanceClass Distance class values (distance from the felling cut) in extrapolation coefficient table per species group. First value is 0 cm and the last is the value of the actual reference height in element ReferenceHeight (e.g. 130 cm). Intervals normally 10 cm. cm xsd:nonNegativeInteger V170_t6


ButtEndProfileExtrapolationFunctionType





Name Description Unit Type OldVarNo
Elements
Parameter Structure for butt end extrapolation function parameters. ButtEndProfileExtrapolationFunctionParameterType

Attributes
ButtEndProfileExtrapolationFunctionCategory extrapolation of butt end diameter values. Volume calculation of butt end is done according the extrapolated diameters. Allowed values: Poikela 2007 => Function DL = [1 + (a0*(1.3-L) + a1*(1.3-L)a2)/100] * D1.3 a0 = a00 + a01*DBH+a02*DBH^2 + a03*DBH^3 + a04 *DBH^4 a1 = a10 + a11*DBH+a12*DBH^2 + a13*DBH^3 a2 = a20 + a21*DBH+a22*DBH^2 list ButtEndProfileExtrapolationFunctionCategoryType


ButtEndProfileExtrapolationFunctionParameterType



Name Description Unit Type OldVarNo
Elements
ParameterName Name of the parameter of the diameter extrapolation function (e.g. a00, a01 …) free text xsd:string V170_t10

ParameterValue parameter value in butt diameter extrapolation function, negative values are possible xsd:decimal V170_t11_t12


ButtEndProfileExtrapolationSpeciesGroupInstructionType

Base type: ButtEndProfileExtrapolationType





Name Description Unit Type OldVarNo
Attributes
modificationRestricted if attributes value is "true" then modification of the defintion is restricted, if "false" then modification is allowed true/false xsd:boolean


EstonianVolumeParametersType



Name Description Unit Type OldVarNo
Elements
ParameterA1 Value for Estonian volume parameter "A1" xsd:decimal

ParameterA2 Value for Estonian volume parameter "A2" xsd:decimal

ParameterA3 Value for Estonian volume parameter "A3" xsd:decimal


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
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
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