Microsoft Adaptive Cards

Ten post jest trzecią częścią serii poświęconej technologii Adaptive Cards. Opisuje szczegółowo tę technologię, jak działa i jak możesz ją wykorzystać w Swoich rozwiązaniach. Jeśli interesuje Cię historia koncepcji, otwórz tutaj pierwszą część z serii.

Adaptive Cards – wprowadzenie

Ponieważ technologia ma swoje początki w rozwiązaniu Message Cards, dzięki czemu odziedziczyła jego wszystkie dobre cechy i została rozwinięta w bardziej dojrzałe i wieloplatformowe rozwiązanie.

Jedną z rzeczy, które zostały odziedziczone po Message Cards to deklaratywny kod tworzony za pomocą notacji JSON. Gwarantuje to bezpieczeństwo rozwiązania, ponieważ jedynie atrybuty „rozumiane” przez SDK zostaną przetworzone i wyświetlone użytkownikowi końcowemu. Próba wstrzyknięcia informacji spoza schematu będzie skutkować zupełnym brakiem wyświetlenia karty lub wyświetleniem tychże dodatkowych informacje w formie zwykłego tekstu.

Mówiąc o schemacie – ponieważ technologia nieustannie się zmienia, nie jest dobrą praktyką umieszczenie tutaj opisu „na sztywno”. Najnowszą definicję można znaleźć w dokumentacji tutaj: https://adaptivecards.io/explorer/. Dobrym pomysłem jest jednak opisanie głównych elementów budujących schemat, mając nadzieję, że te nie ulegną prędko dramatycznej zmianie:

Adaptive Cards schema
Schemat Adaptive Cards
  1. Definicja karty (card definition) – która zawiera wersję, style, tło, język itd… – podstawowa definicja kanwy karty, której autor planuje użyć.
  2. Zawartość (body) – zasadniczo cała zawartość, która będzie wyświetlana jako treść karty.
  3. Akcje (actions) – definiuje zestaw możliwych działań (przycisków, łączy), z którymi użytkownik końcowy może współdziałać.

Następnie w „Body” możemy wyróżnić:

  1. Kontenery (Containers) – obiekty pozwalające na grupowanie kontrolek razem w celu uzyskania lepszego układu/ wyglądu. Są to ActionSet, Container, ColumnSet, FactSet, ImageSet.
  2. Kontrolki (controls) – używane do prezentacji faktycznej zawartości. Są to: TextBlock, RichTextBlock, Media, Image.
  3. Pola formularza (Inputs) – służy do wyświetlania pól formularza, dzięki czemu użytkownik może nie tylko konsumować informacje, ale także wprowadzać własne. Są to na przykład: Text, Toggle, Date, ChoiceSet i inne…

Ważne! Wszystkie media (filmy, muzyka, obrazy), które są dostarczane jako źródło dla kontrolek, muszą być dostępne za pośrednictwem bezpiecznego adresu URL (https). Upewnij się również, że jeśli przekazujesz tekst wielowierszowy, wszystkie nowe linie zastępujesz znakiem \n, aby uniknąć błędów w formacie JSON.

Mówiąc o akcjach. Muszą być umieszczone w bloku ActionSet lub nie. Istnieją cztery rodzaje możliwych działań:

  1. OpenURL (aka GET)
  2. ShowCard
  3. Submit
  4. ToggleVisibility

Bardzo specyficzny rodzaj akcji, które nie są wyzwalane, gdy użytkownik kliknie przycisk, ale są dostępne dla zdarzenia, gdy to karta jest kliknięta lub zaznaczona:

  1. OpenURL (aka GET)
  2. Submit
  3. ToggleVisibility

Ważne! Podczas gdy akcja OpenURL i ToggleVisibility są wykonywane całkowicie po stronie klienta: OpenURL po prostu bezpośrednio otwiera podany adres URL, Toggle pokazuje / ukrywa część karty, tymczasem Submit i ShowCard (tylko jeśli ShowCardActionMode jest ustawiony na popup) są bardziej złożone. Czemu? Ponieważ akcja nie jest wykonywana bezpośrednio. Najpierw żądanie jest wysyłane do źródła (SDK, Bot), a następnie źródło jest odpowiedzialne za obsługę tej akcji.

SDK

SDK jest silnikiem, który otrzymany kod JSON parsuje i renderuje go w ładnie wyglądającą Adaptive Card. Dziś dostępne są już SDK dla najpopularniejszych platform, ale programiści mogą używać SDK w celu zaimplementowania go we własnych rozwiązaniach.

Obecnie można korzystać z kart adaptacyjnych na następujących platformach (https://docs.microsoft.com/en-us/adaptive-cards/rendering-cards/getting-started#adaptive-cards-sdks):

Gdzie SDK jest obecnie wdrażany i gdzie może być używany?

Where Adaptive Cards can be used today?
Gdzie dziś można już używać Adaptive Cards?
  • Microsoft Teams (SDK znajduje się w Bot Framework)
  • Bots (ogólnie :))
  • Speech (znów Bot Framework)
  • Windows Timeline (SDK w Windows UWP)
  • Cortana Skills (SDK w Windows WPF)
  • Email (Outlook Actionable Messages, SDK wbudowane)
  • Mobile email (Outlook Actionable Messages, SDK wbudowane, aktualnie jedynie na iOS)
  • Skype (SDK w Bot Framework)
  • Własne rozwiązania (własna implementacja SDK)

