Go to home page

R³S Toolkit

The R³S Toolkit provides APIs that enable you to build your own interfaces and dashboards so that you can run models or embed the running of models in other applications. You can use these APIs to build a process that precisely meets your needs instead of using a process that somebody else has designed and developed.

The R³S Modeler model-development environment can create run archive files containing executable model code. The APIs of the R³S Toolkit enable you to run models using the executable model code from these run archive files. Consequently, you can run and rerun models without generating and compiling those models again.

We built R³S Process Manager using the R³S Toolkit, so it provides an example of what is possible with the R³S Toolkit. R³S Process Manager uses the R³S Toolkit to embed the running of models in a secure, structured, process-driven framework.

Key Benefits

  • The R³S Toolkit enables you to run models from outside of R³S Modeler, providing a clear distinction between users who develop models from those who run the models.
  • You do not need to install either R³S Modeler or the compiler on a machine that runs executable models from run archive files using the R³S Toolkit.
  • Users do not need a license for R³S Modeler to run executable models from run archive files using the R³S Toolkit.
  • You can use the R³S Toolkit with other tools to build an automated production environment.

Key Features

  • Create execution jobs to run models in run archive files created by R³S Modeler
  • Specify the values of runtime parameters, such as the location of data files and assumptions, programmatically or using an XML file
  • Monitor and cancel the execution of a job and read any error messages
  • Distribute jobs
  • Check the status of the various external input sources of a job