Plugin Configuration [SET062]

Owned by DATASCOPE WMS, created
Last updated: Jun 07, 2024
3 min read

Plugins are code components that add capabilities to an existing program without impacting that program’s core code. We allow a user to inject specific logic into the system in particular areas of the software to enhance default functionality.

On a high level, plugins can be implemented in the following modules.

  • Receiving - Imports of data (e.g., LCTs) and Scales configuration

  • Sales Orders and Jobs - Custom Auto Reservation Rules (rules around what stock must be picked from where) (for more information, refer to the Advanced section/video)

  • Checkout – Scales configuration

  • Transport Management System – highly customizable module

  • Task Management System is a highly customizable module from a plugin and scripting perspective.

It is used where critical parts of the system typically integrate with 3rd party systems or pieces of logic that require some custom development.

  • All configurations for plugins happen on this screen. This is where a specific plugin (the developed .dll file) will be linked to a specific process in the system.

  • Select the Plugin Name drop-down to select one of the allowed processes to link a plugin to.

  • Enter a display name for the configuration in the Display Name field.

  • Select Tab

  • The Plugin Details data grid will load with information about the specific plugin.

  • The next step is to enter the file name, which is the compiled DLL the developer must create, in the DII FileName field.  Ensure to include the .DLL extension as well. 

  • These .dll files must first be saved in the DATASCOPE WMS server under C: / Program Files (x86) / DATASCOPE / DATASCOPE WMS WebAPI / Plugins folder, before they can be used.

Note: The extension .dll must form part of the file name, and the name must have no spaces.

Note: If the file name entered in the Dll FileName field is different from the compiled DLL saved then the plugin will not work.

  • Select Save

  • A pop-up will appear, stating that a Plugin has been amended

  • This process applies a custom plugin, written by a developer, to a specific area within the software.  

  • All newly configured plugins will appear in the Configured Plugins data grid. This list will grow over time as you create and configure more plugins.

  • The data grid will indicate the following:

    • Display Name – This is the name we created when creating a custom plugin.

    • Dll FileName – This is the .dll file developed when creating the new custom plugin.

    • Name – This is the name of the controlled area (Type) within the software where plugins are allowed.

    • Application Name – This refers to the specific module where this plugin can be used.

    • Linked Action – This refers to a button or link in a module that will use the plugin custom code.

Note: If there are errors in the .dll file, the user will see a pop-up message when selecting the Linked Action button in a module.

SPECIAL FEATURES

  • Plugins are broken down into different types. For a list of all available Plugin Types and Interfaces, contact your local DATASCOPE Solution Provider.

  • Plugins can be configured in two ways:

    • One-to-one - is linked to a specific button in a specific module.

    • One-to-many – is linked to a specific System Setting and can be used over multiple warehouses and modules.

  • Plugins are also hot-swappable (meaning parts of the software can be changed without shutting down or rebooting), and no upgrades are required. It can be pushed directly into a production environment without taking the system down. It is only used at the time it is called from the core software. We, however, do not advise implementing new pieces of code without testing it in your test environment.

  • Custom Plugins can also be deleted if no longer required.

TECHNICAL

  • Users require development skills to create and work with plugins.

  • If creating a Client-Side plugin, a logout/login will be required on the client after placing the .DLL file on the Server. This is required to download the DLL file from the server to the client.

  • Developers also have the option to create .dll.config or even log files. These must also be stored under the Plugins folder.

  • All .dll files developed must be saved on the DATASCOPE WMS server under C: / Program Files (x86) / DATASCOPE / DATASCOPE WMS WebAPI / Plugins.

SYSPRO REQUIREMENTS & Business objects used

  • None

RELEASE NOTES

  • Release notes 23.4 (Ticket #8326) - Add new Core Printing plugin

  • Release notes 24.2 (Ticket #8281) - Add standard Core Replenishment Calculation plugin has been added from existing Pickface Replen standard code.

REFERENCE

SET062