Integration Accelerator — Daily Use
Daily Use
Section titled “Daily Use”Who is this guide for? This guide is for people who already have the Integration Accelerator set up and want to understand how to use it day to day. You will learn how to check if data is being sent correctly, how to spot and fix problems, and how to keep things running smoothly.
Overview: What Happens Every Day?
Section titled “Overview: What Happens Every Day?”Once the Integration Accelerator is set up and running, most of the work happens automatically in the background. The system watches your Business Central data and sends changes to the connected external system without you having to do anything.
However, it is good practice to check in regularly to make sure everything is working as expected. This guide shows you what to look at and what to do if something goes wrong.
The Activities Page — Your Daily Dashboard
Section titled “The Activities Page — Your Daily Dashboard”The Activities page is your starting point for monitoring the Integration Accelerator. It gives you a quick overview of all your integrations and their current health.
How to open it:
Section titled “How to open it:”- Use the search bar in Business Central.
- Search for “Activities” (or “API Activities”).
What you will see:
Section titled “What you will see:”The Activities list shows one row for each integration you have set up. The most important columns to watch are:
| Column | What it tells you |
|---|---|
| Code | The name of the integration activity |
| Active | Whether this activity is currently running |
| Activity Type | What kind of integration this is (Publish Data, Request Data, etc.) |
| Unprocessed Count | How many data changes are waiting to be sent — this should normally be 0 or a small number |
| Failed Count | How many data changes failed to send — this should always be 0 |
| Error Count | How many errors have been logged for this activity |
🚦 What to look for:
- Green / normal: Unprocessed Count is low and Failed Count is 0 — everything is working.
- Yellow / warning: Unprocessed Count is growing — data may be backing up.
- Red / action needed: Failed Count is greater than 0 — some data did not get sent and needs attention.
Checking Outbound Entries (Data Being Sent Out)
Section titled “Checking Outbound Entries (Data Being Sent Out)”For activities that send data out (such as Azure Data Lake or a generic API endpoint), you can see a detailed log of every piece of data that has been sent.
How to open Outbound Entries:
Section titled “How to open Outbound Entries:”- On the Activities page, select the activity you want to check.
- Click Entries in the action bar, then choose Outbound Entries. — or — Open the Activity Card and click Outbound Entries.
What you will see:
Section titled “What you will see:”Each row in the Outbound Entries list represents one data change that was detected and processed. The key columns are:
| Column | What it means |
|---|---|
| Status | The current state of this entry (see status guide below) |
| Table Caption | Which Business Central table this data came from |
| Record ID | Which specific record was changed |
| Publish Type | Whether this was an Insert (new record), Modify (changed record), or Delete |
| Processed Date | When the data was successfully sent |
| Error Count | How many times this entry has failed |
| Queue Date | When this entry was queued for sending |
Understanding the Status:
Section titled “Understanding the Status:”| Status | What it means |
|---|---|
| New | The change has been detected and is waiting to be sent |
| Registered | The entry has been picked up and is being prepared for sending |
| Processed | The data was sent successfully ✅ |
| Failed | The data could not be sent ❌ — action may be needed |
| Cancelled | This entry was manually cancelled and will not be sent |
Checking Inbound Entries (Data Coming In)
Section titled “Checking Inbound Entries (Data Coming In)”For activities that receive data (such as Request Data or Save Request), you can see a log of everything that has been received.
How to open Inbound Entries:
Section titled “How to open Inbound Entries:”- On the Activities page, select the activity you want to check.
- Click Entries in the action bar, then choose Inbound Entries.
What you will see:
Section titled “What you will see:”| Column | What it means |
|---|---|
| Status | Whether the incoming data was processed successfully |
| Registered Date | When the data arrived |
| Processed Date | When the data was processed |
| Result Response | The response that was sent back to the external system |
| Payload | Whether the incoming data payload is stored |
What to Do When Something Goes Wrong
Section titled “What to Do When Something Goes Wrong”Scenario 1: Failed Count is greater than 0
Section titled “Scenario 1: Failed Count is greater than 0”This means some data changes could not be sent to the external system. Here is what to do:
- Open the Outbound Entries for the affected activity.
- Filter by Status = Failed to see only the problem entries.
- Look at the Error Count column — a high number means the system has tried many times.
- Click on a failed entry to see more details about what went wrong.
Common causes and fixes:
| Cause | What to check |
|---|---|
| The external system is temporarily unavailable | Wait and see if the system retries automatically (based on your Maximum Error Retries setting) |
| The Bearer Token has expired | Go to the Activity Card and update the Auth. Bearer Token and its expiration date |
| The Azure credentials are wrong | Check the Client ID, Client Secret, and Tenant ID on the Activity Card |
| The API endpoint URL is wrong | Check the API Endpoint URL on the Activity Card |
💡 Tip: The Integration Accelerator will automatically retry failed entries up to the number of times you set in Maximum Error Retries. If all retries are exhausted, the entry stays as Failed and you need to investigate manually.
Scenario 2: Unprocessed Count is growing
Section titled “Scenario 2: Unprocessed Count is growing”This means data changes are piling up and not being sent. Here is what to check:
- Search for “Job Queue Entries” in Business Central.
- Find the Activity Processor XTE entry.
- Check its Status:
- If it shows Error — click Restart to get it running again.
- If it shows On Hold — someone may have paused it. Change the status to Ready.
- If it shows Ready — it is scheduled to run soon; wait a few minutes.
💡 Tip: The Activity Kick Starter XTE job is designed to automatically restart the processor if it stops. If both jobs are in an error state, restart the Kick Starter first.
Scenario 3: Error Count is greater than 0
Section titled “Scenario 3: Error Count is greater than 0”Errors are logged on the Activity itself. To see them:
- On the Activities page, click on the number in the Error Count column.
- A list of error messages will appear, showing what went wrong and when.
These errors are useful for diagnosing problems. Share them with your IT partner or XtensionIT support if you need help.
Cleaning Up Old Entries
Section titled “Cleaning Up Old Entries”Over time, the Outbound and Inbound Entry logs can grow large. The Integration Accelerator can automatically clean up old entries based on a date formula you set.
How to set up automatic cleanup:
Section titled “How to set up automatic cleanup:”- Open the Activity Card for the activity you want to manage.
- In the Clean Entries Older Than field, enter a date formula.
- Example:
30Dmeans entries older than 30 days will be deleted automatically. - Example:
3Mmeans entries older than 3 months will be deleted.
- Example:
How to clean up manually:
Section titled “How to clean up manually:”- Open the Activity Card or the Activities list.
- Click Entries in the action bar, then choose Clean Entries.
- Confirm when prompted.
⚠️ Note: Cleaning entries is permanent. Make sure you no longer need the log data before deleting it.
Monitoring the Record Monitor
Section titled “Monitoring the Record Monitor”Some activities use a feature called the Record Monitor, which watches for changes in real time. You can see whether it is currently running directly on the Activity Card.
How to check:
Section titled “How to check:”- Open the Activity Card.
- Look at the Monitor Running field in the Publish Data section.
- Green (Favorable): The monitor is running — changes will be detected in real time.
- Standard (grey): The monitor is not running — changes will only be picked up on the next scheduled job run.
Everyday Tips for Smooth Operation
Section titled “Everyday Tips for Smooth Operation”Here are some good habits to keep your integrations running well:
-
Check the Activities page once a day — glance at the Failed Count and Unprocessed Count columns. If both are 0, everything is fine.
-
Keep an eye on Bearer Token expiry dates — if you use a Bearer Token for authentication, note its expiration date and renew it before it expires. An expired token will cause all outbound entries to fail.
-
Do not manually delete Job Queue Entries — if you need to stop an integration temporarily, set the Activity to Inactive instead of deleting the job queue entry.
-
Use the Test System flag — if you are testing changes to your setup, use a separate Activity with Test System turned on. This keeps your live integration safe.
-
Set a Clean Entries date formula — keeping the log tables small helps Business Central run faster.
Summary: Daily Monitoring Checklist
Section titled “Summary: Daily Monitoring Checklist”Use this quick checklist each day (or as often as needed):
- Open the Activities page and check Failed Count and Unprocessed Count
- If Failed Count > 0 → open Outbound Entries, filter by Failed, investigate errors
- If Unprocessed Count is growing → check Job Queue Entries for the Activity Processor
- Check Error Count on any active activities
- Verify Bearer Token expiry dates are not approaching
- Confirm Job Queue Entries are in Ready status