Back to Top

AndTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.AndTask
Category Conditionals and Loops

Description

This task works in the same way as logical AND operator. Depending of the values of conditionParameter this task will retrieve result equals to true or false.

Example

In your orchestration you can have two tasks which generate outputParameters. For example one of them is NumberCheckTask which sets ${numberCheckResult1} as true and StringCheckTask which sets ${stringCheckResult1} to false. If you then add to "conditionParameters" task parameter of AndTask values: ${numberCheckResult1} and ${stringCheckResult1} - the ${andOperatorResult} from "resultParameter" task parameter will be set to false because 
                     			TRUE AND FALSE = FALSE

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
conditionParameters java.lang.String   false Condition parameters to be checked. You can specify many conditionParameters.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
resultParameter java.lang.String ${andOperatorResult} false This parameter is a logical AND result of all conditions specified in conditionParameters task parameter.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Fail Job

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.FailTask
Category Conditionals and Loops

Description

This task will just throw an exception with the message you specify. Usually you will use this task with IfTask to be able to stop running job if some condition has not been met.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
errorMessage java.lang.String   true Specify the error message which will be shown in deployment logs. Typically this will be some information about the reason why the job should fail.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

OrTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.OrTask
Category Conditionals and Loops

Description

This task works in the same way as logical OR operator. Depending of the values of conditionParameter this task will retrieve result equals to true or false.

Example

In your orchestration you can have two tasks which generate outputParameters. For example one of them is NumberCheckTask which sets ${numberCheckResult1} as true and StringCheckTask which sets ${stringCheckResult1} to false. If you then add to "conditionParameters" task parameter of OrTask values: ${numberCheckResult1} and ${stringCheckResult1} - the ${orOperatorResult} from "resultParameter" task parameter will be set to true because 
                     			TRUE OR FALSE = TRUE

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
conditionParameters java.lang.String   false Condition parameters to be checked. You can specify many conditionParameters.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
resultParameter java.lang.String ${orOperatorResult} false This parameter is a logical OR result of all conditions specified in conditionParameters task parameter.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Send an Email

Class Name com.midvision.rapiddeploy.orchestration.tasks.SendEmailTask
Category Email

This is the task to send a custom E-Mail.

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
fromAddress java.lang.String   false Sender email address.
messageBody TextArea   true Email Message text body.
outputParameter java.lang.String ${emailMessageBody} true Output Parameter name to get the email message body.
sessionDebug java.lang.Boolean false false SMTP Session debug flag.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
smtpHost java.lang.String   false SMTP server hostname/dns/ip.
smtpPassword java.lang.String   true Password (if required for SMTP Authentication).
smtpPort java.lang.String 25 true SMTP server port (optional, default is 25.).
smtpTLS java.lang.Boolean false false Enable/Disable TLS for SMTP Authentication.
smtpUsername java.lang.String   true Username (if required for SMTP Authentication).
subject java.lang.String   true Email Subject
toAddress java.lang.String   false Email destination addresses.

Back to Top

Search/Replace Literal from property file

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.ReplaceTask
Category File - Search/Replace

Search and Replace Task.
Supports: archiveRoot operationDir

Description

Search/Replace files recursively from the directoryToSearch
Search all files matching the given filesetIncludes and filesetExcludes and replace any occurrence of any key in the replaceFilterFile, with the matching value.
This task supports literal replacement strings, not regular expressions
Note that if you want to specify key value pairs inside task parameters you can use SearchReplaceTask which gives you this opportunity.

Usage (standard)

Replace filter file uses standard Java properties syntax as follows:
                     			Key1=Value1
                     			Key2=Value2
                     			Key3With\=InKey=Value3
                     			Key4With\ InKey=value4
                     			Key5With\:InKey=Value5
By default uses first space, colon or = as separator. Escape these in the search string if they should not be the separator.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
directoryToSearch java.lang.String c:\temp\path\to\search/under true The directory below which the search is performed. - If this is set to "operationDir", the search is performed on the expanded ear file for a WebSphere, Jboss or Weblogic deployment or another expansion task that adds this variable to the task list.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
filesetExcludes java.lang.String   true ANT FileSet Style list of files to exclude from the replace operation.
filesetIncludes java.lang.String **/* false ANT FileSet Style list of files to include in the replace operation.
replaceFilterFilePath java.lang.String replaceFilterFile.props false The path to the property file containing search/replace properties (key/value pairs).
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Search/Replace Regex or Literal by Fileset

Class Name com.midvision.rapiddeploy.orchestration.tasks.SearchReplaceFilesetsTask
Category File - Search/Replace

Search and Replace by Regex or Literal for files in a Fileset.

Description

Search/Replace files recursively from the directoryToSearch.
Search all files matching the given filesetIncludes and filesetExcludes and replace any occurrence of any key in task entries with type "PROPERTY", with the matching value.

Usage (standard)

Multiple Search/Replace Entries can be added to this task, by adding a new "PROPERTY" entry in the 'Entries' section at the bottom of the task panel.

The entries may be literal string replacements or based on Regular Expressions.
keyValuePairs task entries use standard Java properties syntax as follows:
                     			Key1=Value1
                     			Key2=Value2
                     			Key3With\=InKey=Value3
                     			Key4With\ InKey=value4
                     			Key5With\:InKey=Value5

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
directoryToSearch java.lang.String /tmp/path/to/search/under false The directory below which the search is performed.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
filesetExcludes java.lang.String   true ANT FileSet Style list of files to exclude from the replace operation.
filesetIncludes java.lang.String **/* false ANT FileSet Style list of files to include in the replace operation.
replaceAnyKeyValuewithValue java.lang.Boolean false true ADVANCED SEARCH/REPLACE. In this scenario, the key is searched for, and ANY value that is found is replaced with the value in the keyValuePairs task entries. For example: (keyValuePairs task entry) : Test.key=Test.value.new (Searched file before) : Test.key=Test.value.original (Searched file after) : Test.key=Test.value.new If not set, the following replacement would happen: (Searched file after) : Test.value.new=Test.value.original
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Search/Replace Regex or Literal by File Type

Class Name com.midvision.rapiddeploy.orchestration.tasks.SearchReplaceTask
Category File - Search/Replace

Search and Replace by file type.
Supports: archiveRoot operationDir

Description

Search/Replace files recursively from the directoryToSearch
Search all files with the given extensions specified by fileExtensions and replace any occurrence of any key in task entries with type "PROPERTY", with the matching value.

Usage (standard)

Multiple Search/Replace Entries can be added to this task, by adding a new "PROPERTY" entry in the 'Entries' section at the bottom of the task panel.

The entries may be literal string replacements or based on Regular Expressions.
keyValuePairs task entries use standard Java properties syntax as follows:
                     			Key1=Value1
                     			Key2=Value2
                     			Key3With\=InKey=Value3
                     			Key4With\ InKey=value4
                     			Key5With\:InKey=Value5

Usage (Jar inside Ear)

If you wish to search/replace inside unexpanded jar files you can do this also using keyValuePairs task entries. The jar search syntax is as follows:
                     			myjar.jar::Key1=Value1
This will open any jar of the given name (anywhere in the expanded archive) and replace all occurrences of Key1 with Value1.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
directoryToSearch java.lang.String c:\temp\path\to\search/under true The directory below which the search is performed. - If this is set to "operationDir", the search is performed on the expanded ear file for a WebSphere, Jboss or Weblogic deployment or another expansion task that adds this variable to the task list.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
fileExtensions java.lang.String xml, xslt, dat, conf, xmi, jsp, props, dtd true File extensions to search through. All others will be ignored. If not set, searches all files.
replaceAnyKeyValuewithValue java.lang.Boolean false true ADVANCED SEARCH/REPLACE. In this scenario, the key is searched for, and ANY value that is found is replaced with the value in the keyValuePairs task entries. For example: (keyValuePairs task entry) : Test.key=Test.value.new (Searched file before) : Test.key=Test.value.original (Searched file after) : Test.key=Test.value.new If not set, the following replacement would happen: (Searched file after) : Test.value.new=Test.value.original
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Search/Replace XPATH Expressions

Class Name com.midvision.rapiddeploy.orchestration.tasks.XpathReplaceTask
Category File - Search/Replace

XPath Replace Task.
Supports: operationDir

Description

Search/Replace files recursively from the directoryToSearch
Search all files with valid Xml extensions and replace any occurrence of any key in the 'Entries' task entries section, with the matching value.

Usage

Multiple XPATH Entries can be added to this task, by adding a new entry in the 'Entries' section at the bottom of the task panel. At runtime, the job will take Xpath expressions in turn from the task entries with type "XPATH" and replace occurrences in all appropriate files.
Please see: XPath Tutorials for additional information.

