GS: UC: Juhtimislaua kuvamine

Juhtimislaua nimetus päises.

GS: DashboardDefinition: API: GET /dashboard-api/dashboards/{dashboardId}.response.name

• Alateemad on kuvatud, kui esimese taseme juhtimislaua komponendi sees on teise taseme sektsioon. Kui esimese taseme sektsiooni sees puudub alateema, siis alateemasid ei kuvata.
  • Eksisteerib GS: DashboardDefinitionSection: API: GET /dashboard-api/dashboards/{dashboardId}/sections objekt, mille id = GS: DashboardDefinitionSection: API: GET /dashboard-api/dashboards/{dashboardId}/components-order.response.components.id ja components.type = SECTION ja components.level = 2 ja mis asub esimese taseme sektsiooni sees.
• Alateemad on järjestatud juhtimislaua komponentide järjekorra alusel kasvavas järjekorras.
  • GS: DashboardDefinitionSection: API: GET /dashboard-api/dashboards/{dashboardId}/components-order.response.components.seqNo
• Vaikimisi on esimene alateema valitud.
• Korraga saab valida ühe alateema.
• Kui kasutaja vajutab alateema peale, siis kuvab süsteem kasutajale aruande komponendid, mis asuvad valitud teise taseme sektsiooni sees.
  • GS: DashboardDefinitionSection: API: GET /dashboard-api/dashboards/{dashboardId}/elements  objektid, mille id = GS: DashboardDefinitionSection: API: GET /dashboard-api/dashboards/{dashboardId}/components-order.response.components.id ja components.type = ELEMENT ja components.level = 3.
• Kui kasutaja vajutab alateemale, siis käivitab süsteem juhtimislaua komponendi filtrite nimekirja saamiseks päringu GS: DashboardDefinitionSection: API: GET /dashboard-api/dashboards/{dashboardId}/sections/{sectionId}/filters. Sisendid:
  • dashboardId = Avatud juhtimislaua id.
  • sectonId = Avatud juhtimislaua teise taseme komponendi id.
• Juhtimislaua alateemale vajutades käivitab süsteem iga aruande komponendi elemendi kohta, mis on alateemale lisatud päringu GS: DashboardDefinitionElementComment: API: GET /dashboard-api/dashboards/{dashboardId}/elements/{dashboardElementId}/comments elementide kommentaaride saamiseks. Sisend:
  • dashboardId = Avatud juhtimislaua id.
  • dashboardElementId = Sektsiooni sees olevate elementide id-d.

• Juhtimislaua komponent filtreid kuvatakse esimese taseme komponendi sees, kui juhtimislaua komponendile on filtrid lisatud ja juhtimislaua komponendil puudub teise taseme juhtimislaua komponent (alateema).
  • Päringu GS: DashboardDefinitionSection: API: GET /dashboard-api/dashboards/{dashboardId}/sections/{sectionId}/filters. (Sisendid: dashboardId = Avatud juhtimislaua id, sectonId = Avatud juhtimislaua esimese taseme komponendi id) vastuses on olemas vähemalt üks objekt.
  • Puudub objekt, mis vastab tingimustele: 
    • GS: DashboardDefinitionSection: API: GET /dashboard-api/dashboards/{dashboardId}/sections objekt, mille id = GS: DashboardDefinitionSection: API: GET /dashboard-api/dashboards/{dashboardId}/components-order.response.components.id ja components.type = SECTION ja components.level = 2 ja mis asub esimese taseme sektsiooni sees.
• Juhtimislaua komponent filtreid kuvatakse teise taseme komponendi juures, kui juhtimislaua teise taseme komponendile on filtrid lisatud.
  • Päringu GS: DashboardDefinitionSection: API: GET /dashboard-api/dashboards/{dashboardId}/sections/{sectionId}/filters. (Sisendid: dashboardId = Avatud juhtimislaua id, sectonId = Avatud juhtimislaua teise taseme komponendi id) vastuses on olemas vähemalt üks objekt.
