Skip to content

Connection General Information#

INFO

Find here general information that is valid for all connections.

General Information#

INFO

Once you create the connection, you can import data into it. See Importing Data to learn more.

See Types of Data Supported for information about the types of data you can use with Spectrum.

Connections are a collection of data from different sources such as various types of files and databases.

INFO

If you want to create a connection for a database type such as DB2, MySQL, or Oracle, you need to add the appropriate database drivers to your Spectrum installation. To create a connection for a database type that you don't see listed in the file type list, you need to first add the appropriate database drivers to your Spectrum installation.

Viewing a Connection Details Page#

INFO

The 'Connection Details' page provides information of:

  • Connection name: e.g. 'Connection Tableau'
  • Description: if you inserted a description during the first configuration
  • Datastore usage: e.g. 'IMPORT_EXPORT'
  • Authentication Mode: e.g. 'TEMPORARY'
  • Url or Uri: connection URL, e.g. 'jdbc:mysql://localhost:3306/dap?tinyInt1isBit=false'
  • Transfer Protocol: e.g. 'Spectrum server filesystem'
  • userName: user name for authentication
  • password: password for authentication
  • Connection type: e.g. 'Database'
  • driverClassName: name of the driver e.g. 'com.mysql.jdbc.Driver'
  • Owner: e.g. 'admin'
  • shared with: the group with the needed right to view, edit or run a connection and your personal user rights, e.g. 'You are allowed to view and edit.'

INFO: Not all entries are available for all connections.

INFO: For connections where authentication options are available (JDBC, SSH and SFTP connections), the valid one out of the two authentication modes is displayed: 'TEMPORARY' or 'PROVIDED'. For JDBC/ MySQL connections, the valid one out of three authentication modes is displayed: 'TEMPORARY', 'PROVIDED' or 'SESSION_BASED'. 'SESSION_BASED' is only displayed when the flag '-Denable.authenticationOnJobRun=true' is set.

To open a connection details page:

  1. Right-click on the connection and select "Show Details". The 'Connection Details' tab opens.

  2. View the connection information.

Creating a Connection#

INFO

For each connection type, different connection setting details are needed. Find the required connection for web services, files, cloud storages, databases and others in the subpages.

To create a connection:

  1. Select "+" and then select "Connection" or right-click on a folder in the File Browser and select "Create New" and then "Connection". A 'New Connection' tab opens.

  2. Select the required connection type from the drop-down in section 'Type' and confirm with "Next". The section 'Connection Details' opens.

  3. Enter the required settings and confirm with "Next". The dialog 'Save Connection' opens.

    INFO: The 'Connection Details' fields adjust to the type of connection and can differ.

  4. If needed, enter a description and confirm with "Save". The dialog 'Save Connection' opens.

  5. Select the name and storage location of the connection and confirm with "Save". The connection is saved.

Duplicating a Connection#

To duplicate a connection:

  1. Right-click on a connection and select "Duplicate". The 'Duplicate Connection' dialog opens.

  2. Enter the name of the duplicated connection and confirm with "Duplicate". The connection is duplicated.

    INFO: The name of the duplicated connection must not be equal with the original connection.

Editing a Connection#

To edit a connection:

  1. Right-click on the connection and select "Open". The connection settings tab opens.

  2. Click "Next". The tab 'Connection Details' opens.

  3. Change the entries according to your needs and confirm with "Next". The 'Save' tab opens.

  4. If needed, change the description. Confirm with "Save". Editing the connection is finished.

Renaming a Connection#

To rename a connection:

  1. Right-click on the connection and select "Rename". The connection name appears in the edit mode directly in the 'File Browser'.

  2. Enter the new connection name and confirm with "Enter". The new connection name is saved.

Deleting a Connection#

To delete a connection:

  1. Select the required connection in the 'File Browser', right-click on it and select "Delete". The dialog 'Delete Connection' opens.

  2. Confirm with "Delete". The connection is deleted.