Export Schema

Owned by Ondřej Tesař
Last updated: Mar 28, 2024 by Jana Volencová (Deactivated)
2 min read

This feature allows you to export tables' metadata (database table schemas) used in the project, including the Description field, which provides a brief description of each specific field in the table. Tables can be exported in HTML, Markdown, or Drawio (http://diagrams.net) formats.

All options of the Export Schema feature can be found under Pricefx > Export Schema.

menu.png

How to Export a Schema

Follow these steps to export a schema in the desired format.

  1. Right-click the project folder and navigate to Pricefx > Export Schema, then click the Export Schema to HTML (for example).

  2. In the Export Schema to HTML dialog, select the tables you want to export and enter the file name of the output file.

  3. Click the OK button.

  4. The source of the exported file is displayed in the IDE’s tab. Click on an icon of your favorite browser to display a preview of the exported tables' metadata.

preview.png

 

Now, you can view the structure of tables. Each table contains the Field Name, Label, en, Data Type, Required, and the Description column. Fields displayed in bold are primary keys.

  • en – The English translation of the label.

  • Required – If marked with an “x”, it means that the field is mandatory.

  • Description – A free-text description of the field. Currently supported in Products (P), Product Extensions (PX), Customers (C), Customer Extensions (CX), Company Parameters (LT) tables.

Found an issue in documentation? Write to us.