Start/Stop Flows

In most cases, deploying on the container level is the preferred approach to deploy a release. It is faster, more stable, and less error-prone. However, when running into problems or maintaining your solution in a Production environment, you might need something extra. So, something extra is what we call "Start/Stop flows." In this microlearning, we will explain what the function does for you and when best to use it.

Should you have any questions, please get in touch with academy@emagiz.com.

1. Prerequisites

• Intermediate knowledge of the eMagiz platform

2. Key concepts

This microlearning centers around start/stop flows for the 3rd generation runtime.
This functionality allows you to

• Stop the entry point of a flow, ensuring no messages are consumed from that point onwards
• Start the entry point of a flow, ensuring messages are consumed again
• Gain additional control over your model in case of Production issues or maintenance windows of related external applications.

3. Start/Stop Flows

In most cases, deploying on the container level is the preferred approach to deploy a release. It is faster, more stable, and less error-prone. However, when running into problems or maintaining your solution in a Production environment, you might need something extra. So, something extra is what we call "Start/Stop flows." 

3.1 How to use it

You can access this functionality via the "Deploy Architecture" overview in Deploy. For example, you can open the context menu on the runtime level and select the "Start/Stop Flows" option.

After selecting the option, eMagiz will open a pop-up where you can stop and start the starting point of each flow deployed on that runtime. This effect is that the flow will process no new messages, but the flow will still process all remaining messages after stopping the flow. To prevent a flow, you select a flow and press the Stop button. To start it again, press Start.

3.2 When to use it

Now that we have learned when to use it, we can focus our attention on when to use it. The preferred option when executing changes on the 3rd generation runtime is via the deployment plan, which keeps all parts of your model in sync. Furthermore, as a result, anyone with access can easily see the runtime state. Having said that, when running into issues on a specific integration, for example, spamming of error message on a particular flow, you should turn to the "Start/Stop flows" functionality only to stop that specific process but keep the rest running.

Another use case of the "Start/Stop flows" functionality is when maintenance is performed on an external system linked to your model. In these cases, you should halt all traffic toward that system but still want to allow them to send you information (in case that is needed).

4. Key takeaways

• Stop the entry point of a flow, ensuring no messages are consumed from that point onwards
• Start the entry point of a flow, ensuring messages are consumed again
• Gain additional control over your model in case of Production issues or maintenance windows of related external applications.
• Only use the functionality in specific scenarios.

6. Suggested Additional Readings

No suggested additional readings for this microlearning. Please read the help text on the pop-up for more context on the functionality.