Message specific documentation



Root element





Name Description Type
ProductInstruction The root element of the Producti Instruction message ProductInstructionType



User defined types

ProductInstructionType





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

ProductDefinition Structure for defining product. ProductDefinitionProductInstructionType

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 Production Instruction message is: "pin" 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


ProductDefinitionProductInstructionType



Name Description Unit Type OldVarNo
Elements
ProductUserID Identity per product defined by user of data, normally logging organisation free text UserIDType V121_t2

ClassifiedProductDefinition Structure for classified product. Definied in pin message. ClassifiedProductDefinitionProductInstructionType


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


CommonProductDefinitionProductInstructionType



Name Description Unit Type OldVarNo
Elements
ProductName Name of the product free text xsd:string V121_t1

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

ModificationDate Date and time when product definition was last modified. ProductKey updated if modified in machine. yyyy-mm-ddThh:mm:ss[+|-]hh:mm ModificationDateType V16_t4

ProductInfo Free text information about product free text xsd:string V121_t2

ProductVersion Additional identity information description of product free text xsd:string V121_t3

ProductBuyer Contact information of buyer ContactInformationType V32_t2

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

ProductDestination Destination address of product ContactInformationType

ProductGroupName Descriptive text for a group of products. free text xsd:string V127

StemTypeCode Code for stem type free text (usually finish PMP-codes) xsd:string V124_t2

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


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


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


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


ClassifiedProductDefinitionProductInstructionType

Base type: CommonProductDefinitionProductInstructionType



Name Description Unit Type OldVarNo
Elements
ProductCreationDate Date and time when product definition was created in an administrative tool. Never set in a forest machine yyyy-mm-ddThh:mm:ss[+|-]hh:mm StanForD2010DateTimeType V13

ManualFreeBuck Any length accepted (manual cut) except forbidden lengths according to element BuckingCriteria true/false xsd:boolean V119_t1

TopLogFreeBuck Reach minimum top diameter using any length (maximize volume). Minimum top diameter for TopLogFreeBuck is the smallest allowed diameter without limitation Forbidden or Manual as registered in element BuckingCriteria. Any length accepted up to MAXLength except forbidden lengths according to element BuckingCriteria. Highest priority is given to minimum diameter search within min and max lengths of the product, independently of value and distribution matrixes. true/false xsd:boolean V119_t1

ProductCondition Allowed list values for bucking criterion per product: "Buck always;","Buck butt-log only" and "Do not buck butt log" list ProductConditionType V136_t1

DiameterDefinition Structure for defining diameter classes. DiameterDefinitionType

LengthDefinition Structure for defining length classes. LengthDefinitionType

CuttingWindowDefinition Definition of cutting window CuttingWindowDefinitionType

PermittedGradesDefinition Structure for permitted grades per product. PermittedGradesDefinitionType

PriceDefinition Structure for defining volume used when calculating log value. PriceDefinitionType

LengthDistributionDefinition Structure for length distribution settings (distribution bucking). LengthDistributionDefinitionType

LimitationDefinition Structure for limitation settings. LimitationDefinitionType

ProductMatrixes Structure for product matrix including prices etc ProductMatrixType

LongLogButtHeight Height above stump of measuring point for butt diameter per product cm xsd:nonNegativeInteger v167_t1

ProductPresentationOrder Indicates the order of products per SpeciesGroup. May be used in presentation tools in order to show the products in a certain order, for example if sawlog product are always to be presented before pulp wood and fuel wood in a printed report. The element should be considered as an optional hint given by forest company. sequential no xsd:positiveInteger


DiameterDefinitionType





Name Description Unit Type OldVarNo
Elements
DiameterClasses Structure for Diameter classes DiameterClassesType

DiameterMINTop Used toghether with volumes and classes dependent on mid diameter (see diameterClassCategory). mm xsd:nonNegativeInteger V134_t1

DiameterMAXButt Maximum diameter in the large end of the log per product. mm xsd:positiveInteger V134_t2

