Description

The ExportSourceBuilder component automatically generates the export of a group of histories in CSV format.

For each history selection query, it creates a PersonalizedExportSource and a ReportDelay which it links to the TriggerSwitch and to the Recipients present in the component.

 

Implementation

  • Copy / paste an ExportSourceBuilder component into the station (usually in the reportService)
  • Optionally edit the following elements in the ExportSourceBuilder:
    • The triggers linked to the TriggerSwitch (TriggerSchedule or TimeTrigger for example)
    • The TriggerSwitch (see related documentation)
    • The recipients (For example a FileRecipient of the report module or an FTPReportRecipient of the btibTooIkit module)
  • Set the InitQuery request to select the id of the logs to export. By default the query retrieves all "NumericTrend" logs. It is possible to add conditions.
  • Select the export period from the TimeRangeDefinition list defined in the btibService (see related documentation).
  • Specify whether a delta on the values should be applied to the selected histories as well as the value of the delay between the report request and its issue (ReportDelay).
  • Set the Enabled property to true

Properties

  • Enable: Enables or disables the ExportSourceBuilder
  • LastAttempt: Indicates the date of the last export attempt
  • LastSuccess: Indicates the date of the last successful export
  • LastFailure: Indicates the date of the last failure to send reports
  • ReportNameFormat: (optional) If the slot has a BFormat value, it will be resolved on each target History and the value will be set in the ExportSources. If the value is empty or if the resolved BFormat is invalid, the name of the history will be used
  • InitQuery: The query to select the id of the logs to be exported
  • TimeRange: The period for which data is to be exported
  • Delta: Defines whether the raw details are sent or the difference between the saved values
  • DateFormat: (optional) Will determine the format used in the reports for the BAbsTime values. If empty the format will be determined by the workbench. You can create a pattern using the following values: "YY", "YYYY", "M", "MM", "MMM", "D", "DD", "h", "hh", "H", "HH", "mm", "a", "ss",  "z", "W", "WW", "MMMM", "Z", "w". Each of those value can be separated by two characters maximum in the pattern. example: for the iso format, put yyyy-MM-ddTHH:mm:ssZ

  • ReportDelay: The delay time between generating the report and sending it

Actions

  • Initialize: Initializes the component, i.e. creates a PersonalizedExportSource and a ReportDelay for each history selected by the InitQuery query and links them to the TriggerSwitch and the Recipients
  • AddExportSource: This is used to manually add an ord for export