Create a DaVinci Project With Predefined Parameters

This approach allows you to standardize initial configurations and streamline the setup process for future DaVinci Projects.

Below, you will find a step-by-step guide on how to create a DaVinci Project using a predefined parameter file. By starting with predefined settings, you can ensure your new DaVinci Project is configured correctly right from the beginning.

With Terminal Commands

Create your DaVinci Project from the terminal and edit your Creation File:

  1. To prepare your DaVinci Project with predefined values, start by generating a project creation schema file. This file will help you configure settings easily. Run the following command:

    $ dvcfg-b project generate-project-creation-schema -o /Path/To/Folder/For/Generated/Creation/Schema/File -b /Path/To/BSW/Package

    A project-creation-schema.json file is generated in the specified folder.

  2. Create a project-creation.json and add the the schema referenz to benefit from auto-completion during parameterization in an IDE:

    {
    "$schema": "/Path/To/Generated/Creation/Schema/File",
}

  3. Edit project-creation.json file and set the values according to your project available parameters and categories.

  4. Once your Creation File is ready, create the DaVinci Project by running:

    $ dvcfg-b project create -o /Path/To/Output/Folder -b /Path/To/BSW/Package -f /Path/To/Creation/File

    After successful creation, you will see:

    Creating a new project        SUCCESSFUL

Via Visual Studio Code

Create your DaVinci Project using the extension interface:

  1. Create a project folder and open your it in VS Code.

  2. In the Explorer, right-click your project folder. From the context menu, select DaVinci  New Project Creation File

  3. Choose a BSW package for your project and click Select.

  4. A file named project-creation.json--your Creation File--will be created.

    • This file includes a reference to the schema file, which is generated in the background.

    • The schema helps you define project-specific parameters.

    • Autocomplete in VS Code will suggest available parameters and categories you can configure.

  5. To create the DaVinci Project using your Creation File, right-click on project-creation.json and select DaVinci  New Project.

  6. The project will now be created in your folder based on the settings in your Creation File.

Verify Project Creation

After successfully creating your variant DaVinci Project, you can verify it by checking that the project structure matches the expected layout:

Table 1. Project folder structure
Folder Description

Config

Description files collection

Input

Contains input files for the input file processing or for transformers

Output

Contains all outputs that were generated or derived

Settings

Contains the project configuration settings

.editorconfig

helps to define and maintain consistent coding styles between different editors and IDEs

.gitgnore

Directories to be ignored from version control

MyNewProject.dvjson

DaVinci project file