Zontroy Project

Zontroy Project is used to start code generation from scratch. If you want generate code on your own software architecture, project or component then create an Empty Project and start to generate code over that Zontroy project.

Zontroy just creates a .zproject file in the selected project directory while creating empty project. zproject stands for Zontroy Project and zproject file is used to store entity and generation data. It means that Zontroy doesn't interact with the database except reading information schema of the database.

.zproject file

Knowing the structure of the zproject file is optional, but it's useful to know how Zontroy works in the background.

Name: Name of the Zontroy project given by developer.

DatabaseType: Type of database that stores data in main project. There are 4 database types integrated in Zontroy. Oracle, MySQL, PostgreSQL and MSSQL.

Server: Database server to connect.

DatabaseName: Name of the database that stores data in main project.

ConnectionString: Connection string to connect to the database.

Username: Database username.

Password: Database password.

Language: Programming Language of which source code will be generated.

Port: Database port.

IsIntegratedSecurity: Is database using integrated security or not, true or false.

Entities: List of tables with fields and properties.

The fields and properties are described in detail in the next sections.

Example .zproject file

{
  "Name": "Oprazi",
  "DatabaseType": "MSSQL",
  "Server": ".\\SQLEXPRESS",
  "DatabaseName": "OpraziReact",
  "ConnectionString": "data source=.\\SQLEXPRESS;initial catalog=OpraziReact;user id=sa;password=12345",
  "Username": "sa",
  "Password": "12345",
  "Language": "CSharp",
  "Port": "",
  "IsIntegratedSecurity": false,
  "Entities": [
    {
      "Name": "Bank",
      "Type": 1,
      "TargetName": "Bank",
      "AlternativeName": "",
      "Label": "Bank",
      "RowOrder": 0,
      "Description": "",
      "Extra1": "",
      "Extra2": "",
      "Extra3": "",
      "Extra4": "",
      "Extra5": "",
      "Extra6": "",
      "Extra7": "",
      "Extra8": "",
      "Extra9": "",
      "EntitySchema": {
        "Name": "dbo",
        "User": null,
        "Password": null,
        "TargetName": null,
        "AlternativeName": null,
        "Label": null,
        "RowOrder": null,
        "Description": null,
        "Extra1": null,
        "Extra2": null,
        "Extra3": null,
        "Extra4": null,
        "Extra5": null,
        "Extra6": null,
        "Extra7": null,
        "Extra8": null,
        "Extra9": null,
        "Catalog": {
          "Type": null,
          "Name": "OpraziReact",
          "Server": null,
          "TargetName": null,
          "AlternativeName": null,
          "Label": null,
          "RowOrder": null,
          "Description": null,
          "Extra1": null,
          "Extra2": null,
          "Extra3": null,
          "Extra4": null,
          "Extra5": null,
          "Extra6": null,
          "Extra7": null,
          "Extra8": null,
          "Extra9": null,
          "Project": null,
          "Schemas": []
        },
        "Entities": []
      },
      "Fields": [
        {
          "Name": "Id",
          "EntityName": "Bank",
          "VirtualEntityName": "",
          "EntitySchema": "dbo",
          "TargetName": "Id",
          "AlternativeName": "",
          "Label": "Id",
          "Order": 1,
          "Description": "",
          "Extra1": "",
          "Extra2": "",
          "Extra3": "",
          "Extra4": "",
          "Extra5": "",
          "Extra6": "",
          "Extra7": "",
          "Extra8": "",
          "Extra9": ""
        },
        {
          "Name": "Name",
          "EntityName": "Bank",
          "VirtualEntityName": "",
          "EntitySchema": "dbo",
          "TargetName": "Name",
          "AlternativeName": "",
          "Label": "Name",
          "Order": 3,
          "Description": "",
          "Extra1": "",
          "Extra2": "",
          "Extra3": "",
          "Extra4": "",
          "Extra5": "",
          "Extra6": "",
          "Extra7": "",
          "Extra8": "",
          "Extra9": ""
        }        
      ],
      "DisplayFields": "Name"
    }
  ]
}

Good to know: Developers begin coding after creating a project in most of the IDEs as in Zontroy.

Last updated