Create Connection configuration

This page describe the parameters to use to create/edit a connection.

Main object

Field	Data Type	Description
ConnectionType	string	Type of the connection - SQLServer/MySQL/DMM_REST/Oracle/SFTP
ConnectionName	string	Connection name (will update the a connection if the name already exists)
ServerName	string	Server URL
InitialCatalog	string	SQLServer and MySQL Initial Catalog; SFTP base folder
Username	string	connection user
Password	string	connection user password
Token	string	If the connection type is DMM_REST, this is the REST API key
Port	integer	If the connection type is Oracle, this is the port to use
SID	string	If the connection type is Oracle, this is the SID or Service Name to use
OracleServerType	string	If the connection type is Oracle, this is the Server Type to use (Dedicated, Shared or Pooled)
SID_ServiceName	integer	If the connection type is Oracle, set to 1 to use a Service Name and with 2 if to use SID
OracleSchema	string	If the connection type is Oracle, this is the schema to use
IsNonOutsystemsDB	boolean	true if this is an external database to be used in the export to database

Sample SQLServer Configuration

JSON

{
	"ConnectionType" : "SQLServer",
	"ConnectionName" : "MSSQLConnection",
	"ServerName" : "url.com",
	"InitialCatalog" : "initCatalog",
	"Username" : "user",
	"Password" : "pass",
	"IsNonOutsystemsDB" : false
}

Sample Oracle Configuration

JSON

{
	"ConnectionType" : "Oracle",
	"ConnectionName" : "OracleConnection",
	"ServerName" : "url.com",
	"Port" : "1521",
	"SID" : "serviceName",
	"OracleServerType" : "DEDICATED",
	"SID_ServiceName" : 1,
	"OracleSchema" : "ADMIN",
	"Username" : "user",
	"Password" : "pass",
	"IsNonOutsystemsDB" : false
}

Sample REST Connection

JSON

{  
	"ConnectionType" : "DMM_REST",  
	"ConnectionName" : "RestConnection",  
	"ServerName" : "https://url/DMMAPI_Api/rest/DMM_API",  
	"Token" : "abc123",
	"IsNonOutsystemsDB" : false  
}

Sample SFTP Connection

JSON

{  
	"ConnectionType" : "SFTP",  
	"ConnectionName" : "SFTPConnection",  
	"ServerName" : "sample.sftp.com",
  "InitialCatalog": "/",
  "UserName": "user",
  "Password": "pass",
	"IsNonOutsystemsDB" : false  
}