This command is only available to users that hold a Pro License and can be used ONLY in the Tasks section of the project script
The AddTask command allows you to specify a User Section in the script which allows it to be assigned as an optional Task. If one or more of these exist at runtime and you are running a script from the Pipeline Runner Studio project builder and runner tool it will show you a list of tasks defined within the script, and you will be able to deselect any that you do not want to execute when the script is run. If you have a large script, or you have dealt with a failure and only want to run later commands, this could be the perfect solution.
Important: This command can ONLY be used in the Tasks Section of a script and must always be used with an existing User Section. If there is no matching User Section or you try to use the command anywhere else in a script an error will be thrown.
Command Syntax
AddTask:[TaskName],[UserSectionName],[Caption]
The colon after the command is compulsory as are the commas between parameters. Any additional spaces or characters will cause an error to be thrown. The command itself is not case sensitive, but parameters may be depending on the operating system and locale.
Parameters:
TaskName: A name to assign to the task
UserSectionName: The name of the User Section to be assigned as a task
Caption: The text to be shown for this task when the Options are displayed for selection
The TaskName parameter is compulsory, the other two parameters are optional. If any parameter is missing the system will replace it with the TaskName parameter value.
Examples:
Just a single parameter:
[Tasks]
AddTask:PublishInstaller // This will behave as if you had entered AddTask:PublishInstaller,PublishInstaller,PublishInstaller
Specifying all three parameters with slightly different values:
[Tasks]
AddTask:PublishInstallerTask,PublishInstaller,Publish Installer
Note: Because this command can only be actioned via a User Interface it is ONLY available when using Pipeline Runner Studio and is not available when you Run a Script from the Windows Command Line
See Also: Tasks Section