Command line arguments

The following command line arguments may be used:

  1. "{Task launch Id (int)}"

    2. Use Command Line key when executing task on Geobank Startup.

    Example: " Geobank.Desktop.Launcher.exe 1 "

    Note: A Task will only execute for a user who has been granted access to that task (within a Profile and Task-list) in the Configuration database being used.

  2. "-S {List of Substitution Parameters}"

    3. Use Substitution Parameters when executing a task on Geobank Startup.

    Example: ‘ Geobank.Desktop.Launcher.exe 1 -S "Project=Test;Site=Test" ’

    Note: Syntax requires there is no space around an equal sign (=) - thus, “Project=Test” and "Site=Test".

  3. "-X"

    4. Close Geobank after execution of the task (if the task is of a type that does not close automatically on completion when executed in a floating window).

    Example: " Geobank.Desktop.Launcher.exe 1 -X"

  4. "-C"

    5. Clear all session data. (Use this if you want to ensure any tabs previously open in Geobank are not reopened on start-up).

    Example: " Geobank.Desktop.Launcher.exe 1 -X -C"

  5. "-D"

    6. Specify the Configuration database. To use this command, enter -D (case-sensitive capital D) and, in double quotes, state the name of the configuration database.

    Configuration databases are the names in the splash screen drop down shown when Geobank opens.

    Note: Names are case-sensitive. If an unmatched name is specified, you will be prompted to select the configuration database. All available configuration database connections are located in the ...Program Data\Micromine\Geobank folder in the 'GbisConfigDb.xml' file.

    Example: " Geobank.Desktop.Launcher.exe 1 -D "Demo"

    Note: If -D is not used, then please be aware of the Automatically login at startup option:

    • When starting Geobank via Command line; if the Automatically login at startup option is NOT enabled under Tools | Options, the Task/Profile must exist in the configuration you select when starting Geobank.

    • If the Automatically login at startup option IS enabled, the Task/Profile must exist in the configuration that was last used. This cached configuration is loaded automatically when you start Geobank.

  6. "-U"

    7. When the -U command line option is used, Geobank will run in Unattended Mode. The purpose of this is so a task can run without any user input being required and can therefore be automated (see Job Scheduler).

    The following types of Geobank jobs/tasks have the functionality to run in Unattended mode;

    • Graphic Reports
    • Advanced Reports
    • Configured Imports
    • Configured Exports
    • Excel Imports
    • Forms
    • Action Queries
    • Query Groups
    • Macros (containing the objects above)

    When in Unattended mode, these jobs/tasks automatically start, log errors instead of displaying errors, and automatically close when complete. In Unattended mode, when tasks have been completed (or errors logged), Geobank will automatically close.

    If you are configuring an Import, Export or Report in Unattended mode, be aware that you should use the full UNC path for any mapped network drive: for example, \\server001\data\reports\ instead of N:\Reports. For detailed information, see Automation.

    Note: if using -U in a command line directly, then also use -C and -X so that Geobank opens without the previous context (which may otherwise trigger prompts) and closes when complete. -D must also be used so there is no ambiguity about which Configuration database to use. If done via the Job Scheduler, -C, -D and -X are automatically included.

    Reports automatically produce the full report in PDF format and save it with a date-stamped name to the folder set in their configuration (under Unattended Options for Graphic Reports or Folder Options for Advanced Reports).

    Note: After installing a new version, Geobank databases must be upgraded (in normal, attended mode) before a task can be performed in Unattended mode. The issue will be logged as "Unattended mode cannot be used until the Geobank system has been upgraded" in the log file (stored in the \ProgramData\Micromine\Geobank\Logs folder) and Geobank will close.

    The recommended approach is that Geobank is installed on an application server for running scheduled/unattended jobs. The server does not require a display: If there is no display, Geobank will simply run in the background. If there is a connected display, Geobank may run visibly, but will not take focus or require any attention.

    Note: Geobank must have access to a licence to run unattended - either a seat on a network licence or a standalone licence on the computer on which Geobank is being run unattended (usually a server).

A task will only execute for a user who has been granted access to that task and profile:

  • If unattended, the task/profile must exist in the configuration specified in the -D argument

When in the normal (attended) mode, if the Automatically login at startup option is NOT enabled under Tools | Options, the task/profile must exist in the configuration you select when starting Geobank.

  • If the Automatically login at startup option IS enabled, the task/profile must exist in the configuration that was last used. This configuration is loaded automatically when you start Geobank).