Skip over navigation
Documentation

Segments

Segments are dynamically filtered subsets of the data (e.g., product collection, marketing list) in OroCommerce.

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.

../../_images/use_segments_in_filter.png

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 .

In this section you will learn how to:

Create Segments

To create a new segment:

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

  2. Click Create Segment.

    The following page is displayed:

    ../../_images/segment_general.png
  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 the 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.

    ../../_images/list_columns.png

    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.
    ../../_images/segments_column.png

    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 and Close.

Manage Segments

From the Segments List

In the main menu, navigate to Report & Segments > Manage Segments.

Hover over the More Options menu to the right of the required segment line to perform the following actions:

  • View segment details. Alternatively, click on the item to open its details page.
  • Edit segment details. Update the segment details as required.
  • Clone the existing segment to simplify the custom segment creation. The cloned segment will be automatically populated with the data from the base segment. Adjust the information as required and save it.
  • Delete existing segments. In the Deletion Confirmation dialog box, click Yes, Delete.
The actions available for a segment in the More Options menu.

From the Segment View Page

  1. In the main menu, navigate to Report & Segments > Manage Segments.

  2. On the All Reports page, click the required segment line.

    Alternatively, hover over the More Options menu, and then click the View icon.

  3. On the segment page, click one of the available buttons in the upper-right corner to perform the following steps:

    • Edit segment details. Update the segment details as required.
    • Clone the existing segment to simplify the custom segment creation. The cloned segment will be automatically populated with the data from the base segment. Adjust the information as required and save it.
    • Delete existing segments. In the Deletion Confirmation dialog box, click Yes, Delete.
The actions available from the view page of any custom segment
  1. Click Save and Close as you finish.

Refresh 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 .
../../_images/segment_view.png
Browse maintained versions:3.11.6

You will be redirected to [title]. Would you like to continue?

Yes No
Back to top