ActiveScript
Packages
Interfaces, Classes and Traits
- CSActiveScript
- CSActiveScriptChart
- Implementation of a special chart type for the active scripts
- CSActiveScriptContext
- A CSActiveScript Context is a contextual situation that a script should run in
- CSActiveScriptFinalizer
- CSActiveScriptGui
- Gui API that provides several functions around the Graphical User Interface
- CSActiveScriptJob
- API Object for the ActiveScriptJob Record
- CSActiveScriptJobInputData
- API Object for the ActiveScriptJob Input that can be passed to a job as further runtime configuration
- CSActiveScriptJobOutputData
- API Object for the ActiveScriptJob Output of a job
- CSActiveScriptLog
- API Object for the ActiveScriptLog Record
- CSActiveScriptLogLink
- API Object for the ActiveScriptLogLink Record
- CSActiveScriptStep
- API Object that encapsulates the most atomic scripting step that must be executed in a unit
- CSActiveScriptStepList
- API Object that collects CSActiveScriptSteps
- CSActiveScriptInstallation
- An Installation Plugin to create default Active Scripts
- CSActiveScriptStudio
- A studio plugin to show the ActiveScript Tree isolated in a plain studio tree
- AdvancedDamSyncScript
- The base of all ActiveScript plugins To be included, it must be placed in a plugins/script subfolder with a file name ending with Script.php.
- DisableDatabaseIndexScript
- Plugin that disables / enables database indices
- FileTransferScriptFinalizer
- Plugin that transfer result links to File Server after a job has been finished
- FtpTransferScriptFinalizer
- Plugin that transfer result links to File Server after a job has been finished
- HelloWorldScript
- The base of all ActiveScript plugins To be included, it must be placed in a plugins/script subfolder with a file name ending with Script.php.
- HousekeepingScript
- The base of all ActiveScript plugins To be included, it must be placed in a plugins/script subfolder with a file name ending with Script.php.
- MamExportScript
- Plugin that exports a configurable set of root folders or volumes
- MamSyncScript
- Plugin that synchronizes a configurable set of root folders or volumes
- MamTransferScriptFinalizer
- Plugin that transfer result links to File Server after a job has been finished
- RunNextScriptFinalizer
- Plugin that runs another script after the first one has finished successfully
- SendMailScriptFinalizer
- Plugin that sends a mail after a job has been finished
- VariantcreatorScript
- The base of all ActiveScript plugins that can be run within a Context To be included, it must be placed in a plugins/script sub folder with a file name ending with Script.php.
- ZipDownloadScriptFinalizer
- Plugin that packs result links to a zip file after a job has been finished and offers a download
- ISAImportScript
- Plugin that Execute ISA Import.
- NotificationSyncScript
- Plugin that syncs the notifications
Table of Contents
- AUTOMATION_SCHEDULE_INTERVAL_DAY = 2
- AUTOMATION_SCHEDULE_INTERVAL_HOUR = 1
- AUTOMATION_SCHEDULE_INTERVAL_MINUTE = 0
- AUTOMATION_SCHEDULE_INTERVAL_MONTH = 3
- AUTOMATION_SCHEDULE_INTERVAL_WEEKDAY = 4
- AUTOMATION_SCHEDULE_INTERVAL_YEAR = 5
- getStateIcon() : mixed
- _getJSToCalculateNextAutomationRunDate() : mixed
- _getRegexForScheduleInterval() : string
- Returns the string with the regex for matching an allowed custom schedule input for the given interval.
- getCategoryFilter() : string
- Returns the category if the list is filtered for one.
Constants
AUTOMATION_SCHEDULE_INTERVAL_DAY
public
mixed
AUTOMATION_SCHEDULE_INTERVAL_DAY
= 2
Tags
AUTOMATION_SCHEDULE_INTERVAL_HOUR
public
mixed
AUTOMATION_SCHEDULE_INTERVAL_HOUR
= 1
Tags
AUTOMATION_SCHEDULE_INTERVAL_MINUTE
public
mixed
AUTOMATION_SCHEDULE_INTERVAL_MINUTE
= 0
Tags
AUTOMATION_SCHEDULE_INTERVAL_MONTH
public
mixed
AUTOMATION_SCHEDULE_INTERVAL_MONTH
= 3
Tags
AUTOMATION_SCHEDULE_INTERVAL_WEEKDAY
public
mixed
AUTOMATION_SCHEDULE_INTERVAL_WEEKDAY
= 4
Tags
AUTOMATION_SCHEDULE_INTERVAL_YEAR
public
mixed
AUTOMATION_SCHEDULE_INTERVAL_YEAR
= 5
Tags
Functions
getStateIcon()
getStateIcon(mixed $row) : mixed
Parameters
- $row : mixed
Tags
Return values
mixed —_getJSToCalculateNextAutomationRunDate()
_getJSToCalculateNextAutomationRunDate(mixed $iActiveScriptId, CSGuiEditor $oEditor[, mixed $bOnChange = true ]) : mixed
Parameters
- $iActiveScriptId : mixed
- $oEditor : CSGuiEditor
- $bOnChange : mixed = true
Tags
Return values
mixed —_getRegexForScheduleInterval()
Returns the string with the regex for matching an allowed custom schedule input for the given interval.
_getRegexForScheduleInterval(mixed $iIntervalUnit) : string
Parameters
- $iIntervalUnit : mixed
Tags
Return values
string —getCategoryFilter()
Returns the category if the list is filtered for one.
getCategoryFilter() : string
Tags
Return values
string —with the category.