IScriptProvider

Overview

The IScriptProvider interface provides access to functionality required to execute the Business Rules Scripting scripts. This interface exposes a set of properties and event handlers that are used by the Data Abstract for .NET to call appropriate event handlers defined in the Business Rules Scripting scripts.

The IScriptProvider interface is implemented by the EcmaScriptProvider class.

Location


 

AfterCommit

This method is called after a transaction (set of insert/update/delete operations) has been committed.

 

method AfterCommit

 

void AfterCommit()

 

func AfterCommit()

 

Sub AfterCommit()

AfterExecuteCommand

This method is called after an sql command is executed.

 

method AfterExecuteCommand(sql: String; commandName: String; parameters: array of DataParameter; rowsAffected: Int32)

 

void AfterExecuteCommand(String sql, String commandName, DataParameter[] parameters, Int32 rowsAffected)

 

func AfterExecuteCommand(_ sql: String, _ commandName: String, _ parameters: DataParameter..., _ rowsAffected: Int32)

 

Sub AfterExecuteCommand(sql As String, commandName As String, parameters As DataParameter(), rowsAffected As Int32)

Parameters:

  • sql: Executed command SQL statement
  • commandName: Executed command name
  • parameters: Set of command parameters
  • rowsAffected: Number of rows affected by the command execution

AfterGetData

This method is called after data is retireved from database.

 

method AfterGetData(tables: array of String; requestInfo: array of TableRequestInfo)

 

void AfterGetData(String[] tables, TableRequestInfo[] requestInfo)

 

func AfterGetData(_ tables: String..., _ requestInfo: TableRequestInfo...)

 

Sub AfterGetData(tables As String(), requestInfo As TableRequestInfo())

Parameters:

  • tables: Table names
  • requestInfo: Corresponding TableRequestInfo instances. These instances contain additional request parameters

AfterLogin

This method is called after the user has logged in.

Relativity Server only.

 

method AfterLogin

 

void AfterLogin()

 

func AfterLogin()

 

Sub AfterLogin()

AfterProcessDelta

This method is called on database updates, after processing of each Delta instance

 

method AfterProcessDelta(delta: Delta)

 

void AfterProcessDelta(Delta delta)

 

func AfterProcessDelta(_ delta: Delta)

 

Sub AfterProcessDelta(delta As Delta)

Parameters:

  • delta: Processed Delta instance

AfterProcessDeltaChange

This method is called on database updates, after processing of each DeltaChange instance.

 

method AfterProcessDeltaChange(delta: Delta; change: DeltaChange; refreshed: Boolean)

 

void AfterProcessDeltaChange(Delta delta, DeltaChange change, Boolean refreshed)

 

func AfterProcessDeltaChange(_ delta: Delta, _ change: DeltaChange, _ refreshed: Boolean)

 

Sub AfterProcessDeltaChange(delta As Delta, change As DeltaChange, refreshed As Boolean)

Parameters:

  • delta: Processed Delta instance
  • change: Processed DeltaChange instance
  • refreshed: Flag indicating wheter the data was re-read from the database server after update. This operation is required to obtain values of server-calculated fields

AfterRollback

This method if called after a transactions is rolled back (canceled).

 

method AfterRollback

 

void AfterRollback()

 

func AfterRollback()

 

Sub AfterRollback()

BeforeCommit

This method is called before a transaction is committed.

 

method BeforeCommit

 

void BeforeCommit()

 

func BeforeCommit()

 

Sub BeforeCommit()

BeforeDelete

This method is called when a data row is going to be deleted.

 

method BeforeDelete(row: IRowHelper)

 

void BeforeDelete(IRowHelper row)

 

func BeforeDelete(_ row: IRowHelper)

 

Sub BeforeDelete(row As IRowHelper)

Parameters:

  • row: Data row being deleted

BeforeExecuteCommand

This method is called before an sql command is executed.

 

method BeforeExecuteCommand(sql: String; commandName: String; parameters: array of DataParameter)

 

void BeforeExecuteCommand(String sql, String commandName, DataParameter[] parameters)

 

func BeforeExecuteCommand(_ sql: String, _ commandName: String, _ parameters: DataParameter...)

 

Sub BeforeExecuteCommand(sql As String, commandName As String, parameters As DataParameter())

Parameters:

  • sql: Command SQL statement
  • commandName: Command name
  • parameters: Set of command parameters

BeforeGetData

This method is called before data is retireved from database.

 

method BeforeGetData(tables: array of String; requestInfo: array of TableRequestInfo)

 

void BeforeGetData(String[] tables, TableRequestInfo[] requestInfo)

 

func BeforeGetData(_ tables: String..., _ requestInfo: TableRequestInfo...)

 

Sub BeforeGetData(tables As String(), requestInfo As TableRequestInfo())

Parameters:

  • tables: Table names
  • requestInfo: Corresponding TableRequestInfo instances. These instances contain additional request parameters

BeforeLogout

This method is called before the user has logged out.

Relativity Server only.

 

method BeforeLogout

 

void BeforeLogout()

 

func BeforeLogout()

 

Sub BeforeLogout()

BeforePost

This method is called when a data row is going to be updated.

 

method BeforePost(row: IRowHelper)

 

void BeforePost(IRowHelper row)

 

func BeforePost(_ row: IRowHelper)

 

Sub BeforePost(row As IRowHelper)

Parameters:

  • row: Data row being updated

BeforeProcessDelta

This method is called on database updates, before processing of each Delta instance.

 

method BeforeProcessDelta(delta: Delta)

 

void BeforeProcessDelta(Delta delta)

 

func BeforeProcessDelta(_ delta: Delta)

 

Sub BeforeProcessDelta(delta As Delta)

Parameters:

  • delta: Delta instance to process

BeforeProcessDeltaChange

This method is called on database updates, before processing of each DeltaChange instance.

 

method BeforeProcessDeltaChange(delta: Delta; change: DeltaChange; refreshed: Boolean; var canRemove: Boolean)

 

void BeforeProcessDeltaChange(Delta delta, DeltaChange change, Boolean refreshed, ref Boolean canRemove)

 

func BeforeProcessDeltaChange(_ delta: Delta, _ change: DeltaChange, _ refreshed: Boolean, _ canRemove: inout Boolean)

 

Sub BeforeProcessDeltaChange(delta As Delta, change As DeltaChange, refreshed As Boolean, ByRef canRemove As Boolean)

