Page Comparison - Get started with Snapshot (v.28 vs v.29) - Helium

DataSync Snapshot reliably, comprehensively backs up ServiceNow objects and data without impacting performance, and all from within the Perspectium DataSync application.

Once you have created and executed a backup, you will have the option to restore the records in the selected table(s) in your ServiceNow instance or another ServiceNow instance.

NOTE: You will need to have MBS 3.0 to properly run backup and restore. For more information, contact Perspectium Support.

Divbox

style	border-bottom: none; border-right: none; border-top: none; background: none

Contents

Table of Contents

maxLevel	3
indent	0px
style	none

Prerequisites

You will need the following information from Perspectium Support:

Perspectium Integration Mesh (MBS) server URL
Integration Mesh (MBS) vhost
Integration Mesh (MBS) username
Integration Mesh (MBS) password

Then, you will first need to install the Perspectium application into your ServiceNow instance by installing update sets in the following order::

Perspectium Core update set
Perspectium Snapshot update set

Follow the link to Get Started with DataSync for ServiceNow.

Initial Setup

Before you begin, you will need set up initial configurations in Perspectium's General Settings:

UI Expand

title	Set up general settings

Divbox

style	background:white;

UI Steps

size	small

UI Step

Log into your ServiceNow instance and navigate to Perspectium > Control and Configuration > Properties or simply type Control and Configuration in the Filter Navigator on the upper left-hand side of the screen. and then click Properties.

Then, click General Settings.

UI Step

Type your Perspectium Integration Mesh username, password, and server URL in the appropriate fields.

NOTE: In the username field, you will need to prepend the username with your vhost name, i.e. vhost/user.

Then, scroll down to the bottom of the page and click Save.

UI Step
If you will be restoring table(s) into another ServiceNow instance, repeat steps 1 and 2 with the same Integration Mesh (MBS) credentials in the other instance.

Upgrading a ServiceNow application

Learn how to setup and execute backup to prepare your ServiceNow instance for an upgrade.

Divbox

style	background:white;

Before you upgrade your application, you will need to back up the tables in your ServiceNow instance.

General Configurations

UI Expand

title	Create a backup

Divbox

style	background:white;

UI Steps

size	small

UI Step
Log into your ServiceNow instance and navigate to Perspectium > DataSync > Snapshot.

UI Step

Next click + New Backup.

Image Modified

UI Step

Fill in

all

the required fields:

Divbox

style	background:white;

UI Steps

size	small

UI Step
Fill in the Name field with the desired name of the backup.

UI Step

Within the Select an application section, choose the tables you want to backup. You can either pick tables manually from the Tables list or select an application which contains a set list of tables to backup.

NOTE: These application templates are tables available in the global scope.

(Optionally) If you manually chose tables, you can save those selected tables as a custom application template with the + button next to the dropdown.

Image Modified

UI Step

Enable Include table components to backup all the related components needed for the selected table(s). Selecting this option will only select records related to your select tables from the following system tables:

Custom fields in the dictionary entry (sys_dictionary)
Business rule (sys_script)
Access control (sys_security_acl)
UI action (sys_ui_action)
List (sys_ui_list)
List element (sys_ui_list_element)
Module (sys_ui_module)
Form section (sys_ui_section)

UI Step
After configuring all the required fields, click Execute Now. This will start executing the backup immediately.

Once the tables are backed up, you can upgrade the application. Let’s say something went wrong or the upgrade removed a core functionality, time to restore that backup!

UI Expand

title	Restore the completed backup

Divbox

style	background:white;

Divbox

style	background:#fff3b4; border:none;

WARNING: Restoring a backup will overwrite existing records.

UI Steps

UI Step
Log into your ServiceNow instance and navigate to Perspectium > Snapshot > Snapshot.

UI Step
Select the completed back up you want to restore. Then, click Restore. You will be prompted to continue and click Ok. Once restore is complete, your ServiceNow instance will start receiving inbound messages (Perspectium > Messages > Inbound) and the restored records in the selected table(s) will appear in your instance.

UI Step

Select the completed back up you want to restore. Then, click Restore. You will be prompted to continue and click Ok.

Once restore is complete, your ServiceNow instance will start receiving inbound messages (Perspectium > Messages > Inbound) and the restored records in the selected table(s) will appear in your instance.

