SmartCOMM DocGen (wersja zapoznawcza)

Smart Communications to wiodąca firma technologiczna, która koncentruje się na pomaganiu firmom w bardziej znaczących rozmowach klientów.

Łącznik Doc-Gen SmartCOMM na żądanie zawiera wstępnie utworzoną integrację na potrzeby tworzenia komunikacji z klientami wielokanałowych. Łącznik udostępnia wywołania usługi internetowej RESTful do funkcji SmartCOMM w przypadku przypadków użycia na żądanie.

Ten łącznik jest dostępny w następujących produktach i regionach:

Smart Communications™ to wiodąca platforma oparta na chmurze na potrzeby komunikacji z klientami w przedsiębiorstwie. Jako jedyne rozwiązanie w chmurze sklasyfikowane jako lider w Magic Quadrant firmy Gartner for Customer Communications Management, ponad 350 globalnych marek — wielu z najbardziej regulowanych branż na świecie — polega na komunikacji inteligentnej, aby komunikacja klientów wielokanałowych miała większe znaczenie, a także pomaga im uprościć swoje procesy i działać wydajniej.

Łącznik SmartCOMM On Demand dla usługi Power Apps obejmuje wstępnie utworzoną integrację do tworzenia komunikacji z klientami. Łącznik udostępnia wywołania usługi internetowej RESTful do funkcji SmartCOMM w przypadku przypadków użycia na żądanie.

Łącznik obsługuje operację SmartCOMM "GenerateDocument", która generuje odpowiedź, w tym dane wyjściowe zakodowane w formacie base64[]. Dane wyjściowe obsługują różne typy danych wyjściowych kanału. (np. SMS, PRINT, TEXT, XML, TML, XSLFO, HTML)

Wymagania wstępne

Aby można było użyć składnika SmartCOMM w usłudze Power Apps, najpierw należy wykonać kilka czynności:

• Plan usługi Microsoft Power Apps lub Power Automate z funkcją łącznika niestandardowego
• Wystąpienie smartCOMM skonfigurowane dla organizacji z dostępem użytkowników
• W celu skonfigurowania szablonu dokumentu w celu wygenerowania dokumentów należy skontaktować się z kontaktem usługi Smart Communications.
• Aby skonfigurować ustawienia składnika — musisz znać identyfikator zasobu selektora szablonów SmartCOMM lub "BatchConfigResID". Poproś kontakt z usługą Smart Communications o pomoc w znalezieniu tego.
• Konfigurowanie wystąpienia smartCOMM przy użyciu klienta OAuth 2.0 (typ udzielania kodu autoryzacji)

Jak uzyskać poświadczenia

1. Skontaktuj się z administratorem użytkownika SmartCOMM, aby utworzyć dostęp użytkownika
2. Po utworzeniu dostępu użytkownika otrzymasz wiadomość e-mail z informacją o aktywowaniu konta
3. Postępuj zgodnie z instrukcjami, aby aktywować konto
4. W przepływie Kod autoryzacji użytkownik SmartCOMM, który jest właścicielem zasobów w chmurze SmartCOMM, autoryzuje klientów do uzyskiwania dostępu do konta użytkownika. Użytkownicy będą uzyskiwać dostęp do adresu URL przekierowania w celu zalogowania się do dzierżawy. Użytkownicy mogą wprowadzić swoją nazwę użytkownika i poświadczenia, aby uzyskać dostęp do dzierżawy podczas pierwszej próby. (następujące próby zostaną wyświetlone bezpośrednio na stronie kodu dostępu)
5. Zaakceptuj żądanie pobrania kodu dostępu, klikając przycisk Akceptuj.
6. Następnie klienci używają tokenów dostępu do uzyskiwania dostępu do zasobów, a nie poświadczeń użytkownika.

Wprowadzenie do łącznika