Parameters:

  • delta: Delta instance to process
  • change: DeltaChange instance to process
  • refreshed: Reserved
  • canRemove: Flag indicating wheter the current deltachange can be removed from its parent Delta after is is successfully processed

BeforeRollback

This method is called before a transaction is rolled back (canceled).

 

method BeforeRollback

 

void BeforeRollback()

 

func BeforeRollback()

 

Sub BeforeRollback()

Clear

Clears all internal caches of the script provide and resets its state.

 

method Clear

 

void Clear()

 

func Clear()

 

Sub Clear()

ClearScriptCache

Clears the script cache.

For performance reasons Script Provider caches precompiled scripts for Schema entities. Is the server Schema is changed then this cache should be cleared to avoind possible inconsistencies.

 

method ClearScriptCache

 

void ClearScriptCache()

 

func ClearScriptCache()

 

Sub ClearScriptCache()

Context

Gets or sets the current script provider context.

 

property Context: IScriptContext read write;

 

IScriptContext Context { get; set; }

 

var Context: IScriptContext { get{} set{} }

 

Property Context() As IScriptContext

Continue    (declared in IScriptDebugProvider)

Continues script execution after it has been paused.

 

method Continue

 

void Continue()

 

func Continue()

 

Sub Continue()

CreateTransaction

This method is called when a new transaction is created to fetch or update records.

 

method CreateTransaction

 

void CreateTransaction()

 

func CreateTransaction()

 

Sub CreateTransaction()

Debug

Gets or seta a flag indicating whether script is executed in Debug mode.

 

property Debug: Boolean read write;

 

Boolean Debug { get; set; }

 

var Debug: Boolean { get{} set{} }

 

Property Debug() As Boolean

DebugFrameEnter    (declared in IScriptDebugProvider)

This event is raised when new script scope (for example script method) is entered.

 

event DebugFrameEnter: EventHandler<ScriptFrameEnterEventArgs>

 

delegate EventHandler<ScriptFrameEnterEventArgs> DebugFrameEnter()

 

__event EventHandler<ScriptFrameEnterEventArgs>: DebugFrameEnter!

 

Event DebugFrameEnter As EventHandler<ScriptFrameEnterEventArgs>

DebugFrameExit    (declared in IScriptDebugProvider)

This event is raised when current script scope (for example script method) is exited.

 

event DebugFrameExit: EventHandler<ScriptFrameExitEventArgs>

 

delegate EventHandler<ScriptFrameExitEventArgs> DebugFrameExit()

 

__event EventHandler<ScriptFrameExitEventArgs>: DebugFrameExit!

 

Event DebugFrameExit As EventHandler<ScriptFrameExitEventArgs>

DebugLog    (declared in IScriptDebugProvider)

This event is raised when the script method log is executed.

 

event DebugLog: EventHandler<ScriptLogEventArgs>

 

delegate EventHandler<ScriptLogEventArgs> DebugLog()

 

__event EventHandler<ScriptLogEventArgs>: DebugLog!

 

Event DebugLog As EventHandler<ScriptLogEventArgs>

DebugMode    (declared in IScriptDebugProvider)

Gets or sets the current debugger mode. Available debug modes are

{| class="dashed-table" style="width: 100%" ! style="width: 30% " |

Debug Mode
! style="width: 70% " |
Description
|- | None | No debug info is provided. This is the recommended mode for production servers due to its performance. |- | Continuous | Full debug info is generated. Script execution performance is degraded significantly. Script execution pauses only on the stop keyword or when an unhandled exception occurrs. |- | Step By Step | Script execution pauses after each script line execution. |- |}

 

property DebugMode: ScriptDebugMode read write;

 

ScriptDebugMode DebugMode { get; set; }

 

var DebugMode: ScriptDebugMode { get{} set{} }

 

Property DebugMode() As ScriptDebugMode

DebugTracePoint    (declared in IScriptDebugProvider)

This event is raised on every script line execution.

 

event DebugTracePoint: EventHandler<ScriptTracePointEventArgs>

 

delegate EventHandler<ScriptTracePointEventArgs> DebugTracePoint()

 

__event EventHandler<ScriptTracePointEventArgs>: DebugTracePoint!

 

Event DebugTracePoint As EventHandler<ScriptTracePointEventArgs>

DebugUnhandledException    (declared in IScriptDebugProvider)

This event is raised when an unhandled exception occurs during the script execution.

 

event DebugUnhandledException: EventHandler<ScriptUnhandledExceptionEventArgs>

 

delegate EventHandler<ScriptUnhandledExceptionEventArgs> DebugUnhandledException()

 

__event EventHandler<ScriptUnhandledExceptionEventArgs>: DebugUnhandledException!

 

Event DebugUnhandledException As EventHandler<ScriptUnhandledExceptionEventArgs>

DoLogin

Reserved.

 

method DoLogin(parameters: IDictionary): Boolean

 

Boolean DoLogin(IDictionary parameters)

 

func DoLogin(_ parameters: IDictionary) -> Boolean

 

Function DoLogin(parameters As IDictionary) As Boolean

Parameters:

  • parameters: Reserved

DoLogout

Reserved.

 

method DoLogout

 

void DoLogout()

 

func DoLogout()

 

Sub DoLogout()

HasAfterCommit

Returns true if the AfterCommit script function is defined.

 

property HasAfterCommit: Boolean read;

 

Boolean HasAfterCommit { get; }

 

var HasAfterCommit: Boolean { get{} }

 

ReadOnly Property HasAfterCommit() As Boolean

HasAfterExecuteCommand

Returns true if the AfterExecuteCommand script function is defined.

 

property HasAfterExecuteCommand: Boolean read;

 

Boolean HasAfterExecuteCommand { get; }

 

var HasAfterExecuteCommand: Boolean { get{} }

 

ReadOnly Property HasAfterExecuteCommand() As Boolean

HasAfterGetData

Returns true if the AfterGetData script function is defined.

 

property HasAfterGetData: Boolean read;

 

Boolean HasAfterGetData { get; }

 

var HasAfterGetData: Boolean { get{} }

 

ReadOnly Property HasAfterGetData() As Boolean

HasAfterLogin

Returns true if the AfterLogin script function is defined.

 

property HasAfterLogin: Boolean read;

 

Boolean HasAfterLogin { get; }

 

