TemplioniX (Vorschau)
TemplioniX ist eine Dokumentgenerierungs-API zum Erstellen von DOCX- und PDF-Dateien aus wiederverwendbaren Word Vorlagen. Verwenden Sie diesen Connector, um Vorlagenmetadaten zu extrahieren, ein einzelnes Dokument zu generieren, die Massendokumentgenerierung auszuführen, den Massenauftragsstatus zu überprüfen, generierte Ergebnisse herunterzuladen und Abonnement- oder Nutzungsinformationen anzuzeigen.
Die Authentifizierung wird mit einem übergebenen API-Schlüssel ausgeführt.
Generierte ZIP-Downloadlinks sind 24 Stunden gültig.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Standard | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: - Azure Government Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | TemplioniX-Unterstützung |
| URL | https://templionix.com |
| support@templionix.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | TemplioniX |
| Website | https://templionix.com |
| Datenschutzrichtlinie | https://templionix.com/privacy-policy |
| Nutzungsbedingungen | https://templionix.com/terms-of-use |
| Kategorien | Produktivität; Inhalt und Dateien |
| IconBrandColor | #333A41 |
TemplioniX Connector
Overview
TemplioniX ist ein Dienst zur Dokumentgenerierung, mit dem DOCX- und PDF-Dateien aus wiederverwendbaren Microsoft Word Vorlagen und strukturierten JSON-Daten erstellt werden können.
Mit diesem Connector können Benutzer Microsoft Power Automate, Power Apps, Azure Logic Apps und Copilot Studio Workflows mit der TemplioniX-API verbinden. Benutzer können Vorlagenmetadaten extrahieren, Start-JSON-Nutzlasten generieren, Dokumente generieren, Massenaufträge zur Dokumentgenerierung ausführen, Auftragsstatus überprüfen, generierte Ergebnisse herunterladen und verfügbare Vorlagen abrufen.
Herausgeber
TemplioniX
Beabsichtigte Microsoft Produkte
- Microsoft Power Automate
Der Connector wird als Microsoft Power Platform benutzerdefinierter Connector implementiert und kann in anderen Microsoft Connectorumgebungen verwendet werden, bei denen zertifizierte Connectors unterstützt werden.
Authentifizierung
Der Connector verwendet die API-Schlüsselauthentifizierung. Der API-Schlüssel wird im Anforderungsheader x-functions-key übergeben.
Benutzer müssen über ein aktives TemplioniX-Konto und einen gültigen API-Schlüssel verfügen, um diesen Connector zu verwenden.
Hauptfunktionen
Abrufen von Vorlagen
Ruft eine paginierte Liste der verfügbaren Dokumentvorlagen aus TemplioniX ab. Dieser Vorgang kann verwendet werden, um eine Vorlage auszuwählen, bevor Metadaten, ein Startmodell, ein einzelnes Dokument oder ein Auftrag zur Massenerstellung von Dokumenten generiert werden.
Extrahieren von Vorlagenfeldern und Platzhaltern
Extrahiert Metadaten aus einer ausgewählten Vorlage, einschließlich Vorlagenfeldern und Platzhaltern. Dies hilft Benutzern zu verstehen, welche Daten von der Vorlage erwartet werden.
Generieren einer Start-JSON-Nutzlast für eine Vorlage
Generiert eine BEISPIEL-JSON-Nutzlast basierend auf der ausgewählten Vorlage. Benutzer können diese Nutzlast als Ausgangspunkt für die Zuordnung von Daten aus anderen Systemen zu einer Anforderung zur Dokumentgenerierung verwenden.
Generieren eines Dokuments
Generiert ein DOCX- oder PDF-Dokument aus einer ausgewählten Vorlage und Eingabe-JSON-Daten.
Generieren von Dokumenten in Massen
Startet einen Auftrag zur Massenerstellung von Dokumenten mit einer ausgewählten Vorlage und mehreren Eingabedatensätzen. Generierte ZIP-Downloadlinks sind 24 Stunden gültig.
Abrufen des Auftragsstatus der Massengenerierung
Ruft den Status und die Ergebnisinformationen für einen bestimmten Massendokumentgenerierungsauftrag ab.
Abrufen von Massengenerierungsaufträgen nach Vorlage
Ruft Massengenerierungsaufträge ab, die einer ausgewählten Vorlage zugeordnet sind.
Häufige Nutzungsszenarien
- Generieren Sie Verträge, Rechnungen, Vorschläge, Berichte, Briefe und andere Geschäftsdokumente aus strukturierten Daten.
- Automatisieren Sie die Dokumenterstellung aus CRM, ERP, Formularen, Excel, SharePoint, Dataverse, SQL oder API-basierten Systemen.
- Erstellen sie einzelne Dokumente bei Bedarf aus einem Workflow.
- Generieren Sie mehrere Dokumente in Massen, und rufen Sie das generierte ZIP-Ergebnis ab.
- Verwenden Sie extrahierte Vorlagenmetadaten, um zu verstehen, welche Felder für die Dokumentgenerierung erforderlich sind.
Beispielworkflow
- Auslösen eines Ablaufs manuell oder aus einem Geschäftsereignis.
- Verwenden Sie den Vorgang "Vorlagen abrufen", um eine Vorlage auszuwählen.
- Verwenden Sie den Start-JSON-Nutzlastvorgang generieren, um die erwartete Datenstruktur zu verstehen.
- Ordnen Sie Quellsystemdaten der generierten JSON-Struktur zu.
- Verwenden Sie den Vorgang "Dokument generieren", um eine DOCX- oder PDF-Datei zu erstellen.
- Speichern Sie die generierte Datei in OneDrive, SharePoint, Dataverse, E-Mail oder einem anderen Ziel.
Support
Informationen zu Produkten, Dokumentationen und Support finden Sie unter:
- Website: https://templionix.com
- Dokumentation: https://docs.templionix.com
- Unterstützung: https://templionix.com/contact
- Datenschutz: https://templionix.com/privacy-policy
- Nutzungsbedingungen: https://templionix.com/terms-of-use
Hinweise zur Zertifizierungsprüfung
Dieses Paket enthält die TemplioniX-Connectorlösung und eine Beispielflusslösung, die die Verbindervorgänge veranschaulicht. Der Connector kommuniziert mit der Production TemplioniX-API und verwendet die API-Schlüsselauthentifizierung über den x-functions-key Header.
Eine Verbindung wird erstellt
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Type | Description | Erforderlich |
|---|---|---|---|
| TemplioniX-API-Schlüssel | securestring | Der TemplioniX-API-Schlüssel für diese API | True |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abrufen des Auftragsstatus der Massengenerierung |
Lädt den Status des Auftrags nach ID: Status, Start-/Endzeiten, ZIP SAS-URL nach Abschluss, Orchestrierungsfehler beim Fehler und analysiert Fehler bei der Generierung pro Element. |
| Auflisten von Massengenerierungsaufträgen für eine Vorlage |
Gibt alle Aufträge für die Partition der Massengenerierung zurück, auf der TemplateId übereinstimmt; das gleiche Nutzlast-Shape wie der Status eines einzelnen Auftrags, sortiert nach absteigender Startzeit |
| Extrahieren von Vorlagenfeldern und Platzhaltern |
Liest die ausgewählte Vorlage und gibt die im Dokument ermittelten Inhaltssteuerelemente zurück, einschließlich Titel, Tag, Typ und vordefinierter Werte, wenn verfügbar. |
| Generieren einer Start-JSON-Nutzlast für eine Vorlage |
Erstellt eine JSON-Beispielstruktur, die den in der ausgewählten Vorlage ermittelten Platzhaltern entspricht, sodass sie als Eingabe für die Dokumentgenerierung wiederverwendet werden kann. |
| Generieren eines Dokuments aus Vorlagendaten |
Führt die bereitgestellte JSON-Nutzlast mit der ausgewählten Vorlage zusammen und gibt das generierte Dokument zurück. Wird für Word Ausgabe oder |
| Massendokumentgenerierung starten |
Starten Sie den Massenauftrag, um Dokumente aus einer freigegebenen Vorlage zu generieren, erstellt eine ZIP-Datei mit einer LESE-SAS-URL und verfolgt den Fortschritt. Gibt die Auftrags-ID sofort zurück. Die zurückgegebene ZIP-Download-URL steht nach Abschluss des Auftrags zur Verfügung und ist 24 Stunden nach der Generation gültig. |
| Verfügbare Vorlagen auflisten |
Gibt eine paginierte Liste von Vorlagen zurück, die mit Metadatenextraktions-, Modellgenerierungs- und Dokumentgenerierungsendpunkten verwendet werden können. |
Abrufen des Auftragsstatus der Massengenerierung
Lädt den Status des Auftrags nach ID: Status, Start-/Endzeiten, ZIP SAS-URL nach Abschluss, Orchestrierungsfehler beim Fehler und analysiert Fehler bei der Generierung pro Element.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Massenauftragsbezeichner
|
jobId | True | string |
Auftrags-ID, die in der generateDocumentsBulk 202-Antwort zurückgegeben wird ( |
Gibt zurück
Status- und Ergebnisdetails für einen Massenauftrag zur Dokumentgenerierung.
Auflisten von Massengenerierungsaufträgen für eine Vorlage
Gibt alle Aufträge für die Partition der Massengenerierung zurück, auf der TemplateId übereinstimmt; das gleiche Nutzlast-Shape wie der Status eines einzelnen Auftrags, sortiert nach absteigender Startzeit
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vorlagenbezeichner
|
templateId | True | uuid |
Es werden nur Aufträge zurückgegeben, die mit dieser Vorlagen-ID gestartet wurden. |
Gibt zurück
- response
- array of bulkGenerationJobStatusDto
Extrahieren von Vorlagenfeldern und Platzhaltern
Liest die ausgewählte Vorlage und gibt die im Dokument ermittelten Inhaltssteuerelemente zurück, einschließlich Titel, Tag, Typ und vordefinierter Werte, wenn verfügbar.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vorlagenbezeichner
|
templateId | True | uuid |
Vom Vorlagenkatalog zurückgegebener eindeutiger Vorlagenbezeichner |
Gibt zurück
- response
- array of contentControlInfoDto
Generieren einer Start-JSON-Nutzlast für eine Vorlage
Erstellt eine JSON-Beispielstruktur, die den in der ausgewählten Vorlage ermittelten Platzhaltern entspricht, sodass sie als Eingabe für die Dokumentgenerierung wiederverwendet werden kann.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vorlagenbezeichner
|
templateId | True | uuid |
Vom Vorlagenkatalog zurückgegebener eindeutiger Vorlagenbezeichner |
Gibt zurück
- response
- object
Generieren eines Dokuments aus Vorlagendaten
Führt die bereitgestellte JSON-Nutzlast mit der ausgewählten Vorlage zusammen und gibt das generierte Dokument zurück. Wird für Word Ausgabe oder .pdf pdf-Ausgabe verwendet .docx
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Template
|
templateId | uuid |
Eindeutiger Vorlagenbezeichner |
|
|
data
|
data | object |
JSON-Objekt, das Werte für Vorlagenplatzhalter enthält. |
|
|
Dokumentname
|
documentName | string |
Name des generierten Dokuments ohne Erweiterung, es sei denn, Ihre API akzeptiert eine Erweiterung. |
|
|
Format
|
format | string |
Ausgabeformat. Verwenden Sie .docx für Word Dokumente oder .pdf für PDF-Dokumente. |
Gibt zurück
- response
- file
Massendokumentgenerierung starten
Starten Sie den Massenauftrag, um Dokumente aus einer freigegebenen Vorlage zu generieren, erstellt eine ZIP-Datei mit einer LESE-SAS-URL und verfolgt den Fortschritt. Gibt die Auftrags-ID sofort zurück. Die zurückgegebene ZIP-Download-URL steht nach Abschluss des Auftrags zur Verfügung und ist 24 Stunden nach der Generation gültig.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Template
|
templateId | uuid |
Eindeutiger Vorlagenbezeichner |
|
|
Format
|
format | string |
Ausgabeformat. Verwenden von .docx für Word Dokumente oder .pdf für PDF-Dokumente |
|
|
Dateiname
|
fileName | string |
Generierter oder angeforderter Dateiname |
|
|
items
|
items | object |
Gibt zurück
Antwort, die zurückgegeben wird, wenn ein Auftrag zur Massenerstellung von Dokumenten zur Verarbeitung akzeptiert wurde.
Verfügbare Vorlagen auflisten
Gibt eine paginierte Liste von Vorlagen zurück, die mit Metadatenextraktions-, Modellgenerierungs- und Dokumentgenerierungsendpunkten verwendet werden können.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Seitenzahl
|
pageNumber | True | integer |
1-basierter Seitenindex, der zurückgegeben werden soll |
|
Seitengröße
|
pageSize | True | integer |
Maximale Anzahl von Vorlagen, die in einer einzelnen Antwort zurückgegeben werden sollen |
Gibt zurück
Offsetbasierte Seitenantwort mit Vorlagendatensätzen.
Definitionen
bulkGenerationAcceptedDto
Antwort, die zurückgegeben wird, wenn ein Auftrag zur Massenerstellung von Dokumenten zur Verarbeitung akzeptiert wurde.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Auftrags-ID
|
jobId | string |
Eindeutiger Massengenerierungsauftragsbezeichner. |
|
Gestartet am
|
startedAt | date-time |
UTC-Datum und -Uhrzeit, zu der der Vorgang gestartet wurde. |
bulkGenerationFailureItemDto
Informationen zu einem fehlerhaften Dokumentelement in einem Massengenerierungsauftrag.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Globaler Index
|
globalIndex | string |
Index oder interner Bezeichner des fehlgeschlagenen generierten Elements. |
|
Dateiname
|
fileName | string |
Generierter oder angeforderter Dateiname. |
|
Fehler
|
error | string |
Fehlermeldung für das fehlgeschlagene Element. |
bulkGenerationJobStatusDto
Status- und Ergebnisdetails für einen Massenauftrag zur Dokumentgenerierung.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Auftrags-ID
|
jobId | string |
Eindeutiger Massengenerierungsauftragsbezeichner. |
|
Vorlagen-ID
|
templateId | uuid |
Eindeutiger Vorlagenbezeichner. |
|
Status
|
status | string |
Aktueller Auftragsstatus, z. B. "Ausstehend", "Ausführen", "Abgeschlossen", "Fehlgeschlagen" oder "Teilweise Abgeschlossen". |
|
Gestartet am
|
startedAt | date-time |
UTC-Datum und -Uhrzeit, zu der der Vorgang gestartet wurde. |
|
Endzeit
|
endTime | date-time |
UTC-Datum und Uhrzeit, zu der der Auftrag abgeschlossen ist. |
|
ZIP-URL
|
zipUrl | string |
Temporäre Download-URL für die generierte ZIP-Datei. Bei der Massengenerierung ist dieser Link 24 Stunden ab Generationszeit gültig. |
|
Fehlermeldung
|
errorMessage | string |
Fehlermeldung auf Auftragsebene, wenn die Orchestrierung fehlgeschlagen ist. |
|
failedGenerations
|
failedGenerations | array of bulkGenerationFailureItemDto |
Sammlung fehlgeschlagener Elemente innerhalb eines Massengenerierungsauftrags. |
|
Anzahl der fehlgeschlagenen Generierungen
|
failedGenerationCount | integer |
Anzahl der fehlgeschlagenen Elemente innerhalb eines Massengenerierungsauftrags. |
categoryDto
Vorlagenkategorieinformationen.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | uuid |
Eindeutiger Bezeichner. |
|
name
|
name | string |
Anzeigename. |
contentControlInfoDto
Metadaten für ein Word Inhaltssteuerelement oder Platzhalter, der in einer Vorlage ermittelt wurde.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
title
|
title | string |
Titel des Inhaltssteuerelements. |
|
tag
|
tag | string |
Inhaltssteuerelementtag, das als JSON-Feldschlüssel verwendet wird. |
|
type
|
type | string |
Inhaltssteuerelementtyp. |
pagedResponseOffsetDto_templateInfoDto
Offsetbasierte Seitenantwort mit Vorlagendatensätzen.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
data
|
data | array of templateInfoDto |
JSON-Objekt, das Werte für Vorlagenplatzhalter enthält. |
|
Seitennummer
|
pageNumber | integer |
Aktuelle Seitenzahl. |
|
Seitengröße
|
pageSize | integer |
Anzahl der Datensätze pro Seite. |
|
Datensätze insgesamt
|
totalRecords | integer |
Gesamtanzahl der verfügbaren Datensätze. |
|
Seiten insgesamt
|
totalPages | integer |
Gesamtanzahl der Seiten. |
templateInfoDto
Vorlagenkatalogelement, das vom Vorlagenlistenendpunkt zurückgegeben wird.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | uuid |
Eindeutiger Bezeichner. |
|
Name
|
name | string |
Anzeigename. |
|
Description
|
description | string |
Menschenlesbare Beschreibung. |
|
Erstellt am
|
createdOn | date-time |
UTC-Datum und Uhrzeit der Erstellung der Vorlage. |
|
Zuletzt geändert
|
lastModified | date-time |
UTC-Datum und Uhrzeit der letzten Änderung der Vorlage. |
|
categories
|
categories | array of categoryDto |
Vorlagenkategorien. |
file
Dies ist der grundlegende Datentyp "Datei".
object
Dies ist der Typ „Objekt“.