Integrations Dashboard

The Integrations Dashboard provides a centralized view of all integrated applications, along with detailed information about fetches and syncs. From this interface, users can add or remove integrations, configure settings, establish data syncs, and manually refresh or sync data.

Top Toolbar and Performance Metrics

The top toolbar displays performance metrics for Fetches and Syncs, along with several action buttons that support configuration, scheduling, and running processes on demand.

Buttons

• - Create a new integration

• REFRESH ALL - Refresh all data fetches

• PAUSE ALL - Stop all integrations from executing future scheduled fetches and syncs

Note: To un-pause, resume each integration individually using the "Resume" button

Performance Metrics

• Displays the number of recent Successful Fetches, Failed Fetches, currently Running Fetches and Paused Fetches.

Integration Table

Columns

• Name: Name of Application and the data types Violet will fetch from the Application. The data types are listed below the application name.

• Status: Status of ongoing or most recent fetch.

• Syncs To: If the integration is sending data to other applications, they will be listed here.

• Created: Name of user who created the integration and the date and time it was created.

• Actions: Allow you to edit the integration configuration.

  • - Subscribe To: Subscribe to receive updates about fetch events for the selected integration in a daily email.

  • - Configure Sync Event Subscriptions: Subscribe to receive information about sync events for the selected integration in a daily email.

    • From the following window, you can choose what type of events will be included in the subscription email -> Errors, Health Information, or Warnings.

  

  • - Fetch Updates: Run a fetch. Click button again mid-fetch to cancel/stop the fetch process.

Note: The run fetch button only looks for changes since the last fetch. If you want to do a full fetch of all data you will need to select the “Refresh Data” from the Integration Health Metrics “view".

• - Pause: Pauses scheduled fetches.

• - Resume: Resumes scheduled fetches.

• - Edit: Opens the Configure App menu, which allows you to reconfigure the integration. From this menu, you can change the application, adjust data types, and define how often to run or refresh Fetches.

More than one integration can be created for a given application in order to fetch different data types on different frequencies, support different permission schemes for different data types etc.

Integration Metrics

Click on an integration row to view its performance metrics, including the fetch and sync duration over time.

Buttons

• Refresh Data: Click this button (located under the Fetch Time graph) to run a Full Fetch of all data from the integration. Unlike the “Run a Fetch” button which only looks for changes since the last fetch, the Refresh Data button will review all data for the requested data type(s).

• If integration is set to Push Data there is also an on-demand push button below the graph.

• Integration Timeline: In the top right corner of the Integration Health Metrics view allows to view the details for each Fetch or Pull.

To see failures in data syncs, navigate to the timeline of the source integration for that data sync (ie. where the data originates). To see more details about the failure, expand the status to show the error message. Click on Entity Link to navigate to the specific entity that failed.