Octobox API  4.1.0
Octobox Scripting API
Data Fields | Properties
ScriptBase

Base class for all script classes. More...

Inheritance diagram for ScriptBase:
ActivityConditionScriptBase ActivityPluginBase ActivityScriptBase BatchSplittingScriptBase ClassificationScriptBase ConversionScriptBase ExtractionScriptBase FieldFormatterScriptBase FileImportScriptBase FileInsertionDownloadScriptBase LocatorScriptBase RulePatternScriptBase ValidationRuleScriptBase ValidationScriptBase ZoneSelectionScriptBase

Data Fields

Action< string > LogInfo
 Write text to the Octobox logging at information level. More...
 
Action< string > LogMsg
 Write text to the Octobox logging at normal level. More...
 

Properties

SCProcess Batch [get, set]
 Batch object containing global values available to all scripts. More...
 
CancellationToken CancellationToken [get, set]
 Cancellation token that can be checked for process cancellation on long running script actions. More...
 
SourceApplications SourceApplication [get, set]
 Application that called this function. More...
 

Detailed Description

Base class for all script classes.

Field Documentation

◆ LogInfo

Action<string> LogInfo

Write text to the Octobox logging at information level.

◆ LogMsg

Action<string> LogMsg

Write text to the Octobox logging at normal level.

Property Documentation

◆ Batch

SCProcess Batch
getset

Batch object containing global values available to all scripts.

◆ CancellationToken

CancellationToken CancellationToken
getset

Cancellation token that can be checked for process cancellation on long running script actions.

◆ SourceApplication

SourceApplications SourceApplication
getset

Application that called this function.