Versions Compared

Key

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

What is the ModuleApiProxy?

...

In addition to all the .NET 6+ modules files the following files, (which are ModuleApiProxy dependencies), must be added to the modules deployment folder as part of the installation process.
All Module Api Proxy files deployed to the .NET 6+ modules folder (SharedLib.dll, ModuleApiProxyLib.dll, ModuleApiProxy.exe, ModuleApiProxy.Config.json) can be removed when the module is uninstalled.

Info

IMPORTANT!!
The following applies to modules based on all PIMA Releases.
With the release of PIMA 1.1.0.926 an additional executable (BootStrapper.exe) has been added to the ModuleApiProxy SDK.
Please place the BootStrapper.exe in the same folder as Setup.exe (the installer for the ModuleApiService).

This means that if a module is based on a PIMA version prior to 1.1.0.926 (e.g. PIMA 1.0.3.806), then take BootStrapper.exe from the latest available ModuleApiProxy SDK and follow the above steps to install the ModuleApiService for the module based on e.g. PIMA 1.0.3.806.

Use BootStrapper.exe to initiate the installation of the ModuleApiService.
For valid use, error codes and supported arguments - see the readme.md file accompanying BootStrapper.exe.

The 'ModuleApiService' will create and update the certificate used for the https communication between ModuleApiProxyLib and ModuleApiProxy.
The ModuleApiService must be installed before the ModuleApiProxy can be used.

...

.NET 6+ Module Deployment files

Deployment Folders

MyDotNet6Module.exe
“Other Module related files“

..\MyModuleFolder\

SharedLib.dll
ModuleApiProxyLib.dll
ModuleApiProxy.exe
ModuleApiProxy.Config.json

..\MyModuleFolder\

Starting with version 1.0.3 of the ModuleApiProxy the component must be deployed like this:
(In the table below the files in cells with green background are provided by HIMSA)

.NET 6+ Module Deployment files

Deployment Folders

MyDotNet6Module.exe
“Other Module related files“

..\MyModuleFolder\

ModuleApiProxyLib.dll
SharedLib.dll

..\MyModuleFolder\

ModuleApiProxy.Config.json
ModuleApiProxy.exe

..\MyModuleFolder\.proxy