diff --git a/docs/ci-server-document-map.md b/docs/ci-server-document-map.md new file mode 100644 index 0000000..8b6edce --- /dev/null +++ b/docs/ci-server-document-map.md @@ -0,0 +1,114 @@ +# CI Server Document Map (EN) + +| | | +|---|---| +| **Software** | Yokogawa CI Server **R1.03** (R1.03.00 or later) | +| **Documentation set** | English manuals, editions dated Sep. 2023 (see Edition column) | +| **Source** | `ciserver.pdf` (English page) in the documentation folder | + +> [!IMPORTANT] +> **Documentation location is machine-specific.** +> The links below point to the default location on the machine where this map was written: +> `C:\Users\Public\Yokogawa\tls\doc\EN\` +> +> The PDFs are **not** stored in this repository. If your CI Server documentation is installed +> elsewhere, the links will not open. Look up the manual by its **IM number / file name** +> (e.g. `IM36K01C10-01EN.pdf`) in your own `...\doc\EN\` folder, or find-and-replace +> `file:///C:/Users/Public/Yokogawa/tls/doc/EN/` in this file with your local path. +> +> If your installed CI Server release is not R1.03, check that your manual editions match the ones listed here. + +## Read Me First + +| Document | IM Number | Edition | +|---|---|---| +| [Read Me First](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K01A10-01EN.pdf) | IM 36K01A10-01EN | 2nd Edition, Sep. 2023 | +| [CI Server Release Information](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K01A50-01EN.pdf) | IM 36K01A50-01EN | 3rd Edition, Sep. 2023 | + +## Installation + +| Document | IM Number | Edition | +|---|---|---| +| [CI Server Setup](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K01C10-01EN.pdf) | IM 36K01C10-01EN | 3rd Edition, Sep. 2023 | +| [CI Server Security Guide](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K01C30-01EN.pdf) | IM 36K01C30-01EN | 3rd Edition, Sep. 2023 | + +## User Manual + +### Engineering Basics + +| Document | IM Number | Edition | +|---|---|---| +| [Engineering Module - I/O Processes](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10C10-01EN.pdf) | IM 36K10C10-01EN | 3rd Edition, Sep. 2023 | +| [Engineering Module - Alarms](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10C20-01EN.pdf) | IM 36K10C20-01EN | 3rd Edition, Sep. 2023 | +| [Engineering Module - Reporting](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10C30-01EN.pdf) | IM 36K10C30-01EN | 3rd Edition, Sep. 2023 | +| [Engineering Module - Historical](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10C40-01EN.pdf) | IM 36K10C40-01EN | 3rd Edition, Sep. 2023 | +| [Edit Module](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10C50-01EN.pdf) | IM 36K10C50-01EN | 3rd Edition, Sep. 2023 | +| [Advanced Operating Graphics](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10C60-01EN.pdf) | IM 36K10C60-01EN | 3rd Edition, Sep. 2023 | + +### Function + +| Document | IM Number | Edition | +|---|---|---| +| [Excel Add-in Data Analysis and Reporting](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10E10-01EN.pdf) | IM 36K10E10-01EN | 3rd Edition, Sep. 2023 | +| [OPC Interface](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10E20-01EN.pdf) | IM 36K10E20-01EN | 2nd Edition, Sep. 2023 | +| [Alarm System Performance Analysis](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10E30-01EN.pdf) | IM 36K10E30-01EN | 3rd Edition, Sep. 2023 | + +## Tutorial + +| Document | IM Number | Edition | +|---|---|---| +| [CI Server Tutorial](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10G10-01EN.pdf) | IM 36K10G10-01EN | 3rd Edition, Sep. 2023 | + +## Engineering Manual + +### System Design / System Construction + +| Document | IM Number | Edition | +|---|---|---| +| [CI Server System Design/Management](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10J10-01EN.pdf) | IM 36K10J10-01EN | 3rd Edition, Sep. 2023 | +| [High Availability Computing](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10J20-01EN.pdf) | IM 36K10J20-01EN | 3rd Edition, Sep. 2023 | +| [Active Directory Integration](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10J40-01EN.pdf) | IM 36K10J40-01EN | 3rd Edition, Sep. 2023 | + +### Function + +| Document | IM Number | Edition | +|---|---|---| +| [Class/Object Engineering](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L10-01EN.pdf) | IM 36K10L10-01EN | 3rd Edition, Sep. 2023 | +| [Alarm Management Engineering](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L15-01EN.pdf) | IM 36K10L15-01EN | 3rd Edition, Sep. 2023 | +| [History Management Engineering](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L20-01EN.pdf) | IM 36K10L20-01EN | 3rd Edition, Sep. 2022 | +| [Audit Trail Management Engineering](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L25-01EN.pdf) | IM 36K10L25-01EN | 3rd Edition, Sep. 2023 | +| [BUS Service Engineering](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L30-01EN.pdf) | IM 36K10L30-01EN | 3rd Edition, Sep. 2023 | +| [ITEM Service Engineering - ITH](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L35-01EN.pdf) | IM 36K10L35-01EN | 3rd Edition, Sep. 2023 | +| [ITEM Service Engineering - ITM](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L36-01EN.pdf) | IM 36K10L36-01EN | 3rd Edition, Sep. 2023 | +| [EQUIPMENT Service Engineering - Utilities](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L40-01EN.pdf) | IM 36K10L40-01EN | 3rd Edition, Sep. 2023 | +| [EQUIPMENT Service Engineering - Configuration](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L41-01EN.pdf) | IM 36K10L41-01EN | 3rd Edition, Sep. 2023 | +| [Data Access Engineering](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L45-01EN.pdf) | IM 36K10L45-01EN | 3rd Edition, Sep. 2023 | +| [Data Set Service Engineering](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L50-01EN.pdf) | IM 36K10L50-01EN | 3rd Edition, Sep. 2023 | +| [Exchange Tool Engineering](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10L55-01EN.pdf) | IM 36K10L55-01EN | 3rd Edition, Sep. 2023 | + +### Language + +| Document | IM Number | Edition | +|---|---|---| +| [Class Description Language - Traditional](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10P10-01EN.pdf) | IM 36K10P10-01EN | 3rd Edition, Sep. 2023 | +| [Class Description Language - Java](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10P11-01EN.pdf) | IM 36K10P11-01EN | 3rd Edition, Sep. 2023 | +| [Report Generation Language](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10P20-01EN.pdf) | IM 36K10P20-01EN | 3rd Edition, Sep. 2023 | +| [Data Set Service Language](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10P30-01EN.pdf) | IM 36K10P30-01EN | 3rd Edition, Sep. 2023 | + +### Setup + +| Document | IM Number | Edition | +|---|---|---| +| [CI Portal Setup](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10R10-01EN.pdf) | IM 36K10R10-01EN | 3rd Edition, Sep. 2023 | +| [Setup File Editor](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10R20-01EN.pdf) | IM 36K10R20-01EN | 3rd Edition, Sep. 2023 | +| [Graphic Display Setup](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10R30-01EN.pdf) | IM 36K10R30-01EN | 3rd Edition, Sep. 2023 | +| [Report Server Setup](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K10R40-01EN.pdf) | IM 36K10R40-01EN | 3rd Edition, Sep. 2023 | + +## Not Listed in the Map + +These files are in the `EN` folder but do not appear in `ciserver.pdf`: + +| Document | IM Number | Edition | +|---|---|---| +| [CI Server Software License Agreement](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K01A20-01EN.pdf) | IM 36K01A20-01EN | 1st Edition, Jan. 2021 | +| [CI Server Terms and Conditions of Open Source Software](file:///C:/Users/Public/Yokogawa/tls/doc/EN/IM36K01A30-01EN.pdf) | IM 36K01A30-01EN | 2nd Edition, Mar. 2022 |