What is GenRocket Runtime?
The GenRocket Runtime is required to use the GenRocket engine that is used to generate test data, performing tasks like masking, subsetting, or any other GenRocket functions. Runtime is a set of JAVA Jars downloaded from GenRocket Cloud and installed on a user's local machine, servers, or virtual machines, wherever test data generation is required (in the customer environment, as shown in the blue box in the diagram below).
In This Article
- GenRocket Jars
- Where can GenRocket Runtime be set up?
- Recommended Hardware Requirements
- Software Requirements
- Environment Variables (New Setup)
- User/Server Profiles
- Prerequisites for a New Runtime Setup
- GenRocket Runtime New Setup vs. Update
- Additional Runtime Articles
GenRocket Jars
The GenRocket Runtime consists of the following set of jars:
| GenRocket Jar Name | Description |
| genrocket.jar | Interprets command line input, user license check, and launches the GenRocket engine. |
| gr-engine.jar | Core engine that runs GenRocket Scenarios and support for other ancillary components like GenRocket Multi-User Server (GMUS) |
| gr-generators.jar | GenRocket Generator classes |
| gr-receivers.jar | GenRocket Receiver classes |
| gr-grepository-servers.jar | Creates and runs a G-Repository Server |
| gr-grepository-clients.jar | Creates a G-Repository Client |
Where can GenRocket Runtime be set up?
GenRocket Runtime should be installed as close to the destination where the synthetic data is needed. You can also use the GenRocket Docker Image to generate test data with Runtime in a Docker environment.
Runtime setup requires access to the firewall for license verification. Errors may occur if encrypted, secure storage or a virtual drive is used that does not have appropriate access permissions.
| Method | Description |
| Local User Machine | To generate test data on the user's local machine. |
| Shared Central Machine | Set up in a shared location on a machine (local, remote, or virtual) where multiple users log into that one machine to generate their test data. |
| Local or Remote Server | Set up on a local or remote server that users can access or one used for automated testing (CI/CD integration). |
Recommended Hardware Requirements
| Hardware | Details |
| Operating System (64-bit) | Linux (Recommended), Mac OS, or Windows |
| CPU | Minimum of 4 CPUs |
| Memory | Minimum 8GB RAM (Recommended 16GB RAM) |
| Hard Drive | Minimum 500GB SSD |
Software Requirements
| Software | Details |
| Internet Browser | The GenRocket Web Platform is used to "Model" and "Design" the GenRocket Test Data Project. Use any of the commercially supported versions of these Internet browsers listed below:
|
| Java Version | The GenRocket Runtime Engine supports the following commercially maintained Oracle Java Versions (including OpenJDK) but may also work with open JDK provided by other providers such as Amazon, Redhat, etc.:
Need to know your Java Version? Enter this command in a Command Prompt or Terminal window: java -version |
Environment Variables (New Setup)
Some Environment Variables have to be configured for Runtime to work. Specific values based on the operating system are defined in the detailed Runtime setup article.
| Environment Variable | Description |
| GENROCKET_HOME Environment Variable | Defines the path (location) for the "genrocket" folder created during the initial setup. The variable should point to your home directory. For local installs, this is a user variable. When installed in a shared location, it will be a system variable. |
| PATH Environment Variable | Must add "GEN_ROCKET_HOME" to the PATH variable. For local installs, this is a user variable. When installed in a shared location, it will be a system variable. |
| JAVA_HOME System Environment Variable | This variable is already set in most instances if JAVA is installed. If more than one version is being used, the path can sometimes be invalid, resulting in an error during the setup. Verifying the path is recommended. |
| JAVA_OPTS System Environment Variable | This system variable will require a value when using Java Versions greater than 1.8. Some Generators use memory to maintain the uniqueness of the random data being generated. An optional value can also be added when generating a large amount of data. This can improve performance and resolve memory issues. |
User/Server Profiles
GenRocket Runtime requires a User Profile or a Server Profile, depending on how it is being set up. The profile file (*.grp) is downloaded from the GenRocket cloud and links the user (or server) executing Runtime to their GenRocket user (or server) license. An Organization Admin must first provision the user (or server) on GenRocket cloud. Details on downloading and linking the user profile to .genrocket folder are provided here.
| Profile Type | Description |
| User Profile | Required for every user to use GenRocket Runtime. It matches the Scenario to your organization and verifies that the user has an enabled, active account to run the Scenario on their local machine, workstation, or a shared machine. |
| Server Profile | Required for any server or machine that does not have specific users tied to it. It is typically used for servers in an automated test environment, such as integration into CI/CD tools. Click here to learn more. |
Prerequisites for a New Runtime Setup
The following prerequisite steps must be performed before GenRocket Runtime can be set up on your machine:
| # | Prerequisite |
| 1 | Verify access to the GenRocket Web Platform and active user license.
|
| 2 | Enable necessary ports through firewalls. The default port for Runtime is port 443.
|
| 3 | Admin rights for local or server machine to be able to change environment variables, install Runtime, and JAVA. |
| 4 | Install Java on the machine (local or remote) where Runtime will be installed. |
GenRocket Runtime New Setup vs. Update
Once GenRocket Runtime is installed, it should be regularly updated for the latest jar files and functionality. Runtime and JAR updates are announced through release notes. Users are notified of updated releases through a pop-up modal when they log in after an update has been released to production (Release notes are also published on the GenRocket Knowledge Base).
Refer to the Release notes to determine if: 1) Full Runtime Update or 2) Jar update is required:
| Type of Install | Description |
| New Setup | Instructions for a new setup can be found here: |
| Runtime Update | If an update has a new Runtime Jar, a full Runtime update is needed by completely replacing the old genrocket folder with the newly downloaded Runtime file. For complete instructions, click here. |
| GenRocket Jar Update | If only a Jar update is required, these files can be updated from the command line. Downloading Runtime from GenRocket Cloud may not be necessary. For complete instructions, click here. |