Templates¶

Overview¶

The Templates feature in Yappes lets you create and reuse YAML configurations for orchestration workflows. Templates standardize multi-step flow definitions across your organisation so teams can start from proven patterns instead of authoring every flow from scratch.

This capability allows organizations to:

Save orchestration step definitions as reusable templates.
Load templates into the orchestration flow designer.
Manage templates centrally from Bridge → Templates.
Share Custom and System templates across the platform.

Why This Matters¶

Reduce time to create new orchestration flows.
Enforce consistent step patterns across APIs and teams.
Avoid duplicating YAML for common integration scenarios.
Separate reusable flow logic from endpoint-specific orchestration policies.

Scope¶

Orchestration workflow templates (orchestration-workflow type).
Create, view, edit, and delete templates from Bridge → Templates.
Save and load templates from the orchestration flow designer.
Search and filter templates by name and source.

Outcome¶

Faster orchestration authoring.
Standardized workflow definitions.
Centralised template governance.

When to Use Templates¶

Use templates when:

Multiple orchestration flows share the same step structure.
You want a starting point for common patterns (sequential chains, parallel fan-out).
Teams need organisation-wide reusable flow snippets.
You have validated YAML steps worth preserving independently of a live policy.

When Not to Use Templates¶

Do not rely on templates when:

The flow is unique to a single endpoint and will not be reused.
You need to version a live orchestration policy — use orchestration policy naming and the flow designer instead.
You only need format conversion — use Transformation Workflow instead.

For attaching templates to endpoints and running flows, see API Orchestration.

Prerequisites¶

Required Access and Permissions¶

Users must have:

API Manager access.
Permission to create and manage orchestration workflows.
Permission to access Bridge → Templates.

System / Technical Requirements¶

Browser access to Yappes API Manager.
Valid orchestration YAML for template content (same validation rules as the flow designer).

Template Features¶

Under Bridge → Templates, you can:

Create Template: Define a new orchestration workflow template with name, description, and YAML.
Search Template: Search templates by name.
Filter by Source: Filter by All Types, Custom, or System.
View Template: Open a template in read-only mode.
Edit Template: Update name, description, or YAML configuration.
Delete Template: Permanently remove a template.

The templates list displays: Template Name, Type, Source, View, Edit, and Delete.

YAML Configuration¶

Template YAML uses the same validation rules as the orchestration flow designer. A valid template contains a steps array:

steps:
  - id: step1
    type: sequential
    target:
      kind: external
      url: https://api.example.com/resource
      method: GET
    dependsOn: []

  - id: parallelGroup
    type: parallel
    dependsOn:
      - step1
    children:
      - id: step2a
        type: sequential
        target:
          kind: external
          url: https://api.example.com/a
          method: GET
      - id: step2b
        type: sequential
        target:
          kind: external
          url: https://api.example.com/b
          method: GET

Rule	Requirement
`steps`	Non-empty array when saving from the flow designer.
Each step	Must have `id` and `type`.
`sequential`	`target.kind` must be `external` with `url` and `method`.
`parallel`	Non-empty `children` array.
`dependsOn`	Lists step IDs for execution order.

When creating a template from Bridge → Templates, provide the full YAML configuration in the editor. When saving from the flow designer, only the steps section is stored.

Step-by-Step Implementation¶

Method 1: Creating a Template from Bridge → Templates¶

Step 1: Navigate to Templates¶

From the left navigation panel, open Bridge.
Select Templates.

Step 2: Create Template¶

Select Create Template.
The template creation dialog will open.

Step 3: Define Template Details¶

Field	Required	Description
Template name	Yes	Unique name for the template.
Template type	Yes	Orchestration Workflow (`orchestration-workflow`) — fixed for new templates.
Description	No	Purpose of the template (max 500 characters).

Step 4: Configure YAML¶

Define the orchestration steps in the YAML Configuration editor.
Fix any validation errors shown in the editor.

Refer to the YAML Configuration section for supported step types and validation rules.

Step 5: Save Template¶

Review the template name, description, and YAML.
Select Save Template.

Success

The template is successfully created and appears in the templates list.

Method 2: Saving a Template from the Orchestration Flow Designer¶

Use this method when you have already built steps in an orchestration policy and want to save them as a reusable template.

Step 1: Navigate to the Flow Designer¶

From the left navigation panel, open Bridge.
Select Orchestration.
Open an orchestration flow in Edit mode.

Step 2: Build or Refine Steps¶

