Skip to main content
Feedback

Setting up a local runtime HTML5 player for an individual Flow

A local runtime player can be set up to be used with only a specific local runtime Flow.

With this approach, a local 'default.html' file based on the Boomi Flow default player is created in a folder and hosted on the local runtime machine. It is configured to render only a specific local runtime Flow in a browser.

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 Boomi Flow, open up the default 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 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 and Flow-id of the local runtime published Flow.

    • For example, the Flow-id can be found in the Flow url as the '&Flow-id=' parameter.
    • For example, the tenant-id can be found in the Account menu in Boomi Flow.

  7. Edit the engine initialization Url parameters at the bottom of the pasted HTML; initialization of the Flow requires a few parameters that by default are usually fetched from the url query string. This will ensure that your player communicates with the correct Flow.

    Url parameters

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

    For example, if your Flow tenant-id was '07f799a4-af7c-449b-ba7c-f1f526f70b' and your Flow-id was 'c6b211f0-b342-4f67-b7b1-b8b62868bb', your player code would be:

    manywho.engine.initialize(
    **'07f799a4-af7c-449b-ba7c-f1f526f70b',
     'c6b211f0-b342-4f67-b7b1-b8b62868bb'**,
     'main',
     queryParameters['join'],
     queryParameters['authorization'],
     options,
     queryParameters['initialization']);

  8. Save the new player file.

  9. View your locally hosted player file in a browser; the Flow will run and be displayed as if it were using the default Boomi Flow hosted player.

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]

Where [local_runtime_player] is your hosted/local runtime player location.

For example, if your local runtime player was hosted locally, the Flow Run URL would be:

http://localhost/default.html

On this Page