ESM Listenerin toimintojen tarkat kuvaukset
ESM Listenerin toimintojen tarkat kuvaukset
AlwaysFailDataCardAction
- Estää tietokortin tallentamisen.
Luokka
com.efecte.datamodel.entity.action.implementations.AlwaysFailDataCardAction
Määritykset
| Nimi | Pakollinen | Kuvaus |
|---|---|---|
| Error message | Ei | Valinnainen virheilmoitus, joka näytetään käyttäjälle / lokitiedostoissa. Arvo voi olla lokalisointia varten tarkoitettu esitysteksti. Oletusarvo on Validation error (text_validator_error). |
ChangeDataCardValuesAction
- Asettaa attribuutin arvon.
- Tyhjentää attribuutin arvon.
Luokka
com.efecte.datamodel.entity.action.implementations.ChangeDataCardValuesAction
Määritykset
| Nimi | Pakollinen | Kuvaus |
|---|---|---|
| Code | Kyllä | Attribuutin koodi. |
| Value | Kyllä | Attribuutin uusi arvo. Koska arvo annetaan tekstinä, se rajoittaa mahdollisia tietotyyppejä, esim. viittaukset (references) eivät toimi. Tyhjä arvo (<value></value>) tyhjentää attribuutin arvon. |
CopyDataCardValuesAction
- Kopioi arvon lähdetietokortista toisen attribuutin arvoksi tai kohdetietokortin attribuutin arvoksi.
- Voi kopioida myös viittausten (references) takana olevia arvoja.
- Jos kopioitava attribuutti on monikkoarvoinen (multivalue), olemassa olevat arvot KORVATAAN.
- Monikkoarvot toimivat vain isäntätietokortilla, ei viittausten takana.
- Jos arvoja kopioidaan monikkoarvoiseen kohdeattribuuttiin, vain ensimmäinen arvo kopioidaan, jos kohdeattribuutti on viittaustyyppiä (reference) eikä lähdeattribuutti ole.
Luokka
com.efecte.datamodel.entity.action.implementations.CopyDataCardValuesAction
Määritykset
| Nimi | Pakollinen | Kuvaus |
|---|---|---|
| Code | Kyllä | Muutettavan attribuutin koodi. |
| Value | Kyllä | Sen lähdetietokortin attribuutin koodi, josta arvo kopioidaan. Tai, jos kopioidaan viittauksen kautta: $source_data_card_reference_attribute_code:referred_data_card_attribute_code$ |
CopySourceReferenceAction
- Luo viittauksen kohdetietokorteista lähdetietokorttiin.
Luokka
com.efecte.datamodel.entity.action.implementations.CopySourceReferenceAction
Määritykset
| Nimi | Pakollinen | Kuvaus |
|---|---|---|
| Code | Kyllä | Kohdetietokortin viittausattribuutin koodi. Tämä attribuutti saa viittauksen lähdetietokorttiin. |
CreateDataCardAction
- Luo uuden tietokortin määritetyn mallin perusteella määritettyyn kansioon.
- Voi valinnaisesti lisätä viittauksia luojan ja luotujen tietokorttien välille.
- Voi valinnaisesti asettaa attribuuttien arvoja luotuun korttiin.
- Erikoistapauksena voi lisätä ajan, jolloin muokkaus ESM-käyttöliittymässä aloitettiin (katso ":EDITING_START_TIME:" alla).
Luokka
com.efecte.datamodel.entity.action.implementations.CreateDataCardAction
Määritykset
| Nimi | Pakollinen | Kuvaus |
|---|---|---|
| Template | Kyllä | Sen mallin koodi, johon uusi tietokortti perustuu. |
| Folder | Kyllä | Sen kansion koodi, johon luotu tietokortti tallennetaan. :SOURCE: käyttää luojan kansiota. |
| Reference from source | Ei | Luojan tietokortin viittaus- tai takaisinviittausattribuutin koodi, joka saa viittauksen äskettäin luotuun tietokorttiin. |
| attribute_code_in_created | Ei | Tietotyyppikohtainen arvo, joka asetetaan ilmoitettuun attribuuttiin. Huomaa, että arvoon voivat vaikuttaa tietotyyppikohtaiset makrot, kuten päivämäärämakrot. |
| attribute_code_in_created | Ei | :EDITING_START_TIME: sijoittaa muokkauksen aloitusajan luodun tietokortin päivämäärä- tai merkkijonoattribuuttiin. Huomaa, että muokkauksen aloitusaika on saatavilla vain, jos tämän toiminnon laukaissut muokkaus tehtiin käyttöliittymän muokkausnäkymän kautta; siksi tätä määritystä tulisi käyttää yhdessä GuiEdit-lähde-ehdon kanssa. |
| attribute_code_in_created | Ei | :SOURCE: luo viittauksen luojaan viittausattribuutissa tai kopioi luojan nimen merkkijonoattribuuttiin. |
| attribute_code_in_created | Ei | $refence_path_to_creator_attribute$ kopioi luojan ilmoitetun attribuutin arvon luodun ilmoitettuun attribuuttiin. |
EntityDataCardAction
- Siirtää tietokortin roskakoriin tai palauttaa sen roskakorista.
- Poistaa tietokortin pysyvästi.
- Piilottaa tai tekee tietokortin näkyväksi.
Huomio:
Esimerkiksi DatacardHiddenState-käsittelijä (handler) voi olla ristiriidassa tämän toiminnon sisältävän kuuntelijan (listener) kanssa. Jos mallilla on DatacardHiddenState-käsittelijä, kuuntelijan toteutuksessa tämä on otettava huomioon. Tarkista kuuntelijoiden ja käsittelijöiden suoritusjärjestys.
Luokka
com.efecte.datamodel.entity.action.implementations.EntityDataCardAction
Määritykset
| Nimi | Pakollinen | Kuvaus |
|---|---|---|
| Entity Action | Kyllä | Toiminto: "trashcan", "restore", "delete permanently", "hide", "set visible". |
ExpressionAction
- Suorittaa määritetyn Python-skriptin kohdetietokorteille.
Huomio:
Toiminnon nimi on hieman harhaanjohtava, koska tämä suorittaa skriptejä, ei lausekkeita (expressions) (siinä merkityksessä kuin termejä käytetään Validator- ja Expression-käsittelijöiden yhteydessä).
Luokka
com.efecte.datamodel.entity.action.implementations.ExpressionAction
Määritykset
| Nimi | Pakollinen | Kuvaus |
|---|---|---|
| Code | Kyllä | Kohdetietokortin attribuutin koodi. Lausekkeen tulos asetetaan tähän attribuuttiin. |
| Expression | Kyllä | Suoritettava Python-skripti. |
FolderDataCardAction
- Siirtää tietokortin tiettyyn kansioon.
Luokka
com.efecte.datamodel.entity.action.implementations.FolderDataCardAction
Määritykset
| Nimi | Pakollinen | Kuvaus |
|---|---|---|
| Folder | Ei | Sen kansion koodi, johon tietokortti siirretään, tai ":SOURCE:", jos tietokortti siirretään samaan kansioon, jossa lähdetieto on. |
| Folder attribute | Ei | Attribuutin koodi, jonka arvo on sen kansion koodi, johon tietokortti siirretään. Jos folder on määritetty, sitä käytetään tämän sijaan. |
| Fallback folder | Ei | Sen kansion koodi, johon tietokortti siirretään, jos folder tai Folder attribuutilla määritettyä kansiota ei ole saatavilla. |
SaveDataCardAction
- Luo viittauksen kohdetietokorteista lähdetietokorttiin.
- Tämä mahdollistaa uusien arvojen laskemisen attribuuteille, joissa on käsittelijä (handler) (esim. ExpressionHandler tai vastaava).
Luokka
com.efecte.datamodel.entity.action.SaveDataCardAction
Määritykset
| Nimi | Pakollinen | Kuvaus |
|---|---|---|
| - | - | - |
SaveDataCardXmlToFileAction
- Tallentaa tietokortin XML-muodossa määritettyyn tiedostoon ja kansioon.
- Tämä toiminto vaikuttaa vain tallennettavaan lähdetietokorttiin.
- Jos tiedosto on jo olemassa, se korvataan (tiedosto poistetaan ennen uuden tiedoston kirjoittamista).
- Toiminto yrittää ensin kirjoittaa XML:n väliaikaiseen tiedostoon ja nimeää sen sitten uudelleen määritetyksi tiedostoksi.
- Tällä estetään se, että kukaan lukisi tulostiedostoa ennen kuin se on kokonaan kirjoitettu.
Luokka
com.efecte.datamodel.entity.action.SaveDataCardXmlToFileAction
Määritykset
| Nimi | Pakollinen | Kuvaus |
|---|---|---|
| Target file | Kyllä | Sen tiedoston nimi (polku), johon XML tallennetaan. Voi sisältää seuraavat makrot: $now$, $TIMESTAMP$ ja $ENTITY_ID$. Ne laajenevat vastaavasti nykyiseen päivämäärään (muodossa yyyy-MM-dd), nykyiseen aikaleimaan (millisekunteina epokista) sekä tietokortin ID:hen tietokannassa. |
SendDataCardXmlToWebService
- Lähettää tietokortin XML-muodossa määritettyyn SOAP-verkkopalveluun.
- Huomaa, että tämä toiminto vaikuttaa vain tallennettavaan lähdetietokorttiin.
Ennakoiva Basic-todennus
Tämä ominaisuus mahdollistaa tehokkaamman todennusprosessin lähettämällä tunnistetiedot ennakoivasti, mikä vähentää todennukseen tarvittavien edestakaisten kutsujen (round-trip) määrää.
Näin otat käyttöön:
- Globaalisti: Aseta alustan asetus (platform setting) datacard.listeners.preemptive.authentication=true
- Kuuntelijakohtaisesti: Lisää toiminnon määrityksiin "preemptiveAuthentication=true" "connectionParameters"-kohtaan
Huomio: Jos ominaisuus on otettu käyttöön globaalisti, voit poistaa sen käytöstä tietyille toiminnoille asettamalla "preemptiveAuthentication=false" toiminnon "connectionParameters"-määritysarvoon.
Luokka
com.efecte.datamodel.entity.action.implementations.webservice.SendDataCardXmlToWebService
Määritykset
| Nimi | Pakollinen | Kuvaus |
|---|---|---|
| endpointAddress | Kyllä | Päätepisteen osoite, joka määrittää, missä verkkopalvelu sijaitsee. Esimerkki: http://localhost:8080/axis2/services/EfecteNotifyService. Käyttäjätunnuksen ja salasanan voi laittaa suoraan URL-osoitteeseen, jos verkkopalvelun puolella käytetään HTTP BASIC -todennusta. Tällöin URL-osoite näyttäisi tältä: http://user:password@localhost:8080/axis2/services/EfecteNotifyService |
| entitysetTargetNamespace | Kyllä | entityset-elementin kohdenimiavaruus (Target Namespace). Esimerkki: http://integration.efecte.com/notify/request |
| operationName | Kyllä | Toiminto (operation): tällä hetkellä ainoa mahdollinen arvo on "Notify". |
| Require changed data | Kyllä | "True" tai "False". Jos tosi, viesti lähetetään vain, kun jokin on muuttunut. Jos epätosi, viesti lähetetään aina tietokorttia tallennettaessa. Lähde-ehtoja (source conditions) voidaan silti käyttää määrittämään, milloin tämä toiminto suoritetaan. Esimerkiksi viesti voidaan lähettää vain, kun tietyn attribuutin arvo on muuttunut. |
| username | Ei | Käyttäjätunnus HTTP Basic -todennusta varten. Jos sitä ei anneta, Basic-todennusta ei käytetä. |
| password | Ei | Salasana HTTP Basic -todennusta varten. Jos sitä ei anneta, Basic-todennusta ei käytetä. |
| useChunkedTransferEncoding | Ei | "True" tai "False". Oletusarvo on "True". Jos arvo on false, chunked transfer -koodausta ei käytetä. |
| connectionParameters | Määrittää yhteysasetukset (connection configuration options). <configuration_item> <name>connectionParameters</name> <value>acceptSelfSignedCertificates=false,allowAllHostnamesInCertificate=true,connectionRequestTimeout=60,connectTimeout=60,socketTimeout=60</value> </configuration_item> Jos ennakoivaa Basic-todennusta ei ole asetettu arvoon "true" alustan asetuksessa "datacard.listeners.preemptive.authentication" ja haluat ottaa sen käyttöön tälle kuuntelijalle, lisää tämä "connectionParameters"-kohtaan: preemptiveAuthentication=true |
SendDataCardXmlToHttpAction
- Lähettää tietokortin XML-viestinä ulkoiseen palveluun.
- Lähetetty viesti voidaan muuntaa mihin tahansa haluttuun muotoon XSLT-muunnoksen avulla.
- Viestit lähetetään jonoon, joka huolehtii viestin uudelleenlähetyksestä, jos lähetys epäonnistuu.
Ennakoiva Basic-todennus
Tämä ominaisuus mahdollistaa tehokkaamman todennusprosessin lähettämällä tunnistetiedot ennakoivasti, mikä vähentää todennukseen tarvittavien edestakaisten kutsujen (round-trip) määrää.
Näin otat käyttöön:
- Globaalisti: Aseta alustan asetus (platform setting) datacard.listeners.preemptive.authentication=true
- Kuuntelijakohtaisesti: Lisää toiminnon määrityksiin "preemptiveAuthentication=true" "connectionParameters"-kohtaan
Huomio: Jos ominaisuus on otettu käyttöön globaalisti, voit poistaa sen käytöstä tietyille toiminnoille asettamalla "preemptiveAuthentication=false" toiminnon "connectionParameters"-määritysarvoon.
Luokka
com.efecte.datamodel.entity.action.implementations.http.SendDataCardXmlToHttpAction
Määritykset
| Nimi | Pakollinen | Kuvaus |
|---|---|---|
| endpointURL | URL-osoite, jossa kolmas osapuoli tarjoaa palvelun. Portti ja palvelun konteksti tulee yhdistää tähän URL-osoitteeseen. | |
| endpointMethod | Määrittää, millaista metodia käytetään kolmannen osapuolen kanssa kommunikointiin. (post/delete). | |
| endpointService | Palvelu, joka kuluttaa kolmannen osapuolen tarjoamaa dataa, eli ESSAnnouncement, Other(=ESM). | |
| username | Kolmannen osapuolen BASIC-todennuksessa määritetty käyttäjätunnus. | |
| password | Kolmannen osapuolen BASIC-todennuksessa määritetty salasana. | |
| datetimePattern | Määrittää päivämäärä-/aikamuodon, jota käytetään lähetettävässä XML-sisällössä (payload). Esimerkki: <configuration_item> <name>datetimePattern</name> <value>yyyy-MM-dd'T'HH:mm:ssXXX</value> </configuration_item> |
|
| expectedResponseCodeMessage |
Odotetun vastauskoodin (Response code) ja -viestin yhdistelmä. Example 1: Sekä 200 että 404 hyväksytään vastauskoodeiksi. Koodille 200 vastausviestin tulisi olla tyhjä tai null. Koodille 404 vastausviestissä tulisi olla "Cannot delete a non-existent announcement". |
|
| xslTransformFile | Määrittää sijainnin tiedostojärjestelmässä, johon xsl-tiedosto voidaan määrittää. <configuration_item> <name>xslTransformFile</name> <value>/home/likewise-open/server777/ESSAnnouncement1.xsl</value> </configuration_item> |
|
| xsl |
Määrittää koodin upotettuna xsl-koodina: <xsl:transform version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.efecte.com/integration/update/xsd/1.0" > ]]> |
|
| xslParameters | Määrittää useita syöttöparametreja XSL-muunnosta varten. Esimerkki 1: <configuration_item> <name>xslParameters</name> <value>ess_tenant=customer</value> </configuration_item> Esimerkki 2: <configuration_item> <name>xslParameters</name> <value>ess_tenant=customer, xxx=yyy</value> </configuration_item> |
|
| xsdSchemaFile | Määrittää vastaavan xsd-tiedoston, jolla validoidaan lähetettävä XML-sisältö. <configuration_item> <name>xsdSchemaFile</name> <value>/home/likewise-open/server777/update.xsd</value> </configuration_item> |
|
| connectionParameters | Määrittää yhteysasetukset (connection configuration options). <configuration_item> <name>connectionParameters</name> <value>acceptSelfSignedCertificates=false,allowAllHostnamesInCertificate=true,connectionRequestTimeout=60,connectTimeout=60,socketTimeout=60</value> </configuration_item> Jos ennakoivaa Basic-todennusta ei ole asetettu arvoon "true" alustan asetuksessa "datacard.listeners.preemptive.authentication" ja haluat ottaa sen käyttöön tälle kuuntelijalle, lisää tämä "connectionParameters"-kohtaan: preemptiveAuthentication=true |
|
| outputEncoding | Määrittää lähtevän XML:n merkistökoodauksen. <configuration_item> <name>outputEncoding</name> <value>UTF-8</value> </configuration_item> |
SendMailAction
- Lähettää sähköpostia.
- HUOMIOITA:
- Myös tietokortin poistaminen laukaisee kuuntelijoita (listeners), joten ole tarkkana lähde-ehtojen kanssa.
- Toiminto ei estä tietokortin tallentamista, vaikka sähköpostia ei voitaisi lähettää mistä tahansa syystä (virheellinen määritys, sähköpostipalvelin ei toiminnassa jne.).
- Jos kuuntelijat on määritetty suoritettavaksi non-root-käyttäjänä, varmista, että määritetyllä käyttäjällä on pääsy tarvittaviin attribuutteihin.
- Sähköpostipalvelimen asetukset määritetään Platform Settings -osiossa. Niitä ei voi ohittaa kuuntelijan määrityksissä.
- Vähintään yhdellä määritysarvoista To, Cc tai Bcc on oltava arvo.
Luokka
com.efecte.datamodel.entity.action.implementations.SendMailAction
Määritykset
| Nimi | Pakollinen | Kuvaus |
|---|---|---|
| From | Kyllä | Lähettäjän osoite(et). Voi sisältää viittauksia attribuutteihin muodossa $attribute_code$ tai $code_of_reference:attribute_code$. Erota useat osoitteet pilkulla tai puolipisteellä. |
| To | Ei | Vastaanottajan osoite(et). Voi sisältää viittauksia attribuutteihin muodossa $attribute_code$ tai $code_of_reference:attribute_code$. Erota useat osoitteet pilkulla tai puolipisteellä. |
| Cc | Ei | Kopion vastaanottajan osoite(et). Voi sisältää viittauksia attribuutteihin muodossa $attribute_code$ tai $code_of_reference:attribute_code$. Erota useat osoitteet pilkulla tai puolipisteellä. |
| Bcc | Ei | Piilokopion vastaanottajan osoite(et). Voi sisältää viittauksia attribuutteihin muodossa $attribute_code$ tai $code_of_reference:attribute_code$. Erota useat osoitteet pilkulla tai puolipisteellä |
| Subject | Ei | Viestin aihe. Voi sisältää viittauksia attribuutteihin muodossa $attribute_code$ tai $code_of_reference:attribute_code$. Monikkoarvot erotetaan pilkulla. |
| Message | Ei | Viestin teksti. Teksti voi sisältää rivinvaihtoja. <![CDATA[]]> -rakennetta voidaan käyttää, jos tarvitaan erikoismerkkejä. Voi sisältää viittauksia attribuutteihin muodossa $attribute_code$ tai $code_of_reference:attribute_code$. Monikkoarvot erotetaan pilkulla. |
| Content-type | Ei | Viestin MIME-tyyppi. Esimerkiksi text/html. Oletusarvo on text/html. Mahdolliset arvot ovat text/plain ja text/html. |
| Send once | Ei | Yksilöllinen tunniste (ID). Jos Send once on asetettu, kuuntelija lähettää sähköpostia vain kerran kutakin tietokorttia kohden. Jos AutoMailSender korvataan kuuntelijalla, käytä arvona AutoMailSenderin attribuutin class-attribuutin ID:tä. Kun luodaan uusi SendMailAction ilman aiempaa AutoMailSender-määritystä, käytä mitä tahansa haluamaasi yksilöllistä ID:tä. Varmista vain, ettei mikään muu kuuntelija käytä samaa ID:tä (ellet nimenomaan halua kahden tai useamman kuuntelijan käyttävän samaa ID:tä). |
| Attachments | Ei | Tiedostojen nimet "uploads/sendmailaction"-nimisessä hakemistossa. Tiedostot on lisättävä palvelimelle manuaalisesti, koska Efectessä ei ole tähän käyttöliittymää. Viittaus/viittauksia attribuutteihin muodossa $attribute_code$ tai $code_of_reference:attribute_code$. Attribuutin/attribuuttien on oltava tyyppiä External reference. Erota useat tiedostot puolipisteellä. |
SendSourceChangedJMSMessageAction
- Toiminto lähettää JMS-viestin jonoon, kun tietokortti tallennetaan. Viestin sisältö on koko tietokortti Efecte XML -muodossa.
Luokka
com.efecte.datamodel.entity.action.implementations.SendSourceChangedJMSMessageAction
Määritykset
| Nimi | Pakollinen | Kuvaus |
|---|---|---|
| Url | Kyllä | URL-osoite, johon viesti lähetetään. |
| Subject | Kyllä | Jonon aihe (subject). |
| User | Ei | Käyttäjätili. |
| Password | Ei | Käyttäjätilin salasana. |
| Require changed data | Kyllä | "True" tai "False". Jos tosi, viesti lähetetään vain, kun jokin on muuttunut. Jos epätosi, viesti lähetetään aina tietokorttia tallennettaessa. Lähde-ehtoja (source conditions) voidaan silti käyttää määrittämään, milloin tämä toiminto suoritetaan. Esimerkiksi viesti voidaan lähettää vain, kun tietyn attribuutin arvo on muuttunut. |
| XmlEncoding | Ei | XML:n valinnainen merkistökoodaus. |
TargetedSccmUpdateAction
- Käynnistää kohdistetun SCCM-päivityksen.
- Tämä tulisi liittää Administered software -malliin, ja se tulisi laukaista, kun AS-kortti siirtyy tilaan "Monitored" (yleensä osa baseline-määritystä).
- Toiminto etsii kaikki tietokoneet, joilla kyseinen ohjelmisto vaikuttaa olevan asennettuna (perustuen "All installed software" -kenttään). Sen jälkeen se ottaa näiden tietokoneiden SCCM-resurssitunnukset (resource ID), asettaa ne päivitysjonoon ja lopuksi käskee SccmIntegrationTaskia suorittamaan kohdistetun ajon käyttäen vain jonossa olevia tunnuksia.
Huomio:
Itse ajo tapahtuu taustalla, joten alkuperäisen tietokortin tallentamisessa ei tapahdu merkittävää viivettä. Ajo käynnistyy muutaman minuutin kuluttua, joten jos useat AS-kortit siirtyvät tilaan Monitored lyhyen ajan sisällä, kaikki resurssitunnukset ryhmitellään ja päivitetään samassa SccmIntegrationTask-ajossa.
Määritykset
| Nimi | Pakollinen | Kuvaus |
|---|---|---|
| - | - | - |
TransformDataCardAction
- Toiminto muuntaa parhaillaan muokattavan tietokortin toiseksi tietokortiksi. Käyttää transformeissa määriteltyjä sääntöjä ja kohdekansiota.
- Yksi ActionChain voi sisältää useita TransformDataCard-toimintoja. Useiden uusien korttien luominen samassa ActionChainissa on myös tuettu.
Huomio:Title
Sinun on varmistettava lähde-ehdoilla, että muunnos tapahtuu vain halutuissa tilanteissa, esimerkiksi kun attribuutti saa arvon ensimmäistä kertaa. Muutoin uusia tietokortteja saatetaan luoda aina, kun isäntätietokortti siirretään tai kopioidaan toiseen kansioon tai poistetaan.
Määritykset
| Nimi | Pakollinen | Kuvaus |
|---|---|---|
| TargetTemplate | Kyllä | Kohdemallin koodi. |
Table of Contents