Open topic with navigation

Startup Configuration File

The Startup Configuration File is an XML file that you can use to launch Geo SCADA Expert on a Multi-Monitor setup (see Launch a ViewX Client on a Multi-Monitor Setup), and/or have customized Window Container behavior.

You store the Startup Configuration File on the client machine (the machine on which the ViewX client is installed and to which the file relates).

Name the file 'StartupConfiguration.xml' and place it in the following directory:

C:\ProgramData\Schneider Electric\ClearSCADA

(The exception to this is if you use a ViewX command line argument to specify a different name and/or location for the file. You can use such an argument to Define an Alternate Startup Configuration File , whereby you can specify a different name and/or location for each Startup Configuration File that you want to use on a particular client machine.)

If the file is detected when the ViewX client launches, its settings are applied to that client's interface layout, resulting in a Multi-Monitor setup or customized Window Container behavior.

If the XML in the Startup Configuration File is not valid, a diagnostic message will appear when you launch the ViewX client(see Resolve an Invalid Startup Configuration File).

NOTICE

unexpected behavior OF APPLICATION

Startup Configuration files are intended only for use on ViewX clients that are required to launch Geo SCADA Expert on a Multi-Monitor setup, and/or have customized Window Container behavior.
Do not use Startup Configuration files on Virtual ViewX clients, as these clients only support a single monitor setup, and do not support the same customized behavior. Using a Startup Configuration file on such a client could result in unexpected behavior. (Startup Configuration files are not supported, and are ignored, on Original WebX clients.)
Failure to follow these instructions can result in inoperable equipment.

A set of XML Elements is used to define the settings in the Startup Configuration File. You can create and configure the file in any standard XML editing tool.

You can use the Startup Configuration File to:

ClosedDefine Primary and Secondary Window Containers

You can specify the attributes that are associated with the Primary and Secondary Window Containers, for example, specifying the monitor on which each Window Container appears, whether the Alarm Banner appears in each Window Container or whether Window Containers are displayed in Full Screen mode.

Example:

The following XML code excerpts are from Startup Configuration Files for Multi-Monitor setups that each have three monitors.

With Geo SCADA Expert 2019 onwards, Startup Configuration Files support the MonitorOrigin attribute, so might include XML code such as the following:

<Startup>

<WindowContainers>

<PrimaryWindowContainer MonitorOrigin="0,0" DisplayMode="FullScreen"/>

<SecondaryWindowContainer Name="Left" MonitorOrigin="-1920,0" DisplayMode="Restored" />

<SecondaryWindowContainer Name="Right" MonitorOrigin="1920,200" DisplayMode="Restored" />

</WindowContainers>

</Startup>

In the code above, the section within the WindowContainer tags specifies that there is one Primary Window Container (named "Primary" by default), and two Secondary Window Containers (named "Left" and "Right"). The MonitorOrigin attribute defines the top-left coordinates of each monitor in relation to the primary monitor (the one on which the Start menu appears in Windows). This attribute specifies that the Primary Window Container appears on the primary monitor (for which the MonitorOrigin is set to 0,0). The negative value used in the coordinates of the Secondary Window Container named "Left" indicates that particular Window Container appears on a monitor that is positioned to the left of the primary monitor (it also indicates that the monitor's display is set to 1920 pixels wide). The coordinates of the other Secondary Window Container (named "Right") indicate that Window Container appears on a monitor that is positioned to the right of the primary monitor. Again, the coordinates are relative to those of the primary monitor (so in this case, they indicate that the primary monitor's display is also set to 1920 pixels wide). The 'y' value of that monitor's MonitorOrigin coordinates indicates that the top-left corner of this particular monitor is positioned 200 pixels lower down than the top-left corner of the primary monitor.

 

On systems that have been upgraded from ClearSCADA 2017 R3 or earlier, the Startup Configuration file might include the following XML code:

<Startup>

<WindowContainers>

<PrimaryWindowContainer Monitor="1" DisplayMode="FullScreen"/>

<SecondaryWindowContainer Name="Left" Monitor="2" DisplayMode="Restored" />

<SecondaryWindowContainer Name="Right" Monitor="3" DisplayMode="Restored" />

</WindowContainers>

</Startup>

