Edit Database Unit (Store Operations)

Edit Database Unit (Store Operations)

Overview

A Database Unit in a flow diagram interacts with a database as part of the workflow. It allows the process to perform structured operations such as reading, writing, updating, or deleting data.

What it does:
  1. Connects to a database system (SQL or NoSQL).
  2. Executes queries or commands to manipulate data.
  3. Returns results for use in subsequent steps.
How it works:
  1. Configuration:
    1. Database type (e.g., MySQL, PostgreSQL, Oracle, MongoDB).
    2. Connection details (host, port, username, password).
    3. Optional: Connection pooling, timeout settings.
  2. Action Selection:
    1. Read: Fetch data using SELECT or equivalent.
    2. Write: Insert or update records.
    3. Delete: Remove records.
    4. Execute Procedure: Call stored procedures or functions.
  3. Execution:
    1. Sends the query to the database.
    2. Receives the result set or status.
    3. Passes data to the next unit (e.g., Mapping Unit, Decision Unit).
  4. Error Handling:
    1. Handles connection failures, query errors, or timeouts.
    2. Can branch to error-handling logic.
Use case:
  1. Document Workflow: Fetch metadata from a database before processing a document.
  2. Integration: Store API response data in a database.
  3. Reporting: Retrieve records for generating reports.

Accessing Database Unit Properties

  1. To view/modify the unit property, click on the Database unit. Upon clicking the unit, a property panel opens below, and the unit gets highlighted.
  2. The property panel will open and display the following sections:
    1. Input
    2. Processing
    3. Output
  3. By default, all sections are displayed unless you have specified panel settings in the user settings.


Input Section

  1. The Input section provides the details on the inbound message, and the following tabs are provided in the section:
    1. Data section: The Data section provides the name of the processed units of the flow.
    2. Message: The Message section displays the inbound message of the selected unit. 


Data Section

  1. The section provides details on inbound messages and lists units that have already been processed. The following message details will be shown:
    1. Complete Message:
      1. The Complete Message represents the entire message payload, including:
        1. Message Header
        2. Start Message
        3. Input Message
        4. Any additional structural elements
    2. Message Header:
      1. The Message Header contains metadata about the message rather than the message's business data.
      2. It helps the system understand how to handle the message. 
      3. It helps in tracking and tracing, routing, logging, and error handling.
    3. Start Message: 
      1. The Start Message is the initial structure received by the Start Unit when the flow begins.
        1. It defines the expected input format.
        2. It acts as the primary data structure for processing.
        3. It is usually defined using XML or JSON schema.
      2. This message becomes the main working data object throughout the flow.
    4. Input Message:
      1. The Input Message refers to the actual incoming payload provided to the flow at runtime.
        1. In testing → comes from the Test Message (XML).
        2. In production → comes from API, queue, subscription, etc.
      2. It populates the Start Message structure and is then used by downstream units like Mapping, Condition, or API calls.
    5. Already Processed Units:
      1. The units that are processed before the Database unit will be listed here. The unit will be displayed by its name. 
  2. You can click any unit to view the data processed by that unit. The message will be displayed in the 


  1. A Search option is also provided to search for the unit name from the list.
  2. Enter the unit name in the search field, and the result will be displayed instantly.
  3. To close the search, click on the Clear (x) icon. 


  1. A Sort icon is provided to arrange the list as needed.
  2. You can also arrange the units either in ascending order (A to Z) or descending order (Z to A) using the icon next to the search icon. By default, the units are arranged in ascending order.
  3. Click the Sort icon to switch to descending order.
  4. Click again to return to the default ascending order.


  1. A Collapse icon is provided next to the Sort icon. You can use this function to increase the message's working area for better readability and more space.
  2. Click on the icon to collapse the listing. 


  1. After clicking the Collapse icon, the listing collapses.
  2. However, you will still be able to view the icon of the respective units.
  3. When you hover over the icon, you can view the names of the units. Additionally, you can click any link to view its message.


Message Section

  1. You can view the message of any of the units listed in the Data section.
  2. To view the message of any unit, click on the unit in the Data section. The message will be displayed instantly. 


