[ui]

Settings for the User Interface

[ui] acknowledgeFunction

Type
string
Range
>functionName<
This config entry can define a function to be performed before every acknowledge. For example, you can implement an authorization, that is, if a user is not authorized, he will not be allowed to acknowledge (regardless of permissions). This function must be implemented in a CTRL library and must be defined as follows: 

void functionName(dyn_string datapts, int type, int &returnValue);
The third parameter defines whether the acknowledge script will be executed (1- acknowledge, 0 do not acknowledge). It is used as a replacement for a return value, thus allowing a dpSetWait().

[ui] activateCursor

Type
string
Default
(PointingHandCursor)
Name of the pixmap file of the cursor which is shown if the mouse cursor is over an object which will activate a command script when clicked. The format of this entry is: " filename[,x,y]" e.g.: "cursor.png" or "cursor.png,2,2" where x,y defines the HotSpot of the cursor. By default it is in the center. The pixmap file must be located in the pictures directory and the format must be "PNG", "XPM" or "GIF".

Note the following restriction:

Valid cursor sizes depend on the display hardware (or the underlying window system). We recommend using 32x32 cursors, because this size is supported on all platforms. Some platforms also support 16x16, 48x48 and 64x64 cursors.

[ui] activeColorScheme

Type
string
Defines the active color scheme for the started UI manager. At runtime the active color scheme can be changed by using the CTRL function colorSetActiveScheme(). See also setActiveIconTheme().

[ui] activeIconTheme

Type
string

Defines the active icon theme for the started UI manager, e.g. "themes/dark"

During runtime this can be changed with the CTRL function setActiveIconTheme().

When a new project is created with the old IconTheme this config entry is added as activeIconTheme = "".

When the new Icon Theme is used, this entry is not added.

A custom Icon Theme is set with e.g.: activeIconTheme = "ownTheme/...".

[ui] aesExtendedFilter

Type
int
Default
0
Range
0 | 1 | 2 |3
Enables the "Extended Filter" functionality of the alert and event panel. The extended filter allows using own filter options for the alert and event panel - see chapter Properties of the Alert Table - Extended Filter .

The config entry can be set to the following values:

0 = disabled (default).

1 = the extended filter is used for the alert panel.

2 = the extended filter is used for the event screen.

3 = the extended filter is used for the event and the alert panel.

[ui] aesShowDistDisconnections

Type
bool
Default
1
Range
0|1
Allows to disable PopUps on disconnecting from distributed system in alarm screen.

[ui] allowULCAnimation

Type
bool
Default
0
Range
0|1
Enables or disables embedded module panel change animations during ULC. Only ULC affected, no effect on native UI and on WebClient.

[ui] animationTimerInterval

Type
int (ms)
Default
16
Animations which are started with the animate() function handle smooth movements due to rendering of the animated object every 16ms. This however leads to high CPU load when a lot of objects are animated in parallel. In this case, this config entry allows to increase the interval for the rendering, which can lead to not so smooth animations, but can reduce the CPU load considerably.

[ui] applicationFont

Type
string
Defines an additional font file (relative to the /data/ directory) which the application will load. Supported formats are TrueType and OpenType fonts. This config entry can be used multiple times.

[ui] arrowFocusThreshold

Type
int
Default
50
When using the keyboard navigation in a panel, this entry defines the percentage the next objects bounding box must overlap the current one to be found.

[ui] arrowsAsTab

Type
bool
Default
0
Range
0|1
If this entry is set to 1 the arrow keys move the focus to the next object (similar to the Tab key) in this direction.

[ui] assignUserGroups

Type
bool
Default
1
Range
0|1

If you set this config entry to 1 (TRUE), the WinCC OA user groups are now cyclically assigned and removed according to the Active Directory (OS Auth Groups). In addition to cyclical synchronization, the groups are also synchronized at login.

You can deactivate this behaviour by setting the config entry assignUserGroups to 0 (FALSE). This means that the user groups are only synchronized at login and not cyclically.

The time between updates is set with the config entry [ui] checkADAuthIntervall. The config entry [ui] modifyGroups is taken into account for synchronization.

[ui] autoDownscaleThreshold

Type
float
Default
2.0
Range
>= 1
Defines the threshold for the ratio: panel size / viewport size up to which panels are automatically downscaled to be able to view the whole panel inside a module. The value 1 is therefore the value which avoids downscaling completely.

[ui] autoUpdateDir

Type
string
Defines a relative directory name below the project path which will be used to download all files and subdirs (recursively) on startup when communicating via the HTTP server. This entry can be specified multiple times. The following sub directories can be used:
  • /pictures
  • /panels
  • /images
  • /colorDB
  • /xml
  • /nls
  • /bin
  • /data
  • /scripts/libs
Note

If other sub directories are specified, the HTTP server answers with "not found".

Example: 


autoUpdateDir = "panels/myTest"
autoUpdateDir = "panels/myTest2"

[ui] bmpTransparentColor

