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, usernames and password hashes (password hashes are only relevant if you use the less secure Stored Credentials option) replaced by the scrubber with more generic strings (tokens).  This is to avoid emailing files that contain the actual values as they 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

...

All files must be in the project file hierarchy. If you want to add a file from outside the project, copy it to the file hierarchy. Place it in the root <ProjectName> directory, or in the <ProjectName>/Log subdirectory, or other subdirectory.  

...

  • If you were running an operation in the Datical desktop client/Eclipse GUI and got an error, that error would be logged in the daticaldb.log file in your Datical installation directory (such as "DaticalDB" or "DaticalDB_6.12").  In that scenario you would need to copy the log file from your installation directory to your project directory structure prior to running the hammer debug export "scrubber" command. 
  • If you use automation software like Jenkins to run packager or deploys, Datical Support may ask you for the packager.log or daticaldb.log from the automation job. You must copy them into your local project directory before running the hammer debug export command.  To avoid needing to do this, you can add a step near the end of your automation jobs to run the hammer debug export command so the zip of scrubbed files will automatically be created for each job.

Other command options

All of the hammer debug export command options are shown here: CLI Commands#debugexport

...

  • Standard for Problem Diagnosis - provide the standard files most commonly used for troubleshooting
  • Default - if no command options are specified, the command will copy all of the files in the project directory into the debug zip file
  • 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. 

...

Standard for Problem Diagnosis

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

  • datical.project - definition of the project
  • changelog.xml - 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
  • 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.

Example of Default

Code Block
hammer debug export

Exclude DML

Scrub and include almost all of the files from the project directory structure, except html reports and DML files in the Resources folders.  (Note that this example is from a single schema project.  The Resources paths may be different for multi-schema projects.)

Example of Excluding DML

Code Block
hammer debug export --exclude=*.html,Resources/sql,Resources/sql_scripts

...