Overview Package Class Deprecated Help

script
ControlScript

Defines a control script instance. Note: This object must be configured through the script manager.

public class ControlScript

Properties
isStartingPoint This flag is used to mark scripts which can be starting points of a script execution flow. If this value is false this script can be only invoked as an intermediate step in a script execution flow.

type=boolean
default=false
Displayed(tab/group)=Starting Point
script.AbstractScriptBinding-Set type=Children-Set
script.ControlScriptVersion-Set type=Children-Set
script.TargetScript-Set type=Children-Set
 
Overridden Properties
useLatestVersion This value must be set to true.

default=true
 
Properties inherited from script.AbstractScript
autoSaveResult, bundleId, contentType, mtosi_description, mtosi_id, mtosi_type, nextVersionId, schedule, scheduleTask, scopeOfCommandProfilePointer, scriptMode, scriptName, scriptState, spanObjectPointer, useLatestVersion
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

associateExecutableScript

This method will create an association (binding) between this control script and another script.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName : string - the full name of the object.
associatedObjectPointer : Pointer - Full name of another script..
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
associatedObject : generic.CommonManagedEntityInformation - Returns the object the input parameter 'associatedObjectPointer' is referring to.

associateHandlerScript

This method will create an association (binding) between this control script and either another script.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName : string - the full name of the object.
associatedObjectPointer : Pointer - Full name of another script..
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
associatedObject : generic.CommonManagedEntityInformation - Returns the object the input parameter 'associatedObjectPointer' is referring to.
Methods inherited from script.AbstractScript
changeScriptVersion, configScriptVersion, configureScript, configureTarget, configureTargets, createScriptVersion