Home | License | FAQ | Contact | Smart-API

CodeGen User-Guide

CodeGen Wizard

Last Updated: September 27, 2022

  • CodeGen Wizard: Contains three main sections as shown in the figure below

1- On the left side (Steps section) ⇒ you can know at which step you are in.
2- On the middle ⇒ will find a container for the technology used in the code process.
3- And On the right side (Description section) ⇒ you can find a description of the step you are in.

home-page
  • Programming Languages and platforms Step: This step shows a list of programming languages that are supported, and from icons at each language box, you can know what technologies are supported in each language as shown in the figure below.

codegen-icon
  • Technologies Stacks Step: Depending on the programming language that has been selected, this page shows a list of technologies stacks that are supported by the selected language, and you can choose any of them to generate your code.

technologies-stacks
  • Transformers (Layers) Step: Depending on the technology stack of a specific language that has been selected, This step shows a list of transformers (Layers) that are supported, and you can choose any of them to generate your code.

transformers-layers-step
Clicking on the "Next" and "Previous" button ⇒ make you able to move forward and backward in steps of generating the code process.
  • Metadata Step: Depending on the transformer (layer) of the technology stack of the specific language that has been selected, this step shows Metadata that provides four main options:

    1. Add field button: As shown in the figure below ⇒ add fields that you want to present in code or preview.

add-field-button
  • After adding fields, you can for each field change: Name, Data type, Required or not, Advanced, Reorder, Delete.

after-adding-fields
"Clear" button: will delete all fields in Metadata.
By clicking on the "Advanced" button from the field row this dialog will appear to ⇒ make you able to add details or any relations of the selected field.
details
relations

2.Choose from Template button: As shown in the figure below, you can Click on the "Choose from Template" button ⇒ which presents a group of the the most common templates that are supported to suggest and save your time and effort with the ability to add or edit each field as mentioned above.

choose-from-template-button
  • After clicking "Choose from Template" button: This dialog appears then, you can choose any template of them.

after-clicking-choose-from-template-button

3.Advanced button: As shown in the figure below, clicking on "Advanced" button ⇒ makes you able to add more details and properties to your class.

advanced-button
  • After clicking "Advanced" button: This dialog appears then, you can enter any general details or properties.

advanced-general
advanced-porperties

4.Import/Export button: As shown in the figure below, clicking on The "Import/Export" button ⇒ converts metadata and what it contains to YML.

import-export-button
  • After clicking on "Import/Export": as shown in the figure below, you can "Copy To Clipboard" ⇒ apply your YML to metadata, "import YML" ⇒ import your YML as backup, or "Cancel" ⇒ canceling changes on YML.

after-clicking-on-import-export
  • Finally, Generate Code button: After adding at least one field and doing your changes, you can "Generate Code" as shown in the figure below.

finally-generate-code-button
  • Generated Code Step: This page shows code in (Code tab) that has been generated depending on metadata of specific language technology and layer that has been selected, and (Preview tab) shows the view of the code with your ability to: "Copy", "Download Code", and "Download as full project" as shown in the figure below.

CodeGen
If you choose view transformer (layer) then, "Preview" tab will be shown and if not it will not be shown.


Home | License | FAQ | Contact | Smart-API