Versions Compared

Old Version 17

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • <host> - the URL for the web server on which you deployed database.war.
  • <port> - port where the container is listening for http requests. This defaults to 8082 if the database connector was deployed in the  tomcat bundle or port 8081 if you are running the Database Connector in Standalone mode.
  • <queryset name> - queryset name defined in the database connector configuration file.
  • <query name> – query name  defined in the database connector configuration file.

Logfiles

Logfiles11:37:25.394 |-WARN

database connector logging output is very helpful for troubleshooting database SQL issues. This example shows the log entry generated when browsing with an incorrect query name.

Excerpt

The Database Connector uses SLF4J with logback, which is the same logging infrastructure used in  .

Log MDC entries for configuration path, the querySet name, the query name, correlation.id, tenant id, subject.id. These will be captured when processing client requests.

Code Block
Code Block
2017-10-26 10:31:35.359 ERROR   12048 --- [http-nio-8082-exec-85] [c.f.cconnectors.d.s.MetaDataService] [mycompany ] [26d27ffe-1213-4c82-890b-cdc1a2e00e87 ] [  ] - Could not find retrieve operation for query STUDENT/addStudent. Skipping ...
11:37:27.186 |-ERRORdatabase.QueryResource    : Query BIRT/allcustomers not found
2017-10-26 10:31:35.372  INFO   12048 --- [http-nio-8082-exec-85] [org.restlet.Component (1199403432)     c.f.c.d.QueryResource] [mycompany ]: [26d27ffe2017-1213-4c82-890b-cdc1a2e00e87 ] [  ] - Error processing request for querySet STUDENT
It is very often useful to know the database and database driver name and version that is being used.  This information can be found in the logfile. An example is shown below:
10-26    10:31:35    0:0:0:0:0:0:0:1    -    0:0:0:0:0:0:0:1    8082    GET    /database/BIRT/allcustomers    -

The database connector logs version information for each datasource definition as it makes initial contact with your database(s).

Code Block
2017-09-15 15:50:01.554  INFO   28614 --- [ost-startStop-1] c.f.c.d.service.ConfigurationService     : DriverName: Microsoft JDBC Driver 6.3 for SQL Server
2017-09-15 15:50:01.554  INFO   28614 --- [ost-startStop-1] c.f.c.d.service.ConfigurationService     : DriverVersion: 6.3.1.0
2017-09-15 15:50:01.554  INFO   28614 --- [ost-startStop-1] c.f.c.d.service.ConfigurationService     : DriverMajorVersion: 6
2017-09-15 15:50:01.554  INFO   28614 --- [ost-startStop-1] c.f.c.d.service.ConfigurationService     : DriverMinorVersion: 3
2017-09-15 15:50:01.554  INFO   28614 --- [ost-startStop-1] c.f.c.d.service.ConfigurationService     : DatabaseProductName: Microsoft SQL Server
2017-09-15 15:50:01.554  INFO   28614 --- [ost-startStop-1] c.f.c.d.service.ConfigurationService     : DatabaseProductVersion: 14.00.900
2017-09-15 15:50:01.554  INFO   28614 --- [ost-startStop-1] c.f.c.d.service.ConfigurationService     : DatabaseMajorVersion: 14
2017-09-15 15:50:01.554  INFO   28614 --- [ost-startStop-1] c.f.c.d.service.ConfigurationService     : DatabaseMinorVersion: 0

Exceptions are properly logged with their stacktraces. This makes it easier to diagnose errors, which sometimes are frevvo/DBConnector specific and sometimes database specific.

All JDBC statements are logged in the DEBUG logging level. This includes the To log the actual SQL statement used, the actual arguments, the number or rows returned and whether it was successfulsuccess status, set logging level to INFO.

There are different logfiles for the Standalone and tomcat bundle installations.

Standalone mode

Three logfiles are created in the

There are four logfiles in <db-home>\database\database-connector-2.5.

3

x\logs

directory:

  1. DbConnector.err.log - there is no content in this log at this timecurrently empty.
  2. DbConnector.out.log - logs the database connector standard out file. You can see the version of the database connector that is running in this file.
  3. DbConnector.wrapper.log - Date/Times of connector starts/stops when the Database Connector empty unless the database connector is running as a serviceservers. Logs starts/stops date/time.

  4. database-connector.YYYY-MM-DD.log - This is the main logfile for the Database Connector. You can see the results of the queryset/queries validation and output error messages in this fileall output.

Turning on DEBUG level logging
in Standalone Mode:Log levels are controlled by the logging.level.com.frevvo.connectors.database property. Add this property to
  1. Stop the Standalone database connector.
  2. Edit the <db-home>\database-connector-2.5.3\config\dbconnector.properties file.
