TemplioniX (förhandsversion)

TemplioniX är ett API för dokumentgenerering för att skapa DOCX- och PDF-filer från återanvändbara Word mallar. Använd den här anslutningsappen för att extrahera mallmetadata, generera ett enda dokument, köra massdokumentgenerering, kontrollera massjobbstatus, ladda ned genererade resultat och visa prenumerations- eller användningsinformation.

Autentiseringen utförs med en API-nyckel som skickas.

Genererade zip-nedladdningslänkar för massinhämtning är giltiga i 24 timmar.

Den här anslutningsappen är tillgänglig i följande produkter och regioner:

Service Class Regions
Copilot Studio Premium Alla Power Automate regioner förutom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Logiska appar Standard Alla Logic Apps-regioner utom följande:
     - Azure Government regioner
     - Azure kinaregioner
     - US Department of Defense (DoD)
Power Apps Premium Alla Power Apps regioner förutom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alla Power Automate regioner förutom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Contact
Name Stöd för TemplioniX
URL https://templionix.com
E-postmeddelande support@templionix.com
Metadata för anslutningsprogram
Publisher TemplioniX
Webbplats https://templionix.com
Sekretesspolicy https://templionix.com/privacy-policy
Användningsvillkor https://templionix.com/terms-of-use
Kategorier Produktivitet; Innehåll och filer
IconBrandColor #333A41

TemplioniX-anslutningsprogram

Overview

TemplioniX är en dokumentgenereringstjänst som hjälper dig att skapa DOCX- och PDF-filer från återanvändbara Microsoft Word mallar och strukturerade JSON-data.

Med den här anslutningsappen kan användare ansluta Microsoft Power Automate, Power Apps, Azure Logic Apps och Copilot Studio arbetsflöden till TemplioniX-API:et. Användare kan extrahera mallmetadata, generera start-JSON-nyttolaster, generera dokument, köra massdokumentgenereringsjobb, kontrollera jobbstatus, ladda ned genererade resultat och hämta tillgängliga mallar.

Publisher

TemplioniX

Avsedda Microsoft produkter

  • Microsoft Power Automate - Automatiseringsverktyg från Microsoft

Anslutningsappen implementeras som en Microsoft Power Platform anpassad anslutningsapp och kan användas i andra Microsoft anslutningsfunktioner där certifierade anslutningsappar stöds.

Authentication

Anslutningsappen använder API-nyckelautentisering. API-nyckeln skickas i begärandehuvudet x-functions-key .

Användarna måste ha ett aktivt TemplioniX-konto och en giltig API-nyckel för att kunna använda den här anslutningsappen.

Huvudfunktioner

Hämta mallar

Hämtar en sidnumrerad lista över tillgängliga dokumentmallar från TemplioniX. Den här åtgärden kan användas för att välja en mall innan du genererar metadata, en startmodell, ett enskilt dokument eller ett massdokumentgenereringsjobb.

Extrahera mallfält och platshållare

Extraherar metadata från en vald mall, inklusive mallfält och platshållare. Detta hjälper användarna att förstå vilka data som förväntas av mallen.

Generera en start-JSON-nyttolast för en mall

Genererar en JSON-exempelnyttolast baserat på den valda mallen. Användare kan använda den här nyttolasten som utgångspunkt för att mappa data från andra system till en begäran om dokumentgenerering.

Generera ett dokument

Genererar ett DOCX- eller PDF-dokument från en vald mall och matar in JSON-data.

Generera dokument i grupp

Startar ett massdokumentgenereringsjobb med hjälp av en vald mall och flera indataposter. Genererade zip-nedladdningslänkar för massinhämtning är giltiga i 24 timmar.

Hämta status för massgenereringsjobb

Hämtar status- och resultatinformationen för ett specifikt massdokumentgenereringsjobb.

Hämta massgenereringsjobb efter mall

Hämtar massgenereringsjobb som är associerade med en vald mall.

Vanliga användningsscenarier

  • Generera kontrakt, fakturor, förslag, rapporter, brev och andra affärsdokument från strukturerade data.
  • Automatisera skapande av dokument från CRM-, ERP-, formulär-, Excel-, SharePoint-, Dataverse-, SQL- eller API-baserade system.
  • Skapa enskilda dokument på begäran från ett arbetsflöde.
  • Generera flera dokument i bulk och hämta det genererade ZIP-resultatet.
  • Använd extraherade mallmetadata för att förstå vilka fält som krävs för dokumentgenerering.

Exempelarbetsflöde

  1. Utlös ett flöde manuellt eller från en affärshändelse.
  2. Använd åtgärden Hämta mallar för att välja en mall.
  3. Använd åtgärden Generera en start-JSON-nyttolast för att förstå den förväntade datastrukturen.
  4. Mappa källsystemdata till den genererade JSON-strukturen.
  5. Använd åtgärden Generera ett dokument för att skapa en DOCX- eller PDF-fil.
  6. Spara den genererade filen i OneDrive, SharePoint, Dataverse, e-post eller något annat mål.

Stöd

Produktinformation, dokumentation och support finns på:

Anteckningar för certifieringsgranskning

Det här paketet innehåller templioniX-anslutningslösningen och en exempelflödeslösning som demonstrerar anslutningsåtgärderna. Anslutningsappen kommunicerar med produktions-TemplioniX-API:et och använder API-nyckelautentisering via x-functions-key huvudet.

Skapa en anslutning

Anslutningsappen stöder följande autentiseringstyper:
Standardinställning Parametrar för att skapa anslutning. Alla regioner Går inte att dela

Standard

Tillämpligt: Alla regioner

Parametrar för att skapa anslutning.

Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.

Name Type Description Obligatoriskt
TemplioniX API-nyckel securestring TemplioniX API-nyckeln för det här API:et True

Begränsningsgränser

Name Anrop Förnyelseperiod
API-anrop per anslutning 100 60 sekunder

Åtgärder

Extrahera mallfält och platshållare

Läser den valda mallen och returnerar de innehållskontroller som identifieras i dokumentet, inklusive deras rubrik, tagg, typ och fördefinierade värden när de är tillgängliga.
Generera en start-JSON-nyttolast för en mall

Skapar en JSON-exempelstruktur som matchar platshållarna som identifieras i den valda mallen så att den kan återanvändas som indata för dokumentgenerering
Generera ett dokument från malldata

Sammanfogar den angivna JSON-nyttolasten med den valda mallen och returnerar det genererade dokumentet. Använd .docx för Word utdata eller .pdf för PDF-utdata
Hämta status för massgenereringsjobb

Läser in status för jobbet efter ID: status, start-/sluttider, ZIP SAS-URL när det har slutförts, orkestreringsfel när det misslyckades och parsade generationsfel per objekt.
Lista massgenereringsjobb för en mall

Returnerar alla jobb för massgenereringspartitionen där TemplateId matchar; samma nyttolastform som status för ett enskilt jobb, sorterat efter fallande starttid
Lista tillgängliga mallar

Returnerar en sidnumrerad lista med mallar som kan användas med metadataextrahering, modellgenerering och slutpunkter för dokumentgenerering
Starta massdokumentgenerering

Starta massjobbet för att generera dokument från en delad mall, skapar en ZIP med en läs-SAS-URL och spårar förloppet. Returnerar jobb-ID omedelbart. Den returnerade ZIP-nedladdnings-URL:en är tillgänglig när jobbet har slutförts och är giltigt i 24 timmar från generationstid.

Extrahera mallfält och platshållare

Åtgärds-ID:
GenerateTemplateMetadata

Läser den valda mallen och returnerar de innehållskontroller som identifieras i dokumentet, inklusive deras rubrik, tagg, typ och fördefinierade värden när de är tillgängliga.

Parametrar

Name Nyckel Obligatorisk Typ Description
Mallidentifierare
 templateId True uuid

Unik mallidentifierare som returneras av mallkatalogen

Returer

response
array of contentControlInfoDto

Generera en start-JSON-nyttolast för en mall

Åtgärds-ID:
GenerateModel

Skapar en JSON-exempelstruktur som matchar platshållarna som identifieras i den valda mallen så att den kan återanvändas som indata för dokumentgenerering

Parametrar

Name Nyckel Obligatorisk Typ Description
Mallidentifierare
 templateId True uuid

Unik mallidentifierare som returneras av mallkatalogen

Returer

response
object

Generera ett dokument från malldata

Åtgärds-ID:
GenerateDocument

Sammanfogar den angivna JSON-nyttolasten med den valda mallen och returnerar det genererade dokumentet. Använd .docx för Word utdata eller .pdf för PDF-utdata

Parametrar

Name Nyckel Obligatorisk Typ Description
Template
 templateId uuid

Unik mallidentifierare
data
 data object

JSON-objekt som innehåller värden för mallplatshållare.
Dokumentnamn
 documentName string

Namnet på det genererade dokumentet utan tillägg, såvida inte ditt API accepterar ett tillägg
Format
 format string

Utdataformat. Använd .docx för Word dokument eller .pdf för PDF-dokument.

Returer

response
file

Hämta status för massgenereringsjobb

Åtgärds-ID:
GetBulkGenerationJobStatus

Läser in status för jobbet efter ID: status, start-/sluttider, ZIP SAS-URL när det har slutförts, orkestreringsfel när det misslyckades och parsade generationsfel per objekt.

Parametrar

Name Nyckel Obligatorisk Typ Description
Massjobbsidentifierare
 jobId True string

Jobb-ID som returneras i generateDocumentsBulk 202-svaret (jobId)

Returer

Status- och resultatinformation för ett massdokumentgenereringsjobb.

Body
bulkGenerationJobStatusDto

Lista massgenereringsjobb för en mall

Åtgärds-ID:
GetBulkGenerationJobsByTemplateId

Returnerar alla jobb för massgenereringspartitionen där TemplateId matchar; samma nyttolastform som status för ett enskilt jobb, sorterat efter fallande starttid

Parametrar

Name Nyckel Obligatorisk Typ Description
Mallidentifierare
 templateId True uuid