• Filtri väärtused on vaikimis tühjad.
• Filtri kohta kuvatakse filtri nimetus.
  • Filtri nimetus: GS: DashboardDefinitionSection: API: GET /dashboard-api/dashboards/{dashboardId}/sections/{sectionId}/filters.response.filters.label
  • Kui tegemist on perioodi tüüpi filtriga, kuvatakse filtri nimetuse järel sulgudes perioodi tüüpi (nt 'Periood (Kalendriaasta)').
• Filtri kohta kuvatakse filtri sisestusväli vastavalt sisestusvälja tüübile.
  • GS: DashboardDefinitionSection: API: GET /dashboard-api/dashboards/{dashboardId}/sections/{sectionId}/filters.response.filters.inputType
    • MULTIPLE_CHOICE - Mitmikvalik (Kasutaja saab teha mitu valikut)
    • SINGLE_CHOICE - Üksikvalik (Kasutaja saab teha ühe valiku)
    • PERIOD- Periood (Kasutaja saab valida perioodi alguse ja lõpu)
• Filtri sisestusvälja väärtused kuvatakse vastavalt filtri sisestusvälja tüübile.
  • Kui sisestusvälja tüübiks on mitmikvalik või üksikvalik, siis kuvab süsteem nimekirjas valikuvariandid nimetuse järgi kasvavas järjekorras.
    • GS: DashboardDefinitionSection: API: GET /dashboard-api/dashboards/{dashboardId}/sections/{sectionId}/filters.response.filters.optionTexts
  • Kui sisestusvälja tüübiks on periood, siis kuvab süsteem perioodi alguse ja lõpu vastavalt juhtimislaua definitsioonile. Kasutaja saab sisestada perioodi etteantud vahemikus. Kui kasutaja sisestab muu väärtuse, siis kuvab süsteem kasutajale selle kohta vea.
    • GS: DashboardDefinitionSection: API: GET /dashboard-api/dashboards/{dashboardId}/sections/{sectionId}/filters.response.filters.period
• Kui kasutaja teeb filtri valiku, siis kuvab süsteem automaatselt aruannete komponentidel aruande andmed vastavalt tehtud valikutele.

• Väärtus: GS: DashboardDefinitionSection: API: GET /dashboard-api/dashboards/{dashboardId}/elements.response.elements.name
• Kui ühele reale ära ei mahu, siis nimi kuvatakse mitmel real.

• Süsteem kuvab aruande komponendi kohta lisatud kommentaaride arvu, kui vähemalt üks kommentaar on lisatud. Kui ühtegi kommentaari lisatud ei ole, siis arvu ei kuvata.
  • Tingimused:
    • Elemendil on päringu GS: DashboardDefinitionElementComment: API: GET /dashboard-api/dashboards/{dashboardId}/elements/{dashboardElementId}/comments vastuses vähemalt üks kommentaar.
  • Väärtus:
    • Elemendile lisatud GS: DashboardDefinitionElementComment: API: GET /dashboard-api/dashboards/{dashboardId}/elements/{dashboardElementId}/comments.response.comments objektide arv.
• Kui kasutaja vajutab kommentaari ikoonile, siis kuvab süsteem aruande elemendile lisatud kommentaarid.

Võimalus kinnitada aruande komponent töölauale või juhtimislaua esiletõstetud aruannete sektsiooni.

• Kui kasutaja vajutab nupule, siis avab kasutajale info selle kohta, kas aruanne on kinnitatud töölauale lemmikuks ja/või esiletõstetud vahelehele.
  • GS: UserDashboardElement: API: GET /dashboard-api/user-dashboard-elements vastuses on dashboardElements objekt, mille dashboardDefinitionElementId = elemendi id, mille juures nupule vajutati.
  • "Lisa lemmikuks" valik on linnutatud, kui GS: UserDashboardElement: API: GET /dashboard-api/user-dashboard-elements vastuses on dashboardElements objekt, mille dashboardDefinitionElementId = elemendi id, mille juures nupule vajutati ja displayLocationType = MAIN_DASHBOARD.
  • "Tõsta esile" valik on linnutatud, kui GS: UserDashboardElement: API: GET /dashboard-api/user-dashboard-elements vastuses on dashboardElements objekt, mille dashboardDefinitionElementId = elemendi id, mille juures nupule vajutati ja displayLocationType = DASHBOARD.