DiameterTopPosition Position from top end of log where top diameter is measured. cm xsd:nonNegativeInteger V164_t4

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


DiameterClassesType





Name Description Unit Type OldVarNo
Elements
DiameterClass Structure for Diameter class DiameterClassType

DiameterClassMAX Maximum diameter use in combination with DiamClasses mm xsd:nonNegativeInteger V131_t1

DiameterClassAdjustment Allowed list values are: "DiameterClassAdjustment1" = Log belongs to first diameter class smaller or equal to log diameter (227 mm => class 220 mm) "DiameterClassAdjustment2" = Log belongs to closest diameter class, normal rounding, (227 mm => class 230 mm) list DiameterClassAdjustmentType

DiameterUnderBark Flag that informs if diameter classes are defined under bark or not (on bark). true/false xsd:boolean

Attributes
diameterClassCategory Type of diameters in DiamClasses (used for determining cell in price matrix) Allowed list values:"Top", "Midpoint", "Calculated Norwegian mid" and "Calculated Estonian mid" list DiameterClassCategoryType v164_t1


DiameterClassType



Name Description Unit Type OldVarNo
Elements
DiameterClassLowerLimit Lower diameter limit of diameter class mm xsd:positiveInteger v131_t1

DiameterClassName Diameter class name (free descriptive text) per diameter class. Primarily for use in Germany where the classes have standardized names. free text xsd:string v131_t2


LengthDefinitionType





Name Description Unit Type OldVarNo
Elements
LengthClassAdjustment Allowed list values are "LengthClassAdjustment1" = Log belongs to first length class smaller or equal to log length (427 cm => class 400 cm) "LengthClassAdjustment1" = Log belongs to closest length class, normal rounding, (427 cm => class 430 cm) list LengthClassAdjustmentType

LengthClass Structure for length class values LengthClassType

LengthClassMAX Maximum length. Use in combination with LengthClasses cm xsd:nonNegativeInteger v132_t1

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


LengthClassType



Name Description Unit Type OldVarNo
Elements
LengthClassLowerLimit Lower length limit of length class cm xsd:positiveInteger v132_t1

LengthClassMargin Additional length margin, can not be a negative number per length class and product. The additional length margin is ONLY used to avoid too short logs. Implementation rules seperatly documented. cm xsd:nonNegativeInteger v135_t1

LongTimberDefinition Structure for for long timber settings. LongTimberDefinitionType


LongTimberDefinitionType



Name Description Unit Type OldVarNo
Elements
LongLogButtMIN Lower limit for butt diameter per length class and product mm xsd:nonNegativeInteger v165_t1

LongLogButtMAX Upper limit for butt diameter per length class product mm xsd:nonNegativeInteger v166_t1


CuttingWindowDefinitionType





Name Description Unit Type OldVarNo
Elements
LowerLengthLimit Lower length limit for "cutting window" per product. LengthClassLowerLimit (var132), LengthClassMargin (var135_t1) and LowerLengthLimit together define the length class of a log if lower limit of the cutting window is below lower length class limit. cm xsd:integer v135_t3

UpperLengthLimit Upper length limit for "cutting window" product. It does not affect length classification of a log. It can not be above LengthClassLowerLimit (132_t1) nor above LowerLengthLimit for the "cutting window" (135_t3) of the next length class. cm xsd:integer v135_t4

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


PermittedGradesDefinitionType





Name Description Unit Type OldVarNo
Elements
PermittedGradeNumber Permitted quality grades per product. This is a reference to GradeNumber element in GradeType definition in SpeciesGropuInstruction message. Not binary code as in old standard. xsd:positiveInteger v141_t1

GradeToleranceTop Tolerance of grade break at top end per product. cm xsd:nonNegativeInteger v145_t1

GradeToleranceButt Tolerance of grade break at butt end per product. cm xsd:nonNegativeInteger v146_t1

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


PriceDefinitionType





