Skip to main content
Feedback

Setting up a local runtime default HTML5 player

A local runtime default legacy player can be set up to be used with all your local runtime flows.

With this approach, a local 'default.html' file based on the Flow default legacy player is created/hosted in a folder on the local runtime machine, and configured to use the local runtime platform URI.

Query parameters are then applied to the Flow Run URL to specify that a Flow should use the player.

note

You will need to create and publish the local runtime Flow that you would like to deliver using the local player, as the tenant-id and Flow-id of the published Flow is required. Refer to Publishing flows to a local runtime.

  1. In Flow, open up the default legacy player in the Players tool.

  2. Copy the entire player HTML code onto the clipboard.

  3. Create a new 'default.html' file where you wish to store your local player. For example, this could be on the same machine as the local runtime, within a web server folder.

  4. Paste the contents of the default legacy player into this new file.

  5. Edit the uri platform setting and specify the platform uri to match the BASE_URL value that is used for the local runtime environment. For example:

    manywho.settings.initialize({
      platform: {
         uri: 'http://localhost:2294',
      },
    })

  6. Identify and copy the tenant-id of the local runtime published Flow. The tenant-id can be found in the Account menu for example.

  7. Edit the engine initialization Url parameters at the bottom of the pasted HTML; to allow users to join a Flow correctly, the tenant-id parameter must be added.

    Url parameters

    • Enter the tenant-id parameter.

    For example, if your Flow tenant-id was '07f799a4-af7c-449b-ba7c-f1f526f70b', your player code would be:

    manywho.engine.initialize(
    **'07f799a4-af7c-449b-ba7c-f1f526f70b',**
     queryParameters['flow-id'],
     queryParameters['flow-version-id'],
     'main',
     queryParameters['join'],
     queryParameters['authorization'],
     options,
     queryParameters['initialization']);

  8. Save the file and check that it can be accessed in a browser. Note that you will receive an error when viewing the file at this point, this is to be expected until the Flow is published and the Flow parameters have been added.

  9. Copy the Flow-id of the local runtime published Flow that you wish to use the player with. This information can be found on the Publish Flow form that is displayed when a Flow has been successfully published. Refer to Publishing flows to a local runtime.

  10. View your locally hosted player file in a browser, and use query parameters to build the Flow Run URL that identifies which Flow the player will run.

The Flow Run URL

The exact Flow Run URL will depend on how you have configured/located your local runtime player, but typically uses the following format:

[local_runtime_player\]?flow-id=[flow-id]

Where [local_runtime_player] is your hosted/local runtime player location, and [flow-id] is the Flow-id of the Flow to run.

For example, if your local runtime player was hosted locally, and the Flow Flow-id was 'c6b211f0-b342-4f67-b7b1', the Flow Run URL might be:

<http://localhost/default.html?flow-id=c6b211f0-b342-4f67-b7b1>

  • To start the latest activated version of the Flow, enter the Flow-id parameter.

  • To start a specific version of a Flow, enter the Flow-id and Flow-version-id parameters.

  • To join a Flow, enter the join parameter.

On this Page