Runtime Dashboard

Last modified by Erik Bakker on 2023/01/24 15:21

Note that the functionality mentioned in this microlearning will become obsolete when migrating to the 3rd generation runtime.

In this microlearning, you will learn the way you can see and validate which flows are active or running on a specific runtime in eMagiz.

Should you have any questions, please contact

1. Prerequisites

  • Basic knowledge of the eMagiz platform
  • Understanding Releases and be able to run a Deployment plan effectively

2. Key concepts

eMagiz uses the concept of flows and runtimes. A flow can run inside a runtime, and that runtime acts as a container to make that flow operate properly. Flows can be stopped inside that container, started, installed, and uninstalled. The runtime dashboard helps to understand the status of the flow inside the runtime, and where needed change the status of that flow.

eMagiz holds some terminology around these runtimes

  • There is the use of a JMS flow which is run as a single flow inside a runtime. For that specific runtime, there is 1 flow called the JMS and therefore usually referred to as the JMS runtime or just JMS
  • In the Create phase you have seen the onramps and offramps, as well as the routing and error flows. These are running inside the container runtime, often referred to as the container. In the Cloud formation, the JMS and Container are located on a single Cloud machine
  • There are also exit and entry flows that run inside runtimes, and these runtimes are referred to as the connector runtimes or just connectors. These connectors can run on Cloud Connector machines or Local Connector machines.

3. Exploring the Runtime dashboard

  • Navigation - use the selection on the left-hand panel to select the runtime you wish to inspect
  • Options
    • Start - start the flow selected. The light bulb will turn yellow if the flow is started correctly
    • Stop - stop the flow selected. The status of the flow will become Resolved.
    • Refresh - refresh the status of all flows on the selected runtime
    • Other options are discussed in the next microlearnings
  • Versions
    • Using the dashboard you can see what version of a flow is running in terms of major, minor, or patch. The pattern is <major>.<minor>.<patch>.
    • The last two digits always denote the build number that is used for that flow.
  • Do's and don'ts
    • Don't stop the container.infra flow. This means that the connectivity to the runtime is gone, and your control over the runtime itself. Especially in Cloud deployments, this is not recommended
    • Stopping the error.process flow means that error messages are no longer send to the eMagiz platform.


4. Key takeaways

  • The runtime dashboard helps to understand what flows are running and what the associated status is
  • You need edit rights to perform actions in the Runtime dashboard

5. Suggested Additional Readings

If you are interested in this topic and want more information on it please read the help text provided by eMagiz when executing these actions.