Name | Description | Type |
---|---|---|
StanForD2010Envelope | The root element of the StanForD2010 envelope message | StanForD2010EnvelopeType |
Name | Description | Unit | Type | OldVarNo | |
---|---|---|---|---|---|
Elements | |||||
StanForD2010EnvelopeHeader | General information for message | StanForD2010EnvelopeHeaderType | |
||
StanForD2010Message | Structure to include StanForD2010 messages | StanForD2010MessageType | |
||
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 | |||||
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 | |
Name | Description | Unit | Type | OldVarNo | |
---|---|---|---|---|---|
Elements | |||||
TransmissionInfo | TransmissionInfo contain more technical information of the delivery of the message. The structure could have multiple instances so that it is possiible to follow message delivering route | TransmissionInfoType | |
||
BusinessSender | Identification information of the business company that is originally sending the envelope message. | ContactInformationType | |
||
BusinessReceiver | Identification information of the business company that is finally receiving the envelope message. | ContactInformationType | |
Name | Description | Unit | Type | OldVarNo | |
---|---|---|---|---|---|
Elements | |||||
TransmissionID | Unique identifier that can be used in registering and following envelope transmissions. | free text | UserIDType | |
|
TransmissionTime | Transmission time registered in sender | yyyy-mm-ddThh:mm:ss[+|-]hh:mm | StanForD2010DateTimeType | |
|
TransmissionSender | TransmissionSender could be business sender but the value of this element could be also: transmission appliication or machine that is sending the message, the representative company of the business sender,... | free text | xsd:string | |
|
TransmissionReceiver | TransmissionReceiver could be business receiver but the value of this element could be also: transmssion appliication or machine that is receiving the message, the representative company of the business sender,... | free text | 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 | |
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 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 | |
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 | |
Name | Description | Unit | Type | OldVarNo | |
---|---|---|---|---|---|
Elements | |||||
MessageDocument | StanForD message included with envelope. | MessageType | |
||
MessageAttachment | File (not StanForD) included with envelope. | AttachmentType | |
||
Attributes | |||||
messageCategory | Attribute tells us the category of the StanForD 2010 message. Enumeration list of file extensions of StanForD 2010 messages: Allowed values are: "fdi", "foi", "fpr", "fqc", "hpr", "hqc", "ogi", "ogr", "oin", "mom", "pin", "spi" and "thp". | list | MessageCategoryType | |
Name | Description | Unit | Type | OldVarNo | |
---|---|---|---|---|---|
Elements | |||||
EmbeddedDocument | A StanForD 2010 message can be included inside the envelope as an embedded document inside this element. However if the message is compressed the message is in a binary format. The XML documents can not include binary content so a compressed message must be encoded to text. Most used encoding method is Base64. If message is not compressed it could be embedded inside this element as it is. Because this is impelemnted using any element the only requirement is that content is well-formed XML. If we remove the headerline from the message the rest of it is well-formed. Other way to handle this problem is to transform all tag-characters into < and > codes and embed then the hole message inside one element | EmbeddedType | |
||
ExternalDocument | The other way to include the StanForD 2010 message into envelope message is to store only the information where the externally stored actual message is. | ExternalDocumentType | |
||
DocumentName | The name of StanForD2010 message. Usually the file name of the message | free text | xsd:string | |
|
SchemaName | It is possible to store the schema file name of the StanFord message in this element. Schema file name is also stored inside StanForD 2010 message | free text | xsd:string | |
|
Compression | It is possible to store the compression method and software in this structure when the StanForD2010 message is compressed | CompressionType | |
||
Signature | Signatures provides us a mechanism to encrypt our message and also be sure that the message is the original one. There is a XML standard (XML Signature) that defines way to implement the signature | SignatureType | |
Name | Description | Unit | Type | OldVarNo | |
---|---|---|---|---|---|
Attributes | |||||
encodingMethod | The encoding method used to transform compressed binary document to text format. Allowed values: "Base64" and "None" | list | |
Name | Description | Unit | Type | OldVarNo | |
---|---|---|---|---|---|
Elements | |||||
DocumentLocation | This is place to store information where the externally stored StanForD 2010 message or attachment file is. It might be for example web-address or file path. | free text | xsd:string | |
Name | Description | Unit | Type | OldVarNo | |
---|---|---|---|---|---|
Elements | |||||
CompressionCategory | List of compression methods. Allowed values are: "ZIP/DEFLATE" and "Not defined". ZIP/DEFLATE is the recommended compression method in StanForD 2010. | list | CompressionCategoryType | |
|
CompressionSoftware | Optional information of the compression software in use. For example WinZip, 7-Zip,… | free text | xsd:string | |
Name | Description | Unit | Type | OldVarNo | |
---|---|---|---|---|---|
Attributes | |||||
signatureCategory | Used signature method. The allowed values are: XML Signature, Other | list | SignatureCategoryType | |
Name | Description | Unit | Type | OldVarNo | |
---|---|---|---|---|---|
Elements | |||||
EmbeddedAttachment | Attachments can be stored embedded in the same way as StanForD messages | EmbeddedType | |
||
ExternalAttachment | Attachments can be stored externally in the same way as StanForD messages | ExternalDocumentType | |
||
AttachmentName | The name of the attachment file. | free text | xsd:string | |
|
SchemaName | If the attachment is a XML document then it is possible to store the corresponding schema file name here | free text | xsd:string | |
|
Compression | It is possible to store the compression method and software in this structure when the attachment is compressed | CompressionType | |
||
Signature | It is possible to encrypt the attachments same way as actual messages using signatures | SignatureType | |
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 | |
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 |
CompressionCategoryType | xsd:string | ZIP/DEFLATE, Not defined |
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 |
SignatureCategoryType | xsd:string | XML Signature, Other |
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 |