¶ bSDD-pelisäännöt
Julkaisupäivä: 10.4.2026
bSDD-pelisäännöt on toteutettu osana InfraBIM-nimikkeistön päivitys ja bSDD-pelisäännöt -projektia. Lisätietoa projektista ja tuloksista projektin artikkelista.
PÄÄKÄSITTEET
| Active (status / tila) | Virallisesti julkaistun sisällön tila bSDD-järjestelmässä. ”Active”-statuksella oleva sisältö on käynyt läpi tarkastus- ja hyväksyntäprosessit, jolloin sisältö on turvallisesti hyödynnettävissä. |
| API (ohjelmistorajapinta) | Ohjelmistotekninen rajapinta, jonka avulla bSDD:hen tallennettua tietoa voidaan hakea ja hyödyntää automaattisesti muissa ohjelmistoissa ja digitaalisissa prosesseissa. |
| bSDD (buildingSMART Data Dictionary) | buildingSMART Internationalin ylläpitämä verkkopohjainen järjestelmä, jonka avulla voidaan kuvata, määrittää ja digitaalisesti jakaa erilaisia rakennetun ympäristön tietokirjastoja ja -kokonaisuuksia. |
| Data Dictionary |
Virallinen suomennos puuttuu, eri lähteissä käytettyjä nimityksiä ovat: Datakirjasto / vaatimuskirjasto / tietokirjasto, -pankki tai -kokonaisuus. Tässä raportissa Data dictioaryllä tarkoitetaan bSDD:n sisältämää tietokirjastoa tai -kokonaisuutta, jolla kuvataan ja määritetään jotakin tiettyä rakennetun ympäristön osa-aluetta, esim. nimikkeistöä tai rakenteiden ominaisuustietoja. |
| Domain | bSDD:n ”hallintataso”, jonka sisällä organisaatio hallitsee ja julkaisee omia Data dictionary-sisältöjään. Osa domainin tiedoista, kuten organisaation tunniste (URL) periytyy kaikkeen organisaation jakamaan sisältöön. |
| JSON-siirtotiedosto | bSI:n määrittelemä JSON-formaattiin pohjautuva tiedonsiirtoformaatti, jolla sisältöä viedään bSDD-järjestelmään. JSON-siirtotiedosto voidaan ladata järjestelmään bSDD:n hallintapaneelin tai API-ohjelmistorajapinnan kautta. |
| Julkaisuympäristö | bSDD:n julkaisuympäristö, jossa hyväksytty ja ”Active”-statuksella julkaistu sisältö on turvallisesti eri osapuolten hyödynnettävissä. |
| Preview (status / tila) | Sisältö, joka on julkaisuympäristössä jo haettavissa ja tarkasteltavissa, mutta ei vielä ole saanut virallista hyväksyntää. |
| Testiympäristö | bSDD:n erillinen testiympäristö, jossa sisältöä voidaan testata ja tarkastella ennen sen virallista julkaisua julkaisuympäristössä. |
¶ Johdanto
Tämän ohjeen tarkoituksena on kuvata yhteiset periaatteet ja toimintamallit, joiden avulla buildingSMART Finlandin (bSF) hankkeissa tuotettua sisältöä voidaan viedä ja hallita bSDD järjestelmässä. Ohje tarjoaa yleisen tason menettelytavat, jotka varmistavat, että sisällön siirtäminen järjestelmään tapahtuu yhdenmukaisesti ja laadukkaasti. Vakioidut toimintamallit ohjaavat laadukkaan sisällön tuottamiseen ja tukevat sisällön systemaattista ylläpitoa ja varmistavat, että bSDD:n kautta julkaistu tieto on selkeää, luotettavaa ja laajasti hyödynnettävissä.
Ohjeessa määritellään sisällön vientiprosessi, käyttöoikeudet ja roolit, sisällön päivittäminen sekä versionhallinnan periaatteet. Lisäksi ohje kuvaa vakioidun toimintamallin sille, kuinka tiedonsiirto bSDD-järjestelmään toteutetaan bSF:n projekteissa vakiomuotoisen Excel-pohjan ja Python skriptin avulla. Excel-pohja varmistaa, että tuotettu sisältö säilyy rakenteellisessa ja koneellisesti luettavassa muodossa, mikä mahdollistaa tiedon hyödyntämisen tulevaisuudessa myös muissa palveluissa ja julkaisualustoissa.
Koska bSDD järjestelmän käyttöönotto ja käyttö on Suomessa vielä alkuvaiheessa, eikä vakiintuneita toimintatapoja tai -malleja vielä ole, tätä ohjetta päivitetään aktiivisesti toimintatapojen vakiintuessa ja muun alaan liittyvän määritys- ja vakiointityön, kuten luokittelu- ja nimikkeistöjärjestelmien, tarkentuessa.
¶ Mikä on bSDD?
BuildingSMART Data Dictionary (bSDD) on BuildingSMART Internationalin kehittämä ja ylläpitämä verkkopohjainen tietokanta. Se muodostuu toisiinsa linkitetyistä / linkitettävissä olevista ”digitaalisista tietokirjastoista”, joilla kuvataan ja määritetään erilaisia rakennetun ympäristön tietokokonaisuuksia. bSDD pohjautuu ISO 12006-3 ja ISO 23386 standardeihin.
bSDD:ssä oleva tieto on helposti haettavissa ja tarkasteltavissa Web-käyttöliittymän kautta. Järjestelmän suurin potentiaali on kuitenkin sen tarjoamissa API-ohjelmistorajapinnoissa. Ohjelmistorajapinnat mahdollistavat järjestelmän sisältämän tiedon monipuolisen hyödyntämisen, esimerkiksi suunnittelu- tai tarkastusprosessien automatisoinnissa. BSDD-järjestelmää ja sen sisältämää tietoa voidaan hyödyntää esim. tietosisältöjen hakemisessa ja tarkastelussa, tietomallien tietosisältöjen rikastamisessa, tiedon tarkastamisessa ja validoinnissa, sekä erilaisten prosessien ja tietovirtojen, kuten suunnittelun tai luovutusaineiston tarkastamisen automatisoinnissa
BSDD-järjestelmän rooli on toimia tietokokonaisuuksien ja näitä ohjaavien määritysten digitaalisena jakokanavana. Järjestelmässä itsessään ei pystytä luomaan tai hallitsemaan tietosisältövaatimuksia, jonka takia järjestelmässä jaettavan tiedon hallinta ja ylläpito toteutetaan jossain toisessa alustassa, josta tietosisältövaatimukset viedään bSDD-järjestelmään joko JSON-siirtotiedostoina tai ohjelmistorajapinnan avulla.
Järjestelmän sisällä tieto on linkitettävissä keskenään, joka mahdollistaa rikkaiden ja monimuotoisten tietokokonaisuuksien luomisen. Esim. mahdollisuus linkittää tuotettua tietoa IFC-määrityksiin tukee osaltaan IFC-formaatin käyttöönottoa, sekä ohjaa laadukkaamman IFC-muotoisen luovutusaineiston laadintaa
¶ Omistajuus ja toimintamallit
¶ Käyttöoikeudet ja vastuut
Käyttöoikeuksien hallinnan keskeinen tavoite on varmistaa, että bSDD:hen vietävä sisältö on laadukasta ja että järjestelmään luotavat tietorakenteet pysyvät selkeinä ja johdonmukaisina.
bSDD:n käyttöoikeudet ja vastuut jaetaan kahteen eri kokonaisuuteen:
Domainin ylläpito ja hallinta (ADMIN oikeudet)
Rakennustietomalli Oy vastaa käyttöoikeuksien hallinnasta ja bSF:n bSDD Domainin ylläpidosta. Tällä hetkellä oikeuksia hallitsee ja myöntää Martin French (martin.french@rakennustietomalli.fi). Rakennustietomalli Oy:n vastuulla on myös tarvittavien pääkäyttöliittymän muutosten hallinta ja oikeuksien koordinointi.
Sisällöntuottajat
Sisällön luomisesta vastaavat projektiryhmät ja niiden jäsenet. Mikäli projektin tuotokset on tarkoitus viedä bSDD:hen, projektiryhmän jäsenille myönnetään tilapäiset oikeudet kyseisen projektin ajaksi. Oikeudet haetaan sähköpostitse Rakennustietomallilta projektin alussa. Näin varmistetaan, että sisällön muokkaajat ovat vastuullisia ja perehdytettyjä.
¶ Aineiston vienti bSDD-järjestelmään
bSDD-järjestelmän rooli on toimia erilaisten tietokokonaisuuksien ja näitä ohjaavien määritysten digitaalisena jakokanavana, eikä näitä pystytä järjestelmässä itsessään luomaan tai hallitsemaan. Tämän takia bSDD:ssä jaettavan tiedon hallinta ja ylläpito toteutetaan aina jossain toisessa alustassa tai ohjelmistossa, josta sisältö viedään bSDD-järjestelmään joko bSDD JSON-siirtotiedostona tai API-ohjelmistorajapinnan kautta, mikäli käytetystä ohjelmistosta löytyy tätä tukeva toiminnallisuus.
Tavoitetilassa sisällön vienti bSDD:hen toteutettaisiin täysin automatisoidusti, esimerkiksi suoraan sähköisestä julkaisualustasta ohjelmistorajapinnan kautta. buildingSMART Finlandilla ei kuitenkaan toistaiseksi ole käytössä ohjelmistoa, joka mahdollistaisi tällaisen suoran integraation. Tämän takia sisällön vieminen bSDD-järjestelmään toteutetaan vakioidun Excel-pohjan ja Python scriptin avulla, joka mahdollistaa yhdenmukaisen ja vakioidun menetelmän bSDD JSON-siirtotiedostojen tuottamiseen. Excel-pohjalla varmistetaan myös se, että tuotettu sisältö säilyy vakioidussa ja koneluettavassa muodossa, mikä mahdollistaa sisällön hyödyntämisen myös tulevissa järjestelmissä ja julkaisualustoissa.
Sisällön vienti bSDD järjestelmään etenee seuraavasti:
- Projekti muuntaa projektissa tuotetun sisällön ohjeistuksen mukaisesti bSF:n vakioituun Excel pohjaan.
- Excel tiedosto muunnetaan Python skriptin avulla JSON siirtotiedostoksi. Muunnoksen voi tehdä joko projektille nimetty vastuuhenkilö tai Rakennustietomallin bSDD vastaava.
- Luotu JSON tiedosto viedään bSDD järjestelmään järjestelmän hallintapaneelin kautta. Viennin toteuttaa joko projektille nimetty vastuuhenkilö tai Rakennustietomallin bSDD vastaava.
- Sekä Excel lähdetiedosto että tuotettu JSON tallennetaan projektin lopputuotteisiin arkistointia ja myöhempää käyttöä varten.
Excel pohja ja Python skriptin ohjeet löytyvät seuraavista osoitteista:
- bSF:n bSDD Excel pohja:
https://drive.buildingsmart.fi/s/HrzaPakzrp9HmR4 - Python skripti ja käyttöohjeet:
https://github.com/buildingSMART/bSDD/tree/master/Model/Import Model/spreadsheet-import
¶ Sisällön julkaisu ja bSDD-testiympäristö
bSDD järjestelmässä julkaistavan sisällön laadun ja rakenteellisen oikeellisuuden varmistamiseksi aineisto viedään lähtökohtaisesti aina ensin bSDD:n testiympäristöön. Testiympäristön käyttö vähentää riskiä siitä, että virheellistä tai keskeneräistä sisältöä julkaistaisiin julkaisuympäristöön, jossa se olisi käyttäjien ja järjestelmäintegraatioiden hyödynnettävissä. Testiympäristö mahdollistaa myös vapaamman kokeilun ja sisällön teknisen toimivuuden arvioinnin ilman julkaisupaineita.
Jos projektissa erikseen sovitaan, ja tarvittavat laadunvarmistus- ja hyväksyntäprosessit on tehty, aineisto voidaan poikkeuksellisesti julkaista suoraan julkaisuympäristössä. Tällaiset tilanteet käsitellään aina projektikohtaisesti ja yhteistyössä Rakennustietomallin kanssa.
Sisällön julkaiseminen bSDD:ssä etenee seuraavan menettelytavan mukaisesti:
- Ensimmäinen julkaisu testiympäristöön.
Ellei muuta ole sovittu, sisältö julkaistaan aina ensin bSDD:n testiympäristössä projektiryhmän vastuuhenkilön toimesta. Julkaisu tehdään Preview-statuksella. Näin varmistetaan, että järjestelmään viety sisältö on tavoitellun mukaista eikä sisällä virheitä. Viennin yhteydessä voidaan bSDD:n hallintapaneelissa asettaa päälle valinta ”Validate only”, jolloin järjestelmä validoi siirtotiedoston oikeellisuuden ilman että sisältö viedään järjestelmään.
- Tarkistus ja siirto julkaisuympäristöön.
Kun testiympäristössä on todettu, että aineisto on teknisesti ja sisällöllisesti oikein, se julkaistaan bSDD:n julkaisuympäristössä työ-/projektiryhmän vastuuhenkilön toimesta. Myös julkaisuympäristössä sisältö julkaistaan aina ensin Preview-statuksella.
- Lopullinen hyväksyntä ja statuksen muuttaminen Active tilaan.
Kun sisältö on viety julkaisuympäristöön ”Preview”-statuksella, sisältö käy läpi bSF:n edellyttämät laadunvarmistustoimenpiteet, kuten toimikuntien hyväksynnät ja mahdolliset kommentointikierrokset. Kun sisältö on läpäissyt tarvittavat laadunvarmistustoimenpiteet, Rakennustietomallin vastuutettu henkilö muuttaa sisällön statuksen Active-tilaan. Tästä hetkestä alkaen julkaisu on virallinen ja turvallisesti hyödynnettävissä.
Testi- ja julkaisuympäristöihin kirjaudutaan seuraavista osoitteista:
-
bSDD:n testiympäristön hallintapaneeli:
https://manage-test.bsdd.buildingsmart.org/domainupload -
bSDD:n julkaisuympäristön hallintapaneeli:
https://manage.bsdd.buildingsmart.org/
Tämä julkaisu- ja hyväksymismalli varmistaa, että bSF:n bSDD sisällöt ovat laadukkaita, teknisesti oikein muodostettuja ja selkeästi jäljitettävissä ennen niiden käyttöönottoa tuotannossa.
¶ Versionhallinta ja sisällön jäljitettävyys
Koska bSDD ei tarjoa varsinaisia työkaluja sisällön versiointiin tai hallintaan, toteutetaan bSDD:ssä jaettavan aineiston versionhallinta muualla kuin itse järjestelmässä. Järjestelmä toimii lähtökohtaisesti julkaisualustana, ei sisällöntuotannon tai ylläpidon alustana. Sisällön luotettavuuden, laadun sekä jäljitettävyyden kannalta on kuitenkin olennaista, että versiointi on toteutettu johdonmukaisesti ja että käyttäjät ymmärtävät versionhallinnan periaatteet.
Sisällön versiointi ja julkaiseminen bSF:n bSDD domainissa noudattaa seuraavia periaatteita:
bSDD:n sisäinen versiotieto (DictionaryVersion).
- Jokaiselle julkaistavalle kokonaisuudelle annetaan bSDD:n sisäinen versionumero. Versionumero noudattaa bSDD määrityksissä kuvattuja periaatteita. Esimerkiksi InfraBIM nimikkeistön viimeisin järjestelmään julkaistu versio on 1.72. Versionumero toimii ensisijaisena tunnisteena, kun halutaan varmistaa, mitä versiota käyttäjä hyödyntää.
Julkaisun status (Status).
- Uusi sisältö julkaistaan aluksi aina Preview-statuksella. Tällä varmistetaan, että sisältö voidaan arvioida ja tarkistaa ennen sen lopullista käyttöönottoa. Kun sisältö on läpikäynyt laadunvarmistuksen, kommentointikierrokset ja tarvittavat hyväksynnät, Rakennustietomalli muuttaa sen statuksen Active-tilaan. Näin varmistetaan, että aktiivisena näkyvä sisältö on laadullisesti hyväksyttyä.
Julkaisupäivämäärä (ReleaseDate).
- bSDD luo sisällölle automaattisesti julkaisupäivän sen hetkellä, kun aineisto viedään järjestelmään. Julkaisupäivämäärä toimii versionhallinnan täydentävänä tietona ja auttaa jäljittämään historiatietoja erityisesti tilanteissa, joissa versiot ovat lähellä toisiaan tai sisällössä on tehty pieniä päivityksiä.
Versiointia ja bSDD:n sisällön jäljitettävyyttä tukee lisäksi yhtenäinen ohjeistus siitä, miten bSDD:ssä julkaistuun sisältöön viitataan ja miten järjestelmässä julkaistu sisältö näkyy muissa bSF:n kanavissa.
-
Jos bSDD:ssä julkaistavalla sisällöllä on omat sivut esim. buildingSMART Finlandin Wikissä, lisätään bSDD-sisältöön viittaus kyseiseen sivustoon bSDD JSON määrityksen mukaisen MoreInfoUrl-tietueen avulla. Esimerkiksi InfraBIM nimikkeistössä viitataan Wikin ”Julkaisut ja standardit: 08 InfraBIM nimikkeistö” -sivustoon.
-
Vastaavasti, jos esim. Wikissä on bSDD sisällölle oma sivu, lisätään sivustolle linkki kyseiseen bSDD-julkaisuun. Linkitys toteutetaan bSDD Dictionaryn URL-tunnisteella.
-
Jos bSDD:ssä julkaistaan sisältöä jostakin muusta dokumentista, ohjeesta tai määrittelystä, lisätään kyseiseen dokumenttiin tai ohjeeseen viittaus bSDD:n sisältämään Data dictionaryyn, jossa dokumentin tai ohjeen sisältöä on julkaistu. Linkitys toteutetaan bSDD:n Data dictionaryn URL-tunnisteella.
Näiden toimintaperiaatteiden avulla on tarkoitus rakentaa selkeä, läpinäkyvä ja jäljitettävä toimintamalli ja linkitys eri muodossa julkaistun sisällön välillä.
HUOM! Viittauslähteiden päivittyessä, esim. Wiki-sivun URL-osoitteen muuttuessa, tulee bSDD sisällössä esitetyt viittaukset päivittää manuaalisesti bSDD-järjestelmään. Muutosten seurannasta ja viittausten päivittämisestä vastaa Rakennustietomallin bSDD-vastaava.
¶ Ongelmatilanteet, tuki ja palaute
-
buildingSMART Finlandin bSDD Domainista ja sen käyttöoikeuksista, sekä bSF:n sisällön julkaisusta bSDD:ssä vastaa Martin French (martin.french@rakennustietomalli.fi)
-
bSDD-järjestelmästä ja sen toiminnasta, sekä Excel > JSON Python scriptistä vastaa buildingSMART International. Tiedustelut ja tukipyynnöt tapahtuvat seuraavan väylän kautta: https://share.hsforms.com/1RtgbtGyIQpCd7Cdwt2l67A2wx5h
¶ DATA DICTIONARYJEN LUOMISPERIAATTEET
Tässä kappaleessa kuvataan buildingSMART Finlandin bSDD Data dictionaryjen yleiset luomisperiaatteet ja säännöt. Näiden periaatteiden tarkoituksena on varmistaa, että bSDD:hen vietävä sisältö muodostaa rakenteeltaan johdonmukaisen, helposti ymmärrettävän ja tehokkaasti hyödynnettävän kokonaisuuden. Yhtenäiset käytännöt tukevat tiedon löydettävyyttä, mahdollistavat johdonmukaisen tiedonhallinnan sekä ehkäisevät rakenteellista hajanaisuutta.
Kappaleessa käsitellään:
- Data dictionaryjen jaottelua ja rakennetta
- Data dictionaryjen nimeämisperiaatteita
- Pakollisia tietoja, jotka kaikkien Data dictionaryjen tulee sisältää
HUOM! Nämä periaatteet kehittyvät ajan myötä, ja ohjetta päivitetään sitä mukaa kuin bSDD:n hyödyntäminen, tietosisältöjen hallintamallit ja alan yleiset käytännöt tarkentuvat.
¶ Data dictionaryjen jaottelu ja rakenne
Data dictionaryt muodostavat bSDD:ssä puumaisen ja hierarkkisen tietorakenteen. Jaottelu vaikuttaa suoraan siihen, miten sisältö järjestelmässä löytyy, miten sitä voidaan tarkastella sekä kuinka tehokkaasti sisältö on hyödynnettävissä esim. automatisoiduissa prosesseissa. Looginen, selkeästi jäsennelty rakenne on keskeinen osa bSDD:n käytettävyyttä.
Koska järjestelmän rakenteella on suuri vaikutus tiedon hyödynnettävyyteen, rakenteen tulee olla johdonmukainen ja perustua mahdollisuuksien mukaan vakiintuneisiin alan toimintatapoihin, kuten luokittelujärjestelmiin. Jos Data dictionaryjen rakennetta ei ohjata, riskinä on epälooginen, pirstaleinen ja vaikeasti löydettävä tieto.
Ohjeen kirjoitushetkellä ei ollut edellytyksiä määrittää tarkkaa tai pysyvää rakennetta bSF:n Data dictionary kokonaisuudelle. Tarve on kuitenkin tunnistettu kriittiseksi ja rakenteet määritellään tarkemmin sitä mukaa kuin toimintamallit ja alan käytännöt kehittyvät.
Data dictionaryjen luomisessa tulee aina huomioida seuraavat periaatteet:
- Data dictionaryjen tulee muodostaa looginen kokonaisrakenne.
- Uudet Data dictionaryt tulee sijoittaa osaksi olemassa olevaa rakennetta niin, että kokonaisuus pysyy ymmärrettävänä. Esimerkkejä selkeistä rakenteista ovat ”Infra > Suunnittelu > Rakenteet” tai ”Nimikkeistöt > InfraBIM nimikkeistö”.
- Yhden tietorakennetason sisällön tulee muodostaa selkeä kokonaisuus.
- Esimerkiksi infran rakenteet tulisi olla yhdessä loogisessa kokonaisuudessa, jotta sisältö on hyödynnettävissä ilman tarpeetonta hajautumista.
- Monoliittisten tai pirstaleisten Data dictionaryjen luomista tulisi välttää.
- Liian laajat Data dictionaryt heikentävät löydettävyyttä, kun taas liian pienet tai hajanaiset Data dictionaryt vaikeuttavat kokonaisuuden hahmottamista.
- Ylimpien tietorakennetasojen tulee olla geneerisiä.
- Tämä mahdollistaa sen, että uusia aihealueita voidaan joustavasti lisätä ilman, että kokonaisrakenne hajoaa tai menettää loogisuuttaan.
- Uusien Data dictionaryjen rakenne suunnitellaan aina projektiryhmässä.
- Uusista Data dictionaryistä sovitaan ennen sisällön vientiä bSDD:hen ja niiden luominen edellyttää Rakennustietomallin vastuuhenkilön hyväksyntää. Näin varmistetaan, että rakenne pysyy yhtenäisenä ennen kuin kattava ohjeistus valmistuu.
¶ Data dictionaryjen nimeäminen
Data dictionaryjen nimillä on keskeinen rooli sekä tietorakenteen selkeydessä että sisällön löydettävyydessä. Nimen tulee tukea loogista hierarkiaa ja auttaa käyttäjää ymmärtämään, mitä ja minkä tyyppistä tietoa kyseinen Data dictionary sisältää.
Nimeämisessä noudatetaan seuraavia periaatteita:
- Nimen tulee perustua alan yleisiin käsitteisiin ja käytäntöihin.
- Tämä helpottaa tiedon tulkintaa ja vähentää epäselvyyksiä eri organisaatioiden välillä.
- Kaikki bSF:n julkaisemien Data dictionaryjen nimet alkavat tunnisteella ”bs-finland”.
- Esimerkiksi bs-finland-InfraBIM-Nimikkeisto. Tämä auttaa erottamaan bSF:n sisällöt muiden organisaatioiden julkaisemasta sisällöstä.
- Data dictionaryjen nimet sovitaan aina projektiryhmässä etukäteen.
- Ennen sisällön viemistä bSDD:hen Data dictionaryn nimi hyväksytään Rakennustietomallin vastuuhenkilön toimesta. Näin varmistetaan yhdenmukaisuus yli projektien ja vähennetään päällekkäisten nimeämisten riskiä.
- Nimeämisessä noudatetaan bSDD:n nimeämiskäytäntöjä ja määrityksiä.
- Esim. erotin merkkinä käytetään ”-” (väliviiva) symbolia.
¶ Kaikkien Dictionaryjen yhteiset pakolliset tiedot
buildingSMART Finlandin bSDD sisällölle annettavat Data dictionary-tason yhteiset ja pakolliset tiedot ovat seuraavat:
| Organisaatiotunnus (OrganizationCode) |
”bs-finland” |
| Data dictionaryn tunnus (DictionaryCode) |
Data dictionaryn uniikki tunnus, sovitaan ennen sisällön vientiä järjestelmään, aina ”bs-finland” alkuinen |
| Data dictionaryn nimi (DictionaryName) |
Data dictionaryn nimi, sovitaan ennen sisällön vientiä järjestelmään |
| Data dictionaryn versio (DictionaryVersion) |
Data Dictionaryn versio, esim. viimeisin InfraBIM-nimikkeistö: 1.72 |
| Kielitunnus (LanguageIsoCode) |
Järjestelmään vietävän sisällön ISO mukainen kielikoodi, oletuksena: ”fi-FI” |
| Kyseessä kielikäännös (LanguageOnly) |
Tieto siitä onko kyseessä pelkkä kielikäännös (sisältö itsessään pysyy samana), pelkällä suomen kielellä sisältö ensi kertaa järjestelmään vietäessä ”False”. |
| Oma URI tunnus (UseOwnUri) |
Annetaan arvo ”False” |
| Palautekanava (ChangeRequestEmailAddress) |
Sposti palautteelle/muutospyynnöille ”martin.french@rakennustietomalli.fi” |
| Lisätiedot / viittaus (MoreInfoUri) |
URl viitaus, jos sisällöllä oma bSF Wiki sivu, esim. ” https://wiki.buildingsmart.fi/fi/04_Julkaisut_ja_Standardit/infrabim_nimikkeisto” |
| Julkaisupäivämäärä (ReleaseDate) |
Data dictionaryn julkaisupäivämäärä |
| Status (Status) |
Data dictionaryn statustieto, sisältö viedään aina järjestelmään ”Preview” statuksella |
Edellä esitettyjen Data dictionary-tason yhteisten ja pakollisten tietojen lisäksi, bSDD:ssä julkaistavan sisällön osalta tulee noudattaa seuraavaa:
- Muun sisällön, kuten luokitteluiden (Class), ominaisuustietojen (Property ja ClassProperty) ja arvojoukkojen / sallittujen arvojen (AllowedValue) osalta noudatetaan sitä, mitä bSDD JSON Import Modelissa on näistä määritetty esim. pakollisten tietojen osalta.
- Määritysten käyttöä (esim. pakolliset tiedot) pyritään ohjeistamaan tulevaisuudessa tarkemmin bSDD-järjestelmän käytöstä satujen kokemusten pohjalta ja alan toimintamallien kehittyessä.
- Määrityksiä tulee kuitenkin pyrkiä hyödyntämään siten ja siinä laajuudessa, että bSDD-järjestelmään viety sisältö palvelisi tarkoitustaan mahdollisimman hyvin. Tämä tarkoittaa esim. sitä, että bSDD:n sisältöön sisällytetään enemmän tietoa, kuin Import Modelissa on määritetty pakolliseksi. Tämän takia, bSDD-järjestelmään vietävän sisällön laajuutta ja määrityksiä tulee tarkastella projektikohtaisesti ennen kuin kattavampaa ohjeistusta on saatavilla.
- Jos bSDD-järjestelmään vietävälle sisällölle, kuten esim. luokitteluille tai ominaisuustiedolla löytyy vastaavia määrityksiä esim. alan standardeista, tulee nämä relaatiot pyrkiä aina kuvaamaan myös bSDD sisällössä. Tällä edesautetaan tiedon ymmärrettävyyttä ja mahdollistetaan rakennetun ympäristön eri osa-alueiden ja kokonaisuuksien, sekä erilaisten standardien ja luokittelujärjestelmien yhteen linkittäminen ja kuvaaminen.
- Esimerkki relaatiosta voi olla esim. ominaisuustiedon linkittäminen IFC standardiin, jolla voidaan tukea ja ohjata IFC-muotoisen aineiston tuotantoa tulevaisuudessa.
Linkki bSDD:n JSON määritykseen /Import Model) https://github.com/buildingSMART/bSDD/blob/master/Documentation/bSDD JSON import model.md.
¶ ESIMERKKI: INFRABIM NIMIKKEISTÖ
Kuva 1. Kuvakaappaus bSF:n bSDD > JSON Excel-taulukon ”Dictionary”-välilehdestä. Kuvassa on esitetty InfraBIM-nimikkeistön Data dictionary-tason tiedot. Pakolliset tiedot ovat, kuten Data dictionaryn versionumero ja yhteystiedot ovat ilmaistu ”Required” tietokentällä.
Kuva 2. Kuvakaappaus bSF:n bSDD > JSON Excel-taulukon ”Class” (luokittelut) välilehdestä. Kuvassa esitetään kuinka yksittäiset nimikkeet (Name / ClassType) ja nimikkeistörakenne (ParentClassCode) on taulukossa esitetty. Pakolliset tiedot ovat ilmaistu ”Required” tietokentällä.
Kuva 3. Kuvakaappaus Python scriptistä komentorivin (Command Prompt) kautta ajettuna. Komento muodostuu viidestä eri osasta:
- Ensimmäisessä osassa scripti (Excel2bSDD_converter.py) ajetaan sijainnista (c:\bSDD).
- Toisessa komennon osassa kerrotaan missä bSDD Excel-taulukko sijaitsee ja viitataan taulukkon nimeen.
- Kolmannessa osassa kerrotaan missä muuntamiseen käytetty JSON-määritystiedosto sijaitsee ja viitataan tiedoston nimeen.
- Neljännessä osassa kerrotaan mihin tiedosto tallennetaan ja minkä nimisenä (InfraBIM_172.json)
- Viides osa ”True” kertoo, että scripti luo ns. pelkistetyn JSON-siirtotiedoston, joka ei sisällä tyhjiä tietokenttiä.
Kuva 4. Kuvakaappaus JSON-siirtotiedoston dictionary-tason tiedoista tekstieditorissa tarkasteltuna.
Kuva 5. Kuvakaappaus bSDD:n hallintasivustosta. Hallintapaneeli jakautuu kahteen osioon:
- Ylemmässä ”Dictionaries” osiossa näkyy kaikki Data dictionaryt, joita bSF:n domain sisältää, tässä tapauksessa domain sisältää yhden ”InfraBIM-nimikkeisto” nimisen Data dictionaryn ja sen kaksi eri versiota. ”Version actions” alta löytyy toiminnot esim. Data dictionaryn poistamiseen tai sisällön lataamiseksi järjestelmästä JSON-formaatissa.
- Hallintapaneelin alempi ”Upload dictionary for buildingSMART Finland” osio on se, jossa itse sisällön vienti järjestelmään tapahtuu. Järjestelmään ladattava bSDD JSON siirtotiedosto valitaan ”Select file” painikkeesta. ”Validate only” valinnalla järjestelmä validoi JSON-siirtotiedoston oikeellisuuden ilman, että sisältö ladataan itse järjestelmään. Jos sisällön oikeellisuus on varmistettu, valitaan ”Upload selected file”, jolloin sisältö julkaistaan bSDD:ssä.