logo
logo

Module assignment

All entities (such as pages, page components, option lists, and so on) have a property called modules that indicates which modules are assigned. This enables you to see the content related to each module.

By default, if an entity does not have any modules assigned, it is visible to everyone. Users who have no assigned modules can still access entities; however, they must have the appropriate user policies (access to entity definitions, portal pages, and so on) to see the actual content.

Note

You must be a superuser to perform these actions.

This section explains how to:

View module assignment

When a user has a limited number of modules assigned, unlicensed pages are not available and do not appear in the dynamic navigation. If the user has only one module assigned, the navigation menu is flattened on one level, making it more usable. This is shown in the following example where the user only has the Content module assigned and the Content navigation menu is flattened on one level.

To view module assignment:

  1. On the menu bar, click Manage .

  2. On the Manage page, click Users.

  3. On the Users page, do one of the following:

    • Click the Users tab and, next to the user of interest, click View details . The modules assigned to the user are listed on the Details tab next to the Modules field.

    • Click the User groups tab and, next to the user group of interest, click View details . The modules assigned to the user group are listed next to the Modules field.

Assign modules to a user

The user entity relation ModuleToUser contains information on which modules a user can access.

To assign modules to a user:

  1. On the menu bar, click Manage .

  2. On the Manage page, click Users.

  3. On the Users page, click the Users tab.

  4. Next to the user of interest, click View details .

  5. On the Details tab, in the User properties section, click Edit .

  6. To add modules, next to the Modules field, click Add and, in the Modules dialog box, select the checkboxes next to the modules you want to add and click OK.

  7. To remove modules, click Remove next to a module.

  8. Click Save.

Assign modules to a user group

The user group entity relation ModuleToUserGroup contains information on which modules members of a user group can access.

To assign modules to a user group:

  1. On the menu bar, click Manage .

  2. On the Manage page, click Users.

  3. On the Users page, click the User groups tab.

  4. Next to the user group of interest, click View details .

  5. In the User group properties section, click Edit .

  6. To add modules, in the User group properties section, next to the Modules field, click Add and, in the Modules dialog box, select the checkboxes next to the modules you want to add and click OK.

  7. To remove modules, click Remove next to a module.

  8. Click Save.

    The selected modules are now the default modules of your new user group.

Module assignment to user group follows this behavior:

  • Modules assigned to a user group are automatically assigned to new users added to this group but not to users already in this group.
  • Removing users from a user group does not remove the default modules assigned to them when they were first added to the group.
  • Removing a module assigned by default to users when they were first added to a group does not remove them from the user group.

Assign modules using Edit in table

To assign modules using Edit in table:

  1. On the menu bar, click Manage .

  2. On the Manage page, click Users.

  3. On the Users page, select the check box next to the users you want to edit and click Edit in table .

  4. On the Mass edit users page, double-click the Modules cell to edit it.

  5. In the Modules dialog box, select the check box next to the modules you want to add and clear the check box next to the modules you want to remove.

  6. Click Select.

  7. Click Save or Save and close to finalize your changes.

    Your changes are now applied to the selected users.

Tip

On the Mass edit users page, you can copy the contents of the Modules cell to other cells by dragging the cursor across the cells to select them and then using copy and paste.

Assign modules using Excel

You can update module assignment using Excel import/export:

  1. Export user data to Excel
  2. Update exported data in Excel
  3. Import user data from Excel

Export user data to Excel

To export the user data to Excel:

  1. Create an export page.

  2. View the Export page, select the relevant users, and click Export to Excel .

    Note

    The exported Excel worksheet provides the required format for the Excel import.

  3. In the Export to Excel dialog box, in the Filename field, enter a name for the file and click Export.

    Important

    Do not activate the User-friendly column headers and the User-friendly cell values fields because you want to be able to import the Excel file back into Content Hub.

  4. Click Profile and Settings and go to the Downloads page to download the exported Excel file.

Update exported data in Excel

To update the exported data in Excel:

  1. Open the Excel file you just downloaded:

    The file contains a ModuleToUser column with the following module values.

    ModuleSolution
    M.Module.MediaSitecore DAM™
    M.Module.ProjectSitecore MRM™
    M.Module.ContentSitecore CMP™
    M.Module.PrintSitecore W2P™
    M.Module.ProductSitecore PCM™

    The following table shows an example of exported user data.

    IdentifierUsernameModuleToUser
    y1p5Vbf9TUWYDMvotFoO7QCMP_userM.Module.Content
    kMAjtFSd0k69Tc-6S-F4GwCombined_userM.Module.Media|M.Module.Project|M.Module.Content
    wQaES5Nn3kCFz_ngV3XdTADAM_userM.Module.Media
    OwHjo8uyA0KHx0GYy1oI4wFull_userM.Module.Media|M.Module.Project|M.Module.Content|M.Module.Product|M.Module.Print
    KxD7U-UT9EGHdBWrC4xpqgMRM_userM.Module.Project
    7NRbtXp2jUC9woVx2CRkDgPCM_userM.Module.Product
    oBt_h9zWG0SA7N4oYDt0ggPrint_userM.Module.Print
    Note

    The required columns for module assignment using Excel are Identifier and ModuleToUser.

  2. Add or remove modules as needed in the ModuleToUser column. As shown in the following example, make sure to separate values with a pipe (|) and that there are no spaces:

    ModuleToUser
    M.Module.Media|M.Module.Project|M.Module.Content

Import user data from Excel

To import the user data from Excel:

  1. Create an import page.

  2. View the import page and click Import.

    The module assignment is now updated according to the assignment in the Excel file.

    For example, if you update your Excel file so that CMP_user is assigned to all modules:

    identifierUsernameModuleToUser
    y1p5Vbf9TUWYDMvotFoO7QCMP_userM.Module.Media|M.Module.Project|M.Module.Content|M.Module.Product|M.Module.Print

    After you re-import the updated Excel file, CMP_user has all the modules assigned:

Can we improve this article ? Provide feedback