The Startup Configuration File is an XML file that uses the following elements:
- Startup
- WindowContainers
- PrimaryWindowContainer
- SecondaryWindowContainer
- ToolbarMode
- InitialDocuments
- Document
Startup
This is the root element. It contains the WindowContainers and InitialDocuments elements.
WindowContainers
This element describes the collection of Window Containers. It needs to contain one PrimaryWindowContainer element, and zero to 15 SecondaryWindowContainer elements.
| Attribute Name | Type | Required | Description |
|---|---|---|---|
| AlarmBannerWindow | String | No | Specifies the name of the Window Container that the Alarm Banner displays on. If this is not specified, the Primary Window Container will be used. |
| AlarmBannerMode | (Bottom, Top, Full) | No |
Controls where the Alarm Banner displays on the target Window. For information on Full mode, see Launch the Alarm Banner in Full Mode. If this attribute is not present, the client will default to the user's setting to determine where the banner displays. |
| IsRestrictedWorkstation | Boolean | No | Controls whether the client operates as a restricted workstation (see Launch a Multi-Monitor Setup on a Restricted Workstation). |
| MaximumDocumentWindows | Integer | No | Controls the maximum number of windows that can display across all Window Containers. The range is 1 to 100. If this attribute is not specified, 100 is the default. |
PrimaryWindowContainer and SecondaryWindowContainer Elements
These elements define each Window Container and how they will display when the View X client launches.
| Attribute Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Specifies a unique name to reference the Window Container. Only used on the SecondaryWindow Container element, as the primary container uses the name 'Primary'. |
| Monitor | Integer | No | Indicates on which monitor the Window Container will display. The number reflects the order that is returned by the Windows API call 'EnumDisplayMonitors'. |
| OpenInWindow | String | No |
Specifies the destination Window Container for all navigation commands. For example, if the user follows a hyperlink, then the linked page will display in the Window Container named in this parameter. NOTE: If you apply this element to the Primary Window Container, you can only specify a Secondary Window Container as a destination. This means you will not be able to edit any documents, as Secondary Window Containers only display document windows in Run Mode. |
| InterfaceMode | (SingleDocument, MultipleDocuments) | No | Controls whether the Window Container is a single document interface or a multi-document interface (see Configure a Window Container to Display a Single Document and Configure a Window Container to Display Multiple Documents). |
| DisplayMode | (Maximized, Restored, FullScreen) | No |
Controls the initial window mode of the Window Container. For information on full screen mode, see Launch a Window Container in Full Screen Mode. NOTE: If the user has their task bar set to Auto Hide, then in maximized mode they will not be able to access the task bar with the mouse. Instead they need to press the 'Windows' keyboard key. |
| ToolbarMode | String | No |
Use one of the following strings to control the Ribbon and Quick Access Toolbar on the Primary and Secondary displays: HideRibbon—This hides the ribbon and all tabs on the Primary screen. HideQAT—This hides the quick access toolbar on the Primary and Secondary screen. HideAllMenus—This hides the ribbon and quick access toolbar on the Primary and Secondary screen. NOTE: If a screen does not have a ribbon or quick access toolbar on display then the logon menu will also be hidden on that screen. |
| Position | Integer, Integer | No |
Defines the position (based on the top-left corner) of the Window Container, relative to the monitor it is on. Applies regardless of the DisplayMode, as even when maximized or in If the position specified results in the bottom right corner of the window being outside of the monitor's work area, the position will be adjusted. If the position is not specified, the window will be centered in the monitor's work area. |
| Size | Integer, Integer | No |
Defines the size of the Window Container.Applies regardless of the DisplayMode, as even when maximized or in If the size is greater than the monitor's work area, the window will resize to fit. If the size is not specified, the window will be sized to half the monitor's work area. |
| LegacyHead | Integer | No |
To support backward compatibility, this parameter identifies the Window Container with a head number (see Assign a Head Number to a Window Container). If the head number is not specified, the system will automatically assign a number based upon the Window Container order in the configuration file. |
| ReapplyOnLogOn | Boolean | No | When set to "true", the Window Container will be reset to the settings specified in the configuration file. This attribute is only allowed on SecondaryWindow Container elements, as moving or changing the main application window on logon would be visually distracting. |
InitialDocument Element
Contains zero or more Document elements that define which documents display when the ViewX client launches.
Document Element
Specifies a document to open when ViewX launches.
| Attribute Name | Type | Required | Description |
|---|---|---|---|
| Window | String | Yes | Specifies the Window Container in which the document will open. |
| Type | (Object, Query, Alarm) | Yes | Specifies the type of document to open. |
| System | String | Yes | Specifies the ClearSCADA system (database) that hosts the document. |
| Title | String | No | Specifies a title for a query document. |
The content of the element specifies the document details:
- Object: The content needs to be the name of an object in the database. If the object does not have a document type (for example, a point), a diagnostic message will display when opening. It is not possible to open the configuration Form for an object on startup.
- Query: The content needs to be an SQL query.
- Alarms: The content needs to be an alarm filter string.
Further Information
Examples that demonstrate the use of specific XML attributes: see Example Configuration.