Example 1

Example key/value of type XPATH in the 'Entries' section of the task. 
                     			Type    Key                                                                                                           
                     Value
                     
                     			XPATH   //section[normalize-space(text())='ERROR_LOGGER']/tag[normalize-space(text())='ENABLED']/value/text()         
                     20

Example 2

Xml file with namespace.
An xml file with a namespace, such as a web.xml will not work with xpath unless you either specify the namespace, or use namespace agnostic xpath expressions. So for example this xml file: 
<?xml version="1.0" encoding="UTF-8"?>
                     			
                     			<weblogic-web-app xmlns="http://www.bea.com/ns/weblogic/90">
                     			  <jsp-descriptor>
                     			    <page-check-seconds>1</page-check-seconds>
                     			    <verbose>true</verbose>
                     			  </jsp-descriptor>
                     			</weblogic-web-app>
With this expression will not find the value (1) to replace: 
//jsp-descriptor/page-check-seconds/text()
Using namespace agnostic expression it will work: 
//*[local-name() = 'jsp-descriptor']/*[local-name() = 'page-check-seconds']/text()
So in order to change the value "page-check-seconds" with 2 you need to specify task entry with type XPATH in this way: 
key="//*[local-name() = 'jsp-descriptor']/*[local-name() = 'page-check-seconds']/text()"
value="2"
Please see additional Online Examples here.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
directoryRelativePath java.lang.String   true The directory below which the XPATH search is performed, relative to directoryToSearch. if directoryToSearch is set to "operationDir", this parameter gives the ability to further specify a subdirectory or file below the "operationDir" to limit the search.
directoryToSearch java.lang.String operationDir true The directory below which the search is performed. - If this is set to "operationDir", the search is performed on the expanded ear file for a WebSphere, Jboss or Weblogic deployment or another expansion task that adds the "operationDir" variable to the task list.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
filesetExcludes java.lang.String   true ANT FileSet Style list of files to exclude from the replace operation.
filesetIncludes java.lang.String **/* true ANT FileSet Style list of files to include in the replace operation.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Echo Message

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.EchoTask
Category IO

Description

Echo a message to a log or to a file

Usage

Echo a message to a log or a file.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
append java.lang.Boolean true true Whether to append to a file, or overwrite it.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
file java.lang.String   true The full path to the file where the message should be logged, if not logging to standard out.
level java.util.List info false The level of the message: One of debug, error, warning, info, verbose
message TextArea   false The message to echo.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Job Note

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.NoteTask
Category IO

Description

Place a note in the deployment orchestration

Usage

Place a note in the deployment orchestration, which is also written to the log file.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
note TextArea   false The note to make.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Manual Job Step

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.HaltTask
Category IO

Halt the current job in order to perform manual steps.

Description

Pause the current thread. Timeout can be specified in seconds.

The job will be shown as paused and the progress bar turns yellow in the executing jobs panel. During this period the user may perform any manual steps on the target server. The job requester will be notified by email that the task is halted. The thread will be halted until either the timeout is reached, or the job is resumed on the executing jobs panel in the RapidDeploy UI by clicking on the "play" button.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
continueExecution java.lang.Boolean true true Continue execution after timeout.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
notificationMessage java.lang.String Task ${TASK_NAME} HALTED. Please take action to continue the job execution. true Custom note for halted task.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
timeout java.lang.Integer 10 true Timeout value in seconds.

Back to Top

Sleep Task

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.SleepTask
Category IO

Pause the current thread for the specified time, which is the total of hours, minutes, seconds and milliseconds.

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
hours java.lang.String 0 false Hours to sleep.
milliseconds java.lang.String 0 false Milliseconds to sleep.
minutes java.lang.String 0 false Minutes to sleep.
seconds java.lang.String 2 false Seconds to sleep.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Check Jira Ticket Status

Class Name com.midvision.rapiddeploy.orchestration.tasks.rest.jira.CheckJiraTicketStatusTask
Category JIRA

CheckJiraTicketStatus Task.

Description

Make a REST request to a running JIRA instance to check the status of the ticket and compare it with expected.

Usage

Set URL and credentials of your Jira instance. Then specify the ticket number and the state of the ticket that you expect it to be. This task will call Jira rest service, retrieve the state of the specified ticket. It will then compare retrieved state to the one you specified and return success if the comparison is successful or fail if retrieved state is different from expected one.

Table of task Parameters

Name Type Default Value Optional Description
expectedStatus java.lang.String Closed false Expected state of the ticket. Task will fail if the status retrieved by rest service is different from the expected one.
failOnError java.lang.Boolean false false This task will not fail the deployment on error if set to false.
issueNumber java.lang.String   false Number identifying the ticket in Jira.
jiraInstanceUrl java.lang.String https://company.atlassian.net false The URL of the Jira instance.
logResponseBody java.lang.Boolean false true Whether the response of REST service call is written in the task log as output or not.
password java.lang.String   false Password for a specified username. We strongly recommend to use Data Dictionary value with type PASSWORD for safety reasons.
resultOutputParameter java.lang.String ${jiraTicketStatusCheckResult} false True or False depending on status check result. Note that it will be ignored if failOnError parameter is true
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String   false Username that will be used in service call.

Back to Top

Linux LAMP Stack Installer

Class Name com.midvision.rapiddeploy.orchestration.tasks.unix.LAMPInstallerTask
Category Linux Stack Installers

LAMP Stack installer using Linux Package installer.

Description

This task installs Apache, MySql and one of PHP, Perl or Python on Linux.

Usage

The task will determine which package installer is available for the platform.
yum will be used on Red Hat and Centos.
apt-get will be used on Ubuntu.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
apachePackageApt java.util.List apache2 false Apt Command to run. One of: [apache2]
apachePackageYum java.util.List httpd false Yum Command to run. One of: [httpd]
developmentPackageApt java.util.List php5 libapache2-mod-php5 php5-mcrypt false Apt Command to run. One of: [php5|python|perl]
developmentPackageYum java.util.List php php-mysql false Yum Command to run. One of: [php php-mysql|php|python|perl]
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
mysqlPackageApt java.util.List mysql-server libapache2-mod-auth-mysql php5-mysql false Apt Command to run. One of: [mysql-server libapache2-mod-auth-mysql php5-mysql,mysql-server,libapache2-mod-auth-mysql]
mysqlPackageYum java.util.List mariadb-server mariadb false Yum Command to run. One of: [mysql,mysql-community-server,mysql-server,mariadb-server mariadb]
outputParameter java.lang.String ${installerOutput} false The name of the output parameter, which holds the text string output from the task. The output will be the result of the 'apt-get/yum' command on the platform. Typically this will be blank if the user creation succeeds. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (later tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${installerOutput}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sudoPassword java.lang.String   true The sudo password, if required, to run the install through sudo. Only required if non-root user requiring sudo password.
verbose java.lang.Boolean false true Verbose mode. Equivalent to the -v/-V option.

Back to Top

Linux LAMP Stack Uninstaller

Class Name com.midvision.rapiddeploy.orchestration.tasks.unix.LAMPUnInstallerTask
Category Linux Stack Installers

LAMP Stack uninstaller using Linux Package installer.

Description

This task removes Apache, MySql and one of PHP, Perl or Python on Linux.

Usage

The task will determine which package installer is available for the platform.
yum will be used on Red Hat and Centos.
apt-get will be used on Ubuntu.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
apachePackageApt java.util.List apache2 false Apt Command to run. One of: [apache2]
apachePackageYum java.util.List httpd false Yum Command to run. One of: [httpd]
developmentPackageApt java.util.List php5 libapache2-mod-php5 php5-mcrypt false Apt Command to run. One of: [php5|python|perl]
developmentPackageYum java.util.List php php-mysql false Yum Command to run. One of: [php php-mysql|php|python|perl]
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
mysqlPackageApt java.util.List mysql-server libapache2-mod-auth-mysql php5-mysql false Apt Command to run. One of: [mysql-server libapache2-mod-auth-mysql php5-mysql,mysql-server,libapache2-mod-auth-mysql]
mysqlPackageYum java.util.List mariadb-server mariadb false Yum Command to run. One of: [mysql,mysql-community-server,mysql-server,mariadb-server mariadb]
outputParameter java.lang.String ${installerOutput} false The name of the output parameter, which holds the text string output from the task. The output will be the result of the 'apt-get/yum' command on the platform. Typically this will be blank if the user creation succeeds. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (later tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${installerOutput}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sudoPassword java.lang.String   true The sudo password, if required, to run the install through sudo. Only required if non-root user requiring sudo password.
verbose java.lang.Boolean false true Verbose mode. Equivalent to the -v/-V option.

Back to Top

Linux LEMP Stack Installer

Class Name com.midvision.rapiddeploy.orchestration.tasks.unix.LEMPInstallerTask
Category Linux Stack Installers

LEMP Stack installer using Linux Package installer.

Description

This task installs Nginx, MySql and PHP on Linux.

Usage

The task will determine which package installer is available for the platform.
yum will be used on Red Hat and Centos.
apt-get will be used on Ubuntu.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
mysqlPackageApt java.util.List mysql-server libapache2-mod-auth-mysql php5-mysql false Apt Command to run. One of: [mysql-server libapache2-mod-auth-mysql php5-mysql,mysql-server,libapache2-mod-auth-mysql]
mysqlPackageYum java.util.List mariadb-server mariadb false Yum Command to run. One of: [mysql,mysql-community-server,mysql-server,mariadb-server mariadb]
nginxPackageApt java.util.List nginx false Apt Command to run. One of: [nginx]
nginxPackageYum java.util.List nginx false Yum Command to run. One of: [nginx]
outputParameter java.lang.String ${installerOutput} false The name of the output parameter, which holds the text string output from the task. The output will be the result of the 'apt-get/yum' command on the platform. Typically this will be blank if the user creation succeeds. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (later tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${installerOutput}.
phpPackageApt java.util.List php5 libapache2-mod-php5 php5-mcrypt false Apt Command to run. One of: [php5|python|perl]
phpPackageYum java.util.List php php-mysql false Yum Command to run. One of: [php php-mysql|php|python|perl]
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sudoPassword java.lang.String   true The sudo password, if required, to run the install through sudo. Only required if non-root user requiring sudo password.
verbose java.lang.Boolean false true Verbose mode. Equivalent to the -v/-V option.

Back to Top

Linux LEMP Stack Uninstaller

Class Name com.midvision.rapiddeploy.orchestration.tasks.unix.LEMPUnInstallerTask
Category Linux Stack Installers

LEMP Stack uninstaller using Linux Package installer.

Description

This task removes Nginx, MySql and PHP on Linux.

Usage

The task will determine which package installer is available for the platform.
yum will be used on Red Hat and Centos.
apt-get will be used on Ubuntu.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
mysqlPackageApt java.util.List mysql-server libapache2-mod-auth-mysql php5-mysql false Apt Command to run. One of: [mysql-server libapache2-mod-auth-mysql php5-mysql,mysql-server,libapache2-mod-auth-mysql]
mysqlPackageYum java.util.List mariadb-server mariadb false Yum Command to run. One of: [mysql,mysql-community-server,mysql-server,mariadb-server mariadb]
nginxPackageApt java.util.List nginx false Apt Command to run. One of: [nginx]
nginxPackageYum java.util.List nginx false Yum Command to run. One of: [nginx]
outputParameter java.lang.String ${installerOutput} false The name of the output parameter, which holds the text string output from the task. The output will be the result of the 'apt-get/yum' command on the platform. Typically this will be blank if the user creation succeeds. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (later tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${installerOutput}.
phpPackageApt java.util.List php5 libapache2-mod-php5 php5-mcrypt false Apt Command to run. One of: [php5|python|perl]
phpPackageYum java.util.List php php-mysql php-fpm false Yum Command to run. One of: [php php-mysql|php|python|perl]
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sudoPassword java.lang.String   true The sudo password, if required, to run the install through sudo. Only required if non-root user requiring sudo password.
verbose java.lang.Boolean false true Verbose mode. Equivalent to the -v/-V option.

Back to Top

Get host name and host address

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.GetHostnameTask
Category Network

Returns the hostname and hostaddress to the respective output parameters.

Description

If failOnError is set to true, this task will fail the job if the hostname/address retrieval fails.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
hostaddressOutput java.lang.String ${hostaddressOutput} false The name of the output parameter, which can pass the return value from the task. The task output will be the host address of the machine where the current job is running. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${hostaddressOutput}.
hostnameOutput java.lang.String ${hostnameOutput} false The name of the output parameter, which can pass the return value from the task. The task output will be the hostname of the machine where the current job is running. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${hostnameOutput}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Is Port In Use Test

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.IsPortInUseTask
Category Network

Description

Check if a port on the specified host is currently in use. If the hostname parameter is not set, the test will be performed on the host where the job is running.

Usage

If the port specified is in use, returns true to the outputParameter.
If the port specified is not in use, returns false to the outputParameter.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
hostname java.lang.String   true The hostname of the port being checked. If blank, will default to the current host where the job is running.
outputParameter java.lang.String ${portOutput} false The name of the output parameter, which holds the text string output from the task. The output will be the result of the 'port check' command on the platform. The output will be a string 'true' or 'false' depending on whether the port is in use or not. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (later tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${portOutput}.
port java.lang.Integer 80 false The port, on hostname or if hostname is balnk the host where the job is running, to check.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Ping an End Point

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.EndPointTestTask
Category Network

Tries to establish a connection with the specified URL end point.

Description

If failOnError is set to true, this task will fail the job if the ping fails.

If failOnError is set to false, the outputParameter from the task returns true or false depending on whether the URL can be connected to or not.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
outputParameter java.lang.String ${isPingable} false The name of the output parameter, which can pass the return value from the task. The task output will be true if the end point can be pinged, or false if not. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${isPingable}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
url java.lang.String telnet://localhost:80 false The URL to connect to, using any valid URL Scheme (http://es.wikipedia.org/wiki/URI_scheme).

Back to Top

Port Scanner

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.PortScannerTask
Category Network

Description

Check if a range of ports on the specified host is currently in use. If the hostname parameter is not set, the test will be performed on the host where the job is running.

Usage

A comma separated list of in use ports within the range is returned to the outputParameter.
Warning: This task makes serial calls to the ports between the starting and ending port values, and waits for the specified timeout for each one. Setting the port range or timeout values too large may result in this task taking a considerable time to execute.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
endingPort java.lang.Integer 1024 false The upper bound of the port range to scan, on hostname or if hostname is blank the host where the job is running, to check. Must be less than or equal to 65535.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
hostname java.lang.String   true The hostname of the port being checked. If blank, will default to the current host where the job is running.
outputParameter java.lang.String ${portOutput} false The name of the output parameter, which holds the text string output from the task. The output will be the result of the 'port scan' of the host. The output will be a comma separated list of in-use ports in the port range. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (later tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${portOutput}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
startingPort java.lang.Integer 1 false The starting port, on hostname or if hostname is blank the host where the job is running, to check. Must be greater than or equal to 1.
timeout java.lang.Integer 20 false The timeout, in milliseconds to wait for a response from EACH socket request. Please note that setting this value too high will result in this task requiring a very long time to complete.

Back to Top

Wget Task

Class Name com.midvision.rapiddeploy.orchestration.tasks.WgetTask
Category Network

Wget task. Similar to Linux wget command. Allows files to be downloaded from remote URLs.

Table of task Parameters

Name Type Default Value Optional Description
alternateFilename java.lang.String   true Save the file with a different name to the remote one.
directory java.lang.String   false The local file system directory to copy parameters to.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
onlyIfNewer java.lang.Boolean false true If true, only perform the download if the remote parameter is newer than the current one. Defaults to false.
password java.lang.String   true Password (if required for Basic Authentication).
proxyHost java.lang.String   true Proxy hostname/dns/ip if this request will go through a proxy.
proxyPassword java.lang.String   true Password (if required for Proxy Authentication).
proxyPort java.lang.String   true Proxy port if this request will go through a proxy.
proxyUsername java.lang.String   true Username (if required for Proxy Authentication).
remoteUrl java.lang.String   false The remote URL to copy parameters from.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String   true Username (if required for Basic Authentication).
verbose java.lang.Boolean false false Verbose logging output.

Back to Top

Assign Integer to Variable

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.AssignIntegerToVariableTask
Category Number

Description

Assigns an integer to an outputParameter for use in later tasks.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
integer java.lang.Integer 0 false The integer to be assigned to the outputParameter.
outputParameter java.lang.String ${assignedInteger} false The name of the output parameter, which can pass the return value from the task. The task output will be the defined integer. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${assignedInteger}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Increment an Integer

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.IncrementIntegerTask
Category Number

Description

Increment an integer and add to an outputParameter for use in later tasks.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
increment java.lang.Integer 1 false The increment to be added to the integer. Defaults to 1.
integer java.lang.Integer 0 false The integer to be incremented and assigned to the outputParameter.
outputParameter java.lang.String ${assignedInteger} false The name of the output parameter, which can pass the return value from the task. The task output will be the integer plus the increment. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${assignedInteger}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Number Comparison Test

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.NumberCheckTask
Category Number

Description

Tells whether or not this input number is equal, not equal, greater, less than another number. The result of this check is then saved to specified resultParam

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
condition java.util.List EQUALS false Allowed values: EQUALS,NOT_EQUALS,GREATER,GREATER_EQUAL,LESS,LESS_EQUAL
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
inputNumber java.lang.Integer 0 false The input number to be compared.
numberToCompare java.lang.Integer 0 false String to compare with given inputString. This task parameter is ignored for condition IS_EMPTY and IS_NOT_EMPTY.
resultParam java.lang.String ${numberCheckResult} false The name of the output parameter, which can pass the return value from the task. The task output will be the check result output value (the real value will be true or false). Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${numberCheckResult}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Pega Rules Deployment

Class Name com.midvision.rapiddeploy.orchestration.tasks.pega.PegaRulesDeploymentTask
Category Pega Rules

This Task Deploys Pega Rules files to a pega installation. Pega Rules are contained in a Zip File (or files) and multiple rules files can be deployed.

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean false false This task will not fail the deployment on error if set to false. This scope is parameter only.
pegaDbPassword java.lang.String @@PEGA_DB_PASSWORD@@ false This is the pega database user password. This is required by prpcutils using the --dbPassword commandline argument
pegaDbType java.lang.String @@PEGA_DB_TYPE@@ false This is the database type for the prpcutils using the --dbType commandline argument
pegaDbURL java.lang.String @@PEGA_DB_URL@@ false This is the pega database url. This is required by prpcutils using the --dbUrl commandline argument
pegaDbUser java.lang.String @@PEGA_DB_USER@@ false This is the pega database user. This is required by prpcutils using the --dbUser commandline argument
pegaDriverClass java.lang.String com.ibm.db2.jcc.DB2Driver false This is the pega driver class used by prpcutils
pegaDriverJAR java.lang.String @@PEGA_DRIVER_JAR@@ false This is the list of Jar files required by pega in the --driverJar commandline argument
pegaOperation java.lang.String importCodeArchive false This is the operations prpcutils will run. The default is importCodeArchive. For other options run prpcutils.sh|bat -help
pegaRelativeFileLocation java.lang.String @@PEGA_RELATIVE_FILE_LOCATION@@ false This is the relative path to the pega rules archives within the deployment package or project.
pegaRulesLocation java.lang.String @@PEGA_ARCHIVE_PATH@@ false This is a directory on the target server where the rules files are copied to.
pegaScriptLocation java.lang.String   false Location of the Pega API script
pegaScriptName java.lang.String prpcUtils.sh false Pega commandline utility file name. This defaults to prpcutils.sh. It should be change to .bat if on windows or a data dictionary item if being run on both windows and unix environments.
pegaUdbSchema java.lang.String @@PEGA_DB_SCHEMA@@ false This is the pega database user password. This is required by prpcutils using the --dbPassword commandline argument
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Create a Deployment Package

Class Name com.midvision.rapiddeploy.orchestration.tasks.CreateRDDeploymentPackageTask
Category RapidDeploy

Remote RapidDeploy Package Creation Requester

Description

This tasks makes a web service request to a running RapidDeploy instance to create a new Deployment Package.

Usage

Set the URL of the RapidDeploy instance and the authentication token. The authentication token can be generated by the MidVision encryptor tool. This task will make a web service call to RapidDeploy and create a Deployment Package for the specified project with the specified name and extension.

Table of task Parameters

Name Type Default Value Optional Description
archiveExtension java.lang.String jar true Select the extension of the deployment package file to generate: jar, war, ear, tar, rar or zip..
authToken com.midvision.rapiddeploy.task.parameter.WebServiceTokenInputParameterType   false The authentication token necessary to perform the web service call.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
packageName com.midvision.rapiddeploy.task.parameter.PackageSelectionParameterType   true The name of the package to create. Leave it empty to create a name by default.
projectName com.midvision.rapiddeploy.task.parameter.ProjectSelectionParameterType   false The name of the project to deploy.
rapidDeployURL java.lang.String http://localhost:9090/MidVision true The RapidDeploy URL to call via web service. This value, if not set, will be the URL of the RapidDeploy instance performing the deployment.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Get Job Plan Variable

Class Name com.midvision.rapiddeploy.orchestration.tasks.GetJobPlanVariableTask
Category RapidDeploy

Get Job Plan Variable

Description

This tasks gets the value of a job plan variable and puts it into the orchestration context as task parameter. Also Optionally the variable can be removed.

Usage

Sets the variable name to get the value and parameter name to put it.

Table of task Parameters

Name Type Default Value Optional Description
defaultValue java.lang.String   true The default value to set as parameter in case that the variable does not exist or is blank.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
parameterName java.lang.String ${jobPlanVariable} true The parameter name to set the variable value. This can be used in downstream tasks in this orchestration.
removeVariable java.lang.Boolean false true Set if the value should be removed after being set as parameter.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
variableName java.lang.String JOB_PLAN_VARIABLE false The variable name to get. For example JOB_PLAN_VARIABLE. This variable should have been previously set using 'Set Job Plan Variable' task in a project job prior to this one in the job plan.

Back to Top

Run a Job Plan

Class Name com.midvision.rapiddeploy.orchestration.tasks.RunRDJobPlanTask
Category RapidDeploy

Remote RapidDeploy Job Plan Requester

Description

This tasks makes a web service request to a running RapidDeploy instance to run a new Job Plan.

Usage

Set the URL of the RapidDeploy instance and the authentication token. The authentication token can be generated by the MidVision encryptor tool. This task will make a web service call to RapidDeploy and start a Job executing for the specified job plan.

Table of task Parameters

Name Type Default Value Optional Description
authToken com.midvision.rapiddeploy.task.parameter.WebServiceTokenInputParameterType   false The authentication token necessary to perform the web service call.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
jobPlanId java.lang.String   false The job plan Id to run.
rapidDeployURL java.lang.String http://localhost:9090/MidVision true The RapidDeploy URL to call via web service. This value, if not set, will be the URL of the RapidDeploy instance performing the deployment.
runAsynchronously java.lang.Boolean false true Check this if you want to run the Job asynchronously. This means running the Job without waiting for the result.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Run a Linked Job

Class Name com.midvision.rapiddeploy.orchestration.tasks.RunRDDeploymentTask
Category RapidDeploy

Remote RapidDeploy Job Requester

Description

This tasks makes a web service request to a running RapidDeploy instance to run a new Job.

Usage

Set the URL of the RapidDeploy instance and the authentication token. The authentication token can be generated by the MidVision encryptor tool. This task will make a web service call to RapidDeploy and start a Job executing for the specified project on the specified target with the specified version package.

Data Dictionary

A custom data ditionary can be passed to this Job execution by using the task entries of type PROPERTY without the "@@" prefix and suffix.

These values will prevail over any data dictionary configured in the RapidDeploy project.

Table of task Parameters

Name Type Default Value Optional Description
allowFailedPkg java.lang.Boolean true true Check this if you want to be able to run previously failed packages.
authToken com.midvision.rapiddeploy.task.parameter.WebServiceTokenInputParameterType   false The authentication token necessary to perform the web service call.
configurationName com.midvision.rapiddeploy.task.parameter.ApplicationSelectionParameterType   false The name of the target app to deploy to.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
installationName com.midvision.rapiddeploy.task.parameter.EnvironmentSelectionParameterType   false The name of the target environment to deploy to.
packageName com.midvision.rapiddeploy.task.parameter.PackageSelectionParameterType   true The name of the package to deploy. Leave it empty to deploy the latest version.
projectName com.midvision.rapiddeploy.task.parameter.ProjectSelectionParameterType   false The name of the project to deploy.
rapidDeployURL java.lang.String http://localhost:9090/MidVision true The RapidDeploy URL to call via web service. This value, if not set, will be the URL of the RapidDeploy instance performing the deployment.
runAsynchronously java.lang.Boolean false true Check this if you want to run the Job asynchronously. This means running the Job without waiting for the result.
serverName com.midvision.rapiddeploy.task.parameter.ServerSelectionParameterType   false The name of the target server to deploy to.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Set Job Plan Variable

Class Name com.midvision.rapiddeploy.orchestration.tasks.SetJobPlanVariableTask
Category RapidDeploy

Set Job Plan Variable

Description

This tasks sets a job plan variable, this variable can be consumed by another project within this job plan context via Get Job Plan Variable task. Also optionally you can get the value from another variable and copied into a new one.

Usage

Sets the variable name and value to be used by another project within this job plan context.

Table of task Parameters

Name Type Default Value Optional Description
copyFromVariable java.lang.Boolean false true Typically this should be left as the default of 'false'. If set to 'true', then In this case
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
variableName java.lang.String JOB_PLAN_VARIABLE false The variable name to set e.g. JOB_PLAN_VARIABLE. This variable will be available in other (later) project jobs in the same job plan via Get Job Plan Variable task.
variableValue java.lang.String   false The variable value to set. This can be an absolute value, or the value stored in a variable such as the output from a previous task, e.g. ${output}.

Back to Top

Check Redmine Ticket Status

Class Name com.midvision.rapiddeploy.orchestration.tasks.rest.redmine.CheckRedmineTicketStatusTask
Category Redmine

CheckRedmineTicketStatus Task.

Description

Make a REST request to a running Redmine instance to check the status of the ticket and compare it with expected.

Usage

Set URL and API access key of your Redmine instance. Note that you need to have Rest Service authentication enabled in you Redmine settings. Then specify the ticket number and the state of the ticket that you expect it to be. This task will call Redmine rest service, retrieve the state of the specified ticket. It will then compare retrieved state to the one you specified and return success if the comparison is successful or fail if retrieved state is different from expected one.

Table of task Parameters

Name Type Default Value Optional Description
authKey java.lang.String   false Authorization key that will be used to call Redmine WebService. You can find it in your "My account" settings (look up for "API access key"). We strongly recommend to use Data Dictionary value with type PASSWORD for safety reasons.
expectedStatus java.lang.String Closed false Expected state of the ticket. Task will fail if the status retrieved by rest service is different from the expected one.
failOnError java.lang.Boolean false false This task will not fail the deployment on error if set to false.
issueNumber java.lang.String   false Number identifying the ticket in Redmine.
logResponseBody java.lang.Boolean false true Whether the response of REST service call is written in the task log as output or not.
redmineInstanceUrl java.lang.String http://company.redmine.org/ false The URL of the Redmine instance.
resultOutputParameter java.lang.String ${redmineTicketStatusCheckResult} false True or False depending on status check result. Note that it will be ignored if failOnError parameter is true
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

FinalisationTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.FinalisationTask
Category REQUIRED

Finalisation Task

Description

This is the mandatory last task for codeDeploy projects. Do not remove this task, change its order or set its state to inactive.

Working Files

The location of the expanded archive (archiveRoot), is removed by this task, unless retainExpandedArchive is true. The location of an expanded Ear/War/Jar from (operationDir), is removed by this task.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
retainExpandedArchive java.lang.Boolean false true Keep the expanded archive after a successful deployment. The default is to delete the expanded archive.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

ForEachTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.ForEachTask
Category REQUIRED

Description

This task will create a list of string using given inputString and split regex. Then it will process each item from generated collection and execute all tasks. In order to retrieve currently processed element use parameter specified in itemParameter parameter.

Examples

Using coma separated string

If you specify task parameters as : inputString as 
                     			inputString="This,is,a,coma,separated,list,of,words"
                     			splitRegex=","
                     			itemParameter=${word}
then generated collection to process in ForEachTask will be 
["This","is","a","coma","separated","list","of","words"]
So if you then add EchoTask with 
message = ${word}
inside ForEach loop - you will see that during the deployment all these words will be echoed.


Real World Scenario: Using the output of previous task


You can also use outputParameters generated by another task as a inputString and then split this string into list of values.
Let's assume that your goal is to list all of the files under specified directory and then - for each filename perform some operations.
  • Use ListFiles task. The outputParameter (let's use ${listOfFiles} for this example) will contain all filenames under specified directory separated by line separator
  • User ForEach loop where: 
                         				inputString=${listOfFiles}
                     				splitRegex=\r\n|[\r\n]
                     				itemParameter=${filename}
  • Inside ForEach loop you can now use ${filename} to retrieve next element from the collection of filenames and perform operation you need

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
inputString java.lang.String ${inputString} false The input string which will be used to generate collection to be processed in ForEachTask loop.
itemParameter java.lang.String ${itemParameter} false This is a parameter which can be used as a reference to currently processed element in the ForEachTask loop.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sleepBetweenLoop java.lang.Integer 5 false In order not to consume all of the CPU it's worth to set pause time in seconds between loops.
splitRegex java.lang.String , false Regular Expression to split the input string into collection to be processed in ForEachTask loop.

Back to Top

IfTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.IfTask
Category REQUIRED

Description

Depending of the value of conditionParameter this task will execute all of the tasks you specified under true or false result.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
conditionParameter java.lang.String ${checkResult} false This parameter is usually a result of some previous check. For example using NumberCheckTask. Depending on this parameter IfTask will perform all the steps under true or false conditions.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

InitialisationTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.InitialisationTask
Category REQUIRED

Initialisation Task

Description

This is the mandatory first task for codeDeploy projects. Do not remove this task, change its order or set its state to inactive.
This task will uncompress (unjar/unzip/untar) the deployment archive into the platform-dependent temporary directory, /tmp on Unix/Linux.
The location of this expanded archive (archiveRoot), is used by many other tasks.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
checkTmpSize java.lang.Boolean true true This setting determines whether the check for /tmp space should be carried out
cleanOnFail java.lang.Boolean true false Clean up temporary files on failure. Temporary files are always cleaned up on success, but on failure certain files in the system temporary directory are retained for debugging purposes. Setting this to true will also ensure any remaining expanded archives, including the expanded deployment archive itself, are removed.
defaultUser java.lang.String null true This setting defines a default user ID for use in other tasks
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
filesetExcludes java.lang.String **/SERVER.ENVIRONMENT.APPLICATION.* true ANT FileSet Style list of configuration files to exclude. Please see the ANT documentation for more details. Keywords SERVER, ENVIRONMENT, APPLICATION are mapped to their correct values at runtime and may appear anywhere in the FileSet definition. By default the FileSet will be: **/SERVER.ENVIRONMENT.APPLICATION.*
filesetIncludes java.lang.String **/SERVER.ENVIRONMENT.APPLICATION.* true ANT FileSet Style list of configuration files to include. Please see the ANT documentation for more details. Keywords SERVER, ENVIRONMENT, APPLICATION are mapped to their correct values at runtime and may appear anywhere in the FileSet definition. By default the FileSet will be: **/SERVER.ENVIRONMENT.APPLICATION.*
projectDictionaryFile java.lang.String project.dict true The relative path of the project level data dictionary file. By default this will be located at the top level directory of the project, but it can be located anywhere in the archive, referenced by a path relative to the top level e.g. j2ee/config/project.py. Any entries in this dictionary file will be overridden by entries in the environment level dictionary file (where keys match).
searchReplaceFilesetExcludes java.lang.String true ANT FileSet Style list of configuration files to exclude from the search/replace of dictionary properties. Typically this might be used to exclude large binary files. E.g. **/*.zip,**/*.jar Please see the ANT documentation for more details.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sourceVariables java.lang.Boolean true true If this value is set to true, any Java Properties or Environment Variables set in the Orchestration process and referenced in any environment properties files with ${PROP_NAME} will be replaced with the actual value at deployment time. For example, if the target server has an environment variable set for all users $TMP or %TMP%, and the environment dictionary file has MY_TMP_DIR=${TMP}, then at deployment time, before any task processing, MY_TMP_DIR will be set to the value of $TMP or %TMP%. On Unix this would be /tmp.
tmpSizeMultiplier java.lang.Integer 2 true This setting determines number of times the size of the deployable tar file, that must be available
useAntCompression java.lang.Boolean false false This setting defines whether standard or ANT based compression utilities are used