Type
string
Each bitmap which contains the color of this config entry should be presented as transparent. The entry is a color string. The bitmap which contains a specific color can be presented as transparent as follows: 

[ui]
bmpTransparentColor = "{58,110,165}"
Note that the color string has to be exactly the color of a bitmap that you want to present transparent. With the entry bmpTransparentColor = "{58,110,165}" all bitmaps which contain the color {58,110,165} are presented transparently. The exact color of a bitmap can be found via a the grab color of the graphics editor. Note that if you add the config entry to the config file first after adding the bitmaps into the GEDI you have to add the bitmaps again so that the color is presented transparent.

NOTE: For true transparency an image format should be used, which supports transparency, like PNG or GIF.

[ui] cacheTimeoutSecs

Type
int (seconds)
Default
300
Range
>= 0
A UI with the start option "-server" uses a local file cache to store the data (panels, libraries, ...). In the UI the information is stored, when a file was last saved in the cache. If you access the file again within the set time period (default cacheTimeoutSecs = 300 seconds), the file will be loaded from the local cache. If a query is executed after the time has expired, a request is sent to the HTTP server with the check whether the file was changed on the server. When using cacheTimeoutSecs = 0, the files are always loaded from the local cache. The cache must be cleared to load newer files from the server.

[ui] canvasBkgnd

Type
string (color)
Default
_3DFace
Sets the background of an embedded module to the specified color e.g. for blue: 

canvasBkgnd = "[0, 0, 100]"

[ui] checkADAuthIntervall

Type
int (min)
Default
60
Range
>= 60 | 0
Interval specification in minutes, after which WinCC OA checks the group assignment of a user in the Active Directory. Therefore the user must have the authorization to browse the AD for user information. This check is executed in addition to the standard-check while user log-in. This cyclic check can be deactivated by setting this config entry to 0. Thus only the check during the log-in will be performed.

[ui] checkChildPanelPos

Type
int
Default
1
Range
0..3
Defines in which way the position of a childpanel is restricted when it is opened:
  • 0: No restriction
  • 1: restriction to the (virtual) desktop size
  • 2: restriction to the window of the parent rootpanel
  • 3: restriction to the visible area of the parent rootpanel

[ui] checkPopupPos

Type
bool
Default
0
Range
0|1
If this entry is set to 1 a popup menu is only opened within the UI window. Therefore, it will not cross the borders of the window. The right edge of the screen is also considered as border in case that the popup is opened right beside it.

[ui] childSystemMenu

Type
bool
Default
1
Range
0|1
With this entry it is possible to disable the Close button in the window titlebar in childpanels. With true (1 = default), the system setting is still valid - the child panels contain active buttons (minimize, close). The button close sets the datapoint elements _Ui_<ManNum>_PanelOff.ModuleName and _Ui_<ManNum>_PanelOff.PanelName. This entry can only be used for UIs under Windows.

[ui] childTitleBar

Type
bool
Default
1
Range
0|1
The title bar (the windows frame) of a child panel is not shown if the config entry is set to 0. Note that the functionality of the config entry under X11 (Linux) is dependent on the Window manager and so it may happen that it does not work how supposed.

[ui] clipPrimitiveText

Type
bool
Default
1
Range
0|1
If this entry is set to 1, the primitive text will be clipped at the object boundaries. If this entry is set to 0 the option "Fit Size" is activated. The whole text is drawn no matter how long it is. Additionally the filling is expanded to the size of the text. Note that if this is the case (clipPrimitiveText = 0) the value of the property "Fit Size" is set to TRUE for all primitive texts after displaying the panel.

[ui] clockExClientEdge

Type
bool
Default
1
Range
0|1
The entry clockExClientEdge = 0 disables the 3D effect in the "Clock" graphics object.

[ui] compatAxArgumentsByValue

Type
bool
Default
0
Range
0|1
NV compatibility mode. If you set the entry to 1, the arguments in ActiveX Object Eventscripts will always be passed by value to the scripts, even when an argument is defined as reference argument. Note: Only scripts without reference arguments are allowed to call waiting functions (dpGet, delay, ...)

[ui] compatDisabledTextBackground

Type
bool
Default
0
Range
0|1
NV compatibility mode. Not suitable for new panels. If this value is set to 1, the background of disabled primitive text objects will be shown as in the old NV user interface.

[ui] compatDisabledTextColor

Type
bool
Default
0
Range
0|1
NV compatibility mode. Not suitable for new panels. If this value is set to 1, the text color of disabled primitive text objects will be shown as in the old NV user interface.

[ui] compatDisableManagedByLayoutCheck

Type
bool
Default
0
Range
0|1
When trying to change size/position of a shape, group or reference while a panel has a layout, an error is thrown and the change is disallowed. Setting this entry to 1 allows to disable this check.

[ui] compatIgnoreTextScale

Type
bool
Default
0
Range
0|1
NV compatibility mode. Not suitable for new panels. You can use this config entry to avoid the transforming of primitive text fonts when changing the primitive text size (=1). As of the WinCC OA version 3.6 the size of the font for primitive texts is scaled when you change the size of a primitive text.

Limitations:

  • The config entry affects the presentation at runtime.
  • The use of this config entry is not supported in GEDI.
  • When using initialZoomFactor, display errors occur.

[ui] compatPanelIdAsTitle

Type
bool
Default
0
Range
0|1
NV compatibility mode. If you set the entry to 1, the parameter "Panelname" will always be used as panel title for the *PanelOn() functions and will therefore be shown in the title bar. In the standard case, the parameter "Panelname" will only be shown as a title if no title was set for the panel in the GEDI.

[ui] compatPanelUpscaleOnDesktop

Type
bool
Default
1
Range
0|1

The config entry "compatPanelUpscaleOnDesktop" can be used to disable panels automatic upscaling in the modules. The config entry affects only Desktop Ui and has no effect on the Mobile Ui.

If set to 0, then the panels upscaling is disabled in the modules.

[ui] confirmCursor

Type
string
Default
(UpArrowCursor)
Name of the pixmap file of the cursor which is shown if the mouse cursor is over an acknowledgeable object in single-acknowledge mode. The format of this entry is: "filename[,x,y]" e.g.: "cursor.png" or "cursor.png,2,2" where x,y defines the HotSpot of the cursor. By default it is in the center. The pixmap file must be located in the pictures directory and the format must be "PNG", "XPM" or "GIF".

Note the following restriction:

Valid cursor sizes depend on the display hardware (or the underlying window system). We recommend using 32x32 cursors, because this size is supported on all platforms. Some platforms also support 16x16, 48x48 and 64x64 cursors.

[ui] connectedShapesColor

Type
string
Default
red
When using the CTRL function connectedShapes() all objects which have an active dpConnect() will be set to a specific color. This entry defines the color to be used.

[ui] connectedShapesTimeOut

Type
int (ms)
Default
2000
When using the CTRL function connectedShapes() all objects which have an active dpConnect() will be set to a specific color (see connectedShapesColor). This entry defines for how long this special color will be shown.

[ui] ctrlDLL

Type
string
This config entry loads a CtrlExtension DLL. First, the DLL is searched in <proj_path>/bin. If it does not exist there, it will be searched in the <wincc_oa_path>/bin. This entry can only be set in the [ui] or the [ctrl] section. If a DLL should be used by the UI and CTRL, this must be loaded in both sections. The number of DLLs to be load is not limited.

Note: It is recommended to load a CtrlExtention DLL directly from the Ctrl script using the #uses statement.

[ui] defaultColorDbFileName

Type
string
Default
colorDB
File name of the color database file, which is read as first.

[ui] defaultFont

Type
string (font)
This config entry is used to determine if the font settings defined inside of the WinCC OA stylesheet should be used. If the font set inside of the object properties matches the font settings specified inside the config entry the stylesheet settings are applied to the object. If the object property settings differ from the defaultFont then the object property settings are used.

[ui] defaultLayoutBottomMargin

Type
int
Default
from widget style
Range
>= 0
Defines the default bottom margin in a layout independently from the widget style (in pixel).

[ui] defaultLayoutLeftMargin

Type
int
Default
from widget style
Range
>= 0
Defines the default left margin in a layout independently from the widget style (in pixel).

[ui] defaultLayoutRightMargin

Type
int
Default
from widget style
Range
>= 0
Defines the default right margin in a layout independently from the widget style (in pixel).

[ui] defaultLayoutSpacing

Type
int
Default
from widget style
Range
>= 0
Defines the default spacing between elements in a layout independently from the widget style (in pixel).

[ui] defaultLayoutTopMargin

Type
int
Default
from widget style
Range
>= 0
Defines the default top margin in a layout independently from the widget style (in pixel).

[ui] defaultPanelFormat

Type
string
Default
PNL
Range
PNL|XML
Defines the standard panel format when creating new panels.

[ui] defaultResolution

Type
integer
Default
300
Default printer resolution in DPI for printing panels or tables.

[ui] desktopUiKeepAlive

Type
bool
Default
1
Range
0|1
To avoid the HTTP connection between a Desktop UI and the server being closed because of inactivity, the Desktop UI sends an HTTP request to the server, if no other HTTP request was sent for a minute. This entry controls this functionality: if set to 1 (default), these additional requests are sent as described above, if set to 0, no additional requests are sent, and the HTTP connection might be closed.

[ui] downscaleOversizedPanel

Type
bool
Default
0
Range
0|1
When opening an oversized panel (larger than the entire desktop in both directions) in a module which is set to some scale mode (which is the default), this config entry can be used to tell the UI to downscale the panel on one side so that it fits entirely in one direction into the module window and gets a scrollbar on the other side. When set to 1, the behavior of the module is then consistent with all panel sizes.

[ui] editShowSelection

