API Help
EPLAN API / User Guide / API Miscellaneous / Command line parameters
In This Topic
    Command line parameters
    In This Topic

    Here is a full list of parameters of the EPLAN.exe application. By default, it is installed in C:\Program Files\EPLAN\Platform\<version>\Bin directory .

     


    Parameter Description

    Auto

    EPLAN is shut down after executing the command line; it has no effects on showing dialogs or the mainframe 
    

    Quiet

    Determines if dialogs are shown while a command line is executed :
     * 0: all dialogs will be shown
     * 1: no dialogs will be shown (default)
     * 2: only some special dialogs will be shown, e.g. progress bars
    

    NoLicenseDialog

    Turn off calling license dialog. 
    

    NoUserRightsDialog

    Turn off calling user-rights dialog. If user rights check fails, EPLAN application will terminate. This dialog will be shown per default if it is needed: 
    

    Frame

    Determines how the EPLAN mainframe should be shown: 
     * 0: Hides this window and passes activation to another window.
     * 1: Activates and displays the window. If the window is minimized or maximized, Windows restores it to its original size and position.
     * 2: Activates the window and displays it as an icon.
     * 3: Activates the window and displays it as a maximized window.
     * 4: Displays the window as an icon. The window that is currently active remains active.
     * 5: Activates the window and displays it in its current size and position.
     * 6: Minimizes the window and activates the top-level window in the system's list.
     * 7: Displays the window as an icon. The window that is currently active remains active.
     * 8: Displays the window in its current state. The window that is currently active remains active.
     * 9: Activates and displays the window. If the window is minimized or maximized, Windows restores it to its original size and position. 
    

    Setup

    Determines if default settings should be used :
     * 0: USER, STATION, COMPANY settings are restored to their installation default (on file level) and databases are backed (default)
     * 8: the actual adjusted settings will be used (on file level) ONLY FOR INTERNAL USE!
     * category (USER or STATION or COMPANY) is denoted: settings of that category are restored to their installation default (on file level) and the database is backed
     * path: all settings below this location will be deleted and then reloaded from the reference database, but only when more than the category is denoted
     * nobackup: same as setup:0, but no backup of the databases.
    

    SetupRestore

    Determines if settings should be restored from last database backup (default: 0): 
     * 0: USER, STATION, COMPANY settings are restored from their last backup (on file level)
     * category (USER or STATION or COMPANY) is denoted: settings of that category are restored from their last backup (on file level)
    

    User

    Eplan login user. Settings will be used from this user.
     [USER]:the user name
    

    Password

    Eplan login password used for user rights.
     [PASSWORD]:the user password
    

    Station

    Settings will be used from another station
     [STATION]:the station name
    

    Company

    Settings will be used from another company
     [COMPANY]:the company name
    

    NoLoadWorkspace

    No workspace is loaded or restored 
    

    NoSplash

    No splash screen is shown on system start 
    

    NoRemoting

    No Eplan Remoting functionalities are available 
    

    Language

    EPLAN will be started with chosen GUI language. The language predefined in the settings of EPLAN will not be changed
     [LANGUAGE]:the chosen language (e.g. de_DE or en_US)
    

    PathsScheme

    Sets scheme of directories' paths, e.g. /PathsScheme:PredefinedPathScheme. If a chosen scheme not exists, the default scheme is used. 
    

    reg

    New modules in the bin directory will be registered at startup 
    

    autoRegAddon

    New installed addons will be registered at startup
     [VALUE]:true or false
    

    NoGuiProfiles

    Disables dialog "Select scope of menu" at startup 
    

    License

    Name of the file containing the license to use or to borrow (*.lis)
     [FILENAME]:the *.lis file
    

    ReturnLicense

    Return the borrowed license. The parameter is the name of the file containing the borrowed license. This same file used by /license
     [FILENAME]:the *.lis file
    

    RequestOfflineLicense

    Create the request file to borrow license offline (*.egr). The parameter is the name of the file containing license to borrow (*.lis)
     [FILENAME]:the *.lis file
    

    OfflineLicense

    Use the file containing the borrowed license which is converted from a confirmation file. The parameter is the name of the file containing license to borrow (*.lis)
     [FILENAME]:the *.lis file
    

    ViewOnlyMode

    Projects are opened read-only. Runs without use of user-right database 
    

    SystemConfiguration

    Set system configuration scheme
     [VALUE] scheme name of system configuration
    

    EditForEEC

    Determines how to create window macros. Macros can be created with only one representation type "undefined" and Variant A. The command line parameter "EditForEEC" has only effect in macro projects.
     [FILENAME]:an XML file that contains variable names for placeholder
    

    Variant

    Product name. It is used to call an EPLAN platform-based product:
     * "Electric P8" 
     * Fluid
     * FluidMan
     * ProPanel
     * PPE
     * View
     * CPM
     * FHC
     * Education
     * Trial
    

    VariantSharedEplDir

    Product name directory. This is alternative way of setting product name to 'Variant' parameter, for example C:\\Program Files\\EPLAN\\Preplanning\\2.7.0
    

    AttachDebugger

    Attach debugger to execution of eplan
    

    BatchServer

    Use eplan as a batch server
     [PORT] (default:50000):the batch server port
    

    WebService

    Starts a webservice on the specific url
     [URL]:the url for the service
    

    WebServer

    Use eplan as a web server
     [HOST],[PORT]:the host and the port
    

    RestartOnCrash

    Restart EPLAN after a crash occurred
    

    TemporarySettingsPath

    Start eplan with default settings in the specified folder
     [DIR]:the settings directory
    

    action name

    Action that should be executed, all following parameters (starting with "/" or "–") are passed to the action as parameters 
    

    Remarks
     When starting P8 from command line with an action then no previously opened projects are opened at the beginning of the session.
     
    

    Example
        
     "C:\\Program Files\\EPLAN\\Platform\\2.7.1\\Bin\\EPLAN.exe" /variant:"Electric P8"
     
      
    

        
     W3u.exe action /Param1:wert1 /Param2:wert2 /Param3
     
      
    

        
     W3u.exe /Setup:USER.WORKSPACE.NAMED
     
      
    

        
     W3u.exe /User:UserXYZ
     
      
    

        
     W3u.exe /NoLoadWorkspace action /Param1:wert1
     
      
    

        
     W3u.exe /Language:en_us
     
      
    

        
     W3u.exe /Auto /Quiet /Frame:2 AnotherAction /ActionPar
     
      
    

     If the license dialog is needed, the flag NoLicenseDialog disables calling it.
     
     W3u.exe /NoLicenseDialog action /Param1:wert1 /Param2:wert2
     
    

     If no user rights dialog is needed, the flag NoUserRightsDialog disables calling it. If user rights check fails, EPLAN application will terminate.
     
     W3u.exe /NoUserRightsDialog action /Param1:wert1 /Param2:wert2
     
    

     Use or borrow a License defined in myLicense.lis. In myLicense.lis you can define a product variant and License modules to use or to borrow for a period of time.
     
     W3u.exe /License:"D:\\myLicense.lis"
     
    

     Return a license
     
     W3u.exe /ReturnLicense:"D:\\myLicense.lis"
     
    

     Request a license file
     
     W3u.exe /RequestOfflineLicense:"D:\\myLicense.lis"
     
    

     Use a license offline
     
     W3u.exe /OfflineLicense:"D:\\myLicense.lis"