Add Configurations
Lesson 6 of 21 7 min read
Switch on each document type an Integration should handle, in the right direction, and get comfortable with the settings editor.
An Integration with no Configurations is a connection that does nothing. A Configuration switches on one document type (orders, shipments, stock levels) on one Integration, in one or both directions. In this lesson you will add Configurations and learn to work with their settings.
One Configuration per document type
You add a Configuration for each document type you want the Integration to work with. Your build sheet from Module 1 already lists them.
Add a Configuration
- Open Settings → Integration setup → Integrations and click the Integration to expand it.
- Click Configurations to open the list of Configurations.
- Click + Add in the top-right to open the Add configuration window.
- Choose a document type from the drop-down.
- Click Send, Receive or both to set the direction.
- Click Create Default JSON to fill in the default settings.
- Review the settings, then click Save.
Direction is from Supply Lens's point of view
Receive brings data into Supply Lens from this system. Send pushes data out of Supply Lens to it. Orders, for example, are typically sent from Supply Lens into Unleashed, and received from Shopify. Getting this backwards is the most common Configuration mistake.
The settings editor
Create Default JSON fills the Configuration with the default settings for that Integration and document type. JSON is a plain-text format for structured settings: names and values in braces and quotes. You don't need to write it from scratch, and for many Integrations the defaults are a sound starting point.
The editor helps you:
- A form and the JSON side by side. Where an Integration offers a settings form, it opens with default values filled in. On wide screens the JSON appears beside the settings and stays in view as you scroll.
- A full code editor for the JSON, with highlighting, folding, search and formatting.
- Checking as you go. Settings are checked against what the Integration expects, and every problem is underlined on the line where it occurs, so you can fix them all at once.
- No empty Configurations. The editor becomes editable once the defaults are ready, and a Configuration can't be saved without settings.
Change only what you understand
If you're unsure what a setting does, leave the default and ask Support or your implementation partner. Settings such as which warehouse an order is sent to, or which status triggers a despatch, change what happens to real orders.
Brookside's Configurations
From her build sheet, Priya adds two Configurations to the new Brookside Integration:
| Document type | Direction | Why |
|---|---|---|
| Warehouse Order | Send | Supply Lens sends Brookside what to pick and pack |
| Shipment | Receive | Brookside tells Supply Lens what it despatched |
On Unleashed she checks the matching Configurations exist: Warehouse Order with Receive on and Shipment with Send on. She clicks Create Default JSON for each new one, reads through the settings without changing anything she isn't sure of, and saves.
Recap
- A Configuration switches on one document type on one Integration, in one or both directions.
- Add them from the Integration's Configurations card with + Add.
- Receive means into Supply Lens; Send means out of Supply Lens.
- Create Default JSON fills in sensible defaults; the editor checks settings and underlines problems.
- Change settings only when you understand their effect.
Quick guides for this topic
Your progress is saved in this browser. Create a free account to keep it everywhere, take quizzes and earn certificates.