Transaksjonsstandard for virkesomsetningen i Norge. Transportklart virke. Versjon 2.0. Desember 2007 SKOG-DATA AS

Transkript

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

2 Innhold 1 INNLEDNING 3 2 DOKUMENTASJON AV TRANSPORTKLARTVIRKE Oversikt Meldingstyper TransportklartVirke forretningsregler Regler for meldingstypen TransportklartVirke Samhandling Transportklart Virke Behandle meldingen TransportklartVirke Statusverdier som benyttes Hvordan lese diagrammene 5 3 TRANSPORTKLARTVIRKE TransportklartVirke Rot-element TrklartHode TrklartSpesifikasjoner 8 4 EKSEMPLER PÅ FORRETNINGSMESSIG BRUK AV MELDINGEN Scenario A Scenario B Scenario C Scenario D 14 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 TransportklartVirke 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 (TransportklartVirke.xsd). Beskrivelse av alle elementer finnes i dokumentet Data Dictionary. 2.1 Oversikt TransportklartVirke er en melding fra oppdragsgiver (utsteder av transportoppdrag) som, relatert til et transportoppdrag, forteller transportledelsen hvor stort kvantum av de forskjellige sortimentene som er klar for transport. TransportklartVirke spesifiserer hvor virket skal hentes. TransportklartVirke inkluderer: Hvilket transportoppdrag volumene er relatert til Varetyper og mengder som skal transporteres Hvor varene skal hentes Meldingstyper Det finnes kun en meldingstype for TransprtklartVirke TransportklartVirke forretningsregler Den etterfølgende tabellen lister hvilke forretningsregler som gjelder Regler for meldingstypen TransportklartVirke Referanse Regel TransportklartVirke har alltid en avsender og en mottaker. TransportklartVirke må inneholde minst ett element av spesifikasjon (TrklartSpesifikasjoner) 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. 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. Side 3

4 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 Transportklart Virke Transportklart Virke Oppdragsgiver Transportledelse [Har et virkesparti som er klar for transport] Bestem hvor stor andel av framkjørt virke som skal klargjøres for transport Generer og send Transportklart Virke TransportklartVirke Motta Transportklart Virke Behandle meldingen TransportklartVirke 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. Et transportselskap kan avvise TransportklartVirke dersom informasjonen ikke tilfredsstiller kravene i standarden. Transportselskapet svarer da med meldingstype TransportklartVirkeBekreftelse og status satt til Avvist. Et transportselskap kan avvise et TransportklartVirke dersom informasjonen ikke tilfredsstiller kravene i standarden. Transportselskapet svarer da med meldingen BusinessAcknowledge og status satt til Avvist. Årsak skal angis. Et transportselskap kan avvise et TransportklartVirke dersom det er feilsendt (inneholder opplysninger som ikke er gjenkjennbare for oppdragsgiver). Transportselskapet svarer da med meldingen BusinessAcknowledge og status satt til Feil. Årsak skal angis. Side 4

5 Statusverdier som benyttes Nivå Attributt Verdi Melding TrklartStatus Endret Indikerer at innholdet i meldingen er endret i forhold til første versjon/forsendelse. Kansellert Utsteder har kansellert denne meldingen. Ny Indikerer at dette er første forsendelse av TransportklartVirke inneholdende originale data. Hode TrklartHodeStatus Endret Indikerer at innholdet i TrklartHode er endret i forhold til første versjon/forsendelse. Ingen Ingen aksjoner er nødvendig for denne delen av meldingen. Brukes dersom andre deler av meldingen er endret. Kansellert Utsteder har kansellert denne meldingen. Ny Indikerer at dette er originale data. Spesifikasjon TrklartSpesStatus Endret Indikerer at innholdet i TrklartHode er endret i forhold til første versjon/forsendelse. Ingen Ingen aksjoner er nødvendig for denne delen av meldingen. Brukes dersom andre deler av meldingen er endret. Kansellert Utsteder har kansellert denne meldingen. Ny Indikerer at dette er originale data. 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). Side 5

6 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 TransportklartVirke Side 7

8 3.1 TransportklartVirke Rot-element Rot-elementet TransportklartVirke består av følgende attributter: MeldingVersjon Gjeldende versjon er 2.0 TrklartStatus 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 TransportklartVirke består av følgende elementer: TrklartHode TrklartSpesifikasjoner 3.2 TrklartHode TrklartHode består av følgende attributter: TrklartHodeStatus Se og Data Dictionary for gyldige verdier. TrklartHode består av følgende elementer: DokumentId Unik identifikasjon av meldingen Avsender Hvilken organisasjon som er utsteder av denne meldingen. Mottaker Hvilken organisasjon som er mottager av denne meldingen. DokumentRefranse Referanse til andre dokumenter. Melding Plass for fritekst Vareleverandør Hvilken organisasjon som er vareleverandør. TrklartSiste Forteller om dette er siste TransportklartVirke relatert til dette Transportoppdraget. Dersom elementet ikke finnes i meldingen, skal defaultverdi alltid antas. 3.3 TrklartSpesifikasjoner Det skal alltid være minst en spesifikasjon/sortlinje (vare eller sortiment). TrklartSpesifikasjoner består av følgende attributter: TrklartSpesStatus Se og Data Dictionary for gyldige verdier. TrklartSpesifikasjoner består av følgende elementer: SpesLinjenr Linjenummer for denne spesifikasjonen. Sammen med DokumentId vil SpesLinjenr være en unik identifikasjon av denne spesifikasjonen. Side 8

