Sahi Pro - License Server

Download and setup License Server

1. Download Sahi Pro License Server from Sahi's download archives
2. To setup Sahi Pro License Server follow the below steps,

• Extract the contents of zip file.
• To start server:
  On Windows command prompt:
  
  >cd spls\bin
  >server.bat
  
  
  On Linux terminal:
  
  >cd spls/bin
  >./server.sh
  
  
  If needed, make it executable on linux by running
  
  >chmod +x server.sh
  


• License server will run on port 8888 by default. To run on different port, say 8989, run
  
  > server.bat 8989
  
  
  or
  
  
  > ./server.sh 8989
  
  
  

Sahi Pro License Server As A Service

Since version 1.0

Sahi Pro License Server can be started as service. Only for Windows operating system it can be started as service.
To start it as a service:

• Open command prompt in Administrator mode
• Type:
  
  
  >cd spls\service
  >spls.bat
  
  
  A service named "Sahi Pro License Server" will be registered and started.
  
• License server will run on port 8888 by default. To change the port, open spls/service/spls.ini change 8888 to the port you want.
• The console output can be seen in spls/service/spls.log file

To stop this service:

• Open command prompt in Administrator mode
• Type: Net Stop "Sahi Pro License Server"

Access Sahi Pro License Server Web Interface

Sahi Pro License Server can be accessed by navigating to http://localhost:8888/ on the same machine
or
by navigating to http://your_license_server_hostname:8888/ from other machines.

One has to enter the valid password when accessing the web interface from other machine. User can logout from the session by clicking the logout button on home page of Sahi Pro License Server.

Manage Licenses

Sahi Pro Licenses can be added and managed.

Sahi Pro Licenses

• To add license: Choose Files > Select a license file to add > Add License.
• Lists all licenses added. Expired and non-concurrent (user) licenses are shown striked out.
• Sahi Pro instances consume licenses but Sahi Pro Runner instances do not consume licenses (For auditing purposes only).
info NOTE: Only Sahi Pro Concurrent Licenses will be honored by the Sahi Pro License Server.

Sahi Pro sessions

• Lists all Sahi Pro sessions that procured licenses from Sahi Pro License Server.
• Revoke: It will release the issued license for that particular user.
• Sahi Pro instances consume licenses.

Sahi Pro Runner (Playback only) sessions

• Lists all Sahi Pro Runner sessions (For auditing purposes only).
• Sahi Pro Runner instances do not consume licenses.

View License Usage Reports

This shows the Sahi Pro License Usage Reports in graphical and tabular format.
Sahi Pro Usage List and Sahi Pro License Denied List can be downloaded as CSV format.

Graphical Representation

• The Upper graph shows the monthly usage of license data as per the selected month (month can be selected from Date Picker or click on the month shown in the left panel). By default, it displays the current date reports.
• Distinct and Concurrent Users:
  
  Suppose, A and B worked in the morning and C, D and E worked in the afternoon.
  So total distinct users are 5.
  But maximum of 3 users have concurrently used licenses, so total concurrent users are 3.
  This will help you understand what your usage pattern is and procure licenses next time accordingly.
  
  Light Blue colored bar: Displays distinct users count.
  Dark Blue colored bar: Displays concurrent users count.
  
  
• The Bottom graph shows the daily usage of license data as per the selected date (date can be selected from Date Picker or click on the Light/Dark blue colored bar shown in the above graph).

Show Data

• This shows the Sahi Pro Usage and Sahi Pro License Denied List in tabular format.
• Sahi Pro Usage List: This will show the list of Sahi Pro users who procured license from Sahi Pro License Server successfully.
• Sahi Pro License Denied List: This will show the list of Sahi Pro users who are unable to procure license from Sahi Pro License Server.

4001 - Could not obtain license. All licenses are issued.
4002 - User is not allowed to access license.
4003 - Time difference between the License Server and the System is more than the allowed time difference.

• Sahi Pro Usage List and Sahi Pro License Denied List can be downloaded as CSV format by clicking on Download CSV icon (top left).

Manage Access List

Access Control Lists help restrict access based on username, IP address or Mac address of the machine requesting license.

