Class ExecuteScript
- java.lang.Object
-
- com.zerog.ia.auto.project.ProjectObject
-
- com.zerog.ia.auto.project.InstallableObject
-
- com.zerog.ia.auto.project.actions.Action
-
- com.zerog.ia.auto.project.actions.ExecuteScript
-
- All Implemented Interfaces:
DBHostable
,GeneralAction
,JEEHostable
,OSHostable
,Referenceable
public final class ExecuteScript extends Action implements GeneralAction
Executes a script or batch file on the target system. When this action runs, it first resolves any InstallAnywhere variables in the script. It then saves the script to the InstallAnywhere temp directory and executes the script. The action finishes by cleaning up and deleting the script from the temp directory.
-
-
Constructor Summary
Constructors Constructor Description ExecuteScript()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getComment()
The comment that describes the function of the script or batch file.java.lang.String
getDialogLabel()
The message to be displayed in the indeterminate dialog.java.lang.String
getExitCodeVar()
The name of the variable to store exit codes.boolean
getPleaseWaitConsole()
Whether to show Please Wait panel in console mode during the execution of the scriptjava.lang.String
getScript()
The script to run.boolean
getShowIndeterminateDialog()
Whether to show an indeterminate dialog during the execution of the script and to show the message you define calling setDialogLabel (Default: Executing Installation Script...).boolean
getShowPleaseWaitPanel()
Whether to show the "Please wait..." panel while installing the action.java.lang.String
getStderrVar()
The name of the variable to store script's stderr.java.lang.String
getStdoutVar()
The name of the variable to store script's stdout.java.lang.String
getTitle()
The title that describes the function of the script or batch file.boolean
getWaitForProcess()
Whether to halt the installer until the script or batch file processes complete.boolean
isSubstituteUnknownVariable()
Whether to substitute unknown variables or not.void
setComment(java.lang.String comment)
Defines a comment that describes the function of the script or batch file.void
setDialogLabel(java.lang.String label)
The message to be displayed in the indeterminate dialog.void
setExitCodeVar(java.lang.String exitCodeVar)
The name of the variable to store exit codes.void
setPleaseWaitConsole(boolean show)
Whether to show Please Wait panel in console mode during the execution of the scriptvoid
setScript(java.lang.String script)
The script to run.
Tip: Start your script with acd
command to establish the directory from which the script will run.void
setShowIndeterminateDialog(boolean show)
Whether to show an indeterminate dialog during the execution of the script and to show the message you define calling setDialogLabel (Default: Executing Installation Script...).void
setShowPleaseWaitPanel(boolean showPleaseWaitPanel)
Whether to show the "Please wait..." panel while installing the action.void
setStderrVar(java.lang.String stderrVar)
The name of the variable to store script's stderr.void
setStdoutVar(java.lang.String stdoutVar)
The name of the variable to store script's stdout.void
setSubstituteUnknownVariable(boolean substituteUnknownVariable)
Whether to substitute unknown variables or not.void
setTitle(java.lang.String title)
The title that describes the function of the script or batch file.void
setWaitForProcess(boolean waitForProcess)
Whether to halt the installer until the script or batch file processes complete.-
Methods inherited from class com.zerog.ia.auto.project.InstallableObject
getBelongsToUninstallPhase, getRollbackEnabledCancel, getRollbackEnabledError, getRuleExpression, getRules, getRulesLogicalOperation, getTagsInInstallPiece, setBelongsToUninstallPhase, setRollbackEnabledCancel, setRollbackEnabledError, setRuleExpression, setRulesLogicalOperation, setTagsInInstallPiece
-
Methods inherited from class com.zerog.ia.auto.project.ProjectObject
equals, getReferenceID, hashCode, setReferenceID
-
-
-
-
Method Detail
-
getStdoutVar
public java.lang.String getStdoutVar()
The name of the variable to store script's stdout.
-
setStdoutVar
public void setStdoutVar(java.lang.String stdoutVar)
The name of the variable to store script's stdout. Default: $EXECUTE_STDOUT$.
-
getStderrVar
public java.lang.String getStderrVar()
The name of the variable to store script's stderr.
-
setStderrVar
public void setStderrVar(java.lang.String stderrVar)
The name of the variable to store script's stderr. Default: $EXECUTE_STDERR$.
-
getExitCodeVar
public java.lang.String getExitCodeVar()
The name of the variable to store exit codes.
-
setExitCodeVar
public void setExitCodeVar(java.lang.String exitCodeVar)
The name of the variable to store exit codes. Default: $EXECUTE_EXITCODE$.
-
getWaitForProcess
public boolean getWaitForProcess()
Whether to halt the installer until the script or batch file processes complete.
-
setWaitForProcess
public void setWaitForProcess(boolean waitForProcess)
Whether to halt the installer until the script or batch file processes complete.
-
setShowPleaseWaitPanel
public void setShowPleaseWaitPanel(boolean showPleaseWaitPanel)
Whether to show the "Please wait..." panel while installing the action.
-
getShowPleaseWaitPanel
public boolean getShowPleaseWaitPanel()
Whether to show the "Please wait..." panel while installing the action.
-
getScript
public java.lang.String getScript()
The script to run.
-
setScript
public void setScript(java.lang.String script)
The script to run.
Tip: Start your script with acd
command to establish the directory from which the script will run. By default, scripts and batch files are run in a temp directory.
-
getComment
public java.lang.String getComment()
The comment that describes the function of the script or batch file.
-
setComment
public void setComment(java.lang.String comment)
Defines a comment that describes the function of the script or batch file.
-
setShowIndeterminateDialog
public void setShowIndeterminateDialog(boolean show)
Whether to show an indeterminate dialog during the execution of the script and to show the message you define calling setDialogLabel (Default: Executing Installation Script...).
-
getShowIndeterminateDialog
public boolean getShowIndeterminateDialog()
Whether to show an indeterminate dialog during the execution of the script and to show the message you define calling setDialogLabel (Default: Executing Installation Script...).
-
setPleaseWaitConsole
public void setPleaseWaitConsole(boolean show)
Whether to show Please Wait panel in console mode during the execution of the script
-
getPleaseWaitConsole
public boolean getPleaseWaitConsole()
Whether to show Please Wait panel in console mode during the execution of the script
-
setDialogLabel
public void setDialogLabel(java.lang.String label)
The message to be displayed in the indeterminate dialog. (default: Executing Installation Script...)- See Also:
setShowIndeterminateDialog(boolean)
-
getDialogLabel
public java.lang.String getDialogLabel()
The message to be displayed in the indeterminate dialog.- See Also:
setShowIndeterminateDialog(boolean)
-
isSubstituteUnknownVariable
public boolean isSubstituteUnknownVariable()
Whether to substitute unknown variables or not.
-
setSubstituteUnknownVariable
public void setSubstituteUnknownVariable(boolean substituteUnknownVariable)
Whether to substitute unknown variables or not.
-
getTitle
public java.lang.String getTitle()
The title that describes the function of the script or batch file.
-
setTitle
public void setTitle(java.lang.String title)
The title that describes the function of the script or batch file.
-
-