9 DokumentSpesReferanse Referanse til spesifikasjonslinje i et annet dokument Varemottaker Hvem som er mottaker av varen. Leveringssted Angir hvor varen skal leveres. Sortiment Hvilken vare (sortiment) denne spesifikasjonen gjelder for Kvantum Mengde av varen. Det er mulig å oppgi flere kvantum, for eksempel kubikkmeter og antall stokker. Hentested Hvor varen (virket) skal hentes. Side 9

10 4 Eksempler på forretningsmessig bruk av meldingen Eksempler på hvordan statustyper brukes i forbindelse med meldingen TransportklartVirke. I beskrivelsene nedenfor, er det bare vist eksempler på meldingsflyt mellom oppdragsgiver og transportledelse. 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 Ny TransportklartVirke fra oppdragsgiver (Utsteder) Ny TransportklartVirke fra oppdragsgiver, avvist av transportledelse Ny TransportklartVirke fra oppdragsgiver, deretter kansellering Scenario D Endring av TransportklartVirke 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 10

11 4.1 Scenario A Melding TransportklartVirke Scenario Ny TransportklartVirke fra oppdragsgiver Resultat Utsteder Mottager Forutsetninger Trigger Stepp 1 TransportklartVirke legges inn i transportsystemet Oppdragsgiver Transportledelse (Transportselskap) Det forutsettes at oppdragsgiver har sendt et Transportoppdrag og at dette er godtatt av transportselskap. Ingen Oppdragsgiver sender ny TransportklartVirke til transportledelsen. Statusfelter i meldingen: TrklartStatus = Ny TrklartHodeStatus = Ny TrklartSpesStatus = Ny Side 11

12 4.2 Scenario B Melding TransportklartVirke Scenario Ny TransportklartVirke fra transportledelse, avvist av mottager Resultat Utsteder Mottager Forutsetninger Trigger Stepp 1 Stepp 2 TransportklartVirke inneholder feil og er ikke akseptert som en gyldig melding Oppdragsgiver Transportledelse (transportselskap) TransportklartVirke inneholder feil som fører til at transportledelsen ikke kan kjenne igjen melding som gyldig i sitt system. Ingen Oppdragsgiver sender ny TransportklartVirke til transportledelsen. Statusfelter i meldingen: TrklartStatus = Ny TrklartHodeStatus = Ny TrklartSpesStatus = Ny Ttransportledelse returnerer BusinessAcknowledge til utsteder. Statusfelter i meldingen: BusinessackStatus = Avvist Side 12

13 4.3 Scenario C Melding TransportklartVirke Scenario Ny TransportklartVirke fra oppdragsgiver, deretter kansellering Oppdragsgiver Transportledelse Mottar Transportklart Virke Business Ack Mottar Transportert Virke Business Ack Resultat Utsteder Mottager Forutsetninger Trigger Stepp 1 Stepp 2 TransportklartVirke slettes/tilbakekalles fra transportledelsens system Oppdragsgiver Transportledelse (transportselskap) TransportklartVirke er sendt til feil adressat eller skal, av andre grunner, tilbakekalles eller slettes. Ingen Oppdragsgiver sender ny TransportklartVirke til transportledelsen. Statusfelter i meldingen: TrklartStatus = Ny TrklartHodeStatus = Ny TrklartSpesStatus = Ny Oppdragsgiver sender TransportklartVirke til transportledelsen. Statusfelter i meldingen: TrklartStatus = Kansellert TrklartHodeStatus = Kansellert TrklartSpesStatus = Kansellert Side 13

14 4.4 Scenario D Melding TransportklartVirke Scenario Endring av TransportklartVirke Transportledelse Oppdragsgiver Mottar TransportertVirke Business Ack Mottar TransportertVirke Business Ack Resultat Utsteder Mottager Forutsetninger Trigger Stepp 1 Stepp 2 TransportklartVirke endres i transportledelsens system. Oppdragsgiver Transportledelse (transportselskap) Det er oppdaget feil i meldingsinnholdet. Ingen Oppdragsgiver sender ny TransportklartVirke til transportledelsen. Statusfelter i meldingen: TrklartStatus = Ny TrklartHodeStatus = Ny TrklartSpesStatus = Ny Oppdragsgiver sender TransportklartVirke til transportledelsen. Statusfelter i meldingen: TrklartStatus = Endret TrklartHodeStatus = Endret eller Ingen avhengig om innholdet i meldingshodet er endret eller ikke. TrklartSpesStatus = Endret eller Ingen avhengig om innholdet i meldingsspesifikasjonen er endret eller ikke. Side 14