How do I connect a new system to Supply Lens?
Add an Integration
Create an Integration for any system, set up its tile, add Configurations and Mappings, and run it for the first time.
About 6 min
This guide gets any system from "not connected" to a working Integration: created, configured, routed with a Mapping and run once. If your system has its own guide, such as Add Xero or Add Shopify, use that instead.
Before you start
- Check your system is available. See Available Integrations.
- Credentials for the other system, usually an API key, token or sign-in. If you don't have admin rights there, ask whoever does to generate them or sit with you while you connect.
- Aligned product codes. Every SKU that will appear on Documents should exist, in exactly the same format, in the system that receives them. See Align your SKUs.
- A plan of your flows: which document types this system sends and receives, and where each one goes. The Plan your data flows lesson shows you how.
Steps
1. Create the Integration
- Go to Settings → Integration setup → Integrations.
- Click + ADD INTEGRATION in the top-right to show the available Integrations.
- Search for your system and click ADD on it.
- Complete the form. It varies from Integration to Integration. Secret fields are masked as you type; use the show button beside a field to check what you've pasted. If your login can reach more than one account, you may be asked which one to use.
- Click CONNECT. Your new Integration appears in the list.
2. Set up the tile
Click the arrow on the Integration to expand its tile.
- Rename it with the pencil next to its name if you'll have more than one of the same type.
- Leave Activation disabled until it's configured.
- Leave State unset unless it's an EDI Integration.
- Set Default Unit of Measure only if this system always trades in one unit; otherwise leave it unset.
Every card is explained in Integration settings.
3. Add Configurations
Add one Configuration per document type the Integration handles, choosing Send (out of Supply Lens) or Receive (into Supply Lens). See Add a Configuration.
4. Add Mappings
Create a Mapping for each flow that starts or ends at this Integration. See Add a Mapping.
5. Switch it on and run it
- Set Activation to Enabled.
- Under Manual Operation, click Run send & receive (or Run send or Run receive).
- When you're happy, set a Schedule so it runs by itself. See Set an integration schedule.
Check it worked
- The Integration shows an Enabled badge in the list.
- After a run, new Documents from this system appear in Supply Lens (for example under Sales →
Orders), or Documents you routed to it have Target Data with the status
Sent. - Open a Document and check it has green ticks beside its parties and lines, which means they were matched to your records.
If something goes wrong
- Nothing arrives or is sent. Check Activation is enabled, the Configuration direction is right, and a Mapping exists and is enabled. See Fix a Document not reaching its target.
- The connection fails. Check the credentials in the other system and correct them on the Credentials card. See Update integration credentials.
- Documents fail with a product error. A SKU doesn't match. See Fix "product does not exist".
When you contact Support, quote the Integration's Id from the bottom of its tile.