Versions Compared

Key

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

System Setup / Plugin Customization / Plugin Configuration [SET062] .

The TMS Address Validation plugin is required to check that the address the order must be shipped to is correct. This helps you avoid penalty fees for incorrect addresses, particularly on small parcel orders.

The address validation feedback will display in the Address Validation column in the TMS Order Query screen’s data grid.

image-20240328-123848.png
Info

If you don’t like reading, you can watch the video.

Panel
panelIconId1f3a5
panelIcon:movie_camera:
panelIconText🎥
bgColor#DEEBFF

<link to YouTube video>

<link to PDF doc on my OneDrive>

None

Try it!

Plugin details

Type

Plugin Name

Interface

Location

Method Name

Module

Linked Action

TMS

TMS Address Validation

ITMSAddressValidation

DATASCOPE.SDK.PluginInterfaces

 

TMS Initial Order Rate Shop Service

Address Validation Step

Most of the logic within the TMS module is based on plugins, and not core code. This is because we deal with external cloud-based solutions (ProShip, Logistyx, FreightPOP, etc.) via our plugins, and these external TMS systems integrate with FedEx, UPS, USPS, and other Carriers.

<detail>

To develop your own plugin:

For more information regarding building the plugin, refer to the high-level overview on how to build a basic plugin - Developing your own plugins

Info

Strong development skills are required in order to develop your own plugins.

For more information, refer to What is needed to work with Plugins?

  • Open a Class Library Project within Visual Studio

  • Insert the DATASCOPE SDK

  • Insert the inheritance from the DATASCOPE SDK

  • Select the required Interface.

  • Write your code as per your own requirement.

  • Build it into a single .dll file and save it in the C:/ Program Files / DATASCOPE / DATASCOPE WMS WebAPI / Plugins folder on the server.

  • Test it in the module.

To configure this plugin:

  • From the Main Menu, browse to System Setup / Plugin Customization / Plugin Configuration

  • Select TMS Address Validation from the Plugin Name drop-down.

  • Select ADDfrom the Action drop-down

  • Enter a Display Name (i.e. TMSAddressVal)

  • Add the compiled DLL file name, developed by a developer, in the Dll FileName field - for example TMSAddressVal.dll

Info

The DLL file name added into the Dll FileName field must be exactly the same as the .DLL file saved in the C: / Program Files (x86) / DATASCOPE / DATASCOPE WMS WebAPI / Plugins folder.

Info

All the Plugin .DLL files are located on the DATASCOPE WMS server under C: / Program Files (x86) / DATASCOPE / DATASCOPE WMS WebAPI / Plugins. . Refer to What is needed to work with Plugins? | Location of plugin files .

  • Select Save to save the configuration.

  • This plugin will now be configured for either all modules with a Print buttons, or depending on the return string, only certain modules.

For more information on configuring a plugin, refer to Create a Custom Plugin and link it to a Module or System Setting (configuring plugins) or Developing your own plugins | Configuring the plugin in the software<image of module>

image-20240610-141509.pngImage Added