1. Podaj adres URL hosta wystąpienia SmartCOMM
2. Podaj szczegóły klienta protokołu OAuth 2.0 — identyfikator klienta, klucz tajny klienta, adres URL autoryzacji i adres URL tokenu
3. Podaj wygenerowany adres URL przekierowania usługi Power Apps (np. https://global.consent.azure-apim.net/redirect)
4. Tworzenie połączenia danych z wystąpieniem smartCOMM przy użyciu zarejestrowanego konta użytkownika
   • Potrzebujemy pełnej konfiguracji generatora dokumentów w programie SmartCOMM, który zawiera co najmniej selektor szablonu, szablon i model danych.
5. Tworzenie łącznika
   • wymagane parametry:
     • Region
       • RegionServer dla exmaple: eu10-sb
     • Identyfikator klienta
       • Jest ona taka sama jak w obszarze Podaj szczegóły klienta OAuth 2.0
     • Klucz tajny klienta
       • Jest ona taka sama jak w obszarze Podaj szczegóły klienta OAuth 2.0
6. Podaj adres URL żądania, aby wygenerować punkt końcowy dokumentu. Np. https://< RegionServer.smartcommunications.cloud/one/oauth2/api/v10/job/generateDocument>
   • wymagane parametry:
     • Uwzględnij dane dokumentu
       • Tak jak zwykle
     • transactionData (Json lub XML)
       • nie ma potrzeby kodowania base64, ponieważ jest on wykonywany przez łącznik
       • powinien mieć taki sam format jak w smartcomm
     • batchConfigResId
       • Identyfikator zasobu selektora szablonu smartcomm
     • identyfikator projektu
       • wartość domyślna jest pusta, ale musi być wypełniona, gdy projekt SmartComm nie zostanie wydany
     • transactionRange
       • może być pusty, ale po wypełnieniu powinien pokazywać, jakie indeksy powinny być używane z tablicy
     • transactionDataType
       • application/json lub application/xml
       • jest to format parametru transactionData
     • dodatkowe parametry, takie jak merge.pdf, można odczytać w opisie interfejsu API SmartComm
       • <https:// server.smartcommunications.cloud/one/apiViewer/>
       • Gdzie <serwer to używany serwer> usługi Smart Communications (NA1.smartcommunications.cloud, EU1.smartcommunications.cloud itd.).
7. Łącznik SmartCOMM On Demand Generation generuje komunikację i zwraca odpowiedź (w tym dane wyjściowe zakodowane w formacie base64) do aplikacji Power App
   • Zwraca tablicę kopert zawierającą dokumenty zakodowane w formacie base64.
   • Dokument zwykle wewnątrz <dokumentuWłącze><koperty koperty><><primaryChannel><data>string</data>
8. Komunikację można następnie wyświetlić w aplikacji Power App do pobrania, zarchiwizowanej (np. zasobnik programu SharePoint, S3) lub wypchniętej do usługi dostarczania danych wyjściowych, np. SNS, Outlook, poczty itp.

Znane problemy i ograniczenia

1. Ograniczanie szybkości (zapoznaj się z administratorem smartCOMM, aby uzyskać więcej szczegółów, ponieważ jest to część umowy licencyjnej)
2. Maksymalny rozmiar pojedynczego żądania to 10 MB

Typowe błędy i środki zaradcze

1. Upewnij się, że właściwość "transactionDataType" jest ustawiona na wartość "application/json" podczas korzystania z ładunku JSON.
2. Upewnij się, że określ wartość "projectId", jeśli chcesz ograniczyć zakres w projekcie SmartCOMM
3. Upewnij się, że parametr "includeDocumentData" ma wartość true, gdy potrzebne są dane wyjściowe, które mają zostać uwzględnione w odpowiedzi
4. Zapoznaj się z sekcją Typowe kody błędów poniżej.

Typowe kody błędów

• HTTP 403 — Generowanie dokumentu nie powiodło się. Ten błąd zwraca wartość "id" (kod błędu SmartCOMM) i błąd "msg" (opis błędu SmartCOMM)

• HTTP 500 — wewnętrzny błąd serwera Zalecamy również, aby w przypadku wystąpienia błędu podczas wywoływania usługi czekać pięć sekund przed ponowną próbą. W przypadku wielu ciągłych awarii usługa powinna powiadamiać użytkowników i przestać przesyłać to połączenie, ponieważ żądanie może być nieprawidłowe.

• HTTP 429 — zbyt wiele żądań, jeśli otrzymasz odpowiedź HTTP 429, poczekaj 60 sekund, a następnie ponów próbę żądania.

• HTTP 503 — usługa niedostępna Podczas konserwacji jest wysyłana odpowiedź HTTP 503. Poczekaj 120 sekund, a następnie ponów próbę żądania. Okna obsługi mogą trwać godzinę lub więcej podczas uaktualniania kamienia milowego.

Często zadawane pytania

"Podaj tutaj podział często zadawanych pytań i odpowiednich odpowiedzi. Może to obejmować często zadawane pytania dotyczące interakcji z podstawową usługą lub samego łącznika.

• Gdzie mogę znaleźć dalsze informacje o usłudze "GenerateDocument"? — można znaleźć tutaj — https://< RegionServer.smartcommunications.cloud/one/apiViewer/#!api=doc-gen&operation=generateDocumentNonMultiPart&resource=Job>

• Czy dane są szyfrowane przy użyciu tego łącznika? — Tak, jeśli skonfigurowano protokół HTTPS, połączenie zostanie zaszyfrowane na końcu.

• Jak uzyskać konto użytkownika SmartCOMM? - Skontaktuj się z administratorem użytkownika SmartCOMM.

• Jaki jest typ autoryzacji? - OAuth 2.0

• Jak uzyskać identyfikator klienta OAuth2 i wpis tajny? — Skontaktuj się z administratorem aplikacji SmartCOMM lub zapoznaj się z https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #EditClient.htm

• Jak uzyskać kod autoryzacji? — Zapoznaj się z sekcją "Jak uzyskać poświadczenia" powyżej, aby uzyskać szczegółowe informacje.

• Jak uzyskać pomoc techniczną dotyczącą tego łącznika? - Kontakt dotyczący support@smartcommunications.com wszystkich zapytań dotyczących pomocy technicznej

• Gdzie można znaleźć więcej informacji o produkcie SmartCOMM? - https://www.smartcommunications.com

• Jak uzyskać identyfikator batchConfigResId? - Skontaktuj się z ekspertem SmartCOMM lub zapoznaj się z https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #ResourceProperties.htm.

• Jak uzyskać identyfikator projectId? - Skontaktuj się z ekspertem SmartCOMM lub zapoznaj się z https://< RegionServer.smartcommunications.cloud/one/help/oneplatform/en/index.htm> #ResourceProperties.htm.

• Jak szybko otrzymam odpowiedź? — Czas odpowiedzi może się różnić w zależności od szybkości sieci, rozmiaru ładunku i złożoności zasobów itp. SmartCOMM zaleca uruchomienie punktu odniesienia wydajności w celu zebrania maksymalnego czasu odpowiedzi i średniego czasu odpowiedzi

• Jak uzyskać dane wyjściowe z odpowiedzi? — Pomyślna odpowiedź zawiera dane wyjściowe zakodowane w formacie base64[]. Aby wyświetlić dane wyjściowe, należy wykonać akcje w celu dekodowania danych wyjściowych bajtu[] i zapisania kopii w formacie określonym w parametrze "mimeType". Aby uzyskać więcej informacji, zobacz https://< RegionServer.smartcommunications.cloud/one/apiViewer/#!api=doc-gen&operation=generateDocumentNonMultiPart&resource=Job>

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:

Domyślny

Dotyczy: wszystkie regiony

Parametry tworzenia połączenia.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Limity ograniczania

Akcje

Generowanie dokumentu