Deploy

Summary

Use the DEPLOY command to migrate all domain objects from one Connect environment to another. For example, your project team may have developed Connect ETL steps and pipelines in the Sandbox environment. After system integration tests pass, you may want to promote or migrate the domain objects to your production instance running on one of the Securex environments. DEPLOY provides a systematic way to migrate the domain objects and code.

Domain objects include steps, pipelines, iterators, schedules, emails, and variables.

Syntax

deploy [synchronous] to <environment_string>(username=<string>, password=<string> [, snapshotid=<string>, merge=<boolean>]);

Parameters

Parameter	Description
synchronous	(Optional) When the command is called from an ODBC client such as isql, determines if Connect returns control immediately to the caller or after the `DEPLOY` command completes. `DEPLOY` runs asynchronously by default, i.e. the command returns control immediately to the caller but runs in the background on the server. Use `SHOW INVOCATION DETAILS` to determine the run status for a given `DEPLOY` invocation.
username	(Required) The Incent/Connect user name for the target system. May differ from the credentials you used to login to the Connect source system. The user must have full Read-Write access to the Xactly Connect role (configured from the Incent UI).
password	(Required) The Incent/Connect user name’s password for the target system. May differ from the credentials you used to login to the Connect source system.
snapshotid	(Optional) Instructs `DEPLOY` to migrate a particular snapshot found on the source system to the target system. If omitted,`DEPLOY` will take a snapshot of and migrate the current source environment to the target system.
merge	(Optional) Instructs `DEPLOY` to merge the objects in target if the value is true. If omitted or the values is false, `DEPLOY` will overwrite the objects in the target.

Details

Follow these general steps to deploy all domain objects from one Connect environment to another:

Login to the source Connect environment. The source environment has the domain objects you want to move to another target Connect environment.
(Optional) In the source environment, run CREATE SNAPSHOT to create a savepoint for your existing domain objects.
(Optional) Execute SHOW DEPLOY TARGETS to list all available Connect target systems for this source system. Choose the target system that corresponds to the environment your Incent instance runs on. You can determine this by logging into the target system Incent UI via a web browser. Look at the server name in browser window after you log in.
Finally from the source system, run the DEPLOY command. It will transfer all domain objects to the target environment. You have the option to use the “current’ domain objects or prior versions stored from an earlier snapshot savepoint you or another developer may have made.