---
title: "Refrigerant Registration Implementation Guide"
canonical: "https://help.fieldbuddy.com/space/FBDOCS/7037976584/Refrigerant%20Registration%20Implementation%20Guide"
format: markdown
---
## Prerequisites

Before installing the package, verify the following:

- FieldBuddy base package installed and configured (version 1.147.42 or higher)
- FieldBuddy Swift enabled and in use on the org
- Translation Workbench enabled — if the org operates in Dutch, enable nl_NL before deploying (all UI labels, picklists and error messages are pre-translated)
- System Administrator access on the target org
- API access enabled on the org (required for Data Loader during data migration)

## Installation

### Install the Package

- Navigate to the installation URL provided by FieldBuddy
- Log in with a System Administrator account on the target org
- Select **Install for Admins Only** — do not install for all users on first deployment
- Accept any third-party access prompts if shown
- Click Install and wait for the confirmation email — deployment can take a few minutes

### Verify Installation

After installation, confirm the following are present in the org:

- **App:** Refrigerant Registration visible in App Launcher
- **Objects:** Container__c, Transaction__c, Logbook_Entry__c, Refrigerant__c
- **Tabs:** Containers, Refrigerants, Transactions, Transfer Refrigerant, Refrigerant Settings
- **Permission Sets:** Refrigerant Registration Admin, Refrigerant Registration Backoffice, Refrigerant Registration Mobile

## Manual Configuration

The following steps must be completed manually after package installation. They cannot be automated via metadata.

### 1. Add Refrigerant Picklist Value to WOI and WOLI Type

The Swift integration relies on a dedicated line item type to identify refrigerant-related work order lines. This picklist value must be added to both the Work Order Item (WOI) and Work Order Line Item (WOLI) Type fields.

**For Work Order Line Item (WOLI) Type:**

- Go to **Setup → Object Manager → Work Order Line Item (FIELDBUDDY__Work_Order_Line_Item__c)** **→ Fields & Relationships → Type**
- Click **Edit** next to the picklist values
- Add a new value: **Refrigerant**
- Save

**For Work Order Item (WOI) Type:**

- Go to **Setup → Object Manager → Work Order Item (FIELDBUDDY__Work_Order_Item__c) → Fields & Relationships → Type**
- Add the same value: **Refrigerant**
- Save

> ⚠️ The value must be spelled exactly **Refrigerant** (case-sensitive). This must match the WOLI Refrigerant Type setting configured in Refrigerant Settings and the item codes in the Swift configuration.

### 2. Add the Container Component to the Installed Product Lightning Page

The package includes a **Container** Lightning Web Component (`containerDetails`) that displays the containers linked to an Installed Product. This component is not added to any page layout automatically and must be placed manually.

- Go to **Setup → Object Manager → Installed Product → Lightning Record Pages**
- Open the Lightning record page used in your org (or create a new one)
- In the Lightning App Builder, find the **Container** component in the custom components panel
- Drag it to the desired position on the page (typically the bottom of the main column or a dedicated tab)
- Save the page

### 3. Activate the Installed Product Lightning Page for the App

After adding the Container component, the updated Lightning page must be activated so it is visible when opening Installed Products from within the Refrigerant Registration app.

- In the Lightning App Builder, click **Activation**
- Select **App Default** tab
- Click **Assign as App Default** and select **Refrigerant Registration**
- Save and close

> 📝 If your org uses multiple apps that access Installed Products, consider using App, Record Type, and Profile activation to avoid affecting other apps.

### 4. Assign Permission Sets

The package installs three permission sets that must be manually assigned to users. See the [Permission sets](https://upperdeck.atlassian.net/wiki/spaces/FBDOCS/pages/7037583366) page for the full role-to-permission-set mapping and assignment instructions.

### 5. Configure FieldBuddy Swift

Import the reference Swift configuration and set up the FieldBuddy Data Settings (WO closed status, WOLI type, and item codes). See the [FieldBuddy Swift example configuration](https://upperdeck.atlassian.net/wiki/spaces/FBDOCS/pages/7037714458) page for full details.

## Operational Processes

### Importing Existing Container Data

Use Salesforce Data Loader or the built-in Import Wizard to migrate existing cylinder data:

- Import Refrigerant__c records first — containers reference refrigerants, so these must exist before containers
- Prepare a CSV for Container__c with columns: Name, Serial_Number__c, Type__c, Status__c, Ownership__c, Capacity__c, Current_Amount__c, Refrigerant__c, Installed_Product__c
- Map Refrigerant__c and Installed_Product__c by external ID or name
- Import containers via **Setup → Data Import Wizard → Custom Objects → Container**

> 📝 Verify Current_Amount__c values carefully before importing — this is the starting balance for each container and will appear in reporting from day one.

### Adding a New Refrigerant

**Via Settings page (bulk):**

- Go to Refrigerant Settings → Manage Refrigerants
- Import a CSV file with the refrigerant list
- Existing records are skipped — the import is safe to run multiple times

Make sure to also add newly added refrigerants to the Refrigerants global value set.

**Manually:**

- Go to the Refrigerants tab → New
- Fill in: Name, Code, Type, GWP, Flammability
- Set Active = true to make it available in container and transaction forms

### Registering a New Cylinder

- Go to the Containers tab → New
- Fill in Serial Number, Type (Cylinder or Installation), Refrigerant, Capacity, Ownership
- Assign a Resource if the cylinder belongs to a specific technician
- Set Current Amount to 0
- Set Status to Active

### Processing a Manual Transfer

Used when refrigerant needs to be moved between containers outside of a work order:

- Go to the Transfer Refrigerant tab
- Search and select the source container
- Select the target container
- Enter the amount in KG
- Click **Create Transaction** — the system creates a Transaction record and updates the balance on both containers automatically