A host script bundle is a compressed zip file that contains the following components.

Component	Description	Notes
tasks.xml	This is the task configuration file for the host script bundle.	REQUIRED for all host script bundles
Host scripts	The most common types of scripts include bash, bat, Powershell,* and Python scripts. These require a script interpreter to be present on the host OS.	OPTIONAL Examples: Bash scripts work on Mac hosts by default Bat scripts work on Windows hosts by default
Executables	This can be a compiled program that performs the desired functions.	OPTIONAL
Data files	This can include data or image files referenced by the host scripts or executables.	OPTIONAL

Note: Please note that administrators will need to create two separate host script bundles: one for Mac hosts and another for Windows hosts. tasks.xml may contain different file paths for Mac versus Windows. Also, host scripts and executables may need to be platform-specific.

*Running Powershell scripts

Powershell scripts will run on Windows hosts, but must be enabled first. Use the following commands to enable Powershell scripts:

On 64-bit hosts:
On 32-bit hosts:

Understanding the host script environment

Tasks

• Tasks are the individual actions that you want to run on the host computer. These can be specified within tasks.xml by:
  • Using a command (contained within the tasks.xml entry)
  • Calling a host script (file contained within the host script bundle)
  • Calling an executable (file contained within the host script bundle)
• You can specify multiple tasks in the same tasks.xml file.

Tags

Tag	Comments
Tasks	Task container
Task	(Attributes: name_id: This is unique to each task, and version: This is the task version, and is uploaded as part of data collection.) This tag declares tasks to execute.
Enable	The task is executed if the "enable" value is set to "true." If this tag is missing, the task will not execute.
command	Commands the executable or script to run. This tag is case-sensitive on Macs.
context	The only supported context is "user."
launch	The only supported context is "on Player start." Host scripts run on Player start, before a user logs in.
run_player	Controls the execution of Player launch (see the description below).
Output	This tag declares information that is output from a host script.
file	The host script outputs to a file.
name	The file name.
format	The output type ("kvp" or "raw." For more information, see the description below).
stdout	The host script outputs to stdout.

Environment Variables

Moka5 provides some environment variables for use in host scripts.

Variable Name	Description
M5_BIN	Returns the Moka5 bin directory on Windows hosts, or the app bundle on Mac hosts (for example: C:\Program Files\MokaFive\bin).
M5_VERSION	Returns the Moka5 Player version (for example, 4.1.0.69772).

Output

Tasks can output in one of two formats:

Raw

Declare this format with the "raw" keyword in the tasks.xml file.

• Example: list of all files in a directory
• Example of the tasks.xml file syntax with "raw" output:

Key-value pairs

• Key-value pairs are sets of data items: a unique identifier for some data, or a “Key,” and the state or content of the data itself, or “Value.” They are denoted by two items connected with an “=” sign: Key=Value.
• Key-value pairs are written to the local property stack and sent to the Management Server
  • The first time key-value pairs are sent, it can take a few minutes after authentication for the send to complete. After that, whenever value changes and you restart your Moka5 Player, the key-value pairs are re-sent.
  • The key-value pair format is declared by the “kvp” keyword in the tasks.xml file.

Tasks can consider the result of a previous run of the host script bundle

<?xml version="1.0" encoding="UTF-8"?>
<tasks>
<task name_id="hello" version="05_21_2014">
<enable>true</enable>
<command>win_run.bat</command>
<context>user</context>
<launch>on player start</launch>
<run_player>true</run_player>
<output>
<file>
<name>win_comp_check.out</name>
<format env=”true”>kvp</format>
</file>
</output>
</task>
</tasks>

Note: To specify key-value pairs as the output format, you must include the content in the <output> tags.

Workflow

On first run:

• There are no previously outputted key-value pairs to consider, so the task will execute without this input.
• The host script bundle generates a key-value pair, stored in the local property stack and sent to the server.

On following runs:

• The previously outputted key-value pair is provided as an environment variable and input to the host script bundle. The script can use environment variable M5HS_Key and make appropriate decision.

• The host script bundle generates a key-value pair, stored in the local property stack and sent to the server.

Control over Moka5 Player

• If this tag is present, then output is checked for presence of the [RUN_PLAYER=True] key-value pair.
• If this is not present, then Moka5 Player is not launched.

How to deploy a host script bundle

Log in to the Moka5 Management Console with an account that has Desktop Administrator role permissions.

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 <script name_platform> (Example: EULA_Win)
• Browse to your newly created zip file and Click Upload.

Target the 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 <script name_Win> from the pull-down menu.
• For the policy “Custom host script for Mac” select <script name_Mac> from the pull-down menu.
• Click Save.

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.
• The host script will now run.
• Note: If you are delivering an update to existing host scripts after installation, you must enable the "Player auto-update" policy for your pilot user group. Restart the player to ensure that the policy update takes effect.

How to retrieve information (reported by a host script) from the Management Server

Obtain the Device Properties Report

• Log in to the Management Console with an account that has Desktop Administrator or Report Viewer role permissions.
• Go to Reports > Devices.
• Click the Export Properties to CSV button.
• 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. This report contains key/value pairs that correspond to a deviceid.
• namespace – This corresponds to the name_id you specified in tasks.xml.
• key – You specified this to output in your host script bundle.
• value – You specified this to output in your host script bundle.