Type
bool
Default
0
Range
0|1
Changes the input field operation. Entry into the field via tab will select the entire field for operator deletion or replacement. Available only on Vision.

[ui] fatalDialogSeconds

Type
int
Default
120 (sec)
Range
>= 0
On fatal errors, which lead to termination of the manager, a dialog is shown with the appropriate error message. This config entry defines how long the dialog is shown before it closes automatically (so this is a countdown timer).

A value of 0 disables the dialog completely. On fatal errors no dialog will be shown, and the manager terminates silently.

[ui] focusColor

Type
string (color)
Default
[60,60,60]
Defines the color of the input focus (if showInputFocus = 1).

[ui] focusLineType

Type
string (lineType)
Default
[solid, oneColor, JointMiter, CapButt, 1]
Defines the line type of the input focus (if showInputFocus = 1).

[ui] forcedSourceDPI

Type
int
Default
-1
This entry forces the interpretation of the font sizes in the panels as if they were constructed on a device with the given DPI (dots per inch) setting. The problem which can be solved with this is the following: In the panels the font sizes are stored as points, and not as pixels. 1 point = 1/72 inch, therefore the pixel size = (points / 72) * DPI Thus if the target device has a different dpi setting than the source device, on which the panel was constructed, the fonts get a different size. This is noticeable especially on devices where the dpi setting is very different from the source device, e.g. source = 96 dpi (default on Windows), target = 400 dpi (high dpi screen). With this entry, the UI calculates the font pixel size to how it was on the source device. Prerequisite is, that all panels have been constructed with the same source dpi setting, since this config entry acts on all panels.

[ui] horizontalFontHinting

Type
bool
Default
1
Range
0|1

Specifies whether horizontal hinting is used when drawing text in panels. If set to 1 (default) and the operating system supports it, spacing between single characters is adjusted to improve readability. Using this optimization, it can happen that the width of a text on a panel doesn't change proportionally with its height when zooming or using displays with different scaling. Texts which had the same width on one screen (or zoom factor) can have different widths on a different screen (or zoom factor).

If set to 0, this optimization is deactivated, if possible (not all operating systems support this). Now the proportion between text width and height is preserved as well as possible, but the width of existing texts might change.

[ui] httpProxy

Type
string (url)
Allows the definition of an HTTP Proxy Server, which is used when using the WebView EWO.

Syntax: http://user:password@proxy.server.com:80

User and password specifications are optional.

[ui] httpServer

Type
string (url)

Allows the definition of an HTTP Server, which is used when using the WebView EWO loadSnippet() function or the global function getConfigActiveHttpServerUrl()

Syntax: http://user:password@my.server.com:80

User, password and port specifications are optional.

This config entry can only be used once in the config file.

This config entry must be used when SSA is activated.

When a redundant server is used with SSA, it is sufficient to set this entry to one of the redundant hosts. The hostname in the URL is changed to point to the active server.

[ui] initialZoomFactor

Type
float
Default
1
This factor scales all panels, even childpanels. The limits are according to maxZoomFactor and minZoomFactor.

NOTE: With a definition of an "initialZoomFactor" the Vision opens the module in original size (respectively as defined in ModuleOn(..)) and zooms afterwards.

[ui] loginPanel

Type
string
Default
vision/login.pnl
Range
vision/login.pnl vision/loginUserdefined.pnl
Specifies the relative path for the login panel.

You can use the WinCC OA standard Login panel "vision/login.pnl" or the user-defined Login panel "loginUserdefined.pnl".

For more information on the user-defined login panel, see chapter user-defined login.

[ui] loginPanelLocal

Type
string
Default
login_Standard.pnl
Range
panel
Defines the panel for the local authentication when the login framework (see chapter Login Framework, Basics) should be extended. If the base functionality is not sufficient, both the standard and the server login panels can be replaced via another implementation.

[ui] loginPanelServer

Type
string
Default
login_Server.pnl
Range
panel
Defines the panel for the server-side authentication ( see Server-side Authentication, Basics) when the login framework should be extended. If the base functionality is not sufficient, both the standard and the server login panels can be replaced via another implementation.

[ui] maxZoomFactor

Type
float
Default
4.0
Range
> 0
Upper limit for zooming. As a default a maximum factor 4 is defined (400%). The range is not limited. Note that you do not specify a too high factor (consider which panel you are using).

[ui] middleMousePanning

Type
bool
Default
1
Range
0|1
If the config entry is set to 1, large panels can be moved in Vision by pressing the middle mouse button (panning). If the middle mouse button shall trigger click-scripts then this entry must be set to 0.

[ui] minZoomFactor

Type
float
Default
0.5
Range
> 0
Lower limit for zooming. As a default a minimum factor 0.5 is defined (to minimal 50%). The range is not limited. Note that you do not specify a too low factor (consider which panel you are using).

[ui] modifyGroups

Type
bool
Default
1
Range
0|1
The config entry "modifyGroups" controls if WinCC OA should automatically create and update groups from an external authentication system. For user-defined external authentication, see chapter How to use the User-defined Authentication.

