Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
02e764f
DOC-4335: Add new Elasticsearch HTTP connection pool properties (#152)
mzorai Dec 3, 2019
97366c1
DOC-4313: Update a property in SAMK config (#155)
mzorai Dec 3, 2019
22542ce
Feature/only office (#151)
mzorai Dec 16, 2019
da02cf6
Fix/doc 4270 (#76)
mzorai Dec 16, 2019
8c86b0b
DOC-4340: Add New features to what's new section (#164)
mzorai Dec 18, 2019
09a0e50
DOC-4350: Update what's new section: technical novelties (#166)
mzorai Dec 20, 2019
2c1970a
DOC-4351: Document the new query param wcm.config.parameterizedURIPar…
mzorai Dec 27, 2019
77f84d1
Update whatsnew.rst (#170)
mzorai Dec 30, 2019
288f909
DOC-4352: Developer guide for OnlyOffice connector (#168) (#173)
mzorai Jan 6, 2020
3660b84
DOC-4356: Remove Jboss configurations on Installation chapter (#176) …
mzorai Jan 10, 2020
81b6d8b
images display fix (#179) (#180)
samehaidi Jan 10, 2020
9803a93
Fix/5.3/news doc backport (#181)
samehaidi Jan 10, 2020
09c6124
M14 Documentation - screenshots updates (#182) (#183)
samehaidi Jan 15, 2020
0aa1fab
DOC-4363: Remove useless email parameter (#189) (#190)
mzorai Jan 28, 2020
5e7031e
Fixx/5.3/doc m15 m16 m17 (#196)
samehaidi Feb 7, 2020
b4f53a6
DOC-4359: Update remote edit documentation with details for linux OS …
mzorai Feb 11, 2020
4fd7647
Fix/5.3/update info version (#197)
samehaidi Feb 13, 2020
6e15095
Fix/doc 4319: Kill Shindig documentation (#198) (#202)
mzorai Mar 11, 2020
c31f6a5
Fix/5.3/news admin updates (#205)
samehaidi Mar 25, 2020
39160f8
Fix some typos (#206)
mzorai Mar 27, 2020
edb497f
News screenshots and applicatinupdates
samehaidi Jun 25, 2020
9b4d1a2
getting started updates
samehaidi Jun 26, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 79 additions & 2 deletions docs/Administration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@ Administering eXo Platform
How to manage categories, portlets and gadgets, and introduction
to management and monitoring gadgets in eXo Platform.

- :ref:`Managing News <ManagingNews>`
How to manage News related pages and content.

- :ref:`Managing wallets <ManagingWallets>`
How to manage users and spaces wallets.

Expand Down Expand Up @@ -4574,6 +4577,72 @@ The Service Management page is displayed.
To invoke a method of the selected service, click Run corresponding
to it. After invoking it successfully, you will see the result
returned if any.


.. _ManagingNews:

==============
Managing News
==============

How to display pinned News on a page
-------------------------------------

The pinned articles are not highlighted by default in the platform (you can refer to
:ref:`this chapter <Pinning-a-News>` to know more how pin function works).

In order to display these pinned articles in a page, edit the page layout then add a "Content by query" application at the desired location.

|image348|

|image349|

Once the application is added in the page, edit its settings and choose the folder path.

|image350|

Then you have to choose the appriopriate template from "Display Settings" tab of "Edit Mode" :

- For the blog layout, select "NewsPin.gtmpl".
- For the latest News layout, select "LatestNews.gtmpl".

|image351|

Next, fill in the field "Header", this information will be displayed in the top left of the block.

|image352|

From advanced tab, fill in the following query in the field "By query" :

*select * from exo:symlink where jcr:path like '/Application Data/News/Pinned/%' ORDER BY jcr:created DESC*

Then select the page *News* > *Details* from the selector "Show in page"

|image353|

Then tick the checkbox "Restricted by user role" and click on "Save" button.

Finally, from access permission tab, tick the checkbox "Everyone" then click on "Save and close" button.

|image357|

.. note:: An issue was detected in the 5.3 version for the display of pinned news for users who are not members of the post space. This issue is due to incompatibility between News and Web-pack Addons.
To work around the problem you can either uninstall Web-pack addon as explained :ref:`here <eXoAddonsGuide.WCM.Installation.uninstall>` or replace the exo:news view template as explained in the following section.

Go to 'Administration > Content > Content Administration' then 'Templates > Documents'.

|image354|

From the Documents interface, click on 'edit' action for News template

|image355|

A popup "View & Edit Template" is displayed. Go to 'View' tab, click on the edit button of the existing 'View'
template then copy paste the template from the following
`link <https://raw.githubusercontent.com/exoplatform/news/1.1.1/webapp/src/main/webapp/WEB-INF/conf/news/nodetypes-templates/news/views/view1.gtmpl>`__ in the content field and save the action.

|image356|


.. _ManagingWallets:

Expand Down Expand Up @@ -5560,5 +5629,13 @@ The following image shows the screen when an anonymous user accesses
.. |image345| image:: images/managerewards/reward_details.png
.. |image346| image:: images/managerewards/display_disabled_users.png
.. |image347| image:: images/managerewards/search_bar.png


.. |image348| image:: images/sharenews/edit_layout.png
.. |image349| image:: images/sharenews/content_by_query.png
.. |image350| image:: images/sharenews/folder_path.png
.. |image351| image:: images/sharenews/template_selector.png
.. |image352| image:: images/sharenews/header_block.png
.. |image353| image:: images/sharenews/show_in_page.png
.. |image354| image:: images/sharenews/content_administration.png
.. |image355| image:: images/sharenews/news_template.png
.. |image356| image:: images/sharenews/view_tab.png
.. |image357| image:: images/sharenews/access_permission.png
118 changes: 1 addition & 117 deletions docs/Administration_eXo_JCR.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ Administration

- :ref:`Performance tuning <chapter-Administration-PerformanceTuning>`

Instructions on JBoss AS tuning, JCR cache tuning, Clustering,
JVM parameters, and Force query hints.
Instructions on JCR cache tuning, Clustering, JVM parameters, and Force query hints.


.. _chapter-Administration-Connectors:
Expand All @@ -45,9 +44,6 @@ Connectors
Details of configuration parameters of FTP, such as command-port,
data-min-port and data-max-port, system, and client-side-encoding.

- :ref:`JCA resource adapter <JCR.JCA>`

Details of SessionFactory, configuration, and deployment.

.. _JCR.WebDAV:

Expand Down Expand Up @@ -657,118 +653,6 @@ FTP includes the following configuration parameters:
Define the character that will be used to replace the forbidden
characters.

.. _JCR.JCA:

JCA resource adapter
~~~~~~~~~~~~~~~~~~~~~

.. note:: JCA is currently supported in eXo Platform JBoss bundle.

JCR supports *J2EE Connector Architecture* 1.5, thus if you want to
delegate the JCR Session lifecycle to your application server, you can
use the JCA resource adapter for eXo JCR. This adapter only supports XA
Transaction, in other words you cannot use it for local transactions.
Since the JCR Sessions have not been designed to be shareable, the
session pooling is simply not covered by the adapter.

**SessionFactory**

The equivalent of the ``javax.resource.cci.ConnectionFactory`` in JCA
terminology is ``org.exoplatform.connectors.jcr.adapter.SessionFactory``
in the context of eXo JCR. The resource that you will get thanks to a
JNDI lookup is of the ``SessionFactory`` type and provides the following
methods:

.. code:: java

/**
* Get a JCR session corresponding to the repository
* defined in the configuration and the default workspace.
* @return a JCR session corresponding to the criteria
* @throws RepositoryException if the session could not be created
*/
Session getSession() throws RepositoryException;

/**
* Get a JCR session corresponding to the repository
* defined in the configuration and the default workspace, using
* the given user name and password.
* @param userName the user name to use for the authentication
* @param password the password to use for the authentication
* @return a JCR session corresponding to the criteria
* @throws RepositoryException if the session could not be created
*/
Session getSession(String userName, String password) throws RepositoryException;

/**
* Get a JCR session corresponding to the repository
* defined in the configuration and the given workspace.
* @param workspace the name of the expected workspace
* @return a JCR session corresponding to the criteria
* @throws RepositoryException if the session could not be created
*/
Session getSession(String workspace) throws RepositoryException;

/**
* Get a JCR session corresponding to the repository
* defined in the configuration and the given workspace, using
* the given user name and password.
* @param workspace the name of the expected workspace
* @param userName the user name to use for the authentication
* @param password the password to use for the authentication
* @return a JCR session corresponding to the criteria
* @throws RepositoryException if the session could not be created
*/
Session getSession(String workspace, String userName, String password) throws RepositoryException;

**Configuration**

+---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| *PortalContainer* | If no portal container can be found in the context of the request, the adapter will use the value of this parameter to get the name of the expected portal container to create the JCR sessions. This parameter is optional. By default, the default portal container will be used. |
+---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| *Repository* | The repository name used to create JCR sessions. This parameter is optional. By default, the current repository will be used. |
+---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


**Deployment**

Get/Download the JBoss bundle of eXo Platform 4 or higher.

Go to the ``exo.jcr.connectors.jca`` folder, then run the
``mvn clean install -Pplatform`` command.

Deploy
``exo.jcr.connectors.jca/target/exo.jcr.connectors.jca-1.15.x-GA.rar``
in ``PLATFORM_JBOSS_HOME/standalone/deployments/``, then rename it to
``exo-jcr.rar``.

Configure the resource adapter in
``PLATFORM_JBOSS_HOME/standalone/configuration/standalone-exo.xml`` by
replacing:

::

<subsystem xmlns="urn:jboss:domain:resource-adapters:1.1"/>

with

::

<subsystem xmlns="urn:jboss:domain:resource-adapters:1.1">
<resource-adapters>
<resource-adapter>
<archive>exo-jcr.rar</archive>
<transaction-support>XATransaction</transaction-support>
<connection-definitions>
<connection-definition class-name="org.exoplatform.connectors.jcr.impl.adapter.ManagedSessionFactory"
jndi-name="java:/jcr/Repository">
<config-property name="PortalContainer">portal</config-property>
<config-property name="Repository">repository</config-property>
</connection-definition>
</connection-definitions>
</resource-adapter>
</resource-adapters>
</subsystem>

.. _chapter-Administration-Database:

Expand Down
Loading