Versions Compared

Old Version 2

changes.mady.by.user DATASCOPE WMS

Saved on

compared with

New Version 3

changes.mady.by.user DATASCOPE WMS

Saved on

Key

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

<menu path> <link to F1 content>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.

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>https://youtu.be/siZOZ-YDwoM

premium_1_CUSTOM_PLUGINS_OVERVIEW_product_technicalguide_TG - v0.1.pdf

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

Image RemovedImage Added

  • The Plugin Configuration screen will open.

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

Image RemovedImage Added

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

  • Select Tab

Info

Note: You will stand on the Misc / Action part of the data grid. Tab off that without selecting.

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

Info

Note: Plugins are broken down in different types. For more information, refer to Custom Plugins Interfaces and Types.

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

Info

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

Info

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

Info

Note: Developing and editing existing plugins require developer skills.

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

Info

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

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.

Info

Note: Linking a System Setting to a plugin does not apply to all plugins. It’s only applicable to a single plugin where you will link it once, and then it is suitable for all those buttons, i.e., the Auto Reserve button.

  • 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