ClearDB Documenter - Highlights

ClearDB Documenter is a unique Oracle Database documenter generating complete and detailed documentation of Oracle Databases. It documents 59 database object types, their status and dependencies, the structure and source code modules. The visualization of the database includes Entity Relationship (ER) and Reference & Dependency (R&D) diagrams, Flowcharts, Call Tree diagrams, and CRUD matrices of PL/SQL code – all interactive and "clickable".
ClearDB Documenter performs a comprehensive and detailed Database Security Audit of the Oracle database. An interactive report summarizes violated checks and provides detailed descriptions of vulnerabilities, their severity, and places where they were located. 29 built-in policies including over 630 security checks ensure your database is thoroughly examined and security issues are detected.

Key Features

Document an Oracle Database

ClearDB Documenter documents 59 schema (tables, views, procedures, functions, packages, types, triggers, etc.) and non-schema (contexts, directories, profiles, users, roles, etc.) object types with their properties, DDL, privileges, synonyms, references, dependencies, source code as well as database instance properties, options, and initialization parameters for Oracle versions up to 12c. A documented Oracle database is represented as a Docu (database documentation) – an interactive and portable HTML documentation that can be viewed using popular web browsers.

What is documented ?
A complete set of 59 Oracle Database object types (schema and non-schema) with all their properties, DDL, privileges, synonyms, references, dependencies, source code as well as database instance properties, options, and initialization parameters for Oracle version up to 12c.

View a Docu – Oracle Database Documentation

ClearDB Documenter generates Oracle Database documentation – aka Docu – as interactive, clickable and portable HTML documentation that can be viewed using popular web browsers. For full support of all Docu features, e.g. Docu protection, the docuVIEWER is available. docuVIEWER is available as a FREE download. It is designed to allow a viewer to simultaneously open and view numerous documents generated by ClearDB Documenter. Docus frequently contain sensitive and confidential data. docuVIEWER was also introduced to provide a high level of security and access control for this kind of information. Protecting a complete Docu is optional. A Database Security Audit Report, however, will be protected by default.

Open a Sample Docu online – click here… or Download FREE standalone docuVIEWER including two Sample Docusclick here

Detect database security issues

The integrated Database Security Audit detects database vulnerabilities, captures the deficiencies in security measures and processes, and identifies shortcomings in their implementation. ClearDB Documenter performs a comprehensive and detailed Database Security Audit of the Oracle database. It checks over 630 potential security risks and generates an interactive report summarizing all violated checks. The output is grouped into POLICIES and CHECKS and provides detailed information about observed issues. The report can be filtered and sorted, e.g. by 4 SEVERITY categories.

Analyze PL/SQL code

ClearDB Documenter is powered by a PL/SQL Code Analyzer that reviews, measures, and checks the quality of Oracle PL/SQL code used in stored objects. In addition, each stored object is analyzed for its structure and architecture. A set of industry standard code metrics (McCabe, Halstead, Maintainability Index) is applied to assess code quality, complexity, and modularity. Error-prone areas are identified and recommendations for a better coding style are provided.
The code review module identifies common coding mistakes and makes suggestions for best coding practice. Using ClearSQL's engine a detailed database observation report is included in a Docu as well. It includes PL/SQL Parser and Database errors and anomalies, alerts, and warnings.

Visualize "GPS" Oracle Databases

ClearDB Documenter automatically captures an entire Oracle database in an interactive map documenting 59 database object types. It visualizes relationships, dependencies, data flows, and highlights observations e.g. database anomalies, invalid objects and errors via R&D (references and dependencies), ER (entity-relationship) diagrams, Flowcharts and Call Tree diagrams, CRUD matrices. ClearDB Documenter also generates a PL/SQL code review report – down to the individual line of code. Oracle developers, DBAs, and consultants use the “clickable” documentation to quickly gain understanding and explore an Oracle database – structure, database objects, code, and anomalies – offline – using standard browsers.

Document Legacy PL/SQL code

Maintaining legacy applications, documenting old and unfamiliar code, analyzing scripts somebody else wrote is a difficult and time-consuming task. ClearDB Documenter automatically generates detailed documentation of legacy PL/SQL, i.e. old code that is badly documented or not documented at all. The documentation is available as “clickable” interactive HTML including numerous illustrations (diagrams) and can be viewed using standard web browsers. Likewise ClearDB Documenter helps to document newly generated code with little effort.

DB Documentation "Docu" includes…
  • code analysis and rule violation report, parser errors, alerts and warnings
  • code quality control metrics e.g. Cyclomatic Complexity, Maintainability Index, Halstead Volume, etc.
  • visualized code by Flowcharts and Call Tree diagrams, and CRUD matrices
  • reports of the compliance status of your enterprise wide coding standards

Compare Docu vs. Docu or Database

Databases are continuously worked at. New code is written, objects created, stored programs changed, new references and dependencies defined. Keeping track of the changes is an important yet challenging task. ClearDB Documenter compares two Docus or a Docu with its source (or any other) Oracle Database generating a detailed Docu Comparison Report. The comparison report spells out the differences between Source 1 and Source 2: Database Properties, Database Objects, and Database Security, highlighting detected similarities and discrepancies in distinctive colors (fully customizable). If required both detailed Docus of Source 1 and Source 2 can be included in the comparison report as well. Filter the Comparison Tree and the content itself to see only differences of the compared Sources.

Automate Docu generation (Job and Template)

ClearDB Documenter automates the Docu generation via its integrated scheduler. Create jobs for complex, time-consuming, and long-lasting Docu generation, and schedule their execution during non-working hours. Each Docu generation job is widely customizable in terms of generation, documentation, and Code Analyzer options. Create and use templates to generate tailor-made output documents with a single click. To avoid repetitive setup of Docu content and generation options, save defined settings to a file and load it each time you need to document a database, run comparison (Docu vs. Docu/DB), extract DDL, actualize Docu content, etc.

Gain tangible Business Benefits

The cost of code maintenance has grown to become the largest budget item in many software development organizations. ClearDB Documenter is a unique tool that addresses important root causes of the issue.

The tool provides insight, transparency, and knowledge into areas that are frequently obscured or entirely unknown. The invaluable output of ClearDB Documenter returns the control to the individuals in charge.

  • The cost of DB programming and maintenance is significantly reduced while the stability of the DB environment increases.
  • The investment into grown DB applications is protected by the software generated documentation and illustration of legacy PL/SQL.
  • Useful lives of programs are extended, novel insights enable innovation and progress.

… and Get immediate ROI

At the same moment ClearDB Documenter is used, it returns a multiple value of its cost. And the savings and benefits continue day by day. Legacy code is automatically documented and illustrated at a few clicks saving man-weeks of labor that cannot produce similar quality output. Continuous code improvement and database documentation reduce the cost of maintenance permanently.

Assuming new database responsibilities or projects, the learning curve to get up-to-speed is reduced to a fraction saving internal and external cost. Database project control and documentation are automated, saving many days of labor. The effectiveness of database security measures is tested automatically during live operation. Security leaks and issues are automatically reported at no extra effort preventing potential embarrassment, loss of reputation, and financial damages.

Back To Top