[ui] numPanelBakFiles

Type
integer
Default
1
Specifies the number of backup files when a panel is saved. The entry is important if a version control system is used.

[ui] numRecentPanels

Type
integer
Default
10
Defines the number of panels, which are shown in the recently used panels list in GEDI.

[ui] nvIconBarOn

Type
bool
Default
1
Range
0|1
Hides or shows the icon bar of the module VISION. The command line options -iconBar and -menuBar overwrite the config entries nvIconBarOn/nvMenuBarOn. Thus, when the config entry nvIconBarOn is set to TRUE in the config file but the module is started with the option "-iconBar" (without icon bar), no icon bar is shown for the module.

[ui] nvMenuBarOn

Type
bool
Default
1
Range
0|1
Hides or shows the menu bar of the module VISION. The command line options -iconBar and -menuBar overwrite the config entries nvIconBarOn/nvMenuBarOn. Thus, when the config entry nvIconBarOn is set to TRUE in the config file but the module is started with the option "-iconBar" (without icon bar), no icon bar is shown for the module.

[ui] panelCacheSize

Type
int
Default
-1 (unlimited)
Range
0 .. x
Maximum number of panels in the cache
  • x (x unequal to 0)... cache all panels (except the panels for which the property "Keep in memory" was set to FALSE in the property sheet.)
  • 0 ... do not cache panels (of the whole project). No cache although the property "Keep in memory" would be set to TRUE in the property sheet.
If necessary, the panel with the oldest access time is deleted from the memory.

[ui] panelRefCacheOn

Type
bool
Default
0
Range
0|1
If the config entry is set to 0, the references that were added using the function addSymbol() are deleted from the cache. This means that if a reference is added to a panel and this reference is changed at run time, the updated reference is added when addSymbol() is called. If the config entry is set to 1, the reference is not changed at runtime. Note that the user interface used to open the panel and the graphics editor has to be started with the same number.

[ui] panelVersion

Type
integer
Default
-1
Range
1 .. current panel version
Defines the panel format version for the PNL panel format when creating new panels. The newest version is -1.

[ui] panningCursor

Type
string
Default
(SizeAllCursor)
Name of the pixmap file of the cursor which is shown in panning mode. The format of this entry is: " filename[,x,y]" e.g.: "cursor.png" or "cursor.png,2,2" where x,y defines the HotSpot of the cursor. By default it is in the center. The pixmap file must be located in the pictures directory and the format must be "PNG", "XPM" or "GIF".

Note the following restriction:

Valid cursor sizes depend on the display hardware (or the underlying window system). We recommend using 32x32 cursors, because this size is supported on all platforms. Some platforms also support 16x16, 48x48 and 64x64 cursors.

[ui] pickRange

Type
integer
Default
3
Range
1..1000
Defines the area around an object which is used to detect a click on an object in addition to the true size of the object (in pixel).

[ui] pixmapEditor

Type
string
Default
X11: kolourpaint, Windows: mspaint.exe
Defines the external program which will be used to edit pixmaps.

[ui] projPanelsObjectsFilter

Type
string (project path) string (pattern)
Default
*
Defines a filter pattern, which is used in Project View and in Catalog View to only show those panels in the "objects" directory, which names match this given pattern. This config entry affects all panel files contained in the /objects directory or its subdirectories (recursive). The pattern matching is done according to the CTRL function patternMatch(). The projectpath must match one of the entries in proj_path or wincc_oa_path.

Example: projPanelsObjectsFilter = "/home/projects/myProject" "*test*"

[ui] queryRDBdirect

Type
bool
Default
0
Range
0|1
Indicates the mode of database read queries:
  • 0 = Standard CTRL read functions (dpGet...()) via the WinCC OA Event Manager and the WinCC OA Data Manager.
  • 1 = The standard CTRL read functions (dpGet...()) are redirected to directly contact the database server.
Can be used in [ui] and [ctrl] sections. Note that the two required CTRL extensions must also be loaded in order to be able to use the RDB read functions. 

CtrlDLL = "CtrlRDBArchive"
CtrlDLL = "CtrlRDBCompr"

CAUTION: If you use queryRDBdirect = 1 and query DPEs using the event screen, enter the DPEs or *.* for the query. Otherwise the event screen does not show the DPEs.

[ui] refuseCNS

Type
bool
Default
0
Range
0|1

Specifies if a manager shall hold CNS data of the identification in memory. CNS data is still tranferred with the identification but the manager discards this data.

[ui] restoreFileSelectorGeometry

Type
bool
Default
1
Range
0|1
If this entry is set to 0, the geometry (position and size) of the dialog, which is opened with the fileSelector() CTRL function, will not be restored. This is useful in a multi-monitor configuration, when a panel is opened on different screens, as the file dialog will be opened on the screen of the panel, and will not be moved to the previous position, which might be on a different screen. All other settings will be saved and restored.

