Configuring a database inbound protocol

In the Java Driver and Database protocols, one process only supports one Java or database protocol. They cannot be in the same process. In the Java Driver, you can also run multiple instances in a single process.

Table Schema lists all selected visible table schemas under the selected connection. Selecting a different Database Connection clears the Table Schema field.

Note: 
  • This option can be left blank. Table schema is not limited to one of the table schemas in the dialog box. You can insert/delete/update any tables in the database. All database tables are supported for the insert/delete/update statement on the Inbound SQL Statement Configurator dialog box.
  • If a database connection from the master/current site has no visible schema, then it is not shown on the Database Connection menu.
  • When using escape characters, the defined escape characters should not display in the message as normal content. If the characters have real meaning in the message, then you can define other characters as escape characters. The engine can handle them as normal content.
  1. Select a Database Connection. This is required. This lists all configured visible connections under the current site and master site. Master site connections are shown in italic.
  2. (Optional) Click the Table Schema button to open the Select Table Schema dialog box.
    1. Click Add to open a list of available table schemas. Multiple selections are permitted.
    2. Click OK to populate the Table Schema field with the selections.
  3. The Action tabs are used to configure the action of the database inbound protocol. Select SQL Statement or Stored Procedure. These are used to identify the action type. The Content field shows the action content.
    Selecting SQL Statement updates Content with the previous SQL statement content. Clicking Configure opens the Inbound SQL Statement Configurator dialog box, from which you configure the SQL statement. By default, SQL Statement is selected.

    See SQL configuration.

    Selecting Stored Procedure is used mainly for selecting data with complex query conditions and deleting rows after reading. This updates Content with the previous stored procedure content. Click Configure to open the Stored Procedure Configurator dialog box, from which you configure the statement that calls the stored procedure.

    See Stored procedure configuration.

    For the Read Success Action and Read Failure Action tabs, you select SQL Statement or Stored Procedure. These two actions are optional for inbound configuration.
    The Read Success Action tab defines the post action for read success.
    The Read Failure Action tab defines the post action for read failure.
  4. In the Scope pane, select Each row as a message or Each read as a message .
    Each row as a message identifies each row in the query result as a message. This is the default.
    Each read as a message identifies all entries in the query result as one message.
  5. In the Max Row per Read pane, select the maximum row number of query results or Unlimited.
    Unlimited means the query result involves all data rows.
    Or, you can set the maximum row number of query results by selecting several rows to be read. The default value is 1. This reads one row at a time. Selecting any other number reads that number of rows.
    If you specify an uncertified DBMS that does not support the max row setting, then Max Row Per Read must be set to Unlimited.
  6. Specify a Scan Interval . This is used to define a fixed timing interval in which to scan the database to retrieve data for each interval. This value is an integer greater than zero that represents seconds. The default value is 30.
    The Scheduling pane is used to define the timing interval at which the current thread scans the database. Scanning the database means that the thread runs the query statement of read action to query data from the database. The database is scanned based on the defined timing interval. In each scan, the queried row count is defined by the Max Row per Read setting.
  7. If required, then select Use advanced scheduling.
    Selecting this enables Setup and Connect as needed and disables Scan Interval. This means the current thread follows advanced scheduling to scan the database. By default, Use advanced scheduling is cleared.

    Clicking Setup opens the Scheduling dialog box.

  8. Select Connect as needed for the current thread to create a temporary connection to run the database scan when the advanced scheduling time is up. Otherwise, the current thread creates a persistent connection.
    If Use advanced scheduling is selected, then by default Connect as needed is also selected.
    Clearing Use advanced scheduling disables Setup and Connect as needed and enables Scan Interval. In this case, the current thread always creates a persistence connection to run the database scan.