Actions mises en œuvre par l'auditeur ESM
Actions mises en œuvre par l'auditeur ESM
AlwaysFailDataCardAction
Classe : com.efecte.datamodel.entity.action.implementations.AlwaysFailDataCardAction
Déclencheur : pré-enregistrement
Description : Empêche l'enregistrement de la carte de données.
Éléments de configuration
| Nom | Requis | Description |
|---|---|---|
| Message d'erreur | Non | Un message d'erreur facultatif s'affiche pour l'utilisateur dans les fichiers journaux. La valeur peut être un texte de présentation à des fins de localisation. La valeur par défaut est Erreur de validation (text_validator_error) (Depuis TODO : ajouter le numéro de build (EN COURS D'IMPLÉMENTATION)). |
Exemple
<action>
<name>Prevent saving of data card</name>
<class>com.efecte.datamodel.entity.action.implementations.AlwaysFailDataCardAction</class>
</action>ChangeDataCardValuesAction
Classe : com.efecte.datamodel.entity.action.implementations.ChangeDataCardValuesAction
Déclencheur : pré-enregistrement ou post-enregistrement
Description : Définit la valeur d'un attribut.
Éléments de configuration
| Nom | Requis | Description |
|---|---|---|
| Code | Oui | Code de l'attribut. |
| Valeur | Oui | Nouvelle valeur pour l'attribut. Étant donné que la valeur est donnée sous forme de texte, les types de données possibles sont limités ; par exemple, les références ne fonctionnent pas. Une valeur vide (exprimée par <valeur></valeur>) signifie que la valeur de l'attribut est vidée [depuis 4.2/4.1 4110 ; auparavant, cela ne fonctionnait pas et provoquait des erreurs avec la plupart des types de données]. |
Exemple
<action>
<name>Set value to Closed</name>
<class>com.efecte.datamodel.entity.action.implementations.ChangeDataCardValuesAction</class>
<configuration_item>
<name>Code</name>
<value>jobstate</value>
</configuration_item>
<configuration_item>
<name>Value</name>
<value>Closed</value>
</configuration_item>
</action>Copier les valeurs de la carte de donnéesAction
Classe : com.efecte.datamodel.entity.action.implementations.CopyDataCardValuesAction
Déclencheur : pré-enregistrement ou post-enregistrement
Description : Copie une valeur de la carte de données source vers la valeur d'un autre attribut ou vers la valeur d'un attribut de la carte de données cible. Possibilité de copier également les valeurs derrière des références.
4.2 (>=4209) Si l'attribut copié est multivaleur, les valeurs existantes seront REMPLACÉES. Ceci n'est pas configurable. Les valeurs multiples fonctionnent uniquement sur la carte de données hôte, et non derrière les références.
Éléments de configuration
| Nom | Requis | Description |
|---|---|---|
| Code | Oui | Code de l'attribut à modifier. |
| Valeur | Oui | Code de l'attribut de la carte de données source d'où la valeur est copiée. Ou, en cas de copie depuis une référence : $source_data_card_reference_attribute_code:referred_data_card_attribute_code$ |
Exemple
<action>
<name>Copy parent incident's status to child indicents</name>
<class>com.efecte.datamodel.entity.action.implementations.CopyDataCardValuesAction</class>
<configuration_item>
<name>Code</name>
<value>jobstate</value>
</configuration_item>
<configuration_item>
<name>Value</name>
<value>jobstate</value>
</configuration_item>
</action>CopierSourceReferenceAction
Classe : com.efecte.datamodel.entity.action.implementations.CopySourceReferenceAction
Déclencheur : post-enregistrement
Description : Copie une référence à la carte de données source vers les cartes de données cible. (Depuis : Effet 4.1 4111).
| Nom | Requis | Description |
|---|---|---|
| Code | Oui | Un code d'attribut de référence dans la carte de données cible. Cet attribut obtiendra une référence à la carte de données source. |
Exemple
<action>
<name></name>
<class>com.efecte.datamodel.entity.action.implementations.CopySourceReferenceAction</class>
<configuration_item>
<name>Code</name>
<value></value>
</configuration_item>
</action>Créer une action de carte de données
Classe : com.efecte.datamodel.entity.action.implementations.CreateDataCardAction
Déclencheur : post-enregistrement
Description : Crée une nouvelle carte de données, basée sur un modèle configuré et dans un dossier configuré. Ajoute éventuellement des références entre le créateur et les cartes de données créées, et définit les valeurs d'attributs de la carte créée. L'heure de début de la modification dans l'interface graphique d'Efecte peut être ajoutée (voir SC-604).
Éléments de configuration
| Nom | Requis | Description |
|---|---|---|
| Modèle | Oui | Code du modèle sur lequel sera basée la nouvelle carte de données. |
| Dossier | Oui | Code du dossier dans lequel la carte de données créée sera stockée. :SOURCE: utilisera le dossier du créateur. |
| Référence de la source | Non | Code d'attribut pour l'attribut de référence ou de référence arrière dans la carte de données du créateur qui obtiendra une référence à la carte de données nouvellement créée. |
| attribut_code_en_création | Non | Valeur spécifique au type de données à définir pour l'attribut indiqué. Notez que cette valeur est soumise à des macros spécifiques au type de données, telles que les macros de date. |
| attribut_code_en_création | Non | :EDITING_START_TIME: place l'heure de début de modification dans un attribut date ou chaîne de la carte de données créée. Notez que l'heure de début de modification n'est disponible que si la modification ayant déclenché cette action a été effectuée via la vue d'édition de l'interface utilisateur graphique ; cet élément de configuration doit donc être utilisé avec la condition source GuiEdit. |
| attribut_code_en_création | Non | :SOURCE: créera une référence au créateur dans un attribut de référence ou copiera le nom du créateur dans un attribut de chaîne. |
| attribut_code_en_création | Non | $reférence_path_to_creator_attribute$ copie la valeur de l'attribut indiqué du créateur dans l'attribut indiqué du créé. |
Exemple
<action>
<name>Create new editing report</name>
<class>com.efecte.datamodel.entity.action.implementations.CreateDataCardAction</class>
<configuration_item>
<name>Template</name>
<value>editing_report</value>
</configuration_item>
<configuration_item>
<name>Folder</name>
<value>editing_reports/value>
</configuration_item>
<configuration_item>
<name>Reference from source</name>
<value>ref_to_editing_reports</value>
</configuration_item>
<configuration_item>
<name>start_time</name>
<value>:EDITING_START_TIME:</value>
</configuration_item>
<configuration_item>
<name>end_time</name>
<value>now</value>
</configuration_item>
<configuration_item>
<name>incident_subject</name>
<value>$subject$</value>
</configuration_item>
<configuration_item>
<name>ref_to_incident</name>
<value>:SOURCE:</value>
</configuration_item>
</action>EntitéDataCardAction
Classe : com.efecte.datamodel.entity.action.implementations.EntityDataCardAction
Déclencheur : pré-enregistrement
Description : Déplace une carte de données vers la corbeille, la restaure depuis la corbeille, la supprime définitivement, la masque ou la rend visible. Notez que, par exemple, le gestionnaire DatacardHiddenState peut entrer en conflit avec un écouteur contenant cette action. Si le modèle possède un gestionnaire DatacardHiddenState, l'implémentation de l'écouteur doit en tenir compte.
Note:
L'action « supprimer définitivement » ne fonctionne actuellement pas avec les autorisations non root --> BUG-003907
Éléments de configuration
| Nom | Requis | Description |
|---|---|---|
| Action de l'entité | Oui | Action : « corbeille », « restaurer », « supprimer définitivement », « masquer », « rendre visible » |
Exemples
<action>
<name>Move data card to trashcan</name>
<class>com.efecte.datamodel.entity.action.implementations.EntityDataCardAction</class>
<configuration_item>
<name>Entity action</name>
<value>trashcan</value>
</configuration_item>
</action>
<action>
<name>Restore data card from trashcan</name>
<class>com.efecte.datamodel.entity.action.implementations.EntityDataCardAction</class>
<configuration_item>
<name>Entity action</name>
<value>restore</value>
</configuration_item>
</action>
<action>
<name>Permanently delete data card</name>
<class>com.efecte.datamodel.entity.action.implementations.EntityDataCardAction</class>
<configuration_item>
<name>Entity action</name>
<value>delete permanently</value>
</configuration_item>
</action>
<action>
<name>Hide data card</name>
<class>com.efecte.datamodel.entity.action.implementations.EntityDataCardAction</class>
<configuration_item>
<name>Entity action</name>
<value>hide</value>
</configuration_item>
</action>
<action>
<name>Set data card visible</name>
<class>com.efecte.datamodel.entity.action.implementations.EntityDataCardAction</class>
<configuration_item>
<name>Entity action</name>
<value>set visible</value>
</configuration_item>
</action>ExpressionAction
Classe : com.efecte.datamodel.entity.action.implementations.ExpressionAction
Déclencheur : pré-enregistrement ou post-enregistrement
Description : Exécutera un script Python défini sur les cartes de données cibles. (Depuis : Effet 4.1 4111).
Note:
Le nom de l'action est un peu trompeur, car il exécute des scripts et non des expressions (car les termes sont utilisés dans le contexte des gestionnaires de validateur et d'expression).
Éléments de configuration
| Nom | Requis | Description |
|---|---|---|
| Code | Oui | Code d'un attribut de la carte de données cible. Le résultat de l'expression sera défini sur cet attribut. |
| Expression | Oui | Le script Python à exécuter. |
DossierDataCardAction
Classe : com.efecte.datamodel.entity.action.implementations.FolderDataCardAction
Déclencheur : pré-enregistrement ou post-enregistrement
Description : Déplace une carte de données vers un dossier spécifique.
Éléments de configuration
| Nom | Requis | Description |
|---|---|---|
| Dossier | Non | Code du dossier dans lequel la carte de données est déplacée, ou « :SOURCE: » si la carte de données est déplacée vers le même dossier où se trouvent les données sources. |
| Attribut de dossier | Non | Code d'attribut dont la valeur correspond au code du dossier où la carte de données est déplacée. Si un dossier est configuré, il sera utilisé à la place. |
| Dossier de secours | Non | Code du dossier dans lequel la carte de données est déplacée s'il n'y a pas de dossier disponible qui a été configuré avec un dossier ou un attribut Dossier . |
Si l'action n'est pas configurée, la carte de données est déplacée vers le même dossier que la carte source. Il est toutefois recommandé de spécifier la configuration du dossier. Le dossier de la carte source est le dossier par défaut, car cette action remplaçait une autre action qui déplaçait les cartes cibles vers le dossier de la carte source. Un script de mise à jour, qui aurait généré la configuration nécessaire, aurait été trop complexe.
- Depuis >=4226. Fonctionne avec (testé) les chaînes, les nombres, les décimales, les dates, les dates et heures, les références, les chaînes et les nombres statiques. Peut également fonctionner avec d'autres types de données. Non testé avec DropDownReference, mais je ne vois pas pourquoi cela ne fonctionnerait pas avec lui aussi.
Exemples
<action>
<name>Move data card to another folder</name>
<class>com.efecte.datamodel.entity.action.implementations.FolderDataCardAction</class>
<configuration_item>
<name>folder</name>
<value>folder_code</value>
</configuration_item>
</action>
<action>
<name>Move data card to another folder specified by an attribute</name>
<class>com.efecte.datamodel.entity.action.implementations.FolderDataCardAction</class>
<configuration_item>
<name>Folder attribute</name>
<value>attribute_code</value>
</configuration_item>
</action>EnregistrerDataCardAction
Classe : com.efecte.datamodel.entity.action.SaveDataCardAction
Déclencheur : post-enregistrement
Description : Enregistre la carte de données. Cela permet de calculer de nouvelles valeurs pour les attributs contenant un gestionnaire (ExpressionHandler ou similaire).
Éléments de configuration
| Nom | Requis | Description |
|---|---|---|
| - | - | - |
Exemple
<action_chain>
<name>Saves datacards</name>
<action>
<name>Saving datacards</name>
<class>com.efecte.datamodel.entity.action.SaveDataCardAction</class>
</action>
</action_chain>EnregistrerDataCardXmlToFileAction
Depuis : 5.4 5400
Classe : com.efecte.datamodel.entity.action.SaveDataCardXmlToFileAction
Déclencheur : post-enregistrement
Description : Enregistre la carte de données au format XML dans un fichier et un dossier spécifiés. Notez que cette action ne s'applique qu'à la carte de données source enregistrée. Si le fichier existe, il sera écrasé (le fichier est supprimé avant l'écriture du nouveau fichier). L'action tente d'abord d'écrire le XML dans un fichier temporaire, puis renomme ce fichier temporaire en le fichier spécifié. Ceci permet d'empêcher toute lecture du fichier résultat avant son écriture complète.
Éléments de configuration
| Nom | Requis | Description |
|---|---|---|
| Fichier cible | Oui | Nom du fichier (chemin) où le XML est enregistré. Peut contenir les macros suivantes : $now$, $TIMESTAMP$ et $ENTITY_ID$. Ces macros contiennent respectivement la date du jour (au format aaaa-MM-jj), l'horodatage (temps écoulé en millisecondes depuis l'époque) et l'identifiant de la carte de données dans la base de données. |
Exemple
<action>
<name>Save to file</name>
<class>com.efecte.datamodel.entity.action.implementations.SaveDataCardXmlToFileAction</class>
<configuration_item>
<name>Target file</name>
<value>C:/Temp/entity-$ENTITY_ID$-$TIMESTAMP$.xml</value>
</configuration_item>
</action>EnvoyerDataCardXmlToWebService
Depuis : 4.2 4235
Classe : com.efecte.datamodel.entity.action.implementations.webservice.SendDataCardXmlToWebService
Déclencheur : post-enregistrement
Description : Envoie une carte de données au format XML au service Web SOAP configuré. Notez que cette action s'applique uniquement à la carte de données source enregistrée.
Éléments de configuration
| Nom | Requis | Description |
|---|---|---|
| adresse du point de terminaison | Oui | Adresse du point de terminaison définissant l'emplacement du service Web. Exemple : http://localhost:8080/axis2/services/EfecteNotifyService. Vous pouvez saisir directement l'utilisateur et le mot de passe dans l'URL si l'authentification HTTP BASIC est utilisée côté service Web. L'URL ressemblera alors à ceci : http://user:password@localhost:8080/axis2/services/EfecteNotifyService |
| ensemble d'entités espace de noms cible | Oui | Espace de noms cible pour l'élément entityset. Exemple : http://integration.efecte.com/notify/request |
| nom de l'opération | Oui | Opération : actuellement, seule la valeur peut être « Notifier » |
| Exiger des données modifiées | Oui | Vrai ou Faux. Si la valeur est Vrai, le message est envoyé uniquement en cas de modification. Si la valeur est Faux, le message est systématiquement envoyé lors de l'enregistrement de la carte de données. Les conditions source peuvent toujours être utilisées pour définir le moment d'exécution de cette action. Par exemple, le message est envoyé uniquement lorsque la valeur d'un attribut a changé. |
Envoyer un e-mail
Classe : com.efecte.datamodel.entity.action.implementations.SendMailAction
Déclencheur : post-enregistrement
Description : Envoie du courrier.
Depuis : 5.1 build 5114
Remarques :
- La suppression de la carte de données déclenche également des écouteurs, alors soyez prudent avec les conditions de la source.
- L'action n'empêche pas le stockage des données de la carte même si le courrier ne peut pas être envoyé pour une raison quelconque (mauvaise configuration, serveur de messagerie en panne, etc.).
- Si les écouteurs sont configurés pour être exécutés en tant qu'utilisateur non root, assurez-vous que l'utilisateur configuré peut accéder aux attributs requis.
- Les paramètres du serveur de messagerie sont définis dans les paramètres de la plateforme. Ils ne peuvent pas être modifiés dans la configuration de l'écouteur.
- Au moins un des éléments de configuration À, Cc ou Cci doit avoir une valeur.
- Différences avec AutoMailSenderHandler :
- Les métadonnées de dossier
automail_recipientetautomail_recipient_[attribute_code]ne sont pas prises en charge. Elles peuvent être remplacées par FolderSourceConditions. - Les balises
$name$,$template$et$from$ne sont pas prises en charge. - Le paramètre « do_not_check_for_change » n'est pas pris en charge. Comme cette action ne vérifie pas si les valeurs de la carte de données changent, ce paramètre n'est pas nécessaire. SourceConditions peut être utilisé pour implémenter des conditions préalables à cette action.
- Les métadonnées de dossier
Éléments de configuration
| Nom | Requis | Description |
|---|---|---|
| Depuis | Oui | Adresse(s) de l'expéditeur. Peut inclure des références à des attributs au format $attribute_code$ ou $code_of_reference:attribute_code$. Séparez les adresses par une virgule ou un point-virgule. |
| À | Non | Adresse(s) du/des destinataire(s). Peut inclure des références à des attributs au format $attribute_code$ ou $code_of_reference:attribute_code$. Séparez les adresses par une virgule ou un point-virgule. |
| Cc | Non | Adresse(s) du/des destinataire(s) en copie carbone. Peut inclure des références à des attributs au format $attribute_code$ ou $code_of_reference:attribute_code$. Séparez les adresses par une virgule ou un point-virgule. |
| Cci | Non | Adresse(s) du ou des destinataires en copie carbone invisible. Peut inclure des références à des attributs au format $attribute_code$ ou $code_of_reference:attribute_code$. Séparez les adresses par une virgule ou un point-virgule. |
| Sujet | Non | Objet du message. Peut inclure des références à des attributs au format $attribute_code$ ou $code_of_reference:attribute_code$. Les valeurs multiples sont séparées par une virgule. |
| Message | Non | Texte du message. Le texte peut contenir des sauts de ligne. <![CDATA[]]> peut être utilisé si des caractères spéciaux sont nécessaires. Peut inclure des références à des attributs au format $attribute_code$ ou $code_of_reference:attribute_code$. Les valeurs multiples sont séparées par une virgule. |
| Type de contenu | Non | Type MIME du message. Par exemple, text/html. La valeur par défaut est text/html. Les valeurs possibles sont text/plain et text/html. |
| Envoyer une fois | Non | ID unique. Si l'option « Envoyer une fois » est activée, l'écouteur n'enverra qu'un seul e-mail par carte de données donnée. Si AutoMailSender est remplacé par un écouteur, utilisez l'ID de classe de l'attribut AutoMailSender comme valeur. Lorsque vous créez une nouvelle action SendMailAction sans configuration préalable d'AutoMailSender, utilisez l'ID unique de votre choix. Assurez-vous simplement qu'aucun autre écouteur n'utilise le même ID (sauf si vous souhaitez que deux ou plusieurs écouteurs utilisent le même ID). |
| Pièces jointes | Non | Nom(s) des fichiers du répertoire « uploads/sendmailaction ». Les fichiers doivent être ajoutés manuellement au serveur, car Efecte ne dispose pas d'interface graphique pour cela. Référence(s) à un ou plusieurs attributs au format $attribute_code$ ou $code_of_reference:attribute_code$. Les attributs doivent être de type Référence externe. Séparez les fichiers par un point-virgule. |
Exemple
<action>
<name>Send mail</name>
<class>com.efecte.datamodel.entity.action.implementations.SendMailAction</class>
<configuration_item>
<name>From</name>
<value>servicedesk@company.com</value>
</configuration_item>
<configuration_item>
<name>To</name>
<value>$customer:email$</value>
</configuration_item>
<configuration_item>
<name>Subject</name>
<value>Your request for support - $Identifier$ has been received</value>
</configuration_item>
<configuration_item>
<name>Message</name>
<value>Thank you for contacting Service.</value>
</configuration_item>
</action>EnvoyerSourceChangedJMSMessageAction
Classe : com.efecte.datamodel.entity.action.implementations.SendSourceChangedJMSMessageAction
Déclencheur : pré-enregistrement ou post-enregistrement
Description : L'action envoie un message JMS à la file d'attente lors de l'enregistrement de la carte de données. Le contenu du message correspond à la carte de données dans son intégralité, au format XML.
Éléments de configuration
| Nom | Requis | Description |
|---|---|---|
| URL | Oui | URL où le message est envoyé. |
| Sujet | Oui | Sujet de la file d'attente. |
| Utilisateur | Non, mais nécessaire avec Efecte Integration Suite | Compte utilisateur. |
| Mot de passe | Non, mais nécessaire avec Efecte Integration Suite | Mot de passe pour le compte utilisateur. |
| Exiger des données modifiées | Oui | Vrai ou Faux. Si la valeur est Vrai, le message est envoyé uniquement en cas de modification. Si la valeur est Faux, le message est systématiquement envoyé lors de l'enregistrement de la carte de données. Les conditions source peuvent toujours être utilisées pour définir le moment d'exécution de cette action. Par exemple, le message est envoyé uniquement lorsque la valeur d'un attribut a changé. |
| Encodage Xml | Non | Codage optionnel pour le XML. |
Action de mise à jour Sccm ciblée
Depuis : 5.1 51??
Classe : com.efecte.integration.database.inventory.TargetedSccmUpdateAction
Déclencheur : post-enregistrement
Description : Déclenche une mise à jour SCCM ciblée. Elle doit être associée au modèle de logiciel administré et déclenchée lorsqu'un AS devient « Surveillé » (voir l'exemple ci-dessous). L'action recherche les ordinateurs sur lesquels ce logiciel semble être installé (d'après le champ « Tous les logiciels installés »). Elle récupère ensuite les identifiants de ressources SCCM de ces ordinateurs, les met en file d'attente pour la mise à jour, puis demande à SccmIntegrationTask d'effectuer une exécution ciblée en utilisant uniquement les identifiants en file d'attente.
Notez que l'exécution de la tâche s'effectue en arrière-plan ; il n'y a donc pas de délai significatif lors de l'enregistrement de la carte de données d'origine. L'exécution de la tâche démarre après quelques minutes. Ainsi, si plusieurs cartes AS sont surveillées en peu de temps, tous les identifiants de ressources sont regroupés et mis à jour dans la même tâche SccmIntegrationTask.
NB : nous avons également envisagé de lui donner un nom plus générique, par exemple quelque chose lié à l'inventaire de la base de données, ou même « RunSchedulableTaskAction », mais comme il est désormais lié à SCCM et ne déclenche qu'un certain type d'exécution de SccmIntegrationTask, il est nommé ainsi.
Éléments de configuration
Aucun élément de configuration n'est nécessaire.
Exemple
<template code="LicenseManagementSoftware" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
<listener>
<name>postsave.4.When Administered software becomes Monitored, update installation information from SCCM</name>
<trigger>post save</trigger>
<source_conditions boolean="AND">
<source_condition>
<value>
<attribute>
<code>monitored_software_status</code>
<current_value>true</current_value>
</attribute>
<operator>=</operator>
<compared_value>Monitored</compared_value>
</value>
</source_condition>
<source_condition>
<value>
<attribute>
<code>monitored_software_status</code>
<current_value>false</current_value>
</attribute>
<operator>!=</operator>
<compared_value>Monitored</compared_value>
</value>
</source_condition>
</source_conditions>
<action_chain>
<name>Run targeted SCCM update</name>
<action>
<name>Run targeted SCCM update</name>
<class>com.efecte.integration.database.inventory.sccm.TargetedSccmUpdateAction</class>
</action>
</action_chain>
</listener>
</template>TransformerDataCardAction
Depuis : 4.2 4210
Classe : com.efecte.datamodel.entity.action.implementations.TransformDataCardAction
Déclencheur : post-enregistrement
Description : L'action transforme la carte de données actuellement modifiée en une autre. Elle utilise les règles et le dossier cible définis dans les transformations. Les règles ne peuvent pas être définies dans le XML de l'écouteur lui-même.
Note:
Vous devez vous assurer, avec les conditions source, que la transformation n'intervient que dans les situations souhaitées, par exemple lorsqu'un attribut obtient une valeur pour la première fois. Sinon, de nouvelles cartes de données risquent d'être créées chaque fois que la carte de données hôte est déplacée, copiée vers un autre dossier ou supprimée.
Une ActionChain peut contenir plusieurs actions TransformDataCard. La création de plusieurs cartes dans une ActionChain est également prise en charge depuis la version 4.2 4210.
Éléments de configuration
| Nom | Requis | Description |
|---|---|---|
| Modèle de cible | Oui | Code du modèle cible. |
Exemple
<action_chain>
<name>Transform datacard</name>
<action>
<name>Transform</name> <class>com.efecte.datamodel.entity.action.implementations.TransformDataCardAction</class>
<configuration_item>
<name>TargetTemplate</name>
<value>service_request</value>
</configuration_item>
</action>
</action_chain>