Manage Named Connections

Manage Named Connections is used to create and manage the named connections. A named connection is a named resource that contains a name and a connection to a data source and is stored in an encrypted format. To create the connection via Sequentum Enterprise, we need to Go to "Application Settings Manage Named Connections → Select Connection Type from Create Connection dropdown list" and then fill the required details.

Two types of Named connections are supported in SE:

  1. Database named connections
  2. Remote Storage connections
  1.  Database Named Connections can be used to create and manage the supported database connections by Sequentum Enterprise such as Azure Cosmos DB, MongoDB, MySQL, ODBC, OleDB, Oracle, PostgreSQL, SQL Server and SQLite. The database named connections can be used in the export targets to export your data to your named database connection and can also be used to read the data from databases using the Named Connection as a Data Provider in the Data List command. The following database types are supported:
    • SQL Server - data will export to one or more SQL Server database tables.
    • MySQL - data will export to one or more MySQL database tables.
    • Oracle - data will export to one or more Oracle database tables.
    • OleDB - the data will export to one or more database tables. You can use any database that has an OleDB provider.
    • MongoDB - data will export to one or more MongoDB database collections.
    • Azure Cosmos DB - data will export to one or more collections in an Azure Cosmos DB instance. Note: Only the MongoDB API is currently supported.
    • PostgreSQL - data will export to one or more PostgreSQL database tables.

How to create and manage Database Named Connection

Follow these steps to create database named connection for SQL Server Database:

  • From the Manage Connections window select SQL Server database from the connections type list.

Named_SQL_Server_1.png

  • Fill in the required details for the database named connection such as specify the Connection Name, Description, Server , User Name , Password and Database name and Test the connection.

Named_Cn_ExportDB_2.png

  • Once the SQL Server Connection is Tested and connection is established successfully, Save your connection and it will get listed under the Manage Connections window with options to edit the connection, delete the connection and an additional option to upload the connection to AgentControlCenter if you are logged in to your AgentControlCenter for uploading your connections.

Named_Con_path_3.png

 

ManageConnection-sqlserverDB.gif

Adding SQL Server Named Connection

 

2.  Remote Storage connections can be used to create and manage the supported database connections by Sequentum Enterprise such as AWS S3 Bucket, Azure Storage, Dropbox,  Email, FTP, Google Drive and Google Storage. The remote storage named connections can be added to the export targets to deliver the exported data to remote storage targets.

How to create and manage Remote Storage Named Connections:

Follow the below steps to create an AWS S3 remote storage named connection:

  • From the Manage Connection window select AWS S3 Bucket remote storage.
  • Fill in the required details for the AWS S3 bucket connection such as specify the Connection Name, Add Description for the connection, Add Bucket Name, Add Access key, Add the Secret Key which will be saved and displayed encrypted, and add the Folder Name.

Named_con_S3_demo_1.png 

  • Name: Specify the Named Connection name e.g. "sequentum-demo".
  • Description: Specify the named connection description. This is an optional field.
  • Bucket Name: Specify the bucket name. e.g. "sequentum-test"
  • Access Key: Specify the Access Key for your AWS S3 bucket.
  • Secret Key: Specify the Secret Key for AWS S3 bucket which will be added and displayed encrypted.
  • Folder Name: Specify the folder name s3 browser in which you want to deliver your files. This is also an optional field, if you will not specify any folder name then the Folder name will be created with the agent name automatically.
  • Region ID: Specify the region id. The default region id is "us-east-1". 
  • Use the "Save Test File" button to test the connection and a test file will be uploaded to your AWS S3 Bucket.
  • Once the AWS S3 bucket is Tested and the connection is established successfully Save your connection and it will get listed under the Manage Connections window with options to edit the connection, delete the connection, and an additional option to upload the connection to AgentControlCenter if you are logged in to your AgentControlCenter for uploading your connections.

 

Named_Con_s3_demo_path_2.png

  • After creating the connection, you can add the named connections to your export target to deliver your exported data to your remote storage target. If your export target is set to export data to a file format such as Excel, CSV, Parquet, Json, XML, or a Script, then you can configure your agent to send the data export as a message attachment to one or more email destinations or alternatively, you can FTP the data to a remote server, save it to Google Drive, Google Storage, Azure Storage, Dropbox, etc. 

    To add the remote storage export targets,  navigate to Data   Export Target Configuration   Select Export Target   Select the Connection name, and save it.

