Create a Custom Plugin and link it to a Module or System Setting (configuring plugins)

Owned by DATASCOPE WMS, created
Last updated: May 20, 2024
5 min read

System Setup / Plugin Customization / Plugin Configuration [SET062]

Let’s review the software to see the different modules from which plugins can be called and review their configuration.

It is also important to note that plugins can be configured in two ways:

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

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

Try it!

Creating a one-to-one plugin linked to a specific module and action:

  • Open DATASCOPE WMS

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

Select Plugin Configuration from the Main Menu

  • The Plugin Configuration screen will open.

Plugin Configuration screen

  • 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. For more information on creating DLLs, refer to Custom Plugin Building a Plugin

  • 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.

  • 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.  These areas are broken down into Types. For more information on the different Types (or areas within the software where a plugin can be used) refer to, Custom Plugins Interfaces and Types.

  • 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.

Creating a one-to-many plugin linked to a System Setting

  • The same steps will be followed up to add the .dll file name.

  • In the Plugin Configuration data grid, you also have the option to add a System Name and Setting Name.

  • If the plugin is linked to a System Name and Setting Name, it will also be visible under that specific Setting, and when selected, it will be applicable over multiple warehouses.

  • To summarize:

    • A plugin (created and configured in the Plugin Configuration module) will be linked to a specific action (button) in a specific module (for example, Receipt LCT, Import LCT button). This is a one-to-one link where a plugin is linked to a specific button.

    • A plugin can also be linked to a specific System Setting and then be used over multiple warehouses.

Delete a Custom Plugin

Â