The Integration tile
Lesson 5 of 21 7 min read
Every Integration has a tile of cards that control whether it runs, how it runs and what it handles. Learn what each card does and which ones you'll use most.
Once an Integration exists, everything about how it behaves is controlled from its tile. In this lesson you will learn each card on the tile, the settings to leave alone, and the information you'll need when you contact Support.
Open the tile
On the Integrations screen, click the arrow on an Integration to expand its tile.
Even collapsed, the Integrations list tells you a lot: an Enabled badge on Integrations that are switched on, whether each runs on a schedule and when it next runs, and whether it has webhooks set up.
The cards
| Activation | Enabled or Disabled. When disabled, no data is sent or received on this Integration. |
|---|---|
| State | Live or Test: whether the Integration transmits data as live or test. This usually only has an effect on EDI Integrations and can be left unset otherwise. |
| Configurations | Opens the list of Configurations: which document types this Integration sends and receives. |
| Schedule | Opens the schedule settings. Disabling the schedule means you must run the Integration manually to send and receive. |
| Default Unit of Measure | Sets a unit of measure for quantities received or sent on this Integration. Leave unset to use each Product's defaults. |
| Manual Operation | Run send and receive, run receive only, or run send only, right now. |
| Credentials | View, add, edit and remove the credentials the Integration uses, for example to correct a wrong password without reconnecting. |
| Remove | Permanently removes the Integration and its secure credentials. Documents already processed are not removed. |
Renaming
Click the pencil next to the Integration's name to rename it. Give Integrations names your team will recognise, especially if you have more than one of the same type, such as a live and a sandbox account.
Key and Id
At the bottom of the tile are the Integration's Key and Id. They are set automatically and used by the system. Note the Id whenever you contact Support about an Integration; it's the quickest way for them to find it.
Uninstalled Integrations
If an Integration has been uninstalled on the other system's side (for example, the Supply Lens app removed from a Shopify store), it shows a grey Uninstalled label and a greyed-out panel, and its settings can't be changed. You can still remove it and its saved credentials.
Remove is permanent
Remove permanently deletes the Integration and its secure credentials. Your Documents stay, but to use that system again you would have to connect and configure it from scratch. To pause an Integration, set Activation to Disabled instead.
Priya's tile checklist
For each new Integration, Priya works across the tile in the same order:
- Rename it if needed (Brookside (Mintsoft)).
- Leave State unset, because it isn't EDI.
- Add Configurations (next lesson).
- Set the Default Unit of Measure only if the system always trades in one unit; Shopify gets Bag, Brookside is left unset.
- Set the Schedule (Module 3).
- Only then switch Activation to Enabled.
Recap
- Expand an Integration's tile to reach all its settings.
- Activation turns it on or off; State matters mainly for EDI.
- Configurations decide what it handles; Schedule and Manual Operation decide when it runs.
- Credentials lets you fix connection details without reconnecting.
- Note the Integration Id for Support; disable rather than remove when you want a pause.
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.