CIOC CIOC Remote Search and Details Joomla Extension Reference

Integrate data from your CIOC Applications into a WordPress or Joomla site using the CIOC CMS plug-ins.

Below is documentation for configuring the Components and Modules for the CIOC Remote Search and Details Joomla Extension.

Learn More About CIOC CMS Plug-ins »

This documentation is for the following Joomla Extension Package version: Please ensure you are using the most up-to-date version of the Joomla Extension Package.


Installing the Joomla Package

Currently, the Joomla Extension Package is available only through manual install by downloading the appropriate zip file(s) from the project repository. Use the Extensions > Manage > Install option from within Joomla to install the zip file.

The code repositories for this project are available at:

CIOC API Reference and Configuration

This plug-in works against the CIOC Remote Search and Details API. Many settings, including the fields and data avaialble, are determined by the API setup and not the WordPress plugin. Please access the documentation for the CIOC Remote Search and Details API for information on customizing data sets, fields, record details pages, and so on.

When configuring an API Account, please take proper security measures to ensure that the API Account is configured to have access only to appropriate Views, Records, and Fields.

Obtaining an API ID and Password

To use the plug-in, you must have an active API ID from the target database connected to an account with permissions to access the "CIOC Remote Search and Details API" (this setting is part of the User Type in CIOC). The CIOC User account with permissions for the API can sign into CIOC to generate an API ID/Password pair for each site. Click on your user name in the top site-bar menu to access the My Account page.

My Account > Manage API IDs

Best Practices for configuring API IDs:

Component / Module Setup Reference

Once the Extension Package has been installed and the API setup completed within the CIOC database, you can begin to configure the Joomla Component and Modules. Note that the main Joomla Component is required to drive the companion Modules; to ensure succesfull operation, please ensure that you install the entire package, and do not delete or inactivate individual parts of the package.

Global Component Setup

After installing the extension package, you should access the CIOC API Settings withing Joomla to configure the database URL, API ID and Password.

System > Global Configuration > CIOC RSD

The only mandatory settings (under the "Authentican" tab) are:

Additional display-related settings can be found under the "Display" tab:

How it Works - The Basics

The ability to generate search results, record details, and some type of search form or category list first relies on the setup of a Joomla Menu Item. This setup adds one type of search form (including "browse by category" option) as well as creating a search results page and a record details page. Additional menu items may be configured with different settings (different type of search, different "View" of records, different language, etc). Once at least one Menu Item is configured, it is also possible to add search form or category modules to other content pages that use an existing Menu Item setup to display search results and record details.

Create a Menu Item

At least one menu item configuration is required to drive all aspects of the Joomla extension. To configure a Menu Item, Select Menus > [Name of Menu to Add To] > Add New Menu Item.

On the Details Tab:

On the Search Form Options tab (if you selected the Search Form option):

On the Browse Options tab (if you selected the Browse option):

A few notes about configuring Categories / Quicklist:

On the Search Results Options tab:

Under some circumstance, you may want to hide the main search form (because you are using Supplementary Search forms in other pages, as described below). To create the Menu Item and gain the functionality of the component, but not explicitly have the link to the search page show up in your menu, choose the Link Type tab and turn off Display in Menu.

Create a Supplementary Search

Supplementary Search forms or lists of categories may be included next to other content using the CIOC RSD Modules. Modules must be tied to an already-configured Menu Item, and many settings are taken from the connected Menu Item.

To configure a Module or add a new one, choose Extensions > Modules. If you do not see the CIOC Modules in your list and there are many Modules listed, use the Search Tools to search by Type and located the ones beginning with "CIOC". To create a new Module, select New + from the main Module management page and select either a CIOC RSD (Search form) or CIOC Remote Browse (Category list) Module Type. It is possible to configure Multiple Modules, which may be tied to the same or different Menu Items. This is useful if you are displaying content from different Views, or different lists of categories.