Exempel på det externa sökfältet i ett anpassat formulär
Ett externt uppslagsfält i ett anpassat formulär anropar ett externt API och returnerar värden som alternativ i ett nedrullningsbart fält. Användare som arbetar med objektet som det anpassade formuläret är kopplat till kan välja ett eller flera av dessa alternativ i listrutan.
I den här artikeln finns exempel på hur du använder fältet för extern sökning för att anropa samma instans av Workfront eller ett offentligt API. Du kan också använda den externa sökningen för att kommunicera med ett externt system som Jira, Salesforce eller ServiceNow.
Externa sökfält är bara tillgängliga i den nya formulärdesignern, inte i den gamla formulärbyggaren. Mer information om hur du lägger till ett externt uppslagsfält i ett anpassat formulär och ytterligare definitioner för de externa uppslagskomponenterna finns i Designa ett formulär med formulärdesignern.
Konfigurera ett externt sökfält för samma instans av Workfront
Du kan använda den externa sökningen för att hämta data från din Workfront-instans till det anpassade formuläret.
I det här exemplet visas hur du anropar Workfront API och hämtar data från det befintliga statusfrågefältet till det externa sökfältet.
-
Öppna det anpassade formuläret.
-
Leta upp extern sökning till vänster på skärmen och dra den till ett avsnitt på arbetsytan.
-
Ange fältets etikett och namn.
-
Välj Format för fältet.
-
Ange API-URL-anropet i fältet Bas-API URL.
- Du kan lägga till $$HOST för att referera till samma instans.
- Du kan lägga till $$QUERY om du vill filtrera resultaten baserat på en fråga i ett annat fält.
Exempel
$$HOST/attask/api/v15.0/project/search?status={DE:StatusQuery}&$$QUERY -
Granska beroendena för fälten som det här sökfältet refererar till i API:t.
Ett beroendefält kan vara vilket anpassat eller inbyggt fält som helst som finns på objektets informationssida.
I det här exemplet ersätts
{DE:StatusQuery}med värdet för det anpassade statusfrågefältet. -
Välj HTTP-metod.
Detta kommer troligtvis att vara Get.
-
Ange JSON-sökvägen för att få resultat från ditt API-anrop.
Exempel
$.data[*].namenote note NOTE Rubrik krävs inte för ett anrop till samma Workfront-instans. -
Klicka på Använd.
När det anpassade formuläret läggs till i ett Workfront-objekt (i det här exemplet ett projekt) ser det ut ungefär så här.
Konfigurera ett externt sökfält för ett offentligt API
Du kan använda den externa sökningen för att anropa ett externt, offentligt API och hämta data.
I det här exemplet visas hur du anropar ett API med länder (till exempel https://api.first.org/data/v1/countries) så att du inte behöver hårdkoda alla landsnamn i listrutan.
-
Öppna det anpassade formuläret.
-
Leta upp extern sökning till vänster på skärmen och dra den till ett avsnitt på arbetsytan.
-
Ange fältets etikett och namn.
-
Välj Format för fältet.
-
Ange API-URL-anropet i fältet Bas-API URL.
- Du kan lägga till $$QUERY för att implementera frågefiltrering för slutanvändarna.
Exempel
Visar alla länder: https://api.first.org/data/v1/countriesTillåter användaren att söka efter ett land i listrutan: https://api.first.org/data/v1/countries?q=$$QUERY
Låter användaren söka efter ett land i en region: https://api.first.org/data/v1/countries?region={DE:Region}&q=$$QUERY
- De tillgängliga områdena definieras i ett separat anpassat fält i Workfront.
- När användaren väljer en region i formuläret visar fältet för extern sökning endast länderna i den regionen (i vilket land som regionen definieras i API:t). Användaren kan också söka efter ett land i den valda regionen.
-
Granska beroendena för fälten som det här sökfältet refererar till i API:t.
Ett beroendefält kan vara vilket anpassat eller inbyggt fält som helst som finns på objektets informationssida.
I det här exemplet ersätts
{DE:Region}med värdet för det anpassade fältet Region. -
Välj HTTP-metod.
Detta kommer troligtvis att vara Get.
-
Ange JSON-sökvägen för att få resultat från ditt API-anrop.
Med det här alternativet kan data extraheras från den JSON som returneras av API-URL:en. Det är ett sätt att välja vilka värden från JSON som ska visas i listrutealternativen.
Exempel
$.data[*].country -
(Valfritt) Klicka på Lägg till huvud och skriv eller klistra in det nyckel/värde-par som krävs för autentisering med API:t.
note note NOTE Rubrikfälten är inte ett säkert ställe att lagra inloggningsuppgifter på och du bör vara försiktig med vad du anger och sparar. -
(Valfritt) Välj Flervalslistruta om du vill att användaren ska kunna välja mer än ett värde i listrutan.
-
Klicka på Använd.
När det anpassade formuläret läggs till i ett Workfront-objekt (i det här exemplet ett projekt) ser det ut ungefär så här.