• Nupu taust on sinine, kui juhtimislaua aruanne on kinnitatud vähemalt ühte asukohta.
• Kui kasutaja teeb töölauale lemmikuks või esiletõstetud vahelehele kinnitamise valiku, siis:
  1. Süsteem käivitab aruande kinnitamiseks päringu GS: UserDashboardElement: API: POST /dashboard-api/user-dashboard-elements. Sisend:
     • dashboardDefinitionElementId = Elemendi id, mille juurest nupule vajutati.
     • appliedFilters = PBI aruande key vastavalt kasutaja tehtud valikule (sektsiooni ja komponendi filtrid, mis olid kasutaja poolt kinnitamise hetkel aktiveeritud).
     • displayLocationType = 
       • Lisa lemmikuks = MAIN_DASHBOARD
       • Tõsta esile = DASHBOARD 
     • institutionId = Kasutaja poolt valitud asutus, sh kui kasutaja valis pidaja pidamisel oleva õppeasutuse, siis rakendatakse pidaja pidamisel oleva õppeasutuse id filtrit..
  2. Süsteem kuvab kinnitatud asukoha kohta linnukese ikooni.
  3. Süsteem kuvab kasutajale aruande kinnitamise kohta teate.
• Aruande kinnitamist ei saa sakkide kuval eemaldada, vaid ainult otse töölaua lemmikuste nimekirjast või esitõstetud vahelehelt. Aruannet saab erinevate või samade filtrite väärtustega kinnitada mitmeid kordi.

Aruanne.

• Aruande andmed kuvatakse vastavalt erinevatele kitsendustele. Vaata "Juhtimislaua komponendid (sakid) → Aruande komponendid → Tehniline info".
• Aruandele vajutades avaneb aruande detailvaade. Avatakse põhikuval kuvatud aruanne. Vaade avatakse valitud näitaja alla ning detailvaate raamiga märgitakse aruande komponent, mille detailvaade on avatud.

Aruande nimetus.

• Väärtus: GS: DashboardDefinitionSection: API: GET /dashboard-api/dashboards/{dashboardId}/elements.response.elements.name
• Kui ühele reale ära ei mahu, siis nimi kuvatakse mitmel real.

Aruande detailvaade funktsioonid.

• Aruande detailvaates saab kasutaja teha järgnevaid tegevusi:
  • Avada juhtimislaua aruande erinevaid tüüpe.
  • Vaadata aruande lisainfot.
  • Vaadata aruande kommentaare.
  • Hallata kasutaja märkuseid aruande komponendi kohta.
  • Luua aruandest PDF faili.
  • Printide aruanne.
  • Jagada aruannet.
  • Kinnitada aruanne juhtimislauale või töölauale.

Võimalus valida aruande tüüpe.

Võimalus vaadata aruande lisainfot.

Võimalus hallata aruande märkmeid.

• Nupule vajutades avaneb märkmete lisamise ja märkmete nimistu kuvamise vaade.
• Nupule vajutades käivitab süsteem märkmete andmete saamiseks päringu GS: DashboardDefinitionElementComment: API: GET /dashboard-api/dashboards/{dashboardId}/elements/{dashboardElementId}/comments. Sisend:
  • dashboardId = Avatud juhtimislaua id.
  • dashboardElementId = Avatud elemendi id.
