European Sharepoint 2013 Hosting Blog
Articles about European Sharepoint Hosting Service
SharePoint 2013 Hosting – HostForLIFE.eu :: How to Connect SharePoint Online Using PowerShell?
Aug 10th
PowerShell is a powerful Command Line Shell Script mainly used by the administrators, and manages anything in Microsoft products. Each Microsoft product, be it Excel, SQL, Office applications, or SharePoint, has its own set of cmdlets [commands used to run any operation that can be performed using GUI and more than it].
Check the cmdlets that can be used in the SharePoint on-premises in my previous article.
But working with SharePoint online is a bit different. The prerequisites are –
PowerShell v3
.NET Framework
SharePoint Module – which can be downloaded from http://www.microsoft.com/en-us/download/details.aspx?id=35588
Once the module is downloaded, open SharePoint Online Management Shell and run the cmdlet to import the SharePoint online module cmdlets.
Import-Module Microsoft.Online.SharePoint.PowerShell -DisableNameChecking;
Or the SharePoint Online Management Shell can be installed directly using the link – https://www.microsoft.com/en-in/download/details.aspx?id=35588
Connect-SPOService -Url https://xyz.sharepoint.com -Credential [email protected]
Note
The connecting site should be a tenant administrator site and the user should have tenant administrator access. The session will be active as an internal variable.
To clear out the service, run Disconnect-SPOService cmdlet which will clear the connected session.
For code reusability, it is better to create a function to connect with SharePoint Online adminstrator site.
|
1 2 3 4 5 6 7 8 9 10 11 |
function ConnectSPOnlineSite() { param ( $adminSite = "https://xyz.sharepoint.com" ) if ((Get-Module Microsoft.Online.SharePoint.PowerShell).Count -eq 0) { Import-Module Microsoft.Online.SharePoint.PowerShell -DisableNameChecking } $cred = Get-Credential $admin Connect-SPOService -Url $adminSite -Credential $cred } |
There is a small change in the cmdlets of SharePoint On-premises and SharePoint Online. In “noun-verb” part of PowerShell cmdlets, the verb has prefixed Get-SPO****.
Example
Get-SPOSite- gets the site collection of particular URL/identity,
Get-SPOSiteGroup- returns all site groups of one or more site collection,
Get-SPOTenant – gets SharePoint online organization properties.
Most of the cmdlets are available till site collection level not till the site level [SPweb level as compared to SharePoint on premises ].
SharePoint 2013 Hosting – HostForLIFE.eu :: REST Calls With SPHttpClient Class In SPFx Webparts
Aug 2nd
Let us look at the usage of sphttpclient in SPFx solutions for making REST calls. To access the required information on SharePoint sites, traditional REST API calls are made previously with JavaScript or jQuery. In the SharePoint Framework solutions, there is an option of making calls using predefined classes. These are the base communication layer used in the SPFx solutions for accessing SharePoint data.
SPHttpClient Class
HttpClient is the class which has basic features to perform REST calls. It can be used to perform REST calls for non-SharePoint services.
SPHttpClient is a subclass which inherits the functionalities from HttpClient, and is used to perform REST calls for SharePoint specific services. This will have default headers and digest information required for get or post calls.
SPHttpClient has the methods and properties. The methods are beginBatch, fetch, get, post, and getWebUrlFromRequestUrl.
Let us focus on retrieving the SharePoint list information using SPHttpClient class. Make sure the latest web part generator packages are available on the environment, before you start creating the SPFx project.
For getting the information, get method is used. This indirectly calls the fetch method. The fetch method will have the same functionalities same as get method. The required parameters are,
- URL (string)
- Configurations (SPHttpClientConfiguration) – Used to set the default headers and version numbers. There is only one value available at this stage (v1).
- Options (ISPHttpClientOptions) – optional parameter, for setting the web URL explicitly.
The get method is triggered using the context with the help of SPHttpClient. URL and configurations are passed as parameters. The URL can be constructed with the help of context available on the component.
The response will be in the type SPHttpClientResponse. JSON data will then be extracted from the response using the methods available.
The required packages to be imported on the webpart file.
|
1 |
import { SPHttpClient, SPHttpClientResponse, SPHttpClientConfiguration } from [email protected]/sp-http'; |
The below code snippet shows retrieval of SharePoint list items.
|
1 2 3 4 5 6 7 |
this.context.spHttpClient.get(`${this.context.pageContext.web.absoluteUrl}/_api/lists/GetByTitle('TestList')/items`, SPHttpClient.configurations.v1) .then((response: SPHttpClientResponse) => { response.json().then((responseJSON: any) => { console.log(responseJSON); }); }); |
Note
“this.context” is used to get the context on the web part TypeScript file. Alternatively, this can be changed in other framework component files.
SharePoint 2013 Hosting – HostForLIFE.eu :: How to Create Result Source In SharePoint 2013 Search Using PowerShell?
Jul 27th
This blog post describes how to create a search result source using PowerShell in SharePoint 2013. I have a requirement to add additional search rules which will be used with the keywords entered by the user in the search box, then you will need to create custom search result source. The query will be,
|
1 |
{searchTerms} Author={User.Name} FileType=pdf FileType=docx |
Source Code
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
Add-PSSnapin Microsoft.SharePoint.PowerShell $SearchServiceApp = Get-SPEnterpriseSearchServiceApplication $fedmanager = New-Object Microsoft.Office.Server.Search.Administration.Query.FederationManager($SearchServiceApp) $searchOwner = Get-SPEnterpriseSearchOwner -Level Ssa $resultSourceName = "Search" $urlTemplate = "http://yoursharepointsitename/search?q={searchTerms}&format=rss&Market=en-Us" $qT = "{searchTerms}" $ResultSource = $fedmanager.GetSourceByName($resultSourceName, $searchOwner) if(!$ResultSource){ Write-Host "Result source does not exist. Creating." $ResultSource = $fedmanager.CreateSource($searchOwner) } else { Write-Host "Using existing result source." } $ResultSource.Name =$resultSourceName $ResultSource.ProviderId = $fedmanager.ListProviders()['OpenSearch Provider'].Id $ResultSource.ConnectionUrlTemplate = $urlTemplate $ResultSource.CreateQueryTransform($queryProperties,$qT) $ResultSource.Commit() |
SharePoint 2013 Italy Hosting – HostForLIFE.eu :: Setting Up the Development Environment For SharePoint Framework
Jul 20th
SharePoint Framework (SPFx) is a page and Web part model, which provides full support for client-side SharePoint development, easy integration with SharePoint data and support for open source tooling. With SharePoint Framework, you can use modern Web technologies and tools in your preferred development environment to build productive experiences and apps, which are responsive and mobile-ready from day one. SharePoint Framework works for SharePoint On-Premises and SharePoint Online. For more details, refer Overview of the SharePoint Framework.
Install Dev Tools
Node.js
Node.js is a JavaScript runtime built on Chrome’s V8 JavaScript engine. Node.js uses an event-driven, non-blocking I/O model, which makes it lightweight and efficient. Node.js’ package ecosystem, npm, is the largest ecosystem of open source libraries in the world.
NPM
Node Package Manager (npm) is used to install the packages, which you want to use and provide a useful interface to work with them.
Install Node.js and NPM
Visual Studio Code
Install VS Code
Install Yeoman and Gulp
Yeoman helps you to kick start new projects, prescribing best practices and tools to help you stay productive.
Use the console command given below to install Yeoman and Gulp.
npm i -g yo gulp
Install Yeoman SharePoint Generator
Yeoman SharePoint Web Part generator allows you to quickly create a SharePoint client-side solution projects with the right tool chain and the project structure.
Use the console command given below to install SharePoint generator:
|
1 |
npm i -g @microsoft/generator-sharepoint@latest |
SharePoint 2013 Hosting – HostForLIFE.eu : SharePoint REST API – CAML Query
Jul 13th
Last week I was working with SharePoint rest API. In some terms, I needed to do some complicated query in a SP list. To do these queries I prefer CAML. But to use CAML with SharePoint rest API, I have been banging my head against the wall for a couple of days as I was stacked with errors. At last I got the solution I wanted.
Using the code
So, what I missed, is the first condition of using CAML with rest request. That is, it always has to be a POST request. The request header is as same as the other normal post request for SharePoint Rest API.
|
1 2 3 4 5 |
headers: { "X-RequestDigest": $("#__REQUESTDIGEST").val(), 'content-type': 'application/json;odata=verbose', 'accept': 'application/json;odata=verbose' } |
The REST endpoint for using caml query is
|
1 |
/_api/web/lists/GetByTitle('<List Name>')/GetItems |
The complete code with the rest call is given bellow:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
// Include JQuery reference // ... script continues ... /// List Name and CAML Query as Parameter function restCallwithCaml(listName, caml) { /// get the site url var siteUrl = _spPageContextInfo.siteAbsoluteUrl; /// set request data var data = { "query" :{"__metadata": { "type": "SP.CamlQuery" }, "ViewXml": caml}}; /// make an ajax call $.ajax({ url: siteUrl+"/_api/web/lists/GetByTitle('"+ listName +"')/GetItems", method: "POST", data: data, headers: { "X-RequestDigest": $("#__REQUESTDIGEST").val(), 'content-type': 'application/json;odata=verbose', 'accept': 'application/json;odata=verbose' } success: function (response) { ///do your code }, error: function (data) { ///do your code } }); } |
The CAML Query has to be used in between this <View><Query>…CAML Query…</Query></View> tag. The query with the way to call the function is given below:
|
1 2 |
var caml = “<View><Query><Where><Eq><FieldRef Name='EndDate'/><Value Type='DateTime'><Today /></Value></Eq></Where></View></Query>”; restCallwithCaml(<listName>, caml); |
Points of Interest
The CAML query can also be used in query string of the rest request. But it makes the URL unnecessarily complicated. If anyone knows of any better approach, please let me know in the comments below and I will update my article.
SharePoint 2013 Hosting – HostForLIFE.eu :: The Generic REST Library CRUD Operation in SharePoint
Jul 6th
For one of my clients, I was working on developing custom forms to interact with SharePoint lists and document libraries.
In that project, there were so many forms to be developed. So, I decided to develop one generic library that can be reused to perform operations using REST API.
The aim of this library is to create a generic set of methods as well, keeping one thing in mind that it should be enhanced easily to include more features.
In this library, there are a total 4of four files.
ListManager.js
This file is used to specify list columns we are working with.
ListUtility.js
This file contains all generic methods.
Main.js
Use this file to write application logic. This will be the main file referenced in our page, the rest of the files are loaded from Main.js itself.
Utility.js
It can be used to specify constants as well as utility methods.
I have also provided detailed information and instructions in attached zip file.
