Admin Guide
Search…
Fetch From URL
Synchronizing users and groups from a .csv file residing on a SFTP server

Users Data .CSV

You can synchronize users from .csv file residing on a Secure FTP Server (SFTP Server) to add or remove users in MangoApps.
Here's a sample of the Users .csv file on the server:
This file creates the users in your domain.

Synchronizing Users

To sync users:
Admin Portal > Users > Add Users > Fetch From URL > Sync Users
  1. 1.
    Click the toggle bar for Synchronize Users to enable synchronization of users from a .csv file residing on a server.
  2. 2.
    Enter the URL where the .csv file is residing on the server. You MUST enter the absolute path of the file for successful file and data fetching.
  3. 3.
    Configure the Advanced Sync Settings.
    1. 1.
      In the When Fetched Users Already Exist in MangoApps option, select the Skip existing users option to NOT overwrite the data of existing users. OR
      Select the Update existing users option to overwrite the data of existing users.
    2. 2.
      In the Email Invites For Newly Added Users option, mark the checkbox to send an email to all the new users with their login credentials.
  4. 4.
    Configure the Authentication options.
    1. 1.
      In the Login ID, enter the login ID for the SFTP server for authentication when MangoApps tries to sync data from the .csv file.
    2. 2.
      In the Password, enter the password for the SFTP server for authentication when MangoApps tries to sync data from the .csv file.
    3. 3.
      In the AES-256 Decryption Key, enter the decryption key for the .csv file if you have encrypted the file with AES-256 Encryption for increased security.
  5. 5.
    Select preferred the sync schedule from the drop-down.
    1. 1.
      Select the Once Every Day option to automatically sync users from the .csv file once in 24 hours. OR
    2. 2.
      Select Every 12 Hours option to automatically sync users from the .csv file every 12 hours.
  6. 6.
    Click the Save Settings button to save the configurations and test the SFTP Server connection. The system displays a success message on verifying all the configurations and successfully connecting to the server.
  7. 7.
    Click the Save Settings & Force Sync Now button to save the configurations and sync all users from the .csv file immediately. The system displays a success message on syncing the users successfully via the .csv file.
Click the Download sample CSV link to download the sample file for syncing users. You must NOT change/edit the field names in the first row since it can result in mapping issues for the data.
After a successful sync, the system sends an email to the network admin who initiated the sync.
Users imported and invited via Admin Portal > Users > Add Users > Fetch From URL are automatically assigned the "Network User" role irrespective of their email address. For example, if the network (of help-docs.com) invites a user with the email address [email protected] or [email protected], then these users are added as network users even if their email address does not match the company domain (for example [email protected]).

Groups & Group Membership .CSV

You can synchronize groups and groups membership data from .csv file residing on a Secure FTP Server (SFTP Server) to manage the groups and memberships in MangoApps.

Here's a sample of the Groups .csv file on the server:

This file creates the actual structure and categories of the groups in your domain.
Fields in the .csv file:
  • Groupname: Name of the group.
  • Id: Unique Id of the group. The system uses this unique ID for assignments from the .csv file.
  • EmployeeID: Employee ID of the owner of the group. By default, if the employee ID or email ID is not found or the user does not exist; the creator of the domain is assigned as the group owner.
  • Grouplevel (Grouplevel1...Groupleveln): Depicts the hierarchy of categories of the groups.

Here's a sample of the Memberships .csv file on the server:

This file is used ONLY for the assignment of groups to the existing users on your domain using their unique employee ID.
Fields in the .csv file:
  • EmployeeID: Employee ID of the member belonging to the group. The system automatically assigns the group to the user using the employee ID.
  • Grouplevel (Grouplevel1...Groupleveln): Depicts the actual groups assigned to the users based on their employee ID. The assignments are carried out based on the group ID in the Groups .csv file.
Click the Download sample CSV link to download the sample file for syncing groups. You must NOT change/edit the field names in the first row since it can result in mapping issues for the data.

Synchronizing Groups and Memberships

To sync group data:
Admin Portal > Users > Add Users > Fetch From URL > Sync Groups
  1. 1.
    Click the toggle bar for Synchronize Groups to enable synchronization of groups and group memberships data from a .csv file residing on a server.
  2. 2.
    In the Group CSV URL text box, enter the URL where the .csv file for the groups' data is residing on the server. You MUST enter the absolute path of the file for successful file and data fetching.
  3. 3.
    In the Group Membership CSV URL text box, enter the URL where the .csv file for the group memberships data is residing on the server. You MUST enter the absolute path of the file for successful file and data fetching.
  4. 4.
    Configure the Advanced Sync Settings.
    1. 1.
      In the When Fetched Users Already Exist in MangoApps option, select the Skip existing users option to NOT overwrite the data of existing users. OR
      Select the Update existing users option to overwrite the data of existing users.
    2. 2.
      In the Email Invites For Newly Added Users option, mark the checkbox to send an email to all the new users with their login credentials.
  5. 5.
    Configure the Group Membership options.
    1. 1.
      Select the Match the group membership exactly with what's in the CSV option to overwrite the existing group memberships to EXACTLY match the assignments in the .csv file.
      This results in the addition and removal of members in the groups.
    2. 2.
      Select the Add the new members from the CSV but don't remove the other members from the group option to keep the existing group memberships as is and ONLY ADD new members to the groups as per the assignments in the .csv file.
      This does NOT remove any user from the groups.
    3. 3.
      Select the Match the group membership with what's in the CSV but don't remove the members that were manually added from the MangoApps UI option to add new group memberships as per the assignments in the .csv file and retain the existing users in the group which were added using the MangoApps UI.
      This does NOT remove the users that did not earlier come from the CSV.
  6. 6.
    Configure the Authentication options.
    1. 1.
      In the Login ID, enter the login ID for the SFTP server for authentication when MangoApps tries to sync data from the .csv file.
    2. 2.
      In the Password, enter the password for the SFTP server for authentication when MangoApps tries to sync data from the .csv file.
    3. 3.
      In the AES-256 Decryption Key, enter the decryption key for the .csv file if you have encrypted the file with AES-256 Encryption for increased security.
  7. 7.
    Select preferred the sync schedule from the drop-down. Select the Once Every Day option to automatically sync groups and group membership data from the .csv file once in 24 hours. OR
    Select Every 12 Hours option to automatically sync groups and group membership data from the .csv file every 12 hours.
  8. 8.
    Click the Save Settings button to save the configurations and test the SFTP Server connection. The system displays a success message on verifying all the configurations and successfully connecting to the server.
  9. 9.
    Click the Save Settings & Force Sync Now button to save the configurations and sync all groups and group membership data from the .csv file immediately. The system displays a success message on syncing the data successfully via the .csv file.
After a successful sync, the system sends an email to the network admin who initiated the sync.

FAQs

What happens if the group in the membership CSV does not exist?

The member assignment is skipped if the matching group is not found in the domain.

What happens if the user in the membership CSV is in suspended state?

The user in suspended state is assigned the groups and membership as per the .csv file but the status is not updated. The assignment are displayed when the user is "Activated".

What happens if the group name is in uppercase in the groups CSV while it is in lowercase in MangoApps?

MangoApps group name matches are case-insensitive.

How are groups in MangoApps assigned group IDs?

Groups are not assigned an group ID in the MangoApps UI, group IDs can ONLY be assigned via the groups CSV file.
Did this article help? Your feedback adds value when we shape up the help articles. Hit the smiley
below to let us know!
Last modified 2yr ago