Testing your project in boxwise

This guide will help you test your newly created Shipping Integration Plugin project in boxwise. If you haven't deployed your project to boxwise yet follow the steps in this article: Deploying your project to boxwise first.

Make sure the plugin is active

1. Start the boxwise server
2. Logon into the boxwise management portal
3. Click System>Plugins
4. Check if your project is visible there. If you followed the guides using the default naming there should be a plugin in the list called Company.Plugin with version 1.0.0.0 and it is Active ✔.
5. If the plugin is there but it is not active please activate it by selecting the plugin and clicking the button ✔ Activate.

Sample of the result

Test the Settings page

1. Start the boxwise server
2. Logon into the boxwise management portal
3. Click Settings>Transport
4. There should be a table specifically for your plugin called Company.Plugin

The settings you see on this page are essentially the settings that are defined in the Settings.cs file in your project. You can define settings there that will be automatically converted into fields on this page.

⚠ Setting field names need to be unique

Please make sure your setting names will be unique by giving them all the prefix of your project name because otherwise they might collide with setting from other parts of boxwise. See below for a sample.

using System.Collections;
using Wms.RemotingObjects.Settings;
using Wms.RemotingObjects.Settings.MetaData;

namespace Company.Plugin
{
  public class Settings: SystemSettings
  {
     ....

     [Group("1S", "Security"), Label("API Key")]
     public string CompanyPluginApiKey = "";

     ....
  }
}

Sample of the result

Test creating a shipment

1. Start the boxwise Touch
2. Login to your server
3. Press Pick in the menu
4. Select a customer to Batch and Pick an order for
5. Press Create batch in the menu
6. Press Confirm
7. Press Select Batches
8. Select the Batch you just created
9. Create your colli and pack your items
10. Press Process
11. After processing the Shipping window will show and it will contain your newly created Shipping Integration Plugin Button.
12. Select your Shipping Integration Plugin Button and select a Service
13. Press Ship Now
14. The shipment will be created now and the windows will disappear
15. Logon into the boxwise management portal
16. Go to Historical>Shipments
17. Here you can see your created shipment
18. Go to Print Management > Print Jobs
19. Here you can see the prints that have been created

Sample of the result

Debug messages

You can write debug messages to boxwise using the LogSink class defined in the Wms.RemotingObjects.ShippingLayers namespace.

To see this debug messages go to System > Db log in the management portal. Make sure the LogLevels Debug and Trace are enabled.

Summary

1. ✅ You verified if the plugin is active
2. ✅ You know where to find and adjust settings for your plugin project and you know where to create new ones
3. ✅ You know how to test your plugin project by creating a new shipment

The next step is to learn how to debug your code while it is running within boxwise. To do this you can follow this guide: Debugging your project