DocumentatieWorkfrontHandleiding voor Workfront

Voorbeelden van het externe opzoekveld in een aangepast formulier

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

Gemaakt voor:

  • Beheerder

Een extern opzoekveld in een aangepast formulier roept een externe API aan en retourneert waarden als opties in een vervolgkeuzeveld. Gebruikers die werken met het object waaraan het aangepaste formulier is gekoppeld, kunnen een of meer van deze opties in het vervolgkeuzemenu selecteren.

Dit artikel bevat voorbeelden van het gebruik van het externe opzoekveld om dezelfde instantie van Workfront of een openbare API aan te roepen. U kunt de Externe raadpleging ook gebruiken om met een extern systeem zoals Jira, Salesforce, of ServiceNow te communiceren.

Voor meer informatie over het toevoegen van een Extern raadplegingsgebied aan een douaneformulier en extra definities van de externe raadplegingscomponenten, zie een douaneformuliercreëren.

Een extern opzoekveld instellen voor dezelfde instantie van Workfront

U kunt de externe zoekopdracht gebruiken om gegevens van uw Workfront-exemplaar over te brengen naar het aangepaste formulier.

Native Workfront-veldwaarden gebruiken in de externe zoekopdracht

In dit voorbeeld wordt getoond hoe u de Workfront API aanroept en gegevens uit het bestaande veld Statusquery naar uw externe opzoekveld brengt.

  1. Open het aangepaste formulier.

  2. Op de linkerkant van het scherm, vind Externe raadpleging en sleep het aan een sectie op het canvas.

  3. Ga het Etiket en Naam voor het gebied in.

  4. Selecteer het Formaat voor het gebied.

  5. Ga de API vraag op het Basis API URL gebied in.

    • Als u wilt verwijzen naar hetzelfde exemplaar van Workfront waarin het aangepaste formulier zich bevindt, gebruikt u $$HOST voor de URL.
    • Voeg $$QUERY toe als u de resultaten wilt filteren op basis van het opvragen van een ander veld.

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

  6. Herzie Afhankelijkheden voor de gebieden dat dit raadplegingsgebied in API van verwijzingen voorziet.

    Een afhankelijkheidsveld kan elk aangepast of native veld zijn dat op de detailpagina van het object bestaat.

    In dit voorbeeld wordt {DE:StatusQuery} vervangen door de waarde van het aangepaste veld StatusQuery.

  7. Selecteer de Methode van HTTP.

    Dit zal meestal krijgen waarschijnlijk zijn.

  8. Ga de Weg JSON in om de resultaten van uw API vraag te krijgen.

    Voorbeeld
    $.data[*].name

    note note
    NOTE
    de informatie van de Kopbal wordt niet vereist voor een vraag aan de zelfde instantie van Workfront.

  9. Klik toepassen.

    Opstelling van API vraag aan Workfront in douanevorm

    Wanneer het aangepaste formulier wordt toegevoegd aan een Workfront-object (in dit voorbeeld een project), ziet het er ongeveer zo uit.

    Vorm van de Douane met extern raadplegingsgebied

    Externe raadplegingsopties die op status worden gebaseerd

Aangepaste veldwaarden gebruiken in de externe zoekopdracht

In dit voorbeeld ziet u hoe u de Workfront API aanroept en gegevens van een aangepast veld naar uw externe opzoekveld brengt. Het aangepaste voorbeeldveld wordt 'Aangepaste kleuren' genoemd.

  1. Open het aangepaste formulier.

  2. Op de linkerkant van het scherm, vind Externe raadpleging en sleep het aan een sectie op het canvas.

  3. Ga het Etiket en Naam voor het gebied in.

  4. Selecteer het Formaat voor het gebied.

  5. Ga de API URL vraag op het Basis API URL gebied in.

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

  6. Herzie Afhankelijkheden voor de gebieden dat dit raadplegingsgebied in API van verwijzingen voorziet.

    Een afhankelijkheidsveld kan elk aangepast of native veld zijn dat op de detailpagina van het object bestaat.

  7. Selecteer de Methode van HTTP.

    Dit zal meestal krijgen waarschijnlijk zijn.

  8. Ga de Weg JSON in om de resultaten van uw API vraag te krijgen.

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

    • "parameterValues" verwijst naar elk aangepast veld in Workfront voor het object dat u hebt ingeschakeld.
    • In dit voorbeeld is "DE:Combo Colors" het specifieke aangepaste veld met de waarden die u wilt ophalen.
    note note
    NOTE
    de informatie van de Kopbal wordt niet vereist voor een vraag aan de zelfde instantie van Workfront.

  9. Klik toepassen.

    Wanneer het aangepaste formulier aan een Workfront-object wordt toegevoegd, worden alle waarden in het veld "Combo Colors" weergegeven in het vervolgkeuzemenu Extern opzoekveld.

Een extern opzoekveld instellen voor de API voor Workfront-planning

Een eindpunt is beschikbaar in de Planning API van Workfront aan onderzoeksverslagen door verslagtype identiteitskaart door Get methode. U kunt dit eindpunt gebruiken om de verslagen van de Planning in Externe raadplegingsgebieden van verwijzingen te voorzien.

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

  • Methode van HTTP: krijgt

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

    {fieldID} is het gebied om in de Externe resultaten van het raadplegingsonderzoek op de douanevorm voor eind te tonen - gebruikers.

