JBoss.orgCommunity Documentation

Chapter 5. Advanced Actions

5.1. Manage Site Resources in one place
5.1.1. CSS Folder
5.1.2. Document Folder
5.1.3. JS Folder
5.1.4. Links Folder
5.1.5. Media Folder
5.1.6. Web Content Folders
5.2. Content Administration
5.2.1. Categories and Tags
5.2.2. Content Presentation
5.2.3. Content Types
5.2.4. Advanced Configuration

5.1. Manage Site Resources in one place

You can easily manage all the site resources in Content Explorer.

Chose [ Sites Management ] in General drive. All of your created sites and their resources will be listed in the left pane.

All sites contain typical folders that are site resources:

CSS is one of the default files of a site. This folder contains CSS data that is used to present data in a site and increase that site's content accessibility.

CSS

Once a new CSS file is created in a site, it will affect how the site is displayed. For example, if your new CSS file is created with the red background color, the site background will then turn into red.

This folder contains all documents used in a site. When you want to add a new document for a site, you can also put them in another folder, but it is recommended to use this one to manage everything easily and conveniently.

This is one of the default files of a site. This file contains Java Script data that is used to make a site more animated and more dynamic.

This file contains all links used in a site.

This folder contains all documents related to videos, images and sounds. It is divided into three sub folders:

audio:

This folder contains sound data used in a site.

images:

This folder contains images used in a site.

videos:

This folder contains videos used in a site.

This folder contains all web content used in sites. It is recommended to put all the web content files here, to manage them more easily, or in case you want to reuse them in another site.

5.2. Content Administration

This page is used to manage all workspaces, drives, node types, metadata, templates, queries, and more. Only administrators can access the Content Administration page.

This page enables you to access:

The Manage Tags function enables you to manage tag styles. The tag styles will change, depending on the number of documents in a tag.

Go to Categories & Tags --> Manage Tags.

Add a tag style

  1. Click the Add Style button. The Edit Tag Style Configuration form will appear.

    Details:

    Table 5.1. 

    FieldDescription
    Asterisk (*) This mark next to each field means that it is required to input values.
    Style Name Give the tag name which cannot be edited.
    Document Range Give the number of document assigned to a tag.
    HTML Style Include font-size, font-weight, color, font-family, and text-decoration.

  2. Input values in the fields: Style Name, Document Range, and HTML Style.

  3. Click Update to accept adding a new tag style.

Note

The format of valid range must be: a..b where 'a', 'b' are positive integers. You can use * instead of 'b' to indicate it is unlimited. For example, 0..2 (means 0-2 documents assigned to a tag), 10..* (means at least 10 documents assigned to a tag).

The 'HTML style' textbox cannot be empty. You can change values of font-size, font–weight, color, font-family, and text-decoration.

The Tag Manager tab enables you to edit the existing tags.

Edit an existing tag

  1. Click pencil corresponding to the tag name which you want to edit in the Action column to edit the tag style configuration. The Edit Tag Style Configuration form appears which is similar to that of adding a tag style.

  2. Change values in the fields, including Document Range and HTML Style, except Style Name.

  3. Click Update to save new changes.

To delete one tag style, simply click the corresponding Delete icon and select OK in the confirmation to accept your deletion.

The Tag Permission Manager tab helps you set permissions regarding to editing and deleting public tags.

Set Permission To Tag Management

  1. Click "Select user" beside the Memberships field to select memberships to add a permission to those memberships. The Select Membership form will appear.

  2. Select a group on the left and the corresponding membership on the right. The selected membership will appear in the Memberships field.

  3. Click Save to accept adding a permission for the membership to the Memberships column.

    You can also delete memberships that have permissions by clicking regarding to that membership, then click OK in the confirmation message.

A category can be understood as a classification practice and science. It is used to sort documents, aiming at facilitating searches. The category management includes adding, editing and deleting a category tree.