var HasAfterLogin: Boolean { get{} }

 

ReadOnly Property HasAfterLogin() As Boolean

HasAfterProcessDelta

Returns true if the AfterProcessDelta script function is defined.

 

property HasAfterProcessDelta: Boolean read;

 

Boolean HasAfterProcessDelta { get; }

 

var HasAfterProcessDelta: Boolean { get{} }

 

ReadOnly Property HasAfterProcessDelta() As Boolean

HasAfterProcessDeltaChange

Returns true if the AfterProcessDeltaChange script function is defined.

 

property HasAfterProcessDeltaChange: Boolean read;

 

Boolean HasAfterProcessDeltaChange { get; }

 

var HasAfterProcessDeltaChange: Boolean { get{} }

 

ReadOnly Property HasAfterProcessDeltaChange() As Boolean

HasAfterRollback

Returns true if the AfterRollback script function is defined.

 

property HasAfterRollback: Boolean read;

 

Boolean HasAfterRollback { get; }

 

var HasAfterRollback: Boolean { get{} }

 

ReadOnly Property HasAfterRollback() As Boolean

HasBeforeCommit

Returns true if the BeforeCommit script function is defined.

 

property HasBeforeCommit: Boolean read;

 

Boolean HasBeforeCommit { get; }

 

var HasBeforeCommit: Boolean { get{} }

 

ReadOnly Property HasBeforeCommit() As Boolean

HasBeforeDelete

Returns true if the BeforeDelete script function is defined for the Schema table tableName.

 

property HasBeforeDelete[tableName: String]: Boolean read;

 

Boolean HasBeforeDelete[String tableName] { get; }

 

subscript HasBeforeDelete(_ tableName: String) -> Boolean { get{} }

 

ReadOnly Property HasBeforeDelete(tableName As String) As Boolean

HasBeforeExecuteCommand

Returns true if the BeforeExecuteCommand script function is defined.

 

property HasBeforeExecuteCommand: Boolean read;

 

Boolean HasBeforeExecuteCommand { get; }

 

var HasBeforeExecuteCommand: Boolean { get{} }

 

ReadOnly Property HasBeforeExecuteCommand() As Boolean

HasBeforeGetData

Returns true if the BeforeGetData script function is defined.

 

property HasBeforeGetData: Boolean read;

 

Boolean HasBeforeGetData { get; }

 

var HasBeforeGetData: Boolean { get{} }

 

ReadOnly Property HasBeforeGetData() As Boolean

HasBeforeLogout

Returns true if the BeforeLogout script function is defined.

 

property HasBeforeLogout: Boolean read;

 

Boolean HasBeforeLogout { get; }

 

var HasBeforeLogout: Boolean { get{} }

 

ReadOnly Property HasBeforeLogout() As Boolean

HasBeforePost

Returns true if the BeforePost script function is defined for the Schema table tableName.

 

property HasBeforePost[tableName: String]: Boolean read;

 

Boolean HasBeforePost[String tableName] { get; }

 

subscript HasBeforePost(_ tableName: String) -> Boolean { get{} }

 

ReadOnly Property HasBeforePost(tableName As String) As Boolean

HasBeforeProcessDelta

Returns true if the BeforeProcessDelta script function is defined.

 

property HasBeforeProcessDelta: Boolean read;

 

Boolean HasBeforeProcessDelta { get; }

 

var HasBeforeProcessDelta: Boolean { get{} }

 

ReadOnly Property HasBeforeProcessDelta() As Boolean

HasBeforeProcessDeltaChange

Returns true if the BeforeProcessDeltaChange script function is defined.

 

property HasBeforeProcessDeltaChange: Boolean read;

 

Boolean HasBeforeProcessDeltaChange { get; }

 

var HasBeforeProcessDeltaChange: Boolean { get{} }

 

ReadOnly Property HasBeforeProcessDeltaChange() As Boolean

HasBeforeRollback

Returns true if the BeforeRollback script function is defined.

 

property HasBeforeRollback: Boolean read;

 

Boolean HasBeforeRollback { get; }

 

var HasBeforeRollback: Boolean { get{} }

 

ReadOnly Property HasBeforeRollback() As Boolean

HasCreateTransaction

Returns true if the CreateTransaction script function is defined.

 

property HasCreateTransaction: Boolean read;

 

Boolean HasCreateTransaction { get; }

 

var HasCreateTransaction: Boolean { get{} }

 

ReadOnly Property HasCreateTransaction() As Boolean

HasDoLogin

Reserved

 

property HasDoLogin: Boolean read;

 

Boolean HasDoLogin { get; }

 

var HasDoLogin: Boolean { get{} }

 

ReadOnly Property HasDoLogin() As Boolean

HasDoLogout

Reserved

 

property HasDoLogout: Boolean read;

 

Boolean HasDoLogout { get; }

 

var HasDoLogout: Boolean { get{} }

 

ReadOnly Property HasDoLogout() As Boolean

HasOnNewRow

Returns true if the OnNewRow script function is defined for the Schema table tableName.

 

property HasOnNewRow[tableName: String]: Boolean read;

 

Boolean HasOnNewRow[String tableName] { get; }

 

subscript HasOnNewRow(_ tableName: String) -> Boolean { get{} }

 

ReadOnly Property HasOnNewRow(tableName As String) As Boolean

HasProcessError

Returns true if the ProcessError script function is defined.

 

property HasProcessError: Boolean read;

 

Boolean HasProcessError { get; }

 

var HasProcessError: Boolean { get{} }

 

ReadOnly Property HasProcessError() As Boolean

HasUnknownSqlMacroIdentifier

Returns true if the onUnknownSqlMacroIdentifier script function is defined.

 

property HasUnknownSqlMacroIdentifier: Boolean read;

 

Boolean HasUnknownSqlMacroIdentifier { get; }

 

var HasUnknownSqlMacroIdentifier: Boolean { get{} }

 

ReadOnly Property HasUnknownSqlMacroIdentifier() As Boolean

HasValidateCommandAccess

Returns true if the ValidateCommandAccess script function is defined.

 

property HasValidateCommandAccess: Boolean read;

 

Boolean HasValidateCommandAccess { get; }

 

var HasValidateCommandAccess: Boolean { get{} }

 

ReadOnly Property HasValidateCommandAccess() As Boolean

HasValidateDataTableAccess

Returns true if the ValidateDataTableAccess script function is defined.

 

property HasValidateDataTableAccess: Boolean read;

 

Boolean HasValidateDataTableAccess { get; }

 

var HasValidateDataTableAccess: Boolean { get{} }

 

ReadOnly Property HasValidateDataTableAccess() As Boolean

HasValidateDirectSQLAccess

Returns true if the ValidateDirectSQLAccess script function is defined.

 

property HasValidateDirectSQLAccess: Boolean read;

 

Boolean HasValidateDirectSQLAccess { get; }

 

var HasValidateDirectSQLAccess: Boolean { get{} }

 

ReadOnly Property HasValidateDirectSQLAccess() As Boolean

LoadScript

Loads and precompiles provided script source.

 

method LoadScript(script: String)

 

void LoadScript(String script)

 

func LoadScript(_ script: String)

 

Sub LoadScript(script As String)

Parameters:

  • script: Script source code

OnNewRow

Called when creating new rows. Can be used to pre-initialize new records data.

 

method OnNewRow(row: IRowHelper)

 

void OnNewRow(IRowHelper row)

 

func OnNewRow(_ row: IRowHelper)

 

Sub OnNewRow(row As IRowHelper)

Parameters:

  • row: New data row

ProcessError

This method is called when an error occurs during applying data changes to the database.

This method should return either the current value of the canContinue argument or false to break the Delta processing and roll back the transaction.

 

method ProcessError(delta: Delta; change: DeltaChange; var canContinue: Boolean; var error: Exception)

 

void ProcessError(Delta delta, DeltaChange change, ref Boolean canContinue, ref Exception error)

 

func ProcessError(_ delta: Delta, _ change: DeltaChange, _ canContinue: inout Boolean, _ error: inout Exception)

 

Sub ProcessError(delta As Delta, change As DeltaChange, ByRef canContinue As Boolean, ByRef error As Exception)

Parameters:

  • delta: Delta instance containing failed data change
  • change: DeltaChange instance that cannot be applied to the database
  • canContinue: Flag indicating wthether Data Abstract should process other DeltaChange instances instead of rolling back the transaction immediately
  • error: Exception raised by the data change attempt

ScriptName

Gets or sets current script name.

Script name is used by the Script Debugger to identify the script source.

 

property ScriptName: String read write;

 

String ScriptName { get; set; }

 

var ScriptName: String { get{} set{} }

 

Property ScriptName() As String

StepInto    (declared in IScriptDebugProvider)

Steps into a method.

 

method StepInto

 

void StepInto()

 

func StepInto()

 

Sub StepInto()

StepOut    (declared in IScriptDebugProvider)

Steps out from the current script method. Script execution will be paused again after workflow exit from the current script.

 

method StepOut

 

void StepOut()

 

func StepOut()

 

Sub StepOut()

StepOver    (declared in IScriptDebugProvider)

Steps over the current script line.

 

method StepOver

 

void StepOver()

 

func StepOver()

 

Sub StepOver()

Stop    (declared in IScriptDebugProvider)

Breaks script execution.

 

method Stop

 

void Stop()

 

func Stop()

 

Sub Stop()

SupportsLanguage

Returns true if provided language is supported by the current Script Provider.

 

method SupportsLanguage(languageName: String): Boolean

 

Boolean SupportsLanguage(String languageName)

 

func SupportsLanguage(_ languageName: String) -> Boolean

 

Function SupportsLanguage(languageName As String) As Boolean

Parameters:

  • languageName: Script language name

UnknownSqlMacroIdentifier

This method is called when an unknown macro is found in the SQL statement processed by Data Abstract.

 

method UnknownSqlMacroIdentifier(identifier: String; var value: String)

 

void UnknownSqlMacroIdentifier(String identifier, ref String value)

 

func UnknownSqlMacroIdentifier(_ identifier: String, _ value: inout String)

 

Sub UnknownSqlMacroIdentifier(identifier As String, ByRef value As String)

Parameters:

  • identifier: Macro identifier
  • value: Macro value

ValidateCommandAccess

This method is called before a SQL command is executed.

Returns true if command execution is allowed.

 

method ValidateCommandAccess(commandName: String; parameterNames: array of String; parameterValues: array of Object; var isAllowed: Boolean)

 

void ValidateCommandAccess(String commandName, String[] parameterNames, Object[] parameterValues, ref Boolean isAllowed)

 

func ValidateCommandAccess(_ commandName: String, _ parameterNames: String..., _ parameterValues: Object..., _ isAllowed: inout Boolean)

 

Sub ValidateCommandAccess(commandName As String, parameterNames As String(), parameterValues As Object(), ByRef isAllowed As Boolean)

Parameters:

  • commandName: Command name
  • parameterNames: Command parameter names
  • parameterValues: Command parameter values
  • isAllowed: Flag indicating whether command execution is allowed

ValidateDataTableAccess

This method is called when data request is validated.

Returns true if access to the data table is allowed.

 

method ValidateDataTableAccess(tableName: String; parameterNames: array of String; parameterValues: array of Object; var isAllowed: Boolean)

 

void ValidateDataTableAccess(String tableName, String[] parameterNames, Object[] parameterValues, ref Boolean isAllowed)

 

func ValidateDataTableAccess(_ tableName: String, _ parameterNames: String..., _ parameterValues: Object..., _ isAllowed: inout Boolean)

 

Sub ValidateDataTableAccess(tableName As String, parameterNames As String(), parameterValues As Object(), ByRef isAllowed As Boolean)

Parameters:

  • tableName: Table name
  • parameterNames: Command parameter names
  • parameterValues: Command parameter values
  • isAllowed: Flag indicating whether data access is allowed

ValidateDirectSQLAccess

This method is called when a raw SQL statement sent by client application is executed.

 

method ValidateDirectSQLAccess(sql: String; parameterNames: array of String; parameterValues: array of Object; var isAllowed: Boolean)

 

void ValidateDirectSQLAccess(String sql, String[] parameterNames, Object[] parameterValues, ref Boolean isAllowed)

 

func ValidateDirectSQLAccess(_ sql: String, _ parameterNames: String..., _ parameterValues: Object..., _ isAllowed: inout Boolean)

 

Sub ValidateDirectSQLAccess(sql As String, parameterNames As String(), parameterValues As Object(), ByRef isAllowed As Boolean)

