Creating an Advanced Database Layout using Layout Builder

Layout Builder feature helps you to upload a sample or an original source (JSON downloaded from Adv. Database layout manage page) file to define the layout. By default, this feature remains disabled in the product. You need to enable this feature before you start working on this.

Steps to create Advanced Database Layout:

Click Configure > LAYOUTS > Advanced Database.
Click Create Advanced Database Layout.
On the Create Layout screen, select the Layout Builder option from the drop-down list of Select Layout UI Type field.
Click Next. The Create New Advanced Database screen is displayed.
1. Type the name and description of the new layout activity in the Name and Description text boxes.
  
  Name: Only alphanumeric and underscore are allowed and you must start the layout name with an alphabet or underscore.
  Description: Only alphanumeric and few special characters (_ - . : , @ $ ? \\ and space) are allowed and you must start the description with an Alphabet/Underscore/Number.
2. Select the definition mode for the Advanced Database Layout. You can define the layout in the following ways:
  - Import Definition file
  - Use Database Table
    
    Using Import Definition File
    1. Select Import Definition File.
    2. Select the type of file from the Definition File drop down list. The available option is JSON.
    3. Browse and upload the data file in Upload Data File field.
    4. Select the project from the Project drop-down list.
    5. Click Continue.
    Using Use Database Table
    1. Select Use Database Table.
    2. Select the database info activity from the Database Info drop-down list.
    3. Select the project from the Project drop-down list.
    4. Click Continue.
    5. On the Record Definition page, select the Database Schema from the drop-down list to create the first record.
      
      When you select the Database Schema, all the database tables associated with the selected schema are populated in the drop-down list of the Database Table field.
    6. Select the required Database Table from the drop-down list. Based on the selected Database Table, column details will be displayed.
    7. In the column details, select the column(s) that you want to include in Select Query by selecting the checkbox.
      
      You can also select the Primary Key checkbox to include column(s) in Select Query.
      
      You can also enter the Query in the Query Editor manually.
      Based on the selected column(s), Select Query will be displayed in the Query Editor. You can edit the query and add the where clause with dynamic parameters as shown in the below screenshot.
      Placeholders will be shown for all the added dynamic parameters, where you can enter the values of placeholders which is used to generate the XSD for this schema.
    8. Click Save to add this record on main view.
      The Record Definition page displays the details of created records and Records Hierarchy.
      Screenshot
      On Record Definition window, you can click to edit and click to remove record.
      On Records Hierarchy window, You can click to add root table.
      
      Records Hierarchy displays selected Database table name. You can hover over the table name and click to add a child table and click to view the data in the table.
In the Definition panel,

Select the Project from the drop-down list of Project.
Expand the Advanced Properties to view the advanced properties of the layout.
Define the Character-set encoding for your Database layout in the Character Set Encoding field. For example UTF-8.
Select the Schema Version checkbox.
Select the Filter Invalid XML Characters checkbox to filter out invalid XML characters (if any) in the input data

In case, the input data contains some characters that are invalid in XML, then this may result in the mapping getting aborted.
Select the Query Batch Update checkbox to enable the query batch update, and enter the batch size in the Query Batch Size field.

Enabling the Query Batch Update checkbox leads to database updation in batches as per the positive value set in the Query Batch Size field.
For example, setting a value '10' in the Query Batch Size field will group 10 separate statements and submit them as a single batch. However setting the value to '0' will disable the batch execution and execution of every statement will occur simultaneously.

You can achieve performance optimization by using batch update. The advantage of batch update is to reduce the network calls to the database by not executing every single SQL query when they are raised. By using this feature, you can send multiple queries to the database in a single instant and thereby reducing the number of JDBC calls and improving performance.

This feature is available for the Insert and Update operation only.
Select the Use Commit Count checkbox to enable the Commit Count field, and enter the number of statements that you want to commit to the database in a single instance in a field.

When you set the commit count value to a positive integer value then the layout starts and commits a batch of transaction as per the number in the Commit Count text box. This helps in reducing the network traffic and in turn increases network performance. This is called as batch transaction.
Select the Handle Null/Empty Element(s) checkbox to handle Null or Empty elements.

Only one of the options between Handle Null/Empty Element(s) and Update Empty Tag should be checked true. Checking both of these true will abort the process flow.

Click Save Layout to save Advanced Database Layout.