ViewX Command Line Arguments
You can use ViewX command line arguments to pre-set the settings for ViewX. The ViewX commands are:
You can use the /register
ViewX command to restore registry settings. This is useful if the Windows’ registry editor (regedit) has been used to alter registry settings incorrectly (which may cause ‘Class Not Registered’ errors if you are using the Automation interface). You may be able to correct the errors using /register
.
When you use /register, ClearSCADA is able to repair many (but not all) incorrect registry settings relating to ClearSCADA.
To use /register
:
- In Microsoft Windows, run the Command Prompt.
- When the prompt is displayed, use the change directory command to locate your ViewX application. For example, if your command prompt shows Documents and Settings\<Your Windows ID> when you first display it, you need to enter:
cd <the location of your ViewX application>
- Press the Enter key. The command prompt should change to show the location of your ViewX application.
- When the prompt shows the location of your ViewX application, enter:
SE.Scada.ViewX.exe /register
- Press the Enter key.
ClearSCADA will attempt to restore the ClearSCADA related registry settings.
Do not include the angle brackets. For example:
cd C:\Program Files (x86)\Schneider Electric\ClearSCADA
If required, you can run multiple instances of the ViewX client application on a single client machine.
You might want to use this setup, for example, if you want to run multiple instances of a ViewX client on a single machine and want each of those ViewX instances to access a different ClearSCADA server and database. (If you want to have a distributed arrangement where different components and documents from the same ViewX client are hosted on different monitors, consider using a Multi-Monitor setup, rather than a Multiple Instance setup, see Multi-Monitor Setup.)
To configure ViewX to run multiple instances on a single client:
- Log on to the client PC.
- Using Windows Explorer, browse to:
"C:\Program Files\Schneider Electric\ClearSCADA"
- Locate the SE.Scada.ViewX.exe file and right-click on it to display a context-sensitive menu.
- Select the Create Shortcut option to create a shortcut to ViewX. The shortcut item is added to the list of files in the ClearSCADA folder.
- Right-click on the shortcut item and select the Properties option from the context-sensitive menu.
The Shortcut Properties dialog box is displayed. - Modify the Target field by adding the following string to the link:
/instance:<number>
Where <number> is the number of the instance of ViewX that runs when you run it from the shortcut. Do not enter the angle brackets <>.
For example, the target should be similar to:
"C:\Program Files\Schneider Electric\ClearSCADA\SE.Scada.ViewX.exe" /instance:2"
- Select the OK button to confirm the target and close the dialog box.
- In Windows Explorer, double click on the shortcut and verify that ViewX runs as expected.
- Repeat this procedure for each instance as required.
Each instance of ViewX can be configured to access a different server using the Systems.xml file. For more information see Configure ViewX Instances to Access Different Servers.
You can use the /bellsilenced
ViewX command to silence the alarm bell on a ViewX client. When the command is used, the alarm bell will not sound, no matter what other alarm bell configuration options are set for the ViewX client or for the Users that might log on to ClearSCADA using that ViewX client. This command is useful, for example:
- To disable the bell on most (but not all) ViewX clients when Multiple Instances of ViewX are used to connect to the same database(s) and those ViewX instances are placed in close proximity to each other. Rather than having the bell ring on all of the ViewX instances, you can use the command to silence the bell on all but a few of those ViewX instances. (Also see Use a ViewX Command to Run Multiple Instances of the ViewX Client.)
- To disable the bell on a ViewX client that purely hosts a system overview on a large display screen in a control room, if the bell is not required to sound on that particular client machine. The command is useful for situations in which the alarm bell is only required to sound on the other ViewX clients in the control room (those that are intended to provide individual user access to ClearSCADA via computer monitors).
Be aware that if you use the /bellsilenced
ViewX command on a ViewX client that is configured to have a Multi-Monitor setup, the command will silence the alarm on the whole ViewX instance, including all of the monitors across which the ViewX client is distributed.
LACK OF AUDIBLE ALARM NOTIFICATION
/bellsilenced
ViewX command with care. Ensure that the command is NOT used on at least one ViewX client in a Multiple Instance setup in which the clients connect to the same database. Also ensure that the Alarm Banner is displayed on the ViewX clients on which the command is NOT used (as the audible alarm can only sound on ViewX clients on which the Alarm Banner is displayed). Be aware that with a ViewX client on which the /bellsilenced
ViewX command is used, the command overrides other alarm bell configuration options set elsewhere on the ViewX client and the accounts of Users that might use that ViewX client.
To use the /bellsilenced
ViewX command:
- In Microsoft Windows, run the Command Prompt.
- When the prompt is displayed, use the change directory command to locate your ViewX application. For example, if your command prompt shows Documents and Settings\<Your Windows ID> when you first display it, you need to enter:
cd <the location of your ViewX application>
- Press the Enter key. The command prompt should change to show the location of your ViewX application.
- When the prompt shows the location of your ViewX application, enter:
SE.Scada.ViewX.exe /bellsilenced
- Press the Enter key.
ClearSCADA will disable the audible alarm bell on the ViewX client.
Do not include the angle brackets. For example:
cd C:\Program Files (x86)\Schneider Electric\ClearSCADA
Further Information
Other means by which you can silence the alarm bell (and which get overridden by the /bellsilenced
ViewX command):
Select the alarm bell button to silence the audible alarm: see Audible Alarms.
Use the alarm bell button menu to disable the alarm bell: see Audible Alarms .
Specify whether a User is allowed to disable the alarm bell: see Define which Alarm Banner and Alarms List Features are Available to a User in ViewX.
Specify whether the audible alarm is disabled by default on whichever ViewX client is used by a particular User: see Define which Alarm Banner and Alarms List Features are Available to a User in ViewX.
You can use the /Systems
command to associate a ViewX client with a Systems.xml file. Systems.xml files can be used to set up a ViewX client connection (as an alternative to using the Client Configuration Applet).
You can use the /Startup
command to associate a ViewX client with a Startup Configuration File. A Startup Configuration File is used to Launch a ViewX Client on a Multi-Monitor Setup.
For more information, see Define an Alternate Startup Configuration File .
To disable any script execution when starting ViewX, (see Disable Script Execution).
You can enter these commands at a Windows command prompt or you can configure desktop shortcuts that include the commands as part of their Target.
You can use combinations of ViewX commands: precede each command with the / character and separate the commands with a space. For example, /Instance:2 /Systems:"E:\SystemsCPLX2.xml."