Upload a Package

◷ Reading Time: 6 minutes

In this tutorial, you will learn how to add a new package to FlexRule Server. We will upload the sample decision package and enable the status of the uploaded package.

A package can be uploaded in two ways.

  1. Directly from the Designer
  2. Upload a package file (.frdp)

Upload a package from the Designer

Uploading a package from the designer is explained under ‘Publish your project‘.

Upload a package file

Decision Scenario

This tutorial is based on one of our default sample projects, Car-Insurance-Sample.

This car insurance premium calculator has two inputs:

  1. Input from operator/user about their car information
  2. Input from a database for a list of high-risk cars

Prerequisites

Database preparation

Follow the instruction at Car-Insurance-Sample and prepare your database, tables, and sample records.

Download Decision Module Package

Download the decision package using the attachment (car-insurance-sample-package.zip) at the end of this page.

FlexRule Server

FlexRule Server will need to be installed and configured.

Run FlexRule Server

Run your FlexRule Server in the console mode and open the FlexRule Workbench application in your browser.

Get It Started

Login to the Workbench as Admin

Log into Workbench using the admin user account and the password you set during configuration. When you are logged in you will see the Workbench home page.

Workbench home screen showing left menu, Quick Stats and status green for Licenses, Master, Agents and Database

Upload Package

From the left side navigation menu, select Execution Server and then choose Packages.

Workbench Package menu item landing page showing available uploaded packages

Click on New Package.

Workbench package view showing the add new package button

Download and Unzip the sample decision package file (car-insurance-sample-package-v9.zip), and you will find a file called car-insurance-sample-package.frdp.

Click the “Browse” button and select the .frdp file,

Workbench package upload view with package file path input in the browse field

Press the “Save” button.

Workbench package view showing the save package button

You will then be redirected to the packages list screen.

Workbench package view showing available packages and a success modal for a new uploaded package

Congratulation! your package has been successfully uploaded and registered in FlexRule Server.

Provide Package Authorization

After adding the package, Users need to be granted access the package.

Select Details from the Actions dropdown for the required User (Admin in this case)

Administration --> Accounts --> Users
Workbench user account view showing the list of available users and the details menu item highlighted

Tick the checkbox for the package in the Packages tab.

Workbench User account details view showing the Packages tab enabled and a highlight of the checkbox to assign the package to the user

Click on Update.

Workbench User account view showing the Update button highlighted to save the package assignment to the user

You will see a success notification the Package is Linked to the User.

Success modal indicating package linked to user

Follow the same steps to provide access to Application accounts.

Enabling Package

You will see in the package list (Execution Server --> Packages), the status of the new package is “off”. Toggle the status to “on” to use the package.

Workbench packages view highlighting the toggle to enable the package

You can also toggle the package on by selecting the Actions dropdown and choose “Start”.

Workbench Packages view showing the Actions menu open and the alternative option to enable the package selected

Now you will see the status of the package has changed to “on”.

 A message will appear in notifications the package is enabled.

The package is ready to be used.

Workbench packages view with a success modal defining the package has been activated
Updated on September 28, 2023

Article Attachments

Was this article helpful?

Related Articles