Installation Instructions

The installation of Basic Lead consists of:

• Adding the limepkg as a dependency in your solution
• Adding the correct fields and tables through the addon-installer and manually
• Setting up lead business logic with Automations

Follow the instructions below to get started

Warning

Check that the requirements are met.

Getting Started

1. Add the package to your solution: poetry add limepkg-basic-lead

2. Go to Lime Admin -> Settings -> Basic Lead -> Setup and install the database structure.

   1. Manual step: Add an option field on Deal called source. Share options between lead.source and deal.source.
   2. Manual step: On History - Add option key autolog to history.type. English Localization: "Automatic note" - add corresponding in your local language. Should be deactivated by default.

3. Add the Lead on the views for related relations company (tab), person (tab), deal (tab), todo (field), history (field) and document (field).

4. Set up the lead business logic by adding Automations. Download the lead automation JSON files below and add them via Lime Admin -> System -> Automations -> + automation -> switch to code editor -> paste the JSON -> save and verify it looks correct -> set the automation to active.

The following lead automations are available:

Automation file	What it does
lead_name_phone_update.json	Concatenates firstname + lastname into name, strips non-digit characters from phone
lead_handle_status.json	Sets/clears dates and rejection reason on status changes (new, qualify, convert, rejection)
lead_create_state_changes.json	Creates statechange records when status, coworker, or office changes

Info

lead_name_phone_update.json and lead_handle_status.json replace the functionality previously provided by the lead decorator. lead_create_state_changes.json adds statechange tracking on top of that.

Once the automations are in place, go to Configuration to continue your setup.

---

Optional: Automated Flow integration

If you also use lime-automated-flow and want leads to trigger automated flow participants when qualified or converted, follow the steps below.

Data structure

First, make sure lime-automated-flow is installed. Then verify that the following relations exist on the automatedflowparticipant limetype:

• person
• lead
• deal

Once set up, a flow participant should look like this:

Then add a single relation from lead to automatedflow. The lead card should look something like this:

Automations

Two additional automations are needed for the automated flow integration. Add them the same way as the other automations in step 4 above.

Automation file	What it does
lead_automated_flow_decider.json	Assigns an automated flow to the lead based on source (e.g. fair, form). Needs customization: update the automated flow IDs and source keys to match your setup
lead_create_AF_participant.json	Creates an automated flow participant when lead status changes to qualify or convert, linking the flow and person to the participant ---

Legacy: Custom Limeobject Approach (Deprecated)

Deprecated

The custom limeobject approach using @lead_decorators.lead() is deprecated and will be removed in a future major version. Existing installations should migrate to Automations before updating to the next major version. See the migration guide for steps.