Qwickr. Administrator Manual

Transcription

1 Qwickr Administrator Manual Transform Data International B.V. Version 1.0 Lage Kanaaldijk 115 Date NA Maastricht Author Bart Kusters Phone +31(0)

2 Table of Contents 1. Introduction Installation Prerequisites Msi of Setup.exe Manual Installation Scripted installation Installing using setup.exe Installing using the.msi Configuration Configuring Result Sources Configuring end-user defaults Logging wickr Administrator Manual Page 2 of 14

3 1. Introduction This document contains installation instructions and configuration steps for Transform Data s Qwickr. wickr Administrator Manual Page 3 of 14

4 2. Installation 2.1. Prerequisites Qwickr requires the following software to be installed: - Microsoft.NET Framework o The offline installed for the.net Framework can be found here: Msi of Setup.exe Qwickr comes with two types of installers, an.msi file and a setup.exe. The.msi file is the actual installer, it is basically a database file use by Windows Installer. It contains all the information, UI, and files required to install the application. The setup.exe is a so called bootstrapper, it doesn t perform the installation, it simple checks if all the pre-requisites (see previous paragraph) are installed and if so, and if everything is okay, it launches msiexec.exe on the.msi file. wickr Administrator Manual Page 4 of 14

5 2.3. Manual Installation The recommended approach to install Qwickr manually, is by double-clicking the setup.exe. Once double-clicked, the following dialog appears: Click Next > to processed to the next page: wickr Administrator Manual Page 5 of 14

6 On this dialog, the Folder to which Qwickr will be installed can be changed by clicking Browse Once satisfied with the target folder, click Next > to processed to the next page: wickr Administrator Manual Page 6 of 14

7 On this page, the SharePoint Host URL of your SharePoint tenant must be entered as well as the Product Key which can be found on the license agreement. Once the fields are completed, click Next > to proceed to the next page: If an installation of Repstor Affinity is found on the computer, this dialog can be used to indicate if the Search from here Repstor Affinity extension should be installed. This extension allows the user to right-click a folder in Repstor Affinity and choose Search from here which brings up Qwickr scoped to the selected folder. If no installation of Repstor Affinity is found, the option to install the extension is unchecked and disabled. Click Next > to proceed to the next page: wickr Administrator Manual Page 7 of 14

8 By now the installer has all the required information, clicking Next > will start the actual installation, once the installer is done, click Close to close the installer. wickr Administrator Manual Page 8 of 14

9 2.4. Scripted installation This paragraph described how to automate / script the installation of Qwickr Installing using setup.exe To install Qwickr using the setup.exe, open a command-prompt or create a batch file containing the following command: "{path to folder containing the installation files}\setup.exe" /v"/qb" /v"edit1={sharepoint Host URL}" /v"edit2={product Key}" Installing using the.msi To install Qwickr using the.msi file, open a command-prompt or create a batch file containing the following command: "{path to folder containing the installation files}\tdi.sharepoint.quicksearch.msi" /qb EDIT1="{SharePoint Host URL}" EDIT2="{Product Key}" wickr Administrator Manual Page 9 of 14

10 3. Configuration 3.1. Configuring Result Sources In SharePoint, so called result sources can be configured to specify a provider to get search results from, and optionally to narrow a search to a subset of those results. In short this means that within SharePoint one can create result sources to narrow search results to business entities like client, dossier, projects, teams, etc. For more information about what result sources are and how to configure them in SharePoint, please see the following links: Understanding result sources for search in SharePoint Server Configure result sources for search in SharePoint Server Qwickr comes with a configuration tool to configure the result sources (also called search scopes), to start configuring, follow the steps below: 1. Go to the installation directory of Qwickr 2. Locate and start the TDI.SharePoint.QuickSearch.Configuration.exe, the following dialog appears: wickr Administrator Manual Page 10 of 14

11 3. Fill in the Username and Password (or app password if using multi-factory authentication) of a tenant admin and fill in the SharePoint URL to your SharePoint tenant, click on Load Search Configuration to load the result sources from your SharePoint search configuration. Once the tool has finished loading the configuration, the dialog should like this: The first column displays the found result sources, please note that the result source called Everything is added always, as this is setup to search your complete SharePoint environment without narrowing search results to certain criteria. The second column lists all the possible refiners, refiners are displayed in Qwickr on the advanced grid as filterable columns, allowing you to refine your search results. The third column lists the possible additional fields that can be added to the advanced grid in Qwickr, note that these columns are not filterable. Select the results sources, refiners and additional properties to include in the configuration. Optionally you could give the result sources a different name, this allows you to change the name the result source is listed in Qwickr. By changing the order numbers, result sources, refiners and additional properties can be re-ordered, allowing you to change the order or appearance in Qwickr. wickr Administrator Manual Page 11 of 14

12 4. When done configuring, click Save to save your configuration. Note: The result source configuration is now saved as a JSON string to the following location in the Windows Registry: [HKEY_CURRENT_USER\Software\TDI\QuickSearch] "SearchScopes"="{this is where you would see the json string containing the configured result sources}" wickr Administrator Manual Page 12 of 14

13 3.2. Configuring end-user defaults When Qwickr need to be installed to many users, some configuration settings can be distributed to their machines. All the settings are stored in the current user registry hive under the following key: [HKEY_CURRENT_USER\Software\TDI\QuickSearch] To create an end-user configuration, follow the steps below: 1. Either install Qwickr on your own machine, a test machine, or a machine dedicated to creating setups and configurations 2. Start Qwickr 3. Open the settings page 4. Change the settings are desired 5. Save the changes 6. Close Qwickr by right-clicking the system tray icon and choosing Exit 7. Open the Windows Registry 8. Locate the key mentioned above 9. Locate the registry value called LicenseKey and delete it 10. Delete any other registry value / settings you don t want to distribute to an end-user s machine 11. Once done, right-click the QuickSearch registry key (in the tree on the left-hand-side) and choose Export 12. Select a location to which the export of the registry key should be stored 13. Use the.reg file in your distribution of choice to distribute the settings to the end-user s machine(s). wickr Administrator Manual Page 13 of 14

14 4. Logging By default, Qwickr is configured to: - Only log errors - Log information to the following file: %TEMP%\TDI.QuickSearch.txt - Have a maximum logfile size of 5 MB - Keep logfiles for a maximum of 7 days - Once a logfile has reached the maximum file size, information is rolled to the next logfile, meaning that if more than 7 logfiles exist, the oldest one is deleted, and all other files are appended with an auto-numbering (001, 002, etc.) Upon desire or if required by a Transform Data support representative one might need to change the log level or other log settings, this can be done in the TDI.SharePoint.QuickSearch.exe.config. Note: Qwickr used Serilog as logging framework, please see this link for more information about Serilog and it configuration options. wickr Administrator Manual Page 14 of 14