DokumentationWorkfrontWorkfront-Handbuch

Beispiele für das externe Suchfeld in einem benutzerdefinierten Formular

Last update: Wed Oct 23 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Erstellt für:

  • Admin

Ein externes Suchfeld in einem benutzerdefinierten Formular ruft eine externe API auf und gibt Werte als Optionen in einem Dropdown-Feld zurück. Benutzer, die mit dem Objekt arbeiten, an das das benutzerdefinierte Formular angehängt ist, können eine oder mehrere dieser Optionen aus der Dropdown-Liste auswählen.

Dieser Artikel enthält Beispiele für die Verwendung des externen Suchfelds, um dieselbe Instanz von Workfront oder eine öffentliche API aufzurufen. Sie können die externe Suche auch verwenden, um mit einem externen System wie Jira, Salesforce oder ServiceNow zu kommunizieren.

Weitere Informationen zum Hinzufügen eines externen Suchfelds zu einem benutzerdefinierten Formular und zusätzliche Definitionen der externen Lookup-Komponenten finden Sie unter Erstellen eines benutzerdefinierten Formulars.

Richten Sie ein externes Suchfeld für dieselbe Instanz von Workfront ein

Sie können die externe Suche verwenden, um Daten aus Ihrer Workfront-Instanz in das benutzerdefinierte Formular zu übertragen.

Native Workfront-Feldwerte in der externen Suche verwenden

In diesem Beispiel wird gezeigt, wie die Workfront-API aufgerufen und Daten aus dem vorhandenen Feld "Statusabfrage"in Ihr externes Suchfeld übertragen werden.

  1. Öffnen Sie das benutzerdefinierte Formular.

  2. Suchen Sie auf der linken Seite des Bildschirms nach Externer Suchvorgang und ziehen Sie ihn in einen Bereich auf der Arbeitsfläche.

  3. Geben Sie den Titel und den Namen für das Feld ein.

  4. Wählen Sie das Format für das Feld aus.

  5. Geben Sie den API-Aufruf im Feld Basis-API-URL ein.

    • Verwenden Sie $$HOST für die URL, um auf dieselbe Instanz von Workfront zu verweisen, in der sich das benutzerdefinierte Formular befindet.
    • Um die Ergebnisse anhand der Abfrage eines anderen Felds zu filtern, fügen Sie $$QUERY hinzu.

    Beispiel
    $$HOST/attask/api/v15.0/project/search?status={DE:StatusQuery}&$$QUERY

  6. Überprüfen Sie die Abhängigkeiten für die Felder, auf die dieses Suchfeld in der API verweist.

    Ein Abhängigkeitsfeld kann ein beliebiges benutzerdefiniertes oder natives Feld sein, das auf der Detailseite des Objekts vorhanden ist.

    In diesem Beispiel wird der {DE:StatusQuery} durch den Wert des benutzerdefinierten Felds StatusQuery ersetzt.

  7. Wählen Sie die HTTP-Methode aus.

    Dies ist meist Get.

  8. Geben Sie den JSON-Pfad ein, um die Ergebnisse aus Ihrem API-Aufruf zu erhalten.

    Beispiel
    $.data[*].name

    note note
    NOTE
    Kopfzeileninformationen sind für einen Aufruf an dieselbe Workfront-Instanz nicht erforderlich.

  9. Klicken Sie auf Anwenden.

    Einrichten des API-Aufrufs für Workfront in benutzerdefiniertem Formular

    Wenn das benutzerdefinierte Formular einem Workfront-Objekt (in diesem Beispiel einem Projekt) hinzugefügt wird, sieht es ähnlich aus.

    Benutzerdefiniertes Formular mit externem Suchfeld

    Externe Suchoptionen basierend auf dem Status

Verwenden benutzerdefinierter Feldwerte in der externen Suche

In diesem Beispiel wird gezeigt, wie Sie die Workfront-API aufrufen und Daten aus einem benutzerdefinierten Feld in Ihr externes Suchfeld übertragen. Das benutzerdefinierte Beispielfeld heißt "Benutzerdefinierte Farben".

  1. Öffnen Sie das benutzerdefinierte Formular.

  2. Suchen Sie auf der linken Seite des Bildschirms nach Externer Suchvorgang und ziehen Sie ihn in einen Bereich auf der Arbeitsfläche.

  3. Geben Sie den Titel und den Namen für das Feld ein.

  4. Wählen Sie das Format für das Feld aus.

  5. Geben Sie den API-URL-Aufruf im Feld Basis-API-URL ein.

    Beispiel
    $$HOST/attask/api/v18.0/PORT/search?ID={portfolioID}&fields=parameterValues

  6. Überprüfen Sie die Abhängigkeiten für die Felder, auf die dieses Suchfeld in der API verweist.

    Ein Abhängigkeitsfeld kann ein beliebiges benutzerdefiniertes oder natives Feld sein, das auf der Detailseite des Objekts vorhanden ist.

  7. Wählen Sie die HTTP-Methode aus.

    Dies ist meist Get.

  8. Geben Sie den JSON-Pfad ein, um die Ergebnisse aus Ihrem API-Aufruf zu erhalten.

    Beispiel
    $.data[*].parameterValues.["DE:Combo Colors"]

    • "parameterValues"bezieht sich auf jedes benutzerdefinierte Feld in Workfront für das Objekt, auf dem Sie sich befinden.
    • In diesem Beispiel ist "DE:Combo Colors"das spezifische benutzerdefinierte Feld, das die Werte enthält, die Sie abrufen möchten.
    note note
    NOTE
    Kopfzeileninformationen sind für einen Aufruf an dieselbe Workfront-Instanz nicht erforderlich.

  9. Klicken Sie auf Anwenden.

    Wenn das benutzerdefinierte Formular einem Workfront-Objekt hinzugefügt wird, werden alle Werte im Feld "Kombinationsfarben"in der Dropdown-Liste Externes Suchfeld angezeigt.

Einrichten eines externen Suchfelds für die Workfront Planning-API

Ein Endpunkt ist in der Workfront Planning-API verfügbar, um Datensätze über die Get-Methode nach Datensatz-Typ-ID zu suchen. Mit diesem Endpunkt können Sie auf Datensätze der Planung in externen Suchfeldern verweisen.

  • Basis-API-URL: $$HOST/maestro/api/v1/records/search?recordTypeId={recordTypeID}

  • HTTP-Methode: Abrufen

  • JSON-Pfad: $.records[*].data.{fieldID}

    {fieldID} ist das Feld, das in den externen Suchergebnissen im benutzerdefinierten Formular für Endbenutzer angezeigt werden soll.

Weitere Informationen finden Sie unter Workfront Planning API.

Externes Suchfeld für eine öffentliche API einrichten

Mit der externen Suche können Sie eine externe, öffentliche API aufrufen und Daten abrufen.

In diesem Beispiel wird gezeigt, wie eine -API von Ländern (z. B. https://api.first.org/data/v1/countries) aufgerufen wird, damit Sie nicht alle Ländernamen in den Dropdown-Optionen hartcodieren müssen.

  1. Öffnen Sie das benutzerdefinierte Formular.

  2. Suchen Sie auf der linken Seite des Bildschirms nach Externer Suchvorgang und ziehen Sie ihn in einen Bereich auf der Arbeitsfläche.

  3. Geben Sie den Titel und den Namen für das Feld ein.

  4. Wählen Sie das Format für das Feld aus.

  5. Geben Sie den API-URL-Aufruf im Feld Basis-API-URL ein.

    • Sie können $$QUERY hinzufügen, um die Abfragefilterung für Ihre Endbenutzer zu implementieren.

    Beispiele
    Listet alle Länder auf: https://api.first.org/data/v1/countries

    Ermöglicht dem Benutzer die Suche nach einem beliebigen Land im Dropdown-Feld: https://api.first.org/data/v1/countries?q=$$QUERY

    Ermöglicht dem Benutzer die Suche nach einem Land in einer Region: https://api.first.org/data/v1/countries?region={DE:Region}&q=$$QUERY

    • Die verfügbaren Regionen werden in Workfront in einem separaten benutzerdefinierten Feld definiert.
    • Wenn der Benutzer eine Region im Formular auswählt, zeigt das externe Suchfeld nur die Länder in dieser Region an (das Land, in dem sich die Region befindet, die in der API definiert ist). Der Benutzer kann auch nach einem Land in der ausgewählten Region suchen.

  6. Überprüfen Sie die Abhängigkeiten für die Felder, auf die dieses Suchfeld in der API verweist.

    Ein Abhängigkeitsfeld kann ein beliebiges benutzerdefiniertes oder natives Feld sein, das auf der Detailseite des Objekts vorhanden ist.

    In diesem Beispiel wird der {DE:Region} durch den Wert des benutzerdefinierten Felds Region ersetzt.

  7. Wählen Sie die HTTP-Methode aus.

    Dies ist meist Get.

  8. Geben Sie den JSON-Pfad ein, um die Ergebnisse aus Ihrem API-Aufruf zu erhalten.

    Diese Option ermöglicht das Extrahieren von Daten aus der JSON-Datei, die von der API-URL zurückgegeben wird. Es dient dazu, festzulegen, welche Werte aus dem JSON-Bereich in den Dropdown-Optionen angezeigt werden.

    Beispiel
    $.data[*].country

  9. (Optional) Klicken Sie auf Kopfzeile hinzufügen und geben Sie das Schlüssel-Wert-Paar ein oder fügen Sie es ein, das für die Authentifizierung mit der API erforderlich ist.

    note note
    NOTE
    Die Felder "Kopfzeile"sind kein sicherer Ort zum Speichern von Anmeldeinformationen. Achten Sie darauf, was Sie eingeben und speichern.

  10. (Optional) Wählen Sie "Dropdown mit Mehrfachauswahl"aus, damit der Benutzer mehr als einen Wert in der Dropdown-Liste auswählen kann.

  11. Klicken Sie auf Anwenden.

    Einrichtung des API-Aufrufs für die öffentliche API in benutzerdefiniertem Formular

    Wenn das benutzerdefinierte Formular einem Workfront-Objekt (in diesem Beispiel einem Projekt) hinzugefügt wird, sieht es ähnlich aus.

    Benutzerdefiniertes Formular mit externem Suchfeld

    Externe Suchoptionen für ein Land basierend auf Region

Zusätzliche Anwendungsfälle für externe Suchfelder

Es gibt viele weitere Anwendungsfälle zum Erstellen einer externen Suche.

Anwendungsfall: Ersetzen Sie typeahead-Felder, da sie Probleme mit der Berichterstellung verursachen können.
Lösung: Verwenden Sie einen API-Aufruf für vorhandene Objekte im System.

Beispiel einer Basis-API-URL für Vorlagen, um ein typeahead -Feld zu ersetzen:
$$HOST/attask/api/v17.0/tmpl/search?isActive=true&name_Sort=asc

Anwendungsfall: Erstellen Sie Dropdown-Felder mit weiteren Funktionen (z. B. ist eine Zeilenumbruch im Feld Externes Suchfeld vorhanden).
Lösung: Verwenden Sie einen API-Aufruf für vorhandene Objekte im System oder erstellen Sie ein neues Objekt und verwenden Sie einen API-Aufruf für dieses Objekt.

Anwendungsfall: Definieren Sie eine Möglichkeit für Benutzer, ihre eigenen Felder außerhalb des benutzerdefinierten Formularbereichs zu verwalten. Richten Sie das externe Suchfeld ein und Sie können Benutzern die Objekte des Felds zuweisen. Diese Option eignet sich gut für Felder und Teams mit hoher Wartung.
Lösung: Erstellen Sie ein neues Objekt und verwenden Sie einen API-Aufruf für dieses Objekt.

Anwendungsfall: Integration mit Objekten außerhalb von Workfront. Beispielsweise beim Zugriff auf ein anderes System, um den Namen jedes Benutzers abzurufen, anstatt in einem typeahead -Feld eingeschränkt zu sein.
Lösung: Webhook-/Fusion-Automatisierung zur Verbindung mit anderen Systemen.

recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43