#XLYRE
##Introduction
Xlyre is an Open Data Management Module for Ximdex CMS. It can be used to publish sets of data with their metadata. It's based on three main components:
- Catalog
- Dataset
- Distribution
A catalog is a list of datasets that describe a collection of entities. Each dataset has several metadata fields and a set of distributions associated with the dataset. Each distribution is a set of data in a specific format or based in a specific period of time (month, year, ...).
All actions can be filtered based on roles but by default the user can create catalogs, datasets and distributions. Also he/she can publish the entire catalog or a specific datasets with their distributions.
##Installation
Before install Xlyre you have to edit a file called install-modules.conf that it's located in conf folder. Once you open this file with your favourite text editor you have to add the following line:
define('MODULE_XLYRE_PATH','/modules/xlyre');
Once this line is added to install-modules.conf file you can install Xlyre. First go to modules folder and copy module files into it. Then go to install folder in Ximdex path and execute:
./module.sh install xlyre
That's it! Now you will see specific actions and configuraitons for Xlyre on Ximdex CMS.
##Configuration
Xlyre has two main sections for configuring it.
- Control Center / Xlyre Manager: In this section you can add, delete or modify all content related with themes, periodicities and spatials.
- License links folder: This folder will be added to the project once you interact with Xlyre (creating your first catalog section for instace). This folder contains all licenses that the system will support to be added to the datasets.
##Publication
We are going to define a base case to show us publication urls. Imagine we have a catalog called ODCatalog which has one dataset called Budget in english and spanish languages. When you publish this catalog, Xlyre generates those urls:
- http://yourdomain.com/en/ODCatalog/
- http://yourdomain.com/es/ODCatalog/
- http://yourdomain.com/en/ODCatalog/Budget
- http://yourdomain.com/es/ODCatalog/Budget
If the dataset has some distributions, when the catalog is published Xlyre also generates:
which will be the unique url to access to that distribution.
##Screenshots
- Create a catalog with one dataset:
- Edit a dataset:
- Add new distribution in a specific dataset:
- Show distribution in a specific dataset:
