General
Change an IDP template's name, description and state, export it as JSON and import an exported JSON over it.
General
The General section of the template settings holds the template's identity and the JSON export and import. Changes are saved automatically, as in the builder. Only workspace developers and administrators can change them.
Identity and state
| Field | Description |
|---|---|
| Name | Up to 80 characters. Shows in the files tree, the editor tab and every screen of the template. |
| Description | Up to 500 characters. Helps your colleagues understand what the template is for. |
| Template active | Turns the template on or off. When off, the template's other tabs show the Template disabled notice, with an Activate template shortcut that brings you back to this section. |
Export and import
Use the export to move the template to another workspace or keep a copy, and the import to bring that copy back.
Export JSON
Export JSON downloads the idp-template-<id>.json file with the template's current configuration: name, description, reference document, the full pipeline, validations and default model. Published versions, evaluation sets and runs are not included in the file.
To create a new template from the file, use Import a file when creating the template. See Creating a template.
The exported file may contain credentials used by API validations, such as authentication headers. Treat it as sensitive data.
Import JSON
Import JSON replaces this template's content with the content of an exported file: name, description, sample document, pipeline steps, validations and default model. A file that is not an IDP template export is rejected.
- Click Import JSON and choose the file.
- The Replace this IDP template? dialog checks whether the connections used in the file exist in this workspace and shows which stages use each one: Default model, Identification, Extraction (LLM OCR) and Post-processing. For each missing connection, choose a connection from this workspace to replace it.
- Click Replace.
As when creating, you can import without resolving everything: connections that don't belong to this workspace are removed and must be chosen later in the editor. The sample document is copied if you can access the source template; otherwise, upload one in the Document stage. See Document and pages.
The import swaps the draft. Published versions don't change, and the active version keeps answering in production until you publish a new one. So you can get back to the draft's current state, the dialog offers two shortcuts before replacing:
- Export current version — downloads the template's JSON as it is now;
- Create new version — takes you to the Versions tab, to publish the current draft first. See Versions.