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. Administration page
5.2.1. Categories and Tags
5.2.2. Content Presentation Manager
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 panel.

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 contents files here, to manage them more easily, or in case you want to reuse them in another site.

5.2. Administration page

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

This page enables you to access:

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

Go to Administration > Categories and Tags > Manage Tags.

Furthermore, you can add a new tag style as follows:

Procedure 5.1. Add a Tag Style

  1. Click the Add style button. The Add tag style configuration form will appear:

    Details:

    Style name

    Give the tag name. You cannot edit it.

    Document Range

    Give the number of document assigned to a tag. (*Required).

    HTML style

    Include font-size, font-weight, color, font-family, text-decoration. (*Required).

  2. Input values in the fields: Style name, Document range, HTML style, all of which are required.

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

Note

Tag manager tab enables you to edit the existing tags.

Do the following:

Procedure 5.2. Editing existing tabs

  1. Click the pen icon 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 like the form to add a tag style.

  2. Change values in the fields 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 editing and deleting public tags.

Procedure 5.3. Set Permission To Tag Management

  1. Click the "Select user" icon beside the Memberships field to select memberships in order to add a permission for 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 the Delete icon relevant to that membership, and then click OK in the confirmation message.

A category may 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 Administration > Categories and Tags > Manage Categories.

Perform the steps in Add a Taxonomy Tree to add a taxonomy tree.

Procedure 5.4. Add a Taxonomy Tree

  1. Click the Add Taxonomy Tree button to add a new taxonomy. The Add taxonomy tree form will appear.

  2. Enter the taxonomy tree name in the Name field. (*Required).

  3. Select the workspace you want to work with.

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

  5. Click the tick icon if you want to select the root path or click the arrow icon to go to the up level path. Click the plus sign to expand the folder.

  6. Click the tick icon corresponding to the path that you want to select as a home path.

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

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

    Then, check at least one of these below options to set rights for the selected user to membership:

    Read Right

    The option is to select the read right or not.

    Add Note Right

    The option is to select the Add Node right or not.

    Set Property Right

    The option is to select the Set Property Right or not.

    Remove Right

    The option is to select the Remove right or not.

  8. 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.

  9. Enter the name for an action of the taxonomy tree in the Name field. (*Required).

  10. Select values for Life-cycle, NodeTypes, Target workspace, Target path, Affected Node Types. (*Required).

  11. Click Save to save all values and, click Next to go to the next step.

Note

Perform the following steps to edit a taxonomy tree.

Procedure 5.5. Edit a Taxonomy Tree

  1. Click the edit icon pencil icon that corresponds to the taxonomy tree you want to edit.

  2. Click the icon plus icon in the Action field to add more taxonomy trees. The Edit taxonomy tree will appear:

  3. Enter a taxonomy name in the Taxonomy name field. (*Required).

  4. Click Saveto save the taxonomy name.

  5. Click Previous to return to the previous steps.

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

Note

When creating a node in eXo Content, 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.

Procedure 5.6. Add a New Template

  1. Click Administration → Content Presentation → Manage Templates

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

  3. In the Name drop-down box, select the template type you require.

  4. Specify a name for the template in the Label field.

  5. Click the Document Template check box if the template you are creating should be used as a template for a document.

  6. Click the icon next to the Permissions field to open the Select Permission dialog.

  7. Select the group from the left panel and the membership from the right panel. Or you can set permission for everyone by clicking the icon next to Any Permission.

  8. Select the Dialog tab and enter the value in the Dialog content field.

  9. Select the View tab and enter the value in the Dialog content field.

  10. Select the CSS tab and enter the value in the Dialog content field.

  11. Click the Save button to create the template.

Procedure 5.7. Edit a Template

  1. Click Administration → Content Presentation → Manage Templates

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

  3. In the Template tab, you can edit the Label of the Template.

  4. To add a dialog, do the following:

    1. Input content for this dialog in the ' Content ' field.

    2. Input name for this dialog. (*Required).

    3. Select permissions for a group that can use this dialog. (*Required).

  5. To edit an existing dialog, do the following:

    1. Click the pencil icon in the dialog row you want to edit.

    2. Edit the dialog properties.

    3. Click Save to accept all changes in the Dialog tab.

  6. To delete an existing dialog, do the following:

    1. Click the trash can icon in the dialog row you want to edit.

    2. Click OK to continue with deletion.

    Note

    You can not delete the default dialog. You must create a new one before you can delete the current default dialog.

  7. To add a view, do the following:

    1. Click the View tab and enter content into the content field.

    2. Input name for this view. (*Required).

    3. Select permissions for a group that can use this view. (*Required).

  8. To edit an existing view, do the following:

    1. Click the pencil icon in the view row you want to edit.

    2. Edit the view properties.

    3. Click Save to accept all changes in the View tab.

    Notes about Editing Views

    You cannot change the view name.

    If you click Enable Version checkbox, this view automatically increments one version after you click Save. It is displayed at ' 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.

  9. To delete an existing dialog, do the following:

    1. Click the trash can icon in the dialog row you want to edit.

    2. Click OK to continue with deletion.

    3. Click Save to accept all changes.

Procedure 5.8. Delete a Template

  1. Click the trash can corresponding to the template that you want to discard.

  2. Click OK on the confirmation message to delete the template or Cancel to abort the operation.

Metadata in its simplest form is "data about data". Generally, it may be understood as information that describes, or supplements the central data. The metadata management allows managing nodes in the metadata format in the eXo Content system. The metadata may be considered as information used to describe the data. When data are provided to the end users, the metadata allow users to understand about information in more details. All metadata nodes can combine with other nodes to create a new node (add mix).

Procedure 5.9. View Metadata

  1. Click Administration → Content Presentation → Manage Metadata

  2. Click the magnifying glass icon corresponding to the metadata you want to view.

    The Metadata Information Form opens.

Procedure 5.10. Edit Metadata

  1. Click the Pencil icon in the metadata row you want to edit.

    The Edit Metadata's Template form opens.

  2. Change the required properties of the metadata.

    Note

    You cannot edit the metadata name.

  3. Click Apply to save all metadata changes.

Procedure 5.11. Delete Metadata

  1. Click the trash can icon corresponding to the metadata you want to delete.

    A confirmation message appears.

  2. Click OK to delete the template, or Cancel to preserve the template.

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

To open the Manage View function, click Administration → Content Presentation → Manage View. The Manage View form displays.

Views Tab

The procedures that describe how to Add, Edit, Delete, and Preview views.

Procedure 5.12. Add View

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

    The Add View form opens.

  2. In the Name field, specify the name of the view you are creating. The name must be unique, and must only contain standard alphanumeric characters.

  3. Select the group from the left panel and the membership from the right panel.

  4. Click the Templates field and select the correct template for this view.

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

Procedure 5.13. Edit a View

  1. Click the Pencil icon in the view row you want to edit.

  2. Edit the view properties.

    Notes about Editing Views

    You cannot change the view name.

    If you click the Enable Version checkbox, this view automatically increments one version after you click Save. It is displayed at ' 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. Click the Add Tab button to open the Tab Form tab to add more tabs.

    1. Click the Add Tab button to add more tabs after the initial tab has been added.

    2. Click the Reset button to apply changes.

    3. Click the Back button to return to the View Form tab in the Edit View form.

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

Procedure 5.14. Delete Views

  1. Click the trash can icon corresponding to the view you want to delete.

    A confirmation message is displayed.

  2. Click OK to delete the view.

    Note

    You can not delete a view that is in use.

Procedure 5.15. Preview a View

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

    The View form opens.

  2. Click Close to exit the View Form.

Procedure 5.16. 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, or click Reset to change values, or Cancel to quit without any changes.

Procedure 5.17. Edit a Template

  1. Click the Pencil icon 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 'ECM 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.

Procedure 5.18. Delete a Template

  1. Click the Trash icon corresponding with the template you want to edit. A confirmation message will appear.

  2. Click OK to accept deleting this template.

Procedure 5.19. Adding a New Template

  1. Click Add to open the Add BC Template form.

  2. Input the content for the template in the Content text box. (*Required).

  3. Input the name for the template in the Name field. (*Required).

  4. Select the template type from the drop-down box in the Template Type form.

    Note

    The name must be unique.

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

  5. Click Save to complete adding a new template.

Procedure 5.20. Edit a BC Template

  1. Click the pencil icon on a template that 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.

    You cannot edit the template type.

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

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

Procedure 5.21. Delete a Template

  1. Click the trash can icon corresponding with the template you want to edit. A confirmation message will appear.

  2. Click OK to accept deleting the template, or Cancel to discard this action.

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

Go to Administration → Content Presentation → Manage Drives.

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

  2. Input a name for the new drive in the Name field. (*Required).

  3. Select a workspace for the drive. There are 4 available workspaces: system, collaboration, backup, and dms-system.

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

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

  6. Select an icon by clicking the green tick corresponding to the desired icon file:

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

  8. Select or deselect the various checkboxes to hide or show the corresponding drive elements:

    Show referenced document

    Allows viewing preference documents.

    Show non-document

    Allows viewing non-documents.

    Show sidebar

    Allows showing the sidebar.

    Show hidden node

    Allows showing the hidden nodes.

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

    Folder

    Only nt:folder folders can be created in this drive.

    Unstructured folder

    Only nt:unstructured folders can be created in this drive.

  10. Select the Apply Views tab and select the view type you want to be available in the drive:

  11. Click Save to commit the details and create the new drive, Refresh to clear the form or Cancel to abort the operation.

To edit a drive, do the following:

Procedure 5.22. Edit a drive

  1. Click the pencil icon that corresponds 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.

Drive Name

The drive name can not be edited in this form.

To delete a drive, do the following:

Procedure 5.23. Delete a drive

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

  2. Click OK on the confirmation message to delete the drive or click Cancel to abort the operation.

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.

Go to Administration > Content Types > Namespace Registry to open the Namespace Registry form.

