Development > Client > Redis/JSON

Connector Commands are used throughout DTS to activate and deactivate connectors in components. From a Client's perspective, it will receive Connector Commands to signal the Activation or Deactivation of connectors targeted by the projects currently open in the Client. It may also receive Kick Connector Commands to be notified that it no longer has access to a certain project.

Activation commands will contain the full description of the Connector, including descriptors for all collections, routines and types involved.

Request
Incoming
Target channel	channel assigned to Client with the Registration Command Response - componentChannel
Payload Class Key	"DTS_CONNECTOR_COMMAND"

{

"name" : "",

"projectName" : "",

"connectorEntry" : {

"name" : "",

"type" : "",

"channel" : "",

"replicaCount" : "",

"parametersContainer" : {

"development" : {},

"testing" : {},

"production" : {}

"collections" : [

"remotes" : [

"types" : [

]

"reconnect" : false,

"reason" : ""

}

Attribute		Value	Note
name		The name of the command	"ACTIVATE_CONNECTOR", "DEACTIVATE_CONNECTOR" or "KICK"
projectName		The name of the project that is the subject of the command
connectorEntry		Wrapper for the descriptor of the connector that is the subject of the command	Not used for KICK commands
	name	The name of the connector
	type	The type code of the connector
	channel	Channel assigned to the connector	Not applicable to Client
	replicaCount	Maximum number of producers	Not applicable to Client
	parametersContainer	Wrapper for the connection parameters to a connector's data source.	Not applicable to Client
	collections	The list of collections that the connector can serve as CollectionResource objects	These are full descriptions of the collections served, with fields, types and constraints (only present on activation)
	remotes	The list of remote calls that the connector can serve as RemoteCallResource objects	These describe the details of the native routines that can be accessed with full descriptions of inputs and outputs (only present on activation
	types	The list of non-trivial data types that the connector relies on as TypeResource objects	These are full descriptions of any structure types present in any fields or parameters served by the connector (only present on activation)
reconnect		Only for KICK commands - whether or not a reconnect should be attempted
reason		Only for KICK commands - the reason for being kicked

Response
Outgoing
Target channel	Request replyToChannel
Payload Class Key	"STRING"

The response the client must provide to a Connector Command Request is the "DONE" acknowledgment string. If the request generated errors, the response should be null and the error should be included in the response message's error attribute.