Name Description Unit Type OldVarNo
Elements
VolumeDiameterAdjustment Diameters in log price volume calculation Allowed list values are: "Measured diameter in mm" and "Measured diameter rounded downwards to cm". The las one is identical with HKS (227 mm => 220 mm) list VolumeDiameterAdjustmentType

VolumeDiameterCategory Diameters used in price volume calculation. Allowed list values are: "All diameters (solid volume)", "Top", "Mid", "Calculated Norwegian mid" and "Calculated Estonian mid" list VolumeDiameterCategoryBaseType v161_t1

VolumeLengthCategory Lengths used in price volume calculation. Allowed list values are: "Physical length,cm", "Length as defined in LengthClasses", "Rounded downwards to nearest dm-module" and "Rounded to nearest mid-dm list VolumeLengthCategoryType v163_t1

VolumeUnderBark Boolean flag that informs if price based volume is defined under bark true/false xsd:boolean

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


VolumeDiameterCategoryBaseType

Base type: VolumeDiameterCategoryType





Name Description Unit Type OldVarNo
Attributes
volumeDiameterTopPosition Position from top end of log where top diameter for volume calculation is measured. cm xsd:nonNegativeInteger


LengthDistributionDefinitionType





Name Description Unit Type OldVarNo
Elements
DistributionAllowed Distribution bucking allowed for product true/false xsd:boolean v136_t2

DistributionCategory Definies type of distribution matrix in "Distribution". Allowed values: "Number of logs" and "Volume of logs". Two separate matrixes in old standard, v191_t4 or v191 list DistributionCategoryType v191

MAXDeviation Maximum allowed deviation (%) in distribution bucking per product % NonNegativeDecimal v192_t2

DistributionWithinProduct Defining if distribution bucking is only allowed within optimal product. If true only within optimal product, if false also allowed to buck non-optimal products. Simplification of old v197_t1 true/false xsd:boolean v197_t1

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


LimitationDefinitionType





Name Description Unit Type OldVarNo
Elements
LimitationCategory Type of limitation matrix per product Codes for limitation of production. The allowed list values are: "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" and "Volume per cell (log size class) per product and tree species". list LimitationCategoryType v190_t1

LimitationResult Action if production target is fulfilled (overproduction according to Limitation in ProductMatrix and LimitationCategory). Allowed values:"No action", "Production is stopped, forbidden to buck logs, only manually bucked logs allowed" and "Production is stopped, forbidden to buck logs including manual bucking of logs" list LimitationResultType v196_t2

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


ProductMatrixType





Name Description Unit Type OldVarNo
Elements
ProductMatrixItem Price, length distribution, color and limitation for each lenght and diameter class. ProductMatrixItemType

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


ProductMatrixItemType





Name Description Unit Type OldVarNo
Elements
Price Price per diameter and length class. currency xsd:integer v162_t2

Distribution Relative number or relative volume of logs per diameter and length class/product. Volume or number of logs is defined by "DistributionCategory". Negative values not allowed. Desired length distribution based on number of cut logs for each diameter class. Percent value is calculated with each diameter class as the denominator. % xsd:nonNegativeInteger v191

Limitation Limit according to "LimitationCategory", per length and diameter classes. no xsd:nonNegativeInteger v190_t2

BuckingCriteria Allowed values: "No limit", "Forbidden to buck the log even manually", "The log is excluded from apportionment bucking,only bucking according to value allowed" and "Only logs bucked manually allowed" list BuckingCriteriaType v190_t2

LogColorMarking Structure for log marking per diameter and length class no LogColorMarkingType v152_t1

Attributes
diameterClassLowerLimit Lower diameter limit of diameter class mm xsd:positiveInteger

lengthClassLowerLimit Lower length limit of length class cm xsd:positiveInteger


LogColorMarkingType



Name Description Unit Type OldVarNo
Elements
Color1 First color for marking logs true/false xsd:boolean

Color2 Second color for marking logs true/false xsd:boolean

Color3 Third color for marking logs true/false xsd:boolean


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