Release 4.6
August 2022 - (Release 4.6)
Whats New ?
- Kelvin API reference documentation is going through a major upgrade in descriptions and key links to Kelvin Documentation for easy terminology reference.
- Kelvin API now has two swagger.json files to download - one with HTML links and one a plain text version. This is useful for API clients that can not process HTML in descriptions.
- Kelvin API reference theme and UX overhaul.
- Kelvin Maps continues to go through major development cycles. Most infographics, terminology and UX is updated to reflect the changes.
- Carbon Maps is a major new feature documented.
- Upgraded pipeline and software for the auto-generated file swagger.json following latest standards.
- Rearranging the Kelvin Overview -> Kelvin Maps structure to give better structure on information of key features.
- New Security Policy and Certifications that document Kelvin's security conscious approach to management, development and deployment. Also listed CSA Level 1 and SSAE 18 SOC 2 Type II certifications Kelvin has attained.
- Split GSG Kelvin API section with a sub-menu to allow for separated detailed GSG's for different API functions.
- Many minor updates including Control Change Infographic speed reduced for easier viewing of the change process
Upgraded Kelvin API Documentation
All API requests listed here have gone through a rigorous upgrade to its documentation on the API description, parameter details, defaults, options and warnings.
- Asset API
/assets/class/create, /assets/class/list, /assets/class/{asset_class_name}/delete, /assets/class/{asset_class_name}/get, /assets/class/{asset_class_name}/update, /assets/create, /assets/create/upload, /assets/failure-overview/list, /assets/hierarchy/get, /assets/hierarchy/update, /assets/list, /assets/oee/get, /assets/statistics/get, /assets/status/count/get, /assets/status/current/get, /assets/templates/create, /assets/templates/list, /assets/templates/{asset_template_name}/delete, /assets/templates/{asset_template_name}/get, /assets/templates/{asset_template_name}/update, /assets/types/create, /assets/types/list, /assets/types/{asset_type_name}/delete, /assets/types/{asset_type_name}/get, /assets/types/{asset_type_name}/metadata/create, /assets/types/{asset_type_name}/metadata/list, /assets/types/{asset_type_name}/metadata/{asset_type_metadata_name}/delete``/assets/types/{asset_type_name}/metadata/{asset_type_metadata_name}/get, /assets/types/{asset_type_name}/metadata/{asset_type_metadata_name}/update, /assets/types/{asset_type_name}/update, /assets/{asset_name}/datastreams/list, /assets/{asset_name}/delete, /assets/{asset_name}/get, /assets/{asset_name}/hierarchy/get, /assets/{asset_name}/update
- Metrics API
/metrics/create, /metrics/create/upload, /metrics/list, /metrics/{metric_name}/delete, /metrics/{metric_name}/get, /metrics/{metric_name}/update
- Control Changes API
/control-changes/create, /control-changes/last/get, /control-changes/list, /control-changes/range/get, /control-changes/sync/{node}/download, /control-changes/sync/{node}/upload, /control-changes/{control_change_id}/get
New Documentation Pages
- Kelvin Overview -> Security Policy & Certifications page added
- Kelvin Overview -> Kelvin Maps -> OEE in Kelvin page added
- Kelvin Overview -> Kelvin Maps -> Carbon Maps page added
- Getting Started Guides -> GSG Kelvin API -> GSG Kelvin API - Online Reference page added
- Documentation -> Cloud Server -> Kelvin SDK -> SDK Authentication page added
Updated Documentation Pages
- Kelvin Overview -> Overview page updated
- Kelvin Overview -> Recommended Reading page updated
- Kelvin Overview -> Cloud Server -> Kelvin Assets page updated
- Kelvin Overview -> Cloud Server -> Kelvin Apps page updated
- Kelvin Overview -> Cloud Server -> Kelvin Alarms page updated
- Kelvin Overview -> Cloud Server -> Kelvin Control Change page updated
- Kelvin Overview -> Kelvin Maps -> Kelvin Maps Overview page updated
- Kelvin Overview -> Kelvin CoPIlot page updated
- Getting Started Guides -> GSG Kelvin Manager UI page updated
- Getting Started Guides -> GSG Kelvin API page updated
- Getting Started Guides -> GSG Kelvin API -> GSG Kelvin API - Control Change page updated
- Getting Started Guides -> GSG Kelvin SDK page updated
- Documentation -> Cloud Server -> Kelvin API -> Kelvin API Overview page updated
- Documentation -> Cloud Server -> Kelvin Manager UI -> Kelvin Manager UI Overview page updated
- Documentation -> Cloud Server -> Kelvin Manager UI -> Monitoring -> Alarms Monitoring page updated
- Documentation -> Cloud Server -> Kelvin Manager UI -> Management -> Metrics -> Metrics page updated
- Documentation -> Cloud Server -> Kelvin Manager UI -> Management -> Assets -> Assets page updated
- Documentation -> Cloud Server -> Kelvin SDK -> Kelvin SDK Installation page updated
- Documentation -> Kelvin Maps -> Kelvin Maps Overview page updated
- Documentation -> Kelvin Maps -> Kelvin Maps Dashboard page updated
- Documentation -> Kelvin Maps -> Kelvin Maps Process View page updated
- Documentation -> Kelvin Maps -> Kelvin Maps Asset Details page updated
- Documentation -> Kelvin Maps -> Kelvin Maps Process Map Editor page updated
- Some legacy documentation and tutorials updated for consistent terminology only (content may not be consistent with latest versions of Cloud Server)
New Tutorials
- New written API tutorial on Create/Edit a Custom Kelvin Template
- New written API tutorial on Create Kelvin Asset and Kelvin Metric with Kelvin API
- New written API tutorial on Install and Setup Postman for API Requests
- New written API tutorial on Create, Read, Delete Kelvin Alarms with Kelvin API
- Duplicate GSG Kelvin API - Control Change to API tutorial on Create and Monitor a Control Change with Kelvin API