Workflow for Addressing Database Integrity - Intergraph Smart 3D - Administration

Intergraph Smart 3D Database Integrity Administration

Language
English
Product
Intergraph Smart 3D
Subproduct
Database Integrity
Search by Category
Administration & Configuration
Smart 3D Version
11 (2016)

The workflow to address database integrity has three overall steps:

  1. Check the database integrity.

  2. Run reports to review the errors.

  3. Clean the database to correct the errors.

Checking Database Integrity

The Database > Integrity command, which is available in Project Management, runs directly on a database (Site, Catalog, Model, or Reports) and creates records for the objects that need to be cleaned.

The Site and Catalog databases cannot have Database Integrity run on them if you run the command from a satellite location within a Global Workshare Configuration.

The databases available for checking vary depending on what you select before clicking this command. After a database has been scanned for errors, you can generate a report to review the errors that the Database > Integrity command generated (see Running Database Integrity Reports below).

You can run the Database > Integrity command in Project Management, or as a custom command in Project Management or the host. The ProgID for the custom command is SP3DCheckDatabaseIntegrity.CCheckObj.

Using the Command Line to Check Database Integrity (DBI)

You can use the command line to check database integrity outside Smart 3D. When DBI is executed in Project Management, a text file called DbIntegrityCommandLine-<PlantName>.txt is generated in local temp folder with a command string reflecting all selections and options used. This method is especially helpful for scheduling this command to execute periodically without user interaction. You can also update diagnostics reports using the Drawing Batch Server based on this DBI schedule.

Running Database Integrity Reports

The software includes report templates intended for diagnosing database integrity issues. You can run these templates by opening a session in the software and clicking the Run Report command on the Tools menu. The report templates are located in the Diagnostic folder on the Catalog Reports tab of the Run Report dialog box. The Diagnostic Clean Database Issues template lists errors, with each error occupying two rows in the report. Other Diagnostic Clean Database Issues templates group the errors by problem description or status. There is also a template that allows you to easily sort the errors using Excel's filtering capability on columns. The reports include the following information for the errors:

  • DataStore - Displays whether the problem exists in the model or catalog.

  • Problem Description - Provides a brief description of the error. Click the Search tab in the Database Integrity Help and type the problem description to find more information about the error, including how to fix it.

  • Status - Displays the current status of the object: New, Existing, Resolved No Longer Existing, or Resolved Fixed. If the status is New, the error has been introduced recently due to operations in the software. If the status is Existing, the error has been present for some time. If the status is Resolved No Longer Existing or Resolved Fixed, the object had an error, and the problem was corrected.

  • Severity - Displays the severity of the error: Fatal, Crucial, High, or Normal. The severity is a quick way to evaluate how important the problem is. Usually, a Normal severity has no impact, and a Fatal severity is a very serious problem.

  • Action to Take - Describes what to do to fix the problem. The actions include To Be Removed, To Be Repaired, and To Be Checked By DBChecker. If the action is To Be Checked By DBChecker, you should run the Database > Integrity command again. For the To Be Removed and To Be Repaired actions, see the following section.

Cleaning Errors

If the action on the report is To Be Removed or To Be Repaired, run the Clean Database custom command to delete or clean the object. For more information about deleting and cleaning objects, see Clean a Database.

The Site and Catalog Database cannot be cleaned from a satellite location within a Global Workshare Configuration.

When a database integrity error is logged against an object, the software specifies an ActionOID that denotes the object on which a possible correction will be performed. The Clean Database command performs its cleaning action on this object referred to by the ActionOID. This object may be the object in error, or it may be a related object.

An example is when a weld is in error, but the update to correct the problem needs to be done on the related connection.

After you fix a problem, be sure to check that it is solved and that no new problems have been created. Re-run the Database > Integrity command and the DB Integrity reports, and then check the results.

Working in an Integrated Environment

When working in an integrated environment, database integrity issues can arise that require you to remove the design basis and register to another SmartPlant Foundation database. The Remove Design Basis custom command removes all correlation relationships and deletes all design basis objects in the 3D model.

Then, you can register the model, retrieve information, and re-correlate objects. For more information, see the Troubleshooting section in the Integration Guide.

See Also

Database Integrity Custom Commands