Skip to main content
platform

Deploy the Dynamics 365 connector

active
Audience: developerUpdated 2026-10-26

The Binoban connector is one Dynamics 365 solution. Import it, run Set up, connect it to Binoban, pick the tables to capture and press Apply. It takes about 30 minutes and needs no developer and no server access. For what the connector does once installed, see How the Dynamics 365 connector works.

Before you start​

You needWhy
Dynamics 365 CE on-premises 9.0 or 9.1 (Settings → About)The connector is built for these versions only
A System Administrator accountTo import the solution and run Set up
A dedicated CRM user for the connector, for example CONTOSO\svc-binoban, Access Mode Non-interactiveThe connector ignores changes made by its own service user. If you pick your own account, nothing you do is captured
HTTPS from the CRM servers to the Binoban API host, with a trusted certificate and a DNS name (not an IP address)Plug-ins call Binoban directly from the CRM server
The Microsoft Dynamics 365 Asynchronous Processing Service runningCapture and retries run as background jobs
From Binoban: apiHost, sourceIdentifier and apiKeyThe three connection values
Chrome, Edge or FirefoxThe admin page doesn't support Internet Explorer

Install​

  1. Import the solution. Settings → Solutions → Import → choose BinobanConnector_<version>_unmanaged.zip (test org) or the managed export (production) → Import. Then press Publish All Customizations.

  2. Open the admin page at https://<crm-server>/<org>/WebResources/bnb_/admin/index.html and bookmark it. After any upgrade, reload it with Ctrl+F5.

  3. Set up tab → Run set up. It creates the connector's tables, security roles, the API-key field security and its internal steps. It only adds what's missing, so it is safe to run again. When it finishes, every line but the heartbeat workflow says Ready.

  4. Heartbeat workflow. Follow the five steps shown under the Set up checklist (Settings → Processes → New), activate the workflow, then press Start heartbeat. It retries waiting events every 2 minutes.

  5. Connect tab: enter the API host, source identifier and API key. Choose the service user (the dedicated account, never yourself), tick Connector enabled, press Save, then Test connection. It must say OK: Binoban accepted the test call.

    Connect tab: the API host, source identifier and saved API key, a passing connection test, and the service user svc-binoban

  6. Tables tab: tick the tables to capture. Standard tables come pre-filled, marked template. Press Apply: the line under the description lists how many steps were registered.

    Tables tab: six captured tables ticked, and the last Apply result above the list

    To change what a table sends, press Review columns. For each column choose Property (sent on events), Trait (sent on the person's profile; Contact and Lead only) or Exclude. The Note column says why a column starts excluded. Press Save, then Apply again.

    Review columns for Contact: the messages and N relationships to capture, and each column sent as a property, a trait or excluded

  7. Optional: event rules. Event rules tab → pick a table, a column, a from and a to value, type an event name (a–z, 0–9, _, - and . only) and press Add rule. The named event fires in addition to the generic one.

    Event rules tab: two invoice rules, and the Add rule form

  8. Optional: backfill. Backfill tab → tick Contacts and Leads first, optionally set a start date, and press Start backfill. Then do the other tables. Progress shows in the list below the button.

    Backfill tab: the tables to load, with a contact backfill done and a lead backfill running

The connector caches its settings for 5 minutes, so wait that long after changing Connect or Tables before testing.

Check it works​

Signed in as yourself (not the service user), create a test Lead, then check:

  • Outbox tab, Show = All: a lead_created row and an identify row appear within a minute, status Sent, HTTP 200.
  • Health tab: Sent today goes up.
  • In Binoban: the lead arrives as an anonymous profile with the anonymousId lead:<lead id>, carrying a lead_created event. It joins the person's profile once the lead is qualified to a contact.

The Outbox lists every call: Sent (kept 7 days), Pending (waiting for a retry) and Dead-letter (rejected, with Binoban's reason). Click a row to see exactly what was sent; Retry sends it again.

Outbox tab: sent, pending and dead-letter rows, with the payload of a lead_created call below

The Health tab shows today's sent count, how many calls are waiting and for how long, dead-letters, the heartbeat's last run, and a per-table count for the last 24 hours. Drain now sends waiting calls at once.

Health tab: counts for today, the last heartbeat run, Diagnose, and the last 24 hours by table

If it doesn't work​

Start with Health → Run checks. It reads the settings, registered steps, System Jobs and the plug-in trace log in one click, and marks what's blocking in red.

Run checks on a healthy install: every check green, followed by the latest plug-in trace lines

SymptomLikely causeFix
No Outbox row at allThe connector is off, or you are the service userConnect: tick Connector enabled; choose a separate service user → Save → Tables → Apply
Connector jobs stuck in Waiting in System JobsThe Asynchronous Processing Service is stoppedAsk IT to start it on the CRM server
Outbox row Pending with a network errorThe CRM server can't reach Binoban (DNS, firewall, certificate)Fix the network path; rows send by themselves once it works
Banner "Sending is paused"Binoban refused the key or source (401/404)Correct the value on Connect → Test connection; sending resumes
Outbox row Dead-letterBinoban rejected that eventRead the error on the row, fix the cause, press Retry
Apply warns about a messageThat action doesn't exist in this CRM versionUntick it under Review columns → Messages

Go to production​

Once a test org works end to end, export the solution from it: Settings → Solutions → select Binoban Connector → Export → Managed. Install that managed zip in production with the same steps.

Uninstall​

Set up → Before uninstalling → Remove connector steps, then delete the solution. Data already sent to Binoban stays there.