Sources

The source of data in your integration data stream.

Overview

The Source is the configuration that our stream needs to get the information from the Source System. The primary fields are

Source List View

The default page that is shown when clicking on the "Sources" link from the left navigation is the source list page. On this page you can view all of the existing sources of data that you have setup in HighCohesion. Towards the right hand side of each existing row are actions for viewing, editing and deleting existing entries.

Please note that a source cannot be deleted it if is attached to a stream, the source will need to be removed from the stream or stream deleted first.

Creating a Source

1. From the control panel, go to the Source section.

2. At the top right hand side of the page, press the button that says Create Source.

3. This will then load the new Source form. On this form complete the following options:

   1. Title - Give the Key a title that is relative to the source, for example: "Shopify GET Orders" or "GBP Store Orders" etc.

   2. System - This is a drown down list of the systems available in the High Cohesion system. Please select from this list the system that the credentials are for. When you select a system from this list, the page will automatically load available functions in the Source Function box below.

   3. Source Function - This is a dropdown list of the functions available in the System that you have selected in step 2. Please select from this list the functions that you would like to consume the data in for this source config.

   4. Key - The key field is a dropdown list of the keys that have already been setup in your account. Please select the key that is relative to the system and environment that you want to connect to.

   5. Trigger - There are four options available here to control how the source is triggered while the data stream is in use:

      1. Manual - The source is triggered when the user creates a new job manually.

      2. Scheduled - The source is triggered on a cron job. We use cron expressions to configure this option.

      3. Dynamic Web hook - The dynamic web hook configuration creates a new endpoint so that the external source system can send the data directly to it. This type of web hook will send the data directly to the source function.

      4. Static Web hook - The static web hook configuration will create a new endpoint so that the external source system can send the data directly to it. This type of web hook will send the data directly to the core.

   6. Trigger Options - This is an options box for the trigger above, please follow the guidelines below depending on the trigger selected above:

      1. Scheduled - Enter a valid CRON expression for when the source trigger should be ran. See here for help generating a valid CRON expression: https://crontab.guru/

   7. Settings - This box is for adding any additional settings or config for the source. Settings in this box should follow the basic TOML formatting. (https://github.com/toml-lang/toml)

4. Once the settings have been added, press the save button at the bottom left of the page.

5. The new source will now be securely saved and available to use in the system.

Deleting a Source

A source can be deleted from either the list page by clicking on the bin icon, or from the single view page, also by the bin icon.

Please note that a source cannot be deleted it if is attached to a stream, the source will need to be removed from the stream or stream deleted first.