[ui] scalePanelsDPIDeadband

Type
float
Default
0.3
Range
>= 0.0
If the difference between the DPI value of the current screen and the one on which a panel was saved lies inbetween the given factor, then the scaling of a panel due to DPI differences will be avoided. E.g. the default value of 0.3 defines a difference of plus or minus 30%.

[ui] scalePanelsPerPhysicalDPI

Type
bool
Default
0
Range
0|1
Setting this entry to 1 automatically scales a panel up or down when the current screen has a different physical DPI value than the one the panel was created on.

[ui] scriptEditorIgnoreLibs

Type
string list
Default
"~*" "*~" ".*" "*.bak"
Defines a list of filter patterns (analogous to scriptEditorParseLibs) which must match to explicitely avoid to parse a script file.

[ui] scriptEditorParseLibs

Type
string list
Default
*
Defines a list of filter patterns, which are checked against the relative paths below scripts/libs/ to define if a matching CTRL library shall be parsed to allow showing its functions etc. in the Script Editor.

Example: scriptEditorParseLibs = "*.ctl" "*.myOldLib"

This config entry can be given multiple times. All entries will be added to one list. The pattern matching is done according to the CTRL function patternMatch(), whereby all checked pathes are relative to the scripts/libs/ directory (e.g. "aes.ctl" or "classes/test.ctl") and the path delimiter is always the Unix "/" path delimiter.

[ui] sendModuleFocusDp

Type
bool
Default
0
Range
0|1
Set this config entry to 1 to activate the sending of data to the datapoint elements _UI_<num>.ModuleFocus.Name and _UI_<num>.ModuleFocus.Geometry (see also chapter INOA%Ui) and to update them whenever the module, which gets the focus, changes. If this config entry is not set or = 0, the data on these datapoint elements is not updated,

[ui] showActiveShapes

Type
bool
Default
1
Range
0|1
If the config entry is set to 1, the cursor is changed over graphics objects which will activate a script when clicked.

[ui] showInputFocus

Type
bool
Default
0
Range
0|1
If activated (=1), you can navigate to the next activatable object using the tabulator key or other defined keys (See config "arrowsAsTab"). The available shapes are complex and primitive graphics objects which have a clicked event and allow focus. The object which currently has the input focus is displayed with a frame around it. The color and the line type can be defined with the config entries "focusColor" and "focusLineType". Only for VISION module. Caution: When showInputFocus is activated, using the "ENTER" key in a Text field will execute both the "clicked" and the "command" event.

[ui] showMaximizeButton

Type
bool
Default
0
Range
0|1
If this config entry is set to 1 the title bar of the panels opened in Gedi will have a maximized button in addition. By clicking this button the panel is shown maximized in the Gedi so that areas in the panel could be edited that are not visible normally. If a panel is maximized only the area that is available in the current Gedi window is used to display the panel. In the case that a panel would be larger when it is not maximized there will be no scrollbars available to see the entire panel. When saving the size of the panel in the non maximized state is taken. If the config entry is set to 0 the button will not be displayed.

[ui] silentPrintWithBorder

Type
bool
Default
1
Range
0|1
Defines whether panels are printed with or without a border. 0 = panel is printed without a border 1 = panel is printed with a border

[ui] soundClick

Type
string
Range
*.wav
Defines a sound file which will be played on a single click or on activation of an action. The wav file has to be located in the project directory data/sound or data/ (see also enableSound()).

[ui] soundDblClick

Type
string
Range
*.wav
Defines a sound file which will be played on a double click script activation. The wav file has to be located in the project directory data/sound or data/ (see also enableSound()).

[ui] soundRightClick

Type
string
Defines a sound file which will be played on a right click script activation. The wav file has to be located in the project directory data/sound or data/ (see also enableSound()).

[ui] startCloseScriptsOnQuit

Type
bool
Default
1
Range
0|1
If this entry is set to 0, no close script of open panels will be started when the UI manager is about to quit. This prevents that panels can not be closed when e.g. the connection to the event manager is already closed but the panel close script wants to close itself with PanelOff() (dpSet of internal DPEs). If a panel cannot be closed, the UI manager will also not terminate.

[ui] strictAddressing

Type
bool
Default
0
Range
0|1
Defines whether addressing of objects in panels is done in "strict mode" (1) or in the old "legacy mode" (0). Note: After setting this entry old panels, that depend on the legacy mode behavior, may not work anymore.

[ui] subprojectsWritable

Type
bool
Default
1
Range
0|1
The value 1 defines that panels, scripts or message catalogs, which were loaded from a subproject, can again be written back into the original subprojekt. The value 0 defines all subprojects to be non-writable and therefore files can only be written to the final project.

[ui] touchDetectionDistance

Type
int
Default
8
Range
>0
This distance, defined in millimeters, defines how far a finger has to be moved on the screen at minimum within the touchDetectionTimeout, to decide if a multi finger gesture was started.

[ui] touchDetectionTimeout

