Rulex Platform version 1.2.x

Here below you can find the documentation for Rulex Platform version 1.2.x for the following components:

• Platform overview

• Factory

Use also the list on the left to browse through the documentation available.

• Rulex Platform
  • Self-coding
  • Platform Overview
  • Buying Platform
    • Installing Rulex Platform
      • Prerequisites
      • Standalone wizard installation
      • Standalone silent installation
      • Cloud version
        • Cloud Configuration Settings (YAML)
          • Platform
          • Persistent volume claim
          • Persistent volume
          • Broker
          • Internal authentication server
          • Init
          • msNotify
          • MS_NAME
          • Ingress
          • Route
          • Istio
        • Rulex Platform Server
          • Installation
          • First Access Configuration - Azure
          • Removing Rulex Platform Server Installation
    • Configuring Rulex Platform
      • Changing the Product Key
      • Configuring the main working area
      • Configuring the caching location and retention policies
      • Configuring Rulex Platform’s mail server
      • Configuring roles in Rulex Platform
        • Platform Mail Server
          • SMTP Server
          • SendGrid®
          • Mandrill®
          • MailGun®
          • HTTP Server
          • Summary
        • Configuring REST API users
          • REST API configuration panel
    • Exploring Rulex Platform
      • Environments
      • Resources
      • Useful Icons
        • Using General Resources
          • Resources Context Menu
          • Importing Resources
          • Exporting Resources
          • Deleting import and export paths
            • Filesystem Resource
              • Filesystem connection configuration
              • Creating a Filesystem Resource
              • Proxy panel
              • Authentication application mediated
                • Accessing Google Drive via Rulex Platform
                • Accessing Outlook via Rulex Platform
                • Registering a Sharepoint app for Azure authentication connection
            • Database Resource
              • Database connection configuration
              • Creating a connection to a database
            • Macro Resource
              • Macro code
              • Using macros
            • Repository Resource
              • Repository connection configuration
              • Using a Repository
            • Vault Resource
              • Vault connection configuration
              • Using a Vault resource
        • Introduction to Primary Resources
          • Variables
          • Versioning
          • Versioning status on the interface
            • Rulex Platform Variables
              • Variable definition
              • Variables Manager
              • Sensitive Variables
              • Variable use
            • Versioning operations
              • Add Resource
              • Clone Resource
              • Merge Resource
              • Info Resource
              • Pull Resource
              • Push Resource
              • Log Resource
              • Revert Resource
              • Tag Resource
              • Update Repository
              • Importing from Repository
        • Environments
          • Environments Context Menu
          • Creating Environments
          • Importing Environments
          • Exporting Environments
        • Using Environment Variables
          • Environment variables panel
        • Resource permissions
          • Permission definition
          • Add a new rule permission
          • Setting permissions
    • Automation for Rulex Platform
      • Using Rulex Platform REST API
        • API Structure
        • API Response
        • API Authentication
        • Sample API call
        • License management in REST API
          • REST API Reference Manual
            • Auth Token
            • Compute Flow
            • Create Database
            • Create Environment
            • Create Filesystem
            • Create Flow
            • Create Macro
            • Create Source
            • Create Environment Variable
            • Create Vault
            • Delete Database
            • Delete Environment
            • Delete Environment Variable
            • Delete Filesystem
            • Delete Flow
            • Delete Macro
            • Delete Repository
            • Delete Vault
            • Export Flow
            • Get File
            • Get Resource ID
            • Get Result
            • Import Flow
            • List Database
            • List Environment
            • List Filesystem
            • List Flow
            • List Macro
            • List Environment Variables
            • List Vault
            • Rename Database
            • Rename Environment
            • Rename Filesystem
            • Rename Flow
            • Rename Macro
            • Rename Environment Variable
            • Rename Vault
            • Set Stop Computation
            • Set Environment Variable
      • Using Rulex Platform Command Line Interface
        • Launching modes
        • General Approach
          • Batch Mode Shortcuts
    • Rulex Platform - Release Notes
      • Version levels
      • Changelogs
        • RELEASE NOTES VERSION 1.2.1
          • Version 1.2.1-199
          • Version 1.2.1-187
          • Version 1.2.1-173
          • Version 1.2.1-163
          • Version 1.2.1-159
          • Version 1.2.1-155
          • Version 1.2.1-144
          • Version 1.2.1-143
          • Version 1.2.1-138
          • Version 1.2.1-130
          • Version 1.2.1-129
          • Version 1.2.1-117
          • Version 1.2.1-106
          • Version 1.2.1-76
          • Version 1.2.1-72
          • Version 1.2.1-48
          • Version 1.2.1-42
          • Version 1.2.1-27
          • Version 1.2.1-26
        • RELEASE NOTES VERSION 1.2.2
          • Version 1.2.2-200
          • Version 1.2.2-196
          • Version 1.2.2-194
          • Version 1.2.2-191
          • Version 1.2.2-177
          • Version 1.2.2-176
          • Version 1.2.2-149
          • Version 1.2.2-131
          • Version 1.2.2-127
          • Version 1.2.2-111
          • Version 1.2.2-96
          • Version 1.2.2-75
          • Version 1.2.2-65
          • Version 1.2.2-61
          • Version 1.2.2-43
          • Version 1.2.2-12
          • Version 1.2.2-9
          • Version 1.2.2-4
        • Changes between Rulex 4 and Rulex Factory
          • Changes managed automatically by import converter
          • Changes mitigated by import converter through value modifications
          • Changes not mitigated or corrected by the converter
    • Rulex Platform license plan
      • Rulex Factory Lite
      • Rulex Factory Personal
      • Rulex Factory Enterprise
    • Rulex Software - Code Quality Review
      • 1- Kernel repo review results
      • 2- Platform repo review results
    • Rulex Platform roles
      • Role Manager
