journeys / journey-xml-5Markdown ↓

Getting started

A Journey is a short, ordered process presented as a wizard. Author XML; the server compiles it into the definition the CoCoCo app runs. XML is the editable source of truth. The compiled JSON belongs to the server and is not a second authoring language.

Start with the Journeys resource index, choose New, and edit Journey XML on the standard form page. The preview shows each stage as the CoCoCo app will. Save draft stores source and compiled output. Publish promotes a saved version; previewing or saving alone does not publish it.

<journey id="welcome" title="Welcome" icon="check" estimatedMinutes="2">
  <summary>A short guided process.</summary>
  <info id="intro" title="Before you begin">
    <body>We will collect your name and show a confirmation.</body>
    <check>Have your details ready.</check>
  </info>
  <form id="details" title="Your details">
    <field key="name" label="Name" kind="text" required="true"/>
  </form>
  <done id="done" title="Ready">
    <body>Thank you, {{ $.state.name }}.</body>
  </done>
</journey>

Enter a name, then advance to see it interpolated on the final page. Go back, change the name, and advance again: completion prose reads current state. The body is plain text, not HTML. A name containing markup must display literally.

Use stable, unique step IDs. The journey's root ID becomes its handle; choose it before publication. Keep a done stage last, with no condition, so every branch can finish. A checklist is guidance, not a required acknowledgement control.

Every example in this manual is complete and compiles as shown. The operations examples use illustrative API fields (greeting, records and save) that your instance does not provide; replace them with your own. The final chapter, Before you go live, lists the checks to make on your own Journey.

Published platform manual · revision c5ed82f1d29b