Back to Top

DBmaestro build between labels

Class Name com.midvision.rapiddeploy.plugins.products.dbmaestro.teamwork.tasks.TeamWorkPipelineBuildBetweenLabelsTask
Category DBmaestro TeamWork

DBmaestro build between labels

Description

Applies a label and generates a deployment script from a predefined pipeline project and an environment to its mapped target environment, between a set of existing label names.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
actionType java.util.List forward false Action type to perform.
baselineLabelName java.lang.String   true The name of the baseline environment label used for the build.
dbType java.util.List Oracle false The default RDBMS DBmaestro TeamWork works with.
environmentName java.lang.String   false Name of the source environment in the pipeline project.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
labelName java.lang.String   false The name of the source environment label used for the build.
otherEnvironmentName java.lang.String   true Name of the target environment in the pipeline project.
outputParameter java.lang.String ${output} false The name of the output parameter, which can pass the return value from the task. The task output will be the java application output to STDOUT. 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 ${output}.
outputResult java.lang.String ${outputResult} false The name of the output parameter, which holds the text string output from the task. The outputResult will be 'true' if the java application returns without error. The outputResult will be 'false' if an error occurs. 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 ${outputResult}.
pipelineName java.lang.String   false Name of the pipeline project.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
targetLabelName java.lang.String   false The name of the target environment label used for the build.
twAutomationJarPath java.lang.String   false Location of the executable JAR file of DBmaestro TeamWork Automation ('TWAutomation.jar').
twServer java.lang.String   false Host server name of DBmaestro TeamWork server.


Back to Top

DBmaestro build by tasks

Class Name com.midvision.rapiddeploy.plugins.products.dbmaestro.teamwork.tasks.TeamWorkPipelineBuildByTasksTask
Category DBmaestro TeamWork

DBmaestro build by tasks

Description

Applies a label and generates a deployment script from a predefined pipeline project and an environment to its mapped target environment using a source environments list of tasks.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
actionType java.util.List forward false Action type to perform.
dbType java.util.List Oracle false The default RDBMS DBmaestro TeamWork works with.
environmentName java.lang.String   false Name of the source environment in the pipeline project.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
otherEnvironmentName java.lang.String   true Name of the target environment in the pipeline project.
outputParameter java.lang.String ${output} false The name of the output parameter, which can pass the return value from the task. The task output will be the java application output to STDOUT. 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 ${output}.
outputResult java.lang.String ${outputResult} false The name of the output parameter, which holds the text string output from the task. The outputResult will be 'true' if the java application returns without error. The outputResult will be 'false' if an error occurs. 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 ${outputResult}.
pipelineName java.lang.String   false Name of the pipeline project.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sourceTasks java.lang.String   false A comma-separated list of the source environment tasks used for the build.
twAutomationJarPath java.lang.String   false Location of the executable JAR file of DBmaestro TeamWork Automation ('TWAutomation.jar').
twServer java.lang.String   false Host server name of DBmaestro TeamWork server.


Back to Top

DBmaestro build latest revision

Class Name com.midvision.rapiddeploy.plugins.products.dbmaestro.teamwork.tasks.TeamWorkPipelineBuildLatestLabelTask
Category DBmaestro TeamWork

DBmaestro build latest revision

Description

Applies a label and generates a deployment script from a predefined pipeline project and an environment to its mapped target environment using the source environments latest revision.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
actionType java.util.List forward false Action type to perform.
dbType java.util.List Oracle false The default RDBMS DBmaestro TeamWork works with.
environmentName java.lang.String   false Name of the source environment in the pipeline project.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
newLabelName java.lang.String   false The name of the new label created during the build.
otherEnvironmentName java.lang.String   true Name of the target environment in the pipeline project.
outputParameter java.lang.String ${output} false The name of the output parameter, which can pass the return value from the task. The task output will be the java application output to STDOUT. 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 ${output}.
outputResult java.lang.String ${outputResult} false The name of the output parameter, which holds the text string output from the task. The outputResult will be 'true' if the java application returns without error. The outputResult will be 'false' if an error occurs. 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 ${outputResult}.
pipelineName java.lang.String   false Name of the pipeline project.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
twAutomationJarPath java.lang.String   false Location of the executable JAR file of DBmaestro TeamWork Automation ('TWAutomation.jar').
twServer java.lang.String   false Host server name of DBmaestro TeamWork server.


