Rationale

The software provides to user one template to use when creating a space. This helps the creator to get a pre configured space (access control, apps) so it is quicker to add a space.

Problems are that:

• only one template is provided
• this template cannot be edited
• new templates cannot be added

1. Functional Requirements

Top User Stories

When accessing the administration site, I can access a templates management page for space templates.
From there, I will be able to:

• Add new template
• List existing ones
• Edit existing ones

Each template must be extensible
So I can

1. Duplicate it if needed (by UI)
2. Allow any Product teams to define the layout, the list of apps to be in predefined space templates

For each template, I can:

• see the icon, the name, the description
• check which members group can create spaces using each template
• list spaces created using templates
• enable / disable the use of templates
• access options to: edit properties, duplicate, delete

By default, items are sorted alphanumerically

Product Templates cannot be deleted. They can be disabled.

When creating a template, then:

• First, I have to:
  • add a name
  • add a description
  • select an icon
• Then I will have to decide about the configuration of the template:
  • Mandatory creation steps: does user need to add a name, to invite users, to add properties, to update access control rules when creating the space?
    • Minimum step: Name or Invitation
    • Default config: all steps required
  • Access Control: What is the default rules to access and list the space?
    • Default config: Open / Listed
  • Permissions:
    • Who can create a space? (default: admins)
    • Who can edit navigation of the space? (default: admins)
    • Is the space an editorial one?
      • That means that you can decide if the content creation restriction is ON or OFF
      • If ON, only space admin and content writers can add contents
      • If OFF, any member can add contents
      • Default config: OFF
    • Who can delete a space?
      

Once saved, the template is listed in the templates list
AND users when creating a space will see it listed in the current dropdown of space templates.

Precisions: Default Product Space Template
Remove the current space template
AND add following ones:

Precisions: Circles
Circles can be created without giving any name. Indeed, by default, the name is composed of first names of the user:

• If John creates a circle and invites nobody then call the space John
• If John creates it and invites Jane at the creation step: call it John, Jane
• If John creates it and invites Jane and Alfred, call it John, Jane and 1 more
  1 being the number of invited people

When inviting more people after the creation, no change done to the name.
Name can be updated from space settings
No need to make sure the name is already used. Indeed, this can happen if same name used.
Default Avatar is created on this base, as it is currently. Unless it is updated manually of course.

Project Home

Community Home

Announcement Home

Circle Home

Impacts

Gamification

NA

Notifications

NA

Analytics

Use of space templates

Unified Search

NA

2. Technical Requirements

Expected Volume & Performance

Security

Space Administrators and Platform Administrators should be able to access Space Templates Management.
The usage of Space Templates has to be restricted switch user permissions, except for Spaces Administrators and Platform Administrators who should be able to manage templates and use it to create spaces independently from specific permissions on the template.
The Space Creation process has to check allowed fields on the space template and to forbid changes from REST calls when the fields aren't allowed switch Space Template Model.
The Layout Editor Button in TopBar should be displayed switch Space Layout Permissions which should be initialized switch Space Template Layout permissions.

Extensibility

The current possibility of SpaceTemplate pages extensibility shouldn't be possible anymore, since the Space Template Layout has to be defined once the Space Template is imported from sources.
Thus, the Space Template definition has to be made in a single location, in Meeds project in sites.war.

The Meeds DAO members will be able to define their own Space Templates without having to inherit automatically the list of Space Templates defined in Meeds.

Configurability

The Space Templates Definition has to be simplified without XML, but with JSON space-templates.json (as made for portlet-instances.json and app center applications.json).

Upgradability

The old Notion of Space Template will be deleted,, thus the TEMPLATE field will be removed and replaced by a field to reference the Template Identifier.

Existing Features

The space creation drawer will reference the new stored templates list switch user permissions.

Feature Flags

N/A

Other Non Functional Requirements

N/A

3. Software Architecture

Security

Access

• A new portlet has to be added in Administration site to be able to manage space templates
• A Dedicated REST endpoint has to be added to GET/POST/PUT/DELETE/PATCH Templates

Services & processing

• The Space creation process will change to be able to restrict space creation switch Space Template Permissions
• The Space with no name specified has to be created using a generated UUID. The Space Display in this case has to be interperted and internationalized in FrontEnd using I18N files content
• The Space Settings application has to evolve to allow/deny modification of certain settings switch associated space template
• When deleting a space template, the flag DELETED has to be turned ON and ENABLED flag to OFF without affecting other space template properties. This will allow to get characteristics of the space template to handle spaces already created with it
• The Layout Editor Button has to be made visible to all users (*:/platform/users) in order to allow fine check the permissions of the user whether it can be displayed or not switch Space Layout edit-permission field

Data and persistence

• The field TEMPLATE has to be removed from SOC_SPACES to be replaced by a field TEMPLATE_ID to reference the Space Template Entity.
• A new Table will be added for Space Template Entities: