2.2.4.12. Manage View

This plugin is used to create a predefined View into a repository. A View can include many object parameters. Parameters are used to create default Views, Templates and Actions of Manage View service. View enables administrators to customize View classification that can impact on users in exploring workspace. Each object-param has a type that is a class representing all properties of a View.

To use the plugin in the component configuration, you must use the following target-component:


<target-component>org.exoplatform.services.cms.views.ManageViewService</target-component>

The configuration is applied mainly in packaging/wcm/webapp/src/main/webapp/WEB-INF/conf/dms-extension/dms/dms-views-configuration.xml.

Sample configuration:


<external-component-plugins>

    <target-component>org.exoplatform.services.cms.views.ManageViewService</target-component>

    <component-plugin>

        <name>manage.view.plugin</name>

        <set-method>setManageViewPlugin</set-method>

        <type>org.exoplatform.services.cms.views.impl.ManageViewPlugin</type>

        <description>this plugin manage user view</description>

        <init-params>

            <value-param>

                <name>autoCreateInNewRepository</name>

                <value>true</value>

            </value-param>

            <value-param>

                <name>predefinedViewsLocation</name>

                <value>war:/conf/dms-extension/dms/artifacts</value>

            </value-param>

            <value-param>

                <name>repository</name>

                <value>repository</value>

            </value-param>

            <object-param>

              <name>Web</name>

              <description>View configuration of WCM administrator</description>

              <object type="org.exoplatform.services.cms.views.ViewConfig">

                <field name="name"><string>Web</string></field>

                <field name="permissions"><string>*:/platform/web-contributors</string></field>

                <field name="template"><string>/exo:ecm/views/templates/ecm-explorer/Content</string></field>

                <field name="tabList">

                  <collection type="java.util.ArrayList">

                    <value>

                      <object type="org.exoplatform.services.cms.views.ViewConfig$Tab">

                        <field name="tabName"><string>Authoring</string></field>

                        <field name="buttons">

                          <string>

                            addCategory; addFolder; addDocument; editDocument; upload; viewPermissions; managePublications; manageCategories; taggingDocument; vote; watchDocument; publicationRequestApproval; publicationApproveContent; publicationPublish; addLocalizationLink  

                          </string>

                        </field>

                      </object>

                    </value>

                  </collection>

                </field>

              </object>

            </object-param>

            <object-param>

              <name>Content Template</name>

              <description>Template to display contents in list style</description>

              <object type="org.exoplatform.services.cms.views.TemplateConfig">

                <field name="type"><string>ecmExplorerTemplate</string></field>

                <field name="name"><string>Content</string></field>

                <field name="warPath"><string>/ecm-explorer/ContentView.gtmpl</string></field>

              </object>

            </object-param>

        </init-params>

    </component-plugin>

</external-component-plugins>

In which:

Name: manage.view.plugin
Set-method: setManageViewPlugin
Type: org.exoplatform.services.cms.views.impl.ManageViewPlugin

Init-param:

value-param	Type	Value	Description
autoCreateInNewRepository	`boolean`	`true`	Allows creating a predefined View in this repository if the value is "true".
predefinedViewsLocation	`string`	`war:/conf/dms-extension/dms/artifacts`	The location of the View node in the repository.
repository	`string`	`repository`	The repository name.

Object type: org.exoplatform.services.cms.views.ViewConfig

Field	Type	Value	Description
name	`string`	`Web`	The name of view which must be unique inside Content.
permissions	`string`	*:/platform/web-contributors	Visibility of the view based on eXo rights.
template	`string`	`/exo:ecm/views/templates/ecm-explorer/Content`	Specifies path to the template location.
tabList	`ArrayList`	{java.util.ArrayList}	Includes a set of view names.

Object type: org.exoplatform.services.cms.views.ViewConfig$Tab

Field	Type	Value	Description
tabName	`string`	`Authoring`	The name of tab which must be unique.
button	`string`	`addCategory; addFolder; addDocument; editDocument; upload; viewPermissions; managePublications; manageCategories; taggingDocument; vote; watchDocument; publicationRequestApproval; publicationApproveContent; publicationPublish; addLocalizationLink`	Specifies a set of view component names.

Object type: org.exoplatform.services.cms.views.TemplateConfig

Field	Type	Value	Description
type	`string`	`ecmExplorerTemplate`	Specifies if a name is truly a class representing all properties of a view.
name	`string`	`Content`	Specifies a view component name.
warPath	`string`	`/ecm-explorer/ContentView.gtmpl`	Specifies a template location to view.