Måledokument (Volumberegnet Måledokument)

Transkript

1 Transaksjonsstandard for virkesomsetningen i Norge (Volumberegnet ) Versjon 2.0 Desember 2007 SKOG-DATA AS

2 Innhold 1 INNLEDNING 3 2 DOKUMENTASJON AV MÅLEDOKUMENT Oversikt Meldingstyper forretningsregler Regler for meldingstypen Samhandling Måling av et tømmerlass Måleresultater ved videresalg av tømmer Behandle meldingen Statusverdier som benyttes Hvordan lese diagrammene 6 3 MÅLEDOKUMENT Rot-element MdokHode MdokSpesifikasjoner MdokStokkLinjer 10 4 EKSEMPLER PÅ FORRETNINGSMESSIG BRUK AV MELDINGEN Scenario A Scenario B Scenario C Scenario D 15 Side 2

3 1 Innledning Transaksjonsstandard for virkesomsetningen i Norge er utviklet for å sikre en effektiv og sikker utveksling av elektroniske meldinger mellom forretningspartnere innen virkesomsetningen i Norge. Standarden inneholder beskrivelse av dokumenter som ikke er dekket i andre standarder. 2 Dokumentasjon av Beskrivelsen i dette dokumentet er ikke komplett med tanke på tekniske spesifikasjoner. Det henvises til dokumentet XML Schema for detaljert teknisk dokumentasjon. Ferdig schema kan lastes ned (.xsd). 2.1 Oversikt er en melding fra den organisasjonen som har utført tømmermåling og er en spesifikasjon av resultatene av utført måling. et inneholder beregnet volum som er fordelt på sortimenter (vareslag) og kvaliteter. et kan anvendes til mange formål og er derfor interessant for en hel rekke aktører innen framdrift, inntransport, måling og virkeshandel. inkluderer: Hvem som er oppdragsgiver og hvilke andre aktører som er berørt Varetyper, kvaliteter og mengder Meldingstyper Det finnes kun en meldingstype for måledokument forretningsregler Den etterfølgende tabellen lister hvilke forretningsregler som gjelder for hver meldingstype Regler for meldingstypen Referanse Regel har alltid en avsender og en mottaker må inneholde minst ett element av Spesifikasjoner Dersom en av aktørene skal endres, skal opprinnelig måledokument kanselleres og det skal utstedes et nytt måledokument med ny Id Samhandling Forklaring på aktivitetsdiagrammene: Kolonne: Et aktivitetsdiagram består av flere kolonner (Swimlanes). En kolonne beskriver aktiviteter og prosesser hos en aktør. Aktivitet: Et sett operasjoner som utføres hos en aktør. Angis i bokser med avrundede hjørner. Valg: Et punkt i prosessen der evalueringen av en betingelse medfører valg av ett eller flere mulige videre prosessløp. Angis som en rombe. Overgang (Forgrening og Sammenføyning): Start og avslutning av to eller flere parallelle prosesser. Angis med en tykk heltrukken linje. Side 3

4 Start/stopp: Start og avslutning av selve samhandlingsprosessen. Det kan kun være ett startpunkt, men det kan være flere avslutninger. Angis som sirkler der startpunktet er helt svart mens sluttpunktet inneholder en hvit ring. Aktivitet med gul farge: Dette er en aktivitet som er direkte relatert til sending eller mottak av en elektronisk melding beskrevet i dette dokumentet til/fra en annen aktør. Selve meldingen identifiseres med et understreket navn. Aktivitet med grønn farge: Dette er en aktivitet som er direkte relatert til sending eller mottak av en elektronisk melding relatert til denne standarden, til/fra en annen aktør. Selve meldingen identifiseres ved et understreket navn. Beskrivelse av meldingen finnes i et annet dokument. Aktivitet med blå farge: Dette er en aktivitet som er direkte relatert til sending eller mottak av en elektronisk melding som ikke er en del av denne standarden, til/fra en annen aktør. Selve meldingen identifiseres ved et understreket navn Måling av et tømmerlass I diagrammet er det brukt Produsent og Varemottaker. Ved omsetning av tømmer vil det oftest være ensbetydende med Skogeier (Leverandør) og Forbrukende kjøper. For å gjøre standarden generell (omsetning av flis osv), er generelle begreper valgt. Side 4

5 Måleresultater ved videresalg av tømmer Videresolgt tømmer Handelsledd N Handelsledd N+1 [Har mottatt et måledokument] [Videresolgt] Generer og send Motta Måleresultatene må følge varestrømmen Behandle meldingen Hvordan meldingen skal behandles, avhenger av verdien av statusattributtene på meldings-, hode- og spesifikasjonsnivå. Status på meldingsnivå påvirker mulig status på hode- og spesifikasjonsnivå. Ved første gangs utsendelse skal status på melding, hode og spesifikasjon settes lik Original. En mottager kan avvise et dersom informasjonen ikke tilfredsstiller kravene i standarden. Mottager svarer da med meldingen BusinessAcknowledge og status satt til Avvist. Årsak skal angis. En mottager kan avvise et dersom det er feilsendt (inneholder opplysninger som ikke er gjenkjennbare for oppdragsgiver). Mottager svarer da med meldingen BusinessAcknowledge og status satt til Feil. Årsak skal angis Statusverdier som benyttes Nivå Attributt Verdi Melding MdokStatusType Original Indikerer at dette er første forsendelse av inneholdende originale data. Endret Indikerer at innholdet i meldingen er endret i forhold til første versjon/forsendelse. Kansellert Utsteder har kansellert denne meldingen. Hode MdokHode- StatusType Original Indikerer at dette er originale data. Endret Indikerer at innholdet i MdokHode er endret i forhold til første versjon/forsendelse. Kansellert Utsteder har kansellert denne meldingen. Ingen Ingen aksjoner er nødvendig for denne delen av meldingen. Brukes dersom andre deler av meldingen er endret. Side 5

6 Spesifikasjon MdokSpes- StatusType Original Indikerer at dette er originale data. Endret Indikerer at innholdet i MdokHode er endret i forhold til første versjon/forsendelse. Kansellert Utsteder har kansellert denne meldingen. Ingen Ingen aksjoner er nødvendig for denne delen av meldingen. Brukes dersom andre deler av meldingen er endret. 2.2 Hvordan lese diagrammene Forklaring på symboler i diagrammene: Sekvensen av enheter til høyre for symbolet, er påkrevd. Et valg mellom enheter til høyre for symbolet, er påkrevd Det er valgfritt å benytte en enkel forekomst av dette elementet. Prikket linje rundt. Det er valgfritt å benytte flere forekomster av dette elementet. Prikket linje rundt. Antall mulige forekomster er angitt under. En enkel forekomst av dette elementet er påkrevd. Heltrukken linje rundt. En enkel forekomst av dette elementet er påkrevd. Flere instanser kan forekomme. Heltrukken linje rundt. Antall mulige forekomster er angitt under. Antallet forekomster må ligge innenfor nedre og øvre grense som er angitt under (i dette tilfellet minimum 2 og maksimum 10 forekomster). Når en datatype er angitt for et element (både simple og komplekse datatyper), er navnet og eventuell lengde på datatypen angitt under. Det samme gjelder minimums og maksimumsverdier samt standardverdi (default-verdi). En farget boks med stiplet linje vil omgi komplekse datatyper. Strukturen på den komplekse datatypen vises inne i boksen. Stiplet linje betyr ikke at elementet er valgfritt. I dette eksemplet er strukturen undertrykket (+ til høyre angir at strukturen kan åpnes). Elementer kan forekomme utenfor den komplekse gruppeboksen hvis de er utvidelser av den definerte datatypen. Attributter knyttet til et element kan bli vist over og under elementet. Hvis attributtet er en utvidelse av en definert datatype, vil det bli vist under gruppeboksen for den komplekse datatypen. I øvrige tilfeller vil den bli vist over elementinnholdet. Dette eksemplet viser en valgfri attributt. Påkrevde attributter vil ha heltrukken linje. Side 6

7 3 Side 7

