Sanomasuositus ja sen yleinen soveltamisohje Tiedoksianto FI033, 204-04-30, v.0 Käyttö: Energiateollisuus Sanasto: UBL Versio: 2.0 Sanoma: AttachedDocument
Sisällysluettelo Sanoma ja sen soveltamisala... 4. Sanoman käyttötarkoitus ja soveltamisen rajaus... 4.2 Soveltamisohjeen sisältö... 4.3 Työryhmän työskentelyyn osallistuneet... 5 2 Dokumentti ja sen yhteydet muihin dokumentteihin... 7 2. Päivitykset... 7 2.2 Esitietovaatimukset... 7 2.3 Aiheeseen liittyvää aineistoa... 7 2.4 Huomioitavaa... 7 3 Tiedoksiantoprosessi... 8 3. Prosessin rajaus... 8 3.2 Prosessin osapuolet... 8 3.3 Prosessin vaiheet... 8 4 Sanoman tietosisältö... 2 5 Tiedoksiantosanoman rakenne... 6 5. Luokkamalli... 6 5.2 Laajennukset... 6 5.3 Tietojen suhde toisiinsa... 7 6 Sanoman määrittely... 20 6. Sanoman otsikkotaso... 20 6.. Tiedoksiantosanoma (Attached Document. Details)... 20 6..2 Tiedoksiantosanoman lähettäjän tiedot (Attached Document. Sender_ Party. Party) 26 6..3 Tiedoksiantosanoman lähettäjän tunniste (Party. Party Identification)... 28 6..4 Tiedoksiantosanoman lähettäjän nimi (Party. Party Name)... 29 6..5 Tiedoksiantosanoman lähettäjän yhteyshenkilö tai -osasto ja yhteystiedot (Party. Contact)... 30 6..6 Tiedoksiantosanoman vastaanottajan tiedot (Attached Document. Receiver_ Party. Party)... 3 6..7 Tiedoksiantosanoman vastaanottajan tunniste (Party. Party Identification)... 33 6..8 Tiedoksiantosanoman vastaanottajan nimi (Party. Party Name)... 34 6..9 Tiedoksiantosanoman vastaanottajaorganisaation yhteyshenkilö tai -osasto ja yhteystiedot (Party. Contact)... 35 6..0 Liitetiedosto (Attached Document. Attachment)... 36 6.. Liitetiedoston web-osoite (Attachment. External Reference)... 37 6.2 Laajennusosa... 38 6.2. Laajennustiedot (Attached Document. UBL Extensions)... 38 6.2.2 Laajennusosan tiedot (UBL Extensions. UBL Extension)... 39
6.2.3 Laajennusosan tietosisältö (UBL Extension. Extension Content)... 4 6.2.4 Laajennusosan tiedot (Extension Content. Attached Document Extension)... 42 6.2.5 Kuittauspyyntö (Attached Document Extension. Response)... 43 6.2.6 Muiden liitteiden tiedot (Attached Document Extension. Document Reference) 45 6.2.7 Liitetiedosto (Document Reference. Attachment)... 48 6.2.8 Liitetiedoston web-osoite (Attachment. External Reference)... 49 6.2.9 Muuttuneen käsittelijän tai vastuuhenkilön tiedot (Attached Document Extension. Person)... 50 7 Sanomaesimerkki... 52 7. UBL tiedoksiantosanomaesimerkki... 52 8 Liite : Kappaleessa 6 Sanoman määrittely esiintyvien taulukoiden lukuohje... 56
Sanoma ja sen soveltamisala. Sanoman käyttötarkoitus ja soveltamisen rajaus Tämä dokumentti sisältää UBL 2.0 -versioon perustuvan AttachedDocument sanoman sanomakuvauksen ja soveltamisohjeen. Tämä soveltamisohje määrittelee sanoman käytön suomalaisen energiateollisuuden sähköntuottajien ja heidän palvelutuottajien välisessä toiminnassa lähetettäessä aiemmin lähetettyyn tai vastaanotettuun sanomaan tai muuhun asiakirjaan liittyvää informaatiota tai liitteitä. Yhdellä sanomalla voidaan lähettää vain yhteen sanomaan tai asiakirjaan liittyvää informaatiota tai siihen kuuluvia liitteitä. OASIS-organisaation tekemässä AttachedDocument sanomassa yhdellä sanomalla voidaan lähettää aina vain yksi liite ja yksi linkki Internet-sivustoon. Tässä soveltamisohjeessa on esitetty laajennus, jonka avulla voidaan lähettää useita liitteitä ja linkkejä. Lähetettäessä samalla sanomalla useita liitteitä on varmistuttava, ettei suuri tiedostokoko aiheuta tiedonsiirrossa ja sanoman vastaanotossa ongelmia. On suositeltavaa, että vastaanotetusta tiedoksiantosanomasta lähetetään ainakin vastaanoton automaattinen kuittaussanoma tiedoksiantosanoman lähettäjälle. Lisäksi voidaan lähettää sovellustason vastaussanoma, kun tiedoksiantosanoman tietosisältö on käsitelty vastaanottajan järjestelmissä. Soveltamisohje on syntynyt Energiateollisuus ry:n organisoimassa projektissa Sähkönjakeluyhtiöiden ja palveluntuottajayhtiöiden tietojärjestelmien yhteensopivuus. Projekti alkoi.9.2009 ja loppui 30.6.200. Soveltamisohjeen on tehnyt TIEKE Tietoyhteiskunnankehittämiskeskus ry. Tämän soveltamisohjeen tarkoituksena on lisätä yritysten halukkuutta ottaa käyttöön XMLpohjaista sähköistä tiedonsiirtoa, nopeuttaa järjestelmien kehitysprosessia ja vähentää integraatiokustannuksia luomalla yleinen ja yhtäläinen kansallinen suositus. Suosituksella pyritään myös vähentämään tarvetta luoda yritys- tai organisaatiokohtaisia erilaisia suosituksia, jotka eivät välttämättä ole yhteentoimivia. Tavoitteena on myös nopeuttaa uuden tiedonsiirtotavan omaksumista kansainvälisen kilpailukyvyn säilyttämiseksi ja parantamiseksi. Soveltamisohje on tarkoitettu apuvälineeksi yhteistyökumppanien välisiin neuvotteluihin kehitettäessä organisaatioiden välistä sähköistä tiedonsiirtoa. Soveltamisohjetta voidaan käyttää hyväksi kehitettäessä jo olemassa olevien järjestelmien tiedonsiirto-ominaisuuksia..2 Soveltamisohjeen sisältö Kappaleessa Sanoma ja sen soveltamisala on esitetty tämän sanoman käyttötarkoitus ja soveltamisen rajaus sekä kehityshankkeen työhön osallistuneet yritykset ja organisaatiot sekä niiden henkilöt. Kappaleessa 2 Dokumentti ja sen yhteydet muihin dokumentteihin esitetään tämän dokumentin ymmärrettävään lukemiseen tarvittavat esitietovaatimukset sekä hyödyllisiä linkkejä ja tämän dokumentin päivitystiedot. Kappaleessa 3 Sanoman tiedoksiantoprosessi esitetään tämän dokumentin tietosisällön ja soveltamisohjeen pohjana oleva sanoman välitysprosessi, sen osapuolet ja vaiheet. 4/56
Kappaleessa 4 Sanoman tietosisältö on esitetty tiedoksiantosanomassa välitettävien tietojen luettelo. Kappaleessa 5 "Tiedoksiantosanoman rakenne on esitetty tämän UBL- AttachedDocument-sanoman luokkamalli käyttäen hyväksi UML-kuvauskieltä sekä UBLsanoman elementtinimillä että niiden sisältämien tietojen nimillä esitettynä. Kappaleessa 6 Sanoman määrittely on esitelty sanoman rakenne, käytettävät aggregaatit, elementit, attribuutit ja koodit sekä niiden käyttötarkoitus. Kappaleessa 7 Sanomaesimerkki on esitetty esimerkki UBL-AttachedDocument-sanoman tiedoksiantosanoman käytöstä. Liitteessä on esitetty kappaleessa 6 Sanoman määrittely esiintyvien taulukoiden lukuohje..3 Työryhmän työskentelyyn osallistuneet Seuraavassa taulukossa on esitetty yritykset ja organisaatiot, jotka ovat osallistuneet Energiateollisuus ry:n organisoiman projektin Sähkönjakeluyhtiöiden ja palveluntuottajayhtiöiden tietojärjestelmien yhteensopivuus työhön joko sen ohjaus- tai projektiryhmässä. Yritys/Organisaatio Eltel Networks Oy Empower Oy Energiateollisuus ry (SV -toimiala) ENFO Fingrid Oyj Fortum Sähkönsiirto Oy Frends Oy Headpower Oy Helen Sähköverkko Oy Henkilö Erkki Leinonen Valter Maasalo Anna Tanskanen Otto Tarkiainen Tommi Dahlroos Antti Herranen Juho Kuivalainen Pertti Lindberg Pertti Markkanen Jari Hirvonen Arto Matsinen Jari Myllylä Antti Toivanen Timo Mutila Jari Martikainen Tuomas Murumäki 5/56
Osmo Siirto Kaupunkiyhtiöt R 2 / Kuopion Energia Oy Logica Suomi Oy Oy Mercus Software Oy STUL Suomen Energia Urakointi Oy Tekla Oy Tieto Oy Vattenfall Verkko Oy Visma Software Oy Voimatel Oy Kari Väänänen Hannu Salonen Valeri Tiik Arto Kari Esa Tiainen Ari Ala-Sippola Taisto Lehonmaa Jukka Pulkkinen Heli Siponen Lauri Anttila Martti Mäkiranta Antti Sulin Vesa Hänninen Olli Lautiainen Markku Manninen Taulukko.3.: Sähkönjakeluyhtiöiden ja palveluntuottajayhtiöiden tietojärjestelmien yhteensopivuus projektin työryhmätyöskentelyyn osallistuneet 6/56
2 Dokumentti ja sen yhteydet muihin dokumentteihin 2. Päivitykset Pvm/Laatija Versio Kommentit/muutokset 200-06-30 Heikki Laaksamo 204-04-30 Heikki Laaksamo.00 Ensimmäinen versio.0 Lisätty aggregaatin Tiedoksiantosanoma (Attached Document. Details)elementin DocumentTypeCode koodi 43 = (Infrastructure condition) Liittymätöiden lisätiedot 2.2 Esitietovaatimukset Soveltamisohje on tarkoitettu sekä johto- että asiantuntijatason käyttöön. Soveltamisohjeen teknisen taustan ymmärtämistä tukee seuraavien aihealueiden tuntemus: XML, UBL ja ebxml ydinkomponentit. 2.3 Aiheeseen liittyvää aineistoa w3schools XML Tutorial (http://www.w3schools.com/xml/default.asp ) ebxml Core Components Technical Specification (CCTS) 2.0 (http://www.ebxml.org/ ) Universal Business Language 2.0 ( www.oasisopen.org/committees/tc_home.php?wg_abbrev=ubl) NES työryhmän tekemät soveltamisohjeet ( www.nesubl.eu ) United Nations Directories for Electronic Data Interchange for Administration, Commerce and Transport (http://www.unece.org/trade/untdid/welcome.htm ) UN/CEFACT Recommendations (http://www.unece.org/cefact/recommendations/rec_index.htm ) 2.4 Huomioitavaa Soveltamisohje perustuu UBL 2.0 AttachedDocument -sanoman määrityksiin. Määrityksissä on noudatettu myös kansainvälisen NES työryhmän suosituksia sanomien tietosisällön ja käytön osalta soveltaen näitä suomalaisen energiateollisuuden tarpeisiin. 7/56
3 Tiedoksiantoprosessi 3. Prosessin rajaus Tässä prosessikuvauksessa on tarkasteltu ainoastaan tiedoksiantosanoman välitysprosessia, jossa tämän dokumentin määrittelemää AttachedDocument-sanomaa voidaan käyttää. Tarkastelussa oletetaan, että tiedoksiantosanoma välitetään sähköisesti osapuolten välillä. Tarkastelusta on jätetty pois tiedoksiantosanoman lähettämistä edeltävät vaiheet, kuten sen sanoman lähetys, johon tiedoksiantosanoma liittyy, ja tiedoksiantosanoman lähettämistä seuraavat vaiheet, kuten tiedoksiannon aiheuttamat muut toimenpiteet sanoman vastaanottavassa organisaatiossa. 3.2 Prosessin osapuolet Seuraavassa taulukossa on esitetty tämän prosessin osapuolet. Osapuoli Tiedoksiantosanoman lähettäjä Tiedoksiantosanoman vastaanottaja Rooli Osapuoli, joka luo tiedoksiantosanoman liittyen johonkin aiemmin osapuolten välillä siirrettyyn sanomaan. Osapuoli, joka lähettää tiedoksiantosanoman. Osapuoli, joka vastaanottaa tiedoksiantosanomaan liittyvät vastaanottokuittaukset. Osapuoli, joka vastaanottaa tiedoksiantosanoman. Osapuoli, joka käsittelee tiedoksiantosanoman tietojärjestelmissään. Osapuoli, joka luo tiedoksiantosanoman vastaanottokuittauksen. Osapuoli, joka lähettää tiedoksiantosanoman vastaanottokuittauksen tiedoksiantosanoman lähettäjälle. Osapuoli, joka ryhtyy tiedoksiantosanoman tietosisällön edellyttämiin toimenpiteisiin. Taulukko 3.2.: Tiedoksiantoprosessin osapuolet 3.3 Prosessin vaiheet Kuviossa 3.3. on esitetty tiedoksiantoprosessin vaiheet eroteltuna kohdassa 3.2 esitettyjen osapuolien toimintojen mukaan. 8/56
Tiedoksiantosanoman lähettäjä Tiedoksiantosanoman vastaanottaja Luodaan tiedoksiantosanoma Lähetetään tiedoksiantosanoma Tiedoksiantosanoma Vastaanotetaan tiedoksiantosanoma Vastaanotetaan automaattinen vastaanoton kuittaussanoma Käsitellään automaattinen vastaanoton kuittaussanoma Vastaanotetaan sovellustason kuittaussanoma Käsitellään sovellustason kuittaussanoma Automaattinen vastaanoton kuittaussanoma Sovellustason kuittaussanoma Luodaan automaattinen vastaanoton kuittaussanoma Lähetetään automaattinen vastaanoton kuittaussanoma Käsitellään tiedoksiantosanoma Luodaan sovellustason kuittaussanoma Lähetetään sovellustason kuittaussanoma Suoritetaan tiedoksiannon vaatimat tehtävät Kuvio 3.3.: Tiedoksiantoprosessi 9/56
Seuraavassa taulukossa on selitetty kuviossa 3.3. esitetyn tiedoksiantoprosessin vaiheet jaoteltuna osapuolten hoitamien toimintojen mukaan. Osapuoli Toiminta Tiedoksiantosanoman lähettäjä Tiedoksiantosanoman vastaanottaja Luodaan tiedoksiantosanoma Lähetetään tiedoksiantosanoma Vastaanotetaan automaattinen vastaanoton kuittaussanoma Käsitellään automaattinen vastaanoton kuittaussanoma Vastaanotetaan sovellustason kuittaussanoma Käsitellään sovellustason kuittaussanoma Vastaanotetaan tiedoksiantosanoma Luodaan automaattinen vastaanoton kuittaussanoma 0/56 Tiedoksiantosanoman lähettäjä luo tiedoksiantosanoman omissa tietojärjestelmissään. Tiedoksiantosanoman lähettäjä lähettää tiedoksiantosanoman sähköisesti tiedoksiantosanoman vastaanottajalle. Tiedoksiantosanoman lähettäjä vastaanottaa tiedoksiantosanoman vastaanoton automaattisen kuittaussanoman tiedoksiantosanoman vastaanottajalta. Tiedoksiantosanoman lähettäjä käsittelee tiedoksiantosanoman vastaanoton automaattisen kuittaussanoman omissa tietojärjestelmissään. Tiedoksiantosanoman lähettäjä vastaanottaa tiedoksiantosanoman vastaanoton sovellustason kuittaussanoman tiedoksiantosanoman vastaanottajalta. Tiedoksiantosanoman lähettäjä käsittelee tiedoksiantosanoman vastaanoton sovellustason kuittaussanoman omissa tietojärjestelmissään. Tiedoksiantosanoman vastaanottaja vastaanottaa tiedoksiantosanoman tämän lähettäjältä. Tiedoksiantosanoman vastaanottaja luo tiedoksiantosanoman automaattisen vastaanoton kuittaussanoman omissa
tietojärjestelmissään. Lähetetään automaattinen vastaanoton kuittaussanoma Käsitellään tiedoksiantosanoma Luodaan sovellustason kuittaussanoma Lähetetään sovellustason kuittaussanoma Suoritetaan tiedoksiannon vaatimat tehtävät Tiedoksiantosanoman vastaanottaja lähettää tiedoksiantosanoman automaattisen vastaanoton kuittaussanoman tiedoksiantosanoman lähettäjälle. Tiedoksiantosanoman vastaanottaja käsittelee tiedoksiantosanoman omissa tietojärjestelmissään. Tiedoksiantosanoman vastaanottaja luo tiedoksiantosanoman sovellustason kuittaussanoman omissa tietojärjestelmissään. Tiedoksiantosanoman vastaanottaja lähettää tiedoksiantosanoman sovellustason kuittaussanoman tiedoksiantosanoman lähettäjälle. Tiedoksiantosanoman vastaanottaja suorittaa tiedoksiantosanoman mahdollisesti vaatimat tehtävät. Tehtävien suorittaminen ei kuulu tähän prosessiin. Taulukko 3.3.: Tiedoksiantoprosessin osapuolikohtaiset vaiheet /56
4 Sanoman tietosisältö Seuraavassa taulukossa on esitetty tiedoksiantosanoman tietosisältö sekä sanoman aggregaatti, jossa kyseinen tieto sijaitsee sanomassa. Kolmannessa sarakkeessa on esitetty linkkinä viittaus kappaleessa 6 Sanoman määrittely olevaan kyseistä aggregaattia esittelevään alakappaleeseen. Neljännessä sarakkeessa on esitetty tiedon pakollisuus energiateollisuuden sähköntuottajien ja heidän palvelutuottajien tiedoksiantojen välitysprosessissa (P = pakollinen, V = valinnainen, R = ehdollinen (tiedon esiintyminen sanomassa riippuu jonkin toisen tiedon esiintymisestä)). Sanoman vastaanottaja voi käyttää vastaanottamansa sanoman tietoja siten, kuin heidän tietojärjestelmänsä sen sallii. Vastaanottajan ei siis tarvitse tallettaa järjestelmäänsä tietoa, joka on soveltamisohjeessa merkitty pakolliseksi, mutta sanoman lähettäjän on aina lähetettävä pakolliseksi merkitty tieto. 2/56
TIETO Aggregaatti Kappale P/V Sanoman versio Attached Document 6.. P Soveltamisohjeen kehittäjä Attached Document 6.. P Soveltamisohjeen tunnus Attached Document 6.. P Sanoman tunnus / Ensimmäisen liitteen tunnus Attached Document 6.. P Sanoman päivämäärä Attached Document 6.. P Sanoman kellonaika Attached Document 6.. V Yleinen vapaamuotoinen teksti Attached Document 6.. P Liitteen tyyppi (ensimmäinen liite) Attached Document 6.. P Sanoma tai asiakirja, johon viesti liittyy Attached Document 6.. P Sanoman lähettäjän tiedot Attached Document. Sender_ Party. Party 6..2 P Lähettäjän tunniste (OVT) Attached Document. Sender_ Party. Party. Party Identification 6..3 P Lähettäjän nimi Attached Document. Sender_ Party. Party. Party Name 6..4 P Lähettäjän yhteyshenkilön tai -osaston tunnus Lähettäjän yhteyshenkilön tai -osaston nimi Attached Document. Sender_ Party. Party. Contact 6..5 V Attached Document. Sender_ Party. Party. Contact 6..5 P Sähköposti Attached Document. Sender_ Party. Party. Contact 6..5 V Puhelinnumero Attached Document. Sender_ Party. Party. Contact 6..5 V Viestin vastaanottajan tiedot Attached Document. Receiver_ Party. Party 6..6 P Vastaanottajan tunniste (OVT) Attached Document. Receiver_ Party. Party. Party Identification 6..7 P 3/56
Vastaanottajan nimi Attached Document. Receiver_ Party. Party. Party Name 6..8 P Vastaanottajan yhteyshenkilön tai - osaston tunnus Vastaanottajan yhteyshenkilön tai - osaston nimi Attached Document. Receiver_ Party. Party. Contact 6..9 V Attached Document. Receiver_ Party. Party. Contact 6..9 V Sähköposti Attached Document. Receiver_ Party. Party. Contact 6..9 V Puhelinnumero Attached Document. Receiver_ Party. Party. Contact 6..9 V Liitteen tiedot (ensimmäinen liite) 6..0 V Liite Attached Document. Attachment 6..0 V Linkki ulkoiseen liitteeseen Attached Document. Attachment. External Reference 6.. V Laajennusosa 6.2. V Laajennuksen tunnus Attached Document. UBL Extensions. UBL Extension 6.2.2 V Laajennuksen ylläpitäjä Attached Document. UBL Extensions. UBL Extension 6.2.2 V Laajennuksen ylläpitäjän nimi Attached Document. UBL Extensions. UBL Extension 6.2.2 V Kuittauspyyntö Liite (muut kuin ensimmäinen liite) Liitteen tunnus Liitteen tyyppi Liite (muut kuin ensimmäinen liite) Attached Document. UBL Extensions. UBL Extension. Extension Content. Attached Document Extension. Response Attached Document. UBL Extensions. UBL Extension. Extension Content. Attached Document Extension. Document Reference Attached Document. UBL Extensions. UBL Extension. Extension Content. Attached Document Extension. Document Reference Attached Document. UBL Extensions. UBL Extension. Extension Content. Attached Document Extension. Document Reference Attached Document. UBL Extensions. UBL Extension. Extension Content. Attached Document Extension. Document Reference. Attachment 4/56 6.2.5 V 6.2.6 V 6.2.6 V 6.2.6 V 6.2.7 V Linkki ulkoiseen liitteeseen (muut kuin Attached Document. UBL Extensions. UBL Extension. Extension Content. 6.2.8 V
ensimmäinen liite) Muuttuneen käsittelijän tai vastuuhenkilön tiedot Muuttuneen käsittelijän tai vastuuhenkilön rooli Muuttuneen käsittelijän tai vastuuhenkilön nimi Muuttuneen käsittelijän tai vastuuhenkilön tunnus Attached Document Extension. Document Reference. Attachment. External Reference Attached Document. UBL Extensions. UBL Extension. Extension Content. Attached Document Extension. Person Attached Document. UBL Extensions. UBL Extension. Extension Content. Attached Document Extension. Person Attached Document. UBL Extensions. UBL Extension. Extension Content. Attached Document Extension. Person Attached Document. UBL Extensions. UBL Extension. Extension Content. Attached Document Extension. Person 6.2.9 V 6.2.9 V 6.2.9 V 6.2.9 V Taulukko 4.: Tiedoksiantosanoman tietosisältö ja tietojen sijaintiaggregaatit 5/56
5 Tiedoksiantosanoman rakenne 5. Luokkamalli Tässä kappaleessa kuviossa 5.. esitetään UBL 2.0 AttachedDocument-sanoman rakenne käyttäen hyväksi UML-luokkamallia, kun sanomaa käytetään energiateollisuuden tiedoksiantojen välittämisessä. Mallissa on esitetty sanoma vain niiltä osin kuin sen tietosisältö on määritelty Energiateollisuus ry:n organisoimassa projektissa Sähkönjakeluyhtiöiden ja palveluntuottajayhtiöiden tietojärjestelmien yhteensopivuus PartyIdentification -ID UBLExtensions 0.. AttachedDocument -UBLVersionID -CustomizationID -ProfileID -ID -IssueDate -IssueTime -Note -DocumentTypeCode -ParentDocumentID -ParentDocumentTypeCode +Sender +Receiver 0..* Party 0.. 0..* PartyName -Name 0.. Attachment -EmbeddedDocumentBinaryObject Contact -ID -Name -Telephone -ElectronicMail 0.. ExternalReference -URI Kuvio 5..: Tiedoksiantosanoman luokkamalli 5.2 Laajennukset Kuviossa 5.2. on esitetty Attached Document tiedoksiantosanoman laajennusosan luokkamalli. Tämä ilmaisee, että tähän soveltamisohjeeseen on liitetty osia, joita ei ole alkuperäisessä UBL-2.0-AttachedDocument-sanoman rakenteessa, eli että soveltamisohjeessa on laajennus. Kuitenkin tiettyjen tietojen välittäminen olisi vaikeaa ilman näitä osia eli ilman tätä laajennusta. 6/56
UBLExtensions..* UBLExtension -ID -ExtensionAgencyID -ExtensionAgencyName ExtensionContent 0.. AttachedDocumentExtension 0.. 0..* 0..* Response -ReferenceID -ResponseCode DocumentReference -ID -DocumentTypeCode -DocumentType 0.. Person -FirstName -FamilyName -NameSuffix -JobTitle -OrganizationDepartment Attachment -EmbeddedDocumentBinaryObject 0.. ExternalReference -URI Kuvio 5.2.: Tiedoksiantosanoman laajennusosan luokkamalli 5.3 Tietojen suhde toisiinsa Tässä luvussa kuviossa 5.3. esitetään tiedoksiantosanoman tietojen suhteet toisiinsa käyttäen UML-luokkamallia. Kuvioissa on esitetty tiedot niillä nimillä, joilla ne esiintyvät 7/56
kappaleessa 6 esiintyvien taulukoiden -osissa, joissa esitetään suomeksi aggregaattien ja elementtien käyttöä. Kuviossa 5.3.2 on esitetty laajennusosan tietojen suhteet toisiinsa nähden. Tunnustiedot -Tunnus Tiedoksiantosanoman laajennus 0.. Tiedoksianto -UBL Version numero -Sovellusohjeen kehittäjä -Sovellusohjeen tunnus -Tiedoksiantosanoman tunnus -Tiedoksiantosanoman päivämäärä -Tiedoksiantosanoman kellonaika -Yleistä tietoa -Liitteen tyyppi -Alkuperäisen sanoman tunnus -Alkuperäisen sanoman tyyppi +Lähettäjän +Vastaanottajan 0..* Osapuolitiedot..* 0..* Nimitiedot -Nimi Yhteystiedot 0.. Liite -Sisäinen liite -Tunnus -Nimi -Puhelin -Sähköposti 0.. Ulkoinen liite -URI Kuvio 5.3.: Tiedoksiantosanoman tietojen suhteet 8/56
UBL Laajennukset..* UBL Laajennus -Laajennuksen tunnus -Laajennuksen ylläpitäjän tunnus -Laajennuksen ylläpitäjän nimi Laajennuksen sisältö 0.. Tiedoksiantosanoman laajennus 0.. 0..* Kuittauspyyntö -Kuittauksen laajuus -Kuittauksen tyyppi Liitteen tiedot -Tunnus -Viitteen tyyppikoodi -Viitteen tyyppi 0.. Muuttunut henkilö -Etunimi -Sukunimi -Roolikoodi -Rooli -Tunnus Liite -Sisäinen liite 0.. Ulkoinen liite -URI Kuvio 5.3.2: Tiedoksiantosanoman laajennusosan tietojen suhteet 9/56
6 Sanoman määrittely 6. Sanoman otsikkotaso Sanoman otsikkotasolla välitetään koko dokumenttia koskevat tiedot, kuten dokumentin tunniste, päiväys, tiedoksiantosanoman vapaamuotoinen informaatio, osapuolitiedot sekä ensimmäinen liite. 6.. Tiedoksiantosanoma (Attached Document. Details) Attached Document. Details Attached Document. UBL Version Identifier. Identifier Attached Document. Customization Identifier. Identifier Attached Document. Profile Identifier. Identifier Attached Document. Identifier Attached Document. UUID. Identifier Attached Document. Issue Date. Date Attached Document. Issue Time. Time Attached Document. Note. Text Attached Document. Document Type Code. Code Attached Document. Document Type. Text Attached Document. Parent_ Document Identifier. Identifier Attached Document. Parent_ Document Type Code. Code 0..* Attached Document. Signature Attached Document. Sender_ Party. Party Attached Document. Receiver_ Party. Party Attached Document. Attachment Elementti / aggregaatti Attached Document. Details Attached Document. UBL Version Identifier. Identifier Attached Document. Customization Identifier. Identifier Toistokerrat, tyyppi, kuvaus, esimerkki Tällä aggregaatilla annetaan tiedoksiantosanoman tiedot, jolla välitetään vastaanottajalle aiemmin lähetettyyn sanomaan liittyvää muuta informaatiota tai muutostietoa. Esimerkki <AttachedDocument> </AttachedDocument> Identifier. Type UBL version numero. Tämän sanoman rakenne ja tämä soveltamisohje perustuvat UBL versioon 2.0. Täten tämä elementti saa vakiosti arvon "2.0". Esimerkki <cbc:ublversionid>2.0</cbc:ublversionid> Identifier. Type Elementillä annetaan sanoman soveltamisohjeen kehittäjän nimi. Attached Document. Esimerkki <cbc:customizationid>et</cbc:customizationid> 20/56
Profile Identifier. Identifier Identification Scheme Agency. Identifier Attached Document. Identifier Attached Document. Issue Date. Date Attached Document. Issue Time. Time Identifier. Type TIEKE ry:n soveltamisohjeelle antama tunnus, joka on vakiosti FI033 Attribuutit schemeagencyid Esimerkki <cbc:profileid schemeagencyid="292">fi033 </cbc:profileid> Attribuutilla annetaan soveltamisohjeluettelon ylläpitäjän tunnus. Esimerkki schemeagencyid="292" Käytettävät koodit 292 (FI, TIEKE The Information Technology Development Centre of Finland) TIEKE Tietoyhteiskunnan kehittämiskeskus ry Toisto.. Identifier. Type Tiedoksiantosanoman yksilöivä tunnus, jolla tiedoksianto tunnistetaan myöhemmin. Tämä tunnus on sama kuin sanomalla annettavan ensimmäisen liitteen tunnus. Esimerkki <cbc:id>76234</cbc:id> Toisto.. Date. Type Elementillä annetaan tiedoksiantosanoman päivämäärä. Tämä on päivämäärä, jolloin järjestelmän käyttäjä on tallettanut tietojärjestelmään sanomalla lähetettävät tiedot. Päivämäärän muoto on YYYY-MM-DD. Esimerkki <cbc:issuedate>200-02-26</cbc:issuedate> Time. Type Elementillä annetaan tiedoksiantosanoman tietosisällön luonnin kellonaika. Tämä on kellonaika, jolloin järjestelmän käyttäjä on tallettanut tietojärjestelmään sanomalla lähetettävät tiedot. Kellonajan muoto on hh:mm:ss. Huomautus Jos kellonajan ilmoittamisessa on huomioitava aikavyöhyke, esitetään kellonaika muodossa hh:mm:ss+hh:mm tai hh:mm:ss-hh:mm, missä plus- tai miinus-merkin jälkeen on ilmoitettu ajan poikkeaminen UCTajasta (Coordinated Universal Time). Jos kellonaika ilmoitetaan UCT-ajassa, voidaan käyttää merkintää hh.mm:ssz. (UTC korvaa aikaisemmin käytetyn Greenwichin keskiajan (GMT).) 2/56
Attached Document. Note. Text Esimerkki <cbc:issuetime>2:9:03</cbc:issuetime> Toisto 0.. unbounded Text. Type Elementillä annetaan tiedoksiantosanoman vapaamuotoista tekstiä eli yleistä informaatiota. Huomautus Vain yksi elementin toisto kieltä kohden. Huomautus Tämän elementin sisältämän tiedon merkkimäärää ei ole Attribuutit rajoitettu, joten periaatteessa vapaamuotoinen teksti voi olla kuinka pitkä tahansa. On kuitenkin varauduttava siihen, ettei vastaanottaja pysty käsittelemään järjestelmissään kovin pitkiä tekstejä. languageid Language. Identifier Attached Document. Document Type Code. Code Esimerkki <cbc:note languageid="fi">lähetämme teille lupaamamme takuutodistukset.</cbc:note> Tiedoksiantosanoman vapaamuotoisen tekstin kieli ilmaistuna standardin ISO 639 mukaisella kaksikirjaimisella kielikoodilla. Esimerkki languageid="fi" Code. Type Tällä elementillä annetaan tiedoksiantosanoman tyyppi koodimuotoisena. Huomautus Elementin arvoja on kahdessa eri koodistossa. OASIS on määritellyt UN/ECE koodiston "00 Document name code" oletusarvoiseksi koodistoksi. Jos tästä koodistosta ei löydy sopivaa koodia, voidaan käyttää UN/ECE koodistoa 53 Reference qualifier". Huomautus Tällä elementillä annetaan ensimmäisen liitteen tai Internet- Koodit ositteessa olevan dokumentin tyyppi. Jos sanomalla välitetään useiden liitteiden tai Internet-osoitteiden tietoja, annetaan muiden liitteiden tai Internet-osoitteista saatavien dokumenttien tyypit laajennusosassa. UN/ECE koodiston 00 mukaisia koodeja ovat: 20 = (Quality data message) Laatutiedot 53 = (Safety and hazard data sheet)työturvallisuusohje 62 = (Certified inspection and test results) Käyttöönottotarkastus 63 = (Material inspection and receiving report) Takuutarkastus 240 = (Delivery instructions) Keskeytyspyyntö 22/56
293 = (Inspection report) Vastaanottotarkastus 32 = (Acknowledgement message) Tiedoksianto 327 = (Operating instructions) Toimintaohjeet 330 = (Request for delivery instructions) Jännitetyöpyyntö 332 = (Trade data) Pientyön / projektin materiaalia (suunnitelma-asiakirja) 43 = (Infrastructure condition) Liittymätöiden lisätiedot 96 = (Related document) Liitetiedosto Code List. Identifier Code List. Agency. Identifier Attached Document. Parent_ Document Identifier. Identifier Attached Document. Parent_ Document Type Code. Code UN/ECE koodiston 53 mukaisia koodeja ovat: ALE = (Reporting form number) Asiakaspalaute AIV = (Event reference number) Työmaakokous (pöytäkirja) AUH = (Performed prescription identification) Kytkentäohjelma AVP = (Person registration number) Henkilötietojen ilmoitus (Käytetään välitettäessä ainoastaan muuttuneen käsittelijän tai vastuuhenkilön tietoja) Esimerkki <cbc:documenttypecode listid="un/ece 00" listagencyid="6">63</cbc:documenttypecode> Attribuutilla annetaan dokumenttitunnuskoodiston tunnus; joko UN/ECE 00 tai UN/ECE 53 Esimerkki listid="un/ece 00" Käytettävät koodit UN/ECE 00 UN/ECE koodisto 00 "Document name code" UN/ECE 53 UN/ECE koodisto 53 "Reference qualifier" Attribuutilla annetaan dokumenttitunnuskoodiston ylläpitäjän tunnus Esimerkki listagencyid="6" Käytettävät koodit 6 UN/ECE (United Nations - Economic Commission for Europe) Toisto.. Identifier. Type Tällä elementillä annetaan sen aiemmin toimitetun sanoman tai asiakirjan tunnus, johon tämä tiedoksiantosanoma liittyy. Esimerkki <cbc:parentdocumentid>00345/0</cbc:parentdocumentid> Code. Type Tällä elementillä annetaan koodimuotoisena sen aiemmin lähetetyn sanoman tai asiakirjan tyyppi, johon tällä sanomalla 23/56
lähetetty tiedoksianto liittyy. Huomautus Elementin arvoja on kahdessa eri koodistossa. OASIS on määritellyt UN/ECE koodiston "00 Document name code" oletusarvoiseksi koodistoksi. Jos tästä koodistosta ei löydy sopivaa koodia, voidaan käyttää UN/ECE koodistoa 53 Reference qualifier". Koodit UN/ECE koodiston 00 mukaisia koodeja ovat: 05 = (Purchase order) Tilaus 270 = (Delivery note) Valmis-ilmoitus 287 = (Status report) Työn alla ilmoitus 3 = (Request for quote) Tarjouspyyntö 320 = (Acknowledgement of order) Tilauskuittaus 348 = (Order status report) Tilauksen osan valmistumisilmoitus 363 = (Price and delivery quote) Tarjous Code List. Identifier Code List. Agency. Identifier Attached Document. Sender_ Party. Party 6..2 Attached Document. Receiver_ Party. Party UN/ECE koodiston 53 mukaisia koodeja ovat: AJA = (Part reference indicator in a drawing) Massaluettelo Esimerkki <cbc:parentdocumenttypecode listid="un/ece 00" listagencyid="6">270</cbc:parentdocumenttypecode> Attribuutilla annetaan dokumenttitunnuskoodiston tunnus; joko UN/ECE 00 tai UN/ECE 53 Esimerkki listid="un/ece 00" Käytettävät koodit UN/ECE 00 UN/ECE koodisto 00 "Document name code" UN/ECE 53 UN/ECE koodisto 53 "Reference qualifier" Attribuutilla annetaan dokumenttitunnuskoodiston ylläpitäjän tunnus Esimerkki listagencyid="6" Käytettävät koodit 6 UN/ECE (United Nations - Economic Commission for Europe) Toisto.. Party. Details Aggregaatilla annetaan tiedoksiantosanoman lähettäjäorganisaation tiedot. Esimerkki <cac:senderparty> </cac:senderparty> Toisto.. Party. Details 24/56
6..6 Aggregaatilla annetaan tiedoksiantosanoman Attached Document. Attachment 6..0 vastaanottajaorganisaation tiedot. Esimerkki <cac:receiverparty> </cac:receiverparty> Toisto.. Attachment. Details Aggregaatilla annetaan tiedoksiantoon liittyvä ensimmäinen liite. Huomautus Lähetettävien liitetiedostojen koosta partnereitten on sovittava keskenään, jotta tietokoneitten kapasiteetti ei kuormittuisi liikaa sanoman prosessoinnissa. Huomautus Tämä aggregaatti esiintyy vain yhden kerran sanomassa ja sillä voidaan välittää vain yhden liitteen ja Internet-ositteen tiedot. Jos sanomalla on välitettävä useampia liitteitä tai Internet- osoitteita, annetaan ne sanoman laajennusosassa. Huomautus Tämä aggregaatti on sanomassa pakollinen, joten sen on esiinnyttävä aina sanomassa. Jos sanomalla välitetään vain muuttuneen käsittelijän tai vastuuhenkilön tietoja, jotka annetaan laajennusosassa, annetaan tämän aggregaatin ala- aggregaatissa ExternalReference käsittelijän tai vastuuhenkilön organisaation web-osoite. Tällöin sanoman juurisegmentin elementti Attached Document. Document Type Code. Code saa arvon AVP. Esimerkki <cac:attachment> </cac:attachment> 25/56
6..2 Tiedoksiantosanoman lähettäjän tiedot (Attached Document. Sender_ Party. Party) Attached Document. Sender_ Party. Party Party. Mark Care_ Indicator. Indicator Party. Mark Attention_ Indicator. Indicator Party. Website_ URI. Identifier Party. Logo Reference. Identifier Party. Endpoint Identifier. Identifier 0..* 0..* 0.. Party. Party Identification Party. Party Name Party. Language 0.. Party. Postal_ Address. Address 0.. Party. Physical_ Location. Location 0..* Party. Party Tax Scheme 0..* Party. Party Legal Entity 0.. Party. Contact 0.. Party. Person 0.. Party. Agent_ Party. Party Elementti / aggregaatti Attached Document. Sender_ Party. Party Party. Party Identification 6..3 Party. Party Name 6..4 Toistokerrat, tyyppi, kuvaus, esimerkki Toisto.. Party. Details Aggregaatilla annetaan tiedoksiantosanoman lähettäjäorganisaation tiedot. Esimerkki <cac:senderparty> </cac:senderparty> Toisto 0.. unbounded Party Identification. Details Aggregaatilla annetaan tiedoksiantosanoman lähettäjäorganisaation tunnukset, joilla järjestelmät tunnistavat sen automaattisesti siirrettäessä tietoa sähköisesti. Esimerkki <cac:partyidentification> </cac:partyidentification> Toisto 0.. unbounded Party Name. Details Aggregaatilla annetaan tiedoksiantosanoman lähettäjäorganisaation nimitiedot Esimerkki <cac:partyname> </cac:partyname> 26/56
Party. Contact 6..5 Contact. Details Aggregaatilla annetaan tiedoksiantosanoman lähettäjäorganisaation yhteyshenkilön tai -osaston tiedot. Esimerkki <cac:contact> </cac:contact> 27/56
6..3 Tiedoksiantosanoman lähettäjän tunniste (Party. Party Identification) Party. Party Identification Party Identification. Identifier Elementti / aggregaatti Party. Party Identification Party Identification. Identifier Identification Scheme. Identifier Identification Scheme Agency. Identifier Toistokerrat, tyyppi, kuvaus, esimerkki Toisto 0.. unbounded Party Identification. Details Aggregaatilla annetaan tiedoksiantosanoman lähettäjäorganisaation tunnukset, joilla järjestelmät tunnistavat sen automaattisesti siirrettäessä tietoa sähköisesti. Esimerkki <cac:partyidentification> </cac:partyidentification> Toisto.. Identifier. Type Elementillä annetaan tiedoksiantosanoman lähettäjäorganisaation tunnus, jolla tiedoksiantosanoman lähettäjä tunnistetaan partnerin järjestelmissä automaattisesti. Tässä elementissä annettava tunnus voi olla esimerkiksi OVT-tunnus, tilaajan tai toimittajan tunnistekoodiston mukainen tunnus. Attribuutit schemeid ja schemeagencyid Esimerkki <cbc:id schemeid="iso 6523" schemeagencyid="5"> 003723232</cbc:ID> Attribuutilla annetaan osapuolitunnistekoodiston tunnus. Esimerkki schemeid="iso 6523" Käytettävät koodit ISO 6523 OVT- tunnus (Structure for the identification of organizations) Attribuutilla annetaan osapuolitunnuskoodiston ylläpitäjä. Esimerkki schemeagencyid="5" Käytettävät koodit 5 ISO (International Organization for Standardization) 9 (Assigned by seller or seller's agent) Toimittajan ylläpitämä luettelo 92 (Assigned by buyer or buyer's agent) Tilaajan ylläpitämä luettelo 28/56
6..4 Tiedoksiantosanoman lähettäjän nimi (Party. Party Name) Party. Party Name Party Name. Name Elementti / aggregaatti Toistokerrat, tyyppi, kuvaus, esimerkki Party. Party Name Toisto 0.. unbounded Party Name. Details Aggregaatilla annetaan tiedoksiantosanoman lähettäjäorganisaation nimitiedot. Esimerkki <cac:partyname> </cac:partyname> Party Name. Name Toisto.. Name. Type Elementillä annetaan tiedoksiantosanoman lähettäjäorganisaation nimi Esimerkki <cbc:name>asennus Oy</cbc:Name> 29/56
6..5 Tiedoksiantosanoman lähettäjän yhteyshenkilö tai -osasto ja yhteystiedot (Party. Contact) Party. Contact Contact. Identifier Contact. Name Contact. Telephone. Text Contact. Telefax. Text Contact. Electronic_ Mail. Text Contact. Note. Text 0..* Contact. Other_ Communication. Communication Elementti / aggregaatti Party. Contact Toistokerrat, tyyppi, kuvaus, esimerkki Contact. Identifier Contact. Details Aggregaatilla annetaan tiedoksiantosanoman lähettäjäorganisaation yhteyshenkilön tai -osaston tiedot. Esimerkki <cac:contact> </cac:contact> Identifier. Type Elementillä annetaan tiedoksiantosanoman lähettäjäorganisaation yhteyshenkilön tai -osaston tunnus. Huomautus Henkilön tunnuksena suositellaan käytettäväksi henkilön sähköpostiosoitetta. Esimerkki <cbc:id>46</cbc:id> Contact. Name Name. Type Contact. Telephone. Text Contact. Electronic_ Mail. Text Elementillä annetaan tiedoksiantosanoman lähettäjäorganisaation yhteyshenkilön tai -osaston nimi. Esimerkki <cbc:name>tommi Toimittaja</cbc:Name> Text. Type Elementillä annetaan tiedoksiantosanoman lähettäjä- organisaation yhteyshenkilön tai -osaston puhelinnumero. Esimerkki <cbc:telephone>03 22 9898</cbc:Telephone> Text. Type Elementillä annetaan tiedoksiantosanoman lähettäjä- organisaation yhteyshenkilön tai -osaston sähköpostiosoite. Esimerkki <cbc:electronicmail>tommi.toimittaja@asennus.fi </cbc:electronicmail> 30/56
6..6 Tiedoksiantosanoman vastaanottajan tiedot (Attached Document. Receiver_ Party. Party) Attached Document. Receiver_ Party. Party Party. Mark Care_ Indicator. Indicator Party. Mark Attention_ Indicator. Indicator Party. Website_ URI. Identifier Party. Logo Reference. Identifier Party. Endpoint Identifier. Identifier 0..* 0..* 0.. Party. Party Identification Party. Party Name Party. Language 0.. Party. Postal_ Address. Address 0.. Party. Physical_ Location. Location 0..* Party. Party Tax Scheme 0..* Party. Party Legal Entity 0.. Party. Contact 0.. Party. Person 0.. Party. Agent_ Party. Party Elementti / aggregaatti Attached Document. Receiver_ Party. Party Party. Party Identification 6..7 Party. Party Name 6..8 Toistokerrat, tyyppi, kuvaus, esimerkki Toisto.. Party. Details Aggregaatilla annetaan tiedoksiantosanoman vastaanottajaorganisaation tiedot. Esimerkki <cac:receiverparty> </cac:receiverparty> Toisto 0.. unbounded Party Identification. Details Aggregaatilla annetaan tiedoksiantosanoman vastaanottajaorganisaation tunnukset, joilla järjestelmät tunnistavat sen automaattisesti siirrettäessä tietoa sähköisesti. Esimerkki <cac:partyidentification> </cac:partyidentification> Toisto 0.. unbounded Party Name. Details 3/56
Party. Contact 6..9 Aggregaatilla annetaan tiedoksiantosanoman vastaanottajaorganisaation nimitiedot. Esimerkki <cac:partyname> </cac:partyname> Contact. Details Aggregaatilla annetaan tiedoksiantosanoman vastaanottajaorganisaation yhteyshenkilön tai -osaston tiedot. Esimerkki <cac:contact> </cac:contact> 32/56
6..7 Tiedoksiantosanoman vastaanottajan tunniste (Party. Party Identification) Party. Party Identification Party Identification. Identifier Elementti / aggregaatti Party. Party Identification Party Identification. Identifier Identification Scheme. Identifier Identification Scheme Agency. Identifier Toistokerrat, tyyppi, kuvaus, esimerkki Toisto 0.. unbounded Party Identification. Details Aggregaatilla annetaan tiedoksiantosanoman vastaanottajaorganisaation tunnukset, jolla järjestelmät tunnistavat sen automaattisesti siirrettäessä tietoa sähköisesti. Esimerkki <cac:partyidentification> </cac:partyidentification> Toisto.. Identifier. Type Elementillä annetaan tiedoksiantosanoman vastaanottajaorganisaation tunnus, jolla tiedoksiantosanoman vastaanottaja tunnistetaan partnerin järjestelmissä automaattisesti. Tässä elementissä annettava tunnus voi olla esimerkiksi OVT-tunnus, tilaajan tai toimittajan tunnistekoodiston mukainen tunnus. Attribuutit schemeid ja schemeagencyid Esimerkki <cbc:id schemeid="iso 6523" schemeagencyid="5"> 003702345672345</cbc:ID> Attribuutilla annetaan osapuolitunnistekoodiston tunnus Esimerkki schemeid="iso 6523" Käytettävät koodit ISO 6523 OVT- tunnus (Structure for the identification of organizations) Attribuutilla annetaan osapuolitunnuskoodiston ylläpitäjä. Esimerkki schemeagencyid="5" Käytettävät koodit 5 ISO (International Organization for Standardization) 9 (Assigned by seller or seller's agent) Toimittajan ylläpitämä luettelo 92 (Assigned by buyer or buyer's agent) Tilaajan ylläpitämä luettelo 33/56
6..8 Tiedoksiantosanoman vastaanottajan nimi (Party. Party Name) Party. Party Name Party Name. Name Elementti / aggregaatti Toistokerrat, tyyppi, kuvaus, esimerkki Party. Party Name Toisto 0.. unbounded Party Name. Details Aggregaatilla annetaan tiedoksiantosanoman vastaanottajaorganisaation nimitiedot. Esimerkki <cac:partyname> </cac:partyname> Party Name. Name Toisto.. Name. Type Elementillä annetaan tiedoksiantosanoman vastaanottajaorganisaation nimi Esimerkki <cbc:name>oy Sähkö Ab</cbc:Name> 34/56
6..9 Tiedoksiantosanoman vastaanottajaorganisaation yhteyshenkilö tai -osasto ja yhteystiedot (Party. Contact) Party. Contact Contact. Identifier Contact. Name Contact. Telephone. Text Contact. Telefax. Text Contact. Electronic_ Mail. Text Contact. Note. Text 0..* Contact. Other_ Communication. Communication Elementti / aggregaatti Party. Contact Toistokerrat, tyyppi, kuvaus, esimerkki Contact. Identifier Contact. Details Aggregaatilla annetaan tiedoksiantosanoman vastaanottajaorganisaation yhteyshenkilön tai -osaston tiedot. Esimerkki <cac:contact> </cac:contact> Identifier. Type Elementillä annetaan tiedoksiantosanoman vastaanottajaorganisaation yhteyshenkilön tai -osaston tunnus. Huomautus Henkilön tunnuksena suositellaan käytettäväksi henkilön sähköpostiosoitetta. Esimerkki <cbc:id>46</cbc:id> Contact. Name Name. Type Contact. Telephone. Text Contact. Electronic_ Mail. Text Elementillä annetaan tiedoksiantosanoman vastaanottajaorganisaation yhteyshenkilön tai -osaston nimi. Esimerkki <cbc:name>olli Ostaja</cbc:Name> Text. Type Elementillä annetaan tiedoksiantosanoman vastaanottaja- organisaation yhteyshenkilön tai -osaston puhelinnumero. Esimerkki <cbc:telephone>03 234 5678</cbc:Telephone> Text. Type Elementillä annetaan tiedoksiantosanoman vastaanottaja- organisaation yhteyshenkilön tai -osaston sähköpostiosoite. Esimerkki <cbc:electronicmail>olli.ostaja@sahko.fi</cbc:electronicmail> 35/56
6..0 Liitetiedosto (Attached Document. Attachment) Attached Document. Attachment Attachment. Embedded_ Document. Binary Object 0.. Attachment. External Reference Elementti / aggregaatti Attached Document. Attachment Attachment. Embedded_ Document. Binary Object Attachment. External Reference 6.. Toistokerrat, tyyppi, kuvaus, esimerkki Toisto.. Attachment. Details Aggregaatilla annetaan tiedoksiantoon liittyvä liite. Huomautus Lähetettävien liitetiedostojen koosta partnereitten on sovittava keskenään, jotta tietokoneitten kapasiteetti ei kuormittuisi liikaa sanoman prosessoinnissa. Huomautus Tämä aggregaatti esiintyy vain yhden kerran sanomassa ja sillä voidaan välittää vain yhden liitteen ja Internet-ositteen tiedot. Jos sanomalla on välitettävä useampia liitteitä tai Internetosoitteita, annetaan ne sanoman laajennusosassa. Huomautus Tämä aggregaatti on sanomassa pakollinen, joten sen on esiinnyttävä aina sanomassa. Jos sanomalla välitetään vain muuttuneen käsittelijän tai vastuuhenkilön tietoja, jotka annetaan laajennusosassa, annetaan tämän aggregaatin alaaggregaatissa ExternalReference käsittelijän tai vastuuhenkilön organisaation web-osoite. Tällöin sanoman juurisegmentin elementti Attached Document. Document Type Code. Code saa arvon AVP. Esimerkki <cac:attachment> </cac:attachment> Binary Object. Type Elementillä annetaan tiedoksiannon liite sanoman sisäisenä binäärisenä suurena oliona (Binary Large Object eli BLOB). Esimerkki <cbc:embeddeddocumentbinaryobject> liitetiedosto binäärisenä suurena oliona </cbc:embeddeddocumentbinaryobject> External Reference. Details Aggregaatilla annetaan tiedoksiantoon liittyvän liitetiedoston web-osoitetiedot. Esimerkki <cac:externalreference> </cac:externalreference> 36/56
6.. Liitetiedoston web-osoite (Attachment. External Reference) Attachment. External Reference External Reference. URI. Identifier External Reference. Document Hash. Text External Reference. Expiry Date. Date External Reference. Expiry Time. Time Elementti / aggregaatti Attachment. External Reference External Reference. URI. Identifier Toistokerrat, tyyppi, kuvaus, esimerkki External Reference. Details Aggregaatilla annetaan tiedoksiantoon liittyvän liitetiedoston web-osoitetiedot. Esimerkki <cac:externalreference> </cac:externalreference> Identifier. Type Elementillä annetaan tiedoksiannon liitetiedoston web-osoite eli URI (Uniform Resource Identifier) Esimerkki <cbc:uri>www.esimerkit.com/tuoteluettelo/200</cbc:uri> 37/56
6.2 Laajennusosa Sanoman laajennuksessa välitetään tietoja, joita varsinainen UBL-AttachedDocumentsanoma ei pidä sisällään. Tässä laajennuksessa välitettäviä tietoja ovat lukukuittauspyyntö, yhtä liitettä ja Internet-linkkiä useammat liitteet ja linkit sekä muuttuneen kuittaajan tai vastuuhenkilön tiedot. 6.2. Laajennustiedot (Attached Document. UBL Extensions) Attached Document. UBL Extensions.. * UBL Extensions. UBL Extension Elementti / aggregaatti Attached Document. UBL Extensions UBL Extensions. UBL Extension 6.2.2 Toistokerrat, tyyppi, kuvaus, esimerkki UBL Extensions. Details Aggregaatilla annetaan tiedoksiantosanoman laajennustiedot. Esimerkki <ext:ublextensions> </ext:ublextensions> Toisto.. unbounded UBL Extension. Details Aggregaatilla annetaan tiedoksiantosanoman yksittäisen laajennusosan tiedot. Esimerkki <UBLExtension> </UBLExtension> 38/56
6.2.2 Laajennusosan tiedot (UBL Extensions. UBL Extension) UBL Extensions. UBL Extension UBL Extension. Identifier UBL Extension. Name UBL Extension. Extension_ Agency Identifier. Identifier UBL Extension. Extension_ Agency Name. Name UBL Extension. Extension_ Version. Identifier UBL Extension. Extension Agency_ URI. Identifier UBL Extension. Extension_ URI. Identifier UBL Extension. Extension Reason_ Code. Code UBL Extension. Extension_ Reason. Text.. UBL Extension. Extension Content Elementti / aggregaatti UBL Extensions. UBL Extension Toistokerrat, tyyppi, kuvaus, esimerkki Toisto UBL Extension. Identifier UBL Extension. Extension_ Agency Identifier. Identifier Identification Scheme. Identifier.. unbounded UBL Extension. Details Aggregaatilla annetaan tiedoksiantosanoman yksittäisen laajennusosan tiedot. Esimerkki <UBLExtension> </UBLExtension> Identifier. Type Elementillä annetaan laajennuksen tunnus. Tässä vakiosti FI:3 Esimerkki <cbc:id>fi:3</cbc:id> Koodit Extension_ Agency Identifier. Type Elementillä annetaan laajennuksen ylläpitäjän tunnus. Käytettäviä koodeja ovat: 292 = (FI, TIEKE The Information Technology Development Centre of Finland) TIEKE Tietoyhteiskunnan kehittämiskeskus ry Attribuutit schemeid ja schemeagencyid Esimerkki <ExtensionAgencyID schemeid="un/ece 3055" schemeagencyid="6">292</extensionagencyid> Attribuutilla annetaan laajennuksen ylläpitäjäkoodiston tunnus. Esimerkki schemeid="un/ece 3055" Käytettävät koodit Identification Scheme UN/ECE 3055 UN/ECE koodisto 3055 Code list responsible agency code 39/56
Agency. Identifier UBL Extension. Extension_ Agency Name. Name UBL Extension. Extension Content 6.2.3 Attribuutilla annetaan laajennuksen ylläpitäjäkoodiston ylläpitäjä. Esimerkki schemeagencyid="6" Käytettävät koodit 6 UN/ECE (United Nations - Economic Commission for Europe) Extension_ Agency Name. Type Elementillä annetaan laajennuksen ylläpitäjän nimi. Esimerkki <ExtensionAgencyName>TIEKE</ExtensionAgencyName> Toisto.. Extension Content. Details Aggregaatilla annetaan tiedoksiantosanoman yksittäisen laajennusosan tietosisältö. Esimerkki <ExtensionContent> </ExtensionContent> 40/56
6.2.3 Laajennusosan tietosisältö (UBL Extension. Extension Content) UBL Extension. Extension Content 0.. * Extension Content. Attached Document Extension Elementti / aggregaatti UBL Extension. Extension Content Extension Content. Attached Document Extension 6.2.4 Toistokerrat, tyyppi, kuvaus, esimerkki Toisto.. Extension Content. Details Aggregaatilla annetaan tiedoksiantosanoman yksittäisen laajennusosan tietosisältö. Esimerkki <ExtensionContent> </ExtensionContent> Attached Document Extension. Details Aggregaatilla annetaan tiedoksiantosanoman laajennusosan tiedot. Esimerkki <tieke:attacheddocumentextension> </tieke:attacheddocumentextension> 4/56
6.2.4 Laajennusosan tiedot (Extension Content. Attached Document Extension) Extension Content. Attached Document Extension 0.. Attached Document Extension. Response 0.. * 0.. * Attached Document Extension. Documen Reference Attached Document Extension. Person Elementti / aggregaatti Extension Content. Attached Document Extension Attached Document Extension. Response 6.2.5 Attached Document Extension. Document Reference 6.2.6 Attached Document Extension. Person 6.2.9 Toistokerrat, tyyppi, kuvaus, esimerkki Attached Document Extension. Details Aggregaatilla annetaan tiedoksiantosanoman laajennusosan tiedot. Esimerkki <tieke:attacheddocumentextension> </tieke:attacheddocumentextension> Response. Details Aggregaatilla annetaan tiedoksiantosanoman kuittauspyynnön tiedot. Esimerkki <cac:response> </cac:response> Toisto 0.. unbounded Document Reference. Details Aggregaatilla annetaan tiedoksiantosanomaan liittyvät yhtä useammat liitteet. Esimerkki <cac:documentreference> </cac:documentreference> Toisto 0.. unbounded Person. Details Aggregaatilla annetaan hankkeen muuttuneen käsittelijän tai vastuuhenkilön tiedot. Esimerkki <cac:person> </cac:person> 42/56
6.2.5 Kuittauspyyntö (Attached Document Extension. Response) Credit Attached Note Line. Document Discrepancy_ Extension. Response. Response Response Response. Reference. Identifier Response. Response Code. Code Response. Description. Text Elementti / aggregaatti Attached Document Extension. Response Response. Reference. Identifier Identification Scheme. Identifier Identification Scheme Agency. Identifier Response. Response Code. Code Toistokerrat, tyyppi, kuvaus, esimerkki Response. Details Aggregaatilla annetaan tiedoksiantosanoman kuittauspyynnön tiedot. Esimerkki <cac:response > </cac:response> Toisto.. Identifier. Type Elementillä ilmoitetaan kuittaamisen laajuus. Koodit UN/ECE koodiston 049 mukainen koodi: 5 = (Multiple sections) Koko sanoma Attribuutit schemeid ja schemeagencyid Esimerkki <cbc:referenceid schemeid="iso 049" schemeagencyid="6">5</cbc:referenceid> Attribuutilla annetaan sanoman osakoodiston tunnus Esimerkki schemeid="un/ece 049" Käytettävät koodit UN/ECE 049 UN/ECE koodisto 049 Message section code Attribuutilla annetaan sanoman osakoodiston ylläpitäjä. Esimerkki schemeagencyid="6" Käytettävät koodit 6 UN/ECE (United Nations - Economic Commission for Europe) Code. Type Elementillä annetaan vastaanoton kuittauksen tyyppi. Koodit = (Acknowledgement requested) Sekä vastaanottokuittaus että sovellustason kuittaus 2 = (Indication of receipt) Vain vastaanottokuittaus 43/56
Country Identification_ Code List. Identifier Country Identification_ Code List. Agency. Identifier Attribuutit listid ja listagencyid Esimerkki <cbc:responsecode listid= UN/ECE 003" listagencyid="6"></cbc:responsecode> Oletus UN/ECE 003 Attribuutilla ilmoitetaan kuittauksen tyyppi. Esimerkki schemeid="un/ece 003" Käytettävät koodit UN/ECE 003 UN/ECE koodisto 003 Acknowledgement request Oletus 6 Attribuutilla annetaan kuittaustyyppikoodiston ylläpitäjä. Esimerkki listagencyid="6" Käytettävät koodit 6 UN/ECE (United Nations - Economic Commission for Europe) 44/56