Export (JSON Schema)

In this guide you will see how to create a JSON-Schema profile manually, or simply just how to export your imported schema.

If you are following the tutorial from Dynamic (JSON Schema) you can skip to Step 2: Use the profile to export your schema

Before starting, let's assume that you have already created some nodes, and you already added some mixins and relations, we will assume that you have used a mixin to store a title, and a summary for your nodes.

Step 1: Create the import/export profile

  1. From the features tray, click on 'Grids' → click on the plus icon.

  2. Select 'JSON-Schema Import/Export Profile' as the Grid Type, and add an appropriate name. The profile UI will automatically open up.

  3. On the bottom left corner, Click on 'Continue without Source'

  4. On the bottom left corner, Click on 'Add Key', and check the 'Is Special Key' checkbox.

  5. select 'title' from the dropdown

    1. Some fields will be auto filled and disabled, since this is a 'Special Key' (Special Keys have pre-configured 'Key Scope', and 'Export Format')

    2. The 'title' card will show up, with the 'Transformed To' set to Mixin.

    3. Set 'Transformation Value' to the mixin that has the value of the title.

    4. Click 'Save'

  6. Repeat the process to add another key for the assumed 'Summary' field, but this time let's not check the 'Is Special Key' checkbox

    1. Set the 'Key Scope' to 'Types Or Elements'

    2. Set the 'Transformed To' to 'Mixin'

    3. Set 'Transformation Value' to the mixin that has the value of the summary.

    4. Set 'Export Format' to 'String'

  7. Repeat the process for any other mixins or relations that you are using in your model

    1. (Suggestion) Add the 'properties' relation, and configure the 'domain includes' as the transformation value.

    2. Note that Relations are usually exported as 'Array' or 'Object' - this is set in the 'Export Format' field.

Now that the profile is set, let's see how to use it.

Step 2: Use the profile to export your schema

  1. Navigate to the 'Types Grid', In the 'Types Grid' tab and on the far right, you'll find the sidebar tab, click on 'export', which will expand the export menu, then select 'JSON Schema'.

    1. Alternatively you can open the dedicated export UI, Features Tray → Channels → Export → JSON Schema

  2. Select the profile you created (or that was created automatically during the import) at the 'Import Configuration' dropdown.

  3. Select 'Types' at the 'Export Includes' dropdown.

  4. Let's leave the other options for now, and click on 'Process', (see the hint below).

  5. After the export is done, you can either download the file or click on 'Preview' to see the export results

If your schema was created using the Dynamic (JSON Schema) and it had a single file, CoreModels will automatically figure which type should be selected, but otherwise, you should select a type for the import to work.

Now that you have exported your schema using the default options, let's explore what the other options mean.

Export Options

Include All Relations:

By Default, CoreModels filters the export results based on the selected space, setting this option to true, will include the relations that exist in the current space, regardless if its target existed in the current space or not.

Selected Types:

This control specifies which type the exporter should start with.

Last updated