Skip to main content

Generating Code

The final step in using the Codebricks Planner is generating the code for your microservices. This process translates your design and configuration into executable code on your local machine.

Setup the Code Client​

To generate code, follow these steps:

  1. Open the Generator Menu:

    • Click on the ⚙ icon next to the Generate button in the top-left corner of the Codebricks Planner.

    The Codebricks Planner Generate Button greyed out with a wheel icon next to it.

    This action opens the Generator Menu.

  2. Setup Code Client:

    • Click on Setup Code Client in the Generator Menu.

    The Codebricks Planner Generate with selected aggregate red and the Setup Code Client button

    Follow the prompts in the setup dialog to configure your Codebricks Client.

    • Define the Path: Specify the directory where you want the generated code to be saved.
    • Select Aggregates: Choose the aggregate(s) you want to include in the code generation from the dropdown menu.

    The Codebricks Planner Generate with selected aggregate filled and the Setup Code Client button

  3. Generate the Code:

    • Once the setup is complete, the Generate button will be enabled.

    Click the Generate button to start the code generation process.

    Generate Button

    The loading indicator will appear while the code is being generated. Once it disappears, the code will be available on your machine.

note

Ensure that all Use Cases you want to generate are in Ready status. Use Cases that are still in the Planned status will not be included in the code generation. For more information, see Use Case Management.