Upgrading across different instances

Learn how to backup and restore table(s) when upgrading your application across different instances.

NOTE: Before you begin, validate that you have the same Integration Mesh credentials across the different instances.

(Optional)

After selecting tables to backup, you have an option to apply conditions to tables that you want to back up. Without setting conditions, the entire tables will be backed up.

To apply conditions, click Set Filters below the Tables to set up your desired conditions.

Image Added

Then, select the table you want to filter and set the conditions with the condition builder.

Image Added

UI Step

Enable backup on related tables:

Divbox

style	background:white;

UI Steps

size	small

UI Step
To backup attachments (sys_attachment and sys_attachment_doc) for with the tables selected, enable Include attachments.

UI Step

Enable Include table components to backup all the related components needed for the selected table(s). Selecting this option will only select records related to your select tables from the following system tables:

Custom fields in the dictionary entry (sys_dictionary)
Business rule (sys_script)
Access control (sys_security_acl)
UI action (sys_ui_action)
List (sys_ui_list)
List element (sys_ui_list_element)
Module (sys_ui_module)
Form section (sys_ui_section)

UI Step
To backup journal field (sys_journal_field) records related to the tables selected, enable Include journal fields.

UI Step

To enable notification for when backups are completed, check Enable notifications. Then, chose which users will receive the notifications or enter an email.

Divbox

style	background:#e8ebff;

NOTE: Perspectium notifications are created as ServiceNow email notifications in order to send emails natively through the instance and notifications use notification email scripts for the email's subject and body content. See email notifications and notification email scripts for more information.

Image Added

UI Step

Instead of executing the backup right away, you can set a up a scheduled back up by enabling Set a schedule. Once activated, you can choose when to run the schedule.

Image Added

UI Step

After configuring all the required fields, click Save.

If you did not set a schedule and want to execute the backup right away, click Execute Now

Divbox

style	background:white;

In cases where you have two instances, i.e. one test environment and one development environment, and you want to upgrade the test environment, you will need to execute a backup

.

Create in the test environment

UI Expand

title

Execute a backup

Divbox

style	background:white;

UI Steps

size	small

UI Step

Log into your ServiceNow instance and navigate to Perspectium >

DataSync

Snapshot > Snapshot.

UI Step

Under Pending Backups, select the backup you want to execute. Then, click Edit.

Image Added

Next click + New Backup.

Fill in the required fields:

UI Step

Divbox

style	background:white;

UI Steps

size	small

UI Step
Fill in the Name field with the desired name of the backup.

UI Step

Within the Select an application section, choose the tables you want to backup. You can either pick tables manually from the Tables list or select an application which contains a set list of tables to backup.

NOTE: These application templates are tables available in the global scope.

(Optionally) If you manually chose tables, you can save those selected tables as a custom application template with the + button next to the dropdown.

UI Step
After configuring all the required fields, click Execute Now. This will start executing the backup immediately.

On the bottom of the page, click Execute Now.

UI Step

(Optional) Navigate back to Snapshot. Under the Backup Status section, monitor the status of your backup.

Image Added

UI Expand

title	Restore a completed backup

Divbox

style	background:white;

Divbox

style	background:#fff3b4; border:none;

WARNING: Restoring a backup will overwrite existing records.

UI Steps

size	small

UI Step
Log into your ServiceNow instance and navigate to Perspectium > Snapshot > Snapshot.

UI Step

Whether you are restoring in your own instance or another instance, select the completed back up you want to restore. Then, click Restore. You will be prompted to continue and click Ok.

NOTE: If you are restoring the table(s) in another instance, validate that you have the same Integration Mesh credentials. See set up initial configurations for Snapshot.

Image Added

Once restore is complete, your ServiceNow instance will start receiving inbound messages (Perspectium > Messages > Inbound) and the restored records in the selected table(s) will appear in your instance.

Upgrading a ServiceNow application

Learn how to setup and execute backup to prepare your ServiceNow instance for an upgrade.

Divbox

style	background:white;

Before you upgrade your application, you will need to back up the tables in your ServiceNow instance.

UI Expand

title	Create a backup

Divbox

style	background:white;

UI Steps

size