Go to Categories & Tags --> Manage Categories.

  1. Click the Add Category Tree button to add a new category. The Add Category Tree form will appear.

  2. Enter the category tree name in the Name field which is required.

  3. Select the workspace you want to work with.

  4. Select the home path by clicking . The Select Home Path form will appear.

  5. Click Reset if you want to reset values that have just been selected or Next to select permissions for a category tree.

    i. Click "Select user" to select a user or "Select memberships" to select memberships or "Select everyone" to select everyone to set permissions. The user or membership that you have just selected will be displayed in the User or Group field.

    ii. Check at least one of these below options to set rights for the selected user to membership:

    Table 5.2. 

    FieldDescription
    Read Right Select the Read right or not.
    Add Note Right Select the Add Node right or not.
    Set Property Right Select the Set Property right or not.
    Remove Right Select the Remove right or not.

  6. Click Save to save all values, or Reset to change values that have just been set. After clicking Save, click Next to go to the next step.

  7. Enter the name for an action of the category tree in the Name field which is required.

  8. Select values for Lifecycle, Node Types, Target Workspace, Target Path, Affected Node Types which are required.

  9. Click Save to save all values, then select Next to go to the next step.

Note

Do not input some special characters into the Name field, such as: !,@,#,$,%,&,*,(,).

Do not add a category which has the same name and level with existing taxonomies in a node.

The category name must contain less than 30 characters.

  1. Click pencil corresponding to the category tree you want to edit.

  2. Click plus in the Add column to add more category trees. The Edit Category Tree form will appear.

  3. Enter a category name in the Category Name field which is required.

  4. Click Save to save the category name.

  5. Click Previous to return to the previous steps.

  6. Click Save to save all changes, or Previous or Next if you want to edit more.

Note

You can delete a category by clicking corresponding to the category that you want to delete. Click OK in the confirmation message to accept your deletion.

You cannot delete categories that have been referenced.

When creating a node in eXo Platform, you must set its properties. Thus, each node needs to have a form to enter data for their properties (called the Dialog template), and display the existing values (called the View template). The template management allows users to view, delete and modify the predefined templates or to add a new template.

Add a new template

  1. Click Content Presentation --> Manage Templates.

  2. Click the Add button in the Manage Templates form to open the Template Form.

  3. Select the template type from the Name drop-down menu.

  4. Specify a name for the template in the Label field. It is required.

  5. Select the is Document Template checkbox if you want your created template to become a template for a document.

  6. Click next to the Permission field to open the Select Permission dialog. It is required.

  7. Optionally, select the Dialog tab and enter the value in the Dialog Content field.

  8. Optionally, select the View tab and enter the value in the View Content field.

  9. Optionally, select the CSS tab and enter the value in the CSS Content field.

  10. Click Save to create the template.

Edit a template

  1. Click Content Presentation --> Manage Templates.

  2. Click in the Action column, corresponding to the template you want to edit.

  3. Make changes on the values of each tab, including:

Delete a template

  1. Click trash can corresponding to the template you want to remove in the Manage Templates page.

  2. Click OK in the confirmation message to accept your deletion.

Metadata is generally defined as "data about data". Metadata is information which describes, or supplements the central data. In the Manage Metadata tab, you can manage nodes in the metadata format in the eXo Platform system. The metadata may be considered as information used to describe the data. When data are provided to end-users, the metadata allows users to understand about information in more details. All metadata nodes can combine with other nodes to create a new node (add mix).

View metadata

  1. Click Content Presentation --> Manage Metadata.

  2. Click corresponding to the metadata you want to view.

    The Metadata Information form will open.

Edit metadata

  1. Click in the Template's Actions column, corresponding to the metadata you want to edit.

    The Edit Metadata's Template form will open.

  2. Change the required properties of the metadata.

    Note

    You cannot edit the metadata name.

  3. Click Apply to save all metadata changes.

Delete metadata

  1. Click corresponding to the metadata you want to delete.

  2. Click OK in the confirmation message to accept your deletion.

The Manage View function is used to control view ways of a user. It has two tabs: View and ECM Templates

To open the Manage View function, click Content Presentation --> Manage View. The Manage View form displays.

In this tab, you can add, edit, delete, and preview views.

Add a view

  1. Click the Add View button located at the bottom of the Manage View form.

    The Add View form will open.

  2. Specify the view name in the Name field that must be unique, and only contains standard alphanumeric characters. It is required.

  3. Set permissions for the view by clicking the plus icon. It is required.

  4. Click the Templates field and select a template from the drop-down menu for this view.

  5. Click the Add Tab button to create a functional tab on this view. It is required.

    i. Enter the name for the tab in the Name field.

    ii. Specify functions to add to the tab.

    iii. Click Save to finish creating a tab;

    Or, click Reset to clear the Tab form;

    Or, click Back to return to the View Form tab of the Add View form.

    The newly created tab is displayed on the Tabs field.

  6. Click Save to apply all settings and close the form.

Edit a View

  1. Click in the Action column, corresponding to the view you want to edit.

  2. Edit the view properties.

    Note

    You cannot change the view name.

    If you select the Enable Version checkbox, this view automatically increases to one version after you click Save. It is displayed at the Base Version column in the View tab.

    If the dialog has at least two versions, in the View tab, it displays the Restore button. You can use Restore to roll back to the previous View.

  3. Optionally, click the Add Tab button to open the Tab Form tab that allows you to add more Tabs to the View.

  4. Optionally, click an added Tab to add or remove functions on it. Note that you cannot change the tab name.

  5. Click Save to apply all changes in the View tab.

Delete a view

  1. Click corresponding to the view you want to delete in the Manage View page.

  2. Click OK to delete the view in the confirmation message.

    Note

    You cannot delete a view which is in use.

Preview a view

  1. Click in the Action column of the view you want to preview.

    The View form will open.

  2. Click Close to exit the View form.

Add a new ECM Template

  1. Select the ECM Templates tab.

  2. Click the Add button to open the Add ECM Template form.

  3. Input the content of the template in the Content field.

  4. Input a name for the template in the Name field.

  5. Select a type for the template in the Template Type field.

  6. Click Save to accept adding a new template.

Edit a template

  1. Click next to the template you want to edit.

  2. Change the current template's properties.

  3. Click Save to accept all changes.

    Note

    You cannot edit the template name.

    If you tick the Enable Version checkbox, this template will automatically increase to 1 version after you have clicked Save. It is displayed at the Base Version column in the ECMS Template tab.

    If the template has at least two versions, in the Edit ECM Template form, it displays the Restore button that allows restoring the template version.

Delete a template

  1. Click corresponding with the template you want to delete.

  2. Click OK in the confirmation message to accept your deletion.

The function supports you to manage drives in the Sites Explorer. It allows adding, editing and deleting drives.

Go to Content Presentation --> Manage Drives.

  1. Click the Add Drive button in the Manage Drives page to open the Add Drive form.

  2. Input a name for the new drive in the Name field that is required.

  3. Select a workspace for the drive from the drop-down menu by clicking the Workspace entry.

  4. Select the home path for the drive by clicking plus beside the Home Path entry.

  5. Browse an icon for the workspace by clicking plus beside the Workspace Icon entry.

    Select an icon by clicking green tick corresponding to your desired icon file.

  6. Select permissions for groups that have access rights to this drive by clicking plus beside the Permissions entry.

  7. Select or deselect the various checkboxes to hide or show the drive elements respectively.

    Show Referenced Document

    Allow viewing preference documents.

    Show Non-document Nodes

    Allow viewing non-documents.

    Show Sidebar

    Allow showing the sidebar.

    Show Hidden Node

    Allow showing the hidden nodes.

  8. Select the document type that will be created in this drive.

  9. Select the Apply Views tab and select the view types you want to be available in the drive.

  10. Click Save to complete creating the new drive, or Refresh to clear the form.

  1. Click pencil corresponding to the drive you want to edit. The Edit Drive form will appear.

  2. Edit the properties as required.

  3. Click Save to commit the changes.

Note

The drive name cannot be edited in this form.

  1. Click trash can that corresponds to the drive you want to delete.

  2. Click OK to delete the drive in the confirmation message.

The namespace is a prefix in the node type name. It enables you to create node types without fearing any conflict with existing node types. The registry helps you manage the namespaces used in the system.

Select Content Types --> Namespace Registry to open the Namespace Registry form.

Register a namespace

  1. Click the Register button on the Namespace Registry form to register a new namespace.

  2. Enter the value for the Namespace Prefix field that is required.

  3. Enter the value for the URI field which must be unique and required.

    Note

    The namespace must not contain special characters, such as !,@,#,$,%,&,*,(,).

This function is used to control all node types in eXo Platform.

View node types

  1. Click [ Glass icon ] that corresponds to the node you want to view. The View Node Type Information form will appear.

  2. Click Close to exit this form.

Add a node type

  1. Open the Add/Edit Node Type Definitions form by clicking the Add button on the Manage Node Type page.

  2. Select a namespace for the node.

  3. Enter a name in the Node Type Name field. This field is mandatory and its value must be unique.

    Note

    The name must not contain special characters, such as !,@,#,$,%,&,*,(,).

  4. Select a value for the Is Mixin Type field.

  5. Select a value for the Orderable Child Nodes field.

  6. Enter a value for the Primary Item Name field.

  7. Click [ Plus icon ] to add more parent types in the Super Types field.

  8. Click Save to accept adding a new node type, or Save as Draft to save this node type as draft.

