RScript AI & Machine Learning

Description

Runs user-created R language scripts.

Configuration

To add the RScript AI & Machine Learning agent to a stream, follow the steps below:

  1. Ensure you have a use case open in the stream designer, this can be a new use case or an existing use case
  2. From the toolbox on the left expand the AI & Machine Learning option and scroll down until you can see “RScript”
    • You can also use the search in the header to find the agent quickly
  3. Click and drag the RScript AI & Machine Learning agent from the toolbox onto the canvas
  4. Rename the agent by clicking into the text area to the right of the icon
  5. Save the Stream by clicking the save button in the action bar
  6. Hover over the icon for the agent until it turns orange and then double click to open the configuration page
    • You can optionally use the configure option on the action bar once you have selected the specific agent and then clicking this option
  7. Configuration options
    • The Collection drop-down allows you to associate this agent with a specific collection. The selected option would be, by default, the same as the collection that was selected for the use case. If you do need to change it to another collection, select a different collection from the drop-down.
  8. Script options
    • If required, select the “Bulk Input?” checkbox.
    • Type your RScript code in the space provided.
  9. Output options
    • Select how your payload should be created by selecting one of the options in the drop-down:
      • Same as Existing
      • Existing with Addition
      • New
    • Add any outputs required in the Outputs grid
      • Click on the “+”-button to add a new row
      • Specify the Name
      • Select the Data Type
  10. Click Apply on the action bar, and then save the stream using the save button
Before this function can be used, R needs to be downloaded and installed on the Data Stream Designer server (click here for instructions).
Press Ctrl+Space while typing to bring up an Intellisense box which contails all input variables and any existing output variables
Manuals for R syntax and functions can be found here.
Limitations

None at this time

Release Notes
Version: 3.05
Released: 02-July-2018
Release Notes: Changed to integrated loading.
Version Released Release Notes
3.04 01-July-2018
  • Allowed Bulk input.
  • Every event received at one time is placed into a data frame and the script run once.
3.03 26-June-2018
  • Agent allows DateTime values, interpreted as POSIXct.
  • Agent allows Int64 values, truncated and passed as Int32.
3.02 7-Sep-2018 Fix: Agent is packaged as Virtual.
3.01 8-Aug-2018 Added error endpoint.
3.0 18-Nov-2017 Converted to v3 framework.

This is the legacy version of the XMPro Documentation site. For the latest XMPro documentation, please visit documentation.xmpro.com

X