Versions Compared

Old Version 20

changes.mady.by.user user-1bc08

Saved on

compared with

New Version 21

changes.mady.by.user user-1bc08

Saved on

Key

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

DataSync Snapshot allows you to backup and restore table(s) into the same or different ServiceNow instance. Leveraging the Perspectium DataSync application, you will need to configure the Perspectium properties and apply your Integration Mesh (MBS) credentials. If you choose to restore the table(s) from another ServiceNow instance, you will need to configure the Perspectium properties in the receiving instance with the same Integration Mesh (MBS) credentials.  

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.


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 need to install 2 Perspectium update sets to your ServiceNow instance in the following order:

  1. Perspectium Core update set
  2. Perspectium Backup and Restore update set 

Follow the link to Get Started with DataSync for ServiceNow. 


Initial Setup

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


UI Expand
titleSet up general settings


Divbox
stylebackground:white;


UI Steps
sizesmall


UI Step

Navigate to General Settings

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

Enter your Perspectium Integration Mesh (MBS) login info

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

(For restoring to another ServiceNow instance) Repeat Steps 1 and 2

If you are restoring the table(s) in another ServiceNow instance, repeat steps 1 and 2 with the same Integration Mesh (MBS) credentials. 






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 to the Backup Status header, click + New Backup.

 


UI Step

Fill all required fields:

Divbox
stylebackground:white;


UI Steps
sizesmall


UI Step

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


UI Step

Within the Select an application section, and choose the tables needed for the application upgrade. 

(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), such as:

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





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 your application 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 developer environment, and you want to upgrade the test environment, you will need to execute a backup. 

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 to the Backup Status header, click + New Backup.


UI Step

Fill the required fields: 

Divbox
stylebackground:white;


UI Steps
sizesmall


UI Step

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


UI Step

Within the Select an application section, and choose the tables needed for the application upgrade. 

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




Let's say you decided 

General Configurations Create

you decided you wanted to upgrade developer 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
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.







Scheduling backups

Learn how to schedule a backup in your ServiceNow instance.


Divbox
stylebackground: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
titleSet up a monthly backup


Divbox
stylebackground:white;


UI Steps
sizesmall


Access Snapshot

UI Step

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


UI Step

Next to the Backup Status header, click + New Backup.

 Image Added


UI Step

Fill the required fields: 

Divbox
stylebackground:white;


UI Steps
sizesmall


UI Step

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


UI Step

Within the Select an application section, you can either select a table template with the dropdown that will auto populate the list of tables to be shared or manually choose tables with the slushbucket. 

(info) NOTE: These 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
stylebackground:white;


UI Steps
sizesmall


UI Step

To backup attachments (sys_attachment) along with the tables selected, enable Include attachments. 


UI Step
Create a new backup 

Enable Include table components to backup all the related components needed for the selected table(s), such as:

  • 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 fields (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 this case, choose Monthly in the Run dropdown.


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.

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.







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 to the Backup Status header, click + New Backup.

 


UI Step

Fill the required

fields 

fields: 

Divbox
stylebackground:white;


UI Steps
sizesmall


UI Step

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


UI Step

Within the Select an application section, you can either select a table template with the dropdown that will auto populate the list of tables to be shared or manually choose tables with the slushbucket. 

(info) NOTE: These 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)

Apply conditions on the selected tables 

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 

tables: 

Divbox
stylebackground:white;


UI Steps
sizesmall


UI Step

To backup attachments (sys_attachment) along 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), such as:

  • 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 fields (sys_journal_field) records related to the tables selected, enable Include journal fields.





UI Step

Enable notifications 

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 some 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

Set a schedule

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.


Save or execute the backup 
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
titleExecute a backup


Divbox
stylebackground:white;


UI Steps
sizesmall


Access Snapshot
UI Step

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


Select a backup
UI Step

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


UI Step

Execute the backup 

On the bottom of the page, click Execute Now.


UI Step

(

Optionally) See backup status 

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


Access Snapshot
UI Step

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


Select a backup to restore 
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.