Procedure 5.24. Registering 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. (* Required).

  3. Enter the value for the URI field. This field must be unique. (*Required).

    Important

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

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

  1. Click the icon that corresponds to the node to be reviewed. The View Node Type Information form will appear.

  2. Click Close to exit this form.

Procedure 5.25. Add Node Type

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

    Add Node Type Form

    Figure 5.1. Add Node Type Form


  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.

    Important

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

  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. Super Types: Click the + button to add more parent types.

  8. Property definitions: lists all definition names of Property tab.

  9. Child node definitions: lists all definition names of Child node tab.

  10. Click Save to accept adding a new node type, or Save draft to save this node type as a draft, or Cancel to quit.

Procedure 5.26. Export Node Types

  1. Open the Export Node Types form by clicking the Export button on the Manage Node Type Form.

  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 computer to save the exported node.

    Important

    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.

Procedure 5.27. Import Node Types

  1. Open the Import Node Type from XML file form by clicking the Import button on the Manage Node Type Form.

  2. Click the Browse button to upload a file.

    Important

    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 a different file, click the trash icon 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 Administration > Advanced Configuration > Manage Queries.

Procedure 5.28. Add a new query

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

  2. Enter a query name for the Name field.

  3. Select the query type.

    • Xpath: (XML Path Language) is a language for selecting nodes. For example, /jcr:root/Documents/Live

    • SQL: (Structured Query Language) is a database computer language.

  4. Enter the statement for query. The name of node type must be unique.

  5. Check or uncheck the 'Enable cache results' option. If you tick this checkbox, for the fist 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 45minutes, 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 the green plus icon.

  7. Click Save to finish adding a new query.

Procedure 5.29. Edit a query

  1. Click the pencil icon 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.

Procedure 5.30. Delete a query

  1. Click trash can icon corresponding to the query you want to delete. A confirmation message will appear.

  2. Click OK to accept deleting this query, or Cancel to discard this action.

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

Go to Administration > Advanced Configuration > Manage Scripts.

Details:

Procedure 5.31. Add a new script in ECM

  1. Select ECM Scripts tab in the Manage Script.

  2. Click the Add button to open the Add/Edit script form:

  3. Enter a value for the Script content field.

  4. Enter a script name for the Script name field.

    • The script name must be unique.

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

  5. Click Save to accept adding the new script.

Procedure 5.32. Edit an ECM script

To edit an ECM script, do the following:

  1. In the ECM Scripts tab, click the pencil icon that corresponds to the script that you want to edit. The Add/Edit script form will appear:

  2. Edit the properties in this form.

  3. Click Save to save all changes.

Procedure 5.33. Delete an ECM script

To delete an ECM script, do the following:

  1. In the ECM Scripts tab, click trash can icon on the script that you want to delete. A confirmation message will appear.

  2. Click OK to accept deleting this action, or Cancel to discard this action.

The BC Scripts tab:

Procedure 5.34. Add a BC script

To add a BC script, do the following:

  1. In the Manage Scripts, select the BC Scripts tab.

  2. Click Add to open the Add/Edit script form:

  3. Input script content for the Script content field.

  4. Input a script name into the Name field.

  5. Click Save to finish adding the new script.

Procedure 5.35. Edit a BC script

To edit a BC script, do the following::

  1. In the BC Script tab, click the pencil icon on a script that you want to edit.

    The Add/Edit script form will appear:

  2. Edit the properties that you want.

  3. Click Save to accept all changes.

Procedure 5.36. Delete a BC script

To delete a BC script, do the following:

  1. In the BC Scripts tab, click the trash can icon on the script you want to delete. A confirmation message appears.

  2. Click OK to accept deleting this script, or Cancel to discard this action.

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

Procedure 5.37. Unlock Nodes

  1. Go to Administration on the navigation bar.

  2. Select Advanced Configuration > Manage Unlocks on the Manage the main ECM functions pane on the left. The locked nodes will be listed on the right panel.

  3. In the Locked Node tab on the right panel, administrators can unlock nodes by clicking the open lock icon that corresponds to nodes which need to be unlocked. The unlocked nodes will disappear from the locked node list.

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

  4. Select the group on the Select group panel and the corresponding membership on the Select membershippanel. The selected group will be listed in the Group and Users column. However, administrators can also click the plus icon if they want to allow any users to unlock nodes.

  5. In case, administrators want to remove the unlock permission of groups, click the trash can icon that corresponds to the group in order to remove them form the Unlock permission list except the group *:/platform/administrator and root.

This function allows managing of all action nodes in the eXo Content.

Procedure 5.38. Create an Action Type

  1. Go to the SitesAdministration on the navigation bar.

  2. Select Advanced Configuration > Create an Action Type.

  3. Click the Add button to open the Action Type Form form:

  4. Select the action type.

  5. Input a name for the action.

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

  7. Select an execute for the Execute field.

  8. The Variables field: allows creating multi-values for action. If you want to add more values for action, click the plus icon. Click the trash can icon to delete a value.

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