Serviceklasse für die Anbindung von edoc datahub

Sie können die Klasse DatahubService z.B. in einem Actions-Plug-In verwenden, um Daten von edoc datahub abzufragen und um neue Zielobjekte oder Webhooks zu erstellen.

Klassenname und Namespace

\edoc\appserver\services\DatahubService

Öffentliche Funktionen

getClients(): array

Diese Funktion gibt eine Liste aller erstellten Mandanten zurück.

Parameter

Keine

Rückgabe

Typ	Beschreibung
array	Gibt die Liste mit allen Mandanten zurück.

getTargetObjects(): array

Diese Funktion gibt eine Liste aller erstellten Zielobjekte und deren Eigenschaften zurück.

Parameter

Keine

Rückgabe

Typ	Beschreibung
array	Gibt die Liste aller erstellten Zielobjekte und deren Eigenschaften zurück.

createTargetObject($source, $name, $text, $properties): void

Diese Funktion erzeugt ein neues Zielobjekt.

Parameter

Name	Typ	Beschreibung
source	string	Gibt den Ursprung des Objektes an, z.B. die App-ID der eigenen App, um Objekte der eigenen App zu identifizieren.
name	string	Gibt den Namen des Zielobjekts an.
text	string	Gibt den Text des Zielobjekts an.
properties	`#[ArrayShape([[` `"id" => "string",` `"text" => "string",` `"key" => "boolean",` `"source" => ["string"]` `]])] array`	Gibt die Liste mit den Eigenschaften des Zielobjektes an.

Rückgabe

Keine

getTargetObjectData($clientId, $targetObjectName, $propertyIds, $createdAfter, $updatedAfter, $pageNumber, $pageSize): array

Diese Funktion liefert die importierten Daten des Zielobjektes zurück.

Parameter

Name	Typ	Beschreibung
clientId	string	Gibt den Mandanten an.
targetObjektName	string	Gibt den Namen des Zielobjektes an.
propertyIds	array	Gibt die Liste mit den IDs der Eigenschaften des Zielobjektes an.
createdAfter	int	Gibt nur Daten zurück, die nach dem angegebenen Zeitstempel erzeugt wurden. Standard: 0
updatedAfter	int	Gibt nur Daten zurück, die nach dem angegebenen Zeitstempel aktualisiert wurden. Standard: 0
pageNumber	int	Gibt an, welche Seite der Daten geladen werden soll. Standard: 0
pageSize	int	Gibt an, wie viele Zeilen eine Seite anzeigen soll. Standard: 100

Rückgabe

Typ	Beschreibung
array	Gibt die Liste mit allen importierten Daten des Zielobjektes zurück. Eine Zeile enthält nur die im Parameter propertyIds angegebenen Eigenschaften.

Typ

Beschreibung

array

Gibt die Liste mit allen importierten Daten des Zielobjektes zurück.

Eine Zeile enthält nur die im Parameter propertyIds angegebenen Eigenschaften.

createWebhook($host, $path): string

Diese Funktion erzeugt einen neuen Webhook.

Parameter

Name	Typ	Beschreibung
host	string	Gibt die Adresse des Zielservers an. Wenn Sie edoc-Services verwenden, geben Sie nur den Servicenamen an. Wenn Sie externe Services verwenden, geben Sie das verwendete Protokoll an, z.B.: http://
path	string	Gibt den relativen Pfad aufzurufenden Endpunktes an.

Name

Typ

Beschreibung

host

string

Gibt die Adresse des Zielservers an.

Wenn Sie edoc-Services verwenden, geben Sie nur den Servicenamen an.

Wenn Sie externe Services verwenden, geben Sie das verwendete Protokoll an, z.B.: http://

path

string

Gibt den relativen Pfad aufzurufenden Endpunktes an.

Rückgabe

Typ	Beschreibung
string	Gibt die ID des neu erstellten Webhooks zurück.

getSchemas($source, $clientShortName): array

Diese Funktion gibt ein Schema für die angegebene Quelle und für den angegebenen Mandanten (Client) zurück.

Parameter

Name	Typ	Beschreibung
source	string	Gibt den Ursprung des Schemas an, z.B. die App-ID der eigenen App, um Objekte der eigenen App zu identifizieren.
clientShortName	string	Gibt den Namen des Mandanten an.

Rückgabe

Typ	Beschreibung
array	Gibt die Liste aller für die Quelle und für den Mandanten erstellten Schemas zurück.

deleteSchema($source, $clientShortName): array