In the Orchestration Definition panel, define or update your orchestration steps in the YAML editor or flow chart.

Step 3: Save as Template¶

Select Save Template.
Enter a Name of template.
Select Save.

Note

Only the steps block from the current YAML is stored. The orchestration header (orchestration.name, execution, etc.) is not included in the template.

Step 4: Confirm¶

A success notification appears when the template is saved.
The template is available under Custom source in the designer dropdown and on Bridge → Templates.

Success

The template is successfully saved from the orchestration flow designer.

Using a Template in an Orchestration Flow¶

After a template exists, load it into an orchestration policy to reuse its step definitions.

Step 1: Open the Flow Designer¶

Go to Bridge → Orchestration.
Open an orchestration policy in Edit mode.

Step 2: Select a Template¶

In the Templates dropdown within Orchestration Definition, choose a template.
Templates are grouped as Custom templates or System templates.
The selected template YAML is merged into the current orchestration definition.

Step 3: Review the Merged YAML¶

Review the updated YAML in the editor or flow chart.
Adjust step IDs, target.url values, and dependsOn as needed for your use case.

Step 4: Save the Orchestration Policy¶

Select Save on the flow designer to persist the orchestration policy.

Step 5: Attach and Test (Optional)¶

Attach the orchestration policy to an endpoint and save the API.
Test the flow using Test Orchestration or invoke the endpoint in your environment.

For attach, test, and monitoring steps, see API Orchestration.

Managing Templates¶

View a Template¶

On Bridge → Templates, select View on a template row.
Review the template name, type, description, and YAML in read-only mode.
Select Close.

Edit a Template¶

On Bridge → Templates, select Edit on a template row.
Update the template name, description, or YAML configuration.
Select Save Template.

You must change at least one field before saving an update.

Delete a Template¶

On Bridge → Templates, select Delete on a template row.
Review the confirmation details (template name and type).
Select Delete to permanently remove the template.

Deleting a template does not affect orchestration policies that were already created from it.

Understanding the Interface¶

Section	Purpose
Bridge → Templates	Central list and CRUD for orchestration workflow templates.
Orchestration flow designer	Load templates via dropdown; save current `steps` as a template.
Custom source	Templates created by users (designer or Templates page).
System source	Platform-provided templates.

Template Sources¶

Source	Description
Custom	Created by a user via Create Template or Save Template in the flow designer.
System	Provided by the platform as starter patterns.

Use the Source filter on the Templates page to narrow the list.

Best Practices¶

Practice	Reason
Use descriptive template names	Easier search and selection in the designer dropdown.
Save only validated steps	Invalid YAML cannot be saved as a template.
Keep templates focused	One reusable pattern per template (e.g. parallel fetch group).
Update templates deliberately	Editing a template does not retroactively change existing orchestration policies.
Version via naming (e.g. `OrderFetch-v2`)	Clearer change history than overwriting in place.
Load then customise	Adjust URLs, step IDs, and dependencies after loading a template into a policy.

Troubleshooting¶

Issue	Possible Cause	Resolution
Save Template disabled in designer	YAML unchanged or invalid	Modify steps and fix validation errors before saving.
Template already exists	Duplicate `steps` configuration	Use a different name or edit the existing template.
Invalid YAML error	Failed validation	Ensure each step has `id`, `type`, and valid `target` fields.
Cannot save update	No fields changed	Modify at least one field before saving an edit.
Template not in dropdown	Filter or cache	Refresh; check Custom vs System groups in the designer.
Delete fails	Server or permission issue	Retry; confirm you have template management access.

Frequently Asked Questions¶

What template types are supported?
Currently Orchestration Workflow (orchestration-workflow) is the supported template type.

Does loading a template attach it to an endpoint?
No. Templates only seed YAML in the flow designer. Attach the orchestration policy to an endpoint separately — see API Orchestration.

What is the difference between a template and an orchestration policy?
A template is a reusable YAML snippet. An orchestration policy is a gateway policy that can be attached to endpoints and executed.

Can I save the full orchestration header in a template from the designer?
No. Save Template in the designer stores only the steps block. Use Bridge → Templates → Create Template for a full YAML configuration.

Does deleting a template affect running orchestrations?
No. Existing orchestration policies are independent of the templates they were created from.

Pro Tip

Build and test a flow in the orchestration designer, then Save Template to capture the validated steps block. Share it via Bridge → Templates so other teams can load the same pattern into new orchestration policies quickly.