Archive Data (found under DataSync) allows you to leverage the Perspectium DataSync solution to archive data from your ServiceNow instance to an external database. Whereas ServiceNow's built-in data archiving feature limits you to running archiving each table record only once, the Archive Data feature allows you to archive a record multiple times and to an external database of your choice using the Bulk Share fuction.
Explore the various contexts and instructions for using this feature.
NOTES
Archive Data is a separate update set installed on top of the Perspectium Core application. Contact Perspectium Support to obtain this update set and for more information.
- This feature requires Krypton 8.2.0+ of the Perspectium Core application for ServiceNow and Krypton 8.
Minimum Requirements and Support
| Perspectium Core (ServiceNow app) | Krypton 8.2.0 and newer |
| DataSync Agent | Krypton 8.0.2 and newer |
| Supported Databases | Oracle Microsoft SQL Server |
Once you navigate to DataSync > Archive Data, you will have the following options:
Archive
Archive allows you to use the Bulk Share feature to back up tables to a queue that the DataSync Agent can then save into an external database. The Archive option provides a simplified view of the Bulk Share feature so as to allow you to specify which table to archive. Leveraging bulk share functionality, records are sent out in the standard Perspectium message format (as found in the Messages > Outbound table).
The Archive option offers the following choices after navigating Archive Data > Archive:
- Create New Archive - Create a new archive configuration to specify which table you want to archive and to what target queue the records will be shared out to. This archive configuration is created as a specialized version of a bulk share.
- View Archive Configurations - View previously created archive configurations. This view will only list archive configurations and not standard bulk shares.
Restore
Restore allows you to restore previously executed archives. Restore works by sending a command message to the DataSync Agent which will then query the external database where the records were previously saved to and send those records back into ServiceNow. The records are sent to the subscribed queue the ServiceNow instance consumes from, with records sent in the Perspectium message format (as found in the Messages > Inbound table) so they can be read in using the Perspectium Core application.
The Restore option offers the following choices after navigating Archive Data > Restore:
- Create New Restore - Create a new restore (bulk share) configuration to specify which archive you want to restore from.
- View Restore Configurations - View previously created restore configurations. This view will only list restore configurations and not standard bulk shares.
NOTES
- Only archives that have a Completed status can be restored. When selecting an archive to restore from, the Restore configuration will populate with the encryption method, target queue, table name, queue and condition from the archive configuration in order to use those configurations for sending out the restore command message to the DataSync Agent.
- Archive configurations that are Completed with have a Restore this archive related link so you can easily create a restore off of it that you can then execute This restore configuration will be named Restore + Unix Timestamp i.e. Restore 1688533795479 to ensure uniquely named restore configurations.
Dashboard
The Dashboard provides a view of the data you've archived using the Archive Data feature.
After navigation to Archive Data > Dashboard, you will see the Dashboard user interface that shows the following:
NOTES
- Your preferences such as the Theme you select or the Show By (Hour, Day, Month, Lifetime) option on Record Breakdown will be saved in your browser's localStorage for when you visit the Dashboard page again.
Recent Archives
This feature displays the most recent (up to 50) archives from you instance. You can click on any entry to access that specific record directly. This table will only list bulk shares created as archives and not standard bulk shares (those created under Perspectium Core > Shares > Bulk Shares).
Record Breakdown
The Record Breakdown graph is a visualization of data based on the calendar date selected. Toggle between different data representation (records per hour, day, month, or lifetime).
Total Daily/Monthly Records
Total Daily Records: Displays the total records archived for the current day.
Total Monthly Records: Displays the total records archived for the current month.
Changing the date/month on the calendar does not affect this count.
Average Records Sent + Calendar Select
Use this feature to get a breakdown of the number of records archived based on a selected date in the calendar. Information here is based on on bulk shares created as archives and executed in your instance.
Any time you access or reload the dashboard, the calendar date will reset to the current date.
You can change the date on the calendar using the available arrows or the dropdown settings.
The Records Sent/Day count reflects the number of records archived on the specific calendar date selected.
The Records Sent/Hour count is reflects the number of records archived in the the specific calendar date selected, divided by 24 hours. However, if the current date is selected, then this number is divided by the number of hours that have passed in that day so far.
Uninstall Archive Data
Located under DataSync > -- Uninstall Archive Data, this option allows you to remove Archive Data specific Perspectium components from your instance.
Once you click on the module, you will be presented with a page to confirm you want to uninstall the Archive Data feature. Once you click Confirm, this will run a job in the background to remove Archive Data specific script includes, modules, scheduled jobs and UI pages including the Dashboard mentioned page.
NOTE: This will take a few minutes to complete. You may need to log out and then log back into your ServiceNow instance to ensure that all Archive Data modules are removed from your left side list display. Also, if any Archive Data modules were marked as favorites prior to the uninstall process, you can remove the modules by selecting the - icon on to the right of the module.