cliu
84181711b8
- Summaries of IM 36K10R10 (CI Portal Setup) and IM 36K10R20 (Setup File Editor), checked against the installed setup files and the Setup File Editor GUI - New skill portal-setup: read a setup file, check web access for CI View, change a setup file safely (verified with a port change and restore) - Manual vs software differences logged as ISS-012 to ISS-017; installed software taken as the reference Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
62 lines
2.2 KiB
Markdown
62 lines
2.2 KiB
Markdown
---
|
|
task: Read a setup file (active settings and keyword help)
|
|
version: R1.03
|
|
source: IM 36K10R20-01EN §1, §3; IM 36K10R10-01EN §4; practiced on the test system 2026-09-30
|
|
status: verified (read-only)
|
|
---
|
|
|
|
# Read a setup file
|
|
|
|
Shows what the Setup File Editor would show, without opening it. Nothing is changed.
|
|
|
|
## Where
|
|
|
|
`%TLS_ROOT_PATH%\tls\sup\<name>.sup` (e.g. `C:\Program Files (x86)\Yokogawa\CIServer\tls\sup`).
|
|
The file list with descriptions is what the Setup File Editor shows on start.
|
|
|
|
## Active settings
|
|
|
|
Lines that do not start with `!` are the settings in use:
|
|
|
|
```powershell
|
|
$f = Join-Path $env:TLS_ROOT_PATH 'tls\sup\wflidi.sup'
|
|
Select-String -Path $f -Pattern '^\s*[^!\s]'
|
|
```
|
|
|
|
Example result (`wflidi.sup`, installed defaults): `FLOW_CONTROL = 30`, `TIMER = 20`,
|
|
`SCAN_TIME = 0`, `RETRY_COUNT = 3`, `QUEUE_BUSY_LEVEL = 10`, `DUR_QUEUE_SIZE = 500`,
|
|
`NODE = -1, 1000, 0.1, 30`, `LOCK_TIMEOUT = 60`.
|
|
|
|
A keyword that has no active line uses the program's built-in default (see its help).
|
|
|
|
## Meaning of a keyword
|
|
|
|
Each keyword is described in a `!KEYWORD : …` block: label and unit (`!ARG1 = label,unit`),
|
|
type (`!KIND`), limits (`!OPTIONS`) and help (`!HELP`/`!KEYHELP`). Show the block:
|
|
|
|
```powershell
|
|
Select-String -Path $f -Pattern '^!KEYWORD\s*:\s*TIMER\b' -Context 0,10
|
|
```
|
|
|
|
For `TIMER` this shows label *Clear cache after*, unit *sec*, kind *number*, option *pos*.
|
|
|
|
## Tabs and description
|
|
|
|
```powershell
|
|
Select-String -Path $f -Pattern '^!(DESCRIPTION|TAB)\s*='
|
|
```
|
|
|
|
`!TAB` lines give the editor's tabs; a keyword belongs to the last `!TAB` above it.
|
|
Keywords before the first `!TAB` appear on a *General* tab in the editor (checked on
|
|
`wfla_display.sup`). Active values that differ from the `!DEFAULT` block show as Status
|
|
*Changed* in the editor.
|
|
|
|
## Notes
|
|
|
|
- Use the Setup File Editor tabs and labels when talking to the user; the keyword names are
|
|
what is in the file. Keyword tables for the user-interface files are in
|
|
`knowledge/manuals/IM36K10R10-01EN.md` §4.
|
|
- Trust the installed file over the manual. The alarm item/display relation file is
|
|
`wfla_display.sup` (the manual says `wfla_displays.sup`), and some installed values differ
|
|
from the manual's defaults (see `knowledge/issues.md` ISS-012 to ISS-015).
|
|
- Some files have no `!DESCRIPTION`.
|