Apps Page

The Apps page lists all integrated applications and displays information about Fetches and Syncs. From this page you can add or remove integrations and setup, schedule and manually run Fetches and Syncs.

Page Overview

[insert screenshot overview, e.g. to put the rest of this page into context?]

Toolbar and Metrics

Buttons

• REFRESH ALL - Run all Fetches and Syncs listed on the Apps Table.

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

*Note: You must un-pause the integrations individually using the "Resume" button in the App Table to return integrations to normal

• + APP - Create a new integration and add a new application to the Apps Table

• - Manage Connections: Opens Connections Page. [LINK TO CONNECTION SECTION – maybe here https://docs.violetlabs.com/resources/administrative/integration-permissions] page which provides more details about the integrations, including Server and Owner. Can change API key.

Applications 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.

*Note – An integration can be listed on the App Table multiple times for a variety reasons. For example, if an application includes different Data Types (if they are set up to run fetches on different data types) or fetch frequencies (e.g., get issues hourly but Receipts daily).

• 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 events related to the fetch events for the integration [error / warning / information]/ -> sends a daily email.

  • Configure Sync Event Subscriptions – Subscribe to events related to Sync events of the integration [errors, warnings, health information]. Sends a daily email.

  • 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 choose the application for integration, data types how often to Run Fetches or Refresh Fetches, etc.

Click on arrow to left of integration to show Integration Health Metrics view.

This view displays information related to the health of Fetches and (if applicable) Syncs.

Buttons:

• Select the Refresh Data button 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).

• [Image of Button Here] If integration is set to Push data there is also an on-demand push button below the graph.

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

*Note: Failures show on the timeline for the source of the push. To see more details about the failure, expand status to show error message. Click on Entity link to see specific part that failed.