• Nupule vajutades kuvatakse kasutajale valitud raportit. Vaata Juhtimislaua komponendid (sakid) → Aruande komponendid → Aruande detailvaade → Aruande detailvaate funktsioonid → Aruande tüübi valimine.
• Kasutaja saab märkmete halduses teha järgnevaid tegevusi:
  
  • Märkme lisamine
    
    • Lisatud märkus peab olema 1- 1000 tähemärki pikk.
    • Märkme salvestamisel:
      1. Süsteem kontrollib, kas andmed vastavad nõuetele.
         1. Kui andmed ei vasta nõuetele, siis kuvatakse kasutajale viga.
      2. Süsteem käivitab päring GS: DashboardDefinitionElementComment: API: POST /dashboard-api/dashboards/{dashboardId}/elements/{dashboardElementId}/comments. Sisend:
         • dashboardId = Avatud juhtimislaua id.
         • dashboardElementId = Avatud elemendi id.
         • comment = Sisestatud kommentaar.
      3. Süsteem kuvab kasutajale teate märkme lisamise kohta.
  • Märkmete nimistu kuvamine
    • Süsteem kuvab iga märkme kohta järgmised andmed:
      • Märkme lisamise aeg tunni täpsusega (DD.MM.YYYY hh24:mm) eesti ajatsoonis.   
        • GS: DashboardDefinitionElementComment: API: GET /dashboard-api/dashboards/{dashboardId}/elements/{dashboardElementId}/comments.response.comments.createdAt
      • Märkuse sisu.
        • GS: DashboardDefinitionElementComment: API: GET /dashboard-api/dashboards/{dashboardId}/elements/{dashboardElementId}/comments.response.comments.comment
    • Märkmed on järjestatud märkme lisamise aja järgi. Eespool on uuemad märkmed.
  • Märkme muutmine
    • Muutmisel kuvatakse vaikimisi väärtuseks lisatud väärtust.
    • Muutmine avaneb märkme kolme punkti ikooni menüüst.
    • Lisatud märkus peab olema 1- 1000 tähemärki pikk.
    • Märkme muutmisel:
      1. Süsteem kontrollib, kas andmed vastavad nõuetele.
         1. Kui andmed ei vasta nõuetele, siis kuvatakse kasutajale viga.
      2. Süsteem käivitab päring GS: DashboardDefinitionElementComment: API: PUT /dashboard-api/dashboards/{dashboardId}/elements/{dashboardElementId}/comments/{commentId}. Sisend:
         • dashboardId = Avatud juhtimislaua id.
         • dashboardElementId = Avatud elemendi id.
         • commentId = Muudetava kommentaari id.
         • comment = Sisestatud kommentaar.
      3. Süsteem kuvab kasutajale teate märkme muutmise kohta.
  • Märkme kustutamine
    • Kustutamine avaneb märkme kolme punkti ikooni menüüst.
    • Märkme kustutamisel:
      1. Süsteem kuvab kasutajale kustutamise kinnitamise kinnitamise vaate.
      2. Kasutaja kinnitab märkme kustutamise.
      3. Süsteem käivitab märkme kustutamiseks päringu GS: DashboardDefinitionElementComment: API: DELETE /dashboard-api/dashboards/{dashboardId}/elements/{dashboardElementId}/comments/{commentId}. Sisend:
         • dashboardId = Avatud juhtimislaua id.
         • dashboardElementId = Avatud elemendi id.
         • commentId = Kustutatava kommentaari id.
      4. Süsteem kuvab märkmete nimistu, kust on kustutatud märkus eemaldatud.
      5. Süsteem kuvab teate märkme kustutamise kohta.

Võimalus luua aruandest fail ja see alla laadida.

• Nupule vajutamine avab kasutajale valiku, millises vormingus faili genereeritakse. Lubatud vormingud:
  • png
  • pptx
  • pdf
• Faili genereerimisel rakendatakse kõiki kasutaja poolt määratud filtreid ja süsteemi poolt vaikimisi lisatud filtreid
• Faili vormingu valimisel genereeritakse faili kohta soovitud vormingus fail ja kasutaja saab loodud faili salvestada enda seadmesse.
• Faili genereerimise ajal tuleb kasutajale kuvada loaderit.

Võimalus printida aruanne.

