Add configurations for your message types

Lesson 5 of 24 6 min read

Switch on each message type, generate its default settings, and learn how to read and edit the configuration.

An Integration does nothing until you tell it which message types to handle. Each message type gets a configuration: a direction and a set of settings. This lesson shows you how to add one, and how to approach the order configuration, which carries more settings than any other.

Add a configuration

Select Settings → Integration setup → Integrations.
Click the Unleashed Integration to expand it.
Click Configurations to open its list of configurations.
Click + Add in the top right to open the Add configuration window.
Choose a document type from the drop-down, such as Order.
Click Send, Receive or both. Remember these are from Supply Lens' point of view: orders are usually sent into Unleashed.
Click Create Default JSON to fill in the configuration with its default settings.
Click Save.

Repeat for each message type you picked in the planning stage.

What the configuration looks like

The settings are held as JSON, a simple text format of names and values. Create Default JSON gives you a starting point. You then change only the settings you need. Here is a small excerpt of an order configuration:

{
  "defaultOrderStatus": "Placed",
  "useSourceOrderNumberAsSalesOrderNumber": true,
  "completeFulfilledOrders": true,
  "deleteCancelledOrders": true,
  "receive": {
    "orderStatuses": ["Placed"]
  }
}

A few things to know when reading it:

True or false settings switch a behaviour on or off, for example completeFulfilledOrders.
Text settings hold a value such as a status, a product code or a warehouse code. These must match what exists in Unleashed exactly.
Lists in square brackets hold several values, for example the statuses to import.
Maps hold rules: "if the order carries this tag, use this value". The next lesson explains them.
Settings under receive control importing orders out of Unleashed. Everything else controls orders sent into Unleashed.

Defaults worth knowing

Some settings are on unless you turn them off:

Setting	Default	What it does
`validateOrderStatuses`	on	Checks the order's status against your account's statuses before sending
`completeFulfilledOrders`	on	Marks fully fulfilled orders `Completed` in Unleashed
`deleteCancelledOrders`	on	Deletes orders in Unleashed when they are cancelled at source
`allowCustomerSourceIdentifierForCustomerCode`	on	Lets the source system's customer identifier be used as the Unleashed customer code
`receive.orderStatuses`	`Placed`	Only `Placed` orders are imported out of Unleashed

Everything else is off or empty until you set it, and when a setting is empty the behaviour it controls simply does not happen.

Change one thing at a time

When you are testing, change one group of settings, send a test order, and check the result in Unleashed before moving on. If something goes wrong you will know exactly which change caused it.

Hilltop Coffee's first configuration

Priya adds an Order configuration with Send selected and clicks Create Default JSON. She sets defaultOrderStatus to Placed and leaves everything else at its default for her first test. She adds Inventory and Shipment configurations with Receive selected, accepting their defaults.

Recap

Each message type needs its own configuration on the Integration, with a direction.
Create Default JSON fills in a starting configuration; change only what you need.
Text values (statuses, codes) must match Unleashed exactly.
Settings under receive govern importing from Unleashed; the rest govern sending into it.
A few settings default to on, including status validation, completing fulfilled orders and deleting cancelled ones.

Quick guides for this topic

How do I add Unleashed?

Complete and continue

Your progress is saved in this browser. Create a free account to keep it everywhere, take quizzes and earn certificates.

Create the Unleashed Integration How tag rules work