Lieferumfang
Workflows
LABTAGON_SHAREPOINT_Example_ComputerExport
Der Workflow LABTAGON_SHAREPOINT_Example_ComputerExport synchronisiert Computerobjekte aus dem Matrix42 ESM System mit einer SharePoint-Liste.
Dabei führt der Workflow folgende Aktionen aus:
- stellt eine Verbindung zu SharePoint her
- prüft für jedes ausgewählte Computerobjekt, ob bereits ein Eintrag in der SharePoint-Liste existiert
- erstellt neue Einträge, wenn noch kein entsprechender Listeneintrag vorhanden ist
- aktualisiert bestehende Einträge, wenn sich die Daten des Computers geändert haben
- löscht Einträge, wenn der Computer im Matrix42 ESM System den Status Verschrottet hat
Der Workflow arbeitet aktionsbasiert und wird gezielt für ausgewählte Computer ausgeführt.
Eine Schritt-für-Schritt-Anleitung zur Einrichtung des Workflows, inklusive Serviceverbindung, SharePoint-Konfiguration und Aktionserstellung, findest du im Abschnitt Schnellstart.
Workflow Aktivitäten
AddSharePointItem
Die Workflow Aktivität AddSharePointItem erstellt ein neues Element in einer SharePoint-Liste.
Eingabeparameter
| Name | Typ | Erforderlich | Beschreibung | Beispiel |
|---|---|---|---|---|
| Connection | SharePointConnection |
✔ | Gibt die SharePoint-Verbindung an, über die die API-Aufrufe erfolgen. | - |
| List | string |
✔ | Name der SharePoint-Liste, in der das Element erstellt wird. | Computer |
| Fields | List<ObjectExpressionParameter> |
✔ | Feldzuweisungen für das neue Listenelement (interne Feldnamen). | Title = "PC-001" |
Ausgabeparameter
| Name | Typ | Beschreibung | Beispiel |
|---|---|---|---|
| ItemId | int |
ID des neu erstellten SharePoint-Listenelements. | 42 |
Info
Diese Workflow Aktivität unterstützt die in der Tabelle Unterstützte Feldtypen aufgeführten SharePoint-Feldtypen. Prüfe die Tabelle, um zu sehen, welche Feldtypen gelesen oder aktualisiert werden können.
DeleteSharePointItem
Die Workflow Aktivität DeleteSharePointItem löscht ein vorhandenes Element aus einer SharePoint-Liste.
Eingabeparameter
| Name | Typ | Erforderlich | Beschreibung | Beispiel |
|---|---|---|---|---|
| Connection | SharePointConnection |
✔ | Gibt die SharePoint-Verbindung an. | - |
| List | string |
✔ | Name der SharePoint-Liste. | Computer |
| ItemId | int |
✔ | ID des zu löschenden Listenelements. | 42 |
EditSharePointItem
Die Workflow Aktivität EditSharePointItem aktualisiert ein bestehendes Element in einer SharePoint-Liste.
Eingabeparameter
| Name | Typ | Erforderlich | Beschreibung | Beispiel |
|---|---|---|---|---|
| Connection | SharePointConnection |
✔ | Gibt die SharePoint-Verbindung an. | - |
| List | string |
✔ | Name der SharePoint-Liste. | Computer |
| ItemId | int |
✔ | ID des zu bearbeitenden Listenelements. | 42 |
| Fields | List<ObjectExpressionParameter> |
✔ | Feldwerte, die aktualisiert werden sollen. | Status = "Aktiv" |
Info
Diese Workflow Aktivität unterstützt die in der Tabelle Unterstützte Feldtypen aufgeführten SharePoint-Feldtypen. Prüfe die Tabelle, um zu sehen, welche Feldtypen gelesen oder aktualisiert werden können.
GetSharePointItem
Die Workflow Aktivität GetSharePointItem liest ein einzelnes Element aus einer SharePoint-Liste.
Eingabeparameter
| Name | Typ | Erforderlich | Beschreibung | Beispiel |
|---|---|---|---|---|
| Connection | SharePointConnection |
✔ | Gibt die SharePoint-Verbindung an. | - |
| List | SharePointList |
✔ | Die SharePoint-Liste, aus der gelesen wird. | - |
| ItemId | int |
✔ | ID des gewünschten Listenelements. | 42 |
Ausgabeparameter
| Name | Typ | Beschreibung | Beispiel |
|---|---|---|---|
| Result | Dictionary<string, object> |
Feldwerte des gefundenen Listenelements. Der Schlüssel (key) entspricht dem Namen des Feldes, der Wert (object) enthält den eigentlichen Feldwert und kann zu SharePointItemField gecastet werden. |
- |
Info
Diese Workflow Aktivität unterstützt die in der Tabelle Unterstützte Feldtypen aufgeführten SharePoint-Feldtypen. Prüfe die Tabelle, um zu sehen, welche Feldtypen gelesen oder aktualisiert werden können.
Standard Ausgabefelder
Zusätzlich zu den definierten Listenfeldern werden bei jedem Abruf eines SharePoint-Items automatisch weitere Standard-Ausgabefelder mit zurückgegeben. Diese können bei Angabe der List mit deren Feldern nicht aufgelistet werden.
| Name | Beschreibung |
|---|---|
| _createdBy_email | E-Mail-Adresse des Erstellers |
| _createdBy_id | SharePoint-Item-ID des Erstellers |
| _createdBy_displayName | Anzeigename des Erstellers |
| _lastModifiedBy_email | E-Mail-Adresse der Person, die das Item zuletzt bearbeitet hat |
| _lastModifiedBy_id | SharePoint-Item-ID der Person, die das Item zuletzt bearbeitet hat |
| _lastModifiedBy_displayName | Anzeigename der Person, die das Item zuletzt bearbeitet hat |
| _createdDateTime | Erstellungsdatum |
| _lastModifiedDateTime | Datum der letzten Bearbeitung des Items |
| _id | SharePoint-ID des Items |
| _webUrl | URL des Items |
| _name | Name des Items. Wird in folgender Reihenfolge bestimmt: name → FileLeafRef → LinkFilename → Title. |
| _title | Titel des Items |
GetSharePointItems
Die Workflow Aktivität GetSharePointItems liest mehrere Elemente aus einer SharePoint-Liste aus. Es kann mithilfe von Field und Value gefiltert werden.
Eingabeparameter
| Name | Typ | Erforderlich | Beschreibung | Beispiel |
|---|---|---|---|---|
| Connection | SharePointConnection |
✔ | Gibt die SharePoint-Verbindung an. | - |
| List | SharePointList |
✔ | Die SharePoint-Liste, aus der gelesen wird. | - |
| Field | string |
✖ | Feld, nach dem gefiltert wird. Leer lassen, um alle Elemente zu laden. | ComputerId |
| Value | object |
✖ | Vergleichswert für das angegebene Feld. | PC-001 |
Ausgabeparameter
| Name | Typ | Beschreibung | Beispiel |
|---|---|---|---|
| Result | List<Dictionary<string, object>> |
Liste der gefundenen SharePoint-Listenelemente. Der Schlüssel (key) entspricht dem Namen des Feldes, der Wert (object) enthält den eigentlichen Feldwert und kann zu SharePointItemField gecastet werden. |
- |
Info
Diese Workflow Aktivität unterstützt die in der Tabelle Unterstützte Feldtypen aufgeführten SharePoint-Feldtypen. Prüfe die Tabelle, um zu sehen, welche Feldtypen gelesen oder aktualisiert werden können.
Standard Ausgabefelder
Zusätzlich zu den definierten Listenfeldern werden bei jedem Abruf eines SharePoint-Items automatisch weitere Standard-Ausgabefelder mit zurückgegeben. Diese können bei Angabe der List mit deren Feldern nicht aufgelistet werden.
| Name | Beschreibung |
|---|---|
| _createdBy_email | E-Mail-Adresse des Erstellers |
| _createdBy_id | SharePoint-Item-ID des Erstellers |
| _createdBy_displayName | Anzeigename des Erstellers |
| _lastModifiedBy_email | E-Mail-Adresse der Person, die das Item zuletzt bearbeitet hat |
| _lastModifiedBy_id | SharePoint-Item-ID der Person, die das Item zuletzt bearbeitet hat |
| _lastModifiedBy_displayName | Anzeigename der Person, die das Item zuletzt bearbeitet hat |
| _createdDateTime | Erstellungsdatum |
| _lastModifiedDateTime | Datum der letzten Bearbeitung des Items |
| _id | SharePoint-ID des Items |
| _webUrl | URL des Items |
| _name | Name des Items. Wird in folgender Reihenfolge bestimmt: name → FileLeafRef → LinkFilename → Title. |
| _title | Titel des Items |
Establish SharePoint Connection
Die Workflow Aktivität Establish SharePoint Connection stellt eine SharePoint-Verbindung bereit und unterstützt Serviceverbindungen. Platziere diese Workflow Aktivität am Anfang des Workflows, um die Verbindung zu SharePoint korrekt herzustellen.
Eingabeparameter
| Name | Typ | Erforderlich | Beschreibung | Beispiel |
|---|---|---|---|---|
| ServiceConnection | ObjectReference |
✖ | Referenz auf eine konfigurierte Serviceverbindung. | - |
| Credentials | SharePointConnection |
✖ | Enthält die Authentifizierungs- und Verbindungsdaten. | - |
Ausgabeparameter
| Name | Typ | Beschreibung | Beispiel |
|---|---|---|---|
| Connection | SharePointConnection |
Initialisierte SharePoint-Verbindung. | - |
Data Contracts
In diesem Abschnitt werden die für die SharePoint Activities verwendeten Data Contracts beschrieben. Jeder Data Contract definiert die Struktur der Daten, die zwischen den Workflow Aktivitäten und SharePoint ausgetauscht werden.
SharePointConnection
Der SharePointConnection Data Contract beschreibt die Verbindungsinformationen zu SharePoint. Er wird genutzt, um eine Authentifizierung und den Zugriff auf SharePoint-Listen herzustellen.
Empfehlung
Wir empfehlen die Nutzung von Serviceverbindungen.
Typdefinition: Labtagon.M42.SharepointActivities.SharePoint.SharePointConnection
Eigenschaften:
| Name | Typ | Erforderlich | Beschreibung | Beispiel |
|---|---|---|---|---|
| Url | string |
Ja | Die Basis-URL der SharePoint-Seite | https://meinsharepoint/sites/testsite |
| Username | string |
Optional | Benutzername für die Authentifizierung | max.mustermann |
| Password | string |
Optional | Passwort für die Authentifizierung | GeheimesPasswort123 |
| Domain | string |
Optional | Domäne des Benutzers | MEINEFIRMA |
| AuthenticationType | AuthenticationType |
Ja | Authentifizierungsmethode für SharePoint | ServiceConnection |
| Timeout | int |
Optional | Zeit in Sekunden bis zum Timeout der Verbindung | 10 |
| ServiceConnection | Guid |
Optional | Referenz auf eine Serviceverbindung, falls verwendet | c56a4180-65aa-42ec-a945-5fd21dec0538 |
Hinweis
AuthenticationType ist ein Enum mit folgenden Werten: Anonymous, PassThrough, SharePointOnline, Forms, Negotiate, Kerberos, NTLM, Digest, ServiceConnection.
SharePointItemField
Der SharePointItemField Data Contract beschreibt ein einzelnes Feld eines SharePoint-Elements. Er enthält Informationen über den internen Namen, den Anzeigenamen, den Feldtyp und den Wert. Dieser Data Contract wird verwendet, um Daten aus einem SharePoint Listen Item auszulesen.
Typdefinition: Labtagon.M42.SharepointActivities.SharePoint.SharePointItemField
Eigenschaften:
| Name | Typ | Erforderlich | Beschreibung | Beispiel |
|---|---|---|---|---|
| InternalName | string |
Ja | Interner Name des SharePoint-Feldes | Title |
| DisplayName | string |
Ja | Anzeigename des Feldes in SharePoint | Computername |
| Type | SharePointFieldType |
Ja | Typ des Feldes (z. B. String, Number, Bool, User) | String |
| Value | object |
Optional | Wert des Feldes | "MeinComputer" |
Methoden:
- GetValue<T>() - Gibt den Feldwert als einen bestimmten Typ zurück und konvertiert automatisch den internen SharePoint-Wert in den Zieltyp.
Beispiele
SharePointUserOrGroup
Der SharePointUserOrGroup Data Contract beschreibt einen Benutzer oder eine Gruppe in SharePoint. Er wird z. B. beim Lesen von Person- oder Gruppenfeldern verwendet.
Typdefinition: Labtagon.M42.SharepointActivities.SharePoint.SharePointUserOrGroup
Eigenschaften:
| Name | Typ | Erforderlich | Beschreibung | Beispiel |
|---|---|---|---|---|
| IsGroup | bool |
Ja | Gibt an, ob es sich um eine Gruppe handelt | false |
| Name | string |
Optional | Login-Name des Benutzers oder der Gruppe | max.mustermann |
| Title | string |
Optional | Anzeigename | Max Mustermann |
string |
Optional | E-Mail-Adresse des Benutzers | max.mustermann@firma.de |
|
| FirstName | string |
Optional | Vorname | Max |
| LastName | string |
Optional | Nachname | Mustermann |
| IsSiteAdmin | bool? |
Optional | Gibt an, ob der Benutzer Site-Administrator ist | false |
Beispiele
Serviceverbindungsprovider-Funktionalität (Service Capability)
Microsoft Graph - SharePoint (Delegated)
Diese Serviceverbindungsprovider-Funktionalität wird mit den SharePoint Activities ausgeliefert und kann direkt in Verbindung mit einer Serviceverbindung genutzt werden.
Sie stellt den notwendigen Berechtigungs-Umfang (offline_access+openid+User.Read+AllSites.FullControl) bereit, die für den Zugriff auf SharePoint-Listen und -Daten erforderlich sind.
Weitere Informationen zur Nutzung in Verbindung mit Serviceverbindungen findest du unter Vorbereitung der Serviceverbindung.