.. _product:

****
产品
****

产品是一组属性、服务、事件、告警规则等要素的集合，可以被应用在多个设备上。

.. contents::
    :local:

.. _product_basic:

产品基础知识
============

| 典型的一个产品比如某品牌的某型号的温度传感器。
| 当然，从监控角度来说，一组设备只要可以抽象出相同的监控要素，都可视同是同一个产品，哪怕从硬件角度来说它们并不完全相同。

产品的要素包括：\ :ref:`基础信息 <product_baseinfo>`\ ， :ref:`属性 <attribute>`\ ， :ref:`事件 <event>`\ ， :ref:`服务 <service>`\ ， :ref:`上下线规则 <connection_rule>`\ ， :ref:`告警规则 <rule>`\ ， :ref:`变量 <macro>`\ ， :ref:`标签 <tag>`\ ， :ref:`值映射方案 <value_mapping>`\。

本页主要介绍产品的\ :ref:`基础信息 <product_baseinfo>`\ ，\ :ref:`上下线规则 <connection_rule>`\ ，\ :ref:`值映射方案 <value_mapping>`\ ，其它要素的详情请在各自的专题页内查看。

.. note::
    产品上的要素被修改后，应用了该产品的设备上的对应要素，原则上也会自动同步被修改。

创建产品
========

产品内的要素较多，所以需要首先创建简单的产品框架并填写基础信息，之后才能继续维护其它要素。最完整的步骤如下。

步骤1：创建产品的框架
-----------------------

#. 进入\ **产品管理**\ →\ **产品**\ 列表页。
#. 点击\ **创建**\ ，在产品基础表单内填写各个字段后点击\ **保存**\ 。
#. 上面新建的产品会列在\ **产品管理**\ →\ **产品**\ 里。

.. _product_baseinfo:

产品的基础信息如下。

.. csv-table::
    :header: "字段", "描述"
    :widths: 20, 80

    "产品ID", "产品的ID，是平台范围内产品的唯一识别号，在各个接口内作为参数用于确定产品。"
    "产品名称", "产品的名称，只是用来显示。"
    "产品分类", "可以是产品分类树上的任意一个节点。当产品比较多时，合理利用产品分类会使产品的管理工作更加高效。"
    "设备类型", "产品的设备类型，可以是下列值之一：直连设备、网关设备、网关子设备。目前设备类型并不会对业务逻辑产生影响。"
    "厂商", "产品的厂商，只是用来显示。"
    "型号", "产品的型号，只是用来显示。"
    "描述", "产品的额外描述信息，只是用来显示。"

步骤2：添加属性
---------------

属性是从设备获取到的最基础数据。它就是一个单一的动态数据指标，直接获取于设备，或者由另一个属性处理而得。

产品的属性会完全被应用它的设备继承。属性的详细信息请见\ :ref:`属性 <attribute>`\ 。

#. 进入\ **产品管理**\ →\ **产品**\ 列表页。点击要编辑产品的\ **产品名称**\ 进入产品详情页，点击顶部的\ **属性**\ ，再点击\ **创建**\ 。
#. 填写各个字段后，点击\ **保存** \ 。


步骤3：添加事件
---------------

事件是设备在特定情况下自动上报的消息，比如设备的特定运行记录、故障信息等。

产品的事件会完全被应用它的设备继承。事件的详细信息请见\ :ref:`事件 <event>`\ 。

#. 进入\ **产品管理**\ →\ **产品**\ 列表页。点击要编辑产品的\ **产品名称**\ 进入产品详情页，点击顶部的\ **事件**\ ，再点击\ **创建**\ 。
#. 填写各个字段后，点击\ **保存** \ 。

步骤4：添加服务
---------------

服务是设备可被外部调用的功能，可设置输入参数，可实现复杂的业务逻辑。

产品的服务会完全被应用它的设备继承。服务的详细信息请见\ :ref:`服务 <service>`\ 。

#. 进入\ **产品管理**\ →\ **产品**\ 列表页。点击要编辑产品的\ **产品名称**\ 进入产品详情页，点击顶部的\ **服务**\ ，再点击\ **创建**\ 。
#. 填写各个字段后，点击\ **保存** \ 。

.. _connection_rule:

步骤5：添加上下线规则
---------------------

上下线规则是平台判定设备在线状态的依据。上线、下线规则可以分别设置，且可在以下判断方法内任选：

* 在特定时间内有/无值；
* 最新值符合特定条件。

产品的上下线规则会完全被应用它的设备继承。设备里继承自产品的上下线规则，不可编辑。

#. 进入\ **产品管理**\ →\ **产品**\ 列表页。点击要编辑产品的\ **产品名称**\ 进入产品详情页，点击顶部的\ **上下线规则**\ ，再点击\ **编辑**\ 。
#. 填写各个字段后，点击\ **保存** \ 。

步骤6：添加告警规则
-------------------

制定产品告警规则后，平台会在接收到的属性、事件等符合条件时发出告警消息，并按自定义规则调用本产品的服务。

产品的告警规则会完全被应用它的设备继承。告警规则的详细信息请见\ :ref:`告警规则 <rule>`\ 。

#. 进入\ **产品管理**\ →\ **产品**\ 列表页。点击要编辑产品的\ **产品名称**\ 进入产品详情页，点击顶部的\ **告警规则**\ ，再点击\ **创建**\ 。
#. 填写各个字段后，点击\ **保存** \ 。

步骤7：添加变量
---------------

可在产品、设备上增加自定义变量，以适用于同一产品不同设备下，键相同而值可能不同的情况，方便后续取用。

产品的变量会完全被应用它的设备继承，且设备上继承的变量的键不可以删改，而值可以被修改。变量的详细信息请见\ :ref:`变量 <macro>`\ 。

#. 进入\ **产品管理**\ →\ **产品**\ 列表页。点击要编辑产品的\ **产品名称**\ 进入产品详情页，点击顶部的\ **变量**\ ，再点击\ **创建**\ 。
#. 填写各个字段后，点击\ **保存** \ 。

.. _product_tag:

步骤8：添加标签
---------------

标签可以用来标记产品、设备及其内的多种要素，也会自动被标记到事件、告警上，从而方便统计分析。

产品的标签会完全被应用它的设备继承。标签的详细信息请见\ :ref:`标签 <tag>`\ 。

#. 进入\ **产品管理**\ →\ **产品**\ 列表页。点击要编辑产品的\ **产品名称**\ 进入产品详情页，点击顶部的\ **标签**\ ，再点击\ **创建**\ 。
#. 填写各个字段后，点击\ **保存** \ 。

.. _product_value_mapping:

步骤9：添加值映射方案
---------------------

产品的值映射方案可以被用在产品下的属性和事件上，以使属性和事件的值的可读性更好，同时不影响入库保存的原始值。

产品内的值映射方案本身，不会被应用它的设备继承，不能被设备独有的属性或事件使用。

#. 进入\ **产品管理**\ →\ **产品**\ 列表页。点击要编辑产品的\ **产品名称**\ 进入产品详情页，点击顶部的\ **值映射方案**\ ，再点击\ **创建**\ 。
#. 填写各个字段后，点击\ **保存** \ 。

..
    .. todo::
    **克隆** 功能，方便用户基于已有的产品快速创建类似的新产品，只需要点击 **克隆** 并输入新的产品ID和名称即可快速克隆出要素与老产品完全相同的新产品。