Export Node Types

  1. Open the Export Node Types form by clicking the Export button at the bottom of the Manage Node Type page.

  2. Click Uncheck all if you do not want to export all node types. After clicking Uncheck all, this button becomes the Check all button.

  3. Select nodes that you want to export by ticking the checkboxes.

  4. Click the Export button in this form.

  5. Select the location in your device to save the exported node.

    Note

    You must select at least 1 node type to be exported. If you do not want to export the node, click Cancel to quit this pop-up.

Import Node Types

  1. Open the Import Node Type From XML File form by clicking the Import button at the bottom of the Manage Node Type page.

  2. Click the Browse... button to upload a file.

    Note

    You must upload an XML file. This file is in the node type's format.

  3. Click the Upload button.

    Note

    If you want to upload another file, click to delete the file which has just been uploaded, then upload other files.

  4. Tick the checkboxes corresponding to the nodes that you want to import.

  5. Click the Import button to complete importing a node type.

The function enables you to manage queries. It allows adding, editing and deleting queries.

Go to Advanced Configuration --> Manage Queries.

Add a new query

  1. Open the Add Query form by clicking the Add Query button in the Manage Queries page.

  2. Enter a query name into the Query Name field.

  3. Select the query type from the drop-down Query Type menu.

  4. Enter the statement for the query that must be unique.

  5. Check or uncheck the Enable Cache Results option. If you tick this checkbox, for the first time you use this query to search, the result will be cached. For the second time you search using this query, it will show the cached results. After 45 minutes, the cache will be removed.

    For example, you have the query Test with statement //element (*, nt:file). In the File Explorer, you have a nt:file document named File1. When you execute the query Test, only document File1 will be shown. After that, create a nt:file document named File2 and execute query Test, only document File2 document will be listed. After 45 minutes, the cache will be removed. When you execute the query Test, the documents File1 and File2 will be listed.

  6. Select permissions for a group that can use this query by clicking green plus.

  7. Click Save to finish adding a new query.

Edit a query

  1. Click pencil corresponding to the query you want to edit. The Edit Query form will appear.

  2. Edit the properties of the selected query.

  3. Click Save to accept all changes.

Delete a query

  1. Click trash can corresponding to the query you want to delete.

  2. Click OK in the confirmation message to accept your deletion, or Cancel to discard this action.

The function enables users to manage all script codes in the eXo Platform and Browser Content system.

Go to Advanced Configuration --> Manage Scripts.

Add a new script in ECM

  1. Click the Add button in the Manage Script page to open the Add/Edit Script form.

  2. Enter a value for the Script Content field.

  3. Enter a script name for the Script Name field that must be unique and not contain special characters, such as !,@,#,$,%,&,*,(,).

  4. Click Save to accept adding the new script.

Edit an ECM script

  1. Click pencil corresponding to the script that you want to edit in the ECM Scripts tab. The Add/Edit script form will appear.

  2. Edit the properties in this form.

  3. Click Save to save all changes.

Delete an ECM script

  1. Click trash can on the script that you want to delete in the ECM Scripts tab.

  2. Click OK in the confirmation message to accept your deletion, or Cancel to discard this action.

This function allows you to manage all action nodes in the eXo Platform.

  1. Select Advanced Configuration --> Create Action Type.

  2. Click the Add button to open the Action Type form.

  3. Select the action type.

  4. Input a name for the action.

  5. Check/uncheck the is Action Move option. The action will have exo:move property or not.

  6. Select an "execute" for the Execute field.

  7. Click plus next to Variables field to add more values for the action.

  8. Click Save to accept adding a new action type.

All locked nodes are listed and managed by administrators in the Content Administration page. There are two ways that help administrators lock nodes: unlock nodes in the right-click menu in Sites Explorer or unlock nodes in the Content Administration page.

Unlock a node

  1. Select Advanced Configuration --> Manage Locks on the Manage ECM Main Functions pane on the left. The locked nodes will be listed in the right pane.

  2. Click open lock corresponding to nodes which need to be unlocked in the Locked Node tab in the right pane. The unlocked nodes will disappear from the locked nodes list.

    Administrators can manage and add the unlock permission for another group and users in the Manage Lock tab.

  3. Select the group on the Select Group pane and the corresponding membership on the Select Membership pane. The selected group will be listed in the Groups Or Users column.