System
System actions. For advanced users.
Static properties
appUrl string
Gets the Rulecube application URL.
Methods
alertInfo
alertInfo(name: string, title: string, message: string, alertOptions?: {
}) Creates and triggers an alert with the given message and type 'info'.
Parameters
name string
The name.
title string
The title.
message string
The message.
alertOptions *{
}* (optional) The object containing the alert options.
Return type
void
Examples
alertWarning
alertWarning(name: string, title: string, message: string, alertOptions?: {
}) Creates and triggers an alert with the given message and type 'warning'.
Parameters
name string
The name.
title string
The title.
message string
The message.
alertOptions *{
}* (optional) The object containing the alert options.
Return type
void
Examples
alertError
alertError(name: string, title: string, message: string, alertOptions?: {
}) Creates and triggers an alert with the given message and type 'error'.
Parameters
name string
The name.
title string
The title.
message string
The message.
alertOptions *{
}* (optional) The object containing the alert options.
Return type
void
Examples
alert
alert(alertOptions: {
}) Creates and triggers an alert with the given options object.
Parameters
alertOptions *{
}* The object containing the alert options.
Return type
void
Examples
createEntity
createEntity(entityName: string, constructorObject?: { [key: string]: any; })
Creates an entity based on the name. Chain with .to()
to cast to the proper Entity type.
Parameters
entityName string
The name of the entity.
constructorObject { [key: string]: any; }
(optional) The object to pass as the parameter to the constructor of the entity.
Return type
RuleSetBaseEntity
Examples
setMetricInput
setMetricInput(metricName: string, metricValue: any)
Sets a metric input by name and value. Will overwrite any existing value by the same name. Note that metrics will need to be enabled in the version settings and execution options for this to work.
Parameters
metricName string
The name of the metric.
metricValue any
The value of the metric.
Return type
void
Examples
setMetricOutput
setMetricOutput(metricName: string, metricValue: any)
Sets a metric output by name and value. Will overwrite any existing value by the same name. Note that metrics will need to be enabled in the version settings and execution options for this to work.
Parameters
metricName string
The name of the metric.
metricValue any
The value of the metric.
Return type
void
Examples
setNextInput
setNextInput(inputName: string, nextValue: any)
Instructs the system to use a new value for an input in the next run. Used in combination with System.restart()
.
Parameters
inputName string
The name of the input.
nextValue any
The value of the input in the next run.
Return type
void
Examples
restart
restart()
Instructs the system to run the ruleset again with potentially new input.
Parameters
Return type
void
Examples
stop
stop(message?: string)
Instructs the system to stop ruleset execution.
Parameters
message string
(optional) The message returned by the ruleset as the reason for stopping execution.
Return type
void
Examples
getCulture
getCulture()
Returns the current culture (language).
Parameters
Return type
string
Examples
isTest
isTest()
Returns whether the system is running in test mode. This is true when a Testcase is executed.
Parameters
Return type
boolean
Examples
getTestName
getTestName()
Returns the current Testcase name if any.
Parameters
Return type
string
Examples
getTestCase
getTestCase()
Returns the current Testcase object if any.
Parameters
Return type
{ [key: string]: any; }
Examples
Last updated