Skip to content

company_segments.rst

Latest commit

 

History

History
224 lines (138 loc) · 6.86 KB

company_segments.rst

File metadata and controls

224 lines (138 loc) · 6.86 KB
Raw

Company Segments

Company Segments group Companies based on shared attributes or criteria, enabling targeted Account-Based Marketing - ABM - strategies. Use Company Segments to organize Companies for Campaign targeting, reporting, and bulk operations.

Note

Company Segments are distinct from Contact Segments. While Contact Segments group individual Contacts, Company Segments group entire Companies. This lets you target organizations rather than individuals in your marketing automation.

Creating a Company Segment

  1. Navigate to Companies > Company Segments in the menu.
  2. Click the New button to create a new Company Segment.
  3. In the Details tab, configure the following:
    • Name - The internal name for your Company Segment.
    • Public name - An optional alternate name visible in certain interfaces.
    • Description - A description of the Segment's purpose.
    • Active - Toggle to make the Segment available for use. Inactive Segments aren't available as Campaign sources or in other areas of Mautic.

Company Segment filters

Use filters to create dynamic Company Segments that automatically include or exclude Companies based on field values. Mautic evaluates Companies against these filters during Segment rebuilds and updates membership accordingly.

Configuring filters

  1. In the Company Segment editor, click the Filters tab.
  2. Select a Company field from the dropdown to filter by.
  3. Choose an operator and specify the filter value.
  4. Add additional filters using And or Or logic:
    • And - Companies must match all connected filters.
    • Or - Creates a new filter group that includes Companies matching any group.
  5. Click Save and close to save the Segment.

Available filter operators

The available operators depend on the field type:

  • Equals / Not equal - Exact match or exclusion of a value.
  • Empty / Not empty - Whether the field has a value.
  • Like / Not like - Partial string matching with wildcards.
  • Contains / Starts with / Ends with - String position matching.
  • Greater than / Less than - Numeric or date comparisons.
  • Regexp / Not regexp - Regular expression pattern matching.

Note

Companies automatically move into or out of dynamic Segments when their field values change and the Segment Cron job runs. See :ref:`Company Segment Cron job<Company Segment Cron job>` for configuration details.

Static Company Segments

Static Company Segments don't use filters. Instead, you manually manage membership through the methods below.

Adding Companies manually

From the Company record

  1. Open the Company you want to add to a Segment.
  2. Click the dropdown arrow next to Edit and select Segments.
  3. Select the Company Segments to add the Company to.
  4. Click Save.

From the Company list view

  1. In the Company list, select the checkboxes next to the Companies you want to modify.
  2. Click the green arrow that appears at the top of the column.
  3. Select Change Segments.
  4. Choose the Segments to add or remove Companies from.
  5. Click Save.

Using Campaign actions

You can add or remove Companies from Company Segments as part of a Campaign workflow using the Modify Company's Segments action. For more information, see :ref:`Campaign Company Segment actions<campaign company segment actions>`.

Viewing Company Segment membership

When viewing all Company Segments, the # Companies column displays the number of Companies in each Segment. During rebuilds, this column shows Building until the process completes.

To view Companies in a Segment:

  1. Navigate to Companies > Company Segments.
  2. Click the Company count link for the Segment you want to view.

This opens the Company list filtered to show only Companies in that Segment.

Searching Companies by Segment

Filter the Company list by Segment membership using the search syntax:

segment:{segment-alias}

Replace {segment-alias} with the alias of your Company Segment. Mautic generates the alias automatically from the Segment name, but you can also set it manually.

Managing Company Segments

Editing a Company Segment

  1. Navigate to Companies > Company Segments.
  2. Click the Segment name or select Edit from the dropdown menu.
  3. Make your changes and click Save and close.

Cloning a Company Segment

  1. Navigate to Companies > Company Segments.
  2. Click the dropdown arrow next to the Segment.
  3. Select Clone.

Mautic creates a copy of the Segment with the same filters and settings.

Activating and deactivating

Make a Segment active or inactive to control whether it's available for use:

  1. In the Company Segment list, click the colored status indicator - green when active, red when inactive.
  2. You can also edit the Segment and toggle the Active setting.

Inactive Segments aren't available in Campaigns or other features.

Deleting Company Segments

  1. Navigate to Companies > Company Segments.
  2. Select the checkbox next to the Segment or Segments to delete.
  3. Click the dropdown arrow and select Delete.
  4. Confirm the deletion.

Warning

Mautic prevents deletion of Company Segments that filters in other Segments reference. Remove the dependency before deleting.

Company Segment Cron job

To keep Company Segments current, configure a Cron job to run the rebuild command:

php /path/to/mautic/bin/console mautic:company-segments:update

This command evaluates all Companies against Company Segment filters and updates membership accordingly.

Available options:

  • --batch-limit=X - Number of Companies to process per batch. Default is 300.
  • --max-companies=X - Maximum number of Companies to process per execution.
  • --segment-id=X - Process only a specific Company Segment.

Run this command regularly, for example every 15 minutes, staggered with other Cron jobs to distribute server load.

0,15,30,45 * * * * php /path/to/mautic/bin/console mautic:segments:update
2,17,32,47 * * * * php /path/to/mautic/bin/console mautic:company-segments:update
5,20,35,50 * * * * php /path/to/mautic/bin/console mautic:campaigns:update