Docs Developer Site
Enonic XP
arrow-down
    1. Widgets
    1. ID providers
    2. System ID provider
    3. Users and groups
    4. Roles
    1. Projects
    2. Layers
        1. AttachmentUploader
        2. Checkbox
        3. Combobox
        4. ContentSelector
        5. ContentTypeFilter
        6. CustomSelector
        7. Date
        8. DateTime
        9. Double
        10. GeoPoint
        11. HtmlArea
        12. ImageSelector
        13. Long
        14. MediaSelector
        15. Radiobutton
        16. Tag
        17. TextArea
        18. TextLine
        19. Time
      2. Field set
      3. Item set
      4. Option set
      5. Mixins
      6. Localization
    4. Content Types
    5. X-data
    6. Macros
    7. Custom styles
    8. Sites
      1. Regions
      2. Part component
      3. Layout component
      4. Text component
      5. Fragments
      6. Filtering
      7. Component indexing
      8. Visual editor
    10. Page templates
  4. Applications
    1. Sandboxes
    2. Code
    3. Building
    4. Configuration
    5. TypeScript
      1. Controllers
      2. Globals
      3. HTTP
      4. Events
      5. Error handler
      6. Filters
      7. ID provider
      8. Tasks
      9. Templating
      10. Localization
      11. Websocket
      12. Mappings
      13. Components
      14. Processors
      15. Contributions
      16. Main controller
      17. Java bridge
      1. Admin API
      2. Application API
      3. Auditlog API
      4. Authentication API
      5. Cluster API
      6. Common API
      7. Content API
      8. Context API
      9. Event API
      10. Export API
      11. Grid API
      12. I18N API
      13. IO API
      14. Mail API
      15. Node API
      16. Portal API
      17. Project API
      18. Repo API
      19. Scheduler API
      20. Schema API
      21. Tasks API
      22. Value API
      23. VHost API
      24. Websocket API
      1. Webapp Engine
        1. Image service
        2. Component service
      3. Admin Engine
      4. Asset service
      5. HTTP service
      6. IDprovider service
    2. Task engine
    3. Management Endpoint
    4. Statistics Endpoint
    1. Nodes and repos
    2. Properties
    3. Indexing
    4. Branches
    5. Queries (NoQL)
    6. Queries (DSL)
    7. Filters
    8. Aggregations
    9. Highlighting
    10. Editors
    1. Strategies
    2. Distributions
    3. Docker image
    4. Vhosts
    5. Configuration
    6. Backup & restore
    7. Systemd
    8. Clustering
  9. Audit Logs
    1. Upgrade Notes
    2. Upgrading Apps
Developer Docs Xp Stable Cms Projects

Content projects

Contents

Create independent content repositories for your different teams and projects.

Introduction

Content projects represent the starting point of XP’s CMS. In order to create sites and content, you first need to create a project. Project defines default permissions and other useful settings for your content and editors.

Project settings

Basics

  • Display name - a human readable name

  • Identifier - a unique id within the installation. Cannot be changed when first created

  • Default language - Specifies the default language for content created in the project

Access mode

Project access mode defines default read permissions for it’s content. The available values are:

  • Public (Everyone can read the content)

  • Private (only users with project roles can read the content)

  • Custom (a specific list of principals can be granted access to read the content, i.e. Employees)

To handle private and custom mode, a special "viewer" role is created and given read access to the content items.

Roles

To provide access to a project or manage it, users can be granted special roles. The following roles are available per project:

  • Contributor - Access to project and issues (must be given specific permissions to create or manage any content)

  • Author - Same as contributor, but can additionally create and update content anywhere in the structure

  • Editor - Same as Author, but with full permissions and access to rich-text editor source mode

  • Owner - Same as Editor, but can also manage the project settings

For each project, dedicated principal roles are created. The roles are named as follows: com.enonic.cms.project.<id>.<roletype>

An example might be com.enonic.cms.myproject.author.

Applications

XP XP 7.12.0 7.12.0

Applications can be assigned directly to a content project. Most functionality, schemas (content types, mixins, x-data) as well as controller mappings be available within the scope of the project, until a site item appears.

Unlike sites, content at project level does not support pages, fragments and page page templates, so content preview and rendring must be done directly via Mappings.

It is also worth noting that configurations of applications assigned to a project will be published instantly - unlike changes to a site.

Sites override project applications. If a site should use an application already assigned to its project, you must assign the application directly to the site.

Layered projects inherit application settings from parent layers, just like .

Sites inside the project are isolated and have no access to project’s or each other’s apps.

Storage

Another important purpose of projecs is to strictly isolate the content from other projects. As such, each project gets a dedicated repository.

This means, that editors of a particular project will not be able to see, use or link to content within other projects.

Site engine

Site engine provides access to content in a specific branch of a specific project at /site/{projectId}/{branch}, where {projectId} is a unique project identifier. For example, draft items of a project with identifier ´myproject´ can be accessed via internal path /site/myproject/draft.

API

To programmatically manage projects, use the project API

Contents

Contents

AI-powered search

Juke AI