Mass User Creation

Create multiple users in CommPeak Dialer from a file: learn about the necessary file format, field mapping, and upload process.

You can create multiple users at once from a .csv file with user details.

CSV File Example

Here, you can find a .csv file example with both mandatory and optional columns.

Screenshot of csv file example

CSV file example

Rules for Creating the .xlsx File

  • Size: the size should not exceed 500 users per file.

  • Mandatory Header: the file must contain a header to recognize from which columns to pull the data.

  • Columns:

    • mandatory columns are Username, Email, Role, and SIP Settings
    • you can use the option to generate virtual extensions and let the system do it. Or you can upload your own extensions. In such a case, the file must also contain the column with virtual extensions
    • optional are Desk, Skill Group, First name, and other columns, depending on your choice of users in one file.
  • SIP options: If you want to use SIP options other than WebRTC, the .csv file should contain the relevant data, as you will see in the SIP Settings below.

  • Role, skill group, or desk:

    • If you create users with the same role, skill group, or desk, you don't need to add columns with roles, skill groups, or desks, as you will use data from the Dialer.

    • If you create users with different roles, skill groups, or desks, add IDs from the Dialer to the relevant columns. Copy data from the ID column on the following pages and enter the IDs in the .csv file:

      • desks: Users > User Management > Desks tab

        Screenshot of the Desks tab in Users Management

        Desks tab in Users Management

      • roles: Users > Users Management > Roles tab

        Screenshot of the Roles tab in Users Management

        Roles tab in Users Management

      • skill groups: Users > Users Management > Skill Groups tab

        Screenshot of the Skill Groups tab in Users Management

        Skill Groups tab in Users Management

Creation Steps

Once the file with user data is ready, you can upload it to the system.

To create multiple users:

  1. Go to Users > Users Management.

  2. Click Create from file in the top-right of the Users Management page.

    Screenshot of the Create from file button

    Create from file button

  3. Drag and drop a file or browse for it. Click Upload.

    Screenshot of uploading a file

    Uploading a file

  4. Map four required fields with file columns:

  • Username, Email - select the relevant column name from the drop-down list:

    Screenshot of selecting the Username column

    Selecting the Username column

  • Virtual Extension - select the appropriate column name from the drop-down list.

    Screenshot of selecting the Extension column

    Selecting the Extension column

    Otherwise, you can select the checkbox below the drop-down list, and the system will generate the next available virtual extension numbers for you.

    Screenshot of selecting the option to generate virtual extensions

    Selecting the option to generate virtual extensions

  • Role:

    • If creating users with the same role, select From Dialer in the first drop-down list. Then select a role in the second list:

      Screenshot of selecting the same role for users

      Selecting the same role for users

    • to assign different roles, make sure the file contains role IDs from the Dialer, then select the relevant column in the drop-down list:

      Screenshot of selecting the Role column

      Selecting the Role column

  • SIP Settings:

    • the default option is Use WebRTC to call using the softphone built into the Dialer.
      If you want to set other options, the .csv file with user details should contain the relevant data.

      Screenshot of the WebRTC option

      Use WebRTC option

    • Use CommPeak classic PBX - call via an existing CommPeak PBX domain. In this case, you select the needed domain in the drop-down list.

      Screenshot of the classic PBX option

      The classic PBX option

      You should also have a column with PBX device (extension) numbers in your file. It can either be the same column as you used for the Virtual Extension field, or you can create a separate column for it.

      Screenshot of the Extension column

      Extension column

    • Use Custom URI - call via a third-party, external PBX. In your file, each user must have a link that includes a PBX domain and a device.

    • Use Built-in PBX - call via the built-in PBX; no further action is required.

  1. Select the authentication type:
  • Default from Role/Tenant - use the default setting for the role. If no role settings are available, the default settings for the tenant will be used.

  • Disabled - login without 2FA - apply no login security enhancements.

  • Email - with one-time code - enable email validation using a temporary password.

  • Google 2FA App - with one-time code - enable login validation using the Google Authenticator app.

    Screenshot of the 2FA options

    2FA options

  1. Optionally, click the toggle switch and add advanced security settings. See tooltips for explanations.

    Screenshot of the advanced security settings

    Advanced security settings

  2. Map the optional fields as needed. For desks and skill groups, follow the same logic as for roles. Either assign all users to the same desk or skill groups or map the relevant data from the .csv file.

    Screenshot of the mapping optional fields

    Mapping optional fields

  3. If you plan to use an IP phone or a softphone that doesn't accept symbols other than digits, select the Generate user passwords with digits only (not recommended) checkbox.

  4. Click Import Users.

Upload Result

After the file has been uploaded, the system will inform you about the number of uploaded or duplicate users and errors with validation or missing user details.

Screenshot of Upload result

Upload result

  1. Click Download Error Details to view and fix the errors, for example, remove duplicates. Then repeat the upload.

    Screenshot of the error details in the result file

    Error details in the result file

  2. Click Download Success Details to save a .csv file with temporary user passwords.

Screenshot of the success details in the result file

Success details in the result file

After you click Continue, new users will appear in the Users table.

❗️

IMPORTANT

If you fail to download the success details with temporary passwords, you will need to reset passwords one by one on the Users page.