1.4.3.4. Example "ReportsTask"

In the dashboard, on the Pipelines tab page, reports can be exported as a file using the Export CSV button.

Furthermore reports can be automatically exported as file or be sent as e-mail.

  1. Open the Tasks tab page in the dashboard and click on the New task button.

    -> The Task details dialog area is displayed below.

  2. Assign a name under Name and select the new option ReportsTask in the list field under Module.

  3. Select the individual options in the Settings dialog area:

    • Pipeline: In the list box, select either a specific pipeline for which reports are to be saved or the "All" option for all pipelines.

    • Export as CSV file: If activated, the reports are exported (as under Dashboard -> Export CSV [see above]). A path must be specified under Save path.

    • Save path: Save path for the CSV file (The task is executed in the app server. Make sure that the path is available on the app server!

    • Send as e-mail: When activated, the reports are sent as an e-mail.

      In this case, the server, etc. must be configured under $CADENAS_SETUP/reportstask.cfg must be configured.

      • Host: Entry is mandatory

      • Sender: Entry is mandatory

      • SenderEnvelope: Entry is mandatory

      • PasswordEncrypted: If 'PasswordEncrypted' is set to 'true' the 'Password' value needs to be encrypted using the cnstools.helpfu proxy (encrypt string).

      SMTP authentication is always possible, SSMTP should also be possible.

      If only Send as E-Mail is selected, an e-mail with so-called inline html is sent (simple table).

      If Send Html as attachment is also selected, the content is not sent directly in the email, but the website is sent as an attachment. HTML as attachment supports more CSS / HTML and therefore looks a little better. The content is structured with indentations and page numbering is possible.

    • E-mail addresses: Comma-separated list of e-mail addresses that are to be notified of new reports.

    • Send CSV file as attachment: Attach CSV file to e-mail instead of sending an HTML e-mail.

    • Report selection: Determine whether all reports or only the new reports from the last 24 hours should be sent. In the second case, repeat the execution every 24 hours.