List Search Web Part Installation Instructions for SharePoint 2013

Transcription

1 List Search Web Part Installatin Instructins fr SharePint 2013 AMREIN ENGINEERING AG Versin 2.0 January 2017

2 Descriptin The List Search Web Part reads the entries frm a Sharepint List r Library and displays the selected fields in a list. The Web Part is cmpatible with WSS 3.0, MOSS 2007,Sharepint 2010, 2013 and The fllwing parameters can be cnfigured: Sharepint List r Library cntaining the data List clumns t be displayed Filtering, Gruping, Searching, Paging and Srting f rws AZ Index ptinal Header text Prerequisites Befre yu attempt t deply the slutin yu need t make sure that yu have the fllwing installed n yur server(s): Micrsft Office SharePint Server 2007 r WSS 3.0 r Micrsft Sharepint 2010 Fundatin r Server r Micrsft Sharepint 2013 r 2016 Installatin Manual Installatin 1. dwnlad and unpack the AEListSearchWebpart.zip file. The ZIP archive cntains the AEListSearchWebpart.dll and the AEListSearch.webpart files. 2. drp the AEListSearchWebpart.dll either int the SPS web applicatin bin directry r int the GAC f yur Sharepint server (c:\windws\assembly). 3. add the fllwing line t the "<SafeCntrls>" sectin f yur Web.Cnfig file. Please make sure that the line is added as ne single line (n line breaks): <SafeCntrl Assembly="AEListSearchWebpart, Versin= , Culture=neutral, PublicKeyTken=41d1fee1c0994dd4" Namespace="AEListSearchWebpart" TypeName="*" Safe="True" /> 4. frm the tp site g t "Site Actins/Site Settings/Mdify All Site Settings/Galleries/Web Parts" 5. use the "Uplad" menu ptin t uplad the AEListSearch.webpart file. Autmatic Installatin Sharepint Unpack the AEListSearchWebpart.wsp and Install.bat files frm the Zip Archive and place the 2 files nt yur Sharepint Server. 2. Add the Slutin by running install2013.bat r by manually entering: stsadm - addslutin -filename AEListSearchWebpart.wsp 3. Deply the slutin by navigating with yur brwser t Central Administratin-> System Settings -> Farm Management -> Manage Farm Slutins :

3 Yu shuld nw see the AEListSearchWebpart.wsp in the farm s slutin stre: Click n AEListSearchWebpart.wsp t deply the slutin: 4. Prceed t activate the feature by navigating t the Site Actins/Site Settings page in yur tp-level site:

4 Chse Site cllectin features t navigate t the Site Cllectin Features page: Activate the AE List Search Web Part feature Adding the Web Part t a Page Navigate t a page where yu wuld like t place the web part and chse "Site Actins/Edit Page" Add the web part t the apprpriate zne. The web part is listed in the "Amrein Engineeering" gallery sectin :

5 Web Part Cnfiguratin Cnfigure the fllwing Web Part prperties in the Web Part Editr "Miscellaneus" pane sectin as needed: Site Name: Enter the name f the site that cntains the Emplyee List: - leave this field empty if the List is in the current site (eg. the Web Part is placed in the same site) - Enter a "/" character if the List is cntained in the tp site - Enter a path if the List in in a subsite f the current site (eg. in the frm f "current site/subsite") List Name: Enter the name f the desired Sharepint List r Library Example: Prject Dcuments View Name: Optinally enter the desired List View f the list specified abve. A List View allws yu t specify specific data filtering and srting. Leave this field empty if yu want t use the List default view. Field Template: Enter the List clumns t be displayed (separated by semiclns). Pictures can be attached (via File Uplad) t the Sharepint List items and displayed using the symblic Picture clumn name. If yu want t allw users t edit their wn entries, please add the symblic Username clumn name t the Field Template. An Edit symbl will then displayed t allw the user t navigate t the crrespnding Edit Frm: Example: Type;Name;Title;Mdified;Mdified By;Created By Friendly Header Names: If yu wuld like t display a friendly header name instead f the default prperty name please append it t the User prperty, separated by the pipe symbl. Example: Picture;LastName Last Name;FirstName;Department; Address Grup By: enter an ptinal List clumn t grup the rws. Srt By: enter the List clumn t define the default srt rder. Example:Department AZ Index Clumn: enter an ptinal List clumn t display the AZ filter in the list header. If an "!" character is appended t the prperty name, the "A" index will be frced when visiting the page. Example: LastName! Search Bx: enter ne r mre List clumns (separated by semiclns) t allw fr interactive searching. Example: LastName;FirstName If yu want t display a search filter as a drpdwn cmb, please enter it with a leading "@" character: LastName;FirstName;Department;@Office Align Search Filters vertically: allws yu t align the seach input bxes vertically t save hrizntal space Rws per page: the Emplyee Directry web part supprts paging and lets yu specify the desired number f rws per page. Image Height: specify the image height in pixels if yu include the "Picture clumn. Enter "0" if yu want t use the default picture size.

6 Header Text: enter an ptinal header text. Please nte that yu can embed HTML tags if needed. Yu can additinally specify the text t be displayed if the "Shw all entries" ptin is unchecked and the users has nt perfrmed a search yet by appending a " " character fllwed by the text. Example: This is the regular header text This text is nly shwn if the user has nt yet perfrmed a search Alternating Rw Clr: enter the ptinal clr f the alternating rw backgrund (leave blank t use default). Enter either the HTML clr names (as eg. "red" etc.) r use hexadecimal RRGGBB cding (as eg. "#CCFFCC"). Enter the values withut the duble qutes. Yu can als change the default backgrund clr f the nn-alternating rws by appending a secnd clr value separated by a semicln. Example: #ffffcc;#ffff99 Shw all entries: either shw all directry entries r nne when first visiting the page. Yu can append a specific text t the "Header Text" field (see abve) which is nly displayed if this ptin is unchecked and n search has yet been perfrmed by the user Exprt t CSV: Shw/hide the "Exprt" buttn fr Excel CSV File Exprt CSV Separatr: Enter the desired CSV field separatr character (Default=Cmma). Use a semicln in cuntries which use the cmmas as a decimal separatr. Lcalizatin: enter the fllwing 4 values (separated by semiclns) in yur lcal language if yu need t verride the English strings crrespnding t the - Search buttn text, - A..Z menu "View all" ptin, - the text displayed when the "WebSite" User Prperty is included in the Template field - and the "Grup By" name: Default: Search;View all;visit Example (German): Suche;Alle;externer Link;Gruppe License Key: enter yur Prduct License Key (as supplied after purchase f the "Emplyee Directry Web Part" license key). Leave this field empty if yu are using the free 30 day evaluatin versin r if yu chse ne f the License Activatin described in the next sectin belw. License Activatin Yu have the fllwing 3 ptins t enter yur License Key: 1. Enter the License Key int the crrespnding License Key field in the web part cnfiguratin pane (See Descriptin abve). 2. WSP Slutin Deplyment: Add the License.txt file (as supplied by AMREIN ENGINEERING after having purchased a license) t the Slutin at the fllwing lcatin: c:\prgram Files\Cmmn Files\Micrsft Shared\Web Server Extensins\14\template\features\AEListSearchWebpart 3. Manual Deplyment: Add the License Key t yur web.cnfig (typically fund at c:\inetpub\wwwrt\wss\virtualdirectries\80) <appsettings> sectin as fllws: <appsettings> <add key="aels" value="aels-x-xxxxx-xxxxx-xx-xx" /> </appsettings> Replace the x characters with yur actual key values. Please nte that this methd requires yu t manually add the key t each Sharepint applicatin.