Produmex WMS WebAPI

The WMS Web API enables users to extend functionality without deeper knowledge of the codebase or the database structure.

Expose WMS functionalities on a middle layer between Produmex objects and the applications using them. The value of this feature is making it possible to connect WMS with cloud platforms and the integration of third-party products like Kardex, Automated warehouse, Beas, etc.

• I. Install Produmex Service Broker
• II. (Optional) Configure dependency from the SBO Server Tools service on an MSSQL system
• III. Install Produmex WMS Server Module
• IV. Create a WebAPI user on WMS License configurator
• V. Go to Swagger and execute the Authentication method with the user & password
• VI. Receive the generator token from Swagger & Confirming the WebAPI

To access the WebAPI components visit the Produmex download page:
http://www.produmex.name/PmxVersions.php?p=WMS

Note:The installation could be familiar for you, the WebAPI installation process is based on the Produmex Scan Fresh Installation. For any inconveniences during the installation you can check for extra information on the previously mentioned site.

1. Extract the ProdumexServiceBrokerSetup file and run the BxServiceBroker.Setup.exe file.

2. Accept the License Agreement and click Install.

The setup process is started, it may take some time.

3. Configure the service settings on the Produmex Service Broker Config form as follows.

• Service run as user:
  In the Service run as user field set the user to be assigned to the service broker service in Windows. This must be a user who has rights to write the event log and the program data directory where the logs are created. The service broker service will also make a connection to the company database/schema and the user must have rights for that as well.
  Note: Local System users usually do not have the right to use printers, therefore, it is recommended to configure a Windows user.
  
• Password:
  In the Password for user field provide the password for the user.
  
• Service port:
  The default port for the communication between the service broker and the clients is 50231. The installer will open the firewall for this port automatically, but if you change the port, you will have to change the firewall settings manually.
  
• Start mode:
  In the Start mode drop-down menu set the start mode of the service to Auto or Manual. The recommended start mode is Auto.
• Exit if any module loading fails:
  The option is selected by default and if a module cannot be loaded, the Service Broker will not run.
• Click Next.

4. On the Admin Page form specify a password for the Service Broker Administration web page in the Web password field and click Next.

5. On the Database connection form provide the connection data to the database server that has access to the company database/schema as follows.

• Select the database type from the Database type drop-down menu.

• MSSQL
  
  • Database Server:
    Enter the name or the IP address of the database server to the field. If you have a named instance, you have to enter the name of the server and the named instance as well (for example SERVER\NAMEDINSTANCE).
  • Database Port:
    Enter the database port on which the application can connect to the server. The default port is 1433.
  • SQL username:
    Enter the name of the database user to the field. The default user is sa.
  • SQL password:
    Enter the password of the database user to the field.
  • When working on SAP B1 Cloud, add the domain user name to the Domain user name field and enter the password to the Domain password field. Note: Domain user details are not stored on Produmex side. They are only required so that user databases can be accessed by Produmex. Your Domain user details are the ones set for the cloud (for designated databases), by its operator.
  • Click Next and continue with step 6 in this section.

• HANA
  
  • Database Server: The database server name must be added with the exact same format as it was added during the installation of the SAP Business One client.
    • Single-Database: Enter the name or the IP address of the database server to the field.
    • Multi-Database: The DATABASENAME parameter must be used: DBA@< >. Example:
  • Database Port: Enter the database port on which the application can connect to the server.
    • Single-Database: The default port is 30015.
    • Multi-Database: The default port is 30013.
  • SQL username:
    Enter the name of the schema user to the field. The default user is SYSTEM. It is recommended to install the Service Broker with the SYSTEM user.
  • SQL password:
    Enter the password of the database user to the field.
  • When working on SAP B1 Cloud, add the domain username to the Domain user name field and enter the password to the Domain password field. Note: Domain user details are not stored on Produmex side. They are only required so that user databases can be accessed by Produmex. Your Domain user details are the ones set for the cloud (for designated databases), by its operator.
  • Click Next.

6. Set up the company database/schema on the Default SAP Company form as follows.

• Company: In the Company drop-down menu select your company.
• SAP username field: Enter an SAP user here which has at least an indirect access license as of SBO 9.2. PL08.
• SAP password: Enter the password of the SAP user.
• Select the language in the SAP language drop-down menu.
• Click Next.

Note: Only one company can be set up with this step. If you have more than one database/schema, you can add them in the Produmex Service Manager after finishing the installation (see documentation here).

7. This setting is used for configuring & select the Produmex WMS WebAPI's location. The WMS Location is required to be selected correctly!

Click on the “Get Location” button, after the pop-up windows appeared find your “WMS Tools” folder and select it. Standard location for “WMS Tools” folder is the following: C:\Program Files\Produmex\Produmex Tools

8. The system displays a summary about your settings. If a setting needs to be changed, click Back and modify the necessary setting. If the data is correct, click Finish.

When you selected the “WMS Tools” folder your summary will display the WMS location as well.

9. The installation is finished. Click Close.

10. Open the Produmex Service Manager. It is automatically installed with the Service Broker.

11. Click the Companies button and on the Select Companies form select your company database. Click OK.

The Produmex Service Broker works together with different Produmex add-ons and it uses the dlls of the given add-on. Install the dlls with the Produmex Service Broker Module Installer as follows.

1. Extract the ProdumexWMS_ServerSetup_2024.04.06.0062_SBO10.0_MSSQL_x64.zip file and run the WMSWebAPI_2024.04.06.0062_setup file.

2. Click Install on the Produmex Service Broker Module Installer and when the installation is finished, click OK on the Success form.

3. The system restarts the Service Broker. Click OK on the Success form.

Note: The add-on and the server dlls must be for the same version. If you use different versions, error messages may be displayed. Start the installer and it will automatically copy the dlls. Then restart the Service Broker.

Open the “License Configurator” to add new users.
When you open the License Configurator, the Automatic license type is checked by default and the License Configurator tries to download the licensing data from the Boyum IT portal automatically. If you wish to read more about the “License Configurator” click here.

If you have an active internet connection and the license can be downloaded, you will see the following window.

On the right side of the window a “WebAPI Users” tab can be seen. Click on that tab to open the users tab.

How to add new users?

In default state the window is empty, right click on the header of the WebAPI users table, with this action you can add new users to the system.

During the process of adding new users, you can define their names and passwords. Once you have entered the name and password, simply press “Enter” to save the user. Deleting users is just as straightforward; right-click on the selected user and choose the delete option. If you wish to retain the user but they are not currently needed in the workflow, you can simply check the “disable” box.

Do NOT forget to save your configurations & restart service before closing the License Configurator!

1. Add new user:
2. Define name & password:
3. Save & restart service:

V. Go to Swagger and execute the Authentication method with the user & password

1. To connect the WebAPI to Swagger use the following link:

http://localhost:50231/swagger/ui/index#

Make sure you changed the localhost before visiting the link. The path to find your localhost number, open the “Produmex Service Manager” start the service, then click on the “hammer” icon. On the right side of window you will find the localhost number.

2. Open the previous link with the correct localhost

For authentication you must login with the created user & password that has been created in the “License Configurator”.

In the WMSAuthentication menu process with the login: WMSAuthentication: /api/wms/authentication/login

VI. Receive the generator token from Swagger & Confirming the WebAPI

If the login process is successful, the following window will appear. A token will be displayed in this window, confirming that the WebAPI is functioning correctly.