See www.zabbix.com for the official Zabbix site.

Docs/specs/ZBXNEXT-1340

From Zabbix.org
Jump to: navigation, search

Rename trigger description and trigger comments

ZBXNEXT-1340

Status: Draft

Owner: Alexei, Sasha

Summary

In order to improve naming consistency some trigger properties should be renamed:

  • Trigger description -> Trigger name
  • Trigger comments -> Trigger description

Front-end changes

  • Monitoring
    • Triggers
      • Rename filter label 'Filter by name' to 'Filter by trigger name'
      • Rename table header 'Name' to 'Trigger'
      • Rename table header 'Comments' to 'Description'
    • Trigger comments
      • Rename page header to 'Trigger description'
      • Rename form header to 'Trigger "<trigger name>"'
      • Rename 'TRIGGER COMMENTS' to 'TRIGGER DESCRIPTION'
      • Rename label 'Comments' to 'Description'
      • Rename action message 'Comment updated' to 'Trigger description updated'
    • Events
      • Rename table header 'Description' to 'Event'
  • Reports
    • Availability report
      • Rename table header 'Name' to 'Trigger'

XML import/export

  • New field names should be supported
    • If XML version is 2.0 or earlier, then old trigger and trigger prototype field names will be used
    • If XML version is 2.2, then new trigger and trigger prototype field names will be used
  • Import of older XML files should be supported

Server side

  • New field names should be supported

API changes

  • All trigger and trigger prototypes methods
    • Field 'description' will be renamed to 'name'
    • Field 'comments' will be renamed to 'description'
  • trigger.get
    • Option expandDescription will be renamed to expandName

Translation changes

Strings added or changed

  • Filter by trigger name
  • Trigger description
  • Trigger "<trigger name>"
  • TRIGGER DESCRIPTION
  • Trigger description updated

Database changes

  • Table 'triggers'
    • Rename field 'description' to 'name'
    • Rename field 'comments' to 'description'

Documentation

  • What's new
  • Zabbix Manual: screenshots
  • Zabbix Manual: XML format
  • API docs
  • Database structure

Test cases

  • Front-end is updated as described
  • XML works
  • Import of older XML files with trigger info works
  • Database is upgraded to new structure automatically

ChangeLog

  • N/A