Versions Compared

Old Version 32

changes.mady.by.user user-b885f

Saved on

compared with

New Version 33

changes.mady.by.user user-b885f

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.  

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


Divbox
styleborder-bottom: none; border-right: none; border-top: none; background: none

Contents

Table of Contents
maxLevel3
indent0px
stylenone



Prerequisites

(warning) 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

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

  1. Perspectium Core update set
  2. 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
titleSet up general settings


Divbox
stylebackground:white;


UI Steps
sizesmall


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.

(info) 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. 






General Configurations 


UI Expand
titleCreate a backup


Divbox
stylebackground:white;


UI Steps
sizesmall


UI Step

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


UI Step

Next click + New Backup.

 


UI Step

Fill in the required fields: 

Divbox
stylebackground:white;


UI Steps
sizesmall


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. 

(info) 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

(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. 

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


UI Step

Enable backup on related tables: 

Divbox
stylebackground:white;


UI Steps
sizesmall


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
stylebackground:#e8ebff;

(info) 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.



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.


UI Step

After configuring all the required fields, click Save. This will save the backup for pending use later on.

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






UI Expand
titleExecute a pending backup


Divbox
stylebackground:white;


UI Steps
sizesmall


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.


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. 






UI Expand
titleRestore a completed backup


Divbox
stylebackground:white;


Divbox
stylebackground:#fff3b4; border:none;

(warning) WARNING: Restoring a backup will overwrite existing records.


UI Steps
sizesmall


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. 

(info) 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.

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.






When to use Snapshot

How to configure Snapshot for different uses are listed below. These listed are just some examples of how you can use Snapshot and if you have any questions about how you can best use it, contact Perspectium Support.


Upgrading a ServiceNow application

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


Divbox
stylebackground:white;

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

UI Expand
titleCreate a backup


Divbox
stylebackground:white;


UI Steps
sizesmall


UI Step

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


UI Step

Next click + New Backup.

 


UI Step

Fill in all required fields:

Divbox
stylebackground:white;


UI Steps
sizesmall


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. 

(info) 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

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
titleRestore the completed backup


Divbox
stylebackground:white;


Divbox
stylebackground:#fff3b4; border:none;

(warning) 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 aapplication across different instances.

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


Divbox
stylebackground: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 can first execute a backup before doing the upgrade. 

UI Expand
titleCreate a backup in the test environment


Divbox
stylebackground:white;


UI Steps
sizesmall


UI Step

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


UI Step

Next click + New Backup.


UI Step

Fill in the required fields: 

Divbox
stylebackground:white;


UI Steps
sizesmall


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. 

(info) 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.




Let's say you now you wanted to upgrade the development environment as well. However during the upgrade, you run into issues because of conflicts with other applications on this instance. You can restore the backup from the test environment to the development environment.

UI Expand
titleRestore a completed backup


Divbox
stylebackground:white;


Divbox
stylebackground:#fff3b4; border:none;

(warning) WARNING: Restoring a backup will overwrite existing records.


UI Steps
sizesmall


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.







Backing up continuously changing environments

For instances where you are continuously making changes to, such as a development environment, you can schedule backups to automatically run on a repeated interval so you can restore at different points in time.


Divbox
stylebackground:white;

To schedule a backup on a repeated interval, do the following:

UI Expand
titleSet up a monthly backup


Divbox
stylebackground:white;


UI Steps
sizesmall


UI Step

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


UI Step

Next click + New Backup.

 


UI Step

Fill in the required fields: 

Divbox
stylebackground:white;


UI Steps
sizesmall


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. 

(info) 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

Enable backup on related tables: 

Divbox
stylebackground:white;


UI Steps
sizesmall


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 and you feel the need to restore previous table(s), you can restore one of your previously executed backups.

UI Expand
titleRestore the latest backup


Divbox
stylebackground:white;


Divbox
stylebackground:#fff3b4; border:none;

(warning) WARNING: Restoring a backup will overwrite existing records.


UI Steps
sizesmall


UI Step

Log into your ServiceNow instance and navigate to Perspectium > Snapshot > 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.