Skip to content

Email Lists

Colin Robbins edited this page Jun 27, 2020 · 5 revisions

SCM Helper can automatically create email lists, based on a set of criteria. Lists can be created based on:

  • Age
  • Groups
  • Type

Configuration

lists:
    suffix: " (Generated)"  # Use to identity generated lists
    edit: False             # Allow script to modify generated lists
    confirmation: False     # Generate lists of non-confirmed and expired confirmation members
    conduct:                # Generate a list of members that have not signed the code of conduct
      - "Code of Conduct Name"

The suffix is added to each generated list, to distinguish it from lists manually created in SCM.

To prevent SCH-Helper editing SCM without your permission, the default configuration prevents this. So you will need to set this to True to enable the lists feature.

  • confirmation

    If true an email list will be created for members whose confirmation of details have expired.

You will need to create a list parameter for each list you want creating.

lists
    list:
       "Swimmer: Development Only":
            group: "Development"
            unique: True                # ONLY the group, no others
            allow_group: "Water Polo"   # If unique is set, allow this too
       "Swimmers: 17 and under on Dec 31":
           type: "swimmer"
           max_age_eoy: 17
       "Water Polo: Men: 16 and over":
           group: "Water Polo"
           min_age: 16
           gender: "male"

Where the parameters are as follows.

  • group

    The member should be a member of the specified group.

  • unique

    The member should be a member of the specified group ONLY.
    UNLESS they are in allow_group

  • type

    The member should be of the specified type

  • gender

    Either male or female.

  • min_age, max_age

    Minimum and maximum age on the date the list was created.

  • min_age_eoy, max_age_eoy

    Minimum and maximum age at the end of the year (Dec 31).

Keep lists up to date

To keep lists up to date, the command line version of SCM Helper can be run from the Windows Scheduler.

Clone this wiki locally