TemplioniX (wersja zapoznawcza)
TemplioniX to interfejs API generowania dokumentów do tworzenia plików DOCX i PDF z szablonów Word wielokrotnego użytku. Ten łącznik służy do wyodrębniania metadanych szablonu, generowania pojedynczego dokumentu, uruchamiania generowania dokumentów zbiorczych, sprawdzania stanu zadania zbiorczego, pobierania wygenerowanych wyników i wyświetlania informacji o subskrypcji lub użyciu.
Uwierzytelnianie jest wykonywane przy użyciu przekazanego klucza interfejsu API.
Wygenerowane zbiorcze linki pobierania zip są ważne przez 24 godziny.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate - narzędzie do automatyzacji procesów | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt biznesowy | |
|---|---|
| Name | Obsługa biblioteki TemplioniX |
| adres URL | https://templionix.com |
| support@templionix.com |
| Metadane łącznika | |
|---|---|
| Publisher | TemplioniX |
| Witryna internetowa | https://templionix.com |
| Zasady ochrony prywatności | https://templionix.com/privacy-policy |
| Warunki użytkowania | https://templionix.com/terms-of-use |
| Kategorie | Produktywność; Zawartość i pliki |
| IconBrandColor | #333A41 |
Łącznik TemplioniX
Overview
TemplioniX to usługa generowania dokumentów, która ułatwia tworzenie plików DOCX i PDF z szablonów Microsoft Word wielokrotnego użytku i danych JSON ze strukturą.
Ten łącznik umożliwia użytkownikom łączenie przepływów pracy Microsoft Power Automate, Power Apps, Azure Logic Apps i Copilot Studio z interfejsem API TemplioniX. Użytkownicy mogą wyodrębniać metadane szablonu, generować początkowe ładunki JSON, generować dokumenty, uruchamiać zadania generowania dokumentów zbiorczych, sprawdzać stan zadania, pobierać wygenerowane wyniki i pobierać dostępne szablony.
Publisher
TemplioniX
Zamierzone produkty Microsoft
- Microsoft Power Automate
Łącznik jest implementowany jako łącznik niestandardowy Microsoft Power Platform i może być używany w innych środowiskach łączników Microsoft, w których obsługiwane są certyfikowane łączniki.
Authentication
Łącznik używa uwierzytelniania klucza interfejsu API. Klucz interfejsu API jest przekazywany w nagłówku x-functions-key żądania.
Użytkownicy muszą mieć aktywne konto TemplioniX i prawidłowy klucz interfejsu API do korzystania z tego łącznika.
Główne możliwości
Pobieranie szablonów
Pobiera listę dostępnych szablonów dokumentów z witryny TemplioniX z podziałem na strony. Ta operacja może służyć do wybierania szablonu przed wygenerowaniem metadanych, modelu początkowego, pojedynczego dokumentu lub zadania generowania dokumentu zbiorczego.
Wyodrębnianie pól szablonu i symboli zastępczych
Wyodrębnia metadane z wybranego szablonu, w tym pola szablonu i symbole zastępcze. Pomaga to użytkownikom zrozumieć, jakie dane są oczekiwane przez szablon.
Generowanie początkowego ładunku JSON dla szablonu
Generuje przykładowy ładunek JSON na podstawie wybranego szablonu. Użytkownicy mogą używać tego ładunku jako punktu wyjścia do mapowania danych z innych systemów na żądanie generowania dokumentów.
Generowanie dokumentu
Generuje dokument DOCX lub PDF na podstawie wybranego szablonu i wejściowych danych JSON.
Zbiorcze generowanie dokumentów
Uruchamia zadanie generowania dokumentów zbiorczych przy użyciu wybranego szablonu i wielu rekordów wejściowych. Wygenerowane zbiorcze linki pobierania zip są ważne przez 24 godziny.
Pobieranie stanu zadania generowania zbiorczego
Pobiera informacje o stanie i wynikach dla określonego zadania generowania dokumentów zbiorczych.
Pobieranie zadań generowania zbiorczego według szablonu
Pobiera zadania generowania zbiorczego skojarzone z wybranym szablonem.
Typowe scenariusze użycia
- Generowanie kontraktów, faktur, propozycji, raportów, listów i innych dokumentów biznesowych na podstawie danych strukturalnych.
- Automatyzowanie tworzenia dokumentów na podstawie systemów CRM, ERP, forms, Excel, SharePoint, Dataverse, SQL lub API.
- Tworzenie pojedynczych dokumentów na żądanie na podstawie przepływu pracy.
- Wygeneruj zbiorczo wiele dokumentów i pobierz wygenerowany wynik zip.
- Użyj wyodrębnionych metadanych szablonu, aby zrozumieć, które pola są wymagane do generowania dokumentów.
Przykładowy przepływ pracy
- Wyzwalanie przepływu ręcznie lub z zdarzenia biznesowego.
- Użyj operacji Pobierz szablony, aby wybrać szablon.
- Użyj operacji Generowanie początkowego ładunku JSON, aby zrozumieć oczekiwaną strukturę danych.
- Mapuj dane systemu źródłowego na wygenerowaną strukturę JSON.
- Użyj operacji Generowanie dokumentu, aby utworzyć plik DOCX lub PDF.
- Zapisz wygenerowany plik w celu OneDrive, SharePoint, usługi Dataverse, poczty e-mail lub innego miejsca docelowego.
Support
Aby uzyskać informacje o produkcie, dokumentację i pomoc techniczną, odwiedź stronę:
- Witryna internetowa: https://templionix.com
- Dokumentacja: https://docs.templionix.com
- Wsparcie: https://templionix.com/contact
- Zasady ochrony prywatności: https://templionix.com/privacy-policy
- Warunki użytkowania: https://templionix.com/terms-of-use
Uwagi dotyczące przeglądu certyfikacji
Ten pakiet zawiera rozwiązanie łącznika TemplioniX i przykładowe rozwiązanie przepływu, które demonstruje operacje łącznika. Łącznik komunikuje się z produkcyjnym interfejsem API TemplioniX i używa uwierzytelniania klucza interfejsu API za pośrednictwem nagłówka x-functions-key .
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
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.
| Name | Typ | Description | Required |
|---|---|---|---|
| TemplioniX Api Key | securestring | Klucz interfejsu API TemplioniX dla tego interfejsu API | True |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Generowanie dokumentu na podstawie danych szablonu |
Scala podany ładunek JSON z wybranym szablonem i zwraca wygenerowany dokument. Użyj |
| Generowanie początkowego ładunku JSON dla szablonu |
Tworzy przykładową strukturę JSON zgodną z symbolami zastępczymi odnalezionymi w wybranym szablonie, co umożliwia ponowne użycie jej jako danych wejściowych na potrzeby generowania dokumentu |
| Lista dostępnych szablonów |
Zwraca listę szablonów podzielonych na strony, które mogą być używane z wyodrębnianiem metadanych, generowaniem modelu i punktami końcowymi generowania dokumentów |
| Pobieranie stanu zadania generowania zbiorczego |
Ładuje stan zadania według identyfikatora: stan, czas rozpoczęcia/zakończenia, adres URL sygnatury dostępu współdzielonego ZIP po zakończeniu, błąd orkiestracji po niepowodzeniu i przeanalizowane błędy generowania poszczególnych elementów. |
| Uruchamianie generowania dokumentów zbiorczych |
Rozpocznij zadanie zbiorcze w celu wygenerowania dokumentów na podstawie udostępnionego szablonu, skompiluje plik ZIP z odczytanym adresem URL sygnatury dostępu współdzielonego i śledzi postęp. Zwraca identyfikator zadania natychmiast. Zwrócony adres URL pobierania pliku ZIP jest dostępny po zakończeniu zadania i jest ważny przez 24 godziny od czasu generowania. |
| Wyodrębnianie pól szablonu i symboli zastępczych |
Odczytuje wybrany szablon i zwraca kontrolki zawartości odnalezione w dokumencie, w tym tytuł, tag, typ i wstępnie zdefiniowane wartości, jeśli są dostępne. |
| Wyświetlanie listy zadań generowania zbiorczego dla szablonu |
Zwraca wszystkie zadania dla partycji generowania zbiorczego, w której jest zgodny identyfikator TemplateId; ten sam kształt ładunku co stan pojedynczego zadania posortowany według malejącego czasu rozpoczęcia |
Generowanie dokumentu na podstawie danych szablonu
Scala podany ładunek JSON z wybranym szablonem i zwraca wygenerowany dokument. Użyj .docx do Word danych wyjściowych lub .pdf danych wyjściowych PDF
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Template
|
templateId | uuid |
Unikatowy identyfikator szablonu |
|
|
dane
|
data | object |
Obiekt JSON zawierający wartości symboli zastępczych szablonu. |
|
|
Nazwa dokumentu
|
documentName | string |
Nazwa wygenerowanego dokumentu bez rozszerzenia, chyba że interfejs API akceptuje rozszerzenie |
|
|
Format
|
format | string |
Format danych wyjściowych. Użyj .docx do Word dokumentów lub .pdf dokumentów PDF. |
Zwraca
- response
- file
Generowanie początkowego ładunku JSON dla szablonu
Tworzy przykładową strukturę JSON zgodną z symbolami zastępczymi odnalezionymi w wybranym szablonie, co umożliwia ponowne użycie jej jako danych wejściowych na potrzeby generowania dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator szablonu
|
templateId | True | uuid |
Unikatowy identyfikator szablonu zwrócony przez wykaz szablonów |
Zwraca
- response
- object
Lista dostępnych szablonów
Zwraca listę szablonów podzielonych na strony, które mogą być używane z wyodrębnianiem metadanych, generowaniem modelu i punktami końcowymi generowania dokumentów
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer strony
|
pageNumber | True | integer |
1-oparty na indeksie strony, który ma być zwracany |
|
Rozmiar strony
|
pageSize | True | integer |
Maksymalna liczba szablonów, które mają być zwracane w jednej odpowiedzi |
Zwraca
Stronicowana odpowiedź oparta na przesunięciach zawierająca rekordy szablonów.
Pobieranie stanu zadania generowania zbiorczego
Ładuje stan zadania według identyfikatora: stan, czas rozpoczęcia/zakończenia, adres URL sygnatury dostępu współdzielonego ZIP po zakończeniu, błąd orkiestracji po niepowodzeniu i przeanalizowane błędy generowania poszczególnych elementów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zadania zbiorczego
|
jobId | True | string |
Identyfikator zadania zwrócony w odpowiedzi generateDocumentsBulk 202 ( |
Zwraca
Szczegóły stanu i wyniku dla zadania generowania dokumentu zbiorczego.
Uruchamianie generowania dokumentów zbiorczych
Rozpocznij zadanie zbiorcze w celu wygenerowania dokumentów na podstawie udostępnionego szablonu, skompiluje plik ZIP z odczytanym adresem URL sygnatury dostępu współdzielonego i śledzi postęp. Zwraca identyfikator zadania natychmiast. Zwrócony adres URL pobierania pliku ZIP jest dostępny po zakończeniu zadania i jest ważny przez 24 godziny od czasu generowania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Template
|
templateId | uuid |
Unikatowy identyfikator szablonu |
|
|
Format
|
format | string |
Format danych wyjściowych. Używanie .docx dla dokumentów Word lub .pdf dokumentów PDF |
|
|
Nazwa pliku
|
fileName | string |
Wygenerowana lub żądana nazwa pliku |
|
|
items
|
items | object |
Zwraca
Odpowiedź zwrócona, gdy zadanie generowania dokumentu zbiorczego zostało zaakceptowane do przetwarzania.
Wyodrębnianie pól szablonu i symboli zastępczych
Odczytuje wybrany szablon i zwraca kontrolki zawartości odnalezione w dokumencie, w tym tytuł, tag, typ i wstępnie zdefiniowane wartości, jeśli są dostępne.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator szablonu
|
templateId | True | uuid |
Unikatowy identyfikator szablonu zwrócony przez wykaz szablonów |
Zwraca
- response
- array of contentControlInfoDto
Wyświetlanie listy zadań generowania zbiorczego dla szablonu
Zwraca wszystkie zadania dla partycji generowania zbiorczego, w której jest zgodny identyfikator TemplateId; ten sam kształt ładunku co stan pojedynczego zadania posortowany według malejącego czasu rozpoczęcia
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator szablonu
|
templateId | True | uuid |
Zwracane są tylko zadania uruchomione z tym identyfikatorem szablonu |
Zwraca
- response
- array of bulkGenerationJobStatusDto
Definicje
bulkGenerationAcceptedDto
Odpowiedź zwrócona, gdy zadanie generowania dokumentu zbiorczego zostało zaakceptowane do przetwarzania.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator zadania
|
jobId | string |
Unikatowy identyfikator zadania generowania zbiorczego. |
|
Rozpoczęto:
|
startedAt | date-time |
Data i godzina UTC rozpoczęcia operacji. |
bulkGenerationFailureItemDto
Informacje o jednym nieudanych elementach dokumentu w zadaniu generowania zbiorczego.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Indeks globalny
|
globalIndex | string |
Indeks lub wewnętrzny identyfikator wygenerowanego elementu, który zakończył się niepowodzeniem. |
|
Nazwa pliku
|
fileName | string |
Wygenerowana lub żądana nazwa pliku. |
|
Error
|
error | string |
Komunikat o błędzie dla elementu, który zakończył się niepowodzeniem. |
bulkGenerationJobStatusDto
Szczegóły stanu i wyniku dla zadania generowania dokumentu zbiorczego.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator zadania
|
jobId | string |
Unikatowy identyfikator zadania generowania zbiorczego. |
|
Identyfikator szablonu
|
templateId | uuid |
Unikatowy identyfikator szablonu. |
|
Status
|
status | string |
Bieżący stan zadania, na przykład: Oczekujące, Uruchomione, Ukończone, Niepowodzenie lub Częściowo Ukończone. |
|
Rozpoczęto:
|
startedAt | date-time |
Data i godzina UTC rozpoczęcia operacji. |
|
Godzina zakończenia
|
endTime | date-time |
Data i godzina UTC zakończenia zadania. |
|
Zip Url
|
zipUrl | string |
Adres URL pobierania tymczasowego dla wygenerowanego pliku ZIP. W przypadku generowania zbiorczego ten link jest ważny przez 24 godziny od czasu generowania. |
|
Komunikat o błędzie
|
errorMessage | string |
Komunikat o błędzie na poziomie zadania, jeśli aranżacja nie powiodła się. |
|
failedGenerations
|
failedGenerations | array of bulkGenerationFailureItemDto |
Kolekcja elementów, które zakończyły się niepowodzeniem w zadaniu generowania zbiorczego. |
|
Liczba nieudanych generacji
|
failedGenerationCount | integer |
Liczba elementów zakończonych niepowodzeniem w zadaniu generowania zbiorczego. |
categoryDto
Informacje o kategorii szablonu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | uuid |
Unikatowy identyfikator. |
|
name
|
name | string |
Nazwa wyświetlana |
contentControlInfoDto
Metadane jednej Word kontrolki zawartości lub symbolu zastępczego odnalezionych w szablonie.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
title
|
title | string |
Tytuł kontrolki zawartości. |
|
oznaczyć
|
tag | string |
Tag kontrolki zawartości używany jako klucz pola JSON. |
|
typ
|
type | string |
Typ kontrolki zawartości. |
pagedResponseOffsetDto_templateInfoDto
Stronicowana odpowiedź oparta na przesunięciach zawierająca rekordy szablonów.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dane
|
data | array of templateInfoDto |
Obiekt JSON zawierający wartości symboli zastępczych szablonu. |
|
Numer strony
|
pageNumber | integer |
Bieżący numer strony. |
|
Rozmiar strony
|
pageSize | integer |
Liczba rekordów na stronę. |
|
Łączna liczba rekordów
|
totalRecords | integer |
Całkowita liczba dostępnych rekordów. |
|
Łączna liczba stron
|
totalPages | integer |
Łączna liczba stron. |
templateInfoDto
Element wykazu szablonów zwrócony przez punkt końcowy listy szablonów.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | uuid |
Unikatowy identyfikator. |
|
Name
|
name | string |
Nazwa wyświetlana |
|
Description
|
description | string |
Czytelny dla człowieka opis. |
|
Data utworzenia
|
createdOn | date-time |
Data i godzina UTC utworzenia szablonu. |
|
Ostatnia modyfikacja
|
lastModified | date-time |
Data i godzina UTC ostatniej modyfikacji szablonu. |
|
categories
|
categories | array of categoryDto |
Kategorie szablonów. |
plik
Jest to podstawowy typ danych "file".
obiekt
Jest to typ 'obiekt'.