Start of Flow
The flow start object is the object that specifies the starting point of the flow of the designed process. This object should be at the top of every flow design. Other objects to be used in the flow design are ordered after this flow start object and relate to each other with the connection object. Only 1 in-stream object is allowed on a flow screen.
While the authoring interface is active screen flow, the Toolbox panel lists flow objects. Sliding a Start Stream object from the Toolbox panel and dropping it onto the flow screen adds the object to the stream. Clicking the start stream object will list the properties that the object has in the Property Viewer panel.
Clicking on the Start Stream object will provide "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
'Documents' - This field sets which form and which view of the form the user who started the flow can see. The forms included in the project are kept in the Document object on the flow side. The document object represents the form that is linked to it and the data on the form. A flow can have multiple, different Document objects that represent different forms. Whichever form the user in the Start Flow object is asked to see, from this field the Document object to which the corresponding form is linked is selected and the necessary settings are determined.
In the Start Flow object, multiple Document objects can also be added for the user who started the process to see in the web interface. When clicking on the Documents section, one or more Document objects that the user wants to see are added with the "Insert" button and the settings of the edits that can be made on the document are determined.
Properties tab properties
| Feature | Description |
|---|---|
| Document | The area on the flow design where all Document objects are listed. The Document object to which the form to be shown to the contact in the Start of Flow object is linked is selected from this field. |
| View | The views of the form to which the Document object selected from the "Document" field is linked are listed in this field. The user in the object must be selected from this field to see which form view they want to see when they open the form. If no selection is made from the view area, the user will see the "default" view. |
| Panel Size | It is the area that determines the width at which the document object defined in the web interface can be opened. Selecting one of the 1-2-3 values will open the panel size at the selected value width. |
| Editable | This field determines whether the user who initiated the flow can edit the document. A document without the Edit field checked opens to the user in read-only mode in the web interface, and the contact can't edit the form. If editing is desired on the form, this field must be checked. |
| Show events | This is the area where the user in that step is set to see event buttons on the form that they will take action to advance the form and continue the flow. If the user needs to use the action buttons to act on the relevant document and include it in a workflow, this field should be checked. If the document is attached to the user for informational purposes, the action event buttons do not need to appear in this document and in this case the "Show events" field should not be checked. |
| Signature | The system supports digital signature infrastructure. If certificates have been obtained from digital signature providers, this option can be used for signed approvals of workflows and documents.The signature field lists 4 options;<br/> No sign : Selected<br/> to indicate that no digital signature will be used on the document Optional : Optionally selected when using a digital signature on the document. When the process comes to the user in question, it is up to the user whether the document is digitally signed or not.<br/> Required : Requires the user to sign the document with a digital signature certificate, regardless of whether they have a certificate or not.<br/> Required if possible : If a digital signing certificate exists for the user, the system forces the user to use the digital signing certificate to approve the document. The requirement applies to the user only if a specific certificate exists. |
Signature tab properties
This is the part where detailed edits to the document signing settings are made.
| Feature | Description |
|---|---|
| Signature | An area that determines whether the document is signed using CAdES or PAdES types. |
| Timestamp | It is the feature that is activated when you want to use the time denga when signing the document. |
:::d anger WARNING
If the document object inserted within the object has a signature set, the document object to be signed must contain documents (pdf etc.) and signatures must be placed on the documents. CSP forms cannot be signed!
:::
CAUTION
If the signature setting has been made on the document object inserted within the object, the Digital Signature Required selection in the event must be activated in the event in which the signature operation will be performed in the Events section of the same object attached in order for the signature process to be initiated in the web interface.
Events
'Events' - This is the part where the action events that the user who started the flow can receive for the form in the web interface are defined. The events defined in this field appear as action buttons on the form in the web interface. Whichever event button the user clicks, the process proceeds to the flow step where the connection arrow for that event is connected at the moment of design.
If the number of events has been added to the object from the Events area, the connection arrows to represent each event must be extracted from the object in the flow design screen, and these arrows must be connected to wherever the stream is intended to go when the corresponding event is clicked.
Clicking on the Events field will open a window where events to be added to the object can be selected and edits can be made for those events. Here the events defined in the Flow Properties->Events tab are listed as event records. By default, the Stream Start object is attached to the "Send"** event. To modify existing events, add a new event, or remove an existing event from the object, clicking the Events field opens the event editing window.
A new event can be added to the Start Stream object with the **"Add" button in the Events editing window, the event settings can be changed by clicking on the event line for attached events, or the event can be removed from the object by pressing the trash can icon that appears in the attached event line details.
| Feature | Description |
|---|---|
| Identity | The id value that represents the event appears in this section. This field is in read-only mode and cannot be changed. |
| Description | The area where the text portion of the event appears. |
| Visible | This feature must be activated in order for the corresponding event button to appear in the web interface. |
| Validate | In order to work with the mandatory conditions given in the object properties at the time of form design and the controls written in the validation Rule Manager section of the form, and to give a warning message to the user in cases where the desired condition is not met or the mandatory objects are left empty, the "Validate" field must be checked on the event button clicked by the user. |
| Reason | When an event with a reason field marked is clicked on in the web interface, a field is removed for the user to enter a description of the reason. It is typically used for the Reject event, and when the person wants to reject the form by pressing the Reject button, they are prompted to enter the reason for the rejection in the reason field. |
| Reason Title | The field where the reason description is shown in the web interface is the field where the expression in the header is customized. |
| Digital Signature Required | Clicking on an event in the web interface with the digital signature required field marked will open the screen required for the user to perform the E-signature process. For the signing process to begin, the Signature settings must be set on the document object defined in the object. |
| Form | From the form field, all the Document objects that are in the flow are listed. When a Document object is selected from this field for any event, clicking on this event in the web interface opens the screen of the defined form within the Document object selected from the Form field in front of the user and the user is expected to fill in the fields in the form. When the user fills out the form that opens and says OK, the flow proceeds to the next step. This completed form becomes the "Event Form" of the corresponding flow object. |
| Icon | The icons of the event buttons that will appear on the form in the web interface are selected from this area. By default, the icons of the incoming events in the system are automatically specified in the icon column. |
CAUTION
If the settings for an event that was added to the object context were changed in Flow Properties->Events, the attached event record in the object context might not be affected by this change. After the change, objects that use the corresponding event may need to be checked and the event for which the change was made may need to be removed and re-added from the Events area.
CAUTION
If an event attached to an object is deleted from the Flow Properties->Events area, the corresponding attached event record within the object must also be deleted, checking for objects that use that event.
Options
'Hide the Approver' - A feature that allows you to show the name of the user who started the stream as hidden in the flow history as * * * *.
'Auto Open Approval Option' - If consecutive flow steps are coming to the same person according to the flow scenario, when the person opens the form for the first action step and presses the action button by performing the necessary actions, the screen will be informed that "Workflow has come to you again". If "Auto Open" is selected in the "Auto Open Approval Option", the form opens directly in front of the user for the second action when the user takes the first action. If "Auto-power" is selected, the screen will redirect to the flow history page after the first action step. To take the second action, the person will need to go to the Approvals page to find the relevant process and reopen the form.
'Show in the Flow History' - This is where it is set whether the corresponding flow step is shown in the flow history or not.
'Start Immediately' - When the feature is activated, it performs the process of starting a new flow without the need for user interaction. When the feature is activated, the event connections from the object are removed and only the Continue event connection can be removed from the object.
CAUTION
If the Start Immediately feature is active and the object does not have a selection in the Documents field, the Create Document object must be used in the flow for the form to render.
'Can Save As Draft' - A feature that is activated if the user who starts the flow in the menu in the web interface is asked to save the form as a draft. Especially in the web interface, the "Save as Draft" button is shown in the form, the user who starts the flow can save the form by clicking the button.
The user can access the forms saved as drafts from the Drafts section in Workflow Management.
INFO
Recording of processes as drafts is activated on a project basis. If the feature is not enabled, the form is not saved as a draft when the user who started the flow closes the form without advancing the process.
CAUTION
When the process is started in the web interface, the form data is not saved in the database until the form is saved as a draft or the process is started.
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 Start Stream 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.