Type
int
Default
200
Range
>=0
This timeout, defined in milli seconds, defines how long the UI waits for more touch events, after a touch sequence has been started, to decide if a multi finger gesture was started.

[ui] trendEnableCurveRulers

Type
bool
Default
0
Range
0|1
Defines whether a trend object may set curve rulers

[ui] trendEnableToolTips

Type
bool
Default
1
Range
0|1
Defines whether a trend object may show tooltips.

[ui] trendGetDataTimeout

Type
int
Default
500
Range
>=0
Defines a time (in milliseconds) which must elapse after a change in the displayed timerange in a trend, before data will get fetched from the database.

[ui] trendHorizontalScaleText

Type
bool
Default
0
Range
0|1
Defines the direction of the legend text on the value scale, which are positioned left or right of the trend area (default 0 = vertical). Scales with top or bottom arrangement have always a horizontal legend text. This setting has no effect on the time scale.

[ui] trendInvalidColor

Type
string (color)
Default
magenta
Specifies the color for a trend curve when the invalid bit is set for the displayed datapoint. This entry is also set in the standard _invalid rule (see trendStatusPattern).

[ui] trendInvalidFillType

Type
string (fillType)
Default
[hatch,[cross,10,left]]
Specifies the fill type for a trend curve when the invalid bit is set for the displayed datapoint. This entry is also set in the standard _invalid rule (see trendStatusPattern).

[ui] trendInvalidLineType

Type
string (lineType)
Default
[dotted, oneColor, JointMiter, CapButt, 0]
Specifies the line type for a trend curve when the invalid bit is set for the displayed datapoint. This entry is also set in the standard _invalid rule (see trendStatusPattern).

[ui] trendLegendStyle

Type
int
Default
1
Range
0|1
Defines the style of the trend legend.
  • 0 = show curve sample and curve name
  • 1 = show no curve sample; show curve name in curve color and curve value

[ui] trendPseudoLineFillLikeCurve

Type
bool
Default
0
By default the pseudo line will be drawn as simple line from the last known value of a datapoint element until the first new value but without any filling, even if the curve itself defines a filling. With the config entry trendPseudoLineFillLikeCurve = 1, the filltype of the curve will be used.

[ui] trendPseudoLineStyleLikeCurve

Type
bool
Default
0
Defines the line type of the trend pseudo line. With the entry trendPseudoLineStyleLikeCurve = 1 the line type of the pseudo line will use the line type of the trend curve. By default the pseudo line will be drawn from the last known value of a datapoint element until the first new value with the "dash-dot-dot" line type with 1 pixel width.

[ui] trendRulerColor

Type
string (color)
Default
{0,0,0}
Specifies the color for the trend ruler. No color names are allowed but only an {R,G,B} value.

[ui] trendRulerLineType

Type
string (lineType)
Default
[solid, oneColor, JointMiter, CapButt, 0]
Specifies the line type for the trend ruler.

[ui] trendStatusPattern

Type
string (pattern) string (color) string (lineType) string (fillType) [string (msgCatKey) [string (icon)]]
Default
"_invalid" "magenta" "[dotted, oneColor, JointMiter, CapButt, 0]" "[hatch,[cross,10,left]]"
Defines a list of patterns (multiple times definable config entry). During runtime the list will be checked with the current status of a value displayed in the trend. When a matching pattern is found, its properties will be used for displaying the trend curve. In case of not defining an own rule, there is a default pattern, which matches against the _invalid status. The properties of this default rule can be defined with the "trendInvalid(Color/LineType/FillType)" config entries. The properties of a pattern definition (color, lineType, fillType) can be left empty (empty string) - so the settings from the curve itself will be used. The value of 'pattern' defines a rule for the status of a value. All WinCC OA status attributes can be used. The following syntax must be used to define a matching rule: 

'attribute[=0|1][,...]'

This means you can define an arbitrary number of attributes whereby all definitions in a pattern must match that a rule can be used.

Example:
  • _invalid ... The status _invalid must be true.
  • _invalid=1 ... The status _invalid must be true.
  • _invalid=0 ... The status _invalid must be false
  • _invalid=0, _userbit1=1 ... The status _invalid must be false and the status _userbit1 must be true.
  • _userbit1=0, _userbit2=1 ... The status _userbit1 must be false and the status _userbit2 must be true.
By default the trend function draws invalid values of a curve dotted and purple. This type of displaying can be deactivated by setting the following config entry: 

trendStatusPattern = "_invalid=1,_invalid=0" "" "" ""
The entry 'msgCatKey' defines a key for the message catalog "quality.cat" which can be created in the project. This message catalog holds a short text for each defined key, which will be displayed in the trend ruler value window if the status of a value on a curve for the currently selected timestamp matches this 'pattern'. The entry 'icon' defines a relative pathname to an icon file below the pictures directory, which will be displayed as marker on the trend curve when this pattern matches.

Note: It has to be considered that a lineType must be stated otherwise the config entry cannot be correctly applied.

