Important RCL EXECUTE Commands

RCL scripts are typically comprised of a series of DEFINE: commands, which define assorted menu settings, followed by an EXECUTE: command, to run the actual menu option. We do not document each and every EXECUTE: command which is available in the program - there are just too many to list. Instead, you can quickly see the DEFINE: parameters and the name of the EXECUTE: command for any RockWorks menu option by selecting the Menu | Show RCL option at the top of that program menu. See Help and Automation for details.

We list here, however, some important EXECUTE: commands that you might want to keep handy.

Contents

• Restoring menu settings
• Linking RCL Files
• Saving datasheets
• Scanning boreholes

See also these additional topics:

• RCL Scripting - Overview
• Special RCL Commands
• Important RCL DEFINE Commands
• RCL Commands - Imports

Restoring Menu Settings

• Purpose:
  • Restore all current project menu settings to their original default states. This can be a handy way to start a script with a known configuration, and then simply make incremental changes from there. We include this command in most of our sample scripts.
    
    You can also restore global settings, however this requires a program close and restart.
     
• Corresponding menu option: 
  • Preferences | Reset Menu Settings.
    
    
• Parameters: 
  • You can reset either the Global Settings or the Project Settings, or both, to the initial "factory" versions installed with RockWorks. Note that resetting the Global settings requires a program close and restart, which is not very helpful when you're running a script.
     
• Example:

DEFINE: MENU_RESET GLOBAL  False DEFINE: MENU_RESET PROJECT True EXECUTE: menu_reset

• Comments:
  • The factory defaults for all of the project-specific menu settings are stored in a file "menus.txt" which is stored within the \Program Files\RockWare\RockWorks17\Tables folder. 
  • The Global Settings, which will affect all of your projects, are stored in the RockWorks System folder.
  • The Project Settings are stored in "menus.ini" in the current project folder's "\System" sub-folder.

Table of Contents

Linking RCL Files

• Purpose:
  • Run an RCL script from within another script.
    For example, you could create one RCL file that contains only striplog DEFINE: commands, another which contains only cross-section settings, and another which lists the actual cross section EXECUTE commands for your series of cross section diagrams. You can create a single "master" script which calls these component RCL files.
     
• Corresponding menu option: 
  • Window | Compile RCL
    
    
• Parameters: 
  • RCL file name
  • optional prompt and error settings
     
• Example:

DEFINE: RCL   FILE_NAME   striplog_settings.rcl DEFINE: RCL   IGNORE_PROMPTS      False DEFINE: RCL   SHOW_ERRORS         False DEFINE: RCL   SHOW_ERROR_SUMMARY  True EXECUTE: rcl DEFINE: RCL   FILE_NAME   section_settings.rcl EXECUTE: rcl DEFINE: RCL   FILE_NAME   create_sections.rcl EXECUTE: rcl

• Comments:
  • See the case study and video on the RockWare website for examples of how this works.

Table of Contents

Saving Datasheet Files

• Purpose:
  • Save the current datasheet in the project folder, under a name with an ".RwDat" file name extension.
     
• Corresponding menu option: 
  • File | Save in the Utilities program tab
    
    
• Parameters: 
  • RwDat file name
     
• Example:

DEFINE: GENERAL  ATD_FILE_NAME  myfile.rwdat EXECUTE: ru_save

Table of Contents

Scanning Boreholes

• Purpose:
  • Establishes the project dimensions by scanning all of the boreholes or scanning the enabled boreholes. 
    
    
• Corresponding menu option:
  • Scan Boreholes button at the bottom of the program window.
     
• Parameters: 
  • Define whether all boreholes or enabled holes only are to be scanned.
  • Other settings define how the dimensions and node spacing are to be determined.
     
• Examples:

DEFINE: SCAN_LOGS SCAN_ALL_LOGS True EXECUTE: scan_boreholes

• Comments:
  • See also the DIMENSIONS command.

Table of Contents

 Back to RCL Overview

RockWare home page