Creating Data Connections
Next we'll create a new Data Connection to review the fields and options.
Use the app search to find Data Connections, or open through the Tools menu. Then press ADD to create a new Data Connection, or tap an existing row to open
Data Connection Fields
The following table summarizes the fields within the Data Connection app:
| Field | Notes |
|---|---|
| Connection Type | Choose a server endpoint type (SFTP, HTTPS, email, API..details below) |
| Connection Name | Enter a name for the connection (e.g. "My SFTP Server") |
| Host URL | This is the public IP address or DNS name of the server |
| Authorization Type | If HTTPS is chosen for the Connection Type, then an additional authentication method must be chosen. |
| Username | The username for accessing this server |
| Password | The password for accessing this server |
| Default library or path | Optional: list the folder or service path for the server |
Platform Notes
The following note apply to specific data connection types.
Browsing SFTP Servers
For SFTP connections, use the BROWSE CONNECTION button to browse the folders and files on the server. You can use the browser tool to select a folder as the Default library or path select, or leave blank to allow any path.
HTTPS Authorization
For HTTPS connections, select an Authorization Type to configure how the provided credentials are applied during the connection. The following authorization types are supported:
| Authorization Type | Notes |
|---|---|
| Basic | The Username and Password are injected into the Headers of the request in the basic format: Authorization: Basic <base64-encoded(username:password)> |
API Endpoints
API Endpoints are different from other Data Connections in that they create a virtual API endpoint within the SimplyWork platform vs one on the outside. These virtual API endpoints can be called by a remote service to POST data into SimplyWork and trigger import processing.
After selecting API as the Connection Type, use the GENERATE API TOKEN button to generate the virtual API endpoint within SimplyWork. This endpoint will contain a unique token which uniquely identifies this Data Connection.
After generating the API Endpoint token, you can POST XML, JSON and CSV payloads to the endpoint. Those payloads will remain in the API Queue until consumed by a Data Import. See the next section for more details on the API Queue.