Groups
Click here to see this page in full context

 Groups

Overview

Groups allow you to organize Members into explicitly defined groupings, such as for teams, households, or companies. You can then use the Groups to search for Members, to target content, or to aggregate metrics on Leaderboards. Groups can optionally be organized into Group Classes.

Access

To access the Groups screen, select Members from the Main Navigation Menu, then select Groups from the Sub-Category menu.

Features

Groups

The Groups screen provides the following features related to managing your Groups:

 Searching and Sorting

Click hereClick here

Search

The search feature allows you to search for a specified text string anywhere within the following fields: Display Name, Description, Tag, Category label, or Category name.

  1. Optionally, in the search field near the top of Groups screen, enter the desired text string.

  2. Optionally, from the "Class" drop-down menu, select a Group Class (or "Any Class").  

  3. Press Enter, or click the search button (magnifying glass icon).

  4. The Groups screen is refreshed to show only the Groups that meet your search criteria. Please note that if you enter multiple search criteria, the platform displays only the Groups that meet ALL criteria.

  5. To remove all search criteria, click the remove button ("X" icon).

Sort

The "Sort" drop-down menu allows you to sort the Groups on a variety of different fields. To sort the list of Groups, select the desired sort option from this menu.

  • Name (default)

  • Created Date

  • Updated Date

Navigation

Once you've found the desired Group, you can navigate to the following other screens:

  • Click the Group to navigate to the Group Details screen for that Group.

 

 Create a New Group

Click hereClick here

 To create a new Group:

  1. In the "Enter Display Name" field, enter the Display Name value for the new Group.

  2. Click create. The "Edit Group" pop-up window is displayed.

  3. The "Name" field is populated with the value you entered previously; optionally edit this value.

  4. Optionally, in the "Description" field, optionally enter a description of the Group.

  5. From the "Group Class" drop-down menu, select a Group Class. 

  6. Optionally, to select an image to use for this Group, click choose file, then browse to and select the desired image file. 

  7. Check show to public if you want this Group visible to all consumers, whether they are Members or not.

  8. In the "Categories" field, optionally assign one or more Categories to this Groups. Categories are used to organize items into groups.

  9. In the "Tags" field, optionally assign one or more Tags to this Group. Tags are used to help search, filter, and organize items within the platform. You can pick an existing Tag previously assigned to other Groups, or you can type in a new Tag value.

  10. Click save. 

 

 View or Edit a Group

Click hereClick here

To view or edit the details of a Group:

  1. Search, sort, or filter the Groups screen as described above.

  2. Click on the desired Group.

  3. The Group Details screen is displayed and populated with all of the information about this Group. See Group Details for more information.

Export Group Data

The Groups screen provides the following features related to exporting Groups.

 Create Export Definition

Click hereClick here

Export definitions can optionally be saved and reused, when you need to download Groups from Loyalty. 

From the "Actions" drop-down menu in the top-right corner of the screen, select "Export Groups." The "Create New Export - Groups" pop-up window is displayed.

 

 

Timing 

  1. Select when you want to execute the export:

  • Asynchronous -- check this option if you want to execute the export manually on an ad hoc basis.

  • Execute now -- check this option if you want to execute the export immediately.

  • Create schedule -- check this option if you want to define a schedule (either a one-off execution, or a recurring schedule).

  1. If you checked "Create schedule" above, the schedule options are displayed.

Define Export ScheduleDefine Export Schedule

To define the export schedule:

  1. From the "Recurrence" drop-down menu, select an option:

  • Repeat -- Execute the export based on the defined schedule; see below for more details.

  • Once -- Execute the export once. In the "Execute once on" field, enter the date and time. Select the time zone from the "Time Zone" drop-down menu.

  • On demand -- Execute the export when specified by a user. In the "Execute once on" field, enter the date and time. From the "Time Zone" drop-down menu, select the time zone to use.

Define a Repeating Schedule

  1. From the "Schedule Composer" drop-down menu, select a unit of time -- every minute, hour, day, week, month, or year.

  2. Optionally, check "Advanced" to enable the "CRON expression" text field, and enter a custom CRON expression.

  3. In the "From" and "To" field, enter the start date and time, and the end date and time, for the repeating schedule.

  4. From the "Time Zone" drop-down menu, select the time zone to use.

 

Notification and Transport 

If you checked "Asynchronous" above, this section is displayed.

  1. To send email notifications when the import process is successful, enter one or more email addresses in the "Success Email Recipients" text field. 

  2. To send email notifications if the import encounters an error, enter one or more email addresses in the "Error Email Recipients" text field. 

 

Fields 

This section allows you to optionally include (or exclude) specific columns in the export file.

  1. From the "Inclusion" drop-down menu, select an option:

  • All -- include all columns in the export file.

  • Only Included -- in the "Fields" field, select one or more columns you want to include in the export file.

  • Except selected -- in the "Fields" field, select one or more columns you want to exclude from the export file.

  1. To include attachments in the export, select the desired attachment from the "Attachments" drop-down menu.

  2. Optionally check include attachment url to include the attachment's URL. 

 

Rules 

This section allows you to create custom business rules to define which Segments are included in the export file.

  1. Click the Add icon, then select Add Rule. The platform adds a new blank row for defining the Rule Condition. 

  2. From the first drop-down menu, select the desired Attributes. This menu is populated with all of the different Attributes for building a condition.

  3. Select a mathematical operator. The available operators will vary based on the data type of the selected Attribute. 

  4. Enter or select a value. 

  5. Some attribute types allow you to define additional criteria, such as a date range, or a channel type, for example. Select or enter the additional criteria. 

  6. Repeat the above steps as needed to define more Rule Conditions. If you need to delete a Rule Condition, click the Delete icon to it. 

  7. Once you define more than one Rule Condition, select the logical operator. From the "Include customers that meet" drop-down menu, select either: 

  • All of the following: The conditions are processed with a logical 'AND' operator such that all conditions must be true for an individual to be selected by this Segment. 

  • Some of the following: The conditions are processed with a logical 'OR' operator such that at least one of the conditions must be true for an individual to be selected by this Segment. 