• Rulex Factory
  • Building solutions
  • Handling heterogeneous data
  • Data preparation and pre-processing
  • Machine learning and explainable AI
  • Rule Management and Engine
  • Optimization
  • Rulex Factory Homepage
  • Customizing Rulex Factory
    • Discovering Factory Flows
      • Flow Status
      • Flow Context Menu
      • Importing Flows
      • Exporting Flows
      • Flow execution parameters
        • The Flow Review Tool
          • Review Validation File
          • Flow Review Tool Panel
          • Results file
        • Scheduling Flow Execution
          • Schedule configuration
          • Using the Plan schedule
        • Searching in Flows
          • Search results
          • Search customization
    • The Flow Stage Window
      • The stage
      • The Left Panel Tabs
      • The Right Panels
        • Stage Left Panel Tabs
          • Summary Tab
          • Variables Tab
          • Priorities Tab
          • Alerts Tab
          • Events Tab
          • Documentation Tab
            • Configuring an Alert
              • Parametrizing an Alert
              • Email Alert Format
            • Documenting a Flow
              • Documentation Editor
              • Autofilling a task
              • Exporting the documentation
              • Exported documentation format
            • Discovering the Option Manager
              • Selecting the tasks
              • Changing the Options
            • Controlling the Priorities
              • Priority management in computation
        • Factory Toolbar
          • General operations
          • Computation modes
          • Flow operation shortcuts
          • User settings and manual search
            • Recording Macro code
              • Configuring an event
        • Decorating the stage
          • Widget Inspector
    • Factory Tasks
      • Opening a task
      • Factory tasks window
      • The Task Tab
      • Task families
      • Data inputs/outputs
      • Flow and Task relationship
        • Task Overview
          • Standard Tasks
          • Manager Tasks
          • Module Tasks
          • Task category mapping
            • The GOLD language
              • GOLD base types
              • GOLD operators
              • Indexing objects
              • Calling GOLD functions
              • Rulex Platform Attributes, Variables and Cells in GOLD
              • Condition and Rule Parser
                • Cast operations in GOLD
                  • Assignment Hierarchy
                • Gold Operators
                  • Arithmetic Operators
                  • Comparison Operators
                  • Logical Operators
            • Manager task history
              • Operations in the History tab
            • Module Task Configuration
              • Module selection
              • Module mapping
              • Module variables
              • Module computation
            • Task options controllers
              • Standard task working modes
              • Control elements in standard tasks
              • Attribute interface interactions
        • Import Tasks
          • Import from File
          • Import from Database
          • Import from Rulex Platform
          • Create a Dataset from Scratch
            • Conditional Import
              • The Options tab
              • The Advanced tab
              • Example
            • Empty Source
              • The Options tab
              • Example
            • Import File Info
              • The Options tab
              • The output dataset
              • Example
            • Import from Azure Table
              • The Options tab
              • Example
            • Import from Database
              • The Options tab
              • Example
            • Import from Excel File
              • The Options tab
              • The Sheets tab
              • The Excel Configuration tab
              • Example
            • Import from JSON File
              • The Options tab
              • The Json Configuration tab
              • Example
            • Import from Parquet File
              • The Options tab
              • The Parquet Configuration tab
              • Example
            • Import from PDF File
              • The Options tab
              • The PDF Configuration tab
              • Example
            • Import from Task
              • The Options tab
              • Example
            • Import from Text File
              • The Options tab
              • The Text Configuration tab
              • Example
            • Import from Word File
              • The Options tab
              • The Word Configuration tab
              • Example
            • Import from XML File
              • The Options tab
              • The Xml Configuration tab
              • Example
            • Rulex Flow File Source
              • The Options tab
              • The Configuration tab
              • Example
        • Export Tasks
          • Export to File
          • Export to Database
            • Export to Azure Table
              • The Options tab
              • Example
            • Export to Database
              • The Options Tab
              • The Advanced tab
              • Example
            • Export to Excel File
              • The Options tab
              • The Export Options tab
              • Example
            • Export to JSON File
              • The Options tab
              • The Export Options tab
              • Example
            • Export to Parquet File
              • The Options tab
              • The Export Options tab
              • Example
            • Export to PDF File
              • The Options tab
              • The Export Options tab
              • Example
            • Export to Text File
              • The Options tab
              • The Export Options tab
              • Example
            • Export to Word File
              • The Options tab
              • The Export Options tab
              • Example
            • Export to XML File
              • The Options Tab
              • The Export Options tab
              • Example
        • Visualization and editing tasks
          • The Data Manager
            • The Attribute List
            • The main Data pane
            • The Modeling Sets bar
              • The Attribute List
                • Feature properties
                • Selecting main data columns
                • Attribute context menu
                • Dragging and dropping attributes
                • Centering an attribute
                  • Attribute dialogs
                    • Editing an attribute
                    • Moving an attribute
                    • Splitting a nominal attribute
              • The Data tab
                • Executing a formula
                  • Bulk editing attributes’ headers with the $names parameters
                  • Searching for a text
                • The main spreadsheet
                  • Index column context menu
                  • Header column context menu
                  • Main grid context menu
                  • Editing a cell
                • The Query panel
                • The Info bar
                  • Executing queries
                    • Filter query
                      • Condition panels
                      • Condition context menu
                    • Group query
                    • Apply query
                    • Sort query
                      • Condition panel for date/time attributes
                        • Defining a value condition
                        • Defining an attribute condition
                        • Defining a code condition
                      • Condition panel for nominal attributes
                        • Defining a value condition
                        • Defining an attribute condition
                        • Defining a code condition
                      • Condition panel for ordered attributes
                        • Defining a value condition
                        • Defining an attribute condition
                        • Defining a code condition
                      • Condition panel for time attributes
                        • Defining a value condition
                        • Defining an attribute condition
                        • Defining a code condition
                  • Data Manager functions
                    • Common operators in formulas
                    • Searching for a desired function
                      • Array functions
                        • enum
                        • fillDown
                        • fillLinear
                        • fillUp
                        • integer
                        • len
                        • matchHeaders
                        • nominal
                        • perm
                        • rank
                        • shift
                      • Data Functions
                        • cast
                        • catNames
                        • decideType
                        • disc
                        • discEqualFrequency
                        • discEqualWidth
                        • discretize
                        • isAttribute
                        • isFloat
                        • isType
                        • type
                      • Date/Time functions
                        • addMonth
                        • addQuarter
                        • addWorkingDays
                        • addYear
                        • currDate
                        • currDatetime
                        • date
                        • datetime
                        • day
                        • hour
                        • isDate
                        • isDatetime
                        • isMonth
                        • isQuarter
                        • isTime
                        • isWeek
                        • minute
                        • month
                        • quarter
                        • second
                        • time
                        • timeZone
                        • week
                        • weekDay
                        • year
                      • Graph functions
                        • connComp
                        • leaf
                        • leafDistance
                        • root
                        • rootDistance
                      • Logical functions
                        • ifelse
                        • ifNone
                      • Math and trigonometric functions
                        • abs
                        • acos
                        • acosh
                        • asin
                        • asinh
                        • atan
                        • atanh
                        • baseConv
                        • ceil
                        • cos
                        • cosh
                        • cumProd
                        • cumSum
                        • exp
                        • floor
                        • isInteger
                        • log
                        • log10
                        • prod
                        • rand
                        • randGauss
                        • round
                        • sign
                        • sin
                        • sinh
                        • sqrt
                        • sum
                        • tan
                        • tanh
                      • Null functions
                        • breakLoop
                        • errorGold
                        • warningGold
                        • multiplyRows
                      • Statistical functions
                        • anovap
                        • anovat
                        • argMax
                        • argMin
                        • chisquare
                        • chisquarep
                        • cohenk
                        • count
                        • countIf
                        • covariance
                        • cumMax
                        • cumMin
                        • distinct
                        • entropy
                        • fact
                        • gini
                        • inIqr
                        • max
                        • max2
                        • maxyoudencut
                        • mean
                        • median
                        • min
                        • min2
                        • mode
                        • movMean
                        • pearson
                        • quantile
                        • roc
                        • std
                        • variance
                      • System functions
                        • hostName
                        • ipAddress
                      • Text functions
                        • charReplace
                        • distance
                        • find
                        • head
                        • isPrefix
                        • isSuffix
                        • isWord
                        • numExt
                        • pad
                        • phonetic
                        • prefix
                        • replace
                        • strip
                        • suffix
                        • tail
                        • textConcat
                        • textDecode
                        • textEncode
                        • textExtract
                        • textFormat
                        • textLen
                        • textLower
                        • textSort
                        • textUpper
                  • The Attributes tab
                    • Executing bulk operations on attributes
                  • Styling dataset columns
                    • Column style panel
                    • Conditional formatting panel
              • The Plots tab
                • Exporting a plot page
                  • Single Plot Configuration
                    • Plot input menu
                    • Plot dimension type
                    • Plot modebar
                    • Plot context menu
                    • Updating Plots after query operations
                      • Changing the Plot Layout
                        • Plot layout tab
                        • Axis layout tab
                        • Legend layout tab
                      • Dimension option menus
                        • Plot option menu
                        • X options
                        • Y options
                        • Color options
                        • Style options
                        • Size options
                      • Input attributes in Plot
                        • Attribute context menu
                  • Vertical and Horizontal Bar Plots
                    • Plot option menu add-ons
                    • Horizontal bar plot
                  • Box Plot
                  • Curve Plot
                    • Plot option menu add-ons
                    • Y dimension menu add-ons
                  • Heat Map
                  • Pie and Doughnut Plots
                    • Doughnut Plot
                  • Scatter Plot
                    • Size dimension menu add-ons
                  • Statistical Plots
                    • P-P plot
                    • Q-Q plot
                    • Lorenz Curve
                    • ROC Curve
              • The Sheets tab
                • Executing a sheet formula
                • The Sheets panel
                  • Index column context menu
                  • Header column context menu
                  • Main grid context menu
                  • Editing a cell
                • The Statistic panel
                  • Evaluating statistics
                    • Input areas
                    • Statistics area
                    • Sheet area
                  • Statistics configuration panels
                    • Single statistics
                    • Values, frequencies and quantiles
                    • Correlation/Covariance
                    • Cross tabulation statistics
                    • ROC Curve
                    • Test for independent samples
                    • Test for paired samples
          • File Manager
            • The Files tab
            • The History tab
            • Example
            • Example - moving emails in Outlook
          • The Rule Manager
            • The Rules tab
            • Configuring a new condition
              • Filtering and sorting rules
                • Operations panel
                • The Rules attributes list
        • Pre-Processing tasks
          • Tasks layout
            • Concatenate
              • The Options tab
              • Example
            • Discretize
              • The Options tab
              • The Monitor tab
              • The Results tab
              • Example
            • Fill Clean
              • The Fill tab
              • The Clean tab
              • Example
            • Join
              • The source attributes section
              • The Matching attributes for joining dataset section
              • Example
            • Moving Window
              • The Basic tab
              • The Advanced tab
              • Example
            • Principal Component Analysis
              • The Options tab
              • The Results tab
            • Reshape to Long
              • The Options tab
              • Example
            • Reshape to Wide
              • The Options tab
              • Example
            • Transpose
              • The Options tab
              • Example
        • Classification tasks
          • Supervised learning
          • Classification tasks layout
            • Decision Tree
              • The Options tab
              • The Monitor tab
              • The Results tab
              • Example
            • K-Nearest Neighbor
              • The Options tab
              • The Points tab
              • The Results tab
              • Example
            • Logic Learning Machine
              • The Options tab
              • The Monitor tab
              • The Results tab
              • Example
            • Logistic
              • The Options tab
              • The Coefficients tab
              • The Results tab
              • Example
            • Neural Networks
              • The Options tab
              • The Monitor tab
              • The Weights tab
              • The Results tab
              • Example
            • SVM
              • The Options tab
              • The Monitor tab
              • The Results tab
              • Example
        • One-class tasks
          • One-class Logic Learning Machine
            • The Options tab
            • The Monitor tab
            • The Results tab
            • Example
        • Clustering tasks
          • Clustering tasks layout
            • Label Clustering (k-means)
              • The Options tab
              • The Monitor tab
              • The Clusters tab
              • The Results tab
              • Example
            • Projection clustering
              • The Options tab
              • The Monitor tab
              • The Clusters tab
              • The Results tab
              • Example
            • Standard Clustering
              • The Options tab
              • The Monitor tab
              • The Clusters tab
              • The Results tab
              • Example
        • Regression tasks
          • Supervised learning
          • Regression tasks layout
            • Auto Regressive
              • The Options tab
              • Models tab
              • Results tab
              • Example
            • K-Nearest Neighbor Regression
              • The Options tab
              • The Points tab
              • The Results tab
              • Example
            • Linear
              • The Options tab
              • The Coefficients tab
              • The Results tab
              • Example
            • Logic Learning Machine Regression
              • The Options tab
              • The Monitor tab
              • The Results tab
              • Example
            • Neural Networks Regression
              • The Options tab
              • The Monitor tab
              • The Weights tab
              • The Results tab
              • Example
            • Regression SVM
              • The Options tab
              • The Monitor tab
              • The Results tab
              • Example
            • Regression Tree
              • The Options tab
              • The Monitor tab
              • The Results tab
              • Example
        • Optimization tasks
          • Tasks layout
            • Build and Solve
              • The Options tab
              • The constraints configuration file
              • Example
            • Mixed Integer Linear Programming
              • The Options tab
              • The Solutions tab
              • The Results tab
              • Example - Normal table mode
              • Example - Sparse table mode
            • Network Optimizer
              • The Options tab
              • The Results tab
              • Example
            • Transport Optimizer
              • The Options tab
              • The Results tab
              • Example
        • Association tasks
          • Unsupervised learning
          • Association tasks layout
            • Anomaly Detection
              • The Options tab
              • The Compressed frequent sequences tab
              • The Results tab
              • Example
            • Assortment Optimizer
              • The Options tab
              • The Replacement rules tab
              • The Results tab
              • Example
            • Frequent Itemsets Mining
              • The Options tab
              • The Frequent itemsets tab
              • The Results tab
              • Example
            • Hierarchical Basket Analysis
              • The Options tab
              • The Association rules tab
              • The Results tab
              • Example
            • Sequence Analysis
              • The Options tab
              • The Frequent sequences tab
              • The Results tab
              • Example
            • Similar Items Detector
              • The Options tab
              • The Replacement rules tab
              • The Results tab
        • Evaluation tasks
          • Evaluation tasks layout
            • Confusion Matrix
              • Confusion Matrix layout
              • Example
            • Feature Ranking
              • Feature Ranking layout
              • Example
            • Rule Viewer
              • Rule Viewer layout
              • Example
        • General tasks
          • Structures Management
          • Modeling sets management
          • Automation of flow computation
          • Management and application of rules
            • Apply Model
              • The Options tab
              • The Results tab
              • Example
            • Check Dataset
              • The Options tab
              • The output dataset
              • Example
            • Convert Dataset to Model
              • Example
            • Convert Dataset to Ruleset
              • The Options tab
              • Example
            • Convert Dataset to Structure
              • The Options tab
              • Example
            • Convert Model to Dataset
              • Example
            • Convert Ruleset to Dataset
              • The Options tab
              • Example
            • Convert Structure to Dataset
              • The Options tab
              • Example
            • Execute Rulex Flow File
              • Task layout
              • Example
            • Export Current Flow
              • The Options tab
              • Example
            • Merge Rules
              • The Options tab
              • Example
            • Optimize Ruleset
              • The Options tab
              • The Monitor tab
              • The Results tab
              • Example
            • Runtime Variables
              • The Options tab
              • Example
            • Select Flows
              • The Options tab
              • Example
            • Split Data
              • The Options tab
              • Example
        • Control tasks
          • Tasks layout
            • Rule Based Control
              • The Options tab
              • Results produced by the task
              • Example
            • Rule Engine
              • The Options tab
              • The configuration file
              • The output file
              • Example
        • Bridge tasks
          • Bridge tasks layout
        • Data Structures
          • Dataset
          • Rules
          • Models
          • Results
          • Other dataset-like data structures