Integration Monitoring Portal - Beta
Kynection have built an Integration Portal to allow our clients to better review and self manage their Integrations. The Portal will allow for the KIM user to understand when an integration is disabled and look into the exception.
This is a Beta Release and is being offered for clients to provide feedback. Kynection will continue to make improvements over the coming months.
The next release will include the ability to view a single item failure, e.g. an invoice, and the design is to allow the client to self manage the rectification of the issue and allow it to be pushed. The single item will no longer disable the Integration and allow for other items to continue to be pushed up.
This is a Beta Release, as the ability to test multiple integrations and large numbers of data push and pull is limited in the Kynection Test database, and so it is expected it will require ongoing improvements and so we welcome feedback, for bug fixes and improvements.
Configuration of the Portal
Once our staff have configured your portal view, integration data will pull into KIM next time the client clicks into the portal.
KIM Integration Monitoring Portal
List View
In this view, you can see all integrations set up with the client KIM, within a sortable, filterable and exportable table as per below:
Names are taken from each integrationID’s ObjectSynchronisation name and cut down to remove the [Source] > [Destination] section, as these Source and Destination values are shown in their own columns.
Source and Destination names are taken from the label of the Connection records/objects in IC.
The on-click functionality for these integration list-items depends on their status - if DISABLED, it will open the Disabled Integration View (single), otherwise it will open the generic Single Integration View.
To refresh this view - pulling/dropping any new/deleted integrations since last fetching integration data, you can click 3 dots > Refresh Integrations.
This will update the view, along with any properties or details contained within.
A full browser refresh will also clear the in-memory cache, auto refresh is not available in this view, only a manual refresh.
Disabled View
This section takes the data pulled from the List View then filters for integrations with status of DISABLED.
Similar to list view, a sortable, filterable and exportable list view of integrations, only displaying those disabled.
Clicking on a disabled integration item, it will take you to the Disabled Integration View (single) for that integration.
Single Integration View
This view displays all the details shown on the List View for a given integration, with the addition of a couple extra properties for that specific API endpoint.
Additional data includes:
- Last Run
- Next Run
Disabled Integration View (single)
This view shows all the details shown in the Single Integration View, with the addition of the 20 most recent logs (filtered down to errors and success/fail alerts).
These logs are presented in a filterable, sortable and exportable table, as pictured below:
For Standard/Manager Users:
- None of the logs where the message is “Object Data” are shown (included in the picture above)
- No expanded error messages - only what is shown above.
For Admin Users, specifically those who have a working knowledge of JSON data structures:
- On-click of list-items (logs), a popup will open with the full error message.
- Object Data logs are included, with on-click popup formatted to display 1 key-value pair per line for optimal readability, and a utility button labelled Copy To Clipboard which does just that.
Chart View
This is a view for clients to view charts for each integration with a 14-day period, summarising how many successful (green) and failed (red) synchronisation attempts have occurred for each day within the period.
We also have a date range selection on the top left of the chart view to define a fortnight at a time in the past.
Kynection live integrations data is only stored for 30 days, we can only fetch data in batches of no more than 14 days due to the enormity of data to be processed - any longer would sacrifice performance and risk timeouts, and not be available. KIM stores data within the client system for longer periods of time,
To ensure access to data outside the 14 day window, the Client needs to accumulate the data in KIM over time by loading the chart view regularly.
If you wish to reset the Chart data, Admins are able to achieve this using the 3 Dots > Wipe Chart Data button.
This is mostly intended for switching between companies in KIM IC Monitoring portal if you have more than one database with us, the Chart View will always have the most up-to-date data on it as it refreshes the last 24 hr period every time you view it.
Using the KIM Integrations Monitoring Portal at least once in every fortnight for 6 months in KIM, the client will be able to view the last 6 months of Historical data in 14 day blocks, but once those records are wiped from KIM you’ll be back to only 14 days worth of data.
Trying to access a date range where data can not be retrieved (whether due to a lack of KIM data, it being in the future or too far in the past) will result in a warning pop up.