Parameters:

  • sql: SQL statement
  • parameterNames: Command parameter names
  • parameterValues: Command parameter values
  • isAllowed: Flag indicating whether SQL statement execution is allowed

 

Context

Gets or sets the current script provider context.

 

property Context: IScriptContext read write;

 

IScriptContext Context { get; set; }

 

var Context: IScriptContext { get{} set{} }

 

Property Context() As IScriptContext

Debug

Gets or seta a flag indicating whether script is executed in Debug mode.

 

property Debug: Boolean read write;

 

Boolean Debug { get; set; }

 

var Debug: Boolean { get{} set{} }

 

Property Debug() As Boolean

DebugMode    (declared in IScriptDebugProvider)

Gets or sets the current debugger mode. Available debug modes are

{| class="dashed-table" style="width: 100%" ! style="width: 30% " |

Debug Mode
! style="width: 70% " |
Description
|- | None | No debug info is provided. This is the recommended mode for production servers due to its performance. |- | Continuous | Full debug info is generated. Script execution performance is degraded significantly. Script execution pauses only on the stop keyword or when an unhandled exception occurrs. |- | Step By Step | Script execution pauses after each script line execution. |- |}

 

property DebugMode: ScriptDebugMode read write;

 

ScriptDebugMode DebugMode { get; set; }

 

var DebugMode: ScriptDebugMode { get{} set{} }

 

Property DebugMode() As ScriptDebugMode

HasAfterCommit

Returns true if the AfterCommit script function is defined.

 

property HasAfterCommit: Boolean read;

 

Boolean HasAfterCommit { get; }

 

var HasAfterCommit: Boolean { get{} }

 

ReadOnly Property HasAfterCommit() As Boolean

HasAfterExecuteCommand

Returns true if the AfterExecuteCommand script function is defined.

 

property HasAfterExecuteCommand: Boolean read;

 

Boolean HasAfterExecuteCommand { get; }

 

var HasAfterExecuteCommand: Boolean { get{} }

 

ReadOnly Property HasAfterExecuteCommand() As Boolean

HasAfterGetData

Returns true if the AfterGetData script function is defined.

 

property HasAfterGetData: Boolean read;

 

Boolean HasAfterGetData { get; }

 

var HasAfterGetData: Boolean { get{} }

 

ReadOnly Property HasAfterGetData() As Boolean

HasAfterLogin

Returns true if the AfterLogin script function is defined.

 

property HasAfterLogin: Boolean read;

 

Boolean HasAfterLogin { get; }

 

var HasAfterLogin: Boolean { get{} }

 

ReadOnly Property HasAfterLogin() As Boolean

HasAfterProcessDelta

Returns true if the AfterProcessDelta script function is defined.

 

property HasAfterProcessDelta: Boolean read;

 

Boolean HasAfterProcessDelta { get; }

 

var HasAfterProcessDelta: Boolean { get{} }

 

ReadOnly Property HasAfterProcessDelta() As Boolean

HasAfterProcessDeltaChange

Returns true if the AfterProcessDeltaChange script function is defined.

 

property HasAfterProcessDeltaChange: Boolean read;

 

Boolean HasAfterProcessDeltaChange { get; }

 

var HasAfterProcessDeltaChange: Boolean { get{} }

 

ReadOnly Property HasAfterProcessDeltaChange() As Boolean

HasAfterRollback

Returns true if the AfterRollback script function is defined.

 

property HasAfterRollback: Boolean read;

 

Boolean HasAfterRollback { get; }

 

var HasAfterRollback: Boolean { get{} }

 

ReadOnly Property HasAfterRollback() As Boolean

HasBeforeCommit

Returns true if the BeforeCommit script function is defined.

 

property HasBeforeCommit: Boolean read;

 

Boolean HasBeforeCommit { get; }

 

var HasBeforeCommit: Boolean { get{} }

 

ReadOnly Property HasBeforeCommit() As Boolean

HasBeforeDelete

Returns true if the BeforeDelete script function is defined for the Schema table tableName.

 

property HasBeforeDelete[tableName: String]: Boolean read;

 

Boolean HasBeforeDelete[String tableName] { get; }

 

subscript HasBeforeDelete(_ tableName: String) -> Boolean { get{} }

 

ReadOnly Property HasBeforeDelete(tableName As String) As Boolean

HasBeforeExecuteCommand

Returns true if the BeforeExecuteCommand script function is defined.

 

property HasBeforeExecuteCommand: Boolean read;

 

Boolean HasBeforeExecuteCommand { get; }

 

var HasBeforeExecuteCommand: Boolean { get{} }

 

ReadOnly Property HasBeforeExecuteCommand() As Boolean

HasBeforeGetData

Returns true if the BeforeGetData script function is defined.

 

property HasBeforeGetData: Boolean read;

 

Boolean HasBeforeGetData { get; }

 

var HasBeforeGetData: Boolean { get{} }

 

ReadOnly Property HasBeforeGetData() As Boolean

HasBeforeLogout

Returns true if the BeforeLogout script function is defined.

 

property HasBeforeLogout: Boolean read;

 

Boolean HasBeforeLogout { get; }

 

var HasBeforeLogout: Boolean { get{} }

 

ReadOnly Property HasBeforeLogout() As Boolean

HasBeforePost

Returns true if the BeforePost script function is defined for the Schema table tableName.

 

property HasBeforePost[tableName: String]: Boolean read;

 

Boolean HasBeforePost[String tableName] { get; }

 

subscript HasBeforePost(_ tableName: String) -> Boolean { get{} }

 

ReadOnly Property HasBeforePost(tableName As String) As Boolean

HasBeforeProcessDelta

Returns true if the BeforeProcessDelta script function is defined.

 

property HasBeforeProcessDelta: Boolean read;

 

Boolean HasBeforeProcessDelta { get; }

 

var HasBeforeProcessDelta: Boolean { get{} }

 

ReadOnly Property HasBeforeProcessDelta() As Boolean

HasBeforeProcessDeltaChange

Returns true if the BeforeProcessDeltaChange script function is defined.

 

property HasBeforeProcessDeltaChange: Boolean read;

 

Boolean HasBeforeProcessDeltaChange { get; }

 

var HasBeforeProcessDeltaChange: Boolean { get{} }

 

ReadOnly Property HasBeforeProcessDeltaChange() As Boolean

HasBeforeRollback