8 3.1 Rot-element Rot-elementet består av følgende attributter: MeldingVersjon Gjeldede versjon er 2.0 MdokStatus Se og Data Dictionary for gyldige verdier MeldingOmsending Indikerer at dokumentet er sendt på nytt uten at det er foretatt endringer i opplysningene. Benyttes derom en mottager ber om å få sendt dokumentet på nytt. Ja eller Nei. Standardverdi er Nei. Dersom opplysningen mangler i dokumentet, skal standardverdi benyttes. Rotelementet består av følgende elementer: MdokHode MdokSpesifikasjoner Side 8

9 3.2 MdokHode MdokHode består av følgende attributter: MdokHodeStatus Se og Data Dictionary for gyldige verder MdokHode består av følgende elementer: DokumentId Unik identifikasjon av måledokumentet. Avsender Hvilken organisasjon som er avsender av meldingen. Mottaker Hvilken organisasjon som er mottaker av denne meldingen. Vareleverandor Hvilken organisasjon som er leverandør. Varemottaker Hvilken organisasjon som er mottaker av varen. AndreAktorer Plass for å angi andre aktører. Eksempeler er måleorganisasjon og transportør. Melding Melding (fritekst) til en eller flere aktører. Utfort Dato og eventuell tid når måling ble utført. Registrert Dato og eventuell tid når informasjonen ble registrert. Beregnet Dato og eventuell tid når beregning ble utført. Endret Dato og eventuell tid når informasjon ble endret. MalePlass Kode og eventuelt navn på måleplass MaleSted Kode og eventuelt navn på målested. MaleMetode Kode og eventuell beskrivende tekst for målemetode. MaleDimensjonsreglement Hvilket dimensjonsreglement som er benyttet. MaleFormal Kode og eventuell beskrivende tekst for måleformål. MaleTariff Kode og eventuell beskrivende tekst for hvilken tariff som er lagt til grunn ved beregning av måleavgift. Kommune Kode og eventuelt navn på kommune. PrisreguleringFlis Faktor for prisregulering av flis. MdokLassreferanse Referanse til hvilke lasskvitteringer (TransportertVirke) som inngår i dette måledokumentet. Fraktbrev Referanse til eventuelt fraktbrev Tollstasjon Referanse til eventuell tollstasjon Side 9

10 3.3 MdokSpesifikasjoner Det skal alltid være minst en spesifikasjon (en vare eller sortiment). Ved flere sortimenter (varer), angis en spesifikasjon pr. sortiment. MdokSpesifikasjoner består av følgende attributter: MdokSpesStatus Se og Data Dictionary for gyldige verdier MdokSpesifikasjoner består av følgende elementer: SpesLinjenr Hver linje skal ha et unikt linjenummer. Sortiment Hvilken vare (sortiment) denne spesifikasjonen gjelder for MdokArsak Kode og eventuell beskrivelse av årsaken til nedsettelse av kvalitet (vraking). VraketFra I VSYS endres varenummer (sortiment) til Vrak dersom kvaliteten tilsier det. I dette feltet kan opprinnelig sortiment angis. Bruken av dette feltet vil falle bort dersom man tar i bruk SortimentKvalitet til å angi kvaliteten. Kvantum Mengde av varen. Det er mulig å oppgi flere kvantum, for eksempel kubikkmeter og antall stokker. Kollektiv Angir hvilket kollektiv som eventuelt er lagt til grunn og hvilken korreksjonsfaktor som gjelder for det oppgitte kollektivet. MdokVolumtabell Hvilken volumtabell som er benyttet ved beregning AnnetKvantum Mulighet til å oppgi andre kvantum enn det som benyttes ved prisberegning. Eksempler er diverse statistikkvantum. Omregningsfaktor Faktor som benyttes ved omregning mellom forskjellige kvantum (tonn til kubikk). MdokStokkLinjer Informasjon på stokknivå. DokumentSpesReferanse Referanse til spesifikasjon i andre dokumenter/meldinger MdokStokkLinjer Valgfri gruppe for å angi verdier på stokknivå. Opplysninger kan grupperes i: Handelsverdier Verdier som benyttes i forretningssammenheng (verdiberegning). Statistikkverdier Verdier beregnet etter norske regler for virke som er importert. RegistrerteVerdier Eksakte registrerte verdier. Side 10

