Command Line Control

Use Insight’s command line control to run Data Manager tools outside of the graphical user interface. Commands can be scripted or scheduled to to automate data management tasks for your Insight projects.

  • Backup
  • Compact
  • Repair
  • Report

Note: Use quotes around project names containing spaces.

Note: Use consistent parameters across tools where possible, e.g. project=/path/to/project or project=d:\path\to\project

Running Commands

Windows:

  1. Open a shell window
    • Start button, type “command” and choose Command Prompt, OR;
    • Press the Windows + R button and type CMD in the text box. Click OK.
  2. Navigate to the installation folder, e.g.
    • cd C:\Program Files\DUG Technology\DUG Insight <version number>
  3. The program to run is:
    • _projectmgr.bat

Mac:

  1. Open a terminalwindow
    • Spotlight search (Click the magnifying glass at the top of the screen)
    • Type “terminal”
    • Hit enter
  2. Navigate to the installation folder
    • cd “/Applications/DUG Insight.app/Contents/MacOS”
  3. The program to run is:
    • _projectmgr

Linux:

  1. Open a terminal window
    • Click the Application > System Tools menu and select Terminal.
  2. Navigate to the installation folder
  3. The program to run is:
    • _projectmgr

Command Line Tools

Command line tools are available using the _projectmgr.bat (Windows) or _projectmgr (macOS, Linux).

Run commands using the following syntax:

_projectmgr.bat <operation> <options>

Example:

_projectmgr.bat backup project=/shared/demoProject destination=/shared/backups/demoProject name=weekly copyHorizons=1 copyImages=1 copyVolumes=0

Getting Help

Use the “help” keyword for more information.

  • _projectmgr.bat help: list available commands (e.g. backup, compact, repair)
  • _projectmgr.bat <operation> help: list parameters for just the <<operation>>

Example:

List parameters for the backup operation:  

  • (win) _projectmgr.bat backup help
  • (macOS, linux)  _projectmgr backup help

Backup

Create a backup of the project database.

Syntax:

_projectmgr.bat backup project=”project path” destination=”backup location” name=”backup folder name” <optional parameters>

Parameters:

  • Project= path of source project
  • Destination= path to write backup
  • name= Name of folder to create and/or store backup (default=date as YYYYMMDDHHmmSS)

Optional parameters:

  • copyHorizons: true/false (default=true)
    • Include horizons in the backup
  • copyImages:true/false (default=true)
    • Include culture images in the backup
  • copyVolumes: true/false (default=true)
    • Include dugio volumes in the backup
  • maximumCopySize:maximum size (in MB)
    • Only backup volumes smaller than this size when copying volumes
    • If no value is set, all dugio volumes are backed up when copyVolumes is true.

Example:

Create a backup of a project including horizons and culture, but excluding dugio volumes.

(win) _projectmgr.bat backup project=/shared/demoProject destination=/shared/backups/demoProject name=weekly copyHorizons=1 copyImages=1 copyVolumes=0

(macOS, linux) _projectmgr backup project=/shared/demoProject destination=/shared/backups/demoProject name=weekly copyHorizons=1 copyImages=1 copyVolumes=0

Compact

Use the Compact tool to perform maintenance on a project database, removing empty, partial or unnecessary pages and optionally clearing the "undo" history of wells and horizons.

Syntax:

_projectmgr.bat compact project=”project path” <optional parameters>

Parameters:

  • Project= ”path of project to compact”

Optional parameters:

  • clearHistoryProject= true/false (default=true)
    • Remove undo history for wells
  • compactHorizons= true/false (default=true)
    • Compact horizon databases
  • clearHistoryHorizons= true/false(default=false)
    • Remove undo history for horizons

Example:

Compact a project database, but maintain undo history for wells.

(win) _projectmgr.bat compact project=/shared/demoProject clearHistoryProject=false

(macOS, linux) _projectmgr.bat compact project=/shared/demoProject clearHistoryProject=false

Repair

Use the Repair operation to safely fix issues with the project database and restore access to the project.

Syntax:

_projectmgr.bat repair project=”project path”

Parameter:

  • Project: ”path of project to repair”

Example:

Repair a project.

(win) _projectmgr.bat repair project=/shared/demoProject

(macOS, linux) _projectmgr repair project=/shared/demoProject

Report

The Report operation outputs tab-separated text (.tsv) files listing the project contents for review in a spreadsheet or scripting tools.

Syntax:

_projectmgr.bat report project=”project path” destination=”report destination”

Parameter:

  • project: path of project for reporting
  • destination: path on disk where report files will be generated

Optional parameter:

  • name: prefix of generated text files

Example:

Output reports for a project to a “reports” folder.

(win) _projectmgr.bat report project=/shared/demoProject destination=/shared/demoProject/reports

(macOS, linux) _projectmgr report project=/shared/demoProject destination=/shared/demoProject/reports