In this article, each Ops Portal view section will be discussed in detail, covering the selections, settings, and options of the SyncFlow control.
The SyncFlow control creates a view that can monitor all flows in Synchronous Mode which implies that the flow will run and data is returned to the flow and displayed on the output window.
This article describes how to:
Watch the tutorial video below to learn how to create the SyncFlow View using the Synatic Operations Portal.
Creating a new SyncFlow View
Go to the Operations Portal menu and select the Operations Portal Tutorial.
Adjacent to the Views tab, click ⨁ to add a new View.
Give the View a name and a meaningful description.
Click on the Control field and select the SyncFlow control to display the data captured in the selected Flow. The SyncFlow control window for this View opens and lets you edit the relevant values and options as described below.
Each View created requires that a Synatic Flow is selected. You may create a new Flow by clicking ⨁ or alternatively, you can select the Flow you want to use from the selection list.
The Output type
The SyncFlow output option is used to define the data type of the output:
JSON - Synatic uses the commonly used JSON file format which can be displayed in most browsers.
FILE - If this option is selected then the JSON file is immediately downloaded to your computer.
The Input Schema is used only in cases where a Synatic Flow has been configured to capture input data before it can execute. The input data might relate to fields in an attached database to search for or filter the output data. Alternatively, the input value may be used in a calculation.
We'll use the Input Schema designer to build an input form to capture and pass data to the selected flow.
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.
You click + to add data objects.
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.
The following options must be set or selected to define the output display and available functionality:
Allow File Upload - This option instructs the view to request a JSON file if the assigned Flow requires input data from a data file.
Return Source - Generally Auto is used and selected from the dropdown list:
- Auto detects the appropriate output.
- Returns the current record processed by the sub flow.
Returns the output of a Writer Step (if any) in the sub flow.
- Returns the output of the Destination Step (if any) in the sub flow.
Execute Automatically - Select the checkbox to execute the flow in the View automatically.
Save the View
When you have completed the View's configuration, click the Save View button.
Test the View
It is always advisable to test each view you create in Synatic's Ops Portal.
1. Select the Ops Portal option in the Account menu to open the Operations Portal. This is also the method used by the operations personnel to process these views.
2. You must then select the view you created from the list of available views.
3. To run execute the Flow assigned to the View, click the Execute Flow button. If the Execute Automatically option (which is available only in some Controls) is selected then the Flow will run automatically.
Revisit the Getting Started page for a refresher.
Learn more in the Operations Portal tutorials.