SharePoint Template Operation basics

A client secret (just as a password or a certificate) expires over time. Before it expires a new client secret must be in place before the current one expires to ensure continued operation of your application. Microsoft recommends to create new secrets a minimum of 30 days before they expire. Learn More - Microsoft

Prerequisites

Make sure the following prerequisites are met

1. User is SharePoint Online global administrators and tenant administrator for the Microsoft 365 tenant

2. Install SharePoint Online Management Shell

   https://www.microsoft.com/en-us/download/details.aspx?id=35588

3. Install PowerShell PowerShellGet

   1. Open PowerShell as administrator

   2. Run:

      Copy

      PowerShell

      Install-Module –Name PowerShellGet –Force
      Update-Module -Name PowerShellGet

4. Install "Microsoft Online Services"

   1. Open PowerShell as administrator

   2. Run:

      Copy

      PowerShell

      Install-Module -Name MSOnline

Generate

Note: Generating a new secret won’t affect to old one, the current Client Secret will be active until it expires

Note: If the client secret is already expired, creating a new app is recommended: UCC Creator - Install Manual “Register SharePoint App (only for SharePoint Online)”

1. Run Powershell as administrator

2. Run the following cmdlets: (Change the client id value to your client id)

   Copy

   PowerShell

   Connect-MsolService
   $clientId = 'clientid'
   $bytes = New-Object Byte[] 32
   $rand = [System.Security.Cryptography.RandomNumberGenerator]::Create()
   $rand.GetBytes($bytes)
   $rand.Dispose()
   $newClientSecret = [System.Convert]::ToBase64String($bytes)
   New-MsolServicePrincipalCredential -AppPrincipalId $clientId -Type Symmetric -Usage Sign -Value $newClientSecret
   New-MsolServicePrincipalCredential -AppPrincipalId $clientId -Type Symmetric -Usage Verify -Value $newClientSecret
   New-MsolServicePrincipalCredential -AppPrincipalId $clientId -Type Password -Usage Verify -Value $newClientSecret
   $newClientSecret

3. Copy outcome and save it

(Optional) Extend expiration date to 3 years

Replace the "New-MsolServicePrincipalCredential” statements from the previous code with:

$dtStart = [System.DateTime]::Now
$dtEnd = $dtStart.AddYears(3)
New-MsolServicePrincipalCredential -AppPrincipalId $clientId -Type Symmetric -Usage Sign -Value $newClientSecret -StartDate $dtStart -EndDate $dtEnd
New-MsolServicePrincipalCredential -AppPrincipalId $clientId -Type Symmetric -Usage Verify -Value $newClientSecret -StartDate $dtStart -EndDate $dtEnd
New-MsolServicePrincipalCredential -AppPrincipalId $clientId -Type Password -Usage Verify -Value $newClientSecret -StartDate $dtStart -EndDate $dtEnd

Once your new Client ID and Secret are created there are several places these may need to be applied.

1. If you expect to, or regularly do add new UCC A Unified Contact Center, or UCC, is a queue of interactions (voice, email, IM, etc.) that are handled by Agents. Each UCC has its own settings, IVR menus and Agents. Agents can belong to one or several UCCs and can have multiple skills (competencies). A UCC can be visualized as a contact center “micro service”. Customers can utilize one UCC (e.g. a global helpdesk), a few UCC’s (e.g. for each department or regional office) or hundreds of UCC’s (e.g. for each bed at a hospital). They are interconnected and can all be managed from one central location. sites (from one of your own local SharePoint administrator Windows machines) to your SharePoint, you will need to use the new Client Secret in the configuration.xml file of your UCC.Creator script to build these sites. Learn More

2. If you want to update your Site Collection and Sites to a newer template version (from one of your own local SharePoint administrator Windows machines) of UCC.Creator, you will need to use the new Client Secret in the configuration.xml file of your UCC.Creator script to update your sites. Learn More

3. If you have running UCC's you will need to change the client secret in a service window to your liking for your UCC servers config.xml file and for each UCC node therein. Learn More. A UCC service restart is not required for this change.

4. If you have Snapper(s) running in your organisation which have been configured for screenrecording and writing the recording to a SharePoint online (Ucc) site then ALL those Snapper configurations will need to be updated with the new Client Secret for ScreenRecording storage location. Learn More

5. If a Dialogue Studio flow connects to a SharePoint online site using Client ID and Client Secret, the Client Secret will need to be replaced in the Dialogue Studio flow. For an example flow Learn More, but other variations exist.