Skip to content

5.2 Setup

Jump to bottom
SBI- edited this page Oct 14, 2018 · 1 revision

Explanation

Sets up a run time for a version of the RTC SDK. A run time is an isolated folder with a self-contained version of jazz that can be run with jetty. This means that every run time you create with the set up command is separate from the others, and can be copied, deleted, re-created etc. without the user having to worry about corrupting other run times.

Creating a new run time can take quite a bit of time, because a vast quantity of files has to be extracted.

Requirements

Before being able to set up a run time, you have to download and copy a set of sdk and server files from the IBM download page. Links are supplied in the [link section](put link here). RTC-SDK files should be downloaded / copied to the jde/sdks folder, and server zip files (JTS-CCM-Keys) to the jde/servers folder.

For example, to set up a 6.0.6 run time on windows, you would download this sdk to the jde/sdks folder, and this JTS (or: Linux download link) to the jde/servers folder.

Arguments

Setup takes one parameter, --sdk, for choosing which version of the RTC SDK should be used to create the run time. If no arguments are passed, the setup task defaults to the latest version of the sdk it can find in the jde/sdks directory.

Default

If no argument is supplied, setup defaults to the latest version available.

Short examples

  1. Set up latest run time: ./gradlew setup
  2. Settin up a specific run time: ./gradlew setup --sdk=6.0.3

Examples

Simple setup

  1. Before being able to run a set up, you need to download the files mentioned in the requirements section. This example uses the 6.0.6 files, so a file structure before running setup should look similar to this:
jre
├── dbs
│   ├── 6.0.3_db.zip
│   └── 6.0.6_db.zip
├── runtime
├── sdks
│   └── RTC-SDK-Server-6.0.6.zip
├── servers
│   └── JTS-CCM-keys-Linux64_6.0.6.zip
└── user
  1. Run the setup task
./gradlew setup
  1. After running the setup task, there will be a 6.0.6 folder in the run time folder, looking roughly like this (most files removed from tree view).
jde
├── dbs
├── runtime
│   └── 6.0.6
│       ├── conf
│       ├── db
│       ├── jre
│       └── sdk
├── sdks
│   └── RTC-SDK-Server-6.0.6.zip
├── servers
│   └── JTS-CCM-keys-Linux64_6.0.6.zip
└── user

Setting up a specific version

Jazz development environment supports an arbitrary number of run times. To choose which version to set up, you can pass it to the setup task as a parameter. As with the simple setup, this requires that you have the files available for the version you want to set up.

  1. This could be the folder structure before you start:
jde
├── dbs
│   ├── 6.0.3_db.zip
│   └── 6.0.6_db.zip
├── runtime
│   └── 6.0.6
│       ├── conf
│       ├── db
│       ├── jre
│       └── sdk
├── sdks
│   ├── RTC-SDK-Server-6.0.3.zip
│   └── RTC-SDK-Server-6.0.6.zip
├── servers
|   ├── JTS-CCM-keys-Linux64_6.0.3.zip
│   └── JTS-CCM-keys-Linux64_6.0.6.zip
└── user
  1. If you now run the setup task without parameters, it would try to set up a 6.0.6 run time. However, that already exists, so you get a message informing you of this:
$ ./gradlew setup

> Task :setup
SDK Version 6.0.6 selected for runtime setup
Runtime for 6.0.6 already exists. Doing nothing.
  1. So, to set up the 6.0.3 run time, the appropriate sdk version has to be specified:
./gradlew setup --sdk=6.0.3
  1. You now have multiple run times available:
jde
├── dbs
│   ├── 6.0.3_db.zip
│   └── 6.0.6_db.zip
├── runtime
│   ├── 6.0.3
│   │   ├── conf
│   │   ├── db
│   │   ├── jre
│   │   └── sdk
│   └── 6.0.6
│       ├── conf
│       ├── db
│       ├── jre
│       └── sdk
├── sdks
│   ├── RTC-SDK-Server-6.0.3.zip
│   └── RTC-SDK-Server-6.0.6.zip
├── servers
│   ├── JTS-CCM-keys-Linux64_6.0.3.zip
│   └── JTS-CCM-keys-Linux64_6.0.6.zip
└── user

JDE

Clone this wiki locally