Important

You are browsing the documentation for version 1.6 of OroCommerce, OroCRM and OroPlatform, which is no longer maintained. Read version 5.1 (the latest LTS version) of the Oro documentation to get up-to-date information.

See our Release Process documentation for more information on the currently supported and upcoming releases.

Segments

Segments are dynamically filtered subsets of the data (e.g. product collection, marketing list). To use a set of records in reports, filters, web catalog nodes or marketing lists, you can create a segment and reuse it instead of copying the same query as a condition.

Segment combines a set of records filtered using the query that may use the following information as the foundation:

• Activity
• Data audit
• Field Condition
• Segment
• Condition Group

Dynamic segments refresh automatically. Segments of manual type require explicit refresh by clicking Refresh .

Create a Segment

To create a new segment:

1. Navigate to Reports & Segments > Manage Segments in the main menu.

2. Click Create Segment.

   The Create Segment page emerges.

3. In the General Details:

   
   1. Fill in the segment name.
   2. Optionally, add a Description to help you and other users to understand the purpose or peculiarities of the segment in the future.
   3. Select the main entity that segment should look up.
   4. Select the segment type from the list. Dynamic segments are updated as soon as any changes have taken place in the system. Manual segments are updated only following the manual refresh action when viewing the segment details.
   5. Optionally, specify the records limit. The segment shows the first X results in case the limit is provided.
   6. Select the segment owner - a business unit, members of which can manage the segment, subject to the roles defined in the system.

4. In the Designer > Columns section, define the set of the fields of the entity records to be shown in the segment.

   

   In order to add a column to the grid:

   1. Choose a field from the drop-down in the Column section.
   2. Type in a label to refer to the field in the segment report on the interface. The field label is used by default. Customize it if necessary.
   3. Define the sorting order for at least one column in the segment to sort the resulting data set by the field value.
   4. Click Add button.
   5. Reorder the columns by clicking on the line and dragging it to the necessary location.

   

   In order to manage the columns, use action icons in the last column:

   • Delete a column from the segment with .
   • Edit the column settings with .
   • Change the column position, dragging the column by the icon.

5. In the Designer > Filters section, define the filter to select the records for the segment.

6. Click Save.

Refresh a Manual Segment

To refresh the data in the segment of the manual type:

1. Navigate to Reports & Segments > Manage Segments in the main menu.
2. Click on the necessary segment line.
3. Click Refresh .

View a Segment Filtered Record

To view the records selected using the segment filter:

1. Navigate to Reports & Segments > Manage Segments in the main menu.
2. Click on the necessary segment line.