Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

At the moment, all of the configuring for order tracking is done in profile.config. It can now also be done directly in WebAdmin panel in the WebViewer but this feature is still in testing.

(warning) Configuration values from WebAdmin will always overwrite those from profile.config when defined. So, if something does not work as unexpected even though your profile.config looks good, it may be because you have different values in WebAdmin.

Because of recent changes, the configuration no longer needs to be nested in an OrderManager configuration block like before. In the new version, make sure to have the OrderTrackingSettings block placed at the document root (outside of the first OrderManager block) otherwise it will not work. Like so:

Code Block
languagexml
<!-- This will work -->
<OrderTrackingSettings enabled="true" dev-mode="false">
  ...
</OrderTrackingSettings>

<OrderManager>
  <OrderManager add-availability-on-orderline="true" enable-external-part-number="true" display-delivery-to-top="true">
  
  <!-- This won't work anymore and will cause an error -->
  <OrderTrackingSettings dev-mode="false">
    ...
  </OrderTrackingSettings>
  
  </OrderManager>
</OrderManager>

...

Code Block
languagexml
<OrderTrackingSettings enabled="true" dev-mode="false">
  <!-- Setting dev mode to true will make tracking stop at the first error and display it in the banner -->
  <CarrierList>
    <Carrier name="DHL" api-key="SECRET" />
    <Carrier name="PostNord" api-key="SECRET" />
    <Carrier name="UPS" api-key="SECRET" />
  </CarrierList>
  <SOSMList>
    <!-- name corresponds to the ID of the status in the WebViewer, site-status corresponds to order status from database orders for current site -->
    <SOSM name="Invoiced" site-statuses="invoiced" />
    <SOSM name="Delivered" site-statuses="Delivered" />
    <SOSM name="Canceled" site-statuses="canceled" />
  </SOSMList>
</OrderTrackingSettings>

(lightbulb) OrderTrackingSettings can be enabled or disabled depending on whether the customer wants to display tracking information on the order page. In order to do so, the enabled attribute to must be set to "true" or "false" whether you want tracking on or off. By default, tracking will be disabled so make sure to add enabled="true" on the opening tag of <OrderTrackingSettings> block.

The actual configuration is split in two parts:

...