CII
5.0.0-pre1
Contents:
1. Introduction
1.1. Scope
1.2. Overview
2. Configuration
2.1. Overview
2.2. Includes and imports
2.2.1. C++
2.2.2. Python
2.3. API Components
2.4. Creation of Documents
2.4.1. Parsing YAML source from input/output stream
2.4.1.1. C++
2.4.1.2. Python
2.4.2. Loading YAML source from file/URI
2.4.2.1. File-provider: local
2.4.2.2. File-provider: root
2.4.2.3. Filenames and relative URIs
2.4.2.4. Default file provider
2.4.2.5. Cache setup in C++
2.4.2.6. Cache setup in Python
2.4.3. Actual document loading
2.4.4. Building document programmatically
2.5. Access to YAML source tree of a document
2.6. Document instance interface
2.6.1. Accessing document instance interface
2.6.1.1. C++
2.6.1.2. Python
2.6.2. Iteration over document instances
2.6.2.1. C++
2.6.2.2. Python
2.7. Document Validation
2.7.1. C++
2.7.2. Python
2.8. Saving documents to YAML
2.8.1. C++
2.8.2. Python
2.9. Merging documents
2.9.1. C++
2.9.2. Python
2.10. Cloning documents
2.10.1. C++
2.10.2. Python
2.11. Listing documents
2.11.1. C++
2.11.2. Python
2.12. Exceptions
2.13. YAML tags recognized by config-ng
2.13.1. cfg.include
2.13.2. cfg.type
2.13.3. cfg.typedef
2.13.4. cfg.optional, cfg.required
2.13.5. cfg.merge
2.14. List of built-in data types
3. Online Database
3.1. Overview
3.2. Introduction
3.3. Prerequisites
3.3.1. WAF Modules
3.3.2. Services
3.3.2.1. Redis
3.3.2.2. Calculation Engine
3.3.2.3. Configuration Service
3.3.3. Configuration
3.3.3.1. OLDB Client Configuration
3.3.3.2. Calculation Service Configuration
3.4. OLDB Library Usage
3.4.1. Includes/Imports
3.4.1.1. C++
3.4.1.2. Python
3.4.1.3. C++
3.4.1.4. Python
3.4.2. Basic Example
3.4.3. Subscribing Example
3.4.4. Advanced Example
3.4.5. Alias Example
3.5. Advanced Topics
3.5.1. OLDB Statistics
3.5.1.1. OLDB Client Statistics
3.5.1.2. Calculation Service Statistics
3.5.2. Disabling Writes to Data Points
3.5.3. Custom functions in Data Point Formulas
3.5.4. Manipulating Data Point Metadata
3.5.5. Data Point Configuration
3.5.6. External Redis Servers
3.5.7. Defining the Storage Location of a Data Point
3.5.8. Enabling notification-only subscriptions on datapoints
3.6. OLDB API LIBRARY
3.6.1. CiiOldb
3.6.2. CiiOldbDataPoint
3.6.2.1. Data Point URI
3.6.2.2. Data Point Value
3.6.2.3. Metadata
3.7. OLDB CLI
3.7.1. Read operations
3.7.1.1. Read value
3.7.1.2. Read Value Formula and Quality Expression
3.7.1.3. Save value to File
3.7.2. Write operations
3.7.2.1. Write value
3.7.2.2. Write Quality and Timestamp
3.7.2.3. Write Formula
3.7.2.4. Write Quality Expression
3.7.2.5. Write Value from File
3.7.2.6. Write Value directly from Formula
3.7.3. Subscribe operations
3.7.3.1. Subscribe to datapoint
3.7.3.2. Subscribe and output to Files
3.7.4. Create operation
3.7.5. Delete operation
3.8. GUI
3.8.1. General
3.8.2. Configuration File
3.8.3. Functionality
3.8.3.1. Main Window
3.8.3.2. Menu
3.8.4. Hierarchy view
3.9. Data Point Value Type to Language Types Mapping
3.10. Default Metadata Instance Names
3.11. Metadata attribute constraints
3.12. YAML Data point type
3.13. OLDB API LISTING
3.13.1. CiiOldb
3.13.2. CiiOldbDataPoint
4. Error Handling
4.1. Overview
4.2. Introduction
4.2.1. Standard workflow
4.2.2. CII Exceptions
4.2.2.1. Error stack
4.2.2.2. Indexing Service
4.2.3. Conditions API
4.2.4. Serialization
4.3. Installation
4.3.1. Prerequisites and waf modules
4.4. Usage
4.4.1. Includes/Imports
4.4.1.1. Java
4.4.1.2. CPP
4.4.1.3. Python
4.4.1.4. QT
4.4.2. Creating an SVN repository
4.4.3. Creating the exceptions
4.4.3.1. Java
4.4.3.2. CPP
4.4.3.3. Python
4.4.4. Wrapping native exceptions
4.4.5. Search script
4.4.5.1. Configuring the script
4.4.5.2. Usage of the search script
4.4.6. Exceptions examples
4.4.6.1. Building an Error Stack
4.4.6.2. Throwing a CPP Exception with Extra Information
4.4.6.3. Exception Serialization from CPP to Java
4.4.7. Using the Condition API
4.5. Using the QT Error Dialog Widget
4.6. Indexing service
4.6.1. Configuring indexing service
4.6.2. Running the indexing service
4.6.3. Accessing the indexed data
4.7. API
4.7.1. CII Exception methods
4.7.2. CPP macros
4.7.3. Conditions API
4.7.3.1. Java
4.7.3.2. CPP
4.7.3.3. Python
4.8. Serialization code example
4.8.1. CPP serialization server code
4.8.2. Java serialization client code
5. Logging
5.1. Overview
5.2. Introduction
5.2.1. Logsink directory
5.2.2. Loggers and Appenders
5.2.3. Log Layouts
5.2.4. Postmortem buffer
5.2.5. Log Levels
5.3. Prerequisites
5.3.1. Includes and imports
5.3.2. C++
5.3.3. Python
5.4. Logging Library Usage
5.4.1. CiiLogManager
5.4.2. CiiLogMessageBuilder
5.4.3. Logging Configuration
5.4.3.1. C++
5.4.3.2. Python
5.4.4. Log Layouts
5.4.4.1. C++
5.4.4.2. Python
5.4.5. Basic usage example with default configuration
5.4.5.1. C++
5.4.5.2. Python
5.4.6. Basic usage example with custom configuration
5.4.6.1. C++
5.4.6.2. Python
5.4.7. Adding optional information to log messages
5.4.7.1. Via LogManager
5.4.7.2. Via MessageBuilder
5.4.7.3. C++
5.4.7.4. Python
5.4.8. String formatting
5.4.8.1. Compile-time validation
5.4.9. Using the Postmortem Buffer
5.4.9.1. C++
5.4.9.2. Python
5.4.10. Ops-Logs
5.4.10.1. Ops-Logs Example C++
5.4.10.2. Ops-Logs Example Python
5.5. Logging services administration
5.5.1. Logging services configuration
5.5.1.1. Host Setup
5.5.1.2. Start/Stop Services
5.5.1.3. Configuration
5.5.2. Logging services monitoring
5.6. Logging User Tools
5.6.1. ciiLogSend
5.6.2. Log Viewer
5.6.2.1. Column Chooser
5.6.2.2. View Filtering
5.6.3. Log Viewer Widget (Qt)
5.7. Tracing
5.7.1. Introduction
5.7.1.1. Traces and Spans
5.7.2. Tracing Library Usage
5.7.2.1. Tracing request-reply communication
5.7.2.2. Tracing publish-subscribe communication
5.7.2.3. Includes/Imports
5.7.2.4. Basic usage example
5.7.2.5. Mal pub/sub and request/response tracing basic examples
5.7.2.6. Context Propagation
5.7.3. Tracing Services
5.7.3.1. Jaeger Agent
5.7.3.2. Jaeger Collector
5.7.3.3. Jaeger Query
5.7.4. Tracing GUI (Jaeger UI)
5.8. CII Log Client API
5.8.1. C++
5.8.1.1. CiiLogManager
5.8.1.2. CiiLogMessageBuilder
5.8.1.3. CiiLogConfigurator
5.8.1.4. CiiLayout
5.8.1.5. CiiSimpleLayout
5.8.2. Python
5.8.2.1. CiiLogManager
5.8.2.2. CiiLogConfigurator
5.8.2.3. CiiLogMessageBuilder
5.9. CII Log Fields
6. Alarm
6.1. Overview
6.2. Introduction
6.3. Prerequisites
6.3.1. Set-up
6.3.2. Start-Stop
6.4. Usage
6.4.1. Write Alarm Definitions
6.4.1.1. Format
6.4.1.2. Alarm functions
6.4.2. Inject Definitions
6.4.3. Request a Reload
6.4.4. Monitor Alarms
6.4.5. Trigger Alarms
6.5. Advanced Topics
6.5.1. Administration
6.5.1.1. Installation
6.5.1.2. Auto-start
6.5.1.3. Health Checks
6.5.1.4. Log Configuration
6.5.1.5. Logs
6.5.2. Troubleshooting
6.5.3. Modify CDB directly
6.5.3.1. General Settings
6.5.3.2. IASIOs
6.5.3.3. Transfer Functions
6.5.3.4. DASUs
6.5.3.5. Supervisor
6.5.3.6. Plugin
6.5.4. Run IAS directly
7. Telemetry
7.1. Overview
7.2. Introduction
7.2.1. Dependencies
7.2.1.1. Engineering Archive
7.2.1.2. Configuration Service
7.2.1.3. OLDB Service
7.2.2. Components
7.2.2.1. Telemetry APIs
7.2.2.2. Telemetry CLI tools
7.2.2.3. Telemetry Archivers
7.3. Telemetry APIs (Common)
7.3.1. wscript
7.3.2. imports/includes
7.4. Telemetry Recording API
7.4.1. Data Entitites
7.4.1.1. Time Series Metadata
7.4.1.2. Time Series Point
7.4.2. Telemetry Recording API Example
7.5. Telemetry Query API
7.5.1. Telemetry Query API Example
7.5.2. Querying data
7.5.3. Reading data
7.6. Telemetry Bulk API
7.6.1. Storing a list of data
7.6.2. Downloading list of data
7.7. Telemetry Management API
7.7.1. Moving data
7.7.2. Deleting data
7.8. Telemetry CLI tools
7.9. Telemetry Archiver
7.9.1. Data Capture Configuration
7.9.2. Telemetry OLDB Subscription
7.9.3. Telemetry Archiver Deployment
8. Service Management
8.1. Overview
8.2. Introduction
8.3. cii-postinstall
8.3.1. Roles
8.3.2. Subcommands
8.4. cii-services
8.4.1. Monitoring/Status Check
8.4.2. Start / Stop
8.5. Example
9. Internal Config System
9.1. Overview
9.2. Introduction
9.2.1. Classes
9.2.1.1. Configuration classes
9.2.1.2. Metadata classes
9.2.2. Instances
9.2.2.1. Metadata instances
9.2.2.2. Configuration instance
9.3. Prerequisites
9.3.1. Local DB initialization
9.3.2. Includes/Imports
9.3.2.1. Java imports
9.3.2.2. CPP Includes
9.3.2.3. Python imports
9.4. Basic usage
9.4.1. Example description
9.4.2. Creating a simple configuration using YAML definitions
9.4.2.1. Java client
9.4.2.2. CPP client
9.4.2.3. Python client
9.4.3. Creating a simple configuration using GUI
9.4.3.1. Creating a simple class in GUI
9.4.3.2. Creating a target configuration for simple class in GUI
9.4.3.3. Generating classes from the classes defined in GUI
9.4.4. CRUD operations
9.4.4.1. Java CRUD
9.4.4.2. CPP CRUD
9.4.4.3. Python CRUD
9.4.5. Using the cache operations
9.4.5.1. Java cache example
9.4.5.2. CPP Cache
9.4.5.3. Python cache example
9.5. Advanced usage
9.5.1. Custom metadata class
9.5.2. Using referenced classes
9.5.2.1.
J
ava referenced type
9.5.2.2. CPP referenced type
9.5.2.3. Python referenced type
9.5.3. Using check values
9.5.3.1. Java checked functions
9.5.3.2. CPP checked functions
9.5.3.3. Python checked functions
9.6. Additional information
9.6.1. Config tool
9.6.1.1. Class generation
9.6.1.2. Deployment and undeployment
9.6.2. Generic types
9.6.3. Java search example
9.6.4. Large data – binary files
9.6.5. Extending metadata classes with additional logic
9.7. Config client API listing
9.7.1. Java API code
9.7.2. CPP API code
9.7.3. Python bindings code
9.8. Config point value type to language types mapping
9.9. Default metadata instance mapping
9.10. Class definition reserved words
9.11. YAML Data point type
9.12. JSON/YAML Schema
9.12.1. Configuration class schema
9.12.2. Metadata class schema
9.12.3. Configuration instance schema
9.12.4. Metadata instances schema
9.13. Configuration client settings
9.14. Code produced by the generators
CII
Index
Index