11 4 Eksempler på forretningsmessig bruk av meldingen Eksempler på hvordan statustyper brukes i forbindelse med meldingen. I beskrivelsene nedenfor, er det bare vist eksempler for meldingsflyt mellom måleorganisasjon og oppdragsgiver. Meldingsflyt mellom andre aktører vil være tilsvarende. Modellen blir generell ved å benytte Avsender og Mottager som roller, men det ikke gitt at alle scenarier vil være aktuelle for alle aktører. Scenario A Scenario B Scenario C Nytt fra måleorganisasjon Nytt fra måleorganisasjon, avvist av oppdragsgiver Nytt fra måleorganisasjon, deretter kansellering Scenario D Endring av I beskrivelsene benyttes Business Ack. Dette er bekreftelse som sendingsprotokollen bruker for å bekrefte at en melding er mottatt av mottagende system (meldingen er overført). Side 11

12 4.1 Scenario A Melding Scenario Nytt fra måleorganisasjon Resultat Utsteder Mottager Forutsetninger Trigger Stepp 1 legges inn oppdragsgivers system Måleorganisasjon Oppdragsgiver/aktør Det forutsettes at oppdragsgiver har sendt et måleoppdrag og at dette er godtatt av måleorganisasjon. Ingen Måleorganisasjon sender originalt til oppdragsgiver. Statusfelter i meldingen: MdokStatusType = Ny MdokHodeStatusType = Ny MdokSpesStatusType = Ny Side 12

13 4.2 Scenario B Melding Scenario Nytt fra måleorganisasjon, avvist av mottager Måleorg. Mottager Mottar BusinessAcknowledge Resultat Utsteder Mottager Forutsetninger Trigger Stepp 1 Stepp 2 inneholder feil og er ikke akseptert som en gyldig melding Måleorganisasjon Oppdragsgiver/aktør inneholder feil som fører til at oppdragsgiver ikke kan kjenne igjen melding som gyldig i sitt system. Ingen Måleorganisasjon sender original til oppdragsgiver/mottaker. Statusfelter i meldingen: MdokStatusType = Ny MdokHodeStatusType = Ny MdokSpesStatusType = Ny Oppdragsgiver svarer med BusinessAcknowledge. Statusfelter i meldingen: MdokStatusType = Avvist MdokHodeStatusType = Avvist MdokSpesStatusType = Avvist Side 13

14 4.3 Scenario C Melding Scenario Nytt fra måleorganisasjon, deretter kansellering Resultat Utsteder Mottager Forutsetninger Trigger Stepp 1 Stepp 2 slettes/tilbakekalles fra oppdragsgivers system Måleorganisasjon Oppdragsgiver er sendt til feil adressat eller skal, av andre grunner, tilbakekalles eller slettes. Ingen Måleorganisasjon sender original til oppdragsgiver/mottaker. Statusfelter i meldingen: MdokStatusType = Ny MdokHodeStatusType = Ny MdokSpesStatusType = Ny Måleorganisasjon sender til oppdragsgiver/mottaker. Statusfelter i meldingen: MdokStatusType = Kansellert MdokHodeStatusType = Kansellert MdokSpesStatusType = Kansellert Side 14

15 4.4 Scenario D Melding Scenario Endring av Resultat Utsteder Mottager Forutsetninger Trigger Stepp 1 Stepp 2 endres i oppdragsgivers system. Måleorganisasjon Oppdragsgiver Det er oppdaget feil i meldingsinnholdet. Ingen Måleorganisasjon sender original til oppdragsgiver/mottaker. Statusfelter i meldingen: MdokStatusType = Ny MdokHodeStatusType = Ny MdokSpesStatusType = Ny Måleorganisasjon sender til utsteder. Statusfelter i meldingen: MdokStatusType = Endret MdokHodeStatusType = Endret eller Original avhengig av om innholdet i meldingshodet er endret eller ikke. MdokSpesStatusType = Endret eller Original avhengig av om innholdet i meldingsspesifikasjonen er endret eller ikke. Side 15