Endast jobb som startats med det här mall-ID:t returneras

Returer

response
array of bulkGenerationJobStatusDto

Lista tillgängliga mallar

Åtgärds-ID:
GetTemplates

Returnerar en sidnumrerad lista med mallar som kan användas med metadataextrahering, modellgenerering och slutpunkter för dokumentgenerering

Parametrar

Name Nyckel Obligatorisk Typ Description
Sidans nummer
 pageNumber True integer

1-baserat sidindex som ska returneras
Sidstorlek
 pageSize True integer

Maximalt antal mallar som ska returneras i ett enda svar

Returer

Förskjutet sidsvar som innehåller mallposter.

Body
pagedResponseOffsetDto_templateInfoDto

Starta massdokumentgenerering

Åtgärds-ID:
GenerateDocumentsBulk

Starta massjobbet för att generera dokument från en delad mall, skapar en ZIP med en läs-SAS-URL och spårar förloppet. Returnerar jobb-ID omedelbart. Den returnerade ZIP-nedladdnings-URL:en är tillgänglig när jobbet har slutförts och är giltigt i 24 timmar från generationstid.

Parametrar

Name Nyckel Obligatorisk Typ Description
Template
 templateId uuid

Unik mallidentifierare
Format
 format string

Utdataformat. Använd .docx för Word dokument eller .pdf för PDF-dokument
Filnamn
 fileName string

Genererat eller begärt filnamn
items
 items object

Returer

Svaret returnerades när ett massdokumentgenereringsjobb har godkänts för bearbetning.

Body
bulkGenerationAcceptedDto

Definitioner

bulkGenerationAcceptedDto

Svaret returnerades när ett massdokumentgenereringsjobb har godkänts för bearbetning.

Name Sökväg Typ Description
Jobb-ID
 jobId string

Unikt massgenereringsjobbidentifierare.
Starttid
 startedAt date-time

UTC-datum och tid när åtgärden startade.

bulkGenerationFailureItemDto

Information om ett misslyckat dokumentobjekt i ett massgenereringsjobb.

Name Sökväg Typ Description
Globalt index
 globalIndex string

Index eller intern identifierare för det misslyckade genererade objektet.
Filnamn
 fileName string

Genererat eller begärt filnamn.
Error
 error string

Felmeddelande för det misslyckade objektet.

bulkGenerationJobStatusDto

Status- och resultatinformation för ett massdokumentgenereringsjobb.

Name Sökväg Typ Description
Jobb-ID
 jobId string

Unikt massgenereringsjobbidentifierare.
Mall-id
 templateId uuid

Unik mallidentifierare.
Status
 status string

Aktuell jobbstatus, till exempel: Väntar, Körs, Slutförd, Misslyckad eller Delvis Slutförd.
Starttid
 startedAt date-time

UTC-datum och tid när åtgärden startade.
Avslutningstid
 endTime date-time

UTC-datum och tid när jobbet har slutförts.
Zip-URL
 zipUrl string

Tillfällig nedladdnings-URL för den genererade ZIP-filen. För massgenerering är den här länken giltig i 24 timmar från generationstid.
Felmeddelande
 errorMessage string

Felmeddelande på jobbnivå om orkestreringen misslyckades.
failedGenerations
 failedGenerations array of bulkGenerationFailureItemDto

Samling misslyckade objekt i ett massgenereringsjobb.
Antal misslyckade genereringar
 failedGenerationCount integer

Antal misslyckade objekt i ett massgenereringsjobb.

categoryDto

Information om mallkategori.

Name Sökväg Typ Description
id
 id uuid

Unik identifierare.
name
 name string

Visningsnamn

contentControlInfoDto

Metadata för en Word innehållskontroll eller platshållare som identifieras i en mall.

Name Sökväg Typ Description
titel
 title string

Rubrik för innehållskontroll.
tag
 tag string

Innehållskontrolltagg som används som en JSON-fältnyckel.
type
 type string

Innehållskontrolltyp.

pagedResponseOffsetDto_templateInfoDto

Förskjutet sidsvar som innehåller mallposter.

Name Sökväg Typ Description
data
 data array of templateInfoDto

JSON-objekt som innehåller värden för mallplatshållare.
Sidnummer
 pageNumber integer

Aktuellt sidnummer.
Sidstorlek
 pageSize integer

Antal poster per sida.
Totalt antal poster
 totalRecords integer

Totalt antal tillgängliga poster.
Totalt antal sidor
 totalPages integer

Totalt antal sidor.

templateInfoDto

Mallkatalogobjekt som returneras av malllistans slutpunkt.

Name Sökväg Typ Description
ID
 id uuid

Unik identifierare.
Name
 name string

Visningsnamn
Description
 description string

Beskrivning som kan läsas av människor.
Skapad på
 createdOn date-time

UTC-datum och tid när mallen skapades.
Senast ändrad
 lastModified date-time

UTC-datum och tid då mallen senast ändrades.
categories
 categories array of categoryDto

Mallkategorier.

fil

Det här är den grundläggande datatypen "fil".

object

Detta är typen 'objekt'.