Generation Process

Creating a Generation

After defining your blueprints, initiate a generation to compile them into your custom client. The generation process transforms your blueprint definitions into a production-ready application with full type safety and validation.

Starting a Generation

To create a new generation:

  1. Click on the Manage Versions button at the bottom of the side panel. Screenshot showing the Manage Versions button
  2. Click "Create Generation" on the top right of the modal. Screenshot showing the Create Generation button
  3. Enter a description for this generation (helps track changes) Screenshot showing the create generation interface
  4. Click Save to begin the process
Use descriptive generation notes to maintain a clear change history. Examples: "Added user preferences section" or "Updated product catalog structure with new taxonomy."

Generation Flow

After saving, your new generation appears in the versions list. At this point the generation will be sent to the Dogen service to Generate, Compile, and Deploy. After its deployed you'll be able to perform the following actions:

Promote to Published

Makes this generation the live version of your client.

Demote to Unpublished

Removes this generation from live status, useful if you need to revert to a previous version.

Load Client Version

Loads this generation's client version for preview. This means in a pinch you could load an older client version. This may be useful to test changes.

When utilizing an out of date client, the schemas and validations may be out of date. This could lead to data loss and unexpected behavior upon saving entities. Always ensure you perform this action with caution.

Access Generation

Access the underlying Generation entity with all its details.

Modifying generation entities directly is not recommended. This could lead to unexpected behavior.

Restore Blueprints

Revert ALL your blueprints to the state they were in when this generation was created. This may take some time.

Version Indicators

At the top right of some generations you may see indicators:

Screenshot showing the version indicators
  • Your Version - Shows which generation version your browser is currently using
  • Latest Published - Indicates this generation is the latest published version

Publishing Process

To publish a new version:

  1. After creating a new generation, wait for the status to be listed as deployed. Once its deployed you will see the "Load Client Version" action button.
  2. Click the "Load Client Version" button.
  3. Preview and test the changes to make sure they suit your needs
  4. If satisfied, click the Promote button to promote to published status. Alternatively, you can click the Demote button to demote to unpublished status.

Configure Your Client →

Learn how to customize your generated client's behavior.

Troubleshooting →

Find solutions to common generation issues.