Find

  1. A Find option is also provided to find any node in the message.
  2. Enter the node name in the search field, and the result will be displayed instantly and highlighted.
  3. If more than one result is displayed, a navigation icon and a results counter are provided. You can navigate through the search results using the navigation icons.
  4. To close the search, click the 'x' icon. 


Legends

  1. A legend icon is provided to help you understand the message. The color of the nodes indicates their status.
  2. Click the Legend icon to view the details. When you click the icon, the list will show the legend used in the message.


Adjust Message Font Size

  1. A Font Size box is provided to increase or decrease the message's font size.
  2. The current font size will be shown in the box.
  3. Click on the box to increase or decrease the font size. 


  1. After clicking the Font Size box, a slider will appear below it.
  2. Use the slider to increase or decrease the font size. 
  3. As you slide, the change in size will be reflected in the message instantly.  
  4. The supported font size ranges from 8 to 72.


Switch Between Code and Tree View

  1. By default, the message will be displayed in Tree View.
  2. Click on the Switch to Code View icon.


  1. The inbound message gets switched to code view.
  2. Click the icon again to switch back to tree view mode.


Toolbar (Code View)

  1. A toolbar is provided to help you to edit the message efficiently. The code view provides the following icons in the toolbar:
    1. Find:
      1. Function: Searches for specific text or patterns within the document or code.
      2. Use Case: Quickly locating words, phrases, or code snippets.
    2. Replace:
      1. Function: Finds specific text and replaces it with new text.
      2. Use Case: Updating repeated terms or correcting errors throughout a document.
    3. Beautify:
      1. Function: Formats code or text to make it more readable and properly indented.
      2. Use Case: Cleaning up messy code for better readability.
    4. Word Wrap:
      1. Function: Ensures that long lines of text automatically wrap to fit within the visible window without horizontal scrolling.
      2. Use Case: Easier reading and editing of long lines.
    5. Maximize: 
      1. Function: Expands the editor or window to full screen for better focus and visibility.
      2. Use Case: Working without distractions or seeing more content at once.
  2. Once you have modified the message, click the Save button to save the changes.


View Variables

  1. The section will display the defined variables. You can create global or local variables in the section.
  2. To open the Variable section, click on the Variable menu.


  1. A list of the variables gets displayed. The list provides both global and local variables.
    1. Global Variables: 
      1. A global variable is one declared at a higher level and accessible from any part of the flow.
      2. Key Characteristics: 
        1. Accessible throughout the entire flow
        2. Can be used by multiple units
        3. Retains its value during the flow execution
      3. When to Use:
        1. Shared configuration values
        2. Data that must be reused across multiple units
        3. Environment-level settings
    2. Local Variables:
      1. A local variable is declared inside a specific unit or block and can only be accessed within that scope.
      2. Key Characteristics: 
        1. Limited visibility
        2. Exists only within the unit
        3. Not accessible outside the specific unit
      3. When to Use:
        1. Unit-specific logic
        2. Temporary calculations
        3. Intermediate processing values


Add Variables

  1. To add variables, click on the (+) icon as shown on the screen.


  1. An Add Variable pop-up will appear, displaying the following fields. All fields are mandatory.
  2. Variable Name:
    1. It is a text field; you can enter the variable name in this field.
    2. You are free to use any name of your choice.
  3. Scope:
    1. You need to select the variable scope from the drop-down.
    2. The following scopes are provided in the drop-down:
      1. Local: A local variable is declared within a specific unit and can be accessed only by that unit. 
      2. Global: A global variable is one declared at a higher level and accessible to all units from any part of the flow.
  4. Variable Type:
    1. Once you have selected the scope, select the variable type from the drop-down.
    2. The following variable types are available:
      1. Fixed: A fixed variable has a constant value that you manually define, and it does not change during execution. 
      2. User: A user variable gets its value from user input.
      3. Expression: An expression variable is calculated using logic or formulas.
  5. Once you have filled all the fields, click on the Add button.
  6. Click Cancel to close the pop-up.


  1. The newly added variable gets added to the list.
  2. Now you can edit the variable and set the values.


