Configure an FLR server

This procedure describes how to use WorkbenchAX to configure an FLR server application. Before configuring the FLR server, check that the following licensing and station status prerequisites are met (see Figure 5):

To configure the FLR server, do the following:

1. In WorkbenchAX, use the Palette sidebar and the Open Palette dialog box to open the flr Palette.

   The flr palette displays in the Palette sidebar.

2. Drag and drop the FloatingLicenseRepository component from the flr Palette onto the Services folder in the nav tree.

   The FloatingLicenseRepository component displays under the Services node in the nav tree.

3. In the nav tree, right-click on the CategoryService component and select ViewsCategory Manager from the popup menu.

   The Category Manager view displays.

4. In the Category Manager view, click the New button at the bottom of the view.

   The New dialog box displays.

5. In the New dialog box click the OK button to add a single new category.

   An expanded New dialog box displays.

6. In the expanded New dialog box, type “FLR” in the name field for the new category (“FLR” is recommended, not required) and click the OK button.

   The new category appears in the Category Manager table listing.

7. In the nav tree, right-click on the CategoryService component and select ViewsCategory Browser from the popup menu.

   The Category Browser view displays.

8. In the Category Browser view, expand the Config and Services nodes and click under the FLR category column to add only the FLR category to the FloatingLicenseRepository row, as shown below.

   Figure 6. Adding the FloatingLicenseRepository to the FLR category

   
   
   
   
   

9. In the nav tree, right-click on the UserService node and select ViewsUser Manager from the popup menu. The User Manager view displays.

10. In the User Manager view, double-click on the “guest” account under the Name column. The Edit dialog box displays.

11. In the Edit dialog box, at the Permissions property, click the >> button, to open the Permissions dialog box and set the guest account to have only Operator Read permission, as shown below.

    Figure 7. Adding read permission to the “guest” account

    
    
    
    
    

12. Click the OK buttons to close all open dialog boxes.

    The FLR server is configured.

    You can verify that the FLR service is running by typing http://localhost:<port>flr/packs in a browser on the FLR platform.

Configure an FLR Client

This procedure describes how to configure an FLR client application. This applies to NiagaraAX-3.5 or later installations.

The flrclient_template.xml is installed by default in the license directory of any NiagaraAX-3.5 Supervisor installation.

1. On the client platform, make a copy of the flrclient_template.xml file in the “licenses” directory and name it flrclient.xml (or just rename the original flrclient_template.xml file).

   The flrclient_template.xml file contains a helpfully commented example configuration.

2. Edit the flrclient.xml file to have at least one <flr> element.

3. In the flrclient.xml file, edit the workbench <packmap> element so that it specifies the name of your actual license application and license pack. For example, <packmap app="wb" pack="<packName>" /> and save the file.

   The “wb” value for “app” is an example for starting a workbench application. The value “station” is used for starting a station. Other values require the full java class name. The value for the "pack" attribute is specific to your organization.

4. Start the application on the client host.

   If you are using the console mode (or console window) to launch the application, you can view the startup output.

   Following, is an example of typical console output log data for a successfully licensed application:

   MESSAGE [11:04:56 08-Sep-09 EDT][sys.license] Obtained
   license pack "workbenchPack" from FLR http://localhost:7777/flr/

   The following list of error messages is not an exhaustive list. Many more error messages are possible.

   Example error messages

   • If the FLR is not available, you see an ERROR message like this in the console log:

     ERROR [11:10:45 08-Sep-09 EDT][sys.license] Failed
     to lease license pack "workbenchPack" from FLR http://localhost:7777/flr/.
      -- Message to FLR failed: java.net.ConnectException: Connection refused:
     connect

   • If you have the wrong “pack name” in the flrclient.xml file, or if the FLR does not serve that license pack, you see an ERROR message like the following in the console log:

     ERROR [11:13:06 08-Sep-09 EDT][sys.license] Failed
     to lease license pack "workbenchPack" from FLR http://localhost:7777/flr/.
      -- com.tridium.sys.license.FlrException: Pack 'workbenchPack' is not defined
     in this FLR.

   • If the FLR license limit has been reached for a particular license pack, you see an ERROR message like this in the console log:

     ERROR [11:15:12 08-Sep-09 EDT][sys.license] Failed
     to lease license pack "workbenchPack" from FLR http://localhost:7777/flr/.
      -- com.tridium.sys.license.FlrException: The license limit has been reached
     for pack [workbenchPack]. limit = {2}.

   • If there are any errors (whatever the type), workbench fails to start and you get an error dialog with the following stack trace details

     javax.baja.license.LicenseDatabaseException: Could
     not lease license pack "workbenchPack" from any configured FLR at com.tridium.sys.license.NLicenseManager.checkFeature(NLicenseManager.java:99)

       at
     com.tridium.workbench.shell.WbMain.checkLicense(WbMain.java:528)   at com.tridium.workbench.shell.WbMain.checkWorkbenchLicense(WbMain.java:506) 
      at com.tridium.workbench.shell.WbMain.main(WbMain.java:755)   at sun.reflect.NativeMethodAccessorImpl.invoke0(Native
     Method)   at sun.reflect.NativeMethodAccessorImpl.invoke(Unknown Source) 
      at sun.reflect.DelegatingMethodAccessorImpl.invoke(Unknown Source)   at
     java.lang.reflect.Method.invoke(Unknown Source)   at com.tridium.sys.Nre.runClass(Nre.java:201) 
      at com.tridium.sys.Nre.main(Nre.java:126)

Check license packs

You can verify that an FLR service is running and check license pack availability and status at the FLR server by doing the following:

1. Open a browser session on the FLR server platform and type in the following:

   http://localhost:nnnn/flr/packs

   where “nnnn” is the port that the FLR is configured to listen on.

   If the FLR service is running, the FLR License Packs page displays the number of “in use” license packs and the number of total license packs, by pack, as shown below:

   Figure 8. FLR License Packs page

   
   
   
   
   

2. In the FLR License Packs view, click on the “station” link (or any pack name link that displays).

   The License Pack Status page displays, as shown below:

   Figure 9. License Packs Status page

   
   
   
   
   

   The License Packs Status page shows the following information about each client that is currently leasing a license from the FLR:

   • Client ID

     This ID is specific to the application and changes with an application restart.

   • Address

     This is the IP address of the FLR Client host platform

   • Last Heartbeat

     This column displays the latest date and time that the FLR server received a heartbeat communication from the FLR client.

Reload the License Pack File (LPF)

Various situations may require you to reload the LPF in the FLR server application. This procedure describes how to use WorkbenchAX to reload an LPF in the FLR server application that is properly licensed, running, and where you have an established a WorkbenchAX to station connection.

1. In the WorkbenchAX nav tree, under the FLR Station node, expand the Config and Services nodes.

   The FloatingLicenseRepository component should display under the Services node.

2. In the nav tree, right-click on the FloatingLicenseRepository component and select ActionsReload from the popup menu.

   The LPF is reloaded.

   The FloatingLicenseRepository component property sheet view displays.

   When you reload the LPF all license pack counts are reset to zero at the FLR. FLR Client applications must reaquire licenses at their next heartbeat communication.