SCUtils Survey Lite Trial Installation Guide Solution for Microsoft System Center 2012 Service Manager Published: 14 th September 2015 Version: 1.9 Authors: Marat Kuanyshev Feedback: support@scutils.com
Content Getting Started... 3 Installation the management packs... 4 Installation the web part... 5 Configuring the web part... 15 Using survey... 16 Localizing the survey page... 17 Updating the web part SCutilsSurveyLiteWp... 20 Deleting the web part SCutilsSurveyLiteWp... 20
Getting Started SCUtils Survey Lite is a solution for Microsoft System Center Service Manager 2012. This solution provides end users with an ability to give a feedback for the closed incidents and service requests. The survey includes two questions: a required general mark (from 1 to 5) and an optional text field to enter a comment. The solution consists of a web part for SharePoint 2010 platform (SharePoint Foundation 2010 or SharePoint Server 2010) and three management packs that define needed classes for data and the data warehouse and SQL analysis services. The trial version of SCUtils Survey Lite has no limitations for the functionality during first 7 days of the use. When the trial period is expired, the users start to see a notification message on the web page on the SharePoint site. The solution package includes four files: 1. SCutils.Survey.Lite.MP.mp 2. SCutils.Survey.Lite.MPDW.mp 3. SCutils.Survey.Lite.Cube.mp 4. SCutilsSurveyLite.wsp Download the SCUtils SurveyLiteTrial.msi from Download section of www.scutils.com. Copy the installer package file SCUtils SurveyLiteTrial.msi on the server that serves as the Service Manager self-service portal. IMPORTANT! Install Service Manager 2012 console on the Self-Service Portal server this is REQUIRED for the correct work of the web part. Run SCUtils SurveyLiteTrial.msi. By default, wsp package is installed into C:\Program Files\SCUtils\SCUtils SurveyLiteTrial folder. You can change the path during the installtion. 3
Fig. 1 Installation path After the successful installation, the installation folder will be opened automatically. Fig. 2 Installation folder Installation the management packs To install the management packs: 4
1. Log on to the computer that hosts the Service Manager console using an account that is a member of the Service Manager Administrators group. 2. In the Service Manager console, select Administration. 3. In the Administration pane, select Management Packs. 4. In the Tasks pane, under Management Packs, click Import. 5. In the Select Management Packs to Import box, point to the location where the solution files are stored. 6. To the right of the File name box, select the file type MP files (*.mp). 7. In the list of files, select the management packs (SCutils.Survey.Lite.MP.mp, SCutils.Survey.Lite.MPDW.mp, SCutils.Survey.Lite.Cube.mp), and then click Open. 8. In the window Import Management Packs click Import. Installation the web part ATTENTION! The System Center 2012 Service Manager console must be installed on the Self-Service Portal server this is REQUIRED for the correct work of the web part. To install the web part: 9. Log on to the computer that hosts the Self-Service Portal using Operations System Account. 10. Run SharePoint 2010 Management Shell as administrator (Fig. 3). Fig. 3 Run SharePoint 2010 Management Shell 11. At the Management Shell, type the following command, where <SolutionPath> is the full path to SCutilsSurveyLite.wsp, and then press ENTER: 5
Add-SPSolution -LiteralPath <SolutionPath> -verbose If you install in default folder the command is: Add-SPSolution -LiteralPath C:\Program Files\SCUtils\SCUtils SurveyLiteTrial\SCUtilsSurveyLiteTrial.wsp -verbose 12. Then go to SharePoint 2010 Central Administration. Click Start -> All Programs -> Microsoft SharePoint 2010 Products -> SharePoint 2010 Central Administration (Fig. 4) Fig. 4 SharePoint 2010 Central Administration 13. Click on the System Settings (Fig. 5) 6
Fig. 5 System Settings 14. Next click on Manage farm solutions (Fig. 6) Fig. 6 Manage farm solution 15. Click on scutilssurveylitetrial.wsp. 16. On the page Solution Properties click on Deploy Solution. 17. In the drop down list Choose a Web application to deploy this solution select the address of the portal (Fig. 7). Fig. 7 Deploying the solution on the self-service portal 7
18. Click ОК. 19. Go to the portal and in the menu Site Actions select Site Settings (Fig. 8) Fig. 8 Select Site Settings 20. In the Galleries section, click on Web parts (Fig. 9) Fig. 9 Select Web parts 21. Select the tab Documents (Fig. 10) 8
Fig. 10 Setting up a web part on the portal 22. Click on the New Document. 23. In the opened window, check SCUtilsSurveyLiteTrial.SCutilsSurveyLiteTrialWp.SCutilsSurveyLiteTrialWp (Fig. 11) Fig. 11 Setting up a web part on the portal 24. Click on Populate Gallery at the top of the page (Fig. 12). Fig. 12 Setting up a web part on the portal 25. The web part appears in the library (Fig. 13). 9
Fig. 13 Setting up a web part on the portal 26. Modify the properties of the web part for convenience. Click on the Edit icon (Fig. 14). Fig. 14 Setting up a web part on the portal 27. In the section Group select Specify your own value then type Custom (Fig. 15). 10
Fig. 15 Setting up a web part on the portal 28. Click on Save. 29. Go to Service Manager Self-Service Portal page. 30. Select Page tab then select View all pages (Fig. 16) Fig. 16 Creating new page 31. Click on Add new page (Fig. 17). 11
Fig. 17 Creating new page 32. In the New Page window type the new page name Survey (Fig. 18). Click on Create. Fig. 18 New page name 33. On the top of the page select Insert tab (Fig. 19). 12
Fig. 19 Modifying a new page 34. Click on Web Part (Fig. 20) Fig. 20 Inserting a new web part 35. In the section Categories select Custom, then in the section Web Parts select SCutilsSurveyLiteTrialWp (Fig. 21). 13
Fig. 21 Inserting a new web part 36. Click the Add button (Fig. 22) Fig. 22 Inserting a new web part 37. Close all Warning message if any. Save your changes using Save & Close icon and then the following message has to appear (Fig. 23). Fig. 23 Saved web part 14
That means that the installation was successful. Next step is configuring the web part. Configuring the web part 38. To configure the web part on the page click on Edit Web Part (Fig. 24) Fig. 24 Edit the web part 39. On the right pane in Advanced make sure that Allow Minimize is unchecked (Fig. 25). Fig. 25 Customize the web part on the page 40. In the area named Service Manager Connection Settings check Check to setup the settings. Then type the proper values (Fig. 26), where: Service Manager Server Name - the name of Service Manager Management Server; Domain the domain name for the account that has administrative rights in Service Manager; User Name the user name of the account that has administrative rights in Service Manager; Password the password for the account that has administrative rights in Service Manager. 15
Fig. 26 Service Manager Connection Settings 41. Save the change by clicking on OK (Fig. 27) Fig. 27 Save the change 42. Pay your attention to the survey page URL. Copy or memorize it. Using survey After the initial setup the survey page is located on the Service Manager self-service portal and not presented in the quick links menu on the left side of the portal. The direct survey link consists of the permanent part, the survey URL noticed in p.42, plus a string?workitemid= and the changeable part equals to the work item ID. The final URL should look similar to: https://ssp/smportal/sitepages/survey.aspx?workitemid=ir6 Now the survey page available by the direct link is editable only for affected user and only for the closed work items. 16
To provide the user with the direct link configure an incident or a service request workflow with e-mail template. The e-mail template has to be in HTML format and consist of the direct link. The email template could be similar to the one presented in Fig. 28. Fig. 28 Sample of e-mail template Localizing the survey page To localize the text strings (Language Pack for SharePoint must be already installed and set up) edit files located usually at the following path: C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\Resources\SurveyResourcesTrial File SurveyResources.resx consists the localized phrases for default language English. File SurveyResources.ru-RU.resx consists the localized phrases for second language Russian. 43. To add the support for additional languages create a copy of any out of resx files and name it using the following pattern SurveyResources.ZZ-ZZ.resx, where ZZ-ZZ is the culture code in.net. Table 1 consists the list of Culture Codes supported by Service Manager 2012. Table 1 Culture Codes Locale LCID Culture Code English 0x409 en-us 17
Locale LCID Culture Code Chinese_PRC 0x804 zh-cn Chinese Taiwan 0x404 zh-tw Czech (Czech Republic) 0x405 cs-cz Danish (Denmark) 0x406 da-dk Dutch (Netherlands) 0x413 nl-nl Finnish (Finland) 0x40B fi-fi French 0x40C fr-fr German Standard 0x407 de-de Greek (Greece) 0x408 el-gr Italian Standard 0x410 it-it Japanese 0x411 jp-jp Korean 0x412 ko-ko Norwegian (Bokmål, Norway) 0x414 nb-no Polish (Poland) 0x415 pl-pl Portuguese (Brazil) 0x816 pt-pt Portuguese (Brazil) 0x416 pt-br Russian 0x419 ru-ru Spanish_Modern_Sort 0xC0A es-es Swedish (Sweden) 0x41D sv-se Turkish (Turkey) 0x41F tr-tr For instance, for German language the file name is SurveyResources.de-DE.resx. 44. Then open the created file in any text editor, e.g. in Notepad, using an account with administrative rights (Fig. 29). Fig. 29 Opening the resource file 45. In the opened xml document edit the text in the tag <value> for required names (Fig. 30): 18
Fig. 30 Localizing the resource file. 46. Save the changes. 47. To restart the IIS run Command Prompt as administrator (Fig. 31): Fig. 31 Running Command Prompt 48. In the opened console type iisreset (Fig. 32): 19
Fig. 32 Restarting IIS 49. Press Enter. Updating the web part SCutilsSurveyLiteWp 50. To update the web part (in the case of release of new versions) repeat steps described in paragraphs 9 and 10. Then run SharePoint 2010 Management Shell console as administrator. In the console type the following command: Update-SPSolution -Identity <SolutionFile> -LiteralPath <SolutionPath> -GACDeployment - verbose Where: SolutionFile name of the file with wsp extension; SolutionPath path where the file is located. For example, the command could be like Update-SPSolution -Identity SCutilsSurveyLiteTrial.wsp - LiteralPath C:\Program Files\SCUtils\SCUtils SurveyLiteTrial\SCUtilsSurveyLiteTrial.wsp - GACDeployment -verbose 51. Press Enter. Deleting the web part SCutilsSurveyLiteWp 52. To remove the web part run SharePoint 2010 Management Shell console as administrator. In the console type the following command: Remove-SPSolution -Identity SCUtilsSurveyLiteTrial.wsp 53. Press Enter. 20