Let's say you now you wanted to upgrade development environment as well, but mid-upgrade, you decided not to do so. You can restore the backup from the test environment to the developer environment.

UI Expand

title	Restore a completed backup

Divbox

style	background:white;

Divbox

style	background:#fff3b4; border:none;

WARNING: Restoring a backup will overwrite existing records.

UI Steps

size	small

UI Step
Log into your ServiceNow instance and navigate to to Perspectium > > DataSync > Snapshot > Snapshot.

UI Step

Select the completed back up you want to restore. Then, click Restore. You will be prompted to continue and click Ok.

Once restore is complete, your ServiceNow instance will start receiving inbound messages (Perspectium > Messages > Inbound) and the restored records in the selected table(s) will appear in your instance.

Scheduling backups

Learn how to schedule a backup in your ServiceNow instance.

Divbox

style	background:white;

To prepare for cases where you are experiencing technical difficulties in your ServiceNow instance, i.e. environment breaks, you can set a scheduled backup.

UI Expand

title	Set up a monthly backup

Divbox

style	background:white;

UI Steps

size	small

UI Step
Log into your ServiceNow instance and navigate to Perspectium > DataSync > Snapshot.

UI Step

Next click + New Backup.

Image Removed

UI Step

Fill in the required fields:

Divbox

style	background:white;

UI Steps

size	small

UI Step
Fill in the Name field with the desired name of the backup.

UI Step

Within the Select an application section, choose the tables you want to backup. You can either pick tables manually from the Tables list or select an application which contains a set list of tables to backup.

NOTE: These application templates are tables available in the global scope.

(Optionally) If you manually chose tables, you can save those selected tables as a custom application template with the + button next to the dropdown.

Image Removed

UI Step

Enable backup on related tables:

Divbox

style	background:white;

UI Steps

size	small

UI Step
To backup attachments (sys_attachment and sys_attachment_doc) for the tables selected, enable Include attachments.

UI Step

Enable Include table components to backup all the related components needed for the selected table(s). Selecting this option will only select records related to your select tables from the following system tables:

Custom fields in the dictionary entry (sys_dictionary)
Business rule (sys_script)
Access control (sys_security_acl)
UI action (sys_ui_action)
List (sys_ui_list)
List element (sys_ui_list_element)
Module (sys_ui_module)
Form section (sys_ui_section)

UI Step
To backup journal field (sys_journal_field) records related to the tables selected, enable Include journal fields.

UI Step

Check Set a schedule.

Once activated, you can choose when to run the schedule in the Run dropdown. In this case we've chosen Monthly to have a backup executed every month from this point forward.

UI Step
Click Save.

Once you experience an issue, i.e. environment breaks, and you feel the need to restore previous table(s), you can restore the latest backup.

Next click + New Backup.

Image Added

UI Step

Fill in all required fields:

Divbox

style	background:white;

UI Steps

size	small

UI Step
Fill in the Name field with the desired name of the backup.

UI Step

Within the Select an application section, choose the tables you want to backup. You can either pick tables manually from the Tables list or select an application which contains a set list of tables to backup.

NOTE: These application templates are tables available in the global scope.

(Optionally) If you manually chose tables, you can save those selected tables as a custom application template with the + button next to the dropdown.

Image Added

UI Step

Enable Include table components to backup all the related components needed for the selected table(s). Selecting this option will only select records related to your select tables from the following system tables:

Custom fields in the dictionary entry (sys_dictionary)
Business rule (sys_script)
Access control (sys_security_acl)
UI action (sys_ui_action)
List (sys_ui_list)
List element (sys_ui_list_element)
Module (sys_ui_module)
Form section (sys_ui_section)

UI Step
After configuring all the required fields, click Execute Now. This will start executing the backup immediately.

Once the tables are backed up, you can upgrade the application. Let’s say something went wrong or the upgrade removed a core functionality, time to restore that backup!

UI Expand

title	Restore the completed backup

Divbox

style	background:white;

Divbox

style	background:#fff3b4; border:none;

WARNING: Restoring a backup will overwrite existing records.

UI Steps

UI Step
Log into your ServiceNow instance and navigate to Perspectium > Snapshot > Snapshot.

UI Step

Select the completed back up you want to restore. Then, click Restore. You will be prompted to continue and click Ok.

