===
Use
===

Logging In
----------

After installation, launch the add-in by clicking the **IBM Envizi for Excel Add-in** button on the Excel ribbon.

When prompted, provide your credentials:

- **apiKey** – API access key
- **tenantId** – Tenant identifier
- **orgId** – Organization identifier

Your credentials can be found on the `Overview Dashboard <https://www.app.ibm.com/envizi/emissions-api-home/overview?cuiURL=%2Femissions-api-home%2Foverview>`_ by clicking on the **View API Key** button.

.. image:: _images/login.png
   :alt: Login screen of the add-in
   :align: center

Once your credentials are validated, the **main interface** of the add-in becomes available:

.. image:: _images/main.png
   :alt: Main interface of the add-in
   :align: center

Working with Functions
----------------------

The add-in provides custom Excel functions that retrieve and calculate emissions data.

**Example: Stationary emissions**

Users can enter a function such as:

.. code-block:: none

   =ENVIZI.STATIONARY(type, value, unit, country, [stateProvince], [date])

**Parameters**

- ``type``: Activity type
- ``value``: Numeric activity value
- ``unit``: Unit of measurement
- ``country``: ISO alpha-3 country code
- ``stateProvince`` *(optional)*: State or province identifier
- ``date`` *(optional)*: Activity date

.. image:: _images/function.png
   :alt: Stationary Function
   :align: center

.. note::
   Ensure that there are enough empty cells available to display the results. If sufficient space is not available, a spill error will occur.

**Process**

1. IBM Envizi for Excel processes the inputs and formats them for the IBM Envizi - Emissions API,
2. The IBM Envizi Emissions API calculates the emissions data,
3. The result is then returned and displayed in the Excel cell.

.. image:: _images/result.png
   :alt: API Result
   :align: center

.. note::
   If an error occurs, the add-in will display an error message once you hover over warning icon.

   .. image:: _images/error.png
      :alt: Example error message
      :align: center
      :width: 220
      :height: 145

Exporting Results
-----------------

To export computed results (without formulas):

1. Copy the cells containing the formulas.
2. Use **Paste Values** to paste only the calculated results into a new location.

.. image:: _images/paste.png
   :alt: Paste Values option in Excel
   :align: center
   :width: 220
   :height: 420