Administration Guides

ShowBack and ChargeBack Guide

Home



Overview

The show back and chargeback feature is designed to automate reporting on department data, group shares or project data.   The solution will be available in a new side menu tab called Show back & ChargeBack that will be visible to administrator users only.  Users will not be able to see this new tab after they login.      The most common scenario's that will be supported are listed below.  It will support daily, weekly, monthly scheduling.   File pool aware search results allow reporting on each storage pool separately and the total on a specific path.  Example archive file pool, cloudpool file pool, performance file pool.    Showback will be usage only in GB's and ChargeBack will allow the data to be assigned a $ amount for each file pool or tier of data to show differential pricing for each tier.


Use Cases:

  1. A scheduled email report on a specific file system path showing the sum of the data on the path.
  2. A scheduled email report on a specific file system path showing the stale data total based on last modified or last accessed attribute
  3. A scheduled email report on a specific file system path showing the file pool break down of stored data and the sum of all file pool usage.
  4. A scheduled email report report on a specific file system path showing data a summary of the data owners.
  5. A scheduled email report covering any of the scenario's above that shows usage and shows a $ amount associated to the data or pool the data is stored in.

Requirements

  1. Release 1.1.5 or >
  2. Only Administrator users configured from the CLI will have the option to create saved searches.


How To Schedule a Search

  1. Login to the Search & Recover webUI as a user listed on the admin list
  2. The Show back & Charge Back UI is the icon on the top right menu as shown below.  It will appear after completing a search or a quick report.
    1.    
    2. Quick Reports Example.  The screenshot below is Who owns What?  report
    3.  
  3. Configure the search parameters for the advanced Search UI and execute the search to display the Schedule icon.
  4. Quick Reports also support saved searches,  configure the search parameters , execute the search to display the results and then click the scheduled search icon and configure the fields as per the below definitions.
  5. Fields to complete
    1. Name Give the saved report a good name as this will be the only way to identify the saved report from the CLI.  No special characters, spaces are allowed.
    2. File type is CSV or Excel format for the attached report format
    3. Frequency Is daily, weekly or monthly
    4. Email and CC Email is the primary person to receive the report, CC is the carbon copy email (optional).
    5. Subject The subject of the email for this report
  6. Test button - This will send an on demand email to validate the results and verify the report was received and verify the contents before saving it.
  7. Submit button -  This will save the report for scheduling.
  8. NOTE:  If click submit multiple times, this will save a duplicate scheduled search.
  9. See steps below to list or remove a saved search.
  10. Done

How to List Saved Searches and Delete Saved Searches CLI and Web GUI

  1. The saved searches are visible from the CLI and WebGUI.   The search criteria used are not displayed so the name of the saved search needs to be descriptive.   
  2. CLI
    1. List Saved Searches
      1. searchctl scheduledsearches list 
      2. The fields that are listed  ID (unique ID for each search), email TO, CC email, Schedule, FileType, Email subject 
    2. Remove a Saved Search
      1. searchctl scheduledsearches remove --id   xxxxx
  3. WebGUI
    1. The scheduled search gui is only available to ecaadmin or other admin users.  
    2. The scheduled searches are listed with the configuration and shows last run time.
    3. The schedules can be edited and re-saved or select one or more schedules and use the trash icon to delete them.
    4.  


How to see scheduled search logs for debugging

  1. Node 1 of the search appliance stores the scheduled search logs
  2. login to node 1 as ecaadmin
  3. cat /opt/superna/var/logs/searchmw/scheduledSearches.log 
  4. use this log to see issues with scheduled searches. 


Example Report

  1.  
  2.  


Customize Email Template

The email template can be customized by editing an html template file on node 1 of the Search & Recover appliance. NOTE: Only 1 report template is supported.

  1. Login to node 1 via ssh as ecaadmin user.
  2. Edit the file to add additional text to the email body.
  3. nano /opt/superna/var/search/downloads/searchreport/emailTemplate.html  
  4. Save the file after making edits
  5. control+x answer yes to save the file.
  6. New report emails will use this template when sending reports. 


Advanced - How to Configure the time Scheduled Reports are Emailed

  1. Changing the time of the daily, weekly and monthly scheduled reports can be customized to determine when searches are executed and emailed to users. 
    1. The defaults are midnight of the day,  Midnight on Sunday for weekly, and the first of the month  at midnight.
  2. login to eca node 1 as ecaadmin
  3. nano /opt/superna/eca/eca-env-common.conf
  4. Paste these variables to the file and adjust the cron string to change when the daily , weekly and monthly reports are emailed.
    1. export ECA_SEARCH_REPORT_SCHEDULE_DAILY="0 0 * * *"
    2. export ECA_SEARCH_REPORT_SCHEDULE_WEEKLY="0 0 * * 0"
    3. export ECA_SEARCH_REPORT_SCHEDULE_MONTHLY="0 0 1 * *"



© Superna LLC