Managing Workflow
Last updated
Last updated
Nected's workflow automation platform provides an efficient, intuitive solution for configuring and executing custom workflows. With a flexible trigger node system, users can initiate automated processes based on a broad range of input parameters, from basic types like strings and numbers to complex data structures such as JSON objects and lists. This adaptability allows for precise, data-driven automation tailored to unique business requirements.
Log into Nected Dashboard: Start by logging into your Nected account. Access the dashboard to find the tools and options for creating workflows.
Navigate to Workflow Option: On the left panel of the dashboard, locate and click on the ‘Workflow’ option. This action takes you to the workflow management section.
Create a New Workflow: Click on the ‘Create Workflow’ button. This opens a window where you can define the details of your new workflow.
Name your workflow (e.g., “Sample Workflow”) and decide its stage (staging or production). Staging allows you to test the workflow without affecting live data, while production puts the workflow into actual use.
After creating your first workflow, follow this steps to complete the process of creating the workflow:
In the workflow editor, the start node is your trigger by default.
Click on it to open the trigger configuration.
from the list choose the type of trigger you want. Currently, only the API trigger is available. More triggers {such as events and cron/scheduler} are coming soon.
You can define different types of input parameters for your trigger:
String: To add string value click on the dropdown list and select "String" from the given option. Then add the test value like this:
Numeric, Boolean: Similarly click on the dropdown button to select the respective datatype and then in the test value.
Date & DateTime: To add Date or DateTime, you can select the datatype from the dropdown list and then you can just add the test value like this:
The dafult format of Date is: DD/MM/YYYY
& the default format of DateTime is : DD/MM/YYYY HH:MM
JSON: To add raw JSON as input follow the guides here.
List: To add LIST (i.e. strings or numbers or JSON or any other type) as input follow the guides here.
Click on Add Field, choose the type, and provide a name for each attribute.
Enter example values for these attributes as required for testing purposes. (Example values are compulsory to test the trigger)
Navigate to the Settings tab within the workflow editor.
Here you will find your Workflow API URL which can be copied.
You can also find the Body Params here, which are needed when requesting your workflow API.
Copy the Body Params to be integrated into your system for triggering the workflow.
Setting Up API Authentication (Optional):
Within the Settings tab, you can add an authentication layer to use your API securely by selecting from the available methods.
Once you select the preferred authentication method, configure it according to the requirements.
After setting up, make sure to save your changes.
For more detailed information on authentication methods, please refer to the Nected documentation on API authentication here.
To add nodes, follow these steps:
Access 'Add Node': Click on the '+' button, to open the “Add node’ panel.
Select the Desired Node Type: From the 'Add Node' modal, browse through the available nodes. You'll see a variety of nodes, each represented by an icon and name, indicating its function.
Action Node: Action Nodes are the primary executors of operations and play a key role in handling data, making decisions, and executing processes.
Control Node: Control Nodes manage how and when actions occur, influencing the workflow’s logic and timing.
Note: To use the output data in subsequent nodes via tokens, one must test the added node to set up sample output.
After adding a node you need to follow the below steps to configure your node.
By the way, this is a general guide to configuring a node. Configuring specific nodes can be different than each other. So read each node's docs for a more detailed guide.
Click on the node to configure it. Fill in the necessary parameters, test it, and set proper settings according to your requirements.
Input Params: The Input Params section looks different for different types of Nodes. In the respective field of nodes, you can feed in respective constant values(like string or number) or map any outcomes from any previous Nodes using tokens available in the dropdown list or can map directly the global variables using tokens.
Note: Only compatible data-type tokens are available in the dropdown to select.
In the dropdown, there are three types of tokens you can see:
Trigger Nodes: {{ Trigger.attribute_Name }} for example: Trigger.sensor_id
Previous Nodes: {{perv_node_Name.attribute_Name}} for example: SetVariable1.output.key_1
Global Attributes: {{globalVar.attribute_Name}} for example: globalVar.edtechLeadsBucketD
By hovering on the specific attribute, you can see the value of that input param. This feature allows you to check the attribute value you're adding to the input param field.
Test Result: Once you've entered the input parameters, you can test the node to ensure it functions as expected by just clicking the 'Test' button. You'll see the following sections:
Input section(optional): The Input section is purely optional as it can only appear if the node is a rule node. Else this section will not appear.
Output Section: In the output section, same as the rule result tab, you can see the execution result in JSON format, along with the Action name and status(if all conditions are met).
Settings: The Settings section allows you to define broader operational parameters and any additional options controlling the node's workflow behavior. Like timeouts, retrials, limits, etc. Now, the settings tab can also vary according to the node types. Go to the specific node pages for a more detailed overview of specific settings tabs.
Save: After configuring the node, save your node. It's important to test the node before saving the node if you want to use the output of this node in any of the subsequent nodes.
Based on the current configuration of the nodes, it can be in any of the following three states:
Untested:
The "Draft/Untested" status is assigned to a node when it is not tested and it will show like the above image.
During the drafting phase, you have the flexibility to make changes and adjustments to your node without affecting the environment.
Note: A node can be kept in untested status, however, the node can affect another ‘child node’ or ’post node’ to be tested. Also, as long as a node is in untested status, the workflow can’t be published.
Tested:
After you have completed the editing process or made changes to the node, you can initiate testing by clicking the "Test" button.
This action redirects you to the “Test Result” tab, where you can evaluate the node's behavior and performance in a controlled staging environment.
Error:
If your node doesn’t execute properly or gets any kind of error, the Node then looks like the above, and its status changes into ‘error’.
To fix this, you can try to run the node again by simply clicking the left ▶️ button or can click on the Node to edit the node and fix that if there’s any kind of error.
Nected allows you to test workflows in a staging environment before deploying them to production. This ensures that your rules are working as expected.
Test in Staging: Click the "Test in Staging" button to test a workflow.
Input Data: Ensure that proper input data is given to all added nodes.
Test Result Tab: In the "Test Result" tab, you can evaluate the node's behavior and performance in a controlled staging environment.
If the added nodes have an error, then the test in staging will be disabled.
Finally, after testing the workflow, you can:
Publish in production: To publish the Workflow in production click on the "Publish" button on the bottom right corner. Please refer to Test & Publish Workflows for more detailed information.
Request for Review: You can assign someone from your workspace to review your Workflow as an Approver, like this:
Note: If you've requested the dataset for a review, then only the reviewer can publish the dataset. Otherwise, you can simply publish the data source by clicking on the Publish button. Read more about it from Approval Flow.
If you edit a published Workflow and re-publish the updated Workflow, then it creates a new version of it. Now for any reason, if you want to check or roll back to a specific previous version, you can do that using the version Control tab. You can do this in two different ways:
At the top bar, you can see the Environment tabs with numbers written alongside. These numbers show how many versions you have for that environment. Like in the image, you can see that I've 3 Published versions and 1 Draft version of that. Now, you can click on the respective environment to access the Version Control section like this:
The second option is, you click on the just next icon of the settings icon, and it will open the Version Control section and from there you can access it.
To rollback to a previous version just click on the Rollback button on that version. You can read more about it in versioning & rollback.
So, as discussed in the previous section, if you're editing the workflow and then publishing it, then it creates a new version. But if you're using the workflow in any other workflow, and you want to check which version of this workflow one is using, then you can do that using the "Dependency Map" section. To do this follow this:
Click on the icon just below the Version Control icon, and it will open the Dependency Map section.
Inside the Dependency Map section, you'll have two tabs:
Using: In this tab, you can check which integration, rule or workflow, this workflow is using.
Used by: In this tab, you can check which workflow is using this workflow along with the version, as shown in the GIF.
Click Clone to duplicate the existing workflow. You can modify a cloned rule using the Edit button.
Click Delete to remove a Workflow from your Nected platform. The Delete workflow dialog box opens. Click the Delete button on the dialog box to remove the rule.
You must update a workflow after you delete a workflow if the deleted workflow is being called in that workflow.
Note: On the free plan, you can create up to 2 Workflows.
Now, you can also import or export your workflow irrespective of its state (draft/tested/published) and version. You can use that same version and state it in other workspaces.
To learn more about the detailed steps and available options for importing and exporting workflows, please refer to the Import/Export documentation.
Once testing is completed and you exit the testing screen, the rule status transitions to "Tested."
