How to create user profiles

Populate your server painlessly

The Virola server admin can choose how user profiles are created on the server. Depending on the server configuration, purpose, and overall company structure, several methods may be used to create user profiles:

  • Add users manually, one by one
  • Enable user self-registration, allowing users to create their own profiles
  • Import users in bulk from a JSON file
  • Synchronize users via the LDAP Directory Service

Adding users manually

To create a user profile manually do the following:

  1. Go to Administration / Manage Users menu in the Virola client app
  2. Click "Create" link there
  3. Specify username and password
  4. Click "Create" button
  5. Open and update user profile or finish the process by clicking "Ok" button.
Screenshot of the process of manual user profile creation

User self-registration

  1. Enable the user self-registration option in Administration / User self-registration.
  2. Ask users to install the Virola client app
  3. Invite users to register on your server using one of the following methods:
    • Send them a self-registration link which has the following look:
      virola://command?action=self-registration&host=127.0.0.1&port=7777
      where
      • 127.0.0.1 is your server host IP or host name
      • 7777 is your server port number
      The self-registration link will open the Virola client app and initiate the self-registration wizard, where users will be prompted to create a username and password.
    • Provide them with your host name, port number, and self-registration instructions via any convenient method
Screenshot of the process of manual user profile creation

Import from JSON

JSON import supports the import of multiple users from a text file containing an array of objects in JSON format. Example:

[
    {
        "user_name": "alex"
    },
    {
        "user_name": "john",
        "password": "qwerty",
        "status": "active",
        "is_admin": true,
        "regular_in_rooms": [1, 2, 3],
        "moderator_in_rooms": [4, 5],
        "properties": {
            "title": "Dr.",
            "first_name": "John",
            "last_name": "K.",
            "middle_name": "Smith",
            "nickname": "Jonny",
            "date_of_birth": "10/26/1990",
            "job_title": "Director",
            "job_department": "Sales",
            "job_description": "Development of sales strategy",
            "phone_number": "+1234567890",
            "email_address": "jonny@qweedcxzas.com",
            "social_profile_url": "https://www.linkedin.com/",
            "postal_address": "123 ABC Str."
        }
    }
]
                    

You can either specify only the user_name field in the JSON, or provide complete user details, including the list of rooms the user should be added to and their role in each room.

Ensure that the JSON format is followed strictly. Any fields that do not conform to the specified format will be ignored.

To import users from JSON do the following:

  1. Follow Administration / Manage Users menu in the Virola client app
  2. Click "Import" link and specify the path to the JSON file with users, then click "Next"
  3. On the appeared form you will get information about extracted users. If you would like to proceed, click "Import" button and have your users imported. Duplicated users will be ignored
Screenshot of JSON import process

Synchronization with LDAP Directory Service

If you use LDAP directory service to manage your contacts, you can synchronize users and have them added to your Virola client. To start synchronization with your LDAP directory service you need to follow Administration / Directory Server menu, specify connection details and map fields for contacts synchronization.

Screenshot of the process of manual user profile creation