Ważne! Pamiętaj, że chociaż zespół Matta ciężko pracuje nad rozwojem nowych wersji i funkcjonalności Adaptive Cards, implementacja i aktualizacje SDK na istniejących platformach zależą od zespołów, które je rozwijają. Dlatego we wszystkich istniejących platformach Microsoft jedyną wersją kart adaptacyjnych, których można użyć, jest 1.0 (https://docs.microsoft.com/en-us/adaptive-cards/resources/partners#live).

Różne narzędzia do pomocy

Aktualnie Adaptive Card można zbudować przy użyciu różnych narzędzi, które pomagają projektantowi w wizualnym tworzeniu karty, a następnie na skopiowanie wygenerowanego kodu JSON, co pozwala na jego dalszą automatyzację w swoich rozwiązaniach.

AdaptiveCards Designer

To jest najbardziej popularne narzędzie, dostępne pod linkiem: https://adaptivecards.io/designer/. Pozwala ono wizualnie zaprojektować kartę (Drag&Drop). Ponadto zawsze korzysta z najnowszej, opublikowanej wersji SDK, która ma teraz numer 1.2, dzięki czemu można próbować najnowszych funkcjonalności.

App Studio w Microsoft Teams

Twórcy mogą dodać nową aplikację do swoich Microsoft Teams, gdzie mogą tworzyć karty i korzystać z nich od razu. By zainstalować rozwiązanie dla siebie przejdź do „Więcej dodanych aplikacji” w swoim kliencie, a następnie kliknij „Więcej aplikacji”, wpisz „app studio” w polu wyszukiwania i dodaj to, co się wyszuka:

App Studio in Microsoft Teams
App Studio w Microsoft Teams

Adaptive Card Viewer rozszerzenie w Visual Studio Code

Możliwe do dodania w postaci add-in do aplikacji VS Code (https://marketplace.visualstudio.com/items?itemName=tomlm.vscode-adaptivecards). Następnie, jeśli edytujesz plik JSON, który ma prawidłowy atrybut $schema karty adaptacyjnej ("$schema": "http://adaptivecards.io/schemas/adaptive-card.json"), możesz wyświetlić wygląd karty korzystając ze skrótu Ctrl+Shift+V A.

WPF Visualizer

Możesz także użyć innego typu wizualizatora przeznaczonego do tworzenia kart adaptacyjnych, które później mogą być używane w rozwiązaniach Windows: https://github.com/Microsoft/AdaptiveCards/tree/master/source/dotnet/Samples/WPFVisualizer

Actionable Messages Debugger dla Outlook

To dodatek do wersji Outlook Desktop i Online, który pozwala autorom debugować karty w aplikacji, aby zobaczyć, co się w nich dzieje. Możesz je pobrać stąd: https://appsource.microsoft.com/en-us/product/office/WA104381686

Gdzie jeszcze?

Zasadniczo, ponieważ designer dla Adaptive Cards jest również rozwiązaniem JavaScript w formie Open Source, można osadzić je we własnej aplikacji. Po prostu pobierz paczkę z npm: https://www.npmjs.com/package/adaptivecards-designer

Jak zacząć?

Najpierw musisz przygotować kod JSON swojej karty.

Adaptive Cards Designer
Adaptive Cards Designer

Następnie musisz utworzyć aplikację / bot / rozwiązanie, które wyświetli ją lub wyśle do aplikacji, w której będzie wyświetlana (np. Microsoft Teams wyświetla karty opublikowane przez Bot Framework, lub Windows Notifications wyświetla karty opublikowane przez aplikacje, takie jak Mail).

Ponieważ nie jestem programistą, najłatwiejszym sposobem na wykorzystanie Adpative Cards dla mnie jest użycie narzędzi, które już posiadają SDK i wyrenderują dla mnie kartę na podstawie dostarczonego JSON. Myślę tu oczywiście o Microsoft Flow i Teams.

Microsoft Flow crafting an Adaptive Card
Tworzenie Adaptive Card w Microsoft Flow

Następnie należy zastąpić wszystkie stałe wartości zdefiniowane w JSON dynamicznymi wartościami pobranymi z danych użytkownika / zewnętrznej bazy – takimi, które są związane z procesem, w którym używana jest karta.

Posting Adaptive Card from Microsoft Flow to Teams
Wysyłanie Adaptive Card z Microsoft Flow do Teams

Na koniec karta musi zostać wysłana przez Twoje rozwiązanie do docelowej aplikacji.

Sending Adaptive Card to Microsoft Teams
Wyświetlanie Adaptive Card w Microsoft Teams

I to wszystko! To takie proste. W moim następnym poście pokażę, jak zbudować takie rozwiązanie, które wykorzystuje karty adaptacyjne do bardziej sprawnego i łatwiejszego zatwierdzenia w procesach biznesowych w organizacji. Bądź czujny!

Dziękuję, że dotarłeś tak daleko! Ten post jest już drugim z serii, w której możesz dowiedzieć się o:

  1. Wprowadzenie do Adpative Cards
  2. Message Cards – case study i how-to
  3. Adaptive Cards – case study i how-to
  4. Co w planach dla wersji 2.0 (mam nadzieję, z przykładami :))

Czy chcesz dowiedzieć się więcej o kartach adaptacyjnych? Skontaktuj się ze mną lub zostaw komentarz.