ci-server-engineer/knowledge/manuals/IM36K10C50-01EN.md
cliu 83af63ab53 R1.05 re-check batch 2: graphics, history, portal, system-management, items
Full manual diffs (C50, R30, C60, L20, C40, L35, R10, R20, J10, L30, L50,
P30, G10, C10) and read-only checks on the shared R1.05 test server where
the permission system allowed them. Skills and summaries moved to R1.05.
Issues ISS-092..129 (gaps 104-107, 114-115, 130-131 unused); ISS-074
closed (manual and software agree), ISS-091 corrected by ISS-119.
version-differences: unlisted manual changes and installed-only changes.
r105-verification: V5-V9 and new not-tested rows.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-08 19:29:15 +11:00

162 lines
11 KiB
Markdown

---
manual: IM 36K10C50-01EN
title: Edit Module
edition: 5th Edition, Feb. 2026 (R1.05); first summarised from the 3rd Edition, Sep. 2023 (R1.03)
version: R1.05 (first written for R1.03)
status: R1.05 re-check 2026-10-08 - full text diff R1.03 → R1.05 reviewed (section "Changes in R1.04 and R1.05"), from docs; nothing re-tested on the R1.05 test server (shared, no displays may be changed). R1.03 results - display CIENG_Tank built by the user in the Edit Module (text, number field, alarm overview, trend) and checked as XML and HTML 2026-10-01; jwuiutl search, validate and HTML export verified; trend settings (§2.27) tested one by one on CIENG_TrendLab 2026-10-02 (skill graphics, tasks/trend.md); generated sample displays (CIENG_*, most components: shapes, arc, text, number/text/date-time fields, buttons, toggle, check box, slider, spinner, combo box, data bar, scales, alarm overview, report, micro trend, trend) checked on desktop and web 2026-10-06; symbols, other actions and the tutorial from docs
---
# Edit Module (R1.05)
The Edit Module draws displays and symbols for the Operator Interface (desktop) and the HTML
display. Displays are XML files (`IM36K10R30-01EN.md` §1). Section numbers refer to the manual;
the numbering is the same in R1.03 and R1.05 (§2.31 is now titled *Generic Functions*).
## 0. Changes in R1.04 and R1.05 (from docs, full text diff 2026-10-08)
Listed in the revision table: R1.04 §2.22 (alarm overview properties), §2.31 (*Password Check*),
§4.12 (update item/parameter); R1.05 §2.22, §2.25, §2.26, §2.33 (properties), §2.31 (*RDP
Connect*). The diff found these, including edits the table does not name:
- §1.5 `jwuiutl -m` / `-M`: output described as space-separated instead of CSV; cross-reference
"previous section" → "next section" (wording). *(not in the table)*
- §1.7: the note "HTML display is not supported for enterprise operations" was removed.
*(not in the table)*
- §2.22 Alarm overview: *[Acknowledgement]* category - *Use Custom Acknowledgement* (acknowledge
from a separate user-made window) enabling *Acknowledge Event* (pulses TRUE), *Acknowledged
Alarm* / *Text* / *Time*; *Selected Alarm Key*; *[External Acknowledgement]* *Alarm Key*,
*Approver*, *Reason*, *Trigger*; *[Enterprise Alarm Locations]* *Alarm Source Locations[nn]*.
- §2.25 Dataset tables: column *Icon*, *Icon filter* (match, not-match, bitwise AND),
*Icon tooltip*; operator column sorting; single / multiple row selection; *[Enterprise
Dataset Locations]*; enterprise location now supported on the HTML display. Example filters
use `ACTION_TIME >=`.
- §2.26 Report: *[Enterprise]* primary / secondary data location (supported on the web).
- §2.27 Trend: *Enterprise* property now supported on the HTML display. *(not in the table)*
- §2.31 *Calculation/Function* renamed **Generic Functions**; execution timing documented
(Date and Time 200 ms; other operations on input change, polled every 100 ms, and at display
load/reload) *(timing not in the table)*; **Password Check** (T[I1] user, T[I2] password →
B[O], T[O] user name or the DSS error; needs login method *Manual CI Server* or *Manual OS*
for the Password Check function in `dssana.sup`, *Login control*); **RDP Connect** (T[I1]
host, optional T[I2] RemoteApp, T[I3] its arguments, T[I4] RD Gateway `host[:port]`; writes an
`.rdp` file, name to T[O]; installed `tls\com\connectrdp.cmd`).
- §2.32 JavaScript Function: inputs polled every 100 ms, script also runs at display
load/reload; the `io` object is described as implemented in Java. *(not in the table)*
- §2.33 Web Browser: new engine (WebRTC, HTTPS, WebSocket, HTTP/2, HTTP/3; VP8/VP9/WebM,
Opus/Vorbis/PCM; *Media player* wording removed); content from R1.04 or earlier may not play
after upgrade; right-click menu; new *[Printing]*, *[Status]*, *[Security]* properties
(*Enable Microphone/Camera*, *Allow Insecure Certificates*, *Allow Local file access*; local
files for CI Mobile View go under `%TLS_ALLUSERS_PATH%\wap`).
- §2.36 Display generator: the note "not supported on HTML displays" was removed. *(not in the
table)*
- §2.37 Map viewer: wording of centre latitude/longitude (decimal fractions), click
information cross-references. *(not in the table; same meaning)*
- §4.12 Actions sheet: *Update item/parameter* can record **Reason** (≤ 256 characters) and
**Approver** (≤ 128) in `AUDIT_TRAIL` (`APPROVAL_REASON`, `APPROVER`); values can be offered
from user-defined parameters; two recipes for alarm acknowledgement with reason/approver
(item parameter with attribute *Acknowledged*, item alarms only; or the overview's
*External Acknowledgement* properties, item and external alarms).
Practical notes for the skill: `.claude/skills/graphics/tasks/create-display.md` (section R1.05).
## 1. Window and files (§1)
- Window: sheets, component bar, graphic sheet, symbols sheet, menu, toolbar, edit area.
- *File > New Display* (Ctrl+N), *New Symbol* (Ctrl+Shift+N), *Save* (Ctrl+S), *Save with
Revision Information* (who/when/why, kept in `revisionHistory`), *Save As*, *Save Selection
as* (new symbol or display), print area, print. Open displays are locked (`<name>.lck`);
autosave writes `<name>.xml.autosave`.
- *Edit > Find* searches the open display; `jwuiutl -m` searches all.
- **HTML display** check box (new display dialog / display properties): the editor then offers
only HTML-supported components, properties and actions, and saving also writes the HTML file.
HTML mode can be switched off later. Not for enterprise displays. The tab icon shows normal /
HTML / HTML with unsupported content.
- Localisation: *Tools > Configure Localization* → *Extract Text*, add locale, translate;
global and per-file tables; the operator's locale decides.
- *Playback > Record* records operator/editor sessions; *Open viewer* plays them back.
## 2. `jwuiutl` — batch operations (§1.5)
`jwuiutl.cmd` (in `tls\com`, Java; runs from a normal prompt):
| Option | Use |
|---|---|
| `-d` / `-s` | Only displays / only symbols (`-p <palette>`, `-g <group>`) |
| `-v` | Validate (connected items exist, components defined); report only. `-l <file>` writes the result, `-i` shows progress (`Validating <name>` / `Info: No problems found`) |
| `-vf` | Force validation and **save** every display/symbol |
| `-u` | Unlock locked files (`.lck` left by a crashed editor) |
| `-c` / `-a` | Clean up temporary files / validate + unlock + clean up |
| `-m <terms>` / `-M <terms>` | Print matching components (CSV) / with actions and properties |
| `-e HTML [-o <dir>] [-f <deployment>] [<display>]` | Export HTML displays |
| `-b`, `-z`, `-h true/false` | Also save `.xml.bin` (faster loading) / compressed / set HTML mode |
| `-un`, `-pw` | User for enterprise displays |
| `-t`, `-?` / `--help` | Debug trace / print the option list (read-only) |
R1.05: the option list in the manual is unchanged; the installed help text on the R1.05 test
server was not compared yet (awaiting user verification, ISS-094).
**Verified on the test system:** `-d -m TANK1` and `-d -v -i -l` ran without errors; locked
displays and displays saved by a newer version are skipped (`*** Display locked <name>`,
`… created with a newer version of CI Server (R1.04.0.0)`); `-e HTML -i -f DEPLOY CIENG_Tank`
wrote `mobileoperator\operatorInterfaces\DEPLOY\displays\CIENG_Tank.html`. 2026-10-06: `-v` with
a display name also **re-saved** that display (normalised XML, same content; skill `graphics`,
`tasks/deploy-displays.md` §2).
## 3. Components (§2)
Shapes (rectangle, ellipse, arc, polygon, spline, line, links), text / text field / text area
/ password field, number and number field, icon, rectangular and circular scales, radial, data
bar, spinner, slider, push/toggle button, check box, radio button, combo box, list box, date
and time field, **alarm overview** (current/historical; acknowledge, block, shelve, link display,
export; dialog tabs Types, Columns, Filter, Alarm link display, Appearance, Header and footer,
Fetching, Alarm Shelving, Enterprise, Advanced, Attributes), list of blocked items, alarm
sound, dataset tables (view/edit dataset records), report, **trend** (pens on items with
history; shows limits; time slider and controls; definitions can be saved from the operator
interface; every setting tested in skill `graphics`, `tasks/trend.md`), DTS trend, micro trend, playback indicator, Generic Functions (R1.03: calculation/function;
§0), JavaScript function, web browser, PDF viewer, navigation tree, display generator, map viewer.
## 4. Sheets (§4)
Visualization (displays/symbols tree), zoom, visibility groups (shown by zoom factor),
**parameters** (default read-only ones such as `name`, `attachedObject`, `client`, `server`,
`mouseX`; user-defined with scope; `$name` in command lines), messages, symbols, **properties**
(connect a property to an item attribute, parameter or dataset field; linear transformations;
writable properties: value, item name parts, id, units, description, status number/text,
control status, option bits), layers, attributes, edit history (undo/redo), **actions** (open /
close display, execute command, read/write parameters; triggered by component events).
Open-display action (verified): `<action type="actionActivateDisplay">` with
`<type type="displayActivationType" value="ActivateSpecific"/>` (factory files also use
`ActivateReplace`), `<display>`, optional `<layout>` (empty = current window) and `<layoutFrame>`,
plus `<parameter>` entries for display parameters. Layout commands from a component:
*Execute command* `ACTION <command>` (e.g. `ACTION navigate back default`). A trend property
connected by mistake (`chart.attribute[00]` -> item) makes the Operator Interface show
*Short attribute name ... is invalid* when the display opens; remove the connection.
## 5. Symbols (§5)
*File > New Symbol*; put it on a palette (attributes sheet); external user-defined parameters
become properties of each instance; after changing a symbol run *Tools > Validate all
Symbols* and *Validate all Displays* (with all tabs closed); a symbol can be linked to a
PROCESS Service class so each instance shows one object; data location (display, operator's
CI Portal, display's server, enterprise, node).
## 6. What the display file stores (verified with CIENG_Tank, removed from the sample 2026-10-06)
- `<coreObjectDefinition type="displayDefinition">` with `<html>true</html>`, `<width>`,
`<height>`, grid, revision history, visibility groups, layers.
- Components as elements (`text`, `numberField`, `alarmOverview`, `chart` = trend).
- Item connections in `<globalSection>`: `<itemName>CI-Eng-Sample.TANK1.LEVEL</itemName>` **and**
`<itemId>1.1.248.0.0.1.1.7</itemId>`. Trend pens: `<source uri="ci:/item/<item>"/>`; a new
trend has 5 empty pens.
- **After a sample remove/reload the item got id 268** while the file kept 248: `jwuiutl -v` still
reported *No problems found*, and a newly opened session showed the live value — the name is
what counts. Sessions that were already open kept the old binding (value frozen) until the
display was opened in a new session.
- Rules for writing display XML directly (text size, rounding, arc angles, item attributes for
the web, server-side commands, alarm overview columns): skill `graphics`,
`tasks/create-display.md`, verified 2026-10-06 with the generated `CIENG_*` displays.
## 7. Tutorial (§6)
Builds wheels, faceplates, valve symbols, indicators, PID faceplates with mode and setpoint
dialogs, scales, limit colours, tag info and pinning buttons — a guided exercise in the GUI.