RuleSession

Parameters:

entityName

Type: string

The name of the Entity to create

boundValue

Type: object

An optional JavaScript object that contains data that the Entity will be bound to, if null an empty object is bound.

Description:

Creates and returns an Entity of the specified name and bound to the provided value

Code Sample:

var session = inrule.createRuleSession(); 
var boundValue = { "FirstName" : "John" };
var entity = session.createEntity("Entity1", boundValue);

Parameters:

ruleSetName

Type: string

The name of the RuleSet to create

arguments

Type: Array of objects

An Array of values to pass to the RuleSet. The values are bound to the arguments by ordinal positioning. If an argument is Entity, the value passed to it will be used as the Entity's bound value. If the RuleSet does not have parameters, pass an empty array.

callback

Type: function(log)

A JavaScript function accepting a RuleExecutionLog object as its parameter

Description:

Executes the Independent Rule Set with the specified name. If arguments are provided they are passed to the Independent Rule Set.

Code Sample:

var session = inrule.createRuleSession(); 
session.executeIndependentRuleSet("RuleSet1", [1, "value"], 
function(log){
   // Code that checks the Execution Log
});

Parameters:

ruleSetName

Type: string

The name of the RuleSet to create

Description:

Creates and returns a RuleSet

Code Sample:

var session = inrule.createRuleSession();
var ruleSet = session.createIndependentRuleSet("RuleSet1");

Code Sample:

var session = inrule.createRuleSession(); 
session.createEntity("Entity1");
var entities = session.getEntities();
var entityCount = entities.length; // entityCount is now 1

Parameters:

callback

Type: function(log)

A JavaScript function accepting a RuleExecutionLog object as its parameter

Description:

Applies all Auto Single-Pass Sequential Rule Sets and evaluates all Calculated Fields against all Entities in the current RuleSession. The callback provided is invoked upon completion of rule execution.

If an error occurs during rule exection, the hasErrors property on the RuleExecutionLog will return True. Error details can be accessed via the runtimeErrors Array.

Code Sample:

var session = inrule.createRuleSession(); 
session.createEntity("Entity1"); 
session.applyRules(function(log){
   // Code that checks the Execution Log
});

Code Sample:

var session = inrule.createRuleSession(); 
session.createEntity("Entity1"); 
// Assuming Entity1 has a Rule Set that fires 1 Notification
session.applyRules(function(log){
   var notifications = session.getActiveNotifications();
   var notificationCount = notifications.length; // notificationCount is now 1
});

Code Sample:

var session = inrule.createRuleSession(); 
session.createEntity("Entity1"); 
// Assuming Entity1 has a Rule Set that sets 1 Field invalid
session.applyRules(function(log){
   var validations = session.getActiveValidations();
   var validationCount = validations.length; // validationCount is now
1
});

Parameters:

date

Type: Date

A Date object representing the date/time used for the Today() and Now() syntax functions

Description:

Sets the value of the date/time to use for the Today() and Now() syntax functions during rule execution. If not set, new Date() will be used when rules execute.

Code Sample:

var session = inrule.createRuleSession(); 
session.setNow(new Date(1995, 5, 1);

Code Sample:

var session = inrule.createRuleSession(); 
session.createEntity("Entity1"); 
session.applyRules(function(log){
   // The parameter log is a reference to session.executionLog
});

Code Sample:

var session = inrule.createRuleSession();
var myTable = session.dataManager.getInlineTable("MyTable");

Code Sample:

var session = inrule.createRuleSession();
var displayName = session.metadata.displayName;