• Printimisel rakendatakse kõiki kasutaja poolt määratud filtreid ja süsteemi poolt vaikimisi lisatud filtreid.
• Trükifaili genereerimise ajal tuleb kasutajale kuvada loaderit.
• Trükifaili genereerimise järgselt tuleb kasutaja seadmes kuvada kasutajale seadme printimise funktsionaalsust.

Võimalus jagada aruannet.

• Kui kasutaja vajutab ikoonile siis avaneb aruande jagamise detailvaade.
  • Vaata Juhtimislaua komponendid (sakid) → Aruande komponendid → Aruande detailvaade → Aruande detailvaate funktsioonid → Aruande jagamine → Detailvaade

Võimalus kinnitada aruande komponent töölauale või juhtimislaua minu juhtimislaua sektsiooni.

• Kui kasutaja vajutab nupule, siis avab kasutajale info selle kohta, kas aruanne on kinnitatud töölauale lemmikuks ja/või esiletõstetud vahelehele.
  • GS: UserDashboardElement: API: GET /dashboard-api/user-dashboard-elements vastuses on dashboardElements objekt, mille dashboardDefinitionElementId = elemendi id, mille juures nupule vajutati.
  • "Lisa lemmikuks" valik on linnutatud, kui GS: UserDashboardElement: API: GET /dashboard-api/user-dashboard-elements vastuses on dashboardElements objekt, mille dashboardDefinitionElementId = elemendi id, mille juures nupule vajutati ja displayLocationType = MAIN_DASHBOARD.
  • "Tõsta esile" valik on linnutatud, kui GS: UserDashboardElement: API: GET /dashboard-api/user-dashboard-elements vastuses on dashboardElements objekt, mille dashboardDefinitionElementId = elemendi id, mille juures nupule vajutati ja displayLocationType = DASHBOARD.
• Nupu taust on sinine, kui juhtimislaua aruanne on kinnitatud vähemalt ühte asukohta.
• Kui kasutaja teeb töölauale lemmikuks või esiletõstetud vahelehele kinnitamise valiku, siis:
  1. Süsteem käivitab aruande kinnitamiseks päringu GS: UserDashboardElement: API: POST /dashboard-api/user-dashboard-elements. Sisend:
     • dashboardDefinitionElementId = Elemendi id, mille juurest nupule vajutati.
     • appliedFilters = PBI aruande key vastavalt kasutaja tehtud valikule (sektsiooni ja komponendi filtrid, mis olid kasutaja poolt kinnitamise hetkel aktiveeritud).
     • displayLocationType = 
       • Lisa lemmikuks = MAIN_DASHBOARD
       • Tõsta esile = DASHBOARD 
  2. Süsteem kuvab kinnitatud asukoha kohta linnukese ikooni.
  3. Süsteem kuvab kasutajale aruande kinnitamise kohta teate.
• Aruande kinnitamist ei saa sakkide kuval eemaldada, vaid ainult otse töölaua lemmikuste nimekirjast või esitõstetud vahelehelt. Aruannet saab erinevate või samade filtrite väärtustega kinnitada mitmeid kordi.

Juhtimislaual valitud filtrid

• Kuvatakse juhtimislaual valitud filtrid koos valitud väärtustega.
• Kui ühtegi filtrit valitud ei ole, siis kuvatakse silt puuduvad.

Võimalus genereerida uus jagamise link.

• Kui kasutaja vajutab nupule, siis:
  1. Süsteem käivitab uue lingi jagamiseks päringu GS: DashboardDefinitionElementReportUrl: API: POST /dashboard/dashboards/{dashboardId}/elements/{dashboardElementId}/reports/{dashboardElementReportId}/urls. Sisend:
     • dashboardId = Avatud juhtimislaua id.
     • dashboardElementId = Avatud juhtimislaua aruande komponendi id.
     • bookmark = Kõik juhtimislaual kasutaja poolt filtrite väärtused ja kõik süsteemi poolt määratud filtrite (nö "peidetud" filtrid, sh kooli id või KOV registrikood) väärtused (ehk filtrite ja väärtuste snapshot, base64 kujul).
  2. Süsteem kuvab kasutajale genereeritud lingi.
  3. Kui vaate avamise hetkest alates genereeritakse teist linki, siis eelnevalt genereeritud lingid lisatakse sektsiooni "Jagamise ajalugu". Uusi linke genereerimise järgselt kohe ajalukku ei lisata.
