For detailed, complete lists of components as well as installation instructions, see the 1.6 XRay release notes article at XRay release notes: v1.6.5.
Please note that the Admin Menu has been redesigned in version 1.6. Please see Admin settings: Overview (v1.6 and later) for details. See Admin settings: Overview (v1.5 and earlier) for the version 1.5 menu layout.
Machine Learning Model Definition and Training wizard
XRay version 1.6 includes a wizard to define the Machine Learning models to be built. Building a model is also known as “training" a model. Models are trained with learning data and a target variable.
The target variable is the field that you wish to gain insight into, predict, perform what-if on, detect anomalies on, or forecast. The learning data is the data that you suspect has an impact on the target field, such as the interval at which you want to forecast.
The wizard includes dataset, target, and variable selection, as well as a scheduling option for model retraining.
The Target is the specific field you wish to gain insight into.
Identify the factors that have an impact on your target:
Indicate how often you want the model to be retrained:
Time Series models require additional configuration options, such as the Time series field, Time series interval, and anomaly detection configuration.
Anomalies detection configuration allows you to choose whether you want anomalies to be processed in real time (when they occur), as well as the Anomaly Margin Type: (Percent or Numeric) and for numeric types, the Anomaly Margin (that is, the margin of error for a numeric value to be considered an anomaly).
See also ML Model Definitions.
Generate a dashboard from a Machine Learning Model
In the script editor, in the jKQL Script Parameters area on the lower right, be sure to specify the dashboard, repository, organization, and ML model information, as shown in the green box below.
The RepositoryID must be the name of the repository followed by a dollar sign ($) and the Organization name. In the example above, BloodPressure$Nastel refers to the BloodPressure repository for the Nastel organization.
Click Test to make sure the ScriptResult is successful. Then save the script and close the Script editor.
Create a temporary viewlet. At the jKQL prompt, enter get MLModel to return the Machine Learning model from which you want to create a dashboard. Select the check box for the model and select Generate Dashboard from the pop-up menu.
A new dashboard is generated based on the model.
jKQL Scripts Enhancements
Import and Export jKQL Scripts
Now, Import and Export buttons are available in the lower-right corner of the screen. These allow you to import jKQL scripts by navigating to script (.jkqls) files, or export a saved script to a .jkqls file. Exported script files are saved to your default downloads folder.
Exported script file notification in browser:
Exported script file in Downloads:
jKQL Scripts can read from and write to multiple repositories
jKQL Scripts are no longer required to be defined within the context of a single repository. Now, each jKQL statement executed by the script can be run against any specific repository in the same organization as the "default" repository (that is, the one in which the script is being run).
The following new methods, which accept a repository in which to run the jKQL statement or upsert, have been added to the jKQL Script API:
executeJKQLInRepo(repoId, jkql)
executeJKQLOnResultInRepo(repoId, jkql, rs)
upsertInRepo(repoId, fieldValues)
|
Script Function |
Description |
|
ResultSet executeJKQLInRepo (String repoid, String jkql) |
Executes the specified jKQL statement in the given repository and returns the result, if any. The specified repository must be in the same organization as the current repository that the script is being run in. |
|
ResultSet executeJKQLOnResult (String jkql, ResultSet rs) |
Executes the specified jKQL statement using the specified result set as input, and returns the result, if any. |
|
ResultSet executeJKQLOnResultInRepo (String repoid, String jkql, ResultSet rs) |
Executes the specified jKQL statement using the specified result set as input, and returns the result, if any. The specified repository must be in the same organization as the current repository that the script is being run in. |
The following restrictions apply to the above methods. An exception is thrown if either of these is not true:
- As indicated above, the specified repository must be in the same organization as the current repository that the script is being run in.
- The user who is running the script must have access to the specified repository.
Token-related enhancements
Token setup has changed since version 1.5. Here's how to access it in version 1.6:
- For Admins, from Admin Settings:
> Admin Settings > Tokens > Streaming
or
orin the Streaming Tokens column.
- For on-Admin users, from User Settings:
New Streaming tokens setup:
New Access token setup:
Where tokens are set up is not the only aspect of tokens that has changed. New version 1.6 functionality for tokens is described below.
Personal tokens can be set to expire
When defining personal access tokens, you can now set up the token to expire at a certain date and time using the Expire Time field.
Allow defining AccessToken quotas
AccessToken quotas are now managed through Admin Settings in the user interface. Available AccessToken quotas are:
- Max requests
- Rate Limit (Bytes)
- Overage Policy
- Retention (in days)
See Tokens (XRay 1.6) for more information.
From the list of streaming tokens, you can view the quotas for a particular token in the list by clicking the View quotas icon: in the Quotas column.
Minimum Java Version is now 11
Beginning with version 1.6, Java 11 is the minimum version required to run XRay.
Clone selected items
When you want to make a new set, alert, or jKQL script, you no longer have to start from scratch. You can clone any of these objects to make a new one. A clone, or copy, button is available for these items, as shown on the screen shots below.
Clone Sets
Clone Alerts
Clone jKQL scripts
Data Import Enhancements
The following enhancements have been made to the data import that is available through the green Import Data button in the upper-right corner of the windows, as shown below:
Retention of Imported Data
When importing data using the import wizard, you can now indicate how long the imported data should be retained. Choices are Temporary (1 Hour), Maximum available (180 Days), or a Custom time frame in minutes, hours, days, weeks, or months.
Allow users to choose CSV file encoding
To help avoid problems that have been encountered importing CSV files because of their character encoding, you are now able to choose the character encoding of CSV files at import. For example, you can select UTF-8 or Windows-1252.