• Sahi Pro users who are added in the Access Control List can only access the Sahi Pro License Server and procure a license.
• Adding Sahi Pro users to access list:
• Set Access Type: Select either none or System's logged in username or IP Address or MAC Address.
• none : No access type is set. Everyone will be allowed to procure a license.
• System's logged in username : Username of the logged in system where Sahi Pro is installed.
• IP Address : IP Address of the logged in system where Sahi Pro is installed.
• MAC Address : MAC Address of the logged in system where Sahi Pro is installed.
• Access Credentials: Set the value based on the Access Type selected above (Example: System's logged in username: sahi, IP Address: 192.168.1.1, MAC Address: 00-0C-29-CC-11-10)
  
  NOTE: Access Credentials value can be a regex pattern also.
  
  Wildcard * and ? can be used. * matches any sequence of characters, whereas ? matches any single character.
  
  Example1: If the Access Type is IP Address and Access Value is 192.168.1.*
  Then all the Sahi Pro users whose IP Address is between 192.168.1.1 to 192.168.1.255 can access Sahi Pro License Server and procure the license.
  Example2: If the Access Type is IP Address and Access Value is 192.168.1.?
  Then all the Sahi Pro users whose IP Address is between 192.168.1.1 to 192.168.1.9 can access Sahi Pro License Server and procure the license.
  
• Access Control List: Lists all the added Sahi Pro users based on the selected Access type.

Remove: Click to remove the access for that particular Sahi Pro user.

Change Password

When accessed from other machines, the Sahi Pro License Server will ask for a password. The default password is: password.

After installation do change the password to prevent abuse.

NOTE: In this release forgot password feature is not available when accessed from other machines.

Properties

To modify License Server properties, open spls/userdata/config/server.properties file.

#Time in ms. Default is 10 mins (600000 ms)
sahi.poll_time=600000
#license lease time in ms. Should be more than "sahi.poll_time" . Default is 1 hour (3600000 ms)
license.lease_time=3600000
#Allowed time difference between client and server in ms. Default is 10 mins (600000 ms)
server.client.allowed_time_difference=600000

Configure Sahi Pro to procure License

You can make Sahi Pro procure License from Sahi Pro License Server by following either of the below two methods:

1. If no License is provided to Sahi Pro or the License provided is invalid/expired, the following GUI will show up when starting Sahi.

• Select the option "Acquire license lease from license server".
• Write in the License Server Host and Port number in the textboxes.
• Test the Host and Port number by pressing the "Test License Server Connection" button.
• Once configured, you can save these settings by pressing the "OK" button.
2. Open sahi_pro/userdata/config/userdata.properties file and set the following properties,
   

   #Set this property to true to procure license from License Server
   sahi.license_server.enabled=true
   #The hostname or ip address of the machine on which license server is running.
   sahi.license_server.host=192.168.1.1
   #The port number on which license server is running. Default port number is 8888.
   sahi.license_server.port=8888

NOTE: If the Sahi Pro License Server is down or not accessible, Sahi Pro will run for 30 minutes with prompts appearing every 10 minutes.

Database Support for Sahi Pro License Server

• By default Sahi Pro License Server stores its reports in a H2 database.
• Sahi Pro License Server also supports MySQL, MSSQL and Oracle databses to store the reports.
• Please refer the below links to configure with different databases,
• MySQL: Refer here
• MSSQL: Refer here
• ORACLE: Refer here

Upgrade Sahi Pro License Server

To upgrade Sahi Pro License Server, please do the following,

• Take a backup of existing Sahi Pro License Server spls/userdata folder.
• Download latest Sahi pro License Server Sahi's download archives and extract contents of zip file.
• Take a backup of new Sahi Pro License Server spls/userdata folder.
• Copy the older spls/userdata folder and put it in new Sahi Pro License Server
• If you are using different database other than H2 database, then make sure you copied corresponding jdbc jar files to spls/extlib folder.
  
• Restart the Sahi Pro License Server and verify the data.

NOTE: The latest Sahi Pro License Server will work only with Sahi Pro 6.2.1 and above