1.1.4. Sites Explorer

The Sites Explorer portlet is used to manage all documents in different drives. With this portlet, users can do many different actions depending on their roles, such as adding/deleting a category and a document, showing/hiding a node, managing publication, and more.

This is an example of the Sites Explorer portlet used in Content:

Packaging: The porlet is packaged in the ecmexplorer.war file.

The portlet class name: org.exoplatform.ecm.webui.component.explorer.UIJCRExplorerPortlet

Available preferences: When using this portlet, you can customize the following preferences:

Preference	Type	Value	Description
repository	`string`	`repository`	The repository name which is used in an instance of Sites Explorer.
workspace	`string`	`N/A`	Not in use. The workspace name was included in the Drive.
path	`string`	`N/A`	The path of the node. This preference will be used when the selected usecase is Parameterize.
drive	`string`	`N/A`	Not in use. Replaced by the driveName preference.
views	`string`	`N/A`	Not in use. The views will be displayed basing on the Drive which the user has the access permission.
allowCreateFolders	`string`	`N/A`	Allow creating a folder by type. When you do not specify the value, the default value will be nt:unstructured, nt:folder.
categoryMandatoryWhenFileUpload	`boolean`	false	Force a user to add a category when uploading or creating a document.
uploadFileSizeLimitMB	`float`	150	The maximum size of a file that is uploaded to the system (MB).
usecase	`string`	`selection`	The behavior to access Sites Explorer. By default, the "selection" option is configured. Besides "selection", there are four other ways to configure the Sites Explorer: Jailed, Personal, Social, Parameterize.
driveName	`string`	`private`	The name of drive which the user wants to access.
trashHomeNodePath	`string`	`/Trash`	The location to store the deleted nodes.
trashRepository	`string`	`repository`	The name of the repository where stores the deleted nodes.
trashWorkspace	`string`	`collaboration`	The name of the workspace where stores the deleted nodes.
editInNewWindow	`boolean`	`false`	Allow editing documents with or without a window popup.
showTopBar	`boolean`	`true`	Allow showing the Top bar or not.
showActionBar	`boolean`	`true`	Allow showing the Action bar or not.
showSideBar	`boolean`	`true`	Allow showing the Side bar or not.
showFilterBar	`boolean`	`true`	Allow showing the Filter bar or not.

Sample Configuration




<portlet-preferences>

  <preference>

    <name>repository</name>

    <value>repository</value>

    <read-only>false</read-only>

  </preference>

  <preference>

    <name>workspace</name>

    <value/>

    <read-only>false</read-only>

  </preference>

  <preference>

    <name>path</name>

    <value/>

    <read-only>false</read-only>

  </preference>

  <preference>

    <name>drive</name>

    <value/>

    <read-only>false</read-only>

  </preference>

  <preference>

    <name>views</name>

    <value/>

    <read-only>false</read-only>

  </preference>

  <preference>

    <name>allowCreateFolders</name>

    <value/>

    <read-only>false</read-only>

  </preference>

  <preference>

    <name>categoryMandatoryWhenFileUpload</name>

    <value>false</value>

    <read-only>false</read-only>

  </preference>

  <preference>

    <name>uploadFileSizeLimitMB</name>

    <value>150</value>

    <read-only>false</read-only>

  </preference>

  <preference>

    <name>usecase</name>

    <value>selection</value>

    <read-only>false</read-only>

  </preference>

  <preference>

    <name>driveName</name>

    <value>Private</value>

    <read-only>false</read-only>

  </preference>

  <preference>

    <name>trashHomeNodePath</name>

    <value>/Trash</value>

    <read-only>false</read-only>

  </preference>

  <preference>

    <name>trashRepository</name>

    <value>repository</value>

    <read-only>false</read-only>

  </preference>

  <preference>

    <name>trashWorkspace</name>

    <value>collaboration</value>

    <read-only>false</read-only>

  </preference>

  <preference>

    <name>editInNewWindow</name>

    <value>false</value>

    <read-only>false</read-only>

  </preference>

  <preference>

    <name>showTopBar</name>

    <value>true</value>

    <read-only>false</read-only>

  </preference>

  <preference>

    <name>showActionBar</name>

    <value>true</value>

    <read-only>false</read-only>

  </preference>

  <preference>

    <name>showSideBar</name>

    <value>true</value>

    <read-only>false</read-only>

  </preference>

  <preference>

    <name>showFilterBar</name>

    <value>true</value>

    <read-only>false</read-only>

  </preference>

</portlet-preferences>