The section within the WindowContainer tags specifies that there is one Primary Window Container (named "Primary" by default), and two Secondary Window Containers (named "Left" and "Right"). The Monitor attribute uses a number to assign each Window Container to one of the monitors detected by the operating system. (Be aware that some activities outside of Geo SCADA Expert might inadvertently cause the monitor numbers to change in the operating system, so causing a discrepancy between the numbers specified in the Startup Configuration File and those identified by the operating system. If this occurs, consider using the MonitorOrigin attribute in your Startup Configuration File instead of the Monitor attribute.)

ClosedDefine how one or more Alarm Banners are displayed

You can define how many Alarm Banners are displayed in multiple Window Containers and their position within each Window Container.

Example:

The following XML code is from a Startup Configuration File for a Multi-Monitor setup with three monitors and illustrates the three types of Alarm Banner that can be displayed in each.

<Startup>

<WindowContainers>

<PrimaryWindowContainer MonitorOrigin="0,0" DisplayMode="FullScreen" AlarmBannerPersistSettings="true" AlarmBannerDisplayState="DockedTop" />

<SecondaryWindowContainer Name="Left" MonitorOrigin="-1920,0" DisplayMode="Restored" AlarmBannerDisplayState="DockedBottom" />

<SecondaryWindowContainer Name="Right" MonitorOrigin="1920,0" DisplayMode="Restored" AlarmBannerDisplayState="Fill" OpenInWindow="Left" />

</WindowContainers>

</Startup>

The AlarmBannerDisplayState attribute within the WindowContainer tags specifies that there is an Alarm Banner in the Primary Window Container (named "Primary" by default) docked at the top of the Window Container.

The two Secondary Window Containers (named "Left" and "Right") contain an Alarm Banner docked at the bottom in the 'Left' Window Container and filling the complete 'Right' Window Container.

You need to add the OpenInWindow element, so that documents (such as the Events list) will display in a different Window Container if opened from the Alarm Banner.

ClosedDefine the display of Documents

You can specify whether any documents are to display automatically when anyone starts the ViewX client
(including the Window Container in which each document window is to appear)

Example:

The following XML code is from a Startup Configuration File for a Multi-Monitor setup with three monitors.

<Startup>

<WindowContainers>

<PrimaryWindowContainer MonitorOrigin="0,0" DisplayMode="FullScreen"/>

<SecondaryWindowContainer Name="Left" MonitorOrigin="-1920,0" DisplayMode="Restored" />

<SecondaryWindowContainer Name="Right" MonitorOrigin="1920,0" DisplayMode="Restored" />

</WindowContainers>

<InitialDocuments>

<Document Window="Primary" Type="Object" System="MySystem1">Eastern Region.Regional Overview</Document>

<Document Window="Left" Type="Object" System="MySystem1">Eastern Region.Zone 1.Plant Overview</Document>

<Document Window="Right" Type="Object" System="MySystem1">Eastern Region.Zone 2.Plant Overview</Document>

</InitialDocuments>

</Startup>

The section within the InitialDocuments tags specifies the documents that display in each Window Container when the ViewX client launches.

ClosedDefine the number of Document windows

You can restrict the maximum number of document windows that can be displayed simultaneously across the suite of Window Containers.

Example:

The following XML code is from a Startup Configuration File for a Multi-Monitor setup with three monitors.

<Startup>

<WindowContainers MaximumDocumentWindows="6">

<PrimaryWindowContainer MonitorOrigin="0,0" DisplayMode="FullScreen"/>

<SecondaryWindowContainer Name="Left" MonitorOrigin="-1920,0" DisplayMode="Restored" />

<SecondaryWindowContainer Name="Right" MonitorOrigin="1920,0" DisplayMode="Restored" />

</WindowContainers>

</Startup>

The section within the WindowContainer tags specifies that there is one Primary Window Container (named "Primary" by default), and two Secondary Window Containers (named "Left" and "Right"). The MaximumDocumentWindows attribute limits the total number of documents that can be opened across all three Window Containers to six.

Disclaimer

Geo SCADA Expert 2020

© 2020 AVEVA Group Plc.  All Rights Reserved.

The Schneider Electric industrial software business and AVEVA have merged to trade as AVEVA Group plc, a UK listed company. Schneider Electric, Life is On Schneider Electric and EcoStruxure are trademarks and the property of Schneider Electric SE and are being licensed to AVEVA by Schneider Electric.