Once restore is complete, your ServiceNow instance will start receiving inbound messages (Perspectium > Messages > Inbound) and the restored records in the selected table(s) will appear in your instance.

Upgrading across different instances

Learn how to backup and restore table(s) when upgrading your application across different instances.

NOTE: Before you begin, validate that you have the same Integration Mesh credentials across the different instances.

UI ExpandtitleRestore the latest backup

Divbox

style	background:white;

In cases where you have two instances, i.e. one test environment and one development environment, and you want to upgrade the test environment, you will need to execute a backup.

UI Expand

title	Create a backup in the test environment

Divbox

style	background:white;

#fff3b4; border:none;

WARNING: Restoring a backup will overwrite existing records.

UI Steps

size	small

UI Step
Log into your ServiceNow instance and navigate to Perspectium > Snapshot > to Perspectium > DataSync > Snapshot.

UI Step

Select the most recent backup, then click Restore. You will be prompted to continue and click Ok.

Once restore is complete, your ServiceNow instance will start receiving inbound messages (Perspectium > Messages > Inbound) and the restored records in the selected table(s) will appear in your instance.

General Configurations

Create a backup

Next click + New Backup.

UI Step
Fill in the required fields:

UI Expand

title

Enable backup on related tables:

Divbox

style	background:white;

UI Steps

size	small

UI Step

Log into your ServiceNow instance and navigate to Perspectium > DataSync > Snapshot

Fill in the Name field with the desired name of the backup.

UI Step

Next click + New Backup.

Image Removed

Within the Select an application section, choose the tables you want to backup. You can either pick tables manually from the Tables list or select an application which contains a set list of tables to backup.

NOTE:

UI Step

Fill in the required fields:

Divbox

style	background:white;

UI Steps

size	small

UI Step
Fill in the Name field with the desired name of the backup.

UI Step

Within the Select an application section, choose the tables you want to backup. You can either pick tables manually from the Tables list or select an application which contains a set list of tables to backup.

NOTE:

These application templates are tables available in the global scope.

(Optionally) If you manually chose tables, you can save those selected tables as a custom application template with the + button next to the dropdown.

Image Removed

UI Step

(Optional)

After selecting tables to backup, you have an option to apply conditions to tables that you want to back up. Without setting conditions, the entire tables will be backed up.

To apply conditions, click Set Filters below the Tables to set up your desired conditions.

Image Removed

Then, select the table you want to filter and set the conditions with the condition builder.

Image Removed

UI Step


After configuring all the required fields, click Execute Now. This will start executing the backup immediately.

Let's say you now you wanted to upgrade development environment as well, but mid-upgrade, you decided not to do so. You can restore the backup from the test environment to the developer environment.

UI Expand

title	Restore a completed backup

Divbox

style	background:white;

Divbox

style	background:#fff3b4; border:none;

WARNING: Restoring a backup will overwrite existing records.

white;

UI Steps

size	small

UI Step
To backup attachments (sys_attachment and sys_attachment_doc) for with the tables selected, enable Include attachments. Log into your ServiceNow instance and navigate to Perspectium > Snapshot > Snapshot.

UI Step

Enable Include table components to backup all the related components needed for the selected table(s). Selecting this option will only select records related to your select tables from the following system tables:

Custom fields in the dictionary entry (sys_dictionary)
Business rule (sys_script)
Access control (sys_security_acl)
UI action (sys_ui_action)
List (sys_ui_list)
List element (sys_ui_list_element)
Module (sys_ui_module)
Form section (sys_ui_section)

UI Step
To backup journal field (sys_journal_field) records related to the tables selected, enable Include journal fields.

Select the completed back up you want to restore. Then, click Restore. You will be prompted to continue and click Ok.

Once restore is complete, your ServiceNow instance will start receiving inbound messages (Perspectium > Messages > Inbound) and the restored records in the selected table(s) will appear in your instance.

Scheduling backups

Learn how to schedule a backup in your ServiceNow instance.

Divbox

style	background:white;

To prepare for cases where you are experiencing technical difficulties in your ServiceNow instance, i.e. environment breaks, you can set a scheduled backup.

UI Expand

title	Set up a monthly backup

Divbox

style	background:white;

