Export of Data

Instead of providing hundreds of highly specialized plugins and statistics reports, LionsBase relies on a 3rd-party extension (EXT:simple_io) to export data. It is then up to the user to prepare statistics and other analysis.

The extension lets so-called «Export Configuration» records be defined:

Export Configuration records in TYPO3

Those records consist of:

  • A title (which currently cannot be translated)
  • An optional private key
  • The output format (CSV for LionsBase as it is compatible with Microsoft Excel and similar spreadsheet softwares)
  • The SQL query itself:
SQL query for an export configuration record

You may have seen that the query above contains placeholders. In fact, the 3rd-party extension lets us pre-process the query before the execution. LionsBase supports a few Lions Club-related placeholders:

  • CURRENT_CLUB: current club UID
  • CURRENT_ZONE: current zone UID
  • CURRENT_REGION: current region UID
  • CURRENT_DISTRICT: current district UID
  • CURRENT_LIONSYEAR_BEGIN: timestamp of the beginning of the current Lions year
  • CURRENT_LIONSYEAR_END: timestamp of the end of the current Lions year
  • PREVIOUS_LIONSYEAR_BEGIN: timestamp of the beginning of the previous Lions year
  • PREVIOUS_LIONSYEAR_END: timestamp of the end of the previous Lions year
  • CURRENT_FISCALYEAR_BEGIN: timestamp of the beginning of the current fiscal year
  • CURRENT_FISCALYEAR_END: timestamp of the end of the current fiscal year
  • PREVIOUS_FISCALYEAR_BEGIN: timestamp of the beginning of the previous fiscal year
  • PREVIOUS_FISCALYEAR_END: timestamp of the end of the previous fiscal year
  • ACTIVE_STATUSES: comma-separated list of «active» status codes
  • INACTIVE_STATUSES: comma-separated list of «inactive» status codes
  • VALID_CLUBS: comma-separated list of valid club types

and a few dynamic placeholders:

  • LIONSYEAR_BEGIN({startYear}-{endYear}): timestamp of 01.07.{startYear}
  • LIONSYEAR_END({startYear}-{endYear}): timestamp of 30.06.{endYear}
  • FISCALYEAR_BEGIN({year}): timestamp of 01.01.{year}
  • FISCALYEAR_END({year}): timestamp of 31.12.{year}

Good to know: The export configuration records are managed by the LionsBase Developers at Causal Sàrl and thus cannot be modified by Multi-District LionsBase Masters.

Administrator Manual

Multi-District LionsBase Masters may put a plugin on their pages (typically somewhere within the Intranet). To use it, create a new content element on your page and choose the plugin «List of export configurations»:

Plugin used to show the list of export configurations

The plugin shows the list of existing export configuration (on the right) and lets you select which of them should be made visible (on the left). The idea behind this selection is to let you restrict access to sensitive list of data to only those of your members who need to access them (e.g., the list of all members within a district could be restricted to governor council members).

To restrict access to some export configuration items, you should put the plugin on a page whose access is restricted or restrict access to the plugin itself. Please read chapter Restricting Access to a Group of Users.

Security Considerations

The plugin renders a bulleted list of links pointing to dynamically-generated files containing the information as requested. The visibility of those links is configured by the access restrictions for the plugin itself or the page containing the plugin. Each export configuration record is created with a private key (see the plugin configuration’s screenshot above).

However, once visible, the link itself is not protected and may be used even when not authenticated to retrieve the information. This is the reason why you must never share the link to the export file with anyone. Instead, you should tell where to find the list of download links (or download the file yourself and send it to whoever asked for the data).

Documentation created using Sphinx 1.8.3 and integrated in TYPO3 with restdoc.