Back to Top

TargetSpecificOrchestration

Class Name com.midvision.rapiddeploy.orchestration.tasks.TargetSpecificOrchestrationTask
Category REQUIRED

Target Specific Orchestration Task

Description

This task is very convenient way of specifying different set of tasks for different target.

Usage

Add this task to your main orchestration. When you select it you should see "New Target" button on the right panel (note that this button is disabled if your project is not assigned to any target, or there is no more targets you can add). Add targets to the task and you will see them under TargetSpecificOrchestration (task list is now shown as a tree). You can add specific tasks by selecting target and using "New Task" button. Configuring sub-orchestration is very similar to configuring main orchestration. You can add/remove/move up/move down tasks etc. During the deployment only these tasks will be performed that are configured for current target (you will not see tasks related to other targets in Progress Monitor for the deployment).

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

WhileTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.WhileTask
Category REQUIRED

Description

This task will execute all of the tasks you specified until conditionParameter equals false. It works in similar way as while loop in most of programming languages. You need to make sure that under while loop you have tasks responsible for changing the state of the conditionParameter. Also we strongly recommend to use SleepTask to allow the while loop not to consume all of the CPU.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
conditionParameter java.lang.String ${checkResult} false This parameter is usually a result of some previous check. For example using NumberCheckTask. This task will execute all of the tasks you specified until conditionParameter equals false.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
maxLoopNumber java.lang.Integer 100 true The maximum number of loops. If set to 0 WhileTask will loop forever. This parameter provides some limitation you may want to use to make sure the while loop finally ends. The job will fail if the maximum number of loops is exceeded.
negateConditionParameter java.lang.Boolean false true This parameter allows you to handle conditionParameter with value false, for example when you want to execute all of the tasks you specified until conditionParameter equals true. From programming point of view it handles while(!condition)
numberOfLoopsParam java.lang.String ${numberOfLoops} true This parameter will be replaced with final number of loops performed in WhileTask.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sleepBetweenLoop java.lang.Integer 5 false In order not to consume all of the CPU it's worth to set pause time in seconds between loops.

Back to Top

REST Service Call

Class Name com.midvision.rapiddeploy.orchestration.tasks.rest.RESTCallTask
Category REST

REST WebService Call Task.

Description

Make a REST request to a running WebService and handle the response. HTTP method allowed are GET, POST, PUT and DELETE. The user must set the URL, HTTP method and if the task fail on error.

Usage

Set the REST service URL (restServiceURL) and HTTP method (restHttpMethod).

GET method call to REST service should define:

If the response should be added to the task log (logResponseBody)
Header parameters (headerParamsValue, headerParamsSplitRegex, headerKeyValueSplitRegex)
Define if response should be handled as Text or ninary format (binaryResponse)
In the case of handling response as text, this can be set into a task scope variable to be used by any following task (responseTextScopeVar)
In the case of handling response as binary, this can be saved into a file. (responseDataFilePath)

POST method call to REST service should define:

If the response should be added to the task log (logResponseBody)
Header parameters (headerParamsValue, headerParamsSplitRegex, headerKeyValueSplitRegex)
Post request parameters (postParamsValue, postParamsSplitRegex, postKeyValueSplitRegex)
Define the content type of the request body e.g. html/text or application/json (requestContentType)
Define if the resquest body should attach a text get from task scope variable(requestTextScopeVar)
Define if the resquest body should attach a data get from a file path (requestDataFilePath)
Define if response should be handled as Text or ninary format (binaryResponse)
In the case of handling response as text, this can be set into a task scope variable to be used by any following task (responseTextScopeVar)
In the case of handling response as binary, this can be saved into a file. (responseDataFilePath)

PUT method call to REST service should define:

If the response should be added to the task log (logResponseBody)
Header parameters (headerParamsValue, headerParamsSplitRegex, headerKeyValueSplitRegex)
Define the content type of the request body e.g. html/text or application/json (requestContentType)
Define if the resquest body should attach a text get from task scope variable(requestTextScopeVar)
Define if the resquest body should attach a data get from a file path (requestDataFilePath)
Define if response should be handled as Text or ninary format (binaryResponse)
In the case of handling response as text, this can be set into a task scope variable to be used by any following task (responseTextScopeVar)
In the case of handling response as binary, this can be saved into a file. (responseDataFilePath)

DELETE method call to REST service should define:

If the response should be added to the task log (logResponseBody)
Header parameters (headerParamsValue, headerParamsSplitRegex, headerKeyValueSplitRegex)
Define if response should be handled as Text or ninary format (binaryResponse)
In the case of handling response as text, this can be set into a task scope variable to be used by any following task (responseTextScopeVar)
In the case of handling response as binary, this can be saved into a file. (responseDataFilePath)

Table of task Parameters

Name Type Default Value Optional Description
binaryResponse java.lang.Boolean false true Whether the response data is handled as a binary response or not. Otherwise is response is handled as text format.
connectionTimeoutSecs java.lang.Integer 15 true Connection timeout in seconds.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
headerKeyValueSplitRegex java.lang.String   true Regular Expression to slip the each header parameter into key/value pair.
headerParamsSplitRegex java.lang.String   true Regular Expression to slip In-line value of the header parameters into a collection of parameters.
headerParamsValue java.lang.String   true In-line value of the header parameters, this will be parsed to via additional Regular Expression cofigurations.
logResponseBody java.lang.Boolean true false Whether the response of REST service call is written in the task log as output or not.
postKeyValueSplitRegex java.lang.String   true Regular Expression to slip the each post resquest parameter into key/value pair.
postParamsSplitRegex java.lang.String   true Regular Expression to slip In-line value of the post resquest parameters into a collection of parameters.
postParamsValue java.lang.String   true In-line value of the post resquest parameters, this will be parsed to via additional Regular Expression cofigurations.
queryKeyValueSplitRegex java.lang.String   true Regular Expression to slip the each query parameter into key/value pair.
queryParamsSplitRegex java.lang.String   true Regular Expression to slip In-line value of the query parameters into a collection of parameters.
queryParamsValue java.lang.String   true In-line value of the query parameters.
requestContentType java.lang.String text/plain true Content Type of the REST service request.
requestDataInputFilePath java.lang.String   true Input file path to be loaded and attached to the request body.
requestTextInputParam java.lang.String   true Name of the input parameter in the task scope to get data to be attached to the request body.
responseDataOutputFilePath java.lang.String   true Output file path to be written with the response body content.
responseTextOutputParam java.lang.String   true Name of the output parameter in the task scope to put response body content.
restHttpMethod java.util.List GET false HTTP mehtod used to call the REST service. Allowed values GET, POST, PUT and DELETE.
restServiceURL java.lang.String http://localhost:8080/MyWebApp/do/something false The URL to call the REST service.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sslKeyStorePassword java.lang.String   true Password of the JKS KeyStore.
sslKeyStoreURL java.lang.String file:/~/.ssh/MyKeyStore.jks true File URL of the JKS KeyStore.
sslTrustStorePassword java.lang.String   true Password of the JKS TrustStore.
sslTrustStoreURL java.lang.String file:/~/.ssh/MyTrustStore.jks true File URL of the JKS TrustStore.

Back to Top

Assign String to Variable

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.AssignStringToVariableTask
Category String

Description

Assigns a string to an outputParameter for use in later tasks.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
outputParameter java.lang.String ${assignedString} false The name of the output parameter, which can pass the return value from the task. The task output will be the defined string. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${assignedString}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
string java.lang.String   false The string to be assigned to the outputParameter.

Back to Top

Base64 Encode/Decode

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.Base64Task
Category String

Description

Encode to, or decode from Base64

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
input java.lang.String   false The input string to encode or decode.
mode java.util.List ENCODE false Perform an Encode or Decode operation on the input.
outputParameter java.lang.String ${resultString} false The name of the output parameter, which can pass the return value from the task. The task output will be the defined string. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${resultString}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Begins With String Test

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.BeginsWithStringTask
Category String

Description

Returns true if and only if the input string begins with the specified stringToSearchFor. This task can be very useful to parse output parameters from (CommandRunnerTask, ScriptRunnerTask or RunDefinedScriptTask) and produce new outputparameter.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
inputString java.lang.String ${output} false The input string to be parsed.
outputParameter java.lang.String ${containsResult} false The name of the output parameter, which can pass the return value from the task. The task output will be the check result output value (the real value will be true or false). Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${containsResult}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
stringToSearchFor java.lang.String   false The sequence to search for

Back to Top

Concatenate Two Strings

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.ConcatenateStringTask
Category String

Description

Concatenate two strings together. The outputParameter will be a concatenation of inputString1 and inputString2.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
inputString1 java.lang.String ${inputString1} false The first input string to be concatenated to.
inputString2 java.lang.String ${inputString2} false The string to concatenate to inputString1
outputParameter java.lang.String ${concatenatedString} false The name of the output parameter, which can pass the return value from the task. The task output will be the concatenated string inputString1 + inputString2. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${containsResult}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Contains String Test

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.ContainsStringTask
Category String

Description

Returns true if and only if the input string contains the specified stringToSearchFor. This task can be very useful to parse output parameters from (CommandRunnerTask, ScriptRunnerTask or RunDefinedScriptTask) and produce new outputparameter.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
ignoreCase java.lang.Boolean false false If set to true, the task will perform a case insensitive contains test. Defaults to false.
inputString java.lang.String ${output} false The input string to be parsed.
outputParameter java.lang.String ${containsResult} false The name of the output parameter, which can pass the return value from the task. The task output will be the check result output value (the real value will be true or false). Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${containsResult}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
stringToSearchFor java.lang.String   false The sequence to search for

Back to Top

Ends With String Test

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.EndsWithStringTask
Category String

Description

Returns true if and only if the input string ends with the specified stringToSearchFor. This task can be very useful to parse output parameters from (CommandRunnerTask, ScriptRunnerTask or RunDefinedScriptTask) and produce new outputparameter.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
inputString java.lang.String ${output} false The input string to be parsed.
outputParameter java.lang.String ${containsResult} false The name of the output parameter, which can pass the return value from the task. The task output will be the check result output value (the real value will be true or false). Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${containsResult}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
stringToSearchFor java.lang.String   false The sequence to search for

Back to Top

Insert String After String Matches

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.InsertStringAfterStringMatchesTask
Category String

Description

Returns a new string that has the insertString inserted immediately after the first occurrence of stringToMatch in the inputString.

If a match is not found for the stringToMatch in the inputString, the unaltered inputString is returned to the outputParameter.

Examples

Example inputString is: 
                     			"the lateness of the hour is telling"
If the stringToMatch is: 
"the lateness of the hour"
and the insertString is: 
", and state of the parties,"
the string returned in the outputParameter will be: 
"the lateness of the hour, and state of the parties, is telling"


Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
inputString java.lang.String ${output} false The input string to be parsed.
insertString java.lang.String   true The string to insert after the first occurrence of stringToMatch in the inputString
outputParameter java.lang.String ${insertStringOutput} false The name of the output parameter, which can pass the return value from the task. The task output will be the inputString with the insertString inserted after the first occurrence of the stringToMatch. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${insertStringOutput}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
stringToMatch java.lang.String   false The string to match. The insertString is inserted immediately after the last character of the first occurrence of this match pattern.

Back to Top

JSON XML Converter

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.JsonXmlConverterTask
Category String

Description

Convert from Xml to Json or vice-versa

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
input java.lang.String   false The input string to convert - either XML or JSON.
mode java.util.List XmlToJson false Perform a JsonToXml or XmlToJson operation on the input.
outputParameter java.lang.String ${resultString} false The name of the output parameter, which can pass the return value from the task. The task output will be the defined string. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${resultString}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Match String Regex

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.MatchStringTask
Category String

Description

Provides different options for string matches with a given regular expression. This task can be very useful to parse output parameters from (CommandRunnerTask, ScriptRunnerTask or RunDefinedScriptTask) and produce a new outputParameter.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
checkEntireText java.lang.Boolean true true If this option is enabled the whole input string will be checked against the regular expression, otherwise substrings inside the input string will be checked.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
inputString java.lang.String ${output} false The input string to be parsed.
matchResultOutputParameter java.lang.String ${matchResult} false The name of the output parameter, which can pass the return value from the task. This value will be the check result output value (the real value will be true or false). Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${matchResult}.
matchValueOutputParameter java.lang.String ${matchValue} false The name of the output parameter, which can pass the return value from the task. This value contains the matching substring in the input text. If the 'checkEntireText' option is enabled this value will contain the same input string provided. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${matchValue}.
regexToSearchFor java.lang.String   false The regular expression to which this inputString is to be matched.
returnFirstMatch java.lang.Boolean true true If this option is enabled only the first substring matching the regular expresion will be returned.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Remove Whitespace/Newline chars

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.StringRemoveWhitespaceTask
Category String

Description

Remove whitespace and/or newline characters from an inputString.

(1) Removes whitespace from the whole string (ALL), or from the beginning (LEADING), end (TRAILING) or both beginning and end (LEADING_AND_TRAILING) of the string.

(2) Remove one newline (carriage return and/or linefeed) from the end of a string. A newline is "\n", "\r", or "\r \n". Remove one newline character (ONE_NEWLINE), or one newline character and trailinig whitespace (TRAILING_WHITESPACE_AND_NEWLINE).

This task can be very useful to parse output parameters from (CommandRunnerTask, ScriptRunnerTask or RunDefinedScriptTask) and produce new outputparameter.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
inputString java.lang.String ${output} false The input string to be parsed.
outputParameter java.lang.String ${trimOutput} false The name of the output parameter, which can pass the return value from the task. The task output will be the inputString, stripped of white spaces according to the removeMode. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${trimOutput}.
removeMode java.util.List LEADING_AND_TRAILING false Remove whitespace according to the following modes. Allowed values: ALL (Remove all whitespace from string), LEADING_AND_TRAILING (Remove leading and trailing whitespace from string), LEADING (Remove leading whitespace from string), TRAILING (Remove trailing whitespace from string). Remove linefeed/carriage returns according to the following modes. Allowed values: ONE_NEWLINE (Remove one newline character from the end of the string) TRAILING_WHITESPACE_AND_NEWLINE (Remove one newline character from the end of the string and then any trailing whitespace).
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Replace String

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.ReplaceStringTask
Category String

Description

Replaces each substring of this string that matches the literal target sequence or given regular expression with the specified literal replacement sequence. You can replace all occurrences or only first one. This task can be very useful to parse output parameters from (CommandRunnerTask, ScriptRunnerTask or RunDefinedScriptTask) and produce new outputparameter.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
inputString java.lang.String ${output} false The input string to be parsed.
outputParameter java.lang.String ${replaceOutput} false The name of the output parameter, which can pass the return value from the task. The task output will be the script output value. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${replaceOutput}.
regexToReplace java.lang.String   true The regular expression to which this string is to be matched Note that this task parameter is used only in REPLACE_ALL and REPLACE_FIRST mode.
replacement java.lang.String   false The string to be substituted.
replaceMode java.util.List REPLACE false Allowed values: REPLACE (String.replace(stringToReplace, replacement)), REPLACE_ALL (String.replaceAll(regexToReplace, replacement)), REPLACE_FIRST (String.replaceFirst(regexToReplace, replacement)).
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
stringToReplace java.lang.String   true The string sequence to be replaced in given input string. Note that this task parameter is used only in REPLACE mode.

Back to Top

Split String

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.SplitStringTask
Category String

Split a string.

Description

Splits this inputString around matches of the given regular expression, splitRegex, into an array of strings.

The outputParameter will be the string at the positional number in the array (starting from 1), designated by listEntryNumber

Examples

The inputString "boo:and:foo", for example, yields the following results with these splitRegex:

splitRegex ":", String list result is { "boo", "and", "foo" }}, A listEntryNumber of 3 returns "foo" to the outputParameter

splitRegex "o", String list result is { "b", "", ":and:f" }}, A listEntryNumber of 1 returns "b" to the outputParameter

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
inputString java.lang.String ${output} false The input string to be split.
listEntryNumber java.lang.String   true The positional number of the entry in the list of returned strings from the split operation. The string at this position will be returned to the outputParameter.
outputCounter java.lang.String ${countOfStrings} true The name of the output counter, which can pass the return value from the task. This will be the count of items as result. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the task flow, as an input parameter ${countOfStrings}.
outputParameter java.lang.String ${splitStringOutput} false The name of the output parameter, which can pass the return value from the task. The task output will be the string at the listEntryNumber position of the returned list of strings from the split operation. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${splitStringOutput}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
splitRegex java.lang.String   false The regular expression to split the string on. For example \s+ for one or more white spaces.

Back to Top

String Comparison Test

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.StringCheckTask
Category String

Description

Tests whether or not this string is equal or not equal to another string or checks if it is empty.

EQUALS_IGNORE_CASE checks for string equality, but ignoring the case of both strings. Two strings are considered equal ignoring case if they are of the same length and the corresponding characters in the two strings are equal ignoring case.

The result of this check (true or false) is then saved to specified resultParam.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
condition java.util.List EQUALS false Allowed values: EQUALS,NOT_EQUALS,EQUALS_IGNORE_CASE,IS_EMPTY,IS_NOT_EMPTY
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
inputString java.lang.String ${output} false The input string to be parsed.
resultParam java.lang.String ${stringCheckResult} false The name of the output parameter, which can pass the return value from the task. The task output will be the check result output value (the real value will be true or false). Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${stringCheckResult}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
stringToCompareInput java.lang.String   true String to compare with given inputString. This task parameter is ignored for condition IS_EMPTY and IS_NOT_EMPTY.

Back to Top

String to Lower Case

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.StringToLowerTask
Category String

Description

The outputParameter will contain the inputString converted to lower case.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
inputString java.lang.String ${inputString} false The input string.
outputParameter java.lang.String ${lowercaseString} false The name of the output parameter, which can pass the return value from the task. The task output will be the lowercase representation of the inputString. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${lowercaseString}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

