Supply Lens

Create and configure the Integration

Lesson 4 of 15 8 min read

Add the Enterpryze Integration, understand its tile, add Configurations for your message types and create the Mappings that route Documents.

With your credentials and codes in hand, you can create the Integration. By the end of this lesson you will have an Enterpryze Integration with Configurations for your chosen message types and the Mappings that connect it to your other systems.

Step 1: add the Integration

  1. Log in to Supply Lens.
  2. Go to Settings → Integration setup → Integrations.
  3. Click + ADD INTEGRATION in the top-right to see the available Integrations.
  4. Click ADD on Enterpryze.
  5. Complete the form with your Enterpryze API username and password.
  6. Click CONNECT.

Open Supply Lens

Step 2: get to know the Integration tile

Click the arrow on your new Integration to expand its tile. Each card controls one aspect of how it runs.

An expanded Integration tile. Every Integration, including Enterpryze, has the same cards.
ActivationWhether the Integration can run. When Disabled, no data is sent or received. Leave it disabled until you are ready to test.
StateLive or Test. This usually only affects EDI Integrations and can be left unset for Enterpryze.
ConfigurationsWhat this Integration sends and receives. You add one per message type.
ScheduleWhen the Integration runs. If you disable the schedule, you have to run it manually.
Default Unit of MeasureForces all quantities to one Unit of Measure. Leave unset to use each Product's default.
Manual OperationRun send, receive, or both, on demand. Useful when testing.
RemovePermanently removes the Integration and its stored credentials. Documents already processed are kept.

Good to know

The Key and Id at the bottom of the tile are set automatically. Note the Id down: Support will ask for your Integration ID if you need help.

Step 3: add Configurations

Add one Configuration for each message type you planned in the first module.

  1. On the Integration tile, click Configurations.
  2. Click + Add in the top-right to open the Add configuration window.
  3. Choose a document type from the drop-down, for example Order.
  4. Click Send, Receive, or both. Remember these are from Supply Lens's point of view: orders going into Enterpryze are a send.
  5. Click Create Default JSON to fill in the configuration with its default settings.
  6. Click Save.

The default JSON gives you a starting point. The settings deep-dive module explains which of those settings to change and why.

Start date is set for you

On orders, a setupDate is set automatically when the Configuration is first created. Only orders created on or after that date are picked up, so going live does not pull in your entire order history.

Step 4: add Mappings

Mappings tell Supply Lens where each Document goes after it arrives.

  1. Go to Settings → Integration setup → Mappings.
  2. Click + ADD in the top-right.
  3. Set the Map, From, As and To fields. For example, map orders from your WooCommerce Integration to your Enterpryze Integration.
  4. Click SAVE.

A Mapping can be narrowed so it runs only for certain Documents, for example a particular customer or Documents carrying particular tags. That matters for Enterpryze, because several settings (such as the Business Partner group a new customer gets) are chosen by the tags on a Document. You can add Target tags on a Mapping so the Documents it creates carry the tags those settings look for.

Step 5: set the schedule

Check the Schedule card so the Integration runs regularly. Leave Activation disabled until you have reviewed the settings and are ready to test.

Fernhill's Integration

Fernhill adds the Enterpryze Integration and three Configurations: Order (send), Inventory (receive) and Shipment (receive). It creates three Mappings: orders from WooCommerce to Enterpryze, inventory from Enterpryze to WooCommerce, and shipments from Enterpryze to WooCommerce. Activation stays off while it works through the settings.

Recap

  • Add Enterpryze from Settings → Integration setup → Integrations → + ADD INTEGRATION, using your API username and password.
  • The tile's cards control activation, configurations, schedule and manual runs. Note the Integration Id for Support.
  • Add one Configuration per message type, choose Send or Receive from Supply Lens's point of view, and click Create Default JSON.
  • Mappings route Documents between Integrations, and can add tags that Enterpryze settings use.
  • Keep Activation off until you are ready to test.

Quick guides for this topic

Complete and take the quiz

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

Before you startChoose a Business Partner strategy