Sample use case for I/O Processing | Optimizing I/O Processing in Employee Onboarding Circuit | Online Help | Circuit

Sample Use Case - Configuring Input and Output Processing in Circuit console

Let's explore Input/Output Processing further by building a Circuit using the example of an Employee Onboarding Process.
We initiate the process with the following state Input which contains information about the employee details for employee onboarding:

{
   "employee_details": {
      "emp_name": "John Doe",
      "emp_id": "357",
      "department": "Engineering",
      "role": "Software Engineer"
   },
   "onboarding": {
      "phase": "Employee Onboarding",
      "start_date": "2023-08-01",
      "manager": "Jane Smith",
      "location": "NewYork"
   }
}
Now, let's define Input & Output Processing fields (in Code view) for the above process:
{
  "onboard_employee": {
      "type": "function",
      "next": "End",
      "start": true,
      "function_id": "function_emp_onboard_1",
      "parameters": {
          "name": "$.employee_details.emp_name",
          "ID": "$.employee_details.emp_id",
          "department": "$.employee_details.department"
      },
      "input_path": "$.employee_details",
      "result_selector": {
          "task_status": "$.SdkResponseMetadata.HttpStatusCode"
      },
      "result_path": "$.onboarding_result",
      "on_error": [
       {
         "error_type": "timeout_error",
         "fallback": {
             "next": "End",
             "error_path": "$.error",
             "error_selector": {
                 "error_code": "EXC_TME_EXC",
                 "error_message": "Execution Time Limit Exceeded"
             }
          }
       }
      ],
     "output_path": "$.employee_details"
   }
}

 

The below images illustrate how the I/O processing fields are configured for the above example in both Builder View and Code View.

Builder View


 

Code View



In this setup:
  • Input Path: Initially filters the JSON to retain only the $.employee_info object, focusing on employee details.
  • Parameters: Passes specific employee-related data (employee_id, employee_name, department, role) to the onboarding function.
  • Result Selector: Extracts the HTTP status code from the response of the Function state, providing insights into the success or failure of the onboarding process.
  • Result Path: Appends the onboarding result as a child of the employee_info node in the original input JSON ($.onboarding_result).
  • Error Selector and Error Path: Capture and store error details in case of any issues during the onboarding process.
  • Output Path: Specifies that the final result passed to the next state is $.employee_info, ensuring only relevant employee information is carried forward.
After processing, the resulting JSON output for the next state will appear as follows:

{
      "role": "Software Engineer",
      "emp_name": "John Doe",
      "department": "Engineering",
      "emp_id": "357"
}


In case of a timeout error during execution, the output JSON will be:

{
    "error_code": "EXC_TME_EXC",
    "error_message": "Execution Time Limit Exceeded"
}

This demonstrates how the Input Path, Result Selector, Result Path, and Output Path can be effectively utilized in the context of Employee Onboarding, ensuring that only relevant data progresses to subsequent states in the Circuit.




    • Related Articles

    • JSON Path

      Path serves to locate specific parts or components within a JSON object. These paths start with the '$' symbol and follow JSONPath syntax. It is used to access particular elements or values within JSON objects passed in the Input Path, Output Path, ...

    • Circuit

      The Circuit state allows you to nest an existing, pre-configured circuit within another workflow. This is useful when your process includes complex sub-processes that are best managed as standalone circuits. Instead of rebuilding the same logic, you ...

    • Create and Configure a Circuit

      Circuits are visual workflows that help automate tasks across various modules in Qntrl. You can create circuits in two ways: Using pre-built templates: Qntrl provides ready-to-use templates designed for common use cases. These templates come with ...

    • Input Path

      Input Path enables you to filter and control the actual input passed to the state. By defining an Input Path (either in Builder View or Code View), using JSONPath notation, you can select a portion of the JSON input and use it for processing within ...

    • Output Path

      Output Path enables you to select a portion of the state's output and transfer it to the next state for processing, eliminating any unecessary objects from the JSON output. If the Output Path isn't specified, the entire JSON node (determined by the ...

    You are currently viewing the help articles of Qntrl 3.0. If you are still using our older version and require guidance with it, Click here.