You can also group rules by selecting Add Rule Group from the Add icon. Rule Groups have their own internal logical operator.

 

Associations

To export associated records:

  1. Click add. A new row is displayed.

  2. Check Enabled. 

  3. From the "Association" drop-down menu, select the type of associated record.

  4. From the "Inclusion" drop-down menu, select an option:

  • All -- include all columns in the export file.

  • Only Included -- in the "Fields" field, select one or more columns you want to include in the export file.

  • Except selected -- in the "Fields" field, select one or more columns you want to exclude from the export file.

  1. Repeat the above steps needed to include more associated records. To remove an association, click the delete icon next to it.

 

Children 

To export child records joined to the main record:

  1. Click add. A new row is displayed.

  2. Check "Enabled."

  3. From the "Child" drop-down menu, select a child record type.

  4. From the "Inclusion" drop-down menu, select an option:

  • All -- include all columns in the export file.

  • Only Included -- in the "Fields" field, select one or more columns you want to include in the export file.

  • Except selected -- in the "Fields" field, select one or more columns you want to exclude from the export file.

  1. Repeat the above steps needed to include more associated records. To remove an association, click the delete icon next to it.

 

Finish

When finished creating the Export Definition, click save. 

 

View or Edit an Export Definition

Click hereClick here

To view or edit a Group Export Definition:

  1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Groups Exports." The "Groups Export Definitions" pop-up window is displayed and populated with a list of all Group Export Definitions.

  2. From the "Action" column of the desired Export Definition, click the Edit icon. The "Edit Export" pop-up window is displayed.

  3. Make any necessary changes to the Export Definition properties.

  4. When finished, click save.

 

 Manually Execute an Export Definition

Click hereClick here

To manually execute a Group Export Definition:

  1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Groups Exports." The "Groups Export Definitions" pop-up window is displayed and populated with a list of all Group Export Definitions.

  2. From the "Action" column of the desired Export Definition, click the Enqueue this Export icon. A confirmation dialog box is displayed.

  3. Click confirm.

 

 Download an Export Definition

Click hereClick here

To download the last execution of an Export Definition:

  1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Groups Exports." The "Groups Export Definitions" pop-up window is displayed and populated with a list of all Group Export Definitions.

  2. In the "Action" column of the desired Export Definition, click the Download File icon. The platform downloads the file to your PC.

 

 Delete an Export Definition

Click hereClick here

To delete a Group Export Definition:

  1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Groups Exports." The "Groups Export Definitions" pop-up window is displayed and populated with a list of all Group Export Definitions.

  2. From the "Action" column of the desired Export Definition, click the Delete icon. A confirmation dialog box is displayed.

  3. Click confirm.

Import Group Data

The Groups screen provides the following features related to importing Groups.

 Import Groups

Click hereClick here

To import Groups, from the "Actions" drop-down menu in the top-right corner of the screen, select "Import Groups." The "Create New Import - Groups" pop-up window is displayed.

 

Basic Properties

  1. From the "Import Method" drop-down menu, identify how you want the platform to handle the import records, such as create new records only, update existing records only, or both create and update records.

  2. In the "File Options" field, select one or more fields used to identify existing records in the database.

  3. If you want to import blank values, select the "Yes" radio button next to "Include Blank Values."

  4. The platform supports email and phone number syntax validation on the appropriate import fields. To run this validation, select the "Yes" radio button next to "Validate Records."

  5. If you account is configured with business units, select the desired Business Unit from the "Business Unit" drop-down menu.

  6. To send email notifications following the import process, enter one or more recipient email addresses in the "Recipients" field.

  7. To send email notifications following a failed import process, enter one or more recipient email addresses in the "Failed Import Email Recipients" field.

  8. To select the import file, click choose file, then browse to and select the desired file.

  9. Select a column separator: Comma or Semicolon.

 

Child Options

  1. To upload "child" records along with the main parent record, click add child.

  2. Select the child resource from the "Resource" drop-down menu.

  3. In the "Find Options" field, select one or more fields used to identify existing records in the database.

  4. If you want to skip the child record when the parent record is skipped, check "Skip with Parent."

  5. Repeat the above steps as needed to define additional child records. To delete a child record, click delete.

 

Import Options

To configure additional import options:

  1. Click add options.

  2. To use a lookup table, select the desired table from the "Lookup table" drop-down menu.

  3. From the "Lookup column" drop-down menu, select the desired column on the lookup table.

  4. Enter a value in the "Rename as" field.

  5. In the "Find by columns" field, select one or more columns used to identify existing records in the database.

  6. If the lookup table is required, select the "Yes" radio button next to "Required."

  7. If you want to stop the import process if a duplicate record is found, select the "Yes" radio button next to "Abort on Duplicate Record."

  8. Optionally enter any additional conditions as Groovy expressions in the "Condition" field. 

  9. Optionally, click delete to remove the additional import options.

 

Finish

  1. When finished, click submit.

 

 View Group Imports

Click hereClick here

To view a list of previous imports:

  1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Groups Import List." The "Groups Import List" pop-up window is displayed and populated with a list of all previous imports. For each import, the screen displays the following:

  • Imported by

  • Filename

  • Result (i.e., the number of records successfully imported, the number of failed records, and the number of skipped records)

  • Created at

  • Duration

  • Status

 

 Back to Members Overview

Last Updated: August 2024

 

Copyright © Marigold   Marigold Loyalty Online Help 24.4  August 2024