Getting Started

Implement the News Document

Updated: January 2, 2020

This page is scheduled for review and update. Check back soon for updated content!

JSF UI Deprecation
This requires to have the JSF UI addon installed on your server that is deprecated since Nuxeo Platform LTS 2019.
Please refer to the Web UI documentation.

In this section, we will:

  • Create the News document type,
  • Create the content template with News Folder,
  • Add a button dedicated to News creation.

For this section, it is recommended to take a look at the following guides for a step-by-step approach:

Before You Start

Make sure that the Nuxeo JSF UI target package is checked in your project's Application Definition to get all the needed features in Nuxeo Studio.

Create the News Document Type

  1. Create a new document type called News.

    A document type must have a container. However if you do not want your document type to be displayed in the available document list window, you can select Document type as the container.

  2. On the Definition tab, ensure that the our News document extends the Document type.
  3. On the Schema tab:
    • Add the files schema (necessary so that pictures that are uploaded with a HTML widget are stored).
    • Under Add a custom schema a field body of type String.
  4. Create the layouts of the document:

    • Creation layout metadata: dc:title as text widget, news:body as a HTML text widget.
    • Edit layout metadata: import Creation layout (it is the same).
    • View layout metadata: import Creation layout and add dc:valid as DateTime widget on a third row.

    The News document type is now created. However, there is no way to access the creation form for now.

Create the Structure Template for News Folder to Be Available Automatically

  1. Create a new Structure Template:
    • ID: Workspace
    • Target Document Type: Workspace
  2. Add a new built-in type: Folder

    • Node Name: NewsFolder
    • Title: News Folder

    Now, every time a workspace is created, a folder called "News Folder" will automatically be created in it by the system.

Add the News Creation Button

Here are the steps to create the button to create news from a Workspace into the News Folder:

  1. Create a new User Action. Its properties:
    • ID: CreateNewsButton
    • Label: Create news
    • Category: Folder toolbar
  2. Activation conditions:
    • User has permission: Edit
    • Current document has type: Workspace
  3. Create new operation chain CreateNewsChain:
    - Repository.GetDocument:
        value: ./NewsFolder
    - Seam.NavigateTo
    - Seam.ShowCreateForm:
        type: News
    Now when you click on the Create News button, a News document will be created for the Workspace and stored directly in the News folder.

We'd love to hear your thoughts!

All fields required