Externe IDs
Verknüpfen Sie findIQ-Objekte mit Kennungen aus Ihren eigenen Systemen und öffnen Sie Maschinen, Routinen und die Fehlersuche direkt über die externe ID.
Geschrieben von Tommy Giesbrecht
Zuletzt aktualisiert Vor 16 Tagen
Eine externe ID ist eine Kennung aus einem Ihrer eigenen Systeme, zum Beispiel eine Anlagennummer aus dem ERP, eine Auftragsnummer aus der Instandhaltungssoftware oder ein Fehlercode aus dem Ticketsystem. Sie hinterlegen sie an einem findIQ-Objekt und können das Objekt danach über Ihre eigene Kennung ansprechen statt über die interne findIQ-ID.
Externe IDs vergeben Sie mit der Rolle Editor oder Administrator.
Ziel des Artikels: Nach dem Lesen wissen Sie, welche Objekte eine externe ID tragen können, wie Sie eine vergeben und wie Sie Maschinen, Routinen und die Fehlersuche über die externe ID öffnen.
Wozu externe IDs
Ihre Systeme verlinken nach findIQ mit den Kennungen, die sie ohnehin verwenden. Eine Mapping-Tabelle entfällt.
Interne findIQ-IDs funktionieren überall unverändert weiter. Externe IDs sind ein zusätzlicher Zugang, kein Ersatz.
Welche Objekte und wofür
Objekte über die externe ID öffnen
Überall dort, wo in diesen URLs eine Maschinen- oder Routinen-ID steht, können Sie stattdessen die externe ID verwenden:
Maschinenseite:
https://app.findiq.de/app/{organisation}/operator/{machine}Standalone-Fehlersuche:
https://app.findiq.de/standalone/{organisation}/{machine}/diagnose/Standalone-Routine:
https://app.findiq.de/standalone/{organisation}/{machine}/routine-run/{routine}Beispiel mit externer ID:
https://app.findiq.de/standalone/acme/ERP-4711/diagnose/Fehlersuche mit vorbelegten Symptomen
Ergänzen Sie den Parameter symptoms mit einer kommagetrennten Liste. Die Einträge können externe IDs, interne Symptom-IDs oder eine Mischung aus beidem sein. findIQ startet die Fehlersuche mit diesen Symptomen bereits beantwortet:
https://app.findiq.de/standalone/acme/ERP-4711/diagnose/?symptoms=ERP-S1,ERP-S2Einträge, zu denen es an dieser Maschine kein Symptom gibt, werden ignoriert, die übrigen trotzdem vorbelegt.
Sobald das Objekt geladen ist, ersetzt findIQ die externe ID in der Adresszeile durch die interne ID. Ein Lesezeichen enthält damit immer den kanonischen Link.
Eine externe ID vergibt keine Berechtigung. Nutzer brauchen weiterhin Zugriff auf die Maschine. Passt die ID zu keinem Objekt, zeigt findIQ einen Hinweis, dass nichts gefunden wurde.
Externe IDs vergeben und pflegen
Öffnen Sie den Editor der Maschine, Routine, Ursache oder des Symptoms und füllen Sie das Feld Externe ID. Das Feld ist optional.
Wenn Sie das Feld leeren, wird die ID wieder frei und kann an einem anderen Objekt verwendet werden.
Kopien übernehmen nie eine externe ID. Eine aus einer Routine kopierte Routine und ein aus einem Template kopiertes Template starten ohne.
Wenn Sie eine externe ID ändern, lösen Links aus Ihren Systemen mit dem alten Wert nicht mehr auf. Behandeln Sie externe IDs als stabil.
Prüfen, ob eine externe ID schon existiert
In der App: geben Sie die ID in die globale Suche ein. Maschinen, Routinen, Ursachen und Symptome werden über ihre externe ID gefunden, und zwar in beiden Schreibweisen,
ERP-4711ebenso wieERP4711.Über die API:
GET /api/records/{organisation}/machines/{external_id}. Ist die ID vergeben, kommt die Maschine zurück. Ist sie frei, antwortet die API mit 404.Vergeben Sie eine bereits belegte ID, weist findIQ die Änderung mit einem Konfliktfehler ab. Duplikate können so nicht versehentlich entstehen.