Parametritunnisteet

Komponentit lisäävät tietoja raportteihin parametrien, kuten näkymän tunnusten, merkkijonojen ja lukujen, avulla. Kyseiset parametrit määritetään käyttämällä fp:*Param-tunnisteita.
Jokaisessa komponentissa on pakollisia ja valinnaisia tunnisteita. Kaikissa parametritunnisteissa on määritteitä.
Taulukko 1. Parametritunnisteet ja määritteet
Nimi Kuvaus
Parametritunnisteet
fp:attrParam Määrittää määritteen. Esimerkki: Tila Vaatimukset-moduulissa.
fp:checkboxParam Sisältää totuusarvon (true tai false).
fp:critParam Sisältää kokonaislukuarvon. Esimerkki: (..., -2, -1, 0, 1, 2, ...).
fp:memberParam Määrittää jäsenen. Esimerkki: Admin.
fp:stringParam Sisältää merkkijonoarvon.
fp:viewParam Määrittää näkymän. Esimerkki: Kaikki vaatimukset
Parametritunnisteiden määritteet
changeable Pakollinen määrite, joka määrittää, milloin parametri muuttuu ja joka on käytössä kaikissa *Param-tunnisteissa. Määritteellä on neljä arvoa:
  • Template: Parametri muuttuu, kun raporttilaji luodaan tai sitä muokataan.
  • Runtime: Parametri muuttuu, kun raportti luodaan.
  • Never: Parametria ei voi muuttaa. Tätä parametria käytetään, jos arvo on jo tiedossa mallipohjan luontihetkellä. Järjestelmä lukee arvon defaultvalue-määritteestä.
  • Fetch: Järjestelmä noutaa arvon automaattisesti. Noudettu arvo määräytyy name-määritteen arvon mukaan:
    • currentdate: nykyinen päivämäärä
    • currenttime: nykyinen kellonaika
    • currentuser: sisään kirjautunut käyttäjä
    • fortune: "Onnenkeksi", joka on aina uusi. Järjestelmä käyttää tätä arvoa, jos .jar-lisätiedostoja lisätään.
    • numpages: Raportin sivumäärä. Järjestelmä käyttää tätä arvoa otsikoissa ja alatunnisteissa.
    • workspacename: työtilan nimi
    • pageno: Nykyisen sivun numero. Järjestelmä käyttää tätä arvoa otsikoissa ja alatunnisteissa.
id Pakollinen määrite, joka määrittää parametrin tunnuksen ja joka on käytössä kaikissa *Param-tunnisteissa. Jokaisella parametrilla on yksilöllinen tunnus. Voit käyttää samaa tunnusta useissa parametreissa.

Vain ensimmäinen parametri näkyy käyttöliittymässä. Muut parametrit kopioivat ensimmäisen parametrin arvot. Tämä käytäntö on hyödyllinen varsinkin, jos samoja tietoja tarvitsee esittää useissa otsikoissa tai jos samaa näkymää tarvitsee käyttää useissa komponenteissa.

name Pakollinen määrite, joka määrittää parametrin nimen ja joka on käytössä kaikissa *Param-tunnisteissa. Komponenttitunnisteissa nimi on yksilöllinen tunnus, jota käytetään parametreja haettaessa. Yleisiä nimiä ovat esimerkiksi näkymänTunnus, määritteenTunnus, elementinTunnus ja sivunro.
masterid Parametria ohjaavan parametrin tunnus. Tämä määrite on pakollinen, mutta sitä ei käytetä kaikissa komponenteissa. Tämä määrite on käytössä attrParam-tunnisteessa. Pääparametri on tavallisesti viewParam. Pääparametri on määritettävä ensin, koska muussa tapauksessa et voi tietää, mitkä määritteet tai elementit ovat käytettävissä.
type Määrittää tässä parametrissa sallitun määritelajin. Tämä määrite on pakollinen, mutta sitä ei käytetä kaikissa komponenteissa. Tämä määrite on käytössä attrParam-tunnisteessa. Seuraavat type-määritteet ovat käytettävissä:
  • choice: valintamääritteet
  • number: kokonaisluku- ja liukulukumääritteet
  • numbertext: kokonaisluku-, liukuluku- ja arvotaulukkomääritteet
  • link: linkki- ja linkkiluettelomääritteet
  • all: kaikki määritelajit.
defaultvalue Parametrin arvoksi määritetään defaultvalue, kun raporttilaji luodaan tai sitä muokataan ensimmäisen kerran tai kun raportti luodaan ensimmäisen kerran. Tämä määrite on valinnainen, ja se on käytössä kaikissa *Param-tunnisteissa. Oletusarvo on tyhjä merkkijono:defaultvalue="".
descr Parametrin kuvaus. Tämä määrite on valinnainen. Kuvaus tulee näkyviin, kun raporttilaji luodaan tai sitä muokataan tai kun raportti luodaan. Oletusarvona on, että kuvaus ei ole käytössä: descr="".

Palaute