Edit Variables

  1. To edit any variable, hover over the variable band and click on the Edit icon.
  2. Based on the variable type, the edit screen will open.


    Edit Fixed Variable Type

    1. Clicking the edit icon opens the Fixed Variable pop-up.
    2. You can modify the value in the Value field. This field is mandatory and cannot be left blank.
    3. Once the modification is complete, click the Save button.
    4. Click on the Cancel button to close the pop-up. 

    Edit User Defined Variable Type

    1. Clicking the edit icon opens the User Variable pop-up. You can modify the following fields:
      1. Label: This field allows you to change the label of the variable.
      2. Description: This field allows you to change the existing description.
      3. Mandatory: Make the variable mandatory or non-mandatory using the Yes or No from the drop-down. 
      4. Data Type: This field allows you to set the data type for the selected variable. 
      5. Default Value: Set the default value for the selected variable. 
    2. Once the modification is complete, click the Save button.
    3. Click on the Cancel button to close the pop-up. 

    Edit Expression Variable Type

    1. Clicking the edit icon opens the Expression Variable pop-up.
    2. You can modify the existing expression of the variable. You can define the expression in the expression field. If you need any variable in your expression, you can drag and drop it from the list. Please note that you cannot use (drag & drop) the selected variable in your expression. 
    3. Once the modification is complete, click the Save button.
    4. Click on the Cancel button to close the pop-up.


    Delete Variables

    1. To delete any variable, hover over the variable band and click on the Delete icon.


    1. A Delete Variable pop-up will appear.
    2. Click on the Yes button to delete the chosen variable.
    3. Click on the No button close the pop-up.


    Processing Section

    The Processing section provides configuration details for the selected unit and includes the following tabs. You can switch between the tabs by clicking on them:
    1. Details Tab: The Details Tab contains the flow's general information and basic properties. Typically includes the unit name and its description.
    2. Configuration Tab: Defines the technical setup and runtime-related settings. Typically includes payload handling, exposed objects, and error-handling settings.
    3. Design: The Design Tab is the visual workspace where you build the actual flow logic. Typically includes request document, key handling, error handling, etc.
    4. Processed: This tab will appear only when the unit is executed. It provides the unit's processing details.


    Details Tab

    The Details tab provides basic details of the Database unit, including its name and description. The Details tab is displayed by default. It provides the following fields:
    1. Name: 
      1. The unit name is provided in this section, and you may modify the existing name within this field.
      2. Click the field to update the unit's name.
      3. Upon completing the modifications, click the 'Save' button in the action area of the screen.
    2. Description: 
      1. This field describes the processing unit, and you can modify the existing description.
      2. Click the field to edit the unit's description.
      3. Once you are done with the modification, click the Save button in the action area of the screen.

    Configuration Tab

    1. To switch to the Configuration tab, click it. The Configuration tab provides configuration details for the Database unit.
    2. The following fields will be shown on the tab:
      1. Payload Handling
      2. Continue flow on error
      3. Exposed Object
    3. Click any of the bands to view and modify the settings. 


    Payload Handling

    This setting allows you to define how a flow receives, processes, transforms, and passes message data (payload) between units during execution. In simple terms, it allows you to select the specific payload that you do not want to process.
    1. Expand the band by clicking it. Once expanded, you will see the Remove for further processing field.
    2. Click the field to view the available payload. Select the payload you do not want to process.
    3. You can also type the payload type in the field; the entered payload is listed, and then select it.


    1. The selected payload is added to the field as a chip. The chip contains the 'X' icon; you can remove the payload by clicking the 'X' icon.
    2. Once you have added the payloads you do not want to process, click the Save button.


    Continue Flow on Error

    Continue Flow on Error is a configuration option that allows a flow to continue executing even if a specific unit encounters an error. Instead of stopping the entire flow, execution moves to the next configured step.
    1. A toggle switch is provided on the band, and it is disabled by default.
    2. To allow the process to continue despite an error, enable the toggle switch.
    3. Click the Save button to save the configuration.


    Exposed Object

    An Exposed Object is a data structure or variable that is made available outside the flow as part of its output. It defines what information the flow will return to the calling system.
    1. Expand the band by clicking it. Once expanded, you will see the Object drop-down field.
    Image

    1. Click the field to view the available objects. Select the required object to process.
    2. Once the object is selected, click the Save button.


    Design Tab

    1. To switch to the Design tab, click it. The Design tab provides configuration details for the Database unit.
    2. The following fields will be shown on the tab:
      1. End Point
      2. Control
      3. SQL
      4. Key Handling
      5. Extendad Error Handling
    3. Click any of the bands to view and modify the settings. 


    Endpoint

    An Endpoint is the specific URL or address where a system sends or receives data. It acts as the communication entry or exit point for an application, API, or service. In simple terms, an endpoint is the destination to which a request is sent or from which a response is received.
    1. Expand the band by clicking it. Once expanded, you will see the Connector field. 
    2. It is a mandatory field. 
    3. Click on the drop-down and select the required database connector from the list.
    Notes
    Please note that all the following sections will be disabled unless the database is selected.


    Control

    The Control field defines how the SQL operation is executed and where the SQL statement is sourced from.
    1. Once expanded, the following fields will be shown:
      1. Processing Method - This determines how many records are processed per execution.
      2. SQL Source - Where the SQL query comes from.
    2. Both fields are mandatory. Please make sure you fill in all the details in all the fields for an error-free process.


    1. The Processing Method drop-down field is displayed.
    2. This field allows you to set the processing mode for the SQL query, either single- or batch-processing.
    3. If the single-processing method is selected, it executes the SQL statement once per message. 
    4. If the batch processing method is selected, it will execute the SQL statement for multiple records. It accepts a collection (array).
    5. Select an appropriate value from the drop-down: either single or batch processing.


    1. Now fill the SQL Source field. 
    2. This field allows you to set the SQL source. The SQL Source setting determines how the SQL statement is provided to the Database unit.
    3. The drop-down provides the following options:
      1. Fix defined SQL statements:
        1. In this mode, the SQL query is statically defined in the Database Unit configuration.
        2. You can write the SQL statement in the SQL section directly.
        3. The SQL structure does not change at runtime. Only parameter values change.
      2. SQL statement dynamically picked during runtime:
        1. In this mode, the SQL statement is determined during flow execution.
        2. Instead of writing SQL directly in the unit, you can build an expression that can be selected based on the conditions. You can use variables to build the expression.
    4. Select an appropriate option from the drop-down.
    5. Once configured, click on the Save button provided in the action area of the screen.

    SQL

    Notes
    Based on the option selected in the SQL Source in the Control section, the fields will be shown in the SQL field.
    The SQL section allows you to define the SQL statement that needs to be executed. Based on the selected SQL source, the section will display the fields.
    If the 'Fix defined SQL statements' option is selected:
    1. If the Fix defined SQL statements option is selected, the SQL section opens the SQL editor, and the following fields are shown.
    2. On top of the editor, a toolbar is provided to help you with the SQL editor.
    3. The editor allows you to write, drag, and drop variables or a message node from any message. 
    4. Create your SQL statement from scratch.
    5. Once created, click Save to save the statement.


    Delete SQL Statement
    1. You can delete any SQL statement using the delete option.
    2. To delete any SQL statement, click the Delete icon on the right.


    1. When you click the Delete icon, a confirmation pop-up will appear.
    2. Click Yes to delete the key.
    3. Click No to close the pop-up.
    4. Once the SQL statement is deleted, click on the Save button.



    Add Multiple SQL Statements
    1. You can add multiple SQL statements in the section.
    2. To add another key, click the (+) Add icon on the right. 
    3. Please note that you can add another SQL statement after successfully creating the first one. If any placeholder is present and it is empty, you cannot add an additional SQL statement unless you fill in the values in the placeholder.
    4. Once you have created the SQL, click the (+) Add icon on the right. 


    1. Clicking the (+) icon adds a new placeholder. 
    2. You can create the SQL statement and then add another SQL statement placeholder.
    3. The SQL will be saved, and a new placeholder will appear. You can create another SQL using the placeholder.


    1. If the SQL statement dynamically picked during runtime option is selected, the SQL Statements field will be shown.
    2. By default, the SQL Statements will support the fx function.
    3. You can drag and drop any nodeset from any message into the field using the Input and Output sections. Open any message, then drag the nodeset into the field.
    4. Please note that you can only drop one nodeset into the field. If you drop a new nodeset on top of an existing nodeset, the existing nodeset will be replaced by the new one.  You cannot drag and drop the child node into the field. Additionally, no manual input is supported in the field.
    5. Click Save to save the new SQL.  
    Please note that to fill the expression, you can drag and drop the nodeset from the Input section.


    Key Handling

    Key Handling refers to how unique identifiers (keys) are managed, validated, and used within a flow or integration process. A “key” is typically a value that uniquely identifies a record, object, or transaction. It ensures the correct record is identified, tracked, and updated throughout the flow.
    1. Expand the band by clicking it. Once expanded, the following fields will be displayed:
      1. ID
      2. Primary Key
      3. OneEnterprise Message
    2. All fields are mandatory.


    1. This ID field lets you assign a unique ID to each key. You can create multiple keys for key handling. The field provides both the Fx and A1 (text field) functions. This field is mandatory.
    2. By default, the field will open with the Fx function. You can change the field type using the Fx or A1 from the drop-down.
    3. If Fx is used:
      1. The fx icon indicates that this field accepts an expression or formula.
      2. You can create an expression by dragging a node or nodeset from the outbound messages into the field. Alternatively, you can write the expression manually, use nodes, or combine both approaches to build it.
      3. Please note that you can drag and drop any nodeset from the Output section only. Open the output message, then drag the nodeset into the field.
      4. To remove a node, press backspace. 
    4. If A1 is used:
      1. The A1 field lets you enter any alphanumeric key to create an ID. A maximum of 10 characters, 0-9, A–Z, and special characters are allowed in the field.
      2. This is a mandatory field.



    1. This Primary Key field allows you to create a valid expression using the variables, strings, and fields from the Output section. The primary key ensures that each record can be uniquely identified.
    2. This field supports only the Fx function and is mandatory. 
    3. The fx icon indicates that this field accepts an expression or formula.
    4. You can create an expression by dragging a node or nodeset from the outbound messages into the field. Alternatively, you can write the expression manually, use nodes, or combine both approaches to build it.
    5. Please note that you can drag and drop any nodeset from the Output section only. Open the output message, then drag the nodeset into the field.
    6. To remove a node, press backspace.
    Please note that to fill the expression, you can drag and drop the nodeset from the Output section.

    1. The OneEnterprise Message field is mandatory. 
    2. Click on the drop-down to view the list of available OE messages. Select an OE message from the drop-down.
    3. Once the message is selected, click on the Save button.


    Delete Key from Key Handling
    1. You can delete any key using the delete option.
    2. To delete any key, click the Delete icon on the right.
    Image

    1. Upon clicking the Delete icon, a confirmation pop-up will appear.
    2. Click Yes to delete the key.
    3. Click No to close the pop-up.
    4. Once the key is deleted, click on the Save button.
    Image


    Add Multiple Keys for Key Handling
    1. You can add multiple keys for key handling.
    2. Please note that you can add another key after successfully creating the first one. An empty placeholder will always be present. You cannot add an additional key unless you fill in the placeholder values.
    3. Fill the details in the placeholder, and click the (+) Add icon on the right. 

    1. The new key will be saved, and an empty placeholder will appear at the bottom.
    2. Repeat the process to add more keys.


    Extended Error Handling

    Extended Error Handling is an advanced error-management mechanism that enables a flow to detect, capture, process, and respond to errors in a controlled, structured manner. The key functionality of this field is that it does not stop execution; it provides detailed control over how errors are handled.
    1. Expand the band by clicking it. Once expanded, the following fields will be displayed:
      1. Condition
      2. Info
      3. Category
    2. All fields are mandatory.


    1. This Condition field lets you define the condition under which extended error handling applies. 
    2. This field supports only the Fx function and is mandatory. 
    3. The fx icon indicates that this field accepts an expression or formula.
    4. You can create an expression by dragging a node or nodeset from the outbound messages into the field. Alternatively, you can write the expression manually, use nodes, or combine both approaches to build it. 
    5. To remove a node, press backspace.
    6. Please note that you can drag and drop any nodeset from the Output section only. Open the output message, then drag the nodeset into the field.
    7. Create a valid expression.

    1. The Info field allows you to provide the information for the condition defined in the Condition field.
    2. The field supports both the Fx and A1 (text field) functions. This field is mandatory.
    3. By default, the field will open with the Fx function. You can change the field type using the Fx or A1 from the drop-down.
    4. If Fx is used:
      1. The fx icon indicates that this field accepts an expression or formula.
      2. You can create an expression by dragging a node or nodeset from the outbound messages into the field. Alternatively, you can write the expression manually, use nodes, or combine both approaches to build it.
      3. Please note that you can drag and drop any nodeset from the Output section only. Open the output message, then drag the nodeset into the field.
      4. To remove a node, press backspace.
    5. If A1 is used:
      1. The A1 field lets you enter information manually using the alphanumeric key. A maximum of 10 characters, 0-9, A–Z, and special characters are allowed in the field.
      2. This is a mandatory field.
    6. Create a valid expression.
    Please note that to fill the expression, you can drag and drop the nodeset from the Output section.


    1. The Category field is mandatory. 
    2. Click on the drop-down to view the list of available categories. Select an appropriate category from the drop-down.
    3. Once all the fields are filled, click on the Save button.


    Delete Category from Extended Error Handling
    1. You can delete any category using the delete option.
    2. To delete any key, click the Delete icon on the right.

    1. When you click the Delete icon, a confirmation pop-up will appear.
    2. Click Yes to delete the key.
    3. Click No to close the pop-up.
    4. Once the key is deleted, click on the Save button.



    Add Multiple Categories for Extended Error Handling
    1. You can add multiple Categories for Extended Error Handling.
    2. Please note that you can add another key after successfully creating the first one. An empty placeholder will always be present. You cannot add an additional key unless you fill in the placeholder values.
    3. Fill the details in the placeholder, and click the (+) Add icon on the right. 

    1. The new key will be saved, and an empty placeholder will appear at the bottom.
    2. Repeat the process to add more keys.


    Output Section

    The Output section displays the unit's final output message. The Output Message of the system call unit is the data generated after the unit completes execution. This final output of the unit is then passed to the next unit in the flow. The Output section provides the message in XML and JSON formats.

    Message Tab

    1. By default, the Message tab is displayed, and the message is shown in tree view mode.


    Find

    1. A Find option is also provided to find any node in the message.
    2. Enter the node name in the search field, and the result will be displayed instantly and highlighted.
    3. If more than one result is displayed, a navigation icon and a results counter are provided. You can navigate through the search results using the navigation icons.
    4. To close the search, click the 'x' icon. 


    Legends

    1. A legend icon is provided to help you understand the message. The color of the nodes indicates their status.
    2. Click the Legend icon to view the details. When you click the icon, the list will show the legend used in the message.


    Adjust Message Font Size

    1. A Font Size box is provided to increase or decrease the message's font size.
    2. The current font size will be shown in the box.
    3. Click on the box to increase or decrease the font size. 

    1. After clicking the Font Size box, a slider will appear below it.
    2. Use the slider to increase or decrease the font size. 
    3. As you slide, the change in size will be reflected in the message instantly.  
    4. The supported font size ranges from 8 to 72.


    Switch Between Code and Tree View

    1. By default, the message will be displayed in Tree View.
    2. Click on the Switch to Code View icon. The message will be displayed in the code view.
    3. To go back to the tree view, click Switch to Tree View icon.



      • Related Articles

      • Edit Component Flow

        Overview The flow editor feature in OneEnterprise enables you to visually modify and refine component flow through an intuitive interface. This functionality permits direct interaction with the flow structure of the component. The flow editor offers ...

      • Database Unit

        Overview A Database Unit in a flow diagram interacts with a database as part of the workflow. It allows the process to perform structured operations such as reading, writing, updating, or deleting data. What it does: Connects to a database system ...

      • Edit Database Unit

        Edit Database Unit

      • Edit Documents Unit (Store Operation)

        Overview A Documents Unit in a flow diagram handles document-related operations within a workflow. It’s commonly used to store or retrieve document-style records such as JSON or XML documents. What it does: Manages document objects in the workflow. ...

      • Edit Subscription Trigger Unit

        Overview Trigger Units are responsible for starting the execution of a flow. They define how and when a flow is triggered. A flow always begins with a Start Unit, and immediately after that comes a Trigger Unit. The following trigger units are ...