Vejledning til connectorstreng

Følgende emne indeholder en generel vejledning til strengfelter i en connector til Power Automate, Power Apps og Logic Apps.

Oplysninger om connector

Hver connector skal have en titel, som er navnet på connectoren, og en generel beskrivelse af connectoren. Disse oplysninger skal angives i felterne til titel og beskrivelse under afsnittet med oplysninger i OpenAPI-definitionen (i filen apiDefinition.swagger.json).

Som minimum skal følgende retningslinjer overholdes for connectors titler og beskrivelser:

• Der kan maksimalt være 30 tegn i connectortitlen.
• Connectorens titel og beskrivelse må ikke indeholde ordet API.
• Connectorens titel og beskrivelse må ikke referere til et Power Platform-produkt eller et produkt, som du ikke ejer backend-API'erne til.

Der findes en højere standard for retningslinjer til titel og beskrivelsesfelter, der gennemtvinges for certificerede connectorer, her, og den bør bruges som bedste praksis.

Drift

Alle stier og verber i OpenAPI-definitionen svarer til en operation. En korrekt beskrivelse af operationen med hver af nedenstående strenge/mærker hjælper slutbrugeren med at bruge den korrekt. Nogle af strengfelterne til en handling er:

• oversigt: Dette felt viser navnet på handlingen.

  • Store og små bogstaver: Sætning
  • Noter:
    • Der må ikke være nogen skråstreg ('/') i navnet.
    • Det må ikke indeholde mere end 80 tegn.
    • Den må ikke slutte med et tegn, der ikke er alfanumerisk, herunder tegnsætning eller mellemrum.

• beskrivelse: Dette vises som beskrivelsen af handlingen, når knappen Oplysninger vælges (som vist på billedet nedenfor).

  • Store og små bogstaver: Sætning
  • Bemærk: Gør det kort nok til tekstfeltet. Intet punktum påkrævet i forbindelse med et enkelt ord.

• handlings-ID: Dette er det entydige id, der er knyttet til handlingen.

  • Store og små bogstaver: Sammentrukket
  • Bemærk: Beregnet til at udtrykke handlingens betydning, f.eks. HentKontakter eller OpretKontakt.

  Billedet herunder viser, hvordan felterne oversigt (Send en mail) og beskrivelse (Denne handling sender en mail) vises i brugergrænsefladen under oprettelse af en arbejdsproces.

  

Udløsere i forhold til handlinger

En udløser starter en arbejdsproces eller proces. For eksempel "Start en arbejdsproces hver mandag kl. 3", "Når der oprettes et objekt" osv.

Udløserfelter til oversigt og beskrivelse skal være menneskeligt læsbare og have semantisk betydning. Udløseren oversigt er som regel i formatet: "Når __________________".

Eksempel:

Udløseren beskrivelse er som regel i formatet: "Denne handling udløses, når _______________"

Eksempel:

• Denne handling udløses, når der tilføjes en ny opgave.

En handling er en opgave, der skal udføres i din arbejdsproces, f.eks. "Send en mail", "Opdater en række", "Send en meddelelse" osv. Nedenfor er angivet nogle få eksempler på handlingen oversigt:

Parametre

Hver operation (uanset om det er en udløser eller en handling) har parametre, som brugeren angiver som input. Nogle af de vigtige strengfelter til en parameter er:

• x-ms-oversigt: Dette felt viser navnet på parameteren.

  • Store og små bogstaver: Titel
  • Bemærk: Det må højst være på 80 tegn

• beskrivelse: Dette viser parameterbeskrivelsen i inputfeltet.

  • Store og små bogstaver: Sætning
  • Bemærk: Gør den kort nok til tekstfeltet. Intet punktum påkrævet i forbindelse med et enkelt ord.

  På billedet nedenfor har den fremhævede parameter "Emne" som værdien for feltet x-ms-oversigt og "Angiv mailens emne" som beskrivelse.

  

Response

Hver operation har et svar, som kan bruges senere i arbejdsprocessen som input til en efterfølgende operation. Resultatskemaet er sammensat af flere egenskaber. Nogle af de vigtige strengfelter til hver egenskab er:

• x-ms-oversigt: Dette felt viser navnet på egenskaben.

  • Store og små bogstaver: Titel
  • Bemærk: Brug et kort navn.

• beskrivelse: Dette viser beskrivelsen af resultategenskaben.

  • Store og små bogstaver: Sætning
  • Bemærk: Skal være kort og præcist og slutte med et punktum.

  På billedet, der vises nedenfor, vises resultatskemaet fra handlingen "Udløs et flow manuelt", når du forsøger at tilføje dynamisk indhold i en af de efterfølgende handlinger i arbejdsprocessen. Her er "Brugermail" x-ms-oversigt, og teksten nedenfor er beskrivelse for en egenskab i svaret på operationen "Udløs et flow manuelt".

Der er et par vigtige ting, der generelt skal tages i betragtning for felterne med oversigt/x-ms-oversigt og beskrivelse:

• Tekst i oversigt og beskrivelse må ikke være ens.
• Beskrivelsen bør bruges til at give yderligere oplysninger til brugeren, f.eks. hvilket outputformat eller objekt egenskaben er relateret til. For eksempel: oversigt : id, beskrivelse: brugerens id.
• I tilfælde af et objekt med indlejrede værdier bliver x-ms-oversigt for den overordnedes navn føjet til den underordnede.

x-ms-visibility

Bestemmer enhedens prioritet af synlighed. Hvis der ikke er angivet nogen synlighed, betragtes det som "normal" synlighed. De mulige værdier er "vigtig", "avanceret" eller "intern". En enhed, der er markeret som "intern", vises ikke i brugergrænsefladen.

Gælder for:

• Operationer
• Parametre
• Svaregenskaber

Eksempel: I brugergrænsefladen vises enheder, der er markeret som "vigtige", oftest først, mens ting, der er markeret som "avancerede", er skjult under en til/fra-knap (fremhævet), og ting, der er markeret som "interne", vises ikke. Som vist i billedet nedenfor er de parametre, der er markeret som "vigtige", som standard synlige, og de parametre, der er markeret som "avanceret", vises, når du klikker på knappen "Vis avancerede indstillinger".