Quick Start: Generating Your First Application

To create the entities.jdl file from the contents provided below, use your favorite method--here are some options.

Start by copying the contents below, typically by using the "Copy to clipboard" button that appears when hovering the text.

Then, paste this text in a new file named entities.jdl.

• On macOS, this can be achieved by executing

  pbpaste > entities.jdl

• On macOS and Linux, this can be achieved by executing

  cat > entities.jdl

  then pasting the copied text in the terminal, and typing ^D on a new line.

• On all systems, it can also be achieved by creating the entities.jdl file in a programming editor, and pasting the copied text into this file. Just make sure that you do not use a word processor like MS Word, but a text editor made for programming, such as VS Code.

The following JDL text is to be saved in a file named entities.jdl. To know more about how to write a JDL file, please refer to Business Model Configuration.

application {
  // DOM  [java.collectorClass] : [<%=collectorClass%>]
}

entity Country {
  // DOM [simple.primary.keys] : [id]
  id String required,
  name String
}

entity Plant {
  // DOM [simple.primary.keys] : [plantId]
  plantId String required,
}

entity Resource {
  // DOM  [simple.primary.keys] : [id]
  id String required,
  name String
}

entity ResourceCapacity {
  quantity Integer
}

entity Activity {
  // DOM  [simple.primary.keys] : [id]
  id String required,
  name String,
  durationInHours Double
}

entity Precedence {
}

entity Requirement {
  quantity Integer
}

entity Schedule {
  start Instant,
  end Instant
}

entity SolutionSummary {
  // DOM  [single.row] : [true]
  start Instant,
  end Instant,
  timespan Integer
}

entity ResourceUsagePerDay {
  // DOM  [simple.primary.keys] : [day]
  day Integer,
  numberOfHours Integer,
}

relationship ManyToOne {
  // DOM  [affects.primary.key] : [true]
  Requirement{activity} to Activity{requirements},
  // DOM  [affects.primary.key] : [true]
  Requirement{resource} to Resource{requirements},
  // DOM  [affects.primary.key] : [true]
  Precedence{first} to Activity{successors},
  // DOM  [affects.primary.key] : [true]
  Precedence{second} to Activity{predecessors},
  // DOM  [affects.primary.key] : [true]
  Schedule{resource} to Resource{schedules}
  // DOM  [affects.primary.key] : [true]
  Schedule{activity} to Activity{schedules}
  // DOM  [affects.primary.key] : [true]
  ResourceUsagePerDay{resource} to Resource{usagePerDay}
  // DOM  [affects.primary.key] : [true]
  Plant{country} to Country{plants}
  // DOM  [affects.primary.key] : [true]
  Activity{plant} to Plant{activities}
}

relationship OneToOne {
  // DOM  [affects.primary.key] : [true]
  ResourceCapacity{resource} to Resource{capacity}
}

Once you have created the generator.sh script with the contents above, there are two more steps before you can run this script.

First, you must give yourself execution rights on this file by running the following command:

chmod +x generator.sh

Then, you must log into the Docker registry where the Application Generator Docker image invoked by the script is stored. To this end, run the following command and provide the installation credentials that you have been given.

docker login product-dbgene-prod-docker-group.decisionbrain.cloud

Open a command line tool and move to the folder where you have stored the entities.jdl and generator.sh files. Your application will be generated in a subdirectory of this directory.

After executing the preliminary steps above, run the following command and answer the questions as explained in the table below.

./generator.sh

Note: Some generation problems are addressed in the Troubleshooting section.

Here is a transcript of a session where an application called capacity-planning was created in the current folder:

$ ./generator.sh
Mounting /Users/alice/Work/example as generation folder
Generating using version @DOC_PRODUCT_VERSION@

**********************************************************
Gene CLI Project Generator
Copyright (c) 2020 DecisionBrain SAS. All Rights Reserved.
**********************************************************

? Your project name  capacity-planning
? Project title (will appear in the interface and documentation)  Capacity Planning
? The project generation destination  .
? Your project package  com.example.capacity-planning
? Collector class name (no package, ex: MyCollector)  CapacityPlanning
? What type of your model definition do you have ? DOC 3.9 (dbm file) or jdl ?  jdl
? Path to your jdl file  entities.jdl
   create capacity-planning/.gitattributes
   create capacity-planning/README.md
   create capacity-planning/build.gradle
...
   create capacity-planning/gene-model/spec/entities.jdl
...
Processing dotfiles
	/tmp/capacity-planning/.gitignore
	/tmp/capacity-planning/workers/python-engine-worker/worker-shell/.gitignore
	/tmp/capacity-planning/web/.gitignore
	/tmp/capacity-planning/web/.npmrc

Note that the Application Generator tool has copied your original JDL file to the gene-model/spec subdirectory of the project that was generated (see near the end of the transcript above). Should you want to change your data model in the future, you should edit this file. The original file is not used in the generated application.

Also, you can notice that the original JDL file that you used as input to the Application Generator tool contains a <%=collectorClass%> placeholder. If you need to generate your project again and provide a different collector class name, be sure to use your original JDL file.

The next steps include building the application, the code of which was just generated. This requires to configure the access to DecisionBrain repositories. Both aspects are covered in the next sections.