Skip to content

Site Factory configuration

Parent Location

You can define the parent Location for a new site in the configuration. Each new site is created in the designated Location.

To define a parent Location, add a new configuration key to the site template definition. Each template is assigned to its own Location. This can be either a Location ID (for example, 62), or a recommended remote Location ID (for example, 1548b8cd8dd4c6b5082e566615d45e91).

Add the configuration key to your template:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
ez_platform_site_factory:
    templates:
        site1:
            siteaccess_group: example_site_factory_group_1
            name: example_site_1
            thumbnail: /path/to/image/example-thumbnail_1.png
            parent_location_id: 62
        site2:
            siteaccess_group: example_site_factory_group_2
            name: example_site_2
            thumbnail: /path/to/image/example-thumbnail_2.png
            parent_location_remote_id: 1548b8cd8dd4c6b5082e566615d45e91

Now, you can see the path to the new site's parent Location under design selection. If you have sufficient permissions, you can change the defined Location during site creation. If the parent Location is not defined, you have to choose it from Universal Discovery Widget.

Site skeletons

The Site skeleton enables you to copy an entire content structure of the site design to the defined Location.

Site skeleton copying is a one-off operation, it only happens during the site creation process. After that, you cannot copy the Site skeleton again, for example in the edit view.

You can create as many skeletons as you need and assign them to templates. Remember that one template can only have one Site skeleton.

If the design does not have a defined Site skeleton, a directory of the new site is created in a standard Site Factory process.

To define a Site skeleton, add the site_skeleton_id or site_skeleton_remote_id key to the site template definition. This can be either a Location ID (e.g. 5966), or a remote Location ID (e.g. 3bed95afb1f8126f06a3c464e461e1ae66).

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
ez_platform_site_factory:
    templates:
        site1:
            siteaccess_group: example_site_factory_group_1
            name: example_site_1
            thumbnail: /path/to/image/example-thumbnail_1.png
            site_skeleton_id: 5966
        site2:
            siteaccess_group: example_site_factory_group_2
            name: example_site_2
            thumbnail: /path/to/image/example-thumbnail_2.png
            site_skeleton_remote_id: 3bed95afb1f8126f06a3c464e461e1ae66

Now, you can choose a design with a defined Site skeleton, and decide if you want to use its skeleton by toggling Generate site using site skeleton.

User Group skeletons

With User Group skeletons you can define Policies and Limitations that apply to selected groups of users who can access the site.

You can create many User Group skeletons and associate them with many templates. One template can have many User Group skeletons assigned.

To create a User Group skeleton, first go to Admin -> Site skeletons and add a User Group to the list of available skeletons. Then, review the detailed information of the newly created User Group skeleton, copy the Location ID or the Location remote ID, and add a configuration key to the site template definition:

1
2
3
4
5
6
ez_platform_site_factory:
    templates:
        <site_name>:
            # ...
            user_group_skeleton_ids: [ <id_skeleton1>, <id_skeleton2>, ... ]
            user_group_skeleton_remote_ids: [ <id_skeleton3>, <id_skeleton4>, ... ]

Manage the permissions associated to the User Group skeleton by assigning Roles. Make sure that the Roles that you assign to the User Group skeleton do not contain Location-based Limitations. User Group skeletons cannot contain individual User Content items either.

User Group skeletons are retained after deleting the site.

Automatic update of Roles

Role definitions can contain user/login Policies with Limitations that limit user access to certain sites. To avoid the need to add the new SiteAccess to Limitations for all Roles, you can decide that the Roles you select are automatically updated when the site is created, updated or deleted.

In config/packages/ezplatform_site_factory.yaml, add a list of Roles which should have access to the frontend when a site is created in Site Factory, for example:

1
2
3
4
ez_platform_site_factory:
    # ...
    enabled: true
    update_roles: [Anonymous, Administrator]

For more information about Roles and Policies, see Permissions.