Back to Top

DBmaestro build specific label

Class Name com.midvision.rapiddeploy.plugins.products.dbmaestro.teamwork.tasks.TeamWorkPipelineBuildSpecificLabelTask
Category DBmaestro TeamWork

DBmaestro build specific label

Description

Applies a label and generates a deployment script from a predefined pipeline project and an environment to its mapped target environment using a source environments specific label name.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
actionType java.util.List forward false Action type to perform.
dbType java.util.List Oracle false The default RDBMS DBmaestro TeamWork works with.
environmentName java.lang.String   false Name of the source environment in the pipeline project.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
labelName java.lang.String   false The name of the label used for the build.
otherEnvironmentName java.lang.String   true Name of the target environment in the pipeline project.
outputParameter java.lang.String ${output} false The name of the output parameter, which can pass the return value from the task. The task output will be the java application output to STDOUT. 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 ${output}.
outputResult java.lang.String ${outputResult} false The name of the output parameter, which holds the text string output from the task. The outputResult will be 'true' if the java application returns without error. The outputResult will be 'false' if an error occurs. 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 ${outputResult}.
pipelineName java.lang.String   false Name of the pipeline project.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
twAutomationJarPath java.lang.String   false Location of the executable JAR file of DBmaestro TeamWork Automation ('TWAutomation.jar').
twServer java.lang.String   false Host server name of DBmaestro TeamWork server.


Back to Top

DBmaestro deploy

Class Name com.midvision.rapiddeploy.plugins.products.dbmaestro.teamwork.tasks.TeamWorkPipelineDeployTask
Category DBmaestro TeamWork

DBmaestro deploy

Description

Executes all scripts in the source environment planned folder on the target environment. Creates a label on the target environment after a successful deploy and sets it as the baseline on the source. In addition, it can create a new XML file in the pipeline scripts folder. This XML file contains the changed objects list. This is to keep a static script after changes.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
actionType java.util.List forward false Action type to perform.
dbType java.util.List Oracle false The default RDBMS DBmaestro TeamWork works with.
environmentName java.lang.String   false Name of the source environment in the pipeline project.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
newLabelName java.lang.String   false The name of the new label created during the deployment.
outputParameter java.lang.String ${output} false The name of the output parameter, which can pass the return value from the task. The task output will be the java application output to STDOUT. 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 ${output}.
outputResult java.lang.String ${outputResult} false The name of the output parameter, which holds the text string output from the task. The outputResult will be 'true' if the java application returns without error. The outputResult will be 'false' if an error occurs. 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 ${outputResult}.
pipelineName java.lang.String   false Name of the pipeline project.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
twAutomationJarPath java.lang.String   false Location of the executable JAR file of DBmaestro TeamWork Automation ('TWAutomation.jar').
twServer java.lang.String   false Host server name of DBmaestro TeamWork server.


Back to Top

DBmaestro validate state

Class Name com.midvision.rapiddeploy.plugins.products.dbmaestro.teamwork.tasks.TeamWorkPipelineValidateTask
Category DBmaestro TeamWork

DBmaestro validate state

Description

Runs a comparison without generating any scripts to validate if the environments are identical. Results in a failure code if they are not identical. If any change has been made, a list of changes is generated to a folder that you define in the pipeline configuration tab in the 'Pipeline Work Path' field, categorised as follows: 'OnlyOnTarget', 'OnlyOnSource' or 'Changed'.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
actionType java.util.List forward false Action type to perform.
dbType java.util.List Oracle false The default RDBMS DBmaestro TeamWork works with.
environmentName java.lang.String   false Name of the source environment in the pipeline project.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
fileName java.lang.String   true The path to the "changed objects list" XML file used for the validation.
labelName java.lang.String   true The name of the source environment label used for the validation.
otherEnvironmentName java.lang.String   true Name of the target environment in the pipeline project.
outputParameter java.lang.String ${output} false The name of the output parameter, which can pass the return value from the task. The task output will be the java application output to STDOUT. 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 ${output}.
outputResult java.lang.String ${outputResult} false The name of the output parameter, which holds the text string output from the task. The outputResult will be 'true' if the java application returns without error. The outputResult will be 'false' if an error occurs. 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 ${outputResult}.
pipelineName java.lang.String   false Name of the pipeline project.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
twAutomationJarPath java.lang.String   false Location of the executable JAR file of DBmaestro TeamWork Automation ('TWAutomation.jar').
twServer java.lang.String   false Host server name of DBmaestro TeamWork server.


Back to Top

Add objects

Class Name com.midvision.rapiddeploy.plugins.products.dbmaestro.teamwork.tasks.TeamWorkPipelineAddObjectsTask
Category DBmaestro TeamWork - Detailed tasks

DBmaestro detailed task: Add objects

Description

Adds objects to source control, without using the optional parameters defaults to add all objects in the environment.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
comment java.lang.String   true The comment to be added to the 'add objects' event.
dbType java.util.List Oracle false The default RDBMS DBmaestro TeamWork works with.
environmentName java.lang.String   false Name of the environment in the pipeline project.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
objectsFilePath java.lang.String   true File path to an XML file with the list of objects to be added to source control.
objectsTaskName java.lang.String   true Name of the task associated to the 'add objects' event.
outputParameter java.lang.String ${output} false The name of the output parameter, which can pass the return value from the task. The task output will be the java application output to STDOUT. 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 ${output}.
outputResult java.lang.String ${outputResult} false The name of the output parameter, which holds the text string output from the task. The outputResult will be 'true' if the java application returns without error. The outputResult will be 'false' if an error occurs. 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 ${outputResult}.
pipelineName java.lang.String   false Name of the pipeline project.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
twAutomationJarPath java.lang.String   false Location of the executable JAR file of DBmaestro TeamWork Automation ('TWAutomation.jar').
twServer java.lang.String   false Host server name of DBmaestro TeamWork server.


Back to Top

Apply label

Class Name com.midvision.rapiddeploy.plugins.products.dbmaestro.teamwork.tasks.TeamWorkPipelineApplyLabelTask
Category DBmaestro TeamWork - Detailed tasks

DBmaestro detailed task: Apply label

Description

Creates a label on a specified environment's schemas.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
dbType java.util.List Oracle false The default RDBMS DBmaestro TeamWork works with.
environmentName java.lang.String   false Name of the environment in the pipeline project.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
labelDescription java.lang.String   true A description of the label to be created.
labelName java.lang.String   false The name of the label to be created.
outputParameter java.lang.String ${output} false The name of the output parameter, which can pass the return value from the task. The task output will be the java application output to STDOUT. 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 ${output}.
outputResult java.lang.String ${outputResult} false The name of the output parameter, which holds the text string output from the task. The outputResult will be 'true' if the java application returns without error. The outputResult will be 'false' if an error occurs. 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 ${outputResult}.
pipelineName java.lang.String   false Name of the pipeline project.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
twAutomationJarPath java.lang.String   false Location of the executable JAR file of DBmaestro TeamWork Automation ('TWAutomation.jar').
twServer java.lang.String   false Host server name of DBmaestro TeamWork server.


Back to Top

Apply label and set baseline

Class Name com.midvision.rapiddeploy.plugins.products.dbmaestro.teamwork.tasks.TeamWorkPipelineApplyLabelAndSetBaselineTask
Category DBmaestro TeamWork - Detailed tasks

DBmaestro detailed task: Apply label and set baseline

Description

Creates a new label and sets it as the baseline from a source environment to the baseline environment.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
baselineEnvironmentName java.lang.String   true Name of the baseline environment to be modified.
dbType java.util.List Oracle false The default RDBMS DBmaestro TeamWork works with.
environmentName java.lang.String   false Name of the source environment in the pipeline project.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
labelDescription java.lang.String   true A description of the label to be created.
labelName java.lang.String   false The name of the label to be created.
outputParameter java.lang.String ${output} false The name of the output parameter, which can pass the return value from the task. The task output will be the java application output to STDOUT. 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 ${output}.
outputResult java.lang.String ${outputResult} false The name of the output parameter, which holds the text string output from the task. The outputResult will be 'true' if the java application returns without error. The outputResult will be 'false' if an error occurs. 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 ${outputResult}.
pipelineName java.lang.String   false Name of the pipeline project.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
twAutomationJarPath java.lang.String   false Location of the executable JAR file of DBmaestro TeamWork Automation ('TWAutomation.jar').
twServer java.lang.String   false Host server name of DBmaestro TeamWork server.


Back to Top

Check-in

Class Name com.midvision.rapiddeploy.plugins.products.dbmaestro.teamwork.tasks.TeamWorkPipelineCheckInTask
Category DBmaestro TeamWork - Detailed tasks

DBmaestro detailed task: Check-in

Description

Checks-in objects to source control, without using the optional parameters defaults to check-in all managed objects in the environment.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
comment java.lang.String   true The comment to be added to the check-in.
dbType java.util.List Oracle false The default RDBMS DBmaestro TeamWork works with.
environmentName java.lang.String   false Name of the environment in the pipeline project.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
objectsFilePath java.lang.String   true File path to an XML file with the list of objects to be checked-in.
objectsTaskName java.lang.String   true Name of the task associated to the check-in.
outputParameter java.lang.String ${output} false The name of the output parameter, which can pass the return value from the task. The task output will be the java application output to STDOUT. 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 ${output}.
outputResult java.lang.String ${outputResult} false The name of the output parameter, which holds the text string output from the task. The outputResult will be 'true' if the java application returns without error. The outputResult will be 'false' if an error occurs. 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 ${outputResult}.
pipelineName java.lang.String   false Name of the pipeline project.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
twAutomationJarPath java.lang.String   false Location of the executable JAR file of DBmaestro TeamWork Automation ('TWAutomation.jar').
twServer java.lang.String   false Host server name of DBmaestro TeamWork server.


Back to Top

Check-out

Class Name com.midvision.rapiddeploy.plugins.products.dbmaestro.teamwork.tasks.TeamWorkPipelineCheckOutTask
Category DBmaestro TeamWork - Detailed tasks

DBmaestro detailed task: Check-out

Description

Checks-out all objects of an environment.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
dbType java.util.List Oracle false The default RDBMS DBmaestro TeamWork works with.
environmentName java.lang.String   false Name of the environment in the pipeline project.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
outputParameter java.lang.String ${output} false The name of the output parameter, which can pass the return value from the task. The task output will be the java application output to STDOUT. 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 ${output}.
outputResult java.lang.String ${outputResult} false The name of the output parameter, which holds the text string output from the task. The outputResult will be 'true' if the java application returns without error. The outputResult will be 'false' if an error occurs. 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 ${outputResult}.
pipelineName java.lang.String   false Name of the pipeline project.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
twAutomationJarPath java.lang.String   false Location of the executable JAR file of DBmaestro TeamWork Automation ('TWAutomation.jar').
twServer java.lang.String   false Host server name of DBmaestro TeamWork server.


Back to Top

Enter deployment mode

Class Name com.midvision.rapiddeploy.plugins.products.dbmaestro.teamwork.tasks.TeamWorkPipelineEnterIntegrationTask
Category DBmaestro TeamWork - Detailed tasks

DBmaestro detailed task: Enter deployment mode

Description

Enters all users/schemas of an environment into Integration state.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
dbType java.util.List Oracle false The default RDBMS DBmaestro TeamWork works with.
environmentName java.lang.String   false Name of the environment in the pipeline project.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
ignoreCheckedOutObjects java.lang.Boolean true false Determines if ignoring the checked-out objects or not.
outputParameter java.lang.String ${output} false The name of the output parameter, which can pass the return value from the task. The task output will be the java application output to STDOUT. 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 ${output}.
outputResult java.lang.String ${outputResult} false The name of the output parameter, which holds the text string output from the task. The outputResult will be 'true' if the java application returns without error. The outputResult will be 'false' if an error occurs. 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 ${outputResult}.
pipelineName java.lang.String   false Name of the pipeline project.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
twAutomationJarPath java.lang.String   false Location of the executable JAR file of DBmaestro TeamWork Automation ('TWAutomation.jar').
twServer java.lang.String   false Host server name of DBmaestro TeamWork server.


Back to Top

Exit deployment mode

Class Name com.midvision.rapiddeploy.plugins.products.dbmaestro.teamwork.tasks.TeamWorkPipelineExitIntegrationTask
Category DBmaestro TeamWork - Detailed tasks

DBmaestro detailed task: Exit deployment mode

Description

Exits all users/schemas of an environment from the Integration state and creates a new XML file in the pipeline scripts folder. The XML file contains the changed objects list. This is to keep a static script after changes.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
dbType java.util.List Oracle false The default RDBMS DBmaestro TeamWork works with.
environmentName java.lang.String   false Name of the environment in the pipeline project.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
outputParameter java.lang.String ${output} false The name of the output parameter, which can pass the return value from the task. The task output will be the java application output to STDOUT. 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 ${output}.
outputResult java.lang.String ${outputResult} false The name of the output parameter, which holds the text string output from the task. The outputResult will be 'true' if the java application returns without error. The outputResult will be 'false' if an error occurs. 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 ${outputResult}.
pipelineName java.lang.String   false Name of the pipeline project.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
twAutomationJarPath java.lang.String   false Location of the executable JAR file of DBmaestro TeamWork Automation ('TWAutomation.jar').
twServer java.lang.String   false Host server name of DBmaestro TeamWork server.


Back to Top

Generate between labels

Class Name com.midvision.rapiddeploy.plugins.products.dbmaestro.teamwork.tasks.TeamWorkPipelineGenerateDeploymentScriptBetweenLabelsTask
Category DBmaestro TeamWork - Detailed tasks

DBmaestro detailed task: Generate between labels

Description

Generates a deployment script from a predefined pipeline project and environment to its mapped target environment, between a set of existing label names.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
actionType java.util.List forward false Action type to perform.
baselineLabelName java.lang.String   true The name of the baseline environment label used for the script generation.
dbType java.util.List Oracle false The default RDBMS DBmaestro TeamWork works with.
environmentName java.lang.String   false Name of the source environment in the pipeline project.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
labelName java.lang.String   false The name of the source environment label used for the script generation.
otherEnvironmentName java.lang.String   true Name of the target environment in the pipeline project.
outputParameter java.lang.String ${output} false The name of the output parameter, which can pass the return value from the task. The task output will be the java application output to STDOUT. 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 ${output}.
outputResult java.lang.String ${outputResult} false The name of the output parameter, which holds the text string output from the task. The outputResult will be 'true' if the java application returns without error. The outputResult will be 'false' if an error occurs. 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 ${outputResult}.
pipelineName java.lang.String   false Name of the pipeline project.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
targetLabelName java.lang.String   false The name of the target environment label used for the script generation.
twAutomationJarPath java.lang.String   false Location of the executable JAR file of DBmaestro TeamWork Automation ('TWAutomation.jar').
twServer java.lang.String   false Host server name of DBmaestro TeamWork server.


Back to Top

Generate by tasks

Class Name com.midvision.rapiddeploy.plugins.products.dbmaestro.teamwork.tasks.TeamWorkPipelineGenerateDeploymentScriptByTasksTask
Category DBmaestro TeamWork - Detailed tasks

DBmaestro detailed task: Generate by tasks

Description

Generates a deployment script from a predefined pipeline project and environment to its mapped target environment using a source environments list of tasks.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
actionType java.util.List forward false Action type to perform.
dbType java.util.List Oracle false The default RDBMS DBmaestro TeamWork works with.
environmentName java.lang.String   false Name of the source environment in the pipeline project.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
otherEnvironmentName java.lang.String   true Name of the target environment in the pipeline project.
outputParameter java.lang.String ${output} false The name of the output parameter, which can pass the return value from the task. The task output will be the java application output to STDOUT. 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 ${output}.
outputResult java.lang.String ${outputResult} false The name of the output parameter, which holds the text string output from the task. The outputResult will be 'true' if the java application returns without error. The outputResult will be 'false' if an error occurs. 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 ${outputResult}.
pipelineName java.lang.String   false Name of the pipeline project.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sourceTasks java.lang.String   false A comma-separated list of the source environment tasks used for the script generation.
twAutomationJarPath java.lang.String   false Location of the executable JAR file of DBmaestro TeamWork Automation ('TWAutomation.jar').
twServer java.lang.String   false Host server name of DBmaestro TeamWork server.


