A connection is a definition of inbound and outbound integrations. The Connections page is available from the main menu (  ) and selecting the submenu items Connections or if already within the Resources pages via the connections icon ().

The defined connections will be available for users to utilize when building an app. A connection can be used to pull files/tables in apps. 

Adding a New Connection

1. Click to open the Connections screen.
2. Click the plus icon () to add a new connection.
3. A "Create Connection" box will appear.
4. Name - Provide a unique name for the connection. This value is uneditable once the connection is created.
5. Connection Type - Select the 'Connection Type' from the dropdown list.
6. Provide values for detailed fields; these fields vary based on the connection type selection.
7. Click 'Create'.

The new connection will appear on the 'Connections' screen and will be available for use within an app.

Connection Type Configurations

Adobe API

Defines the credentials the Syntasa application will need to establish a connection with the Adobe API providing the ability to pull eVar, sProp, and Event definitions and turn on the automated auditing feature of Syntasa. There are two options to choose from, Company and Environment. For customers, it is recommended to use Company; for dev or testing environments it is recommended to use Environment. 

• Company
  
  • Company - Customer's company name registered with Adobe Analytics.
  • Username - Adobe API username.
  • Password - Adobe API password.
• Environment
  • Environment - Select from a dropdown menu of available Adobe environments.
  • Username - Adobe API username.
  • Password - Adobe API password.

Azure Storage

Microsoft's cloud warehouse solution:

Big Query

Google's cloud warehouse solution provides for very fast querying.

• ProjectID - Name of the project where the BQ instance is located.
• Use Instance Profile
  • On (green) - No further information is needed.
  • Off (grey)
    • Key File Upload - JSON file with project private key.

Database

FTP

Defines host and credentials for creating FTP connector.

• Host - FTP server location
• Port - for FTP this is typically set to 21
• Username - customer-provided username
• Password - customer-provided password

GCS

Google Cloud Storage, is also referred to as "GCS bucket". 

• Use Instance Profile selection - provides the option of using the credentials in the GCP instance profile or uploading a JSON with the private key information.
  • On (green)
    • Bucket - GCS location
    • Project ID - project the GCS bucket is associated with
  • Off (grey)
    • Bucket - GCS location
    • Project ID - project the GCS bucket is associated with
    • Key File Upload - field to upload the private key JSON format file

S3

Simple Storage Service - This is an Amazon cloud storage service also referred to as "S3 bucket"

• Use Instance Profile
  • On (green)
    • AWS End Point - This is the AWS web address for accessing the storage bucket
  • Off (grey) 
    • Access Key ID - S3 access key
    • Secret Access Key - S3 secret key
    • Bucket - the name of the bucket to be used for the connector
• Enable V4 - leave off, Syntasa services professionals will advise if this should be turned on.

SFTP

Defines host and credentials for creating SFTP connector

• Host - SFTP server location
• Port - for SFTP this is typically set to 22
• Auth Type
  • Password - uses a username/password combination for authentication
  • Key - ability to upload key file for authentication

Matomo API

  To streamline the ingestion of Matomo data, there's a new connection type ‘ Matomo API’ connection.

Name -  Should be a unique Connection name. This value is noneditable once the connection is created.

Connection Type - Select Matomo API from the dropdown list. This value is noneditable once the connection is created.

Tags -  Custom free text field to help segment jobs in the job logs. Users can create a new tag or select from the existing dropdown list

Url - Provide a valid URL, should be a mandatory field

Protocol - Should select either Http or Https from the dropdown list

SSL Cert - Matomo connections can authenticate using SSL. The user can upload the SSL Cert File once the SSL cert is checked

Auth Type - The Syntasa platform supports multiple types of authentication mechanisms to securely allow the users to access the platform. Users can either select Auth Type as Token or PKI. If the user selects Auth Type as Token then should provide Auth Token. PKI authentication mode allows the users to use the digital PKI certificate that can be imported into the user browser to authenticate with the Syntasa platform.

Test Connection - When creating a new connection you can now test it right away, even before saving, to ensure it's in working order before trying to use it in an app.

Pick a sharing option- When creating a new Connection the sharing option selection will be available to make the runtime available as Private, Public, or Group. Regardless of the selection, a user with the role of System Admin will always have access to all connections. The sharing option selected at the time of creating the connection can be changed by the owner or a system administrator. 

Private- Private can be set by the owner (or the system administrator) to limit access to the Connection only to the owner. System administrators can also access the Connection set to private.

Public- Public is the default setting. All users have access to the Connection

Group- Group can be set by the owner (or the system administrator) to limit the access to the user group(s) assigned to the Connection. As with private, the system administrator can view components with the sharing option set to the group regardless if they are a group member.

Owner- The owner of the Connection is by default the user that is creating the Connection. This can be changed, if needed, by the owner or the system administrator, after the Connection is created.

 

Socket

          Socket Connection is mainly used while creating streaming apps 

Name -  Should be a unique Connection name. This value is non-editable once we create the connection.
Connection Type - Select Socket from the dropdown list. This value is non-editable once we create the connection.
Tags -  Custom free text field to help segment jobs in the job logs. Users can create a new tag or can select from the existing dropdown list.
Socket Type - The user can select either TCP or UDP from the dropdown list.
Host - Here you have to provide the server Location
Port - Provide valid Port details.
Test Connection - When creating a new connection, you can now test it right away, even before saving, to ensure it's in working order before trying to use it in an app.
Pick a sharing option- When creating a new Connection, the sharing option selection will be available to make the runtime available as Private, Public, or Group. Regardless of the selection, a user with the role of System Admin will always have access to all connections. The owner or a system administrator can change the sharing option selected at the time of creating the connection.
Private- Private can be set by the owner (or the system administrator) to limit access to the Connection only to the owner. System administrators can also access the Connection set to private.
Public- Public is the default setting. All users have access to the Connection
Group- Group can be set by the owner (or the system administrator) to limit the access to the user group(s) assigned to the Connection. As with private, the system administrator can view components with the sharing option set to the group regardless if they are a group member.
Owner- The owner of the Connection is by default the user that is creating the Connection. This can be changed, if needed, by the owner or the system administrator, after we create the Connection.

Adobe Live Stream

        Adobe Live Stream Connection is mainly used while creating streaming apps 

Name -  Should be a unique Connection name. 
Connection Type - Select Socket from the dropdown list. 
Tags - Custom free text field to help segment jobs in the job logs. Users can create a new tag or can select from the existing dropdown list.
Token URL - Provide a valid URL, which should be a mandatory field
Livestream URL - Provide a valid Livestream URL, should be a mandatory field.
Client ID - Client ID is typically the ID used and must be integrated with the system
Client Secret - Provide a valid key, which is a mandatory field.
Key File Upload - Field to upload the private key in JSON file format.
Test Connection - When creating a new connection, you can now test it right away, even before saving, to ensure it's in working order before trying to use it in an app.
Pick a sharing option - When setting up a connection, select Private, Public, or Group. But note that a System Admin always has access. The owner or admin can modify the sharing option later.

Private - Owners and system administrators can set private access to Connections.
Public - Public is the default setting. All users have access to the Connection.
Group - Owners and system administrators can restrict user access to a Connection by setting a group. They can still view shared components, even if not a group member.
Owner - The owner of the Connection is by default the user that is creating the Connection. This can be changed, if needed, by the owner or the system administrator, after we create the Connection.