Efecte Query Language (EQL) -kieltä käytetään datan kyselyyn Efectestä. Web API:a voidaan käyttää Efecten integroimiseen muihin järjestelmiin, ja tämän dokumentin tarkoituksena on tarjota esimerkkejä web API -palveluista.

Efecte-kyselykieli

Efecte Query Language (EQL) on SQL:n kaltainen strukturoitu kieli, jolla Efecteä voidaan kysellä Web API:n kautta. Sen avulla voidaan tehdä tehokkaita ja joustavia hakuja Efecten tietomallia vasten.

Jotta EQL:ää voidaan käyttää tehokkaasti, on tunnettava joitakin taustalla olevan tietomallin peruskäsitteitä. EQL:n kanssa yleisimmin käytetyt tietomallin elementit ovat "entity", "entitydata", "template" ja "folder". 

Alla on yksinkertaisia esimerkkejä EQL:n käytön havainnollistamiseksi. Taulukot tarjoavat viitetietoa Efecten tietomallin tärkeimmistä luokista ja ominaisuuksista.

Haettavat luokat:

Luokan entity ominaisuudet (com.efecte.datamodel.Entity):

Luokan Template ominaisuudet

Luokan Template ominaisuudet (com.efecte.datamodel.Template):

Luokan Folder ominaisuudet

Luokan Folder ominaisuudet (com.efecte.datamodel.Folder):

Päivämääräkoodit ja aikalausekkeet

EQL-kyselyissä voi käyttää päivämääräkoodeja ja aikalausekkeita yhdessä päivämääräkoodien kanssa. Nämä kaksi voidaan yhdistää esimerkiksi muodossa now+6h tai start_month-1M.

Päivämääräkoodit:
 

Aikalausekkeet:

EQL-esimerkkejä

Koko Efecte-järjestelmän kaikkien tietokorttien määrän hakeminen

Koko Efecte-järjestelmän kaikkien tietokorttien määrän hakeminen. Tämä on hyvä tapa testata, että web API toimii oikein.

SELECT count(id) FROM entity

Tietyn datan hakeminen tietokortista

Haetaan tietokortin nimi, mallin nimi ja kansion nimi entiteeteille, joilla on tietty host_name ja jotka ovat mallissa 'workstation'

SELECT name, template.name, folder.name FROM entity WHERE $host_name$= 'falco' AND template.code = ‘workstation’

Yksittäisen moduulin kaikkien tietokorttien hakeminen

Haetaan yksittäisen moduulin kaikki tietokortit:

SELECT entity FROM entity WHERE template.systemCode = 'beq'

tai käyttämällä alikyselyä

SELECT entity FROM entity WHERE templateId IN (SELECT id FROM template WHERE systemCode = 'beq')

tai käyttämällä exists-kyselyä:

SELECT entity FROM entity WHERE EXISTS (SELECT id FROM template WHERE id = entity.templateId AND template.systemCode = 'beq') 

Kaikkien incident-tietokorttien hakeminen, jotka eivät ole poistettuja tai piilotettuja

Haetaan kaikki tietokortit, jotka eivät ole piilotettuja tai poistettuja:

SELECT entity FROM entity WHERE template.code='incident' AND entity.deleted=0 AND entity.hidden=0

Tietokorttien hakeminen ja annettujen attribuuttien valitseminen kansiossa

Valitaan mallin tietokorttien annetut attribuutit. Palauttaa attribuutit efecte_id, subject ja status:

SELECT $efecte_id$, $subject$, $status$ FROM entity WHERE entity.template.code = 'incident'

Tiettyjen päivämäärien välillä luotujen tietokorttien hakeminen

EQL:ssä voi käyttää päivämääräkoodeja. Alla on esimerkki, joka hakee kaikki incidentit, jotka on luotu kahden kuukauden takaisen ajankohdan ja nykyhetken (now) välillä:

SELECT entity FROM entity WHERE template.code='incident' AND $created$>'start_month-2M' AND $created$<'NOW'

Yksilöllisten tietokorttien hakeminen

Yksilöllisten tietokorttien löytäminen

SELECT DISTINCT entity.referenceData.target FROM entity WHERE template.code = 'invoice_row'

Tietokorttien hakeminen viittausarvon avulla

Etsitään työasema, jonka omistaa käyttäjä, jonka koko nimi on

SELECT entity FROM entity WHERE template.code='workstation' AND $user:full_name$='user test'