Returns true if the BeforeRollback script function is defined.

 

property HasBeforeRollback: Boolean read;

 

Boolean HasBeforeRollback { get; }

 

var HasBeforeRollback: Boolean { get{} }

 

ReadOnly Property HasBeforeRollback() As Boolean

HasCreateTransaction

Returns true if the CreateTransaction script function is defined.

 

property HasCreateTransaction: Boolean read;

 

Boolean HasCreateTransaction { get; }

 

var HasCreateTransaction: Boolean { get{} }

 

ReadOnly Property HasCreateTransaction() As Boolean

HasDoLogin

Reserved

 

property HasDoLogin: Boolean read;

 

Boolean HasDoLogin { get; }

 

var HasDoLogin: Boolean { get{} }

 

ReadOnly Property HasDoLogin() As Boolean

HasDoLogout

Reserved

 

property HasDoLogout: Boolean read;

 

Boolean HasDoLogout { get; }

 

var HasDoLogout: Boolean { get{} }

 

ReadOnly Property HasDoLogout() As Boolean

HasOnNewRow

Returns true if the OnNewRow script function is defined for the Schema table tableName.

 

property HasOnNewRow[tableName: String]: Boolean read;

 

Boolean HasOnNewRow[String tableName] { get; }

 

subscript HasOnNewRow(_ tableName: String) -> Boolean { get{} }

 

ReadOnly Property HasOnNewRow(tableName As String) As Boolean

HasProcessError

Returns true if the ProcessError script function is defined.

 

property HasProcessError: Boolean read;

 

Boolean HasProcessError { get; }

 

var HasProcessError: Boolean { get{} }

 

ReadOnly Property HasProcessError() As Boolean

HasUnknownSqlMacroIdentifier

Returns true if the onUnknownSqlMacroIdentifier script function is defined.

 

property HasUnknownSqlMacroIdentifier: Boolean read;

 

Boolean HasUnknownSqlMacroIdentifier { get; }

 

var HasUnknownSqlMacroIdentifier: Boolean { get{} }

 

ReadOnly Property HasUnknownSqlMacroIdentifier() As Boolean

HasValidateCommandAccess

Returns true if the ValidateCommandAccess script function is defined.

 

property HasValidateCommandAccess: Boolean read;

 

Boolean HasValidateCommandAccess { get; }

 

var HasValidateCommandAccess: Boolean { get{} }

 

ReadOnly Property HasValidateCommandAccess() As Boolean

HasValidateDataTableAccess

Returns true if the ValidateDataTableAccess script function is defined.

 

property HasValidateDataTableAccess: Boolean read;

 

Boolean HasValidateDataTableAccess { get; }

 

var HasValidateDataTableAccess: Boolean { get{} }

 

ReadOnly Property HasValidateDataTableAccess() As Boolean

HasValidateDirectSQLAccess

Returns true if the ValidateDirectSQLAccess script function is defined.

 

property HasValidateDirectSQLAccess: Boolean read;

 

Boolean HasValidateDirectSQLAccess { get; }

 

var HasValidateDirectSQLAccess: Boolean { get{} }

 

ReadOnly Property HasValidateDirectSQLAccess() As Boolean

ScriptName

Gets or sets current script name.

Script name is used by the Script Debugger to identify the script source.

 

property ScriptName: String read write;

 

String ScriptName { get; set; }

 

var ScriptName: String { get{} set{} }

 

Property ScriptName() As String

 

AfterCommit

This method is called after a transaction (set of insert/update/delete operations) has been committed.

 

method AfterCommit

 

void AfterCommit()

 

func AfterCommit()

 

Sub AfterCommit()

AfterExecuteCommand

This method is called after an sql command is executed.

 

method AfterExecuteCommand(sql: String; commandName: String; parameters: array of DataParameter; rowsAffected: Int32)

 

void AfterExecuteCommand(String sql, String commandName, DataParameter[] parameters, Int32 rowsAffected)

 

func AfterExecuteCommand(_ sql: String, _ commandName: String, _ parameters: DataParameter..., _ rowsAffected: Int32)

 

Sub AfterExecuteCommand(sql As String, commandName As String, parameters As DataParameter(), rowsAffected As Int32)

Parameters:

  • sql: Executed command SQL statement
  • commandName: Executed command name
  • parameters: Set of command parameters
  • rowsAffected: Number of rows affected by the command execution

AfterGetData

This method is called after data is retireved from database.

 

method AfterGetData(tables: array of String; requestInfo: array of TableRequestInfo)

 

void AfterGetData(String[] tables, TableRequestInfo[] requestInfo)

 

func AfterGetData(_ tables: String..., _ requestInfo: TableRequestInfo...)

 

Sub AfterGetData(tables As String(), requestInfo As TableRequestInfo())

Parameters:

  • tables: Table names
  • requestInfo: Corresponding TableRequestInfo instances. These instances contain additional request parameters

AfterLogin

This method is called after the user has logged in.

Relativity Server only.

 

method AfterLogin

 

void AfterLogin()

 

func AfterLogin()

 

Sub AfterLogin()

AfterProcessDelta

This method is called on database updates, after processing of each Delta instance

 

method AfterProcessDelta(delta: Delta)

 

void AfterProcessDelta(Delta delta)

 

func AfterProcessDelta(_ delta: Delta)

 

Sub AfterProcessDelta(delta As Delta)

Parameters:

  • delta: Processed Delta instance

AfterProcessDeltaChange

This method is called on database updates, after processing of each DeltaChange instance.

 

method AfterProcessDeltaChange(delta: Delta; change: DeltaChange; refreshed: Boolean)

 

void AfterProcessDeltaChange(Delta delta, DeltaChange change, Boolean refreshed)

 

func AfterProcessDeltaChange(_ delta: Delta, _ change: DeltaChange, _ refreshed: Boolean)

 

Sub AfterProcessDeltaChange(delta As Delta, change As DeltaChange, refreshed As Boolean)

Parameters:

  • delta: Processed Delta instance
  • change: Processed DeltaChange instance
  • refreshed: Flag indicating wheter the data was re-read from the database server after update. This operation is required to obtain values of server-calculated fields

AfterRollback

This method if called after a transactions is rolled back (canceled).

 

method AfterRollback

 

void AfterRollback()

 

func AfterRollback()

 

Sub AfterRollback()

BeforeCommit