UI Steps

size	small

UI Step
Log into your ServiceNow instance and navigate to Perspectium > DataSync > Snapshot.

UI Step

Next click + New Backup.

Image Added

UI Step
Fill in the required fields:

UI Step

To enable notification for when backups are completed, check Enable notifications. Then, chose which users will receive the notifications or enter an email.#e8ebff;

Divbox

style	background:

NOTE: Perspectium notifications are created as ServiceNow email notifications in order to send emails natively through the instance and notifications use notification email scripts for the email's subject and body content. See email notifications and notification email scripts for more information.

Image Removed

UI Step

Instead of executing the backup right away, you can set a up a scheduled back up by enabling Set a schedule. Once activated, you can choose when to run the schedule.

Image Removed

UI Step

After configuring all the required fields, click Save.

If you did not set a schedule and want to execute the backup right away, click Execute Now.

UI Expand

title	Execute a backup

white;

UI Steps

size	small

UI Step
Fill in the Name field with the desired name of the backup.

UI Step

Within the Select an application section, choose the tables you want to backup. You can either pick tables manually from the Tables list or select an application which contains a set list of tables to backup.

NOTE: These application templates are tables available in the global scope.

(Optionally) If you manually chose tables, you can save those selected tables as a custom application template with the + button next to the dropdown.

Image Added

UI Step

Enable backup on related tables:

Divbox

style	background:white;

UI Steps

size	small

UI Step
To backup attachments (sys_attachment and sys_attachment_doc) for the tables selected, enable Include attachments.

UI Step

Enable Include table components to backup all the related components needed for the selected table(s). Selecting this option will only select records related to your select tables from the following system tables:

Custom fields in the dictionary entry (sys_dictionary)
Business rule (sys_script)
Access control (sys_security_acl)
UI action (sys_ui_action)
List (sys_ui_list)
List element (sys_ui_list_element)
Module (sys_ui_module)
Form section (sys_ui_section)

UI Step
To backup journal field (sys_journal_field) records related to the tables selected, enable Include journal fields.

UI Step

Check Set a schedule.

Once activated, you can choose when to run the schedule in the Run dropdown. In this case we've chosen Monthly to have a backup executed every month from this point forward.

UI Step
Click Save.

Once you experience an issue, i.e. environment breaks, and you feel the need to restore previous table(s), you can restore the latest backup.

Divbox

style	background:white;

UI Steps

size	small

UI Step
Log into your ServiceNow instance and navigate to Perspectium > Snapshot > Snapshot.

UI Step

Under Pending Backups, select the backup you want to execute. Then, click Edit.

Image Removed

UI Step
On the bottom of the page, click Execute Now.

UI Step

(Optional) Navigate back to Snapshot. Under the Backup Status section, monitor the status of your backup.

Image Removed

UI Expand

title	Restore

a completed

the latest backup

Divbox

style	background:white;

Divbox

style	background:#fff3b4; border:none;

WARNING: Restoring a backup will overwrite existing records.

UI Steps

size	small

UI Step
Log into your ServiceNow instance and navigate to Perspectium > Snapshot > Snapshot

.

UI Step

.

UI Step
Select the most recent backup, then

Whether you are restoring in your own instance or another instance, select the completed back up you want to restore. Then,

click Restore. You will be prompted to continue and click Ok.

NOTE: If you are restoring the table(s) in another instance, validate that you have the same Integration Mesh credentials. See set up initial configurations for Snapshot.

Image Removed

Once restore is complete, your ServiceNow instance will start receiving inbound messages (Perspectium > Messages > Inbound) and the restored records in the selected table(s) will appear in your instance.

Content

Space Tools

Versions Compared

Old Version 28

New Version 29

Key

Prerequisites

Initial Setup

Upgrading a ServiceNow application

General Configurations

Upgrading across different instances

Upgrading a ServiceNow application

Scheduling backups

Upgrading across different instances

General Configurations

Scheduling backups

Content

Space Tools

Page History

Versions Compared

Old Version 28

New Version 29

Key

Prerequisites

Initial Setup

Upgrading a ServiceNow application

General Configurations

Upgrading across different instances

Upgrading a ServiceNow application

Scheduling backups

Upgrading across different instances

General Configurations

Scheduling backups