Versions Compared

Key

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

Table of Contents

...

For Datical DB versions 5.9 and higher, you can use the hammer debug export command to "scrub" sensitive information such as hosts, ports, and credentials from your files before sending them to Datical Support.  The hammer debug export command will create a new zip file in your <ProjectName>/Reports/debug directory that contains the files you specify to include. The files in the zip will have the actual values for hosts, ports, and credentials replaced with more generic strings (tokens).  This is to avoid emailing files that contain the actual values which may be sensitive information.

The hammer debug export command provides a simple way to archive the needed files into a zip file that you then send to Datical Support:

  • You can specify which files to include in the zip. 
  • The command must be run from the command line (not from the Datical desktop client/GUI)
  • The "scrubber" will only handle files that are located somewhere within your <ProjectName> directory structure for that project.  If there are relevant files located outside of the project's directory structure (for example the daticaldb.log file for operations performed in the Datical desktop client/Eclipse GUI), you can copy that log into the project directory structure prior to running the hammer debug export command.
  • You can add a new step near the end of your automation jobs so that the hammer debug export command creates the zip of "scrubbed" files automatically for each job.

Command: hammer debug export

...

Datical has found patterns in customer needs, customer security policies, and requirements for files to fully diagnose a problem.  Here are four example scenarios. 

  • Minimum Standard for Problem Diagnosis - provide the minimum number of files to start diagnosis.standard files most commonly used for troubleshooting
  • Default - provide all data if no command options are specified, the command will copy all of the files in the project directory into the debug zip file
  • Exclude All SQL Files - provide all files except SQL files. Security policy may determine whether you are allowed to share SQL files outside of your company.  
  • Exclude DML Files - provide all files except DML files. Security policy may determine whether you are allowed to share DML files. DML files may contain sensitive information about people and accounts. 

Scenarios

...

Standard for Problem Diagnosis

Scrub and provide the minimum information required for Datical Support to start diagnosing a problem. 

  • datical.project - definition of the project
  • changelog.xml - all changesets (changes applied to the database)the changelog lists all of the change sets 
  • daticaldb.log - main Datical DB log (use an asterisk where a date may be within the filename, daticaldb*.log
  • packager.log - log from running the Deployment Packager, which refactors SQL files into changesets and deploys them to the REF database

...

  • html reports - forecastReport.html, deployReport.html, packagerReport.html (use an asterisk to wildcard all html reports, *.html)

Example of Standard

Code Block
hammer debug export --include=datical.project,changelog.xml,daticaldb*.log,packager.log,*.html

Default (no command options specified)

Include and scrub all files in the project directory.

...