String to Upper Case

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.StringToUpperTask
Category String

Description

The outputParameter will contain the inputString converted to upper case.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
inputString java.lang.String ${inputString} false The input string.
outputParameter java.lang.String ${uppercaseString} false The name of the output parameter, which can pass the return value from the task. The task output will be the upper case representation of the inputString. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${uppercaseString}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

SubString by Index

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.SubStringTask
Category String

Description

Returns a new string that is a substring of this string. The substring begins at the specified beginIndex and extends to the character at index endIndex - 1. Thus the length of the substring is endIndex-beginIndex. This task can be very useful to parse output parameters from (CommandRunnerTask, ScriptRunnerTask or RunDefinedScriptTask) and produce new outputparameter.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
beginIndex java.lang.Integer 0 false beginIndex - the beginning index, inclusive.
endIndex java.lang.Integer MAX_LENGTH true endIndex - the ending index, exclusive. If you leave it blank - it will be set to (inputString.length - 1)
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
inputString java.lang.String ${output} false The input string to be parsed.
outputParameter java.lang.String ${substringOutput} false The name of the output parameter, which can pass the return value from the task. The task output will be the script output value. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${substringOutput}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

SubString by String Matches

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.SubStringByStringMatchesTask
Category String

Description

Returns a new string that is a substring of the inputString, being the portion of the inputString between the beginStringToMatch and endStringToMatch, exclusive.

More specifically, the substring begins at the first character after the first occurrence of beginStringToMatch and extends to the character before the first character of the first occurrence of the endStringToMatch.

If the beginStringToMatch is blank, the substring will begin with the first character of the inputString and extend to the character before the first character of the endStringToMatch.

If the endStringToMatch is blank, the substring will begin with the first character after the beginStringToMatch and extend to the end of the inputString.

If a match is not found for either the begin or end strings, the empty string is returned to the outputParameter.

Examples

Example inputString is: 
                     			"the lateness of the hour is telling"
If the beginStringToMatch is: 
"the lateness"
and the endStringToMatch is: 
"hour"
the substring returned in the outputParameter will be: 
" of the "


If the beginStringToMatch is: 
""
and the endStringToMatch is: 
"hour"
the substring returned in the outputParameter will be: 
"the lateness of the "


If the beginStringToMatch is:
"the lateness"
and the endStringToMatch is 
""
the substring returned in the outputParameter will be: 
" of the hour is telling"


Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
beginStringToMatch java.lang.String   false The first string to match.
endStringToMatch java.lang.String   true The second string to match
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
inputString java.lang.String ${output} false The input string to be parsed.
outputParameter java.lang.String ${substringOutput} false The name of the output parameter, which can pass the return value from the task. The task output will be the substring between the two string matches. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${substringOutput}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Yaml Json Converter

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.YamlConverterTask
Category String

Description

Convert from Yaml to Json or vice-versa

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
input java.lang.String   false The input string to convert - either Yaml or JSON.
mode java.util.List YamlToJson false Perform a JsonToYaml or YamlToJson operation on the input.
outputParameter java.lang.String ${resultString} false The name of the output parameter, which can pass the return value from the task. The task output will be the defined string. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${resultString}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Copy Property File To Ear

Class Name com.midvision.rapiddeploy.orchestration.tasks.CopyPropertyFileToEarTask
Category Utilities

Copy Files into an Expanded Ear or War.

Description

Copy a file from the archive into an expanded ear, war or other archive file.
Useful for example to copy environment specific DTD file into the ear. This task depends on one of the war/ear expansion tasks having been executed (operationDir is set).

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
propertyFilePath java.lang.String ${ARCHIVE_ROOT}/path/to/file false The path identifying the file to be copied to the Ear/War. If inside the deployment package, use ${ARCHIVE_ROOT}/path/to/file
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
targetRelativeToEarFileRoot java.lang.String relative/target/inside/expanded/ear false The target file location relative to the root of the expanded Ear/War.

Back to Top

isAix Test

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.IsAixTask
Category Utilities

Is this server running an AIX compliant OS

Description

This task retrieves information about OS into specified outputParameter. Is true if this is an AIX compilant system. Returns false if not.

The field will return false if OS name is null.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
outputParameter java.lang.String ${isAix} false The name of the output parameter, which can pass the return value from the task. The task output will be true if OS is AIX compliant, or false if not. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${isAix}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

isLinux Test

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.IsLinuxTask
Category Utilities

Is this server running a Linux compliant OS

Description

This task retrieves information about OS into specified outputParameter. Is true if this is a Linux compilant system, such as CentOS, RHEL, Ubuntu. Returns false if not.

The field will return false if OS name is null.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
outputParameter java.lang.String ${isLinux} false The name of the output parameter, which can pass the return value from the task. The task output will be true if OS is Linux compliant, or false if not. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${isLinux}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

isMac Test

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.IsMacTask
Category Utilities

Is this server running a Mac compliant OS

Description

This task retrieves information about OS into specified outputParameter. Is true if this is a Mac compilant system, such as OSX. Returns false if not

The field will return false if OS name is null.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
outputParameter java.lang.String ${isMac} false The name of the output parameter, which can pass the return value from the task. The task output will be true if OS is Linux compliant, or false if not. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${isMac}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

isSolaris Test

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.IsSolarisTask
Category Utilities

Is this server running a Solaris compliant OS

Description

This task retrieves information about OS into specified outputParameter. Is true if this is a Solaris compilant system such as Solaris or SunOS. Returns false if not.

The field will return false if OS name is null.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
outputParameter java.lang.String ${isSolaris} false The name of the output parameter, which can pass the return value from the task. The task output will be true if OS is Solaris compliant, or false if not. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${isSolaris}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

isUnix Test

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.IsUnixTask
Category Utilities

Is this server running a Posix compliant OS

Description

This task retrieves information about OS into specified outputParameter. Is true if this is a POSIX compilant system, as in any of AIX, HP-UX, Irix, Linux, MacOSX, Solaris or SUN OS. False if not.

The field will return false if OS name is null.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
outputParameter java.lang.String ${isUnix} false The name of the output parameter, which can pass the return value from the task. The task output will be true if OS is POSIX compliant, or false if not. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${isUnix}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

isWindows Test

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.IsWindowsTask
Category Utilities

Is this server running a Windows compliant OS

Description

This task retrieves information about OS into specified outputParameter. Is true if this is a Windows compliant system, false if not.

The field will return false if OS name is null.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
outputParameter java.lang.String ${isUnix} false The name of the output parameter, which can pass the return value from the task. The task output will be true if OS is Windows compliant, or false if not. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${isUnix}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Kill a Process

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.KillTask
Category Utilities

Kill Task

Description

Task to kill a process on a Unix/Linux/Mac/Windows Server.

Windows Usage

On the windows platform, the signal parameter is ignored and will not be used.
The processName name should be the Image Name of the proecess, for example 
notepad.exe

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
processName java.lang.String PROCESS_STRING false Replace PROCESS_STRING with a character sequence matching your process(es) to be killed. Please note that all processes containing the specified character sequence will be sent the specified signal.
signal java.util.List -9 false A signal to pass to the process. Common Signals: [-TERM | -15 | -KILL | -9 | -HUP | -1 | -STOP | -17,-19,-23 ]
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Timestamp Task

Class Name com.midvision.rapiddeploy.orchestration.tasks.utils.CurrentDateTask
Category Utilities

Read the current date/time into an outputParameter

Description

This task retrieves the current date/time into the specified outputParameter, according to the specified date format specified in dateFormat.

The output date may be used by other (later) tasks in the orchestration.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
dateFormat java.lang.String yyyy-MM-dd:HH:mm:ss false The format to use for the date. Uses Java SimpleDateFormat.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
outputParameter java.lang.String ${currentDateFormatted} false The name of the output parameter, which can pass the return value from the task. The task output will be the current date/time formatted according to the dateFormat specified. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${currentDateFormatted}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Update a Version File

Class Name com.midvision.rapiddeploy.orchestration.tasks.UpdateVersionFileTask
Category Utilities

Update Version File Task.

Description

This target updates (appends to) a file on the remote system with deployment information. It can be used to append data to any file that resides on a target server. The source file cound be a MANIFEST.MF file from the deployment package.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
copySource java.lang.String ${ARCHIVE_ROOT}/path/to/file false The full path to the copy source. If the source is in the deployment package use ${ARCHIVE_ROOT}/path/to/file. This file should contain pertinent information about the build version etc.
copyTarget java.lang.String /tmp/path/to/copy/to false The full absolute path to the copy target. This is the file holding version information.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.