[ui] useElemNameForReadRequest

Type
int
Default
1
Range
0|1
When a DP Identification is missing for a DB query, the query does not stop but instead uses the ElementName for continuation, if useElemNameForReadRequest is set to 1. A value of 0 indicates that if the DP identification is missing the query is aborted.

[ui] useExtendedAlarmHandling

Type
bool
Default
0
Range
0|1
Provides the extended parameterization of continuous alert handling. See chapter Extended alert handling of continuous values.

[ui] useLocalIdentification

Type
bool
Default
0
Range
0|1
Specifies whether a manager should read the identification (TypeContainer and DpIdentification) from a local file or gets it from the Data Manager. When finishing, the Id is saved in the proj_path/data/DpMsgTypeContainer.bin and proj_path/data/DpMsgIdentification.bin files. If the files do not exist in spite of this entry, the manager starts normal and gets the identification from the Data Manager. The entry can be set in all sections of the config file

[ui] userDefinedCatalog

Type
string
Default
catalog path
Allows to the define custom symbol catalogs. For the entry the path of the catalog folder must be stated (relative to the /panel directory). All panels within the stated folder are added to a custom catalog inside the GEDI. Please note that objects inside sub folders are not added to the catalog. For these folders separate entries must be created.

[ui] usesTouchScreen

Type
bool
Default
0
Range
0|1
If this entry is set to 1, the UI is set to Touch Screen input mode, which means that in general mouse clicks will be ignored and the UI only reacts to touch input events. (Mouse-events and touch-events are separate events but the processing of both sometimes contradict each other with regards to the way of operation. Therefore this config entry switches between either touch or mouse input only)

[ui] useStylesheets

Type
bool
Default
1
Range
0|1
Defines if stylesheet files are loaded for the UI.

[ui] versionControl

Type
string
Range
>VCS name<
This config entry is used to check if a VCS (version control system) shall be activated. There can be a script for each VCS and the name must be exactly the name defined as value of the config entry. The WinCC OA package contains the scripts for the implementation of CVS, SVN and Git. E.g.: "CVS.ctl" --> config entry: versionControl = "CVS"

[ui] versionControlDiff

Type
string
Range
>path</>Diff tool name<
This config entry is used to, in conjunction with a VCS, define a program to compare two files. E.g.: Using the "TortoiseUDiff" tool --> versionControlDiff = ">TortoiseSVN Pfad</bin/TortoiseUDiff.exe"

[ui] visionResizeMode

Type
string
Default
Scale
Range
Zoom, Scale, None, FitSmallPanel, FitToModule
  • "Scale" - You can resize the module freely. The panel scales and a scrollbar will be shown at the shorter module side.
  • "Zoom" - You can resize the module freely. The panel size will not be changed. You can change the size of the panel only by using the zoom functions (CONTROL function ZoomModule(), the toolbar options such as Zoom in and out of the module VISION or the zoom navigator).
  • "None" - The module will be adapted to the panel size and cannot be resized.
  • "FitSmallPanel" - The size of the module will not be adapted. The panel is opened in the original size. Scrollbars are used. The panel size will not be changed when the module size is changed manually.
  • "FitToModule" - You can resize the module freely. The panel scales but in a way that scrollbars will never appear. The whole panel will always be completely visible.

[ui] visionScreenMode

Type
string
Default
all
Range
noTitleBar, noMenu, all
Spezifies whether a panel in VISION is displayed with or without title bar (full-screen mode). One of three options can be set:
  • "noTitleBar" ... title bar is not shown (full-screen mode)
  • "noMenu" ... title bar is shown but without Minimize, Maximize and Close buttons.
  • "all" ... title bar is shown with all its standard buttons

[ui] vtMixComprAndCurrentValues

Type
bool
Default
1
Range
0|1
Specifies whether the curves of a variable trend show compressed values only or they are mixed with current values.

1 = Default. The curve shows mixed values. After the last compressed value (these are only shown in minute cycles, hour cycles, etc.) the current value is drawn.

0 = The curve shows compressed values only. Nothing is drawn between the cycles (not even the actual value).

[ui] wmfWinPainter

Type
bool
Default
1
Range
0|1
For Windows only. If the value is set to 0, the rendering of WMF pictures will use the WinCC OA own implementation, otherwise the Windows native functions will be used.

The advantage of the Windows native functions is the 100% correct rendering of all WMF and EMF images.

The advantage of the WinCC OA own implementation is the fast speed and lesser memory consumption. Although not all WMF rendering operations are fully supported or might not be rendered correctly. Also, the EMF rendering is only implemented partially.

Note: SVG as an official standardized vector format shall be used instead of the Microsoft proprietary formats WMF/EMF/EMF+

[ui] xpmTransparentColor

Type
string
Default
_3DFace
Range
color string
Each bitmap which contains the color of this config entry should be displayed as transparent. The entry is a color string.

NOTE: For true transparency an image format should be used, which supports transparency, like PNG or GIF