############
Service Memo
############

Typical Workflow
================

#. Configure the monitor to send data to gams platform:

   * Find the manufacturer of the monitor in :ref:`monitors/index:Supported Manufacturers`
   * Under the manufacturer page, find the model of the monitor
   * Configure the monitor according to the instructions under the ``Configuration`` section of the model page

#. Create the client's **Organization** under your Organization (:ref:`platform/cc/organizations:Organization Creation`):

   * ``Parent organization``: the upper-level Organization of your client's Organization; usually, the client's
     Organization should be represented as a child Organization under your company's Organization
   * ``Organization display name``: the name of your client's company or project, e.g. ``ABC Shanghai``
   * ``Support email``: the customer service email address of your company

#. Create a **Location** under the client's Organization (:ref:`platform/cc/locations:Location Creation`):

   * ``Location name``: the location name of your client's company or project, e.g. ``ABC Shanghai office``
   * ``Timezone``: the time zone of your client's company or project
   * ``Address``: the detailed street address of your client's company or project
   * ``Outdoor station``: the closest outdoor air monitoring station to the client's address

#. Create **Nodes** under the client's Organization (:ref:`platform/cc/nodes:Node Creation`):

   * ``Sensor model``: the model of the monitor or sensor belonging to the Node
   * ``Sensor UUID``: the unique identifier of the monitor or sensor belonging to the Node
   * ``Node name``: a name used to identify the Node; Nodes should usually be named in a way that allows the install
     location of the sensors or monitors attached to the Nodes to be easily identified, e.g. ``2F Lobby``,
     ``Front Desk``, and ``A1-23``
   * ``Location``: the Location that the Node belongs to; this is important for establishing indoor-outdoor comparison

#. Invite client **Users** to the client's Organization (:ref:`platform/cc/users:User Creation`):

   * ``Email address``: the User's email address for logging in to gams services
   * ``Full name``: the User's full name
   * ``Language``: the User' interface language
   * ``Role``: the User's permission level; select ``Reader`` for most users, who only need to access the monitoring data

#. Create **Tags** under the client's Organization (:ref:`platform/cc/tags:Tag Creation`):

   * ``Tag name``: a name used to identify the Tag; usually, Tags are based on the physical locations
     (e.g. ``1F monitors``), types (e.g. ``O3 monitors``), or purposes (e.g. ``Data comparison between monitor models
     X, Y, Z``) of the Nodes and are used to create Views, reports, and multi-Node accordingly
   * ``Nodes``: select the Nodes to attach to the Tag

#. Create **Views**, the public data displays, based on Tags.

The workflow can be altered according to the actual feature requirements of the client:

.. list-table::
   :header-rows: 1

   * - Requirement
     - Public display (Views)
     - Real-time data (CC, Surround)
     - Historical data (CC)
     - Reports and alerts
     - Multi-node chart (CC)
   * - **Organization**
     - ●
     - ●
     - ●
     - ●
     - ●
   * - **Location**
     - ●
     - ●
     - ●
     - ●
     - ●
   * - **Node**
     - ●
     - ●
     - ●
     - ●
     - ●
   * - **User**
     - ○
     - ●
     - ●
     - ●
     - ●
   * - **Tag**
     - ●
     - ○
     - ○
     - ○
     - ●
   * - **View**
     - ●
     - ○
     - ○
     - ○
     - ○

●: Required
○: Optional