Display a custom EULA when starting Moka5 Player

An administrator can present a custom End User License Agreement to users, and track user acceptance from the Management Server. This article describes how an administrator can implement this custom EULA.

Moka5 3.17 and later

Before you begin

Overview – how it works

Components of the EULA host script bundle

How to deploy the first EULA version

How to verify EULA acceptance from the Management Server

Example - CSV Report
How to deploy an updated EULA version

Work with your legal department to obtain the desired wording for the End User License Agreement. The intent is to have the user accept the EULA prior to starting Moka5 Player or any LivePC. This wording should be saved into a EULA content file in text, rich text, or html format. (Example: eula.html)

Moka5 provides a small EULA application that displays the contents of the EULA content file. This EULA app can be delivered to Mac or Windows host computers via a Host Script Bundle, targeted to specific groups from the Moka5 Management Console. The administrator can update the EULA content file and redeploy the updated version to end users.

Components of the EULA host script bundle

For Windows hosts, the host script bundle (EULA_Win.zip) contains:

• eula-app.exe – This is the EULA application provided by Moka5.
• eula.html – This is the EULA content file that can be customized by the administrator.
• QtCore4.dll and QtGui4.dll – These supporting files are needed for eula-app.exe to run.
• tasks.xml – This is the task configuration file for the host script bundle. This file can be modified for version control when an updated EULA version needs to be deployed.

For Mac hosts, the host script bundle (EULA_Mac.zip) contains:

• EULA Dialog.app – This folder and subfolders contain the EULA application provided by Moka5.
• eula.html – This is the EULA content file that can be customized by the administrator.
• tasks.xml – This is the task configuration file for the host script bundle. This file can be modified for version control when an updated EULA version needs to be deployed.

Hint: The eula.html file is identical for both Windows and Mac hosts.

How to deploy the first EULA version

1. Extract the contents of the EULA_Win.zip and EULA_Mac.zip files into their respective folders.
2. Replace eula.html in both folders with your EULA content file that contains your customized wording.
3. Open tasks.xml using Notepad++ or similar editor. (Note that tasks.xml is different for Windows versus Mac, so you’ll need to edit each one separately.)

• Search for the line that contains

• Make a note of these values (and customize them if needed)
  • name_id
  • version (adjust to show the current date)

4. Create new compressed zip files that contain all the necessary files for both Windows and Mac platforms. (The only files you modified were eula.html and tasks.xml.)

• EULA_Win.zip
• EULA_Mac.zip

5. Login to the Moka5 Management Console with an account that has Desktop Administrator role permissions.
6. Upload the host script bundles. Do this for both Windows and Mac zip files.

• Go to Settings > Customizations > Host Scripts tab.
• Click the Upload button.
• For bundle name, enter EULA_Win (or EULA_Mac)
• Browse to your newly created zip file and Click Upload.

7. Target the EULA host script bundles to a pilot user group

• Go to Policies > Player Policies > Custom tab
• Select the pilot user group you wish to target.
• For the policy “Custom host script for Windows” select EULA_Win from the pull-down menu.
• For the policy “Custom host script for Mac” select EULA_Mac from the pull-down menu.
• Click Save.

8. On each of the target computers in your pilot group:

• Shut down the LivePC.
• Go to the Player menu > Check for updates.
• You will see a message in the yellow notification bar, “MokaFive Player update available.”
• Click Update Now, and then click Yes.
• Launch Moka5 Player.
• You should see the EULA dialog box.
• Click Accept.
  

How to verify EULA acceptance from the Management Server

Obtain the Device Properties Report

1. Login to the Management Console with an account that has Desktop Administrator or Report Viewer role permissions.
2. Go to Reports > Devices.
3. Click the Export Properties to CSV button.
4. Download and save the file mokafive_deviceproperties<date>.csv.
   

How to interpret the MokaFive_Device_Properties csv report

• deviceid – This is a unique identifier for a host computer that has installed Moka5 Player and registered with the Management Server. This report contains key/value pairs that correspond to a deviceid.
• namespace – Look for the namespace that corresponds to the name_id you specified in tasks.xml.
  • EULA_Win_v1
  • EULA_Mac_v1
• key – Look for the key named “ACCEPTED”
• value – If value is “yes” it means the user accepted the EULA from that device (host computer).

Example – CSV report

How to deploy an updated EULA version

• Add/edit/delete wording within the EULA.
  • In this case, you will want to all users to see the new EULA version, even those that already accepted the old EULA version.
  • You should modify tasks.xml with a new name_id and version.
• Minor formatting changes.
  • In this case, you only want new users to see the EULA version. If someone has already accepted the EULA, you do not want to prompt them again.
  • You should modify tasks.xml with a new version only. (If you modify name_id, the EULA will be pushed to all targeted users.)

1. Modify eula.html with your desired changes.
2. Extract the contents of the currently deployed EULA_Win.zip and EULA_Mac.zip files into their respective folders.
3. Replace eula.html in both folders with your EULA content file that contains your new changes.
4. Open tasks.xml using Notepad++ or similar editor. (Note that tasks.xml is different for Windows versus Mac, so you’ll need to edit each one separately.)

• Search for the line that contains

• Make a note of these values (and customize them if needed)
  • name_id (change if you want the new version to go to all users)
  • version (adjust to show the current date)
• Examples:
  • <task name_id="EULA_Win_v2" version="11_26_2013">
  • <task name_id="EULA_Mac_v2" version="11_26_2013">
• You will need this information when you view the report on the Management Server.

5. Create new compressed zip files that contain all the necessary files for both Windows and Mac platforms. (The only files you modified were eula.html and tasks.xml.)

• EULA_Win.zip
• EULA_Mac.zip

6. Login to the Moka5 Management Console with an account that has Desktop Administrator role permissions.
7. Re-Upload the host script bundles. Do this for both Windows and Mac zip files.

• Go to Settings > Customizations > Host Scripts tab.
• Look for the existing entry for EULA_Win (or EULA_Mac).
• Click Re-Upload.
• Do not change the Bundle name. (If you change the Bundle name, you will need to modify the Player Policies to select the new bundle names for your target groups.)
• Browse to your newly created zip file and Click Upload.

8. On each of the targeted computers:

• Shut down the LivePC.
• Go to the Player menu > Check for updates.
• You will see a message in the yellow notification bar, “MokaFive Player update available.”
• Click Update Now, and then click Yes.
• Launch Moka5 Player.
• You should see the updated EULA dialog box.
• Click Accept.