ks.activity

Mit ks.activity lassen sich ActivityLog Einträge jeder Art programmatisch erstellen.

createCustomActivity

Erstellt ein ActivityLog Eintrag des übergebenen Typen an dem angegebenen Datensatz.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
entity	Objekt	Ja	Datensatz an dessen ActivityStream die Nachricht hinzugefügt werden soll
customActivity	Objekt	Ja	Der Inhalt der Nachricht, definiert durch die CustomActivityMessage
user	Objekt	Nein	Optionaler User, der als Ersteller der Nachricht hinterlegt wird
isApi	Boolean	Nein	Steuert ob Auslöser ein User oder eine API war

Beispiel

Das Beispiel zeigt, wie Sie eine AppMessage an einen beliebigen Datensatz hinzufügen.

const incident = await ks.record.get('Incident', 'd2f78da5-fbd3-fe91-4046-3b5aea0648f6');
await ks.activity.createCustomActivity(incident, {
    type: 'appMessage',
    body: ks.translate.instant('Incident.StaleAfter7d')
}, user, true);

CustomActivityMessage

type

Steuert den Typ der ActivityLog Nachricht die erstellt wird. Folgende Typen sind möglich:

• externalMessage
• internalMessage
• email
• appMessage
• relation
• change
• created
• deleted

body

Der Hauptinhalt der erstellten Nachricht

header

Fungiert bei appMessage, externalMessage und internalMessage als Überschrift und bei email als Betreffzeile.

recipients

String Array aus E-Mail-Adressen, an die die E-Mail gesendet werden soll.

cc

String Array aus E-Mail-Adressen, die als CC zur E-Mail hinzugefügt werden soll.

attachments

Array aus Anhängen die mit an die E-Mail gehangen werden soll.

send

Steuert, ob eine E-Mail aus dem ActivityLog Eintrag generiert und gesendet werden soll.

Default Wert: true

save

Steuert, ob der ActivityLog Eintrag schlussendlich gespeichert werden soll und somit auch im Activity Stream des Datensatzes landet.

Default Wert: true