Automated Reports

Add the Report Schedule

From Serraview, complete the following:

1. Navigate to Admin Settings > System Config > General > Reporting. Remember, you can add the General setting to your Favorites menu, so that you have quick access to these settings.

2. Click the Add button.
3. From the list, select the report.

(A) Report Parameters

Depending on the report selection, different parameters display.

(B) Options

Complete the Options:

1. From the Output Type drop-down, select either Excel, PDF, or CSV. Note: When you select the import, the output type will automatically change to CSV.
2. From the Page Size drop-down, select either A4 or A3.
3. From the Orientation drop-down, select either Portrait or Landscape.

(C) Frequency

From the Frequency drop-down, select either:

• Daily - Then select the time.
• Weekly - Then select the day(s) of the week and the time.
• Monthly - Then select the month(s) of the week and the time.

(D) Delivery Method

You need at least 1 method selected:

• Email
• Import
• SFTP

Email Settings

1. In the Recipient field, enter the recipient's email address.
2. In the Subject field, enter the email's subject. Note that when the report is scheduled, it will automatically append the frequency to the report's name.
3. In the Email Body field, enter the email's body.
4. When you have finished completing the settings, click the Update button.

Import Settings

1. From the Import Type drop-down, select the import and depending on the selection, different settings display.

2. In the Email Failure field, enter the recipient's email address.
3. When you have finished completing the settings, click the Update button.

SFTP Settings

1. Complete the SFTP details, and it will override the SFTP details configuration in the Configuration > General > SFTP.

2. When you have finished completing the settings, click the Update button.

Edit the Report Schedule

1. Select the report you want to edit and the Automated Report form displays.
2. Edit the settings. 
3. Click the Update button.

Delete the Report Schedule

1. Select the report you want to delete.
2. Click the Delete button and the message "Are you sure you want to proceed with deleting this report?" displays.
3. Click the Ok button.

Pre-requisite Knowledge

• Understanding of basic JSON

Modify the Automated Report Schema

1. Navigate to Configuration > General.
2. Select Reporting.
3. In the Automated Report Schema field, enter the JSON code.

5. Click the Updated button.

Automated Report Schema Examples - JSON code

The automated report is created using the JSON (JavaScript Object Notation) format.

Monthly Example

This report is created on the 5th day of the month at the time of 22:30.

The second report is created on the 5th day of the month at the time of 23:30 and it is generated from the latest snapshot. The report is renamed to the timestamp of yyyyMMdd HH.mm.ss.

The email notification is sent to username1 and username2 and if the SFTP fails then username1 will receive the failure email.

{
    "reports": [
    {
        "frequency": "monthly",
        "days": "5",
        "time": "22:30",
        "reportUrl": "2&floorSelector=&shiftToSnapshot=-2147483648&OutputType=Excel&PageSize=A4&PageOrientation=Portrait",    
        "subject": "report 2 monthly"
    }
    {
        "frequency": "monthly",
        "days": "5",
        "time": "23:30",
        "reportUrl": "2&floorSelector=&OutputType=Excel&PageSize=A4&PageOrientation=Portrait",    
        "parameters": [{
            "useSnapshot": "[[latest]]"
        }],
        "renameFile": "[[timestamp:yyyyMMdd HH.mm.ss]]NewFileName.ext[[timestamp:yyyyMMdd HH.mm.ss]]"
    }
    ],
    "to_email": "username1@company.com, username2@company.com",
    "sftp_config": {
        "hostname": "sftp.xxxx.xxxxx",
        "port": "22",
        "username": "testusername",
        "password": "bkcd/EMD1+oPFPltJhB9Hdhz2a/QN9KAB6tpY6K7cwAw8XDlQHSw8dUIC0S",
        "fingerprint": "ssh-rsa 1024 39:05:08:3d:f8:fb:41:f2:17:a4:68:3a:2f:ab:a0:2b"
    },
    "sftp_remote_path": "to_client_name",
    "local_path": "\\test",
    "emails_on_failure": "username1@company.com"
}

The JSON parameters are:

ReportID=2&floorSelector=&OutputType=Excel&PageSize=A4&PageOrientation=Portrait

2&floorSelector=&OutputType=Excel&PageSize=A4&PageOrientation=Portrait

"useSnapshot": "SnapshotName" ]"

"useSnapshot": "[[latest]]"

"to_email": "username1@company.com, username2@company.com",