======Licensing System======
<WRAP round important 65%>
Starting from version 19.1 the license module uses the Boyum IT portal for the licences. When upgrading from a version older than 19.1 to version 19.1 or higher, make sure that you have a license on the [[https://license.boyum-it.com/Account/Login?ReturnUrl=%2F|Boyum IT Portal]]. The old license files should not be used any more.</WRAP>

<WRAP center round todo 100%>After a new license is imported via the Produmex Scan add-on, make sure that you **restart the Produmex Service Broker**.</WRAP>

=====1. Required licenses for a Produmex Scan installation=====

__Produmex Scan add-on__\\
For the Produmex Scan add-on no extra SBO license is needed. The required SBO license depends on the SBO function the user will use to prepare documents for the Produmex application in the office environment, e.g. to create pick lists. Consult with the SAP Business One official licensing documentation for more information on which SBO license type is required for your installation.

__Client application__\\
Since Produmex Scan devices have concurrent licensing, the number of required licenses depends on the number of devices that are used concurrently. Allocation happens automatically.

__Produmex Service Broker__\\
As the Produmex Service Broker is assigned to one SBO user, all SBO documents created with Produmex Scan devices are created by the same user.

Tip: It is possible to check the employee who created the document with the Produmex Scan device. The Employee No. of the employee is stored in a UDF on the document header.

{{ :implementation:scan:scan_user.png |Checking user}}

=====2. Allocating licenses for terminals=====

Terminals have concurrent licensing, that is, licenses do not have to be assigned to a certain terminal. Instead, the system allows as many concurrent connections as the total number of terminals in the license.

Each time logging in on the terminal, the system checks if there is a free license slot that can be allocated for the terminal. 
  * If there is a free license, the system allocates it to the terminal.  
  * If there is no free license, an error message is displayed.  
After the logout, the system deallocates the license from the terminal.

The current status of the license usage can be seen on a webpage of the Service Broker: 
<code>http://<IP>:<PORT>/api/admin_accesstokens</code>

where the IP is the IP address and the PORT is the port number. 

{{ :implementation:licensing:accesstokens.png |}}

When Produmex Service Broker has multiple assigned databases, each database can have as many connections as in the license. For example, if you have a license for 3 terminals, and the Service Broker has 4 assigned databases, each database can have 3 connections and the total number of the potential concurrent connections is 12.

===== 3. Online and offline licensing =====

====3.1. Online solution====

When you purchase the Produmex Scan add-on on the Boyum Portal, your license is automatically generated and if you have active Internet connection, your license is automatically downloaded.

<wrap em>Important</wrap>: Make sure that you allow outbound access to our license servers (*.boyum-it.com (port 80)) in your firewall configuration.

====3.2. Offline solution====

If you are not connected automatically to the license system or you have no active internet connection, visit the [[https://license.boyum-it.com/licensekey|offline license generator]] of the Boyum IT Portal and get your license data as follows.

1. On the Get Manual License screen fill in the //Installation Number// field. For information on to how find your installation number click [[https://support.boyum-it.com/hc/en-us/articles/226546427-How-to-get-a-manual-license|here]].

2. Select //Produmex Scan – Device license// in the drop-down //Product// list.

3. Click ''Submit''. 

{{ :implementation:scan:install:1.getmanuallicense_screen.png |Get Manual License}}

The portal displays your license data as follows:

{{ :implementation:scan:install:2.license_data.png |License data}}

4. Copy all the data.
 
5. In SAP Business One go to Administration > Add-ons > Produmex Scan > Produmex License Administration and click ''Manage Boyum License''.

{{ :implementation:scan:install:pmx_license_administration_window.png |PMX License Administration}}

6. Paste your license data into the //License key// field and click ''OK''.

Your license data is imported.

{{ :implementation:scan:install:manage_boyum_license.png |Importing the license data}}

Note: If you purchase additional users or upgrade to a new product version, you must re-import your offline license and **restart the Produmex Service Broker**.

=====4. License check=====

From product version 2022.01, the Produmex Service Broker checks the client application license.

The Produmex Service Broker retrieves the application license based on the installation number and the system number. These numbers can be configured in Produmex Service Manager > Produmex Service Broker service configuration window. 

If the installation number and the system number are not provided, the system retrieves these numbers from a license already downloaded by the add-on.

The license download happens in every 12 hours. If the license cannot be downloaded, the system tries the download process in every 5 minutes.

{{:implementation:scan:1.png|installation number and the system number}}