Open Diagnosis

What it is and what it's for

Open Diagnosis is an Interactions-category behavior that runs only on the exported, running page when the user clicks the shape. It asks the HQ VISU host to open its device diagnosis popup, so an operator can click a device icon on a screen and bring up that device's diagnosis/status window. The behavior does not draw a window itself; it hands a small payload to the host, and the host opens the diagnosis view using its own popup template. Note: it relies on the host popup protocol, so it only works when the page runs inside the HQ VISU host. Opening the exported file directly in a plain browser will not show the diagnosis popup.

How to use it: the editor fields

In the behavior editor, besides the shared Definition and Condition, you fill in the Popup Target group. These four target fields are JavaScript string expressions (use a literal, or build a value dynamically). The labels shown in the editor map to the payload field names the host receives as follows:

• Definition: setup logic. Read tags or define variables here for the fields below to use (e.g. var dev = 'F01';).
• PLC: the target PLC / station name (payload PLC). Default 'PLC'.
• Template (payload ID): the diagnosis popup identifier; the popup title normally shows this ID. Default 'device-default'.
• Status Prefix (payload DiagnosisControl): the host popup template name, deciding which diagnosis template opens. Default '' (empty).
• Title (payload GroupRightIndex): a tag-tree prefix, not the full tag name; the host appends the template's suffix to build the final tag. Default 'ObjectName'.
• Condition (payload Enabled): the run gate; true runs the behavior, false means a click does nothing. Default true.

// Definition
var dev = 'F01';

// Target fields (string expressions)
PLC:           'PLC1'
Template(ID):  dev          // popup title shows F01
Status Prefix(DiagnosisControl): 'device-default'
Title(GroupRightIndex):          'AAA.bb'   // prefix only
Condition(Enabled):             true

// At runtime this is equivalent to:
qtedit.openDiagnosis({
  PLC: 'PLC1', ID: 'F01',
  DiagnosisControl: 'device-default',
  GroupRightIndex: 'AAA.bb'
});

When to use it

Typical case: on a device-overview or process screen, bind Open Diagnosis to each pump, valve, or motor icon so an operator can click an icon and pop up that device's diagnosis/status window to check live bits, alarms, and parameters without switching to a dedicated diagnosis page. You can also drive the target dynamically from Definition, e.g. build the ID and prefix from the currently selected device number so one template serves many devices.

Boundaries and common mistakes

A few things to watch for:

• Title / GroupRightIndex is only a tag-tree prefix, not the full tag name. The host builds the final tag as PLC + prefix + the template's suffix, e.g. PLC1 + AAA.bb + Run gives PLC1.AAA.bb.Run; putting a full tag in the prefix produces a wrong tag.
• The editor labels (Template / Status Prefix / Title) are not the same words as the payload names (ID / DiagnosisControl / GroupRightIndex); use the mapping above when debugging.
• The four target fields are string expressions: quote literals (e.g. 'PLC1'); only use a bare name for a variable (e.g. dev).
• If Condition / Enabled is false, a click does nothing; check it first when 'clicking opens no popup'.
• The popup is opened by the host, so it only works if the host has the matching diagnosis template (DiagnosisControl) configured; it has no effect outside the HQ VISU host.