Named_Con_s3__Export4.png


Similarly, you can add a Database Named connection export target to export your data to your database.

For the added named connection, you can also define when the result file should be delivered to the added remote storage. There are five options for setting up the Environment. Always, Never, Prod, QA, and Dev. Choose as per your requirements.

 

Named_con_environemnt_5.png

  • Always - It is used to deliver the exported file always. If we want to deliver the exported data to the destination in all the cases such as Completed, Incomplete failed, Completed Unsuccessfully, Dev, QA, Prod, then we use the Always option.
  • Never - If you don’t want to deliver the extracted data to the added remote storage, then you can use this option.
  • Prod - It delivers the data only when the agent runs with the Prod environment and runs successfully.
  • QA - It delivers the data only when the agent runs with the QA environment.
  • Dev- It delivers the data only when the agent runs with the Dev environment.

Create and Manage AWS S3 Named ConnectionManageConnection_S3_Export.gif


Named Connections Through Sequentum Enterprise API

The Sequentum Enterprise also provides API support to create Named connections. The following examples show to create Remote Storage and Databases Named Connection through SE API.


Note: Make sure that Sequentum Enterprise service is running before sending the API request.

API Request URL   

http://localhost:8004/ContentGrabber/CreateNamedConnection?key={key}

key: Use the API access key from the Application Settings>API Access menu in the Sequentum Enterprise editor.

AWSS3

Example:

POST  http://localhost:8004/ContentGrabber/CreateNamedConnection?key=6de336b03c514a9e9309cd3027da4ff3

Body:

{
"NamedConnectionType": "AwsS3",
"ConnectionName": "S3APINamedConnection",
"Description": "AWSS3-NamedConnectionViaAPI",
"AccessKey": "myaccesskey",
"SecretKey": "mysecretkey",
"Region": "us-east-1",
"BucketName": "my-bucketname",
"FolderName": "my-folder-name"
}

Azure Storage

Example:

POST  http://localhost:8004/ContentGrabber/CreateNamedConnection?key=6de336b03c514a9e9309cd3027da4ff3

{
"NamedConnectionType": "AzureStorage",
"ConnectionName": "AzureStorage-APINamedConnection",
"Description": "AzureStorage-NamedConnectionViaAPI",
"StorageType": "File",
"AzureStorageAccountName": "cgstorageacc",
"AccessKey": "myaccesskey3abcd++==",
"FileShareName":"myfileshare",
"FolderName": "[AGENT_NAME]"
}

DropBox

Example:

POST  http://localhost:8004/ContentGrabber/CreateNamedConnection?key=6de336b03c514a9e9309cd3027da4ff3

Body:

{
"NamedConnectionType": "DropBox",
"ConnectionName": "DropBox-APINamedConnection",
"Description": "DropBox-NamedConnectionViaAPI",
"AccessToken": "AAAAAAAAAAcccccessToooookkkeeen",
"FolderName": "myfolder"
}

Email

Example:

POST  http://localhost:8004/ContentGrabber/CreateNamedConnection?key=6de336b03c514a9e9309cd3027da4ff3

Body:

{
"NamedConnectionType": "Email",
"ConnectionName": "A-Email-APINamedConnection",
"Description": "Email-NamedConnectionViaAPI",
"Server": "123.45.678.910",
"Username": "myusername",
"Password": "mypassword",
"Port": 587,
"IsSsl":false,
"FromEmailAddress": "fromemail@address",
"RecipientEmailAddresses": "email@recipient",
"BccEmailAddresses":"email@bcc"
}

FTP

Example:

POST  http://localhost:8004/ContentGrabber/CreateNamedConnection?key=6de336b03c514a9e9309cd3027da4ff3

Body:

{
"NamedConnectionType": "Ftp",
"ConnectionName": "FTP-APINamedConnection",
"Description": "FTP-NamedConnectionViaAPI",
"Protocol": "Ftp",
"Server": "22.23.245.27",
"Port": "21",
"Username": "ftpuser",
"Password": "ftppass",
"RemoteDirectory": "ftpdirectory"
}