Back to Top

Generate latest revision

Class Name com.midvision.rapiddeploy.plugins.products.dbmaestro.teamwork.tasks.TeamWorkPipelineGenerateDeploymentScriptTask
Category DBmaestro TeamWork - Detailed tasks

DBmaestro detailed task: Generate latest revision

Description

Generates a deployment script from a predefined pipeline project and environment to its mapped target environment using the source environments latest revision.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
actionType java.util.List forward false Action type to perform.
dbType java.util.List Oracle false The default RDBMS DBmaestro TeamWork works with.
environmentName java.lang.String   false Name of the source environment in the pipeline project.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
otherEnvironmentName java.lang.String   true Name of the target environment in the pipeline project.
outputParameter java.lang.String ${output} false The name of the output parameter, which can pass the return value from the task. The task output will be the java application output to STDOUT. 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 ${output}.
outputResult java.lang.String ${outputResult} false The name of the output parameter, which holds the text string output from the task. The outputResult will be 'true' if the java application returns without error. The outputResult will be 'false' if an error occurs. 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 ${outputResult}.
pipelineName java.lang.String   false Name of the pipeline project.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
twAutomationJarPath java.lang.String   false Location of the executable JAR file of DBmaestro TeamWork Automation ('TWAutomation.jar').
twServer java.lang.String   false Host server name of DBmaestro TeamWork server.


Back to Top

Generate specific label

Class Name com.midvision.rapiddeploy.plugins.products.dbmaestro.teamwork.tasks.TeamWorkPipelineGenerateDeploymentScriptByLabelTask
Category DBmaestro TeamWork - Detailed tasks

DBmaestro detailed task: Generate specific label

Description

Generates a deployment script from a predefined pipeline project and environment to its mapped target environment using a source environments specific label name.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
actionType java.util.List forward false Action type to perform.
dbType java.util.List Oracle false The default RDBMS DBmaestro TeamWork works with.
environmentName java.lang.String   false Name of the source environment in the pipeline project.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
labelName java.lang.String   false The name of the label used for the script generation.
otherEnvironmentName java.lang.String   true Name of the target environment in the pipeline project.
outputParameter java.lang.String ${output} false The name of the output parameter, which can pass the return value from the task. The task output will be the java application output to STDOUT. 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 ${output}.
outputResult java.lang.String ${outputResult} false The name of the output parameter, which holds the text string output from the task. The outputResult will be 'true' if the java application returns without error. The outputResult will be 'false' if an error occurs. 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 ${outputResult}.
pipelineName java.lang.String   false Name of the pipeline project.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
twAutomationJarPath java.lang.String   false Location of the executable JAR file of DBmaestro TeamWork Automation ('TWAutomation.jar').
twServer java.lang.String   false Host server name of DBmaestro TeamWork server.


Back to Top

Set baseline

Class Name com.midvision.rapiddeploy.plugins.products.dbmaestro.teamwork.tasks.TeamWorkPipelineSetBaselineTask
Category DBmaestro TeamWork - Detailed tasks

DBmaestro detailed task: Set baseline

Description

Sets a label as a baseline from an environment to a baseline environment.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
baselineEnvironmentName java.lang.String   false Name of the baseline environment to be modified.
dbType java.util.List Oracle false The default RDBMS DBmaestro TeamWork works with.
environmentName java.lang.String   false Name of the source environment in the pipeline project.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
labelName java.lang.String   false The name of the label to be used.
outputParameter java.lang.String ${output} false The name of the output parameter, which can pass the return value from the task. The task output will be the java application output to STDOUT. 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 ${output}.
outputResult java.lang.String ${outputResult} false The name of the output parameter, which holds the text string output from the task. The outputResult will be 'true' if the java application returns without error. The outputResult will be 'false' if an error occurs. 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 ${outputResult}.
pipelineName java.lang.String   false Name of the pipeline project.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
twAutomationJarPath java.lang.String   false Location of the executable JAR file of DBmaestro TeamWork Automation ('TWAutomation.jar').
twServer java.lang.String   false Host server name of DBmaestro TeamWork server.