Uploaded image for project: 'Magnolia Personalization'
  1. Magnolia Personalization
  2. MGNLPN-266

As a developer, I want to be able to define a component as un-personalizable

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Closed
    • Priority: Neutral
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.3
    • Component/s: None
    • Labels:
      None
    • Epic Link:
    • Sprint:
      Kromeriz 54
    • Story Points:
      3
    • Magnolia Release:
      5.4.9

      Description

      Proposal:

      1) Add a new property personalizable in the template definition. We already support similar properties deletable, moveable and writable that are specific to component templates and restrict the actions that editors can take on components. This is an existing pattern.

      Example:

      my-module/templates/components/textImage.yaml
      templateScript: /my-module/components/textImage.ftl
      renderType: freemarker
      dialog: my-module:components/textImage
      personalizable: false
      

      The new property personalizable should be true by default. This means that component personalization is an opt-out feature: a site admin needs to specifically turn the feature off if they don't want to allow component personalization. It also means that an editor can start experimenting with component personalization immediately without having to ask IT to turn the feature on.

      2) To restrict personalization of a component in a particular area, add a new permission personalize in the area definition. This is also an existing pattern. We already support the permissions write, move and delete. As a use case, you may want to allow editors to personalize textImage everywhere except in the footer area.

      Example: Restrict personalization of textImage in the footer area to the superuser role

      /my-module/templates/pages/home.html (partial fragment)
      areas:
        footer:
          availableComponents:
            textImage:
              id: mtk:components/textImage
              permissions:
                personalize:
                  roles: [superuser]
      

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              rkovarik Roman Kovařík
              Reporter:
              ahietala Antti Hietala
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:
                Date of First Response: