3.0 User Guide

This guide covers a few use cases to get users started quickly. For detailed task instructions, please refer to the Tasks section. There is no way to cover every work flow, but this should get you used to how things work.

At this point, it is expected that you have at least done the quick start tutorial, including checking that you meet all the requirements.

Jazz development environment uses gradle as a task runner, so all interactions with the tool will either be through the gradle command line, or via a gradle plugin for the IDE of your choice. Any tool capable of running gradle can be used, but instructions on how to do so are outside of the scope of this wiki.

Configuration

Bootstrapping creates the folder structure inside jde, and usually only needs to be run once. As the jazz development environment is convention-based, this exact structure is necessary for everything to work. The user folder is where all configuration files are located. These are the only files a user should need to edit in order to use all of the jazz development environment facilities. Bootstrapping includes sane defaults inside every configuration file, and all files are commented and include examples.

This is a quick run down of the configuration files, their detailed usage is covered in other sections of the wiki. The configuration files also contain comments which guide the user while editing the files.

jde/user
├── eclipse-proxy.ini
├── java_command.cfg
├── jts_locations.cfg
├── linux_terminal_emulator.cfg
├── log4j
│   └── log4j.properties
├── run_time_parameters.cfg
└── workspaces
    └── workspaces_template.cfg

• eclipse-proxy.cfg Proxy configuration for the eclipse based tasks (mainly used for ide) Coveed in the Eclipse Proxy Configuration section.
• java_command.cfg Allows customization of the java command that is used to launch the development environment when the run task is executed. Covered in the JDK Configuration section.
• jts_locations.cfg Reserved configuration file for a planned but not implemented feature.
• linux_terminal_emulator.cfg Only relevant to linux users, configures the terminal emulator which is used to run jazz. Covered in the linux command line section
• log4j.properties Custom log configuration, which allows detailed logging from the run time. Comes with sane defaults and will place detailed log files in the jde/logs directory. Covered in the Log4J Configuration section.
• run_time_parameters.cfg Optional run time parameters passed to the jvm when running jazz, covered in the custom parameters section
• workspaces_template.cfg Last but definitely not least, this is most like the most important configuration file. Contains the locations of custom plugins loaded at run time. Plugin configuration is covered in the plugins section