Configuring the Envizi API connection

Edit online

Configure the system properties to enable Maximo® Manage to connect to the Envizi GHG API for automatic emission calculations.

Before you begin

You must have administrator access to configure system properties. You must also obtain the following information from your Envizi account:

  • Envizi domain URL
  • Organization ID
  • Client ID
  • API key

About this task

The Envizi API connection settings are stored as system properties in Maximo Manage. These properties are used to authenticate and communicate with the Envizi GHG API for emission calculations.

Procedure

  1. In Maximo Manage, from the side navigation menu, click System Configuration > Platform Configuration > System Properties.
  2. In the System Properties application, search for properties that start with envizi.
  3. Configure the following system properties with values from your Envizi account:
    Property Description
    mxe.envizi.auth.endpoint The Envizi specific API endpoint for authentication
    mxe.envizi.domain The base URL for your Envizi API instance
    mxe.envizi.fugitive.emission.calculation.endpoint The Envizi specific API endpoint for fugitive emission calculation
    mxe.envizi.ibm.apiKey The API key for secure access to Envizi services
    mxe.envizi.ibm.clientId The client ID for API authentication
    mxe.envizi.orgId Your Envizi organization identifier
  4. Save each property value.
  5. Select all properties that you added for the Envizi integration.
  6. In the Common actions navigation pane, click Live Refresh to apply the configuration changes immediately.

Results

Maximo Manage can now connect to the Envizi API to calculate CO₂e emissions automatically when you record emission data.

What to do next

After the API connection is configured, set up the lookup values for emission gas type so that gas types can be selected when recording emissions.