Diese Funktion löscht das mit Quelle und Mandanten (Client) angegebene Schema.

Parameter

Name	Typ	Beschreibung
source	string	Gibt den Ursprung des Schemas an, z.B. die App-ID der eigenen App, um Objekte der eigenen App zu identifizieren.
clientShortName	string	Gibt den Namen des Mandanten an.

Rückgabe

Typ	Beschreibung
array	Gibt die Liste aller für die Quelle und für den Mandanten gelöschten Schemas zurück.

createSchema($source, $clientShortName, array $collections): array

Diese Funktion erstellt ein neues Schema.

Parameter

Name	Typ	Beschreibung
source	string	Gibt den Ursprung des Schemas an, z.B. die App-ID der eigenen App, um Objekte der eigenen App zu identifizieren.
clientShortName	string	Gibt den Namen des Mandanten an.

Rückgabe

Typ	Beschreibung
array	Gibt die Liste aller für die Quelle und für den Mandanten neu erstellten Schemas zurück.

updateSchema($source, $clientShortName, array $collections): array

Diese Funktion aktualisiert das angegebene Schema.

Parameter

Name	Typ	Beschreibung
source	string	Gibt den Ursprung des Schemas an, z.B. die App-ID der eigenen App, um Objekte der eigenen App zu identifizieren.
clientShortName	string	Gibt den Namen des Mandanten an.

Rückgabe

Typ	Beschreibung
array	Gibt die Liste aller für die Quelle und für den Mandanten aktualisierten Schemas zurück.

getEvents($source = null): array

Diese Funktion gibt alle Events zurück.

Parameter

Name	Typ	Beschreibung
source	string	Gibt den Ursprung des Events an, z.B. die App-ID der eigenen App, um Objekte der eigenen App zu identifizieren.

Rückgabe

Typ	Beschreibung
array	Gibt eine Liste aller für die angegebene Quelle gefundenen Events zurück.

createEvents($source, $description, $events): array

Diese Funktion erstellt neue Events.

Parameter

Name	Typ	Beschreibung
source	string	Gibt den Ursprung des Events an, z.B. die App-ID der eigenen App, um Objekte der eigenen App zu identifizieren.
description	string	Gibt eine Beschreibung für die Events an.
events	array	Gibt die Liste der zu erstellenden Events an.

Rückgabe

Typ	Beschreibung
array	Gibt die Liste der erstellten Events zurück.

updateEvents($source, $events, $description = null): array

Diese Funktion aktualisiert die angegebenen Events.

Parameter

Name	Typ	Beschreibung
source	string	Gibt den Ursprung des Events an, z.B. die App-ID der eigenen App, um Objekte der eigenen App zu identifizieren.
events	array	Gibt eine Liste mit den anzupassenden Informationen der Events an.
description	string	Gibt die Beschreibung der Events an, wenn diese aktualisiert werden soll.

Rückgabe

Typ	Beschreibung
array	Gibt die Liste der aktualisierten Events zurück.

deleteEvents($source, $name = null): void

Diese Funktion löscht die angegebenen Events.

Parameter

Name	Typ	Beschreibung
source	string	Gibt den relativen Pfad aufzurufenden Endpunktes an.
name	string	Gibt den Namen des zu löschenden Events an.

sendEvent($source, $eventName, $eventId, $clientShortName, $payload)

Diese Funktion startet einen Bewegungsdatenexport zum angegebenen Event.

Parameter

Name	Typ	Beschreibung
source	string	Gibt den relativen Pfad aufzurufenden Endpunktes an.
eventName	string	Gibt den Event an, der ausgelöst werden soll.
eventId	string	Gibt eine eindeutige ID an.
clientShortName	string	Gibt den Namen des Mandanten an.
payload	array	Gibt die Daten für den Export an.

Beispiel für ein Aktions-Plug-In

In diesem Codebeispiel werden alle Mandanten aus edoc datahub abgerufen.

PHP

<?php

namespace edoc\appserver\app\actions\plugins;

use edoc\appserver\app\AbstractAction;
use edoc\appserver\services\DatahubService;

class GetClients extends AbstractAction
{
    use \edoc\appserver\app\actions\DatasetAction;
    
    protected function init()
    {
    }

    protected function exec(): AbstractAction
    {        
      $processedClients = [];

      $dh = new DatahubService();
      $clients = $dh->getClients();
      
      foreach ($clients as $client) {
        // process client data
      }

      return $this->returnDataset($processedClients);
    
    }
}