Command line option / switches for GoldMine Premium Edition

Version 1

    Details

    Definition by Wikipedia of Command-line options - http://en.wikipedia.org/wiki/Command-line_interface

    A command-line option or simply option (also known as a flag or switch) modifies the operation of a command; the effect is determined by the command's program. Options follow the command name on the command line, separated by spaces. A space before the first option is not always required.


    GoldMine users can edit their GoldMine shortcut on their desktop / the GoldMine Start menu entry / the GoldMine  Windows Task Bar item to include e.g. their user name by default, run  certain GoldMine macros when starting GoldMine or the GoldMine Administrator can set up command  line switches e.g. for running GoldSync in silent application mode

     


    Resolution

    [STEPS]
    1. Browse to the GoldMine shortcut on the Desktop / in the Windows Start menu or in the Windows Taskbar
    2. Right Click >> Properties
    3. Tab Shortcut
    4. The command line options/switches are added after the application path and executable in the Target field of the GoldMine shortcut e.g.
    "C:\Program Files (x86)\GoldMine\gmw.exe" /u:master /p:access /m:805 
    5. OK

    For GoldMine Premium Edition (GMPE) the below command line options/switches are possible and can be used when launching GoldMine.

    I. the User name option/switch u

    Switch:
    /u:username
    Example: "C:\Program Files (x86)\GoldMine\gmw.exe" /u:master
    Description: Fills in automatically the set user name in the log on screen when starting GoldMine
    Usage: e.g. when the Windows user name is different than the GoldMine user name >> when starting GoldMine the user name shows the Windows user name and the user needs to manually fill every time the GoldMine user name is blank
    Notes: When the GoldMine user does not have a password set within GoldMine the application will log in the user straight away with this command line option/switch
    Related Knowledge Article: #11271 - How to set the GoldMine Login name for a workstation so that the users name shows by default.


    II. the password option/switch p

    Switch: /p:password
    Example: "C:\Program Files (x86)\GoldMine\gmw.exe" /u:master /p:
    abc123
    Description: Fills in automatically the set password in the log on screen w
    hen starting GoldMine
    Usage: e.g. for test environments where no security concerns arise when the password can be seen in plain text on the short cut icon, also used when GoldSync is setup as a Service automatically and usually also when the GoldMine Administrator sets up the GoldSync in silent mode as an application (see below the s switch)  
    Notes:
    this will expose the GoldMine password in plain text on the shortcut icon


    III. the GOLDDIR option/switch g

    Switch:
    /g:database alias: (this needs to be an alias for a database containing the CAL and related tables)
    Example: "C:\Program Files (x86)\GoldMine\gmw.exe"
    /u:master /p:abc123 /g:archive:
    Description: 'overrides' the GOLDDIR entry in the global GM.INI for the specific shortcut icon 
    Usage: 
    GoldMine Technical Support does  NOT recommend the usage of the setting without having a concrete need  e.g. on a test environment, the actual used GoldMine base can be  verified within GoldMine via Help >> About GoldMine >>  System >> GoldMine Files entry
    Notes: This setting should be ONLY used by experienced and skilled GoldMine Administrators as it means that the user is working on a DIFFERENT GoldMine system (different Calendars, different Mailbox, different Opportunities etc.) than all other users.
     

    IV. the COMMONDIR option/switch c

    Switch:
    /c:database alias:
    (this needs to be an alias for a database containing the CONTACT1 and related tables)
    Example:
     
    "C:\Program Files (x86)\GoldMine\gmw.exe"/u:master /p:abc123 /c:leads:
    Description:
    'overrides' the COMMONDIR entry in the USER.INI and GM.INI for the specific shortcut icon and will open the specified Contact Set Database
    Usage: The Contact Set which should be opened is globally set in the COMMONDIR setting of the GM.INI, but is then overridden by the user's last selected Contact Set which is also stored as COMMONDIR entry in the USER.INI, so when e.g. a user needs to work every morning within a specific contact set but after this work is completed the user needs to change into a different contact set this last Contact Set will be stored in the USER.INI when the user exits GoldMine. Although, the user can then in the morning again use the Tools >> Databases >> Open Database feature to select the first Contact Set, again this setting can be used to log in the user automatically into the correct desired contact set. This means the user needs only once to Open a database during the day. Of course their might be also other usage scenarios possible e.g. for a GoldMine Administrator on a test environment etc. 
    Notes:
    -
    While the g switch in order to determine a different GoldMine  base than the GOLDDIR entry in the GM.INI is absolutely NOT recommended on a GoldMine production system and may result in unexpected data appearing or not appearing within GoldMine, the
    command line option/switch /c: can be used as users can easily select another or the proper Contact Set again.
    - Where this
    command line option/switch is used by a user it is absolutely recommended that the user activates the status bar in GoldMine to have a constant visibility in which Contact Set the user is currently active via Tools >> Options >> Tab System >> activate Show status bar >> OK


    V. the Silent application option/switch s

    Switch:
    /s:DDE or /s:GoldSync or /s:GMAlarm
    Notes:
    -
    When  GoldMine is set to start in silent mode, GoldMine appears on the system  tray / notification area instead of as an icon on the Windows taskbar.
    - if GoldMine is then started either by another GoldMine shortcut or via the system tray icon >> Right Click >> GoldMine... it needs to be kept in mind that the silent mode is not re-entered when exiting GoldMine and GoldMine in silent mode needs to be started again in order to serve for the determined purpose.
    -
    GoldMine logs in the user specified in the /u: command line option/switch without increasing the "logged-in" license count. All operations are performed in the context of the currently logged user.

    V.1. start GoldMine in silent mode as a DDE Server with /s:DDE

    Example:
    "C:\Program Files (x86)\GoldMine\gmw.exe" /u:master /p:abc123 /s:DDE
    Description: Starts GoldMine in silent mode serving as a DDE server
    Usage: this is most likely only interesting for programmers who are integrating GoldMine with DDE data exchange

    V.2. start GoldMine in silent mode as a GoldSync Server / GoldSyncAgent with /s:GoldSync

    Example:
    "C:\Program Files (x86)\GoldMine\gmw.exe" /u:master /p:
    abc123 /s:GoldSync
    Description: Starts GoldMine in silent mode serving as a GoldSync server
    Usage: used where running GoldSync as a Windows Service is not desired, running GoldSync as a Windows Service was introduced in GoldMine version 6.5.x. For further information refer to GoldMine Online Help via Help >> GoldMine Help >> GoldMine Administrator Guide >> Synchronization >> About GoldSync >> Configuring GoldSync as a Service  
    Related Knowledge Article: #15421 :  How to run GoldSync as application in silent mode?

    V.3. start GoldMine in silent mode with GoldMine Alarm with /s:GMAlarm

    Example:
    "C:\Program Files (x86)\GoldMine\gmw.exe" /u:master /p:
    abc123 /s:GMAlarm
    Description: Starts GoldMine in silent mode for bringing up GoldMine alarms on the Desktop while GoldMine is closed
    Usage:
    bringing up GoldMine alarms on the Desktop while GoldMine is closed
    Notes:
    While the other command line options / switches need to be created/adjusted manually, the GoldAlarm can be setup by the user within GoldMine via Tools >> Options >> Tab Alarms >> place a GoldAlarm icon on the Windows desktop and also to optionally launch GoldAlarm when Windows is started.


    VI. run a macro on the start of GoldMine with the option/switch m

    Switch: /m:macro number
    Example: "C:\Program Files (x86)\GoldMine\gmw.exe" /u:master /p:abc123 /m:805
    Description: when GoldMine is started the specified macro is executed automatically  
    Usage:
    e.g. useful in order to start Server Agents automatically when starting GoldMine 
    Notes:
    the macro number can be identified in the GoldMine shared folder >> macros folder >> opening the USER.MAC (e.g. master.mac) >> the section header shows the macro number >> the T entry is the defined macro text and the D entry shows the description for the macro
    Related Knowledge Article: #13299 -  Is it possible to setup GoldMine Automated Processes as a Windows service?

    VII. Start GoldMine in maintenance mode for indexing and/or rebuilding the GoldMine database with the option/switch r

    Switch: /r:first
    numeric parameter indicating the process type,second numeric parameter indicating the tables to be processed
    - Both parameters allow for multiple options (and tables) by adding the values of all desired options and are separated by a comma.
    Example:
    "C:\Program Files (x86)\GoldMine\gmw.exe" /u:master /p:abc123 /r:132,5
    Description: starts automatically the determined maintenance action when GoldMine is started  
    Usage: was rather used in former GoldMine Standard versions / GoldMine dBase versions (see Notes)
    Notes:

    - the regular database maintenance of GoldMine Premium's Microsoft SQL databases and tables should rather be setup and performed within SQL Server Management Studio either by a manual maintenance or regular SQL Server maintenance plans than within GoldMine by the Database maintenance especially the rebuild and pack feature. Nevertheless, in some occasions a re-indexing and/or a complete rebuild and pack maintenance might be necessary or is advised by GoldMine Technical Support. In such cases we recommend to use the database maintenance wizard from within GoldMine and setup e.g. Automatic Maintenance or perform manual database maintenance actions on demand than the usage of the command line options/switch.
    - regardless if performing a database maintenance via SQL maintenance plans, via the GoldMine Maintenance Wizard or the command line options/switch, it is absolutely recommended to have a full running backup of the GoldMine database prior to executing the maintenance.
    - maintenance runs performed via the GoldMine database maintenance feature will re-index and if applicable re-create tables upon GoldMine internal definition and therefore e.g. indexes might be changed or dropped, triggers will be removed etc.  

    VII.1. Details of Process types as the first numeric parameter of the r command line option / switch     

    The options available for the first parameter includes the below options and the values are then simply calculated, e.g. Rebuild (4) + Force all users to be logged out (128) >> first parameter (132):

    None                      0
    Index                           //index 
    IndexUI                   2      //index w/o status
    Rebuild                   4      //pack and rebuild
    ConvertRecID         16      // converts to new recid's, DO NOT USE unless GoldMine was upgraded from GoldMine 4.x or on advise
    Minimize                32      // minimize GM flag.
    LogoutWhenDone   64      // quit GM when done.
    LogoutAll              128      // force all users out flag.


    VII.2. Details about the tables to be processed as the second numeric parameter of the r command line option / switch   

    The  options available for the second parameter includes the below options for the specific table set(s) and the values are  then simply calculated, e.g. GoldDirTables (4) + AllContTables (1) >> second parameter (5):

    GoldDirTables     1   // GoldMine Base (GOLDDIR) tables
    CurrContTables   2   // current Contact Set tables
    AllContTables      4  // all Contact Sets tables


    GoldMine Technical Support will not provide any information about individual table values when it is necessary to maintain only certain tables but instead we recommend to use the Database Maintenance Wizard via Tools >> Databases >> Database Maintenance >> Individual Files >> then select the desired Tables from the list.


    VIII. the ThinClient emulation mode option/switch t

    Switch: /t:
    Example: "C:\Program Files (x86)\GoldMine\gmw.exe" /t:

    Description: This switch starts GoldMine for non master users in a "ThinClient mode" and was intended to provide a similar possibility as iGoldMine's default limitation not being able to run reports, execute merge/purge and record deletion wizard or execute or remove Automated Processes.
    Already on the login window users can recognize a difference from the usual log on window vs. when using the switch


    Notes:
    This switch still works in GoldMine Premium Edition but is neither officially supported nor maintained in any way.