flatfiles_emails_of_groups

Description

This client will generate a flat txt file by Groups, containing the e-mail addresses of its members (one by line).

Configuration

hermes-client-usersgroups_flatfiles_emails_of_groups:
  # MANDATORY
  destDir: "/path/where/files/are/stored"

  # Facultative: if set, will generate a file only for the specified group names in list
  onlyTheseGroups:
    - group1
    - group2

Datamodel

The following data types must be set up:

• Users, requires the following attribute names:
  • user_pkey: the user primary key
  • mail: the user email address
• Groups, requires the following attribute names:
  • group_pkey: the group primary key
  • name: the group name, that will be compared to those in onlyTheseGroups, and used to name the destination file “groupName.txt”
• Only one of the following two options:
  • GroupsMembers, for which each entry must contain a pair (user_pkey, group_pkey). Requires the following attribute names:
    • user_pkey: the user primary key
    • group_pkey: the group primary key
  • MembersOfGroups, for which each entry must contain a pair (group_pkey, groupmembers). Requires the following attribute names:
    • group_pkey: the group primary key
    • groupmembers: the exhaustive list of logins for the Users members of the group

  datamodel:
    Users:
      hermesType: your_server_Users_type_name
      attrsmapping:
        user_pkey: user_pkey_on_server
        mail: mail_on_server

    Groups:
      hermesType: your_server_Groups_type_name
      attrsmapping:
        group_pkey: group_pkey_on_server
        name: group_name_on_server

    GroupsMembers:
      hermesType: your_server_GroupsMembers_type_name
      attrsmapping:
        user_pkey: user_pkey_on_server
        group_pkey: group_pkey_on_server

    MembersOfGroups:
      hermesType: your_server_MembersOfGroups_type_name
      attrsmapping:
        group_pkey: group_primary_key_on_server
        groupmembers: list_of_group_member_logins_on_server