Create a data preserver

Data preservers maintain certain data on the target instance. Sometimes, preserving certain data on a target instance is desirable. For example, when using a MID Server, you can avoid overwriting the MID Server [ecc_agent] table.

Before you begin

Role required: clone_admin or admin

About this task

Preserved data is stored in a dynamically generated list on the target instance before the clone and restored on the target instance after the clone is complete. You define data preservers on the source instance.

Data preservers are primarily intended to preserve system settings and themes, such as instance-specific authentication settings. Do not use data preservers to transfer large sets of data, such as user groups. If you must preserve table data such as users, groups, and roles, consider exporting the records to a file and importing it after the clone is complete.

Consider whether to preserve the data in the following tables.
  • Bookmark [sys_ui_bookmark]
  • Recent Selection [sys_ui_recent_selection]
  • User Preference [sys_user_preference]

Procedure

  1. Navigate to System Clone > Preserve Data.
  2. Click New.
  3. Enter the table label as the Name, for example, User Preference for the [sys_user_preference] table.
  4. Select the Table to be preserved.
  5. Select the Theme check box if the data being preserved is a UI property.
  6. Define the data to be preserved using the Condition builder.
    You can use conditions to define particular records you want to preserve during a clone. For example, to only preserve particular system properties, you can add conditions for each property name you want to preserve.
    Data preserver with conditions
    Warning: If the clone from backup fails for some reason, the clone process fails over to the legacy clone engine. The legacy clone engine cannot preserve data from extended tables, relationships, hierarchies between tables, and dot-walked queries. You may want to reschedule a system clone or manually transfer data in such cases.
  7. Click Submit.

Delete a data preserver

You can delete data preservers that you no longer need. The platform protects certain essential data by default.

Before you begin

Role required: clone_admin or admin

About this task

Do not modify or delete the following data preserver records:
  • Core Instance Properties
  • Semaphores
  • Email Accounts

Procedure

  1. Navigate to System Clone > Preserve Data.
  2. Select the data preserver to delete.
  3. Perform either of the following actions.
    OptionDescription
    To delete a condition Click the X icon beside the condition, and then click Update.
    To delete the entire data preserver record Click Delete, and then click Delete in the confirmation prompt.

Exclude a table from cloning

You can exclude a table to create an empty but usable table on the target instance.

Before you begin

Role required: clone_admin or admin

About this task

The System Clone > Exclude Tables module lists the tables that are not copied during a system clone. By default, the system excludes tables for logging, auditing, notifications, and license usage.

The system cannot exclude tables that extend the Task table and that are also flattened into it as part of the table per hierarchy extension model. Since these extended tables are part of the same physical database table, the system clones the data when it clones the Task table.

You can exclude tables that extend the Task table under two conditions. Either the system stores the tables in their own physical tables as part of the table per class extension model, or you exclude the Task table itself.

To preserve the existing data on the target instance, see preserving data. Data on tables that reference the table, such as business rules, is not excluded.

Procedure

  1. Navigate to System Clone > Exclude Tables.
  2. Click New.
  3. Enter the table Name.
  4. Click Submit.

Data preservation and multiple provider single sign-on

The system automatically creates the necessary data preservers for cloning when you activate Multiple Provider Single Sign-On integration.

Table 1. Data preservers created for multiple provider single sign-on
Name Table Conditions
Certificate X.509 Certificates [sys_certificate] None
Core Instance Properties System Property [sys_properties]
  • [OR] [Name] [is one of] [glide.authenticate.external, glide.authenticate.external.logout_redirect]
  • [OR] [Name] [starts with] [com.snc.integration.saml_esig]
  • [OR] [Name] [is one of] [glide.smtp.port, glide.smtp.auth, glide.smtp.encryption]
  • [OR] [Name] [starts with] [glide.authenticate.multisso]
  • [OR] [Name] [is] [glide.authenticate.sso.redirect.idp]
Digest Properties Digest Properties [digest_properties] None
Identity Providers Identity Providers [sso_properties] None
SAML2 Update1 Properties SAML2 Update1 Properties [saml2_update1_properties] None
Note: Although you can modify these data preservers, a good practice is to avoid changing them. The Digest Properties [digest_properties], Identity Providers [sso_properties], and SAML2 Update1 Properties [saml2_update1_properties] tables are required for multiple source single sign-on to function properly. If multiple source single sign-on is disabled on the target instance, you can safely remove all three data preservers. Remove them at the same time, as the system terminates the clone with an error message when you attempt to clone with one or two of these tables being preserved.