Ajax Solr Reporting

From VYRE

Jump to: navigation, search

Contents

Introduction

Ajax Solr reporting is a solr search service for the reporting module. It works and behaves in a very similar manner as Ajax enterprise search except that you must specify a solr core. It is a lightweight implementation between unify and solr. The service proxies the request data to solr. The service has two main function search and exporting the search result.

Search

The search services allows proxies all the request parameters to solr. But there are some unify related parameters:

  • action: must be solrReportingSearch. Mandatory.
  • pageId: id of the page. Mandatory.
  • portletId: id of the portlet
  • displayItemId: sets the current item id, used to access the item velocity variable.
  • solrCore: name of the solr core
  • xslId: id of the xsl
  • xslPath: full path of the xsl
  • globalXmlCfgPath: full path of the global xml configuration
  • globalXmlCfgId: id of the global xml configuration


Export

This functionality was introduced in unify 4.6.3. The Solr Reporting service pulls data from solr to create an export. The Solr exporter only export data, it does not export files like original, derivied file. The exporter will exports all the items from the Solr search. After the export is completed it will appear in the users (order) inbox. The exporter will put the data from Solr into an XML file. Given that the search results can potentially return millions of document. The xml file is generated by making multiple paginated request to solr. This file will then be transformed by an XSL to the desired output (csv, html). The XSL transformation lets the developer choose how they want to display data and makes it easier to add business logic to the exporter.

[Note]

Note
  • This functionality is only available in this ajax service and has not been ported to Solr Restful Service.
  • That the relevant data must be indexed into solr. The xml will not contain unify item xml data.

Create Export

The parameters are the same as the search with few difference:

  • action': must be solrReportingExport
  • additional parameters:
    • export_filename - filename of the order
    • export_generator - by default its xsl, but you can select xhtml2excel which will convert the output to an excel document as long as the structure matches an xhtml table.
  • ignored value:
    • globalXmlCfgPath
    • globalXmlCfgId

Poll Export

This lets you poll an order. Even though its part of the solr export polling, it can be used to poll any order created by the current user. The parameters are:

  • action: must be pollOrder
  • orderId: id of the order
Personal tools