This method is called before a transaction is committed.

 

method BeforeCommit

 

void BeforeCommit()

 

func BeforeCommit()

 

Sub BeforeCommit()

BeforeDelete

This method is called when a data row is going to be deleted.

 

method BeforeDelete(row: IRowHelper)

 

void BeforeDelete(IRowHelper row)

 

func BeforeDelete(_ row: IRowHelper)

 

Sub BeforeDelete(row As IRowHelper)

Parameters:

  • row: Data row being deleted

BeforeExecuteCommand

This method is called before an sql command is executed.

 

method BeforeExecuteCommand(sql: String; commandName: String; parameters: array of DataParameter)

 

void BeforeExecuteCommand(String sql, String commandName, DataParameter[] parameters)

 

func BeforeExecuteCommand(_ sql: String, _ commandName: String, _ parameters: DataParameter...)

 

Sub BeforeExecuteCommand(sql As String, commandName As String, parameters As DataParameter())

Parameters:

  • sql: Command SQL statement
  • commandName: Command name
  • parameters: Set of command parameters

BeforeGetData

This method is called before data is retireved from database.

 

method BeforeGetData(tables: array of String; requestInfo: array of TableRequestInfo)

 

void BeforeGetData(String[] tables, TableRequestInfo[] requestInfo)

 

func BeforeGetData(_ tables: String..., _ requestInfo: TableRequestInfo...)

 

Sub BeforeGetData(tables As String(), requestInfo As TableRequestInfo())

Parameters:

  • tables: Table names
  • requestInfo: Corresponding TableRequestInfo instances. These instances contain additional request parameters

BeforeLogout

This method is called before the user has logged out.

Relativity Server only.

 

method BeforeLogout

 

void BeforeLogout()

 

func BeforeLogout()

 

Sub BeforeLogout()

BeforePost

This method is called when a data row is going to be updated.

 

method BeforePost(row: IRowHelper)

 

void BeforePost(IRowHelper row)

 

func BeforePost(_ row: IRowHelper)

 

Sub BeforePost(row As IRowHelper)

Parameters:

  • row: Data row being updated

BeforeProcessDelta

This method is called on database updates, before processing of each Delta instance.

 

method BeforeProcessDelta(delta: Delta)

 

void BeforeProcessDelta(Delta delta)

 

func BeforeProcessDelta(_ delta: Delta)

 

Sub BeforeProcessDelta(delta As Delta)

Parameters:

  • delta: Delta instance to process

BeforeProcessDeltaChange

This method is called on database updates, before processing of each DeltaChange instance.

 

method BeforeProcessDeltaChange(delta: Delta; change: DeltaChange; refreshed: Boolean; var canRemove: Boolean)

 

void BeforeProcessDeltaChange(Delta delta, DeltaChange change, Boolean refreshed, ref Boolean canRemove)

 

func BeforeProcessDeltaChange(_ delta: Delta, _ change: DeltaChange, _ refreshed: Boolean, _ canRemove: inout Boolean)

 

Sub BeforeProcessDeltaChange(delta As Delta, change As DeltaChange, refreshed As Boolean, ByRef canRemove As Boolean)

Parameters:

  • delta: Delta instance to process
  • change: DeltaChange instance to process
  • refreshed: Reserved
  • canRemove: Flag indicating wheter the current deltachange can be removed from its parent Delta after is is successfully processed

BeforeRollback

This method is called before a transaction is rolled back (canceled).

 

method BeforeRollback

 

void BeforeRollback()

 

func BeforeRollback()

 

Sub BeforeRollback()

Clear

Clears all internal caches of the script provide and resets its state.

 

method Clear

 

void Clear()

 

func Clear()

 

Sub Clear()

ClearScriptCache

Clears the script cache.

For performance reasons Script Provider caches precompiled scripts for Schema entities. Is the server Schema is changed then this cache should be cleared to avoind possible inconsistencies.

 

method ClearScriptCache

 

void ClearScriptCache()

 

func ClearScriptCache()

 

Sub ClearScriptCache()

Continue    (declared in IScriptDebugProvider)

Continues script execution after it has been paused.

 

method Continue

 

void Continue()

 

func Continue()

 

Sub Continue()

CreateTransaction

This method is called when a new transaction is created to fetch or update records.

 

method CreateTransaction

 

void CreateTransaction()

 

func CreateTransaction()

 

Sub CreateTransaction()

DoLogin

Reserved.

 

method DoLogin(parameters: IDictionary): Boolean

 

Boolean DoLogin(IDictionary parameters)

 

func DoLogin(_ parameters: IDictionary) -> Boolean

 

Function DoLogin(parameters As IDictionary) As Boolean

Parameters:

  • parameters: Reserved

DoLogout

Reserved.

 

method DoLogout

 

void DoLogout()

 

func DoLogout()

 

Sub DoLogout()

LoadScript

Loads and precompiles provided script source.

 

method LoadScript(script: String)

 

void LoadScript(String script)

 

func LoadScript(_ script: String)

 

Sub LoadScript(script As String)

Parameters:

  • script: Script source code

OnNewRow

Called when creating new rows. Can be used to pre-initialize new records data.

 

method OnNewRow(row: IRowHelper)

 

void OnNewRow(IRowHelper row)

 

func OnNewRow(_ row: IRowHelper)

 

Sub OnNewRow(row As IRowHelper)

Parameters:

  • row: New data row

ProcessError

This method is called when an error occurs during applying data changes to the database.

This method should return either the current value of the canContinue argument or false to break the Delta processing and roll back the transaction.

 

method ProcessError(delta: Delta; change: DeltaChange; var canContinue: Boolean; var error: Exception)

 

void ProcessError(Delta delta, DeltaChange change, ref Boolean canContinue, ref Exception error)

 

func ProcessError(_ delta: Delta, _ change: DeltaChange, _ canContinue: inout Boolean, _ error: inout Exception)

 

Sub ProcessError(delta As Delta, change As DeltaChange, ByRef canContinue As Boolean, ByRef error As Exception)

Parameters:

  • delta: Delta instance containing failed data change
  • change: DeltaChange instance that cannot be applied to the database
  • canContinue: Flag indicating wthether Data Abstract should process other DeltaChange instances instead of rolling back the transaction immediately
  • error: Exception raised by the data change attempt

StepInto    (declared in IScriptDebugProvider)

Steps into a method.

 

