TemplioniX (Preview)
TemplioniX je rozhraní API pro generování dokumentů pro vytváření souborů DOCX a PDF z opakovaně použitelných Word šablon. Pomocí tohoto konektoru můžete extrahovat metadata šablony, vygenerovat jeden dokument, spustit hromadné generování dokumentů, zkontrolovat stav hromadné úlohy, stáhnout vygenerované výsledky a zobrazit informace o předplatném nebo využití.
Ověřování se provádí s předaným klíčem rozhraní API.
Vygenerované odkazy hromadného stahování ZIP jsou platné po dobu 24 hodin.
Tento konektor je dostupný v následujících produktech a oblastech:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Všechny oblasti Power Automate kromě následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Logické aplikace | Standard | Všechny oblasti Logic Apps s výjimkou následujících: – Azure Government oblastí – Azure oblasti Čína - Ministerstvo obrany USA (DoD) |
| Power Apps | Premium | Všechny oblasti Power Apps s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Automatizace napájení | Premium | Všechny oblasti Power Automate kromě následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Contact | |
|---|---|
| Name | Podpora templioniX |
| URL | https://templionix.com |
| support@templionix.com |
| Metadata konektoru | |
|---|---|
| Vydavatel | TemplioniX |
| Internetová stránka | https://templionix.com |
| Zásady ochrany osobních údajů | https://templionix.com/privacy-policy |
| Podmínky použití | https://templionix.com/terms-of-use |
| Kategorie | Produktivita; Obsah a soubory |
| IconBrandColor | #333A41 |
Konektor TemplioniX
Přehled
TemplioniX je služba generování dokumentů, která pomáhá vytvářet soubory DOCX a PDF z opakovaně použitelných Microsoft Word šablon a strukturovaných dat JSON.
Tento konektor umožňuje uživatelům připojit Microsoft Power Automate, Power Apps, Azure Logic Apps a pracovní postupy Copilot Studio k rozhraní TEMPlioniX API. Uživatelé mohou extrahovat metadata šablon, generovat počáteční datové části JSON, generovat dokumenty, spouštět úlohy hromadné generování dokumentů, kontrolovat stav úlohy, stahovat generované výsledky a načítat dostupné šablony.
Vydavatel
TemplioniX
Zamýšlené produkty Microsoft
- Microsoft Power Automate
Konektor se implementuje jako Microsoft Power Platform vlastní konektor a může být použitelný v jiných prostředích konektorů Microsoft, kde jsou podporované certifikované konektory.
Autentizace
Konektor používá ověřování pomocí klíče rozhraní API. Klíč rozhraní API se předává v x-functions-key hlavičce požadavku.
Aby mohli uživatelé používat tento konektor, musí mít aktivní účet TemplioniX a platný klíč rozhraní API.
Hlavní možnosti
Získání šablon
Načte stránkovaný seznam dostupných šablon dokumentů z templioniX. Tuto operaci lze použít k výběru šablony před generováním metadat, počátečního modelu, jednoho dokumentu nebo úlohy hromadného generování dokumentů.
Extrahování polí šablony a zástupných symbolů
Extrahuje metadata z vybrané šablony, včetně polí šablony a zástupných symbolů. To pomáhá uživatelům pochopit, jaká data šablona očekává.
Vygenerování úvodní datové části JSON pro šablonu
Vygeneruje ukázkovou datovou část JSON na základě vybrané šablony. Tuto datovou část můžou uživatelé použít jako výchozí bod pro mapování dat z jiných systémů do žádosti o generování dokumentů.
Vygenerování dokumentu
Vygeneruje dokument DOCX nebo PDF z vybrané šablony a vstupní data JSON.
Hromadné generování dokumentů
Spustí úlohu hromadného generování dokumentů pomocí vybrané šablony a více vstupních záznamů. Vygenerované odkazy hromadného stahování ZIP jsou platné po dobu 24 hodin.
Získání stavu úlohy hromadného generování
Načte informace o stavu a výsledku pro určitou úlohu generování hromadného dokumentu.
Získání úloh hromadného generování podle šablony
Načte úlohy hromadného generování přidružené k vybrané šabloně.
Běžné scénáře použití
- Generování kontraktů, faktur, návrhů, sestav, dopisů a dalších obchodních dokumentů ze strukturovaných dat
- Automatizujte vytváření dokumentů ze systémů CRM, ERP, forms, Excel, SharePoint, Dataverse, SQL nebo API.
- Vytvoření jednotlivých dokumentů na vyžádání z pracovního postupu
- Vygenerujte více dokumentů hromadně a načtěte vygenerovaný výsledek ZIP.
- Pomocí extrahovaných metadat šablon můžete zjistit, která pole jsou potřebná pro generování dokumentu.
Ukázkový pracovní postup
- Ručně nebo z obchodní události aktivujte tok.
- Pomocí operace Získat šablony vyberte šablonu.
- K pochopení očekávané datové struktury použijte operaci Vygenerovat počáteční datovou část JSON.
- Mapujte zdrojová systémová data do vygenerované struktury JSON.
- K vytvoření souboru DOCX nebo PDF použijte operaci Vygenerovat dokument.
- Uložte vygenerovaný soubor do OneDrive, SharePoint, Dataverse, e-mailu nebo jiného cíle.
Support
Informace o produktech, dokumentaci a podporu najdete tady:
- Internetová stránka: https://templionix.com
- Dokumentace: https://docs.templionix.com
- Podpora: https://templionix.com/contact
- Zásady ochrany osobních údajů: https://templionix.com/privacy-policy
- Podmínky použití: https://templionix.com/terms-of-use
Poznámky ke kontrole certifikace
Tento balíček obsahuje řešení konektoru TemplioniX a ukázkové řešení toku, které demonstruje operace konektoru. Konektor komunikuje s produkčním rozhraním API TemplioniX a prostřednictvím hlavičky x-functions-key používá ověřování pomocí klíče rozhraní API.
Vytvoření připojení
Konektor podporuje následující typy ověřování:
| Default | Parametry pro vytvoření připojení | Všechny oblasti | Nesdílitelné |
Výchozí
Použitelné: Všechny oblasti
Parametry pro vytvoření připojení
Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.
| Name | Typ | Description | Povinné |
|---|---|---|---|
| Klíč rozhraní API TemplioniX | securestring | Klíč rozhraní API TemplioniX pro toto rozhraní API | True |
Limity omezování
| Name | Volání | Období obnovení |
|---|---|---|
| Volání rozhraní API na připojení | 100 | 60 sekund |
Akce
| Extrahování polí šablony a zástupných symbolů |
Přečte vybranou šablonu a vrátí ovládací prvky obsahu zjištěné v dokumentu, včetně jejich názvu, značky, typu a předdefinovaných hodnot, pokud jsou k dispozici. |
| Spuštění hromadného generování dokumentů |
Spusťte hromadnou úlohu pro generování dokumentů ze sdílené šablony, sestavte soubor ZIP s adresou URL SAS pro čtení a sleduje průběh. Vrátí ID úlohy okamžitě. Vrácená adresa URL pro stažení souboru ZIP je k dispozici po dokončení úlohy a je platná po dobu 24 hodin od generování. |
| Vygenerování dokumentu z dat šablony |
Sloučí zadanou datovou část JSON s vybranou šablonou a vrátí vygenerovaný dokument. Slouží |
| Vygenerování úvodní datové části JSON pro šablonu |
Vytvoří ukázkovou strukturu JSON, která odpovídá zástupným symbolům zjištěným ve vybrané šabloně, aby ji bylo možné znovu použít jako vstup pro generování dokumentů. |
| Výpis dostupných šablon |
Vrátí stránkovaný seznam šablon, které lze použít s extrakcí metadat, generováním modelů a koncovými body generování dokumentů. |
| Výpis úloh hromadného generování pro šablonu |
Vrátí všechny úlohy pro oddíl hromadného generování, kde templateId odpovídá; stejný obrazec datové části jako stav jedné úlohy seřazený sestupně podle počátečního času |
| Získání stavu úlohy hromadného generování |
Načte stav úlohy podle ID: stav, čas zahájení/ukončení, adresa URL SAS ZIP po dokončení, chyba orchestrace při selhání a parsovaná selhání generování jednotlivých položek. |
Extrahování polí šablony a zástupných symbolů
Přečte vybranou šablonu a vrátí ovládací prvky obsahu zjištěné v dokumentu, včetně jejich názvu, značky, typu a předdefinovaných hodnot, pokud jsou k dispozici.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Identifikátor šablony
|
templateId | True | uuid |
Jedinečný identifikátor šablony vrácený katalogem šablon |
Návraty
- response
- array of contentControlInfoDto
Spuštění hromadného generování dokumentů
Spusťte hromadnou úlohu pro generování dokumentů ze sdílené šablony, sestavte soubor ZIP s adresou URL SAS pro čtení a sleduje průběh. Vrátí ID úlohy okamžitě. Vrácená adresa URL pro stažení souboru ZIP je k dispozici po dokončení úlohy a je platná po dobu 24 hodin od generování.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Template
|
templateId | uuid |
Jedinečný identifikátor šablony |
|
|
Format
|
format | string |
Výstupní formát Použití .docx pro dokumenty Word nebo .pdf dokumentů PDF |
|
|
Název souboru
|
fileName | string |
Vygenerovaný nebo požadovaný název souboru |
|
|
items
|
items | object |
Návraty
Odpověď vrácená při přijetí úlohy hromadného generování dokumentu ke zpracování.
Vygenerování dokumentu z dat šablony
Sloučí zadanou datovou část JSON s vybranou šablonou a vrátí vygenerovaný dokument. Slouží .docx k Word výstupu nebo .pdf pro výstup PDF.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Template
|
templateId | uuid |
Jedinečný identifikátor šablony |
|
|
data
|
data | object |
Objekt JSON obsahující hodnoty pro zástupné symboly šablony |
|
|
Název dokumentu
|
documentName | string |
Název vygenerovaného dokumentu bez přípony, pokud vaše rozhraní API nepřijímá rozšíření |
|
|
Format
|
format | string |
Výstupní formát Pro Word dokumenty nebo .pdf dokumentů PDF použijte .docx. |
Návraty
- response
- file
Vygenerování úvodní datové části JSON pro šablonu
Vytvoří ukázkovou strukturu JSON, která odpovídá zástupným symbolům zjištěným ve vybrané šabloně, aby ji bylo možné znovu použít jako vstup pro generování dokumentů.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Identifikátor šablony
|
templateId | True | uuid |
Jedinečný identifikátor šablony vrácený katalogem šablon |
Návraty
- response
- object
Výpis dostupných šablon
Vrátí stránkovaný seznam šablon, které lze použít s extrakcí metadat, generováním modelů a koncovými body generování dokumentů.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Číslo stránky
|
pageNumber | True | integer |
Index stránky založený na 1 závislosti na vrácení |
|
Velikost stránky
|
pageSize | True | integer |
Maximální počet šablon, které se mají vrátit v jedné odpovědi |
Návraty
Stránkovaná odpověď založená na posunu obsahující záznamy šablony
Výpis úloh hromadného generování pro šablonu
Vrátí všechny úlohy pro oddíl hromadného generování, kde templateId odpovídá; stejný obrazec datové části jako stav jedné úlohy seřazený sestupně podle počátečního času
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Identifikátor šablony
|
templateId | True | uuid |
Vrátí se pouze úlohy spuštěné s tímto ID šablony. |
Návraty
- response
- array of bulkGenerationJobStatusDto
Získání stavu úlohy hromadného generování
Načte stav úlohy podle ID: stav, čas zahájení/ukončení, adresa URL SAS ZIP po dokončení, chyba orchestrace při selhání a parsovaná selhání generování jednotlivých položek.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Identifikátor hromadné úlohy
|
jobId | True | string |
ID úlohy vrácené v odpovědi generateDocumentsBulk 202 ( |
Návraty
Informace o stavu a výsledku pro úlohu hromadného generování dokumentů
Definice
bulkGenerationAcceptedDto
Odpověď vrácená při přijetí úlohy hromadného generování dokumentu ke zpracování.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID úlohy
|
jobId | string |
Jedinečný identifikátor úlohy hromadného generování |
|
Spuštěno v
|
startedAt | date-time |
Datum a čas UTC, kdy byla operace spuštěna. |
bulkGenerationFailureItemDto
Informace o jedné neúspěšné položce dokumentu v úloze hromadného generování
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Globální index
|
globalIndex | string |
Index nebo interní identifikátor vygenerované položky, která selhala. |
|
Název souboru
|
fileName | string |
Vygenerovaný nebo požadovaný název souboru |
|
Error
|
error | string |
Chybová zpráva pro neúspěšnou položku |
bulkGenerationJobStatusDto
Informace o stavu a výsledku pro úlohu hromadného generování dokumentů
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID úlohy
|
jobId | string |
Jedinečný identifikátor úlohy hromadného generování |
|
ID šablony
|
templateId | uuid |
Jedinečný identifikátor šablony |
|
Stav
|
status | string |
Aktuální stav úlohy, například: Čeká na vyřízení, Spuštěno, Dokončeno, Selhání nebo Částečně Dokončeno. |
|
Spuštěno v
|
startedAt | date-time |
Datum a čas UTC, kdy byla operace spuštěna. |
|
Koncový čas
|
endTime | date-time |
Datum a čas UTC, kdy se úloha dokončila. |
|
Zip Url
|
zipUrl | string |
Dočasná adresa URL pro stažení vygenerovaného souboru ZIP. Pro hromadné generování je tento odkaz platný po dobu 24 hodin od generování. |
|
Zpráva o chybě
|
errorMessage | string |
Pokud orchestrace selhala, zobrazí se chybová zpráva na úrovni úlohy. |
|
neúspěšné generování
|
failedGenerations | array of bulkGenerationFailureItemDto |
Kolekce neúspěšných položek v úloze hromadného generování |
|
Počet neúspěšných generování
|
failedGenerationCount | integer |
Počet neúspěšných položek v úloze hromadného generování |
categoryDto
Informace o kategoriích šablon
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid |
Jedinečný identifikátor. |
|
name
|
name | string |
Zobrazovaný název. |
contentControlInfoDto
Metadata jednoho Word ovládacího prvku obsahu nebo zástupného symbolu zjištěného v šabloně
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
title
|
title | string |
Název ovládacího prvku obsahu |
|
klíčové slovo
|
tag | string |
Značka ovládacího prvku obsahu použitá jako klíč pole JSON. |
|
typ
|
type | string |
Typ ovládacího prvku obsahu |
pagedResponseOffsetDto_templateInfoDto
Stránkovaná odpověď založená na posunu obsahující záznamy šablony
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
data
|
data | array of templateInfoDto |
Objekt JSON obsahující hodnoty pro zástupné symboly šablony |
|
Číslo stránky
|
pageNumber | integer |
Číslo aktuální stránky. |
|
Velikost stránky
|
pageSize | integer |
Počet záznamů na stránku |
|
Celkový počet záznamů
|
totalRecords | integer |
Celkový počet dostupných záznamů |
|
Total Pages
|
totalPages | integer |
Celkový počet stránek |
templateInfoDto
Položka katalogu šablon vrácená koncovým bodem seznamu šablon
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID
|
id | uuid |
Jedinečný identifikátor. |
|
Name
|
name | string |
Zobrazovaný název. |
|
Description
|
description | string |
Popis čitelný pro člověka. |
|
Vytvořeno dne
|
createdOn | date-time |
Datum a čas UTC, kdy byla šablona vytvořena. |
|
Poslední změna
|
lastModified | date-time |
Datum a čas UTC, kdy byla šablona naposledy změněna. |
|
categories
|
categories | array of categoryDto |
Kategorie šablon |
soubor
Toto je základní datový typ "file".
objekt
Toto je typ "object".