Joomla publication

From OpenKM Documentation
Jump to: navigation, search

Joomla publication feature allow to automatically publish contents from OpenKM to Joomla. OpenKM Joomla publication feature can upload HTML contents from OpenKM and images related into these HTML contents to Joomla.

Configuration

Configuration Joomla

Configuration OpenKM

There are three configuration parameters that must be set in Configuration view:

  • joomla.url: the Joomla URL, for example http://yoursite/.
  • joomla.user: the Joomla users with write grants for publishing.
  • joomla.pass: the password of the user.

Property group configuration

This property group must be registered in Property Groups administration:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 2.3//EN"
                                 "http://www.openkm.com/dtd/property-groups-2.3.dtd">
<property-groups>
  <property-group label="Joomla Publication" name="okg:joomla_publication">
    <input label="Id Article" type="text" name="okp:joomla_publication.article.id" readonly="true" />  
    <input label="Title" type="text" name="okp:joomla_publication.title" width="300px">
       <validator type="req"/>   
    </input> 
    <input label="Id Category" type="text" name="okp:joomla_publication.category.id" readonly="true" />        
    <select label="Category" name="okp:joomla_publication.category" type="simple">
      <option label="OpenKM Features" value="OpenKM Features"/>
      <option label="OpenKM Blog" value="OpenKM Blog"/>
      <validator type="req"/>
    </select>  
    <input label="Publish Up" type="date" name="okp:joomla_publication.publish_up" >
      <validator type="req"/>
    </input>      
    <input label="Publish Down" type="date" name="okp:joomla_publication.publish_down" />      
    <select label="State" name="okp:joomla_publication.state" type="simple">
      <option label="Published" value="1"/>
      <option label="Unpublished" value="0"/>          
      <option label="Archived" value="2"/>
      <option label="Trash" value="-2"/>
      <validator type="req"/>
    </select>
    <select label="Access" name="okp:joomla_publication.access" type="simple">
      <option label="Public" value="1"/>
      <option label="Registered" value="2" /> 
      <option label="Special" value="3"/> 
    <validator type="req"/>
    </select>      
    <select label="Language" name="okp:joomla_publication.language" type="simple">
      <option label="All" value="*"/>
      <option label="English" value="en-GB"/> 
      <option label="Spanish" value="es-ES" />           
      <validator type="req"/>
    </select>
    <select label="Synchronized" name="okp:joomla_publication.synchronized" type="simple">
      <option label="True" value="true"/>
      <option label="False" value="false"/>
      <validator type="req"/>
    </select>          
  </property-group>
  <property-group label="Joomla Media" name="okg:joomla_media" readonly="true">
    <input label="Id" type="text" name="okp:joomla_media.id" />  
    <input label="name" type="text" name="okp:joomla_media.name" />
    <input label="path" type="text" name="okp:joomla_media.path" />                   
  </property-group>
</property-groups>

Publish content

With any HTML file - uploaded or created into OpenKM - add the property group ( metadata ) called Joomla Publication


Okm user guide 547.png


After the property group ( metadata ) fields will be saved, these are automatically processed by OpenKM metadata events. The OpenKM automation task called Joomla metadata will process the contents and upload the media - images - related into the HTML content to joomla.


Okm user guide 548.png


Also the Joomla response is processed by OpenKM and values are saved in property group ( metadata ) Joomla Publication information about joomla content, like idContent and idCategory.

Okm user guide 549.png


or into property group ( metadata ) Joomla Media information about media contents, like idMedia, path


Okm user guide 550.png

Update content

Each time some content yet published into Joomla is updated, automatically is processed by OpenKM metadata events. The OpenKM automation task called Joomla content and media will update the content.

Update metadata

Each time some Joomla publication property group - metadata - values are changed automatically are processed by OpenKM metadata events. The OpenKM automation task called Joomla metadata will update the content.

Update media

Each time some media yet uploaded into Joomla is updated, automatically is processed by OpenKM metadata events. The OpenKM automation task called Joomla content and media will update media at Joomla and also update all related contents with that media.


Okm user guide 548.png


Also the Joomla response is processed by OpenKM and values are updated in property group ( metadata ) Joomla Publication.

Property group description

Joomla Publication

  • Id Article: is the joomla content id.
  • Title: is the Joomla title.
  • Id Category: is the joomla category id.
  • Category: are the Joomla categories.
  • Publish Up: are the Joomla publish up.
  • Publish Down: are the Joomla publish down.
  • State: indicate the Joomla publication state (Published, Unpublished,Archived,Trash).
  • Access: indicate the Joomla publication access (Public, Registered,Special).
  • Language: indicate the Joomla publication language (All, English,Spanish).

Joomla Media

  • Id: is the Joomla media id.
  • Name: is the unique Joomla filename.
  • URL: is the Joomla media url.