Voor meer informatie, zie de Planning API van Workfront.

Een extern opzoekveld instellen voor een openbare API

U kunt de externe zoekopdracht gebruiken om een externe, openbare API aan te roepen en gegevens op te halen.

In dit voorbeeld wordt getoond hoe u een API van landen (zoals https://api.first.org/data/v1/countries) aanroept, zodat u niet alle landnamen in de vervolgkeuzemogelijkheden hoeft te coderen.

  1. Open het aangepaste formulier.

  2. Op de linkerkant van het scherm, vind Externe raadpleging en sleep het aan een sectie op het canvas.

  3. Ga het Etiket en Naam voor het gebied in.

  4. Selecteer het Formaat voor het gebied.

  5. Ga de API URL vraag op het Basis API URL gebied in.

    • U kunt $$QUERY toevoegen om vraag het filtreren voor uw eind uit te voeren - gebruikers.

    Voorbeelden
    Geeft alle landen weer: https://api.first.org/data/v1/countries

    Hiermee kan de gebruiker naar een land in het vervolgkeuzevenster zoeken: https://api.first.org/data/v1/countries?q=$$QUERY

    Hiermee kan de gebruiker naar een land in een regio zoeken: https://api.first.org/data/v1/countries?region={DE:Region}&q=$$QUERY

    • De beschikbare gebieden worden gedefinieerd in een afzonderlijk aangepast veld in Workfront.
    • Wanneer de gebruiker een gebied op het formulier selecteert, worden in het veld Extern opzoeken alleen de landen in dat gebied weergegeven (in welk land de regio is gedefinieerd in de API). De gebruiker kan ook naar een land in het geselecteerde gebied zoeken.

  6. Herzie Afhankelijkheden voor de gebieden dat dit raadplegingsgebied in API van verwijzingen voorziet.

    Een afhankelijkheidsveld kan elk aangepast of native veld zijn dat op de detailpagina van het object bestaat.

    In dit voorbeeld wordt {DE:Region} vervangen door de waarde van het aangepaste veld Regio.

  7. Selecteer de Methode van HTTP.

    Dit zal meestal krijgen waarschijnlijk zijn.

  8. Ga de Weg JSON in om de resultaten van uw API vraag te krijgen.

    Met deze optie kunnen gegevens worden opgehaald uit de JSON die door de API-URL wordt geretourneerd. Hiermee kunt u selecteren welke waarden in de JSON-code worden weergegeven in de vervolgkeuzemogelijkheden.

    Voorbeeld
    $.data[*].country

  9. (Optioneel) Klik op Koptekst toevoegen en typ of plak het sleutelwaardepaar dat voor verificatie met de API is vereist.

    note note
    NOTE
    De gebieden van de Kopbal zijn geen veilige plaats om geloofsbrieven op te slaan, en u zou moeten zorgvuldig zijn wat u ingaat en bewaart.

  10. (Facultatief) selecteer multi-Select Vervolgkeuzelijst om de gebruiker toe te staan om meer dan één waarde in dropdown te selecteren.

  11. Klik toepassen.

    Opstelling van API vraag aan openbare API in douaneformulier

    Wanneer het aangepaste formulier wordt toegevoegd aan een Workfront-object (in dit voorbeeld een project), ziet het er ongeveer zo uit.

    Vorm van de Douane met extern raadplegingsgebied

    Externe raadplegingsopties voor een land dat op gebied wordt gebaseerd

Aanvullende gebruiksgevallen voor externe opzoekvelden

Er zijn veel andere gevallen waarin u een externe zoekopdracht kunt maken.

geval van het Gebruik: vervang typeahead gebieden, omdat zij problemen met het melden kunnen veroorzaken.
Oplossing: gebruik een API vraag aan bestaande voorwerpen in het systeem.

Voorbeeld-basis-API-URL voor sjablonen, ter vervanging van een typeahead-veld:
$$HOST/attask/api/v17.0/tmpl/search?isActive=true&name_Sort=asc

het geval van het Gebruik: creeer dropdown gebieden met meer eigenschappen (bijvoorbeeld, is er lijnomslag op het Externe onderzoeksgebied).
Oplossing: gebruik een API vraag aan bestaande voorwerpen in het systeem, of creeer een nieuw voorwerp en gebruik een API vraag aan dit voorwerp.

geval van het Gebruik: bepaal een manier voor gebruikers om hun eigen gebieden buiten het gebied van douaneformulieren te handhaven. Stel het externe opzoekveld in en u kunt gebruikers de objecten geven die het veld vormen. Deze optie is geschikt voor velden en teams met hoog onderhoud.
Oplossing: creeer een nieuw voorwerp en gebruik een API vraag aan dit voorwerp.

geval van het Gebruik: Integratie met voorwerpen buiten Workfront. Bijvoorbeeld, die tot een ander systeem toegang hebben om de naam van elke gebruiker te krijgen, eerder dan wordt beperkt op een typeahead gebied.
Oplossing: automatisering Webhaak/Fusion om met andere systemen te verbinden.

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