Google Drive

Example:

POST  http://localhost:8004/ContentGrabber/CreateNamedConnection?key=6de336b03c514a9e9309cd3027da4ff3

Body:

"NamedConnectionType": "GoogleDrive",
"ConnectionName": "GoogleDrive-APINamedConnection",
"Description": "GoogleDrive-NamedConnectionViaAPI",
"Credentials": "{\"google-drive\":\"credentails\"}",
"FolderName": "google-drive-folder"

Google Storage

Example:

POST  http://localhost:8004/ContentGrabber/CreateNamedConnection?key=6de336b03c514a9e9309cd3027da4ff3

Body:

{
"NamedConnectionType": "GoogleStorage",
"ConnectionName": "GoogleStorage-APINamedConnection",
"Description": "GoogleStorage-NamedConnectionViaAPI",
"Credentials": "{\"google-storage\":\"credentials\"}",
"BucketName": "google-storage-bucket",
"FolderName": "google-storage-folder"
}

MySQL

Example:

POST  http://localhost:8004/ContentGrabber/CreateNamedConnection?key=6de336b03c514a9e9309cd3027da4ff3

Body:

{
"NamedConnectionType": "MySql",
"ConnectionName": "MySql-APINamedConnection",
"Description": "MySql-NamedConnectionViaAPI",
"Protocol": "TcpIp",
"Server": "localhost",
"Username": "root",
"Password": "mysqlpass",
"Port": 3306,
"Database": "[AGENT_NAME]_[AGENT_ID]",
"IsCreateDatabase": true,
"IsDedicatedDatabase": true,
"Charset": "Default"
}

PostgreSQL

Example:

POST  http://localhost:8004/ContentGrabber/CreateNamedConnection?key=6de336b03c514a9e9309cd3027da4ff3

Body:

{
"NamedConnectionType": "PostgreSql",
"ConnectionName": "PostgreSQL-APINamedConnection",
"Description": "PostgreSQL-NamedConnectionViaAPI",
"Username": "postgres",
"Password": "postgrespass",
"Server": "(local)",
"Port": "5432",
"Database": "[AGENT_NAME]_[AGENT_ID]",
"IsCreateDatabase": true,
"IsDedicatedDatabase": true
}

SFTP

Example:

POST  http://localhost:8004/ContentGrabber/CreateNamedConnection?key=6de336b03c514a9e9309cd3027da4ff3

Body:

{
"NamedConnectionType": "Ftp",
"ConnectionName": "SFTP-APINamedConnection",
"Description": "SFTP-NamedConnectionViaAPI",
"Protocol": "Sftp",
"Server": "127.99.0.1",
"Port": "22",
"Username": "sftpuser",
"Password": "sftppass",
"RemoteDirectory": "sftpremoteDirectory"
}

SFTP (Private Key)

Example:

POST  http://localhost:8004/ContentGrabber/CreateNamedConnection?key=6de336b03c514a9e9309cd3027da4ff3

Body:

{
"NamedConnectionType": "Ftp",
"ConnectionName": "SftpPrivateKey-APINamedConnection",
"Description": "SftpPrivateKey-NamedConnectionViaAPI",
"Protocol": "SftpPrivateKey",
"Server": "34.56.550.656",
"Port": "22",
"PrivateKey": "------BEGIN RSA PRIVATE KEY-----
myprivatekey
-----END RSA PRIVATE KEY-----",
"Username": "myusername",
"Password": "",
"RemoteDirectory": "myremote"
}

SQL Server

Example:

POST  http://localhost:8004/ContentGrabber/CreateNamedConnection?key=6de336b03c514a9e9309cd3027da4ff3

Body:

{
"ConnectionName": "SqlServerNamedConnectionTest4",
"NamedConnectionType": "SqlServer",
"Username": "sa",
"Password": "mypass",
"Server": "(local)",
"Database": "TestDb",
"UseWindowsAuthentication": false,
"IsCreateDatabase": true,
"IsDedicatedDatabase": false,
"RecoveryModel": "Simple",
"UseSystemDefaultRecoveryModel": false,
"Description": "This is test connection"
}
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.