In a Virtual Environment, a Release is deployed directly within the GoRules BRMS system. This setup acts as a self-hosted environment where decision models can be executed and managed natively within the platform.

Once a Release is deployed to a Virtual Environment, the models are immediately available via GoRules' environment evaluation endpoints. This approach is ideal for scenarios where customers don't need complex infrastructure and high performance engines, with minimal external dependencies, offering a straightforward deployment process.

Virtual Environment Setup

Setting Up Virtual Environment

1. Open your project.
2. Navigate to Settings > Environments.
3. Click Create Environment.
4. In the dialog, provide a name, choose the type as Virtual, and enter a unique key, such as "staging" or "production".

📘

The Environment KEY must be unique within each project.

Deploying a Release to a Virtual Environment

1. Go to Releases.
2. Create a new Release if one does not already exist.
3. Open the desired Release and click Deploy, or from the list, click the three dots next to the Release and select Deploy.
4. In the dialog, select the Environment where you wish to deploy.
5. Click Deploy.
6. You can check the deployment workflow status under Releases > Runs.

Testing a Release and Environment Evaluation

1. From the list of environments, copy the environmentAccessToken.
2. Similar to the evaluation endpoint, make a POST request to:
   /api/projects/{projectId}/environments/{environmentKey}/evaluate/{documentPath}
3. Set the header x-access-token to the token obtained in Step 1.
4. In the request body, include a "context" property and proceed with the request.