CopySettings script

(SharePoint Online Only) Pre-requisite

• Enable your Azure App Registration Authentication permissions:

  • This may already have been executed during the installation of the Ucc.Creator. If not please follow steps on, Learn More

Preparations

1. Download the zipfile called CopySettings vX.X.X.X.zip
2. Make sure that the .zip package is unblocked.
   Right click on the .zip file and choose ‘properties’
   Then click Unblock and Apply

Configure Properties

1. Edit the properties.ps1 file (in your preferred editor).

2. Set inputOperation:

   1. backup = Create a local backup of the UCC site(s), can be used to restore to a new or the same location

   2. restore = Restore a local backup to SharePoint

   3. sidebyside = Perform a backup from one site and restore into another site in one go (useful when moving to a new site collection)

      Note

      For sidebyside and restore the parameters for the restore destination needs be entered separately under the header "Restore location settings".

3. Set library Copy options (Libraries may be larger and will take longer to copy):

   1. inputCopyLibrariesOnly = Specify if Only the libraries should be copied (and not the other lists).

   2. inputCopyRecordings = Specify if the Recordings library should be copied (together with the other lists).

   3. inputCopyVoicemails = Specify if the Recordings library should be copied (together with the other lists).

   4. inputCopyCallSummary = Specify if the CallSummary list should be copied (together with the other lists).

   5. inputCopyBridgDocuments = (The Bridg App and settings is deprecated).

   6. inputCopyInboundScreenRecordings = Specify if the Inbound ScreenRecordings library should be copied (together with the other lists).

   7. inputCopyOutboundScreenRecordings = Specify if the Outbound ScreenRecordings library should be copied (together with the other lists).

4. Select if the permissions should be copied.

   Warning

   Make sure the account(s) exist when moving the a new environment (For example to SharePoint Online)

5. Fill in the InputSiteUrl. This is the URL of the Site Collection which contains the UCC site(s). (A single site can be selected during execution of the script).

6. Specify with backupFromSiteDirectly whether the site to backup is a OneUCC site (when subsites are disabled and not used) or if Legacy subsites are used. (true/false)

7. Choose the authentication method:
   1. User Authentication:

      1. inputUsername = Domain and Username of the UCC Service account or SharePoint Online account)

      2. inputPassword = (Encrypted) Password of the account

      3. inputPasswordEncrypted = Enable or disable that the password needs to be encrypted.

         Note

         Encrypt password script is located in the same folder as the properties.ps1.

   2. App Authentication (SPOnline only) Learn More:
      1. inputAppId = ClientId is the id created during the installation of the UCC Creator
      2. inputAppSecret = ClientSecret is the client secret created during the installation of the UCC Creator
   3. Certificate Authentication (SPOnline only) Learn More:
      1. inputCertificateAppId = The AppId created during the creation of the X.509 certificate.

      2. inputCertificateTenantId = The TenantId of your SharePoint site

      3. inputCertificatePassword = The password created during the creation of the X.509 certificate.

      4. inputCertificatePath = The path (local) to where the .pfx certificate file is placed on the machine running this script.

8. Select client mode:
   1. 2010 = SharePoint 2010 Server (On-Premise)
   2. 2013 = SharePoint 2013 Server (On-Premise)
   3. 2016 = SharePoint 2016 Server (On-Premise)
   4. 2019 = SharePoint 2019 Server (On-Premise)
   5. online = SharePoint Online
9. Select SharePoint Template version:
   1. inputv2Template - y = SharePoint template 6.0 (Ucc.Creator) or higher.
   2. inputv2Template - n = SharePoint template 5.2

10. Similar values should be set for the Restore destination settings (See steps 5 - 9).

11. (Optional) point to the path (inputPathtoUccCreator) for the Ucc.Creator on the same machine. This is needed for sidebyside or restore to a new Ucc.Creator site collection.

    Warning

    With the Ucc.Creator (8.2.0.7 and higher) option to create UCC sites with or without subsites it is now required for the UCC sites in a new Site Collection to be created first. Each UCC site's content can then be copied using this script to the newly created sites. Learn More

12. Save the properties file

Backup - Execute script

1. Open PowerShell as administrator

2. Navigate to the copysettings folder.

3. Run the sptemplate_copysettings.ps1 script.

4. You will be able to select the site you want to backup

   

5. A new folder will be created inside the copysettings folder with the name SettingsBackup, and subfolders for each UCC name.

Restore - Execute script

Scenario A. to recreate ucc settings sites in the same site collection

1. In the backup folder rename the ucc folder name to the new name.

2. Edit the properties file and use restore mode

3. The script will ask if you want to overwrite. This is ok because the name is changed and a new site is created.

4. Your new site is created and you can change the url in the ucc config to the new site.

Scenario B. to move a site to a new site collection

1. Edit the properties file

2. Use restore mode and the inputTargetSiteUrl will be used to restore content of UCC sites in there

3. The script will ask if you want to overwrite. This is ok because the Site Collection is new.

4. Your new site is created. Now your UCC service needs a change for the URL in the ucc config to point to the new site.

5. A restart of your UCC service without cache is required to have your UCC's looking to the new SharePoint UCC site(s)

Scenario C to change the site prefix for a UCC site

When you want to restore a certain UCC from a backup, you have the possibility to adjust the UCC Config Site name by adding a new prefix, that will display on the new URL of the target location.

1. Open the properties file and scroll down to #restore site with prefix

2. Enable the feature with yes

   $inputTargetSitePrefix = "y" # yes/no

3. Add the prefixold and the prefixnew inside brackets

   $inputTargetSitePrefixOld = ""

   $inputTargetSitePrefixNew = ""

4. When you run the script next time and the feature is enabled, you will be able to change the name (site URL) from all selected backup UCCs (prefixold) to be restored with a new prefix (prefixnew).

SidebySide - Execute script

1. Open PowerShell as administrator

2. Navigate to the copysettings folder.

3. Run the sptemplate_copysettings script.

4. You will be able to select the site you want to backup

5. A new folder will be created inside the copysettings folder with the name SettingsBackup, and subfolders for each UCC name.

6. The script will next restore the backed up sites to the target Site Collection. The UCC sites to restore to must first be created however!

7. Your new site is created. Now your UCC service needs a change for the URL in the ucc config to point to the new site.

8. A restart of your UCC service without cache is required to have your UCC's looking to the new SharePoint UCC site(s)