Wizard Framework, Details
Internal Data Point Structure
_WizardFramework
Für jeden Wizard wird ein Datenpunkt vom Typ _WizardFramework erstellt. Dieser Datenpunkt enthält alle notwendigen Informationen zur Verwendung eines WinCC OA Wizards.
| DPE | Typ | Beschreibung |
|---|---|---|
| FullName | langString | Wird in der Titelleiste des Wizards angezeigt. Bleibt dieser Eintrag leer, wird der Wizardkey angezeigt. |
| WizardKey | string | Dieser Key wird für die Navigationspunkte verwendet und muss für jeden Wizard eindeutig sein. This key is used for the navi points and must be unique for every wizard. Pictures for the navi points must be stored in /pictures/<WizardKey>/navi. |
| Description | langString | Wird momentan nicht verwendet. Die Beschreibung soll als Tooltip für den entsprechenden Wizard im Systemmanagement angezeigt werden. |
| PanelEnable | bool | Zeigt ob der Wizard aktiv oder inaktiv ist. Dieses Element darf nicht konfiguriert werden. |
| Navi.Keys | dyn_string | Jeder Navigationspunkt hat einen eigenen Key. Das entsprechende Icon wird Each navi point has its own key. The respective icon is shown due to this key. The icons must be stored under /<Wizardkey>/navi/<NaviKey. If the icon does not exist, an error message is displayed in the notification bar and the default icon is used. Note that you must not use any characters for the name which are not allowed by the operating system. |
| Navi.PanelsPath | dyn_string | Das hier definierte Panel öffnet sich wenn auf den entsprechenden Navigationspunkt geklickt wird. Es muss der relative Panelpfad angegeben werden. Existiert das Panel nicht wird eine Warnung in der Notification Bar ausgegeben. |
| Navi.Dollars | dyn_string | Dollarparameter welche beim Öffnen des Panels übergeben werden. Es ist möglich mehrere Parameter zu übergeben. Hierbei dient das erste Zeichen als Separator. Beispiel: |$Dp1:a|$Dp2:b|$Dp3:c … in diesem Fall ist die Pipe | das Trennzeichen. |
| Navi.Names | dyn_langString | Text der unter dem Icon des Navigationselements angezeigt wird. |
| Navi.Descriptions | dyn_langString | Beschreibung der Navigationselemente als Tooltip. |
| Navi.ViewPermissions | dyn_int | Definiert das benötigte Benutzerbit um den entsprechenden Navigationspunkt zu aktivieren. |
| Navi.HelpKeyWord | dyn_string | Definiert das Keyword für den Hilfe-Button. Ist kein Keyword bzw. ein nicht existentes Keyword definiert, wird der Help-Button nicht angezeigt. Das Keyword muss im Keyword.txt definiert werden (< wincc_oa_path >/data) Per Default wird die "WinCC_OA_Help.chm" Datei aufgerufen, durch Verwendung der Pipe kann aber auch eine benutzerdefinierte chm-Datei verwendet werden. Beispiel: wizard1_panel1|custom_help.chm |
| Navi.Functions.Save | dyn_string | Diese Funktion bzw. dieses Script wird durch Klicken auf den Übernehmen-Button aufgerufen. Es wird auch aufgerufen wenn der Wizard geschlossen wird, ohne Änderungen zu übernehmen (der Dialog (Möchten Sie die Änderungen übernehmen? wird angezeigt). Die Funktion wird nur aufgerufen wenn die IsChanged Funktion ausgeführt wird und WF_PANEL_CHANGED zurückliefert. Beispiel: #uses "std.ctl" int main(){cns_savePanel(); return 0;} |
| Navi.Functions.IsChanged | dyn_string |
Diese Funktion bzw. dieses Script wird aufgerufen wenn der Wizard geschlossen oder ein anderes Navigationselement geöffnet wird. Es wird überprüft ob irgendwelche Änderungen vorgenommen wurden. Beispiel: #uses "wizardFramework.ctl“ int main(){return WF_PANEL_NO_CHANGE;}
- WF_PANEL_NO_CHANGE ... no changes - WF_PANEL_CHANGED ... changed |
| Navi.Functions.MenuPointClick | dyn_string | Diese Funktion bzw. dieses Script wird durch Klicken auf einen Navigationspunkt aufgerufen. |
_NotificationBar
| DPE | Type | Description |
|---|---|---|
| Msg.Catalog | string | Message catalog in which the notification texts are defined |
| Msg.Key | string | Message key of the notification |
| Msg.Code | string | Message code which is displayed in the log viewer. If it is not existent in your message catalog or the notification message catalog, it is taken from the _errors.cat. Please note that _errors.cat is a WinCC OA standard file and must not be configured. If the message is not found in any of the catalogs, only the keyword is displayed. |
| Msg.Prio | int | |
| Msg.Params | dyn_string |
Priority of the message: INFO (constant NOTIFICATION_BAR_PRIO_INFO) WARNING (constant NOTIFICATION_BAR_PRIO_WARNING) SEVERE (constant NOTIFICATION_BAR_PRIO_ERROR) FATAL (constant NOTIFICATION_BAR_PRIO_FATAL) |
| Msg.ShwoInPanel | string | If set true, the message is only shown in the notification bar of this panel and the root panel does not display a message. If it is false, the message is shown in all panels. |
| Settings.MinPrio | int | Defines from which priority messages are displayed in the notification bar. |
| Settings.ShowPublicMsg | bool | Not in use. |
| Settings.ShowInLogView | bool | Display the message in the log viewer. |
| Settings.EnabledManIds | dyn_int | Message is only displayed on the given manager IDs (the entire manager ID must be defined). |
