Show Process

The show command shows the configuration that is stored for a Capture Process or an Apply Process: the parameters that have a value, without the ones that have the default. It shows what is stored now, which is not necessarily what the running process uses: a change made with Alter Process is used after the process has been stopped and run again.

The values are shown as they are stored, including the passwords and the keys. Do not leave the output of the command where other people can read it.

Command line (repcli)

repcli show process=capture|apply id=processID
ParameterDescription
processcapture or apply.
idThe identifier of the process.

The output is a line for every parameter, in the order of the names. The transformation rules come last:

repcli show process=capture id=2
[Completed]: Capture parameters:
  dbname=testDB
  dbtype=mssql
  ddlinclude=dbo.%
  dmlinclude=dbo.%
  name=SQLServerCap2
  password=Passw0rd123
  port=1433
  server=db-src.example.com
  user=repuser
repcli show process=apply id=4
[Completed]: Apply parameters:
  capturename=SQLServerCap2
  dbname=testDB
  dbtype=postgresql
  ddlprocessing=map
  password=Passw0rd123
  port=5432
  server=pg-tgt.example.com
  user=repuser
  map=1,rule=(dbo.%:public.%)

All the stored parameters are shown, also the ones that are not on the form of the Web UI and the ones that the pages of the parameters do not list. The id and the process are not repeated, and a parameter that has been removed with the value default is not shown (see Alter Process).

REST API

  • Endpoint: https://repstance_url/configure/process
  • Method: POST
  • Header: Content-Type: application/json and X-Token: token

The body of the request:

{
  "command": "show",
  "parameters": [
    ["process", "capture"],
    ["id", "2"]
  ]
}

The body of the answer. Message is the text that repcli prints, parameters is the same list of the parameters as [name, value] pairs:

{
  "Status": "Completed",
  "Message": "Capture parameters: \n  dbname=testDB\n  dbtype=mssql\n  ddlinclude=dbo.%\n  dmlinclude=dbo.%\n  name=SQLServerCap2\n  password=Passw0rd123\n  port=1433\n  server=db-src.example.com\n  user=repuser",
  "parameters": [
    ["dbname", "testDB"],
    ["dbtype", "mssql"],
    ["ddlinclude", "dbo.%"],
    ["dmlinclude", "dbo.%"],
    ["name", "SQLServerCap2"],
    ["password", "Passw0rd123"],
    ["port", "1433"],
    ["server", "db-src.example.com"],
    ["user", "repuser"]
  ]
}
HTTP codeMeaning
200The request is valid. The status is Completed.
401The token is invalid.
422The request is invalid, for example the process does not exist: the status is Failed and the message is Invalid Process ID has been supplied.

Web UI

Click “Edit” on the card of the process. The form shows the configuration of the process, and the parameters that are not on the form are listed in “Advanced Settings”. The form is described in Edit Replication Processes.