To get started with GenRocket, you will need to complete a few basic installation and setup steps. These steps typically only need to be completed once for first-time users, with the exception of occasional GenRocket Runtime updates, and include the following:
- Download GenRocket Runtime
- Extract the GenRocket Runtime File
- Update Your Environment Variables
- Run the "genrocket" Command in your Command Window
The GenRocket Runtime is used to generate data on your local machine or server. It acts like an engine on your local machine and follows the instructions within the Scenario to generate the test data. The GenRocket Runtime will need to be installed on your local computer to run Scenarios and generate your test data.
Need to Update GenRocket Runtime Only? Please see one of the following articles:
Need to see a list of supported Java Versions? Java must be installed on the computer that GenRocket Runtime will be set up on. To see the full list of supported versions, click here.
In This Article
- Step 1 - Download GenRocket Runtime
- Step 2 - Extract the GenRocket Runtime File
- Step 3 - Update Your Environment Variables
- Next Steps
Step 1 - Download GenRocket Runtime
- Log into the GenRocket web platform.
- Expand the Options Menu in the navigation bar.
- Click Download Runtime. The version number you are downloading may not match the version in the screenshot.
Step 2 - Extract the GenRocket Runtime File
Once the download is complete, you will need to extract the GenRocket Runtime into your User Home Directory/Folder. This is usually: (C:\Users\*Your User Name*).
Complete the following steps in Windows File Explorer:
- Navigate to your downloads folder: C:\Users\*User Name*\Downloads.
- Right click on the GenRocket Runtime zip file (genrocket-#.#.#).
- Select Extract All... to extract the file.
Note: Make sure you don't extract the folder into itself like this: C:\Users\yourName\genrocket\genrocket.
To extract the file to your User Home Directory/Folder, complete these steps:
- Click Browse... to select an extract folder.
- Select your User Home Directory/Folder (usually C:\Users\*Your User Name*).
- The default path will show the name of the zip file being extracted: genrocket-#.#.# (the #'s are digits).
- To avoid additional work, remove genrocket-#.#.# from the extraction path.
- Click Extract at the bottom of the pop-up window.
- The extracted folder will appear as shown below.
Note: Please note that the version number will be different from what is shown in the folder name below.
- You will need to rename the folder to: genrocket.
Runtime File Extraction Troubleshooting
If you happen to extract the Runtime to the default location, you will end up with a directory system that looks like this:
To fix the problem, only move the sub genrocket directory containing the bin and lib folders into your home directory. Be certain to remove the version number from the end of the folder name. It will look like this once finished:
- *Your Home Directory*/
Step 3 - Update Your Environment Variables
Open the Start Menu on your Windows computer and complete these steps:
- Click on the Windows icon.
- Type environment into the Search Bar.
- Select Edit the system environment variables option in the search results.
Note: For newer Windows versions, simply type environment into the Search Bar.
- Click on Environment Variables at the bottom of the System Properties window.
- In the User Variables section, click New...
Step 3a - Add the First Environment Variable
- Name: GEN_ROCKET_HOME
- Value: The value is the location path of the GenRocket RunTime.
- Example: C:\Users\yourName\genrocket
- Click OK.
Step 3b - Add (or Modify) the Second Environment Variable
To create a new PATH variable, complete these steps:
- Name: PATH
- Value: %GEN_ROCKET_HOME%\bin
- Click OK.
If you already have a PATH variable, just add the %GEN_ROCKET_HOME%\bin to the end of it. Make sure to put a semi-colon after the last value before you add your value.
- Example: C:\Some Other Path;%GEN_Rocket_Home\bin
Note: The steps for modifying the PATH value may vary depending on the version of Windows you are running.
Step 3c - Add New System Variable for Later Versions of Java (Versions 1.9 to 1.15)
If you will be running later versions of JDK or JRE (1.9 to 1.15), an additional system environment variable will be needed to successfully run GenRocket Scenarios in your Command Terminal. Please note that Java versions 1.16+ have not been tested with GenRocket Runtime. Complete the steps below:
- Name: JAVA_OPTS
--add-opens java.base/jdk.internal.loader=ALL-UNNAMED --add-opens jdk.zipfs/jdk.nio.zipfs=ALL-UNNAMED
- Click OK.
Note: To learn how to check your Java version, please see this article: How to Check your Java Version.
Step 3d - Save Your Changes
- Click OK within the Environment Variables dialog to save your changes.
Note: The PATH value will change to this once saved: (C:\Users\User Name\genrocket\bin).
- Click OK again to close the System Properties window.
Note: You must close these windows before opening a new command prompt. Otherwise the changes will not be recognized.
Step 4 - Run the "genrocket" Command in your Command Window
- Open a new command prompt since, the Environment Variable values are modified.
Note: If you do not know where you command prompt program is, use the Search Bar in the Windows Start Menu.
- Type genrocket into the command prompt and press the Enter Key.
- If you do not receive any errors, you are all set.
- A default .genrocket folder will be created in your User Home Directory/Folder automatically (usually C:\Users\User Name\).
- Once the GenRocket Runtime has been successfully installed, you will need to download and set up your my profile.prg file. See this page for more information: Windows: How do I download and set up my profile.grp?.
"genrocket" Command Troubleshooting
If you receive an error, please see one of the troubleshooting articles below:
- Unsupported Class Version Error
- "genrocket" Command Not Recognized
- JAVA_HOME is Set to an Invalid Directory
Once the initial installation and setup steps have been successfully completed, you will need to configure your Resources and download my profile.grp.
To learn more about setting up your Resources, please see this Knowledge Base section: Resources.
To learn more about downloading my profile.prg, please see this article: Windows: How do I download and set up my profile.prg?.