This tutorial will show how to create a view with the SyncFlow control. The SyncFlow view lets you view and monitor the functioning of the processing logic in the selected flow with the ability to correct any anomalies that may occur.
The article provides guidance on how to:
For more details on the SyncFlow control, click on the following link:
Creating an Ops Portal SyncFlow View
Open the Operations Portal created earlier, go to the Operations Portal menu and click the plus icon outlined in red in the image below to add a new View.
Give it a name and a meaningful description (description optional).
Click on the Save View button.
Select the Control type
Each Ops Portal view can be configured to use a specific control type.
Select the SyncFlow option which provides a view into any Synatic Flow that returns a result.
Click on the Control field.
The selection list opens, now select the SyncFlow option.
Select the Flow
Select the desired flow from the dropdown list or alternatively, create a new flow by clicking on the highlighted plus icon.
Select the Output
Select the output type to use from the available options:
JSON - The JSON option will display a JSON view of the record/file being used in the flow.
FILE - The file option immediately downloads a file to your computer based on the file format being used in the flow.
In this example, select the JSON option in the selection list.
Input Schemas
Define an input form to capture input parameters for the flow. This form will be displayed when the View is opened.
The input form is built in the Designer tab. Click on the button highlighted in the image below to build an input form.
The Schema Viewer and Raw Schema tabs are used to view the data only.
The Designer tab is used to add input fields to capture the required data.
Click on the plus icon (+) to add fields.
The "string" option is used to select the appropriate data type from the selection list.
The Required checkbox is selected to ensure that the value is entered at runtime. The flow will not continue if the value is not entered.
An example of the input form is shown in the image below.
Options
Select the following options to define the View further:
Allow File Upload checkbox – Allow file upload into the flow.
Return Source – The return source from the flow to use.
Auto – Auto detects the appropriate output.
Record – Returns the current record processed by the subflow.
Output – Returns the output of the Writer Step (if any) in the subflow.
Result – Returns the output of the Destination Step (if any) in the subflow.
Execute Automatically – Execute the flow automatically when the View is opened if no parameters are required.
Hidden checkbox – Hide the view from the Operations Portal when selected.
Once the View's configuration is completed, click the Save View button.
Operations Portal
The view is constructed in the Operations Portal. To access it the Operations Portal, Click on the link below:
Type the Organization name and click on the sign-in button.
1. Select the Ops Portal option from the view list on the left side of the platform.
2. Click the Execute Flow button to run the Flow in the View.
3. Results of the run are shown in the image below.
Flow Request Box
Flow request buttons are used to initiate SyncFlow flows that have been set in a SyncFlow Control Ops View.
The flow requests box will show all flow requests. It is located at the bottom of the page on the right side of the screen as shown in the image below. The flow requests box can be expanded and collapsed or removed using the icons outlined in blue.
Details about how long the flow took to run as well as the status will be shown as shown in the image below.
Ops Portal View Menu Section
To access the menu, click on the username initials located on the top right of the page as shown in the image below.
In addition to showing the user details, the menu has the option to show the flow request buttons if they are closed. There are also options to sign out and access the settings page. The settings page is shown in the image below.
Set the table row height by clicking on the outlined dropdown arrow to select the required pixels. The flow request box automatic expansion is turned off in the settings as well by clicking the on/off button outlined in blue in the above image.