Alter Process

The “alter” command is used to change either Capture or Apply Process parameters. The id parameter can not be changed. The Process has to exist otherwise the command will fail. The Apply Parameter capturename  and the Capture Parameter name can be altered only in the case that it has not been configured earlier.

Note – You can alter the Process even if it is running, however these changes will only be implemented after this Process has been stopped and rerun.

Depending on the process type and  RDBMS type the “alter” command may utilise different set of the parameters. 

The parameters for Capture:

The parameters for Apply:

The command can be invoked from repcli or via REST API or Web UI.

CLI Syntax:

repcli alter process=capture|apply id=processID dbtype=mssql|oracle|others \
[list of parameters to be modified] \
preview=0|1 \
 

 

REST API:

  • Endpoint: https://repstance_url/configure/process
  • Method: POST
  • Header:
    • Content-Type: application/json
    • X-Token: token
  • Body:
    {
      "command": "alter",
      "parameters": [
          ["process","capture|apply"],
          ["id","processID"],
          ["dbtype","mssql|oracle|others"],
          [list of parameters to be modified]
          ["preview","0|1"]
      ]
    }

Server response:

  • HTTP Status – status of the command, possible codes are:
    • 200 – if no error occurs
    • 422 – if error occurs
  • Body:
    {
          "Status":"{Failed|Completed}",
          "Message":"The command execution details"
    }

 

Web UI

 See How to prepare database in Web UI

 

Examples

The following example shows how to modify Capture Process with id=1 to reload data for the“dbo.mytable1”  and instruct corresponding Apply processes to “truncate” table before data loading: 

repcli alter process=capture id=1 loadinclude=dbo.mytable1:T 

The following example shows how to change users' password for the Apply Process (id=1): 

repcli alter process=apply id=1 password=NewPassw0rd123