Übersicht der Macro Actions
Nachfolgend finden Sie eine Übersicht der mit KIX ausgelieferten Macro Actions zur Verwendung in Jobs oder Aktionen.
Tipp
Einige der Macro Actions bieten einen Editor zum Hinterlegen von Text an (z. B. Ticket anlegen oder Artikel erstellen). Wenn Sie KIX Platzhalter via Copy & Paste im Editor einfügen, werden diese aufgrund der spitzen Klammern nicht anerkannt. Verwenden Sie daher zum Einfügen von KIX Platzhaltern die Tastenkombination STRG + SHIFT + V bzw. COMMAND+ SHIFT + V.
Legt einen Artikel mit vordefinierten Inhalten an.
Verwendung/Jobtyp: Ticket
Die in der Macro Action anzugebenden Parameter entsprechen denen zum Anlegen eines neuen Artikels.
Zusätzliche Parameter sind:
Parameter | Beschreibung |
---|---|
Überspringen | Wenn aktiviert: Überspringt die Ausführung der Aktion |
NewArticleID | Ergebnisvariable. Individueller Bezeichner zum Speichern der Artikel ID (z. B. myArticleID). Über diese Variable kann auf den Artikel in nachfolgenden Macro Actions referenziert und deren Wert verwendet werden. |
DoNotSendEmail | Wenn aktiviert, wird das Versenden des neuen Artikels durch das System verhindert. So kann bspw. bei Kopplung von 2 Systemen verhindert werden, dass das Empfängersystem den Artikel noch einmal versendet, obwohl das Sendersystem dies bereits getan hat. |
Anhangsobjekt | Optional: Angabe eines Anhang-Objektes mit den Attributen Es ist der Bezeichner der Ergebnisvariable anzugeben. Z. B.: Anhang-Objekte können mit der Macro Action Objekt zusammenstellen erstellt werden. Anwendungsbeispiel: Berichte automatisiert erstellen |
Dynamische Felder | Setzen von Dynamischen Feldern am Artikel
HinweisEin Dynamisches Feld mit Objekttyp "Article" steht nur dann am Artikel zur Verfügung, wenn ein Kanal ausgewählt wurde. |
Hinweise:
Verwendung der ArtikelID s. Variablen
Soll ein mehrzeiliger Text (DF Typ "TextArea") in einen Artikel eingefügt werden, so müssen Sie das Suffix "_HTML" verwenden, um Zeilenumbrüche zu erhalten. Zum Beispiel: <KIX_TICKET_DynamicField_WorkOrder_HTML>
Löscht den durch die ArticleID identifizierten Artikel.
Die Historie am Ticket erhält den Eintrag, dass der Artikel gelöscht wurde.
Verwendung/Jobtyp: Ticket
Parameter | Hinweise |
---|---|
ArticleID | ID des zu löschenden Artikelswerden soll. Es können Platzhalter verwendet werden (z. B.: <KIX_LAST_ArticleID> ) |
Hinweise:
Das Löschen fungiert im Hintergrund; bei Jobs also mit den Berechtigungen des Systemusers.
Es gelten damit nicht die Rollenberechtigungen des auslösenden Nutzers wenn die Macro Action verwendet wird.
Die Aktion "ArticleDelete" verwendet ebenfalls diese Macro Action.
Referenziert auf ausgewählte Asset Attribute, um diese bspw. in den Ticketinformationen anzuzeigen.
Verwendung/Jobtyp: Ticket
Parameter | Beschreibung |
---|---|
Assetbezug aus dynamischen Feld: | Referenz zum Asset, dessen Attribute abgerufen werden sollen. Geben Sie den Namen des Dynamischen Felds an, welches die ID des zu verwendenden Assets enthält, z. B. AffectedAsset oder RelatedAssets. Beispiel: Sollen Attribute des am Ticket ausgewählten "betroffenen Assets" ausgelesen werden, so tragen Sie hier "AffectedAsset" ein. |
Attribut - Dynamisches Feld Mapping: | Definiert, welches Asset Attribut in welchem Dynamischen Feld angezeigt wird. Beispiel: Liest den Hersteller des Assets aus und zeigt diesen im Dynamischen Feld "DFHersteller" an.
(Der Wert des Dynamischen Feldes "DFHersteller" wird dort angezeigt, wo es in der Oberfläche eingebunden ist.) |
Praxisbeispiele: Asset Attribute in den Ticketdetails anzeigen
Setzt den Bearbeiter an einem Ticket.
Verwendung/Jobtyp: Ticket
Parameter | Beschreibung |
---|---|
Bearbeiter | ID oder Login-Name des Bearbeiters. KIX Platzhalter sind möglich, z. B.: <KIX_CURRENT_UserID> Hinweis: Es findet keine Prüfung statt, ob der gewählte Agent berechtigt ist, das Ticket zu bearbeiten. |
Prüft, ob eine Bedingung wahr (true) ist und ermöglicht so den Kontrollfluss in Macros.
Das Macro wird ausgeführt, wenn die Bedingung wahr ist.
Verwendung/Jobtyp: Asset, Berichte, Synchronisation, Ticket
Parameter | Beschreibung |
---|---|
Wenn | Logischer Ausdruck der Bedingung Z. B.: Ist die Variable
Sie können Platzhalter und die in vorangehenden Macros definierten Variablen verwenden. ![]() |
Macro | Das gewählte Macro wird ausgeführt, wenn die unter "If" angegebene Bedingung wahr (true) ist. Die zur Auswahl stehenden Jobtypen entsprechen den in den Job Informationen (Konfigurationsschritt 1 im Job) Zur Auswahl stehen die gleichen Jobtypen wie in Schritt 1 der Job-Konfiguration (Job Informationen). Jedoch sind die hier als Macro gewählten Jobtypen völlig unabhängig zu Ihrer Auswahl in den Job Informationen. Abhängig von Ihrer Auswahl, stehen Ihnen weitere Aktionen und Eingabefelder zur Verfügung. |
Hinweise
Mögliche Operatoren sind u. a.:
defined
- Prüfung auf Vorhandensein (true)!defined
- Prüfung auf Nichtvorhandensein (false)&&
- Logisches UND||
- Logisches ODER
Kombinierte Operatoren wie
if-else
oderif-not
sind nicht möglich.Sie müssen in einzelne Anweisungen gesplittet werden:
Bedingung 1 = if-Anweisung
Bedingung 2 = else-Anweisung
Die Macro Action unterstützt (eingeschränkten) Perl-Code.
Das heißt, es muss ein valider Perl-Ausdruck verwendet werden, der einen booleschen Wert ergibt.
Beachten Sie bei Vergleichen:
Texte werden mit
eq
(equals) verglichenZahlen werden mit
==
verglichen
Erzeugt einen Bericht auf Basis einer bestehenden Berichtsdefinition.
Verwendung/Jobtyp: Asset, Berichte, Synchronisation, Ticket
Parameter | Beschreibung |
---|---|
Berichtsdefinition | Auf Basis der gewählten Definition werden die Parameter des Berichts als Eingabefelder eingebunden. Tragen Sie die entsprechenden Werte ein. Die Werte werden durch den Job gesetzt und der Bericht erzeugt. Die Auswahl des Ausgabeformates ist ebenfalls abhängig von der Berichtsdefinition. Der Bericht liefert ein Ergebnis, was in Folgeaktionen auch als Variable verwendet werden kann. |
Bericht | Bezeichner der Ergebnisvariable. Der Bericht liefert ein Ergebnis, was in Folgeaktionen auch als Variable verwendet werden kann. |
Hinweis: Ein Anwendungsbeispiel finden Sie unter: Berichte automatisiert erstellen
Erstellt ein Ticket, welches auf einer Ticketvorlage mit Nutzungskontext "System" basiert (Systemvorlage).
Die Macro Action liefert als Rückgabewert die IDs des erstellten Tickets und - sofern in der Vorlage definiert - die ID des erstellten Artikels.
Verwendung/Jobtyp: Ticket
Parameter | Beschreibung |
---|---|
NewArticleID | Ergebnisvariable Individueller Name/Bezeichner einer Variable zum Speichern der Artikel ID (z. B. myArticleVariable) |
NewTicketID | Ergebnisvariable Individueller Name/Bezeichner einer Variable zum Speichern der Ticket ID (z. B. myTicketVariable) |
Template | Auswahl der Ticketvorlage, auf deren Basis die Tickets erstellt werden. Es stehen nur gültige Vorlagen mit Nutzungskontext "System" zur Auswahl. Legen Sie ggf. im Vorfeld entsprechende Ticketvorlagen an. |
Setzt einen Wert in ein Dynamisches Feld.
Verwendung/Jobtyp: Ticket
Parameter | Beschreibung |
---|---|
Überspringen | Wenn aktiviert: Überspringt die Ausführung der Aktion |
Objekt ID | Nur verfügbar in Jobs vom Typ "Ticket" ID des Objekts, an welchem das Dynamische Feld gesetzt werden soll, z. B. ID eines bestimmten Tickets oder eines bestimmten Artikels. Wichtig: Beachten Sie den Objekttyp des Dynamischen Feldes! Für Dynamische Felder mit Objekttyp "Ticket" muss die ID eines Tickets angegeben werden. Für Dynamische Felder vom Objekttyp "Artikel" muss die ID eines Artikels angegeben werden. Ist keine explizite ID angegeben, wird die ID des auslösenden Objekts verwendet ( |
Dynamic Field Name | Name des Dynamischen Feldes, z. B. "DFMobileProcessingState". |
Dynamic Field Value | Wert, der in das Dynamische Feld gesetzt werden soll, z. B. "accepted". Der zu setzende Wert ist abhängig vom Typ des Dynamischen Feldes:
|
Hinzufügen |
|
Setzt den Kontakt an einem Ticket.
Verwendung/Jobtyp: Ticket
Parameter | Beschreibung |
---|---|
Kontakt | ID, Login oder E-Mail-Adresse des zu setzenden Kontakts. KIX Platzhalter sind möglich. |
Hinweise:
Bei gleichzeitigem Setzen von Kunde und Kontakt erfolgt aktuell keine Prüfung auf
Abhängigkeit zwischen Kunde (Organisation) und Kontakt
Existenz des gesetzten Kontakts.
Mit dem Setzen eines Kontaktes wird dem Ticket dessen Primär-Organisation zugeordnet.
Das Setzen eines unbekannten Kontakts ist möglich.
Setzt den Kunden an einem Ticket.
Verwendung/Jobtyp: Ticket
Parameter | Beschreibung |
---|---|
Organisation | ID der Organisation oder Kundennummer. KIX Platzhalter sind möglich. |
Hinweise:
Bei gleichzeitigem Setzen von Kunde und Kontakt erfolgt aktuell keine Prüfung auf
Abhängigkeit zwischen Kunde (Organisation) und Kontakt
Existenz der gesetzten Organisation
Erlaubt das Ausführen weiterer Macros innerhalb einer MacroAction.
Zur Unterscheidung:
Die Macro Action Macro ausführen kann nur an einem spezifischen Objekt ausgeführt werden.
Die Macro Action Schleife hingegen kann auf mehrere Werte/Arrays ausgeführt werden.
Verwendung/Jobtyp: Asset, Berichte. Synchronisation. Ticket
Parameter | Beschreibung |
---|---|
ObjectID | Ergebnisvariable (Optional) Die ID des Objektes, für das das Macro ausgeführt werden soll. |
Macro | Das auszuführende Makro stellt - abhängig von seinem Typ - die entsprechenden Actions zur Verfügung. Die Makros können auch von einem anderen Typ sein und sind nicht vom gewählten JobTyp abhängig. |
Ein Anwendungsbeispiel finden Sie unter Berichte automatisiert erstellen
Fügt mehrere Objekte zu einem neuen Objekt zusammen.
Kann bspw. eine aus einem Bericht extrahierte Tabelle als Artikelanhang an ein Ticket anfügen.
Verwendung/Jobtyp: Asset, Berichte, Synchronisation, Ticket
Parameter | Beschreibung |
---|---|
Objekt | Bezeichner der Ergebnisvariable. Der angegebene Bezeichner ist eine "Text-Repräsentation" des unter "Definition" deklarierten Objekts. Auf dessen Attribute und Sub-Attribute kann zugegriffen werden.
Das Objekt besitzt die Eigenschaften:
|
Hinweise:
Ein unter Definition erzeugtes Attachment-Objekt hat 3 Eigenschaften:
Filename: Name und Dateiendung des erzeugten Attachmentobjekts (z. B. "dummy.csv")
ContentType: MIME Type des Inhalts (z. B.
${Report.Results:0.ContentType}
)Infos dazu auch unter: https://wiki.selfhtml.org/wiki/MIME-Type/%C3%9Cbersicht
Content: Inhalt des Attachmentobjekts mit Angabe der Pipe
Z. B.:
${Report.Results:0.Content|JSON}
Die Angabe der Pipe mit JSON (
|JSON
) ist notwendig, um den Inhalt valide in das JSON-Format einzufügen.
Ein Anwendungsbeispiel finden Sie unter Berichte automatisiert erstellen.
Setzt die Priorität an einem Ticket.
Verwendung/Jobtyp: Ticket
Parameter | Beschreibung |
---|---|
Priorität | Exakte Bezeichnung der Priorität Sie müssen den exakten Namen des Attributs verwenden, das im Backend gespeichert werden soll. |
Erzeugt mehrstufige (verschachtelte) Aktionen.
Die Macro Action Schleife kann verwendet werden, um ein referenziertes Macro zu definieren und dieses für verschiedene Objekte auszuführen. Bspw. um den in einem Ticket dokumentierten Workaround an alle Kind-Tickets weiterzugeben oder um Änderungen an einem Eltern-Ticket auch an allen Kind-Tickets vorzunehmen (z. B. "Flächenstörung").
Zur Unterscheidung: Die Macro Action Macro ausführen kann nur auf 1 spezifisches Objekt ausgeführt werden.
Mit der Macro Action Schleife können Aktionen beliebig verschachtelt werden. Dadurch können komplexe, mehrstufige Workflows abgebildet und Verweise zwischen mehreren, aufeinander verweisende Tickets für Automatismen genutzt werden. Achten Sie jedoch darauf, keine Endlosschleifen zu erzeugen!
Verwendung/Jobtyp: Asset, Berichte, Synchronisation, Ticket
Parameter | Beschreibung |
---|---|
Werte | Liste von Werten, die vom Loop berücksichtigt werden. Entweder kommaseparierte Liste oder durch einen Platzhalter generiertes Array (z. B. <KIX_TICKET_DynamicField_RelatedTickets_Key>). |
Schleifenvariable | Optional: Bezeichner der Ergebnisvariable für die aktuelle Loop-Wiederholung. Die Variable kann analog zu anderen Ergebnisvariablen verwendet werden. |
Maro | Konfigurationsmöglichkeit weiterer Aktionen der nächst tieferen Ebene. |
Beispiel zur Verwendung der Aktion: Verschachtelung von Macro Actions mit "Schleife"
Setzt den Sperrstatus eines Tickets.
Verwendung/Jobtyp: Ticket
Parameter | Beschreibung |
---|---|
Sperren | Exakte Bezeichnung des Sperrstatus, z. B. "lock" oder “unlock” |
Setzt den Status am Ticket.
Verwendung/Jobtyp: Ticket
Parameter | Beschreibung |
---|---|
Status | Wählen Sie den zu setzenden Status aus. z. B. neu | offen | warten zu Erinnerung |
Hinweise:
Bei Setzen eines Warten-Status (Statustypen "pending reminder" oder "pending auto") sind weitere Parameter möglich. Zudem muss mindestens eine Angabe zur Wartezeit definiert werden:
Warten" - Zeitdifferenz: Differenz des zu setzenden Zeitpunktes zum Ausführungszeitpunkt bzw. relative Wartezeit in Sekunden. Eine Angabe in Form "60 * 60 * 24" ist möglich. Nicht zulässige Werte, werden als "0" interpretiert.
Warte Zeitpunkt: Zielzeitpunkt in Format "YYYY-MM-DD hh:mm:ss". Es können auch Platzhalter verwendet werden, um Zielzeitpunkte bspw. aus dynamischen Feldern des Typs Date oder DateTime zu beziehen (z. B. KIX_TICKET_DynamicField_DatumZeit).
Zielzeit: kann den Wert EOB
, BOB
oder <leer>
annehmen.
BOB
setzt den "Begin Of Businessday" des durch PendingDiffTime oder PendingDateTime avisiert Zielzeitpunkts.Liegt der Zielzeitpunkt außerhalb der Servicezeit wird der nächste Servicetag betrachtet.
EOB
setzt den "End Of Businessday".Wird keine der Optionen genutzt, wird der exakte Zeitpunkt eingetragen.
PendingTimeOffset hat Vorrang gegenüber PendingDateTime.
Wird bei PendingTimeOffset oder PendingDateTime eine Zeit angegeben und zusätzlich EOB oder BOB, hat die Eingabe bei Target Time Vorrang.
Setzt das Team an einem Ticket.
Verwendung/Jobtyp: Ticket
Parameter | Beschreibung |
---|---|
Team | Vollständige Bezeichnung des zu setzenden Teams. KIX Platzhalter sind möglich. Um untergeordnete Teams zu setzen, gilt folgende Schreibweise: Ebene1::Ebene2::Ebene3 Beispiel: 2nd-Level::On Site::Chemnitz
|
Extrahiert Teile aus einem bestehenden Text.
Die Macro Action Kann bspw. die in einem Bericht erzeugte Ergebnistabelle (oder Teile davon) extrahieren, um sie im Nachrichtentext oder im Artikelanhang bereitzustellen.
Verwendung/Jobtyp: Asset, Berichte. Synchronisation. Ticket
Parameter | Beschreibung |
---|---|
ExtractedText | Ergebnisvariable Individueller Bezeichner der Ergebnisvariable, welche den extrahierten Text aufnimmt. |
RegEx | Gültiger Regulärer Ausdruck z. B. |
Text | Der Text, auf dem die RegEx angewendet werden soll. Sie können Variablen und Platzhalter verwenden, z. B. |
Capture Group Names | Optionale Benennung der einzelnen Capture Groups des RegEx. Sind keine Namen angegeben, werden die Gruppen per Index durchnummeriert (1,..., n) |
Bei Verwendung als Variable in anderen Actions:
Wird kein Variablenname vergeben, so lautet dieser:
ExtractedText
Zugriff auf Werte der Variable erfolgt mittels Angabe der Capture Group, z. B.:
keine Variable definiert und auch keine benannte Capture Group:
${ExtratcedText.1}
benannte Variable und benannte Capture Group:
${MyVariable.MyValue}
Ein Anwendungsbeispiel finden Sie unter Berichte automatisiert erstellen
Legt ein neues Ticket mit vordefinierten Werten an.
Verwendung/Jobtyp: Ticket
Die anzugebenden Parameter sind analog zur Ticketerstellmaske. Zusätzlich können Ergebnisvariablen und Dynamische Felder inkl. ihrer Werte verwendet werden.
Parameter | Beschreibung |
---|---|
Ergebnisbezeichnungen | Ermöglicht die Speicherung der Ticket ID in einer Variablen, um bspw. in nachfolgenden Macro Actions darauf zu referenzieren (s. Variablen)
|
Anhangsobjekt 1 bis 5 | Optional: Angabe eines Anhang-Objektes mit den Attributen Es ist der Bezeichner der Ergebnisvariable anzugeben. Z. B.: Anhang-Objekte können mit der Macro Action Objekt zusammenstellen erstellt werden. Anwendungsbeispiel: Berichte automatisiert erstellen |
Article Dynamic Fields | Setzen von Dynamischen Feldern am Artikel
|
Ticket Dynamic Fields | Setzen von Dynamischen Feldern am Ticket
|
Hinweise:
Falls nichts gesetzt wird, gelten folgende Standardwerte:
Sperrstatus: "unlock"
Bearbeiter: der aktuelle Nutzer wird gesetzt
Verantwortlicher: root (ID: 1)
Kunde:
wenn Kontakt gefunden: dessen Organisation
kein Kontakt gefunden: Kontakt als unbekannter Kontakt
Type: Wert aus SysConfig-Schlüssel "Ticket::Type::Default"
Soll in den Artikeltext ein mehrzeiliger Text (DF Typ "TextArea") via KIX-Platzhalter eingefügt werden, so müssen Sie das Suffix
_HTML
verwenden, um Zeilenumbrüche zu erhalten.Beispiel: <KIX_TICKET_DynamicField_WorkOrder_HTML>
Konfigurieren Sie Benachrichtigungen so, dass kein neuer Artikel anlegt wird. Sonst erscheint diese Benachrichtigung als erster Artikel.
Löscht Tickets.
Achtung
Die Aktion kann nicht rückgängig gemacht werden!
Es ist nicht möglich, spezifische Tickets zu löschen, da die Ticketnummer nicht als Filterkriterium zur Verfügung steht.
Diese Aktion beendet den Job. Nachfolgende, ticketbezogene Aktionen werden nicht ausgeführt (außer Ticket erstellen).
Verwendung/Jobtyp: Ticket
Parameter | Beschreibung |
---|---|
keine | - |
Setzt den Titel an einem Ticket.
Verwendung/Jobtyp: Ticket
Parameter | Beschreibung |
---|---|
Titel | Der Text des zu setzenden Titels. KIX Platzhalter sind möglich. Es können jedoch keine Platzhalter für Dynamische Felder der Typen "Checklist" und "Dropdown" verwendet werden. |
Setzt den Tickettyp an einem Ticket.
Verwendung/Jobtyp: Ticket
Parameter | Beschreibung |
---|---|
Typ | Exakte Bezeichnung des zu setzenden Typs, z. B. "Vorfall". |
Deklariert eine Variable zur flexiblen Verwendung in nachfolgenden Actions.
Verwendung/Jobtyp: Asset, Berichte, Synchronisation, Ticket
Parameter | Beschreibung |
---|---|
Variable | Individueller Bezeichner der Variable Die Variable dient als Ergebnisvariable. Sie kann folgende Werte aufnehmen:
|
Wert | Wert mit dem die Variable vordefiniert sein soll oder Variablenbezeichner/Platzhalter für den zu setzenden Wert. |
Setzt den Verantwortlichen an einem Ticket.
Verwendung/Jobtyp: Ticket
Parameter | Beschreibung |
---|---|
Verantwortlicher | ID oder Login-Name des Verantwortlichen KIX Platzhalter sind möglich Es findet keine Prüfung statt, ob der gewählte Agent berechtigt ist, das Ticket zu bearbeiten. |