logo
logo

Exporting user accounts

You can export user accounts to an Excel workbook. It is useful when you want to edit, add, or delete user account information. After you update the user account data, you import the updated Excel file back into Sitecore Content Hub™.

Create the export profile

Following best practices, create an export profile. It allows you to export only the data fields you require. You can still export user account data without an export profile when you want to export everything without filtering out unnecessary fields.

The export profile used in the following example allows you to export:

In the following example, the export profile created allows you to export the following fields:

  • id
  • identifier
  • Username
  • UserGroupToUser
  • ModuleToUser

These fields are defined in the Text settings:

{
  "properties": ["id", "identifier", "Username"],
  "relations": {
    "UserGroupToUser": {
      "exportRelatedEntities": false
    },
    "ModuleToUser": {
      "exportRelatedEntities": false
    }
  },
  "includeSystemProperties": false,
  "version": "1.1"
}

The example export profile we use to export users is as follows:

Create an Export page

We create a dedicated page to use to select and export the users, with a Search component and a Selection component:

  1. On the menu bar, click Manage .

  2. On the Manage page, click Pages.

  3. Create a new blank page.

    • Name: define the name of the new page.
    • Page type: select Blank page.
    • Master layout: select Basic.

  4. To the new page, add a Selection component and a Search component.

Edit the Selection component

To edit the Selection component:

  1. Click More options and select Edit .

  2. On the General settings tab, turn the Enable export to Excel option to active.

    The Linked search component is autocompleted, so you do not need to change it:

  3. On the Operations tab, select the User definition.

  4. Add any required operations to the Selection component by clicking ADD OPERATION and selecting the operations from the menu.

  5. On the Export Excel settings tab, click Add definition and add the User definition.

  6. Click + Add export profile and select the export profile.

    In this example, we select the User export profile:

  7. Click Save and close.

Edit the Search component

To edit the Search component:

  1. On the Layout tab, next to the Search component, click More options and select Edit .

  2. Add the User definition as a filter to the Search component:

    • Click add .

    • Select the Filter type of Definition.

    • Select the User (User) definition.

  3. On the Functionality tab, turn the Selection option to active.

  4. On the Selection tab, select Shared pool:

    • Click Create new... to create a new selection pool that is specific for the user's selection.

    • In the New selection pool dialog box, input a name for the selection pool. In the following example, we name it ExportUsers.

  5. Click the Output tab.

  6. Turn the Table option to active and turn the Grid option to inactive.

  7. In the Template section, select TableNoImage.

  8. In the Fields section, add the required fields, for example:

    • Username
    • Disable user
    • User groups
    • Modules
  9. Click Save and close.

Export to Excel

After you create the dedicated page, you can use it to export users.

To export users to Excel:

  1. Select the users to export using the checkboxes or use the Select all option to export all the users.

  2. Click Export to Excel .

  3. On the Export to excel dialog box, enter:

    • Cultures - define which culture you need to download (drop-down menu).

    • User-friendly column headers - define whether to use labels instead of technical member names for column headers.

    • User-friendly column headers: define whether to use labels instead of technical member names for column headers.

      Warning

      If you turn this switch to active, you cannot reimport the file.

    • User-friendly cell values - define whether to add extra columns with user-friendly labels for every value.

  4. Click Export.

    The export is processed. You can verify the status of the export on the Background processes page.

  5. When the export is completed, go to the Downloads page to download your workbook.

Can we improve this article ? Provide feedback