Skip to main content
Eptura Knowledge Center

Manage Snapshots

  1. Last updated
  2. Save as PDF
The Serraview reports let you analyze current Serraview data and the snapshots let you analyze historical data. The snapshots can be created automatically or manually and if you want to use snapshots then contact your System Administrator.

The snapshot creation can be created:

  • at set frequency e.g. monthly.
  • at a set time. We recommend running this outside of business hours.
  • with a snapshot name that can include today's date or a timestamp.

Automate a Snapshot

Pre-requisite knowledge

  • Understanding of basic JSON

If you need help with setting up the automated snapshot's JSON code, then contact the Serraview Support team. In the request you will need to specify the following:

  • frequency
  • time
  • name

You can automate the snapshot.

  1. Navigate to Admin Settings > System Config.
  2. Select General > General.
  3. In the Automated Snapshot Schema field, enter the JSON code.

Remember to validate the JSON code before you paste it into the field, use the JSON Validator https://jsonlint.com/

Refer to the Automated Snapshot Schema Examples - JSON Code below for the examples and code description.

5. Click the Update button.

Automated Snapshot Schema Examples - JSON Code

The automated snapshots are created using the JSON (JavaScript Object Notation) format. 

Monthly Example

This snapshot is created in the middle of the month and at the last day of the month e.g. "days": "15,-1", at the time of 23:30 and with the name Monthly with today's date.

{
	"snapshots": [
		{
			"frequency": "monthly",
			"days": "15,-1",
			"time": "23:30",
			"snapshotName": "Monthly [[today]]",
			"periodEnding": "[[today]]"
		}
	]
}

The JSON's parameters are:

Parameter

Description

snapshots

Defines an array of snapshot objects.

frequency

Defines the frequency.

The option is monthly.

If the frequency parameter is not defined, it defaults to weekly, and then the days parameter is mandatory.

When it is set to monthly, use the digit to represent the day of the month. A negative will count from the end of the month e.g. -1 means the last day of the month.

days

Defines the days.

If frequency parameter is not provided then the days parameter is required to specify which days the snapshot must be created.

The days parameter's values are:

  • day's name Monday to Sunday
  • day of the month 1 to 31. Also, the days parameter can accept multiple days e.g. "days": "15,-1" this will create a snapshot on the 15 of the month and -1 is the last day of the month. If the frequency parameter is monthly, then days parameter is the day of the month 1 to 31.

time

Defines the time. Use the 24 hours format, for example, 23:30.

Do not use a time from 1:30 to 03:30 as this is reserved for nightly tasks that start at 1:30 AEST/AEDT, instead use 00:45 or 03:45.

snapshotName

Optional - Defines the snapshot's name.

Name parameter's value is not provided, the default snapshot name is Snapshot .

You can use the following values: 

  • - this will be replaced with the value of the current date time in the format of yyyy-MM-dd HH:mm:ss. it can be placed at any position in the new file name.
  • - this will be replaced by the timestamp formatted as yyyy-MM-dd HH.mm.ss by default, it can be placed at any position in the new file name. 

Timestamp supports the following: 

  • [[timestamp:yyyyMMdd HHmmss]] will be formatted the new file name as 20170927 171345 
  • separators such as - (dash), . (period/full stop), / (back-slash) or / (forward-slash). For example will be formatted as 2017/09/27 171345.

If \ (forward-slash) is used then an extra \ is required to be placed in front as the escape character (this is part of the code syntax).

For example

periodEnding

Optional - Defines the snapshot period ending.

Use the format yyyy-MM-dd HH:00:00

Create a Snapshot Manually

From Serraview, complete the following:

  1. Navigate to Admin Settings > System Config.
  2. Select General > Snapshots. The Snapshots screen displays.

clipboard_ee402e9f62ff7aecee3379b1271a1a54b.png

3. Click the + Add icon. The Create Snapshot form displays.

clipboard_e8aa631e2ec4b2038ca01ffd2f6274ffe.png

4. In the Snapshot Name field, enter the name.

5. From the Period Ending calendar picker, select the date for the snapshots' period ending.

6. Click the Create Snapshot button.

When completed the Snapshot success displays.

Deactivate an out-of-date Snapshot

You can deactivate out-of-date Snapshots.

From Serraview, complete the following:

  1. Navigate to Admin Settings > System Config.
  2. Select General > Snapshots. The Snapshots screen displays.
  3. From the list, tick the Snapshot you want to deactivate. Note that you can select multiple snapshots.
  4. Click the + Deactivate Snapshot icon.

The Snapshot is deactivated and hidden from the list.

Show Inactive Snapshots

To display the inactive Snapshots, click the Show Inactive button.

Activate an out-of-date Snapshot

If you need an out-of-date (deactivated) Snapshot to be made active again.

From Serraview complete the following:

  1. Navigate to Admin Settings > System Config.
  2. Select General > Snapshots. The Snapshots screen displays.
  3. Click the Show Inactivate button.
  4. From the list, tick the Snapshot you want to make activate. Note that you can select multiple snapshots.
  5. Click the + Activate Snapshot button.

The Snapshot is activated and displays in the list.