Restart

  2. Add the

connector

  1. following line.

Create the Database Connector log in JSON format
The spring.profiles.include=logging-json property creates the logfile in JSON format. Add this property to the <db-home>\database-connector-2.5.3\config\dbconnector.properties file.
  1. Code Block
     logging.level.com.frevvo.connectors.database=DEBUG
  2. Restart the connector.

Tomcat bundle

When debugging database queries refer to output error messages in The database connector writes all output to a single logfile <frevvo-home>\tomcat\logs\database-connector.YYYY-MM-DD.log

Turning on DEBUG level logging

Log levels are controlled by the logging.level.com.frevvo.connectors.database property.

To change the log level to DEBUG when using the tomcat bundle, follow these steps:

  1. Stop if it is running.
  2. Navigate to Stop . You do not have to stop the Insight Server.
  3. Edit the <frevvo-home>\tomcat\conf directoryCreate/Edit the \frevvo-config.properties file.

  4. Add the logging.level.com.frevvo.connectors.database property with a value of DEBUG as shownfollowing line.

    Code Block
     logging.level.com.frevvo.connectors.database=DEBUG
  5. Save the file
  6. Restart
Create

Switch the Database Connector log in JSON format

If you want to create the connector logs in Logging output defaults to text format. To switch to JSON format, add the spring.profiles.include=logging-json thisproperty to the frevvo-config.properties file and restart . This will create JSON logfiles for all of the frevvo spring boot based connectors - Database, Box, Filesystem, Google and SharePoint. Support for the frevvo.log file will be added in a future release.

Code Blocktitlefrevvo-config.properties - This property will create logs in JSON format for all connector logs

-tomcat bundle or to dbconnector.properties file for the standalone bundle.

Code Block
spring.profiles.include=logging-json 

Image Removed

Common Problems

Doc Post Failure

If the a submission doesn't reach the Database Connector or when certain database operations fail,  will

  • Flag the submission with an error in the Submissions Table
  • Send Doc Post Failure notification email(s) reporting information about the error to all tenant administrators or flow admins (if configured)

...

 Example 1:

The email reports a Connection refused error - To resolve, verify the URL to your database connector is correct in business rules or Doc URI's

Example 2:

All DBC SQL operations are performed within a database transaction. When the following SQL errors occur, flags the submission with an error and generates Doc Action Failure emails to the tenant/flow admin(s) :

  • An update statement updates ) rows and autocreate is false
  • A query with autocreate=true is missing a create statement
  • A query when autodelete is true and is missing the delete statement
  • A query with the Delete statement and the delete Key is not defined
  • A delete statement where the specified delete key cannot be found in the retrieved resultset
  • If any one of the SQL operations (except Update) fails
    •  For example: When calling a querySet with 1 or more autocreate or autodelete=true, internally the DBC is likely to execute multiple SQL statements:
      • It will try to delete all rows that were deleted from the form resultSet that were originally in the resultSet retrieved from the database.
      • It will try to update rows from the form resultSet - and if autocreate is true and the update fails, it will execute an insert for each update failure. 
  • Browsing the URL to generate the schema for querysets

Updates do not trigger errors due to several valid use cases for update failures ex: autocreate=true

Image Added

Log entries for the error are captured in the database-connector.YYYY-MM-DD.log

Code Block
2017-10-26 13:46:05.828 ERROR mycompany 93f95ebc-6a85-4426-a015-eb34a1c96042 17048 --- [http-nio-8082-exec-8] c.f.connectors.database.QueryResource    : Create operation not defined for query BIRT/createOrder
2017-10-26 13:46:05.829  INFO mycompany 93f95ebc-6a85-4426-a015-eb34a1c96042 17048 --- [http-nio-8082-exec-8] org.restlet.Component (2011499821)       : 2017-10-26    13:46:05    127.0.0.1    -    127.0.0.1    8082    POST    /database/BIRT/createOrder    -    404    328    535    6    http://localhost:8082    Jakarta Commons-HttpClient/3.1    -

Live Forms tomcat running on non-default port

...

Check the reported path. Verify that the configuration.xml is present in the same directory as the database.war file or in the C:\database\database-connector-2.5.2x\config directory for a Standalone installation. If you are running the connector in the tomcat bundle, verify that the value of the  "frevvo.connectors.database.configuration parameter in the <frevvo-home>\tomcat\conf\dbconnectorfrevvo-config.properties file reflects the correct location of the configuration.xml. An example of this property is shown below:

Code Block
<Parameter name="frevvo.connectors.database.configuration" value="c:\<frevvo-home>\frevvo\dbconfig\configuration.xml" override="false"/>=file:///C:/<path to configuration.xml>

The format of your test query URL is invalid

...