method StepInto

 

void StepInto()

 

func StepInto()

 

Sub StepInto()

StepOut    (declared in IScriptDebugProvider)

Steps out from the current script method. Script execution will be paused again after workflow exit from the current script.

 

method StepOut

 

void StepOut()

 

func StepOut()

 

Sub StepOut()

StepOver    (declared in IScriptDebugProvider)

Steps over the current script line.

 

method StepOver

 

void StepOver()

 

func StepOver()

 

Sub StepOver()

Stop    (declared in IScriptDebugProvider)

Breaks script execution.

 

method Stop

 

void Stop()

 

func Stop()

 

Sub Stop()

SupportsLanguage

Returns true if provided language is supported by the current Script Provider.

 

method SupportsLanguage(languageName: String): Boolean

 

Boolean SupportsLanguage(String languageName)

 

func SupportsLanguage(_ languageName: String) -> Boolean

 

Function SupportsLanguage(languageName As String) As Boolean

Parameters:

  • languageName: Script language name

UnknownSqlMacroIdentifier

This method is called when an unknown macro is found in the SQL statement processed by Data Abstract.

 

method UnknownSqlMacroIdentifier(identifier: String; var value: String)

 

void UnknownSqlMacroIdentifier(String identifier, ref String value)

 

func UnknownSqlMacroIdentifier(_ identifier: String, _ value: inout String)

 

Sub UnknownSqlMacroIdentifier(identifier As String, ByRef value As String)

Parameters:

  • identifier: Macro identifier
  • value: Macro value

ValidateCommandAccess

This method is called before a SQL command is executed.

Returns true if command execution is allowed.

 

method ValidateCommandAccess(commandName: String; parameterNames: array of String; parameterValues: array of Object; var isAllowed: Boolean)

 

void ValidateCommandAccess(String commandName, String[] parameterNames, Object[] parameterValues, ref Boolean isAllowed)

 

func ValidateCommandAccess(_ commandName: String, _ parameterNames: String..., _ parameterValues: Object..., _ isAllowed: inout Boolean)

 

Sub ValidateCommandAccess(commandName As String, parameterNames As String(), parameterValues As Object(), ByRef isAllowed As Boolean)

Parameters:

  • commandName: Command name
  • parameterNames: Command parameter names
  • parameterValues: Command parameter values
  • isAllowed: Flag indicating whether command execution is allowed

ValidateDataTableAccess

This method is called when data request is validated.

Returns true if access to the data table is allowed.

 

method ValidateDataTableAccess(tableName: String; parameterNames: array of String; parameterValues: array of Object; var isAllowed: Boolean)

 

void ValidateDataTableAccess(String tableName, String[] parameterNames, Object[] parameterValues, ref Boolean isAllowed)

 

func ValidateDataTableAccess(_ tableName: String, _ parameterNames: String..., _ parameterValues: Object..., _ isAllowed: inout Boolean)

 

Sub ValidateDataTableAccess(tableName As String, parameterNames As String(), parameterValues As Object(), ByRef isAllowed As Boolean)

Parameters:

  • tableName: Table name
  • parameterNames: Command parameter names
  • parameterValues: Command parameter values
  • isAllowed: Flag indicating whether data access is allowed

ValidateDirectSQLAccess

This method is called when a raw SQL statement sent by client application is executed.

 

method ValidateDirectSQLAccess(sql: String; parameterNames: array of String; parameterValues: array of Object; var isAllowed: Boolean)

 

void ValidateDirectSQLAccess(String sql, String[] parameterNames, Object[] parameterValues, ref Boolean isAllowed)

 

func ValidateDirectSQLAccess(_ sql: String, _ parameterNames: String..., _ parameterValues: Object..., _ isAllowed: inout Boolean)

 

Sub ValidateDirectSQLAccess(sql As String, parameterNames As String(), parameterValues As Object(), ByRef isAllowed As Boolean)

Parameters:

  • sql: SQL statement
  • parameterNames: Command parameter names
  • parameterValues: Command parameter values
  • isAllowed: Flag indicating whether SQL statement execution is allowed

 

DebugFrameEnter    (declared in IScriptDebugProvider)

This event is raised when new script scope (for example script method) is entered.

 

event DebugFrameEnter: EventHandler<ScriptFrameEnterEventArgs>

 

delegate EventHandler<ScriptFrameEnterEventArgs> DebugFrameEnter()

 

__event EventHandler<ScriptFrameEnterEventArgs>: DebugFrameEnter!

 

Event DebugFrameEnter As EventHandler<ScriptFrameEnterEventArgs>

DebugFrameExit    (declared in IScriptDebugProvider)

This event is raised when current script scope (for example script method) is exited.

 

event DebugFrameExit: EventHandler<ScriptFrameExitEventArgs>

 

delegate EventHandler<ScriptFrameExitEventArgs> DebugFrameExit()

 

__event EventHandler<ScriptFrameExitEventArgs>: DebugFrameExit!

 

Event DebugFrameExit As EventHandler<ScriptFrameExitEventArgs>

DebugLog    (declared in IScriptDebugProvider)

This event is raised when the script method log is executed.

 

event DebugLog: EventHandler<ScriptLogEventArgs>

 

delegate EventHandler<ScriptLogEventArgs> DebugLog()

 

__event EventHandler<ScriptLogEventArgs>: DebugLog!

 

Event DebugLog As EventHandler<ScriptLogEventArgs>

DebugTracePoint    (declared in IScriptDebugProvider)

This event is raised on every script line execution.

 

event DebugTracePoint: EventHandler<ScriptTracePointEventArgs>

 

delegate EventHandler<ScriptTracePointEventArgs> DebugTracePoint()

 

__event EventHandler<ScriptTracePointEventArgs>: DebugTracePoint!

 

Event DebugTracePoint As EventHandler<ScriptTracePointEventArgs>

DebugUnhandledException    (declared in IScriptDebugProvider)

This event is raised when an unhandled exception occurs during the script execution.

 

event DebugUnhandledException: EventHandler<ScriptUnhandledExceptionEventArgs>

 

delegate EventHandler<ScriptUnhandledExceptionEventArgs> DebugUnhandledException()

 

__event EventHandler<ScriptUnhandledExceptionEventArgs>: DebugUnhandledException!

 

Event DebugUnhandledException As EventHandler<ScriptUnhandledExceptionEventArgs>