Configure Surveys to SQL

(SharePoint Online Only) Pre-requisite

• Enable APP permissions

  • This was already executed during the installation of the 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. Creator. If not completed, Learn More

Configure the Surveys to SQL application as scheduled task

1. Grab the site URL (parent site of your ucc) and client secret
   

   Example: http://workstreampeople.sharepoint.com/sites/ucc/ucc_support/uccconfigtemplate (only use bold part)

   Note

   This is also the site for the UCC Creator.

2. Copy the contents of the Survey script to <drive>\program files\anywhere365\scripts\SPO_Survey on the UCC server (may also be another Windows server, make sure the above pre-requisites are met).

   Note

   The survey scrips can be requested at the support-desk.

3. In the config file (Surveys.config), fill in the Targets:

   Same Site = For all sites on the root level:

   Copy

   XML

   <Target enabled="true" type="SameLevel">https://contoso.sharepointonline.com/sites/ucc</Target>

   Site Collection = For all sites in this site collection:

   Copy

   XML

   <Target enabled="true" type="SiteCollection">https://contoso.sharepointonline.com/sites/ucc</Target>

   Site = Only for this site:

   Copy

   XML

   <Target enabled="true" type="Site">https://contoso.sharepointonline.com/sites/ucc</Target>

4. Next step is to configure user authentication.

   1. (SharePoint On-premises) Fill in the Username and Encrypted Password.

      Note

      Use the Password Tool in the install directory to encrypt the password.

      Copy

      XML

      <Username></Username>
      <Password></Password>

   2. (SharePoint Online) Fill in the ClientID and ClientSecret, between the quotes.

      Copy

      XML

      <ClientID></ClientID>
      <ClientSecret></ClientSecret>

      Important

      Find your site collection URL and Client Secret code. If you lost your Client Secret code, you can generate one by following Generate a new client secret for SharePoint Template

5. Create a Windows Scheduled Task that runs indefinitely every 5 minutes (starting from rounded minutes e.g. 12.00, 12.05, 12.10, 12.15) and starts the executable (WSP.A365.SharePoint.WebJob.Survey.exe).

   Or use the example XML below to import it into Task Scheduler:

   Copy

   XML

   <?xml version="1.0" encoding="UTF-16"?>
   <Task version="1.2" xmlns="http://schemas.microsoft.com/windows/2004/02/mit/task">
   <RegistrationInfo>
   <Date>2019-04-16T15:24:40.1269215</Date>
   <Author>Workstreampeople B.V.</Author>
   </RegistrationInfo>
   <Triggers>
   <TimeTrigger>
   <Repetition>
   <Interval>PT5M</Interval>
   <StopAtDurationEnd>false</StopAtDurationEnd>
   </Repetition>
   <StartBoundary>2019-04-16T15:20:00</StartBoundary>
   <Enabled>true</Enabled>
   </TimeTrigger>
   </Triggers>
   <Principals>
   <Principal id="Author">
   <UserId>S-1-5-21-3347327956-105208351-3318644539-10774</UserId>
   <LogonType>Password</LogonType>
   <RunLevel>LeastPrivilege</RunLevel>
   </Principal>
   </Principals>
   <Settings>
   <MultipleInstancesPolicy>Parallel</MultipleInstancesPolicy>
   <DisallowStartIfOnBatteries>false</DisallowStartIfOnBatteries>
   <StopIfGoingOnBatteries>false</StopIfGoingOnBatteries>
   <AllowHardTerminate>true</AllowHardTerminate>
   <StartWhenAvailable>false</StartWhenAvailable>
   <RunOnlyIfNetworkAvailable>false</RunOnlyIfNetworkAvailable>
   <IdleSettings>
   <StopOnIdleEnd>true</StopOnIdleEnd>
   <RestartOnIdle>false</RestartOnIdle>
   </IdleSettings>
   <AllowStartOnDemand>true</AllowStartOnDemand>
   <Enabled>true</Enabled>
   <Hidden>false</Hidden>
   <RunOnlyIfIdle>false</RunOnlyIfIdle>
   <WakeToRun>false</WakeToRun>
   <ExecutionTimeLimit>P3D</ExecutionTimeLimit>
   <Priority>7</Priority>
   </Settings>
   <Actions Context="Author">
   <Exec>
   <Command>"C:\Program Files\Anywhere365\Scripts\SPO_Survey\WSP.A365.SharePoint.WebJob.Survey.exe"</Command>
   </Exec>
   </Actions>
   </Task>

6. Make sure that the account that performs the task has sufficient permissions to run the job, even if it is not logged in. Run with highest privileges.

(Optional) Generate a new client secret

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:Anywhere365 SharePoint UCC Site Creator “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