Streaming Status

At certain stages of the flow, the Flow State object is used to set the flow state. The flow state definitions specified in the Flow Properties->Statuses** tab are selected as states from within the Flow Status object.

Using the object allows you to track where the flow is and receive reports based on process status. Using this object after the desired step in the flow, the current state of the flow can be set by selecting it from the registered states for that flow.

When the object in the Flow design screen is clicked, the object properties appear in the Property Viewer panel.

Clicking on the Stream State object displays the "Appearance", "Properties", and "Events" tabs in the Property Viewer panel.

Appearance

Text Configs

'Object Name' - The name of the object to be used on the system side. On the code side, the object is accessed by the value that is written in the object name field.

'Caption' - The area where the object's title text is entered.

'Is Lock' - This field is activated if the object is not to be moved at the time of design.

'Size' - The part where the width and height of the object are adjusted.

Properties

Documents

'Status' - This field lists the streaming statuses saved in the **"Statuses" field in the Stream Properties. The state definition in the flow state object in which the flow is intended to be set is selected from this list. When the flow passes through this object, the state of the flow is updated to the state selected on the object. In the web interface, the status of the flow is shown in the flow history section and in the flow information area.

Let's add a status named "Agreement Approved" to the status field in the flow properties.

The new state added can be selected in the Flow State object.

So as soon as the flow passes through this Flow Status object, the status of the flow will be updated to "Agreement Approved".

'Show in the Flow History' - This is the field that should be selected if the inserted Flow State object is desired to appear on the flow history in the web interface.

INFO

It is checked by the system that the attached properties on the object are correct. When a missing feature is found, a red exclamation point icon can be displayed on the object, and hovering over the icon with the mouse pointer can display what is missing or incorrect.

Events

The events owned by the Stream State object are located in the "Events" tab in the Property Viewer panel. Each event is triggered at different runtime moments, performing its own unique operations. Code written by the developer to these events is also executed at the time the corresponding event is triggered. To write code for any event, double-click the appropriate event line from the Events tab. The screen is directed to the flow code editor section named "FlowName.cs" and the method block for the clicked event is automatically created. The developer can construct any code block he wants in this method. Next to the event whose method is created on the code side by clicking from the Events tab, the method name information is automatically generated and the relationship between the event and the method is indicated.