Define Architect flows using YAML

AI-generated summary

Genesys Cloud enables defining Architect flows using YAML through the Archy feature, which addresses use cases where UI-based flow creation is time-consuming or inefficient. This capability is particularly valuable for migrating flows between organizations while preserving queue mappings, data actions, and other configurations that would otherwise require manual remapping. Users can export flows in YAML format via Genesys Cloud scripting, edit them in text editors such as Visual Studio Code, and reimport them into Architect to quickly replicate existing flow configurations across environments without manually duplicating queue mappings, task processes, menu navigation, and other settings. The export process involves selecting the YAML format option and optionally preserving tracking IDs for each action, menu, and task within the flow. Sequence builders are not currently supported during export but are rendered as equivalent expressions that function as expected. This workflow enables efficient flow reuse and cross-organization deployment while maintaining configuration integrity.

Genesys Cloud offers the capability of defining Architect flows using YAML (YAML Ain’t Markup Language). This feature, Archy, allows organizations to cover specific use cases when creating a flow using the UI is awkward and time consuming.

For example, if you move a flow between different test and production orgs, then you lose all mappings to queues, data actions, and more. Make sure that you manually remap these configurations later. With Archy, you define the flow you want to move and then use find-and-replace functionality to update these mappings procedurally and automatically.

Export flows in YAML format

You can use Genesys Cloud scripting to export an Architect flow in YAML format. Next, edit the flow in a text editor such as Visual Studio Code and then use Archy to import the flow back into Architect. After you import the updated flow, you can recreate it in the same Genesys Cloud organization or enable it in a different Genesys Cloud organization. This feature enables you to quickly reuse an existing flow’s configuration rather than creating a new flow and manually duplicating queue mappings, lengthy task processes, menu navigation, and other settings.

Note: Sequence builders are not currently supported when you export a flow in YAML format. During export, the system renders these sequences in the equivalent expressions; however, the expressions function as expected.

Open an existing Architect flow, or create a new one.
Click next to the Save button and from the menu that appears, click Export flow. The Export Flow dialog box appears.
Under Format, select YAML.
(Optional) Select the Include tracking ID details checkbox to preserve the tracking IDs in the exported YAML file. Each action, menu, and task currently included in the flow has a tracking ID. This feature is useful when flow authors want to review, analyze, or quickly access a specific instance of an item in the flow.

Architect exports the flow with the .yaml extension.

For more information about defining Architect flows using Archy for your Genesys Cloud organization, see Archy in the Genesys Cloud Developer Center.

[NEXT] Was this article helpful?

Get user feedback about articles.