• Kui link on genereeritud (enne genereerimist linki ei kuvata), siis saab kasutaja kopeerida linki ja kopeerida koodi.
  • Lingi kopeerimisel kopeeritakse veebilink.
  • Koodi kopeerimisel kopeeritakse iFrame kood.
  • Kui kasutaja kopeerib lingi või koodi nupu abil, siis kuvatakse kasutajale teade selle kohta, et link kopeeriti või kood kopeeriti.
• Lingi või iFrame koodi avamisel või kasutamisel kuvatakse kasutajale aruande jagatud vaade või aruanne iFrame sees. Vaata GS: UC: Juhtimislaua kuvamine - Jagatud vaade

Võimalus näha genereeritud linke.

• Sektsioon on kuvatud, kui enne vaate avamist oli vähemalt üks link genereeritud.
  • GS: DashboardDefinitionElementReportUrl: API: GET /dashboard/dashboards/{dashboardId}/elements/{dashboardElementId}/reports/{dashboardElementReportId}/urls vastuses on vähemalt üks objekt.
• Sektsioon on kuvatud, kui enne vaate avamist ei olnud ühtegi linki genereeritud ja kasutaja genereeris esimese lingi ja seejärel teise lingi.
• Lingid on järjestatud lingi genereerimise aja järgi. Eespool on uuemad lingid.
  • GS: DashboardDefinitionElementReportUrl: API: GET /dashboard/dashboards/{dashboardId}/elements/{dashboardElementId}/reports/{dashboardElementReportId}/urls.response.createdAt

Lingi loomise aeg.

• Lingi loomise kuupäev ja kellaaeg minuti täpsusega.
  • GS: DashboardDefinitionElementReportUrl: API: GET /dashboard/dashboards/{dashboardId}/elements/{dashboardElementId}/reports/{dashboardElementReportId}/urls.response.createdAt

Genereeritud link.

• Genereeritud lingi url koos genereeritud lingi UUID väärtusega.
  
  • GS: DashboardDefinitionElementReportUrl: API: GET /dashboard/dashboards/{dashboardId}/elements/{dashboardElementId}/reports/{dashboardElementReportId}/urls.response.id

Jagamise hetkel valitud filtrid.

• GS: DashboardDefinitionElementReportUrl: API: GET /dashboard/dashboards/{dashboardId}/elements/{dashboardElementId}/reports/{dashboardElementReportId}/urls.response.bookmark

• Kasutaja saab genereeritud linkidega teha järgnevaid tegevusi:
  • Kopeeri link
    • Lingi kopeerimisel kopeeritakse veebilink.
  • Kopeeri kood
    • Koodi kopeerimisel kopeeritakse veeblink, mis on lisatud html iframe tagi sisse.
  • Ava link
    • Nupule vajutades avatakse veebilehitseja uues sakis valitud link.
  • Kustuta.
    • Kui kasutaja vajutab nupule, siis:
      1. Süsteem käivitab lingi kustutamiseks päringu GS: DashboardDefinitionElementReportUrl: API: DELETE /dashboard/dashboards/{dashboardId}/elements/{dashboardElementId}/reports/{dashboardElementReportId}/urls/{urlId}. Sisend:
         • uldId = GS: DashboardDefinitionElementReportUrl: API: GET /dashboard/dashboards/{dashboardId}/elements/{dashboardElementId}/reports/{dashboardElementReportId}/urls.response.id
      2. Süsteem kuvab kasutajale teate lingi kustutamise kohta.

• Nupule vajutades sulgeb süsteem vaate ja kuvab juhtimislaua vaate.