Durchsuchbare Dokumentation aufrufen

Zurück zur Dokumentationsübersicht

custom service registrieren

Hinweis: Diese Dokumentation bezieht sich auf die aktuellste Version des agorum core template managers. Aktualisieren Sie ggf. das hier beschriebene Plug-in, um die Dokumentation verwenden zu können.

Mit dieser dateiabhängigen Aktion registrieren Sie einen eigenen (custom) JavaScript API Service.

  1. Legen Sie den custom service als JavaScript-Datei an. Diese muss unter folgendem Pfad oder tiefer liegen:
    Eigene Dateien/Administration/customers/<Konfigurationsprojekt>/js
  2. Klicken Sie mit der rechten Maustaste auf die angelegte JavaScript-Datei.
  3. Wählen Sie im Kontextmenü agorum core template manager > Registrieren > custom service.

    Ergebnis: Ein Dialog öffnet sich.

    • Der Name und die Beschreibung können nicht bearbeitet werden.
    • Durch Setzen des Hakens bei noauth wird der Service mit der Extension .noauth angelegt. Dadurch wird keine Authentifizierung für den Service benötigt.
  4. Klicken Sie auf OK.

    Ergebnis

    • Das System registriert den custom service in der MetaDB.
    • Der registrierte Name wird in einem neuen Dialog angezeigt, sodass Sie diesen kopieren können.
    • Das System bindet die Registrierung in die Datei export.yml ein, sodass diese Registrierung automatisch beim Export mitgenommen wird.

    Die Registrierung wird unter folgendem Pfad in der MetaDB abgelegt:
    MAIN_MODULE_MANAGEMENT/api/control/Services/Custom/Services/[<Konfigurationsprojekt>]/<ausgegebener RegisterName>
    
    Wie bei jeder Registrierung über den agorum core template manager wird ebenfalls eine uninstall-Datei angelegt, mit dem Sie die Aktion vollständig rückgängig machen können. Diese liegt unter:
    /agorum/roi/workspace/<Konfigurationsprojekt>/uninstall/<Name registrierter Custom Service>.json