FAQ List with nice User Interface in SharePoint Online

I got the request to create a nice FAQ in SharePoint Online. The user interface should not be a simple list but should be fancy or modern. Additionally, the content should be in two languages, English and German.

So, what would be a simple approach for the solution? The content itself would be a custom list in SharePoint Online, where we have a choice field for the languages. For the answers we use a Note field with FullHtml style.

To display the contents of the list, we use some html, CSS and JavaScript in a Content Editor Webpart. In the JavaScript we query the list by language and build up some html that is added using jQuery. Finally, the added html gets a click function injected to show or hide the answer.

The html and JavaScript will look like this:

To create the structure for our solution, we are using just some PowerShell (with the SharePoint PnP extensions):

The final solution will look like this for the end user:

The complete code for this sample could be found in GitHub:

https://github.com/OlafD/Simple-FAQ-in-SharePoint

Advertisements

Prepare Deployment of Azure Web Jobs reloaded

A few years ago, I wrote already an article about creating the zip-file for the Azure Web Job deployment directly in Visual Studio. You can find the article here.

It seems, there is a limit of 50 MB for the zip-file, when you upload the file in the Azure Portal. Now I had the problem for a little more complex timerjob that this file size was exceeded. When we have a look into the bin/release folder, we see some files that are not needed to run the exe-file. So, I made a little modification to the PowerShell script to exclude these files. The new script file looks like this:

Reorder Content Type Fields with PowerShell

When the business is working with a solution, build in SharePoint Online, they often have new requirements. One of these requiremtens most time is, to add new fields to a list or content type. Because we have the SharePoint PnP extensions, the task for adding a new field could easily be solved with the Add-PnPField cmdlet. But…

… often the user wants to have a new field in a special position within the list or content type. This could also be solved using PowerShell, but we need some CSOM code for the solution. The field order is part of the FieldLinks collection of the content type. Most of the time, we have already a field in the content type that could be used as the anchor, after which we want to place the new file. So, first, we need the position of our already existing field (the new field should already be created). We get this information with the following script:

With the position of the anchor field, we can use the following script to move our new field to the desired position in the content type. That could be done with the following script:

When we put this together, we can use the following script to do the move during a provisioning process:

If necessary, and this often makes sense, we can put all these scripts together and use the functions directly in one script.

Why should I use PowerShell to define my SharePoint site structure?

SharePoint is really a great tool. We can easily create lists and libraries with all the columns for metadata we need. All just with using the web interface of SharePoint. When we need to create content types to build some more structure for our lists and libraries, we can do it via the web interface, too. And, when I need to do any other setting in my site, do any regional or language setting or activate any additional feature, just do the necessary clicks in the site settings in the web interface. So, why the hell should I use PowerShell or any other automation tool to create the site structure?  

When preparing a simple proof of concept, or a really simple site structure, without any other needs, using the web interface is the right choice, because it is the fastest way to show proper results. But what, when any additional development is needed? What, when we need to implement any HTML and JavaScript (via a Content Editor Webpart)? What, when we need to implement a remote timerjob to do any regular tasks? Or when we need an additional web application that needs to work with the data stored in our SharePoint site? In these cases, it is necessary that we have object names and object id’s, we can rely on, because our development must work in our development environment and in any other stage (integration, test, production, …). To be sure, we have always the same object id’s and object names, we need to automate the creation of the site structure. And that is, where PowerShell (best with the PnP extensions) will be our best friend. Especially with the PnP Extensions, it is very easy to create columns (and site columns), content types and also lists and libraries. Creating views is not the strength of the PnP extensions, but with PowerShell we also can use any function available of the SharePoint Client Side Object Model (CSOM). And because we need to script the creation of the objects (or artefacts) in our SharePoint site, we have full control about the id’s for fields or content types and the names (for fields, content types, lists and libraries). So, when it comes to development (eg. timerjobs), we know the names or id’s of all the objects in our site. Especially, when we use id’s, when using these objects, any user can rename an object in the user interface, but our solution will still work properly. 

When we work in iterations (a good practice today), our automation scripts easily can make modifications or extensions to our former development. Because we know the id’s, the internal names of the artefacts and the structure, we can easily reconfigure the site to our needs. 

And, when we at first do not know how we can do something with scripting, because we do not know, where and how a setting is stored, we can first configure in the web interface and then investigate in tools like the SharePoint Client Browser

So, what are the pro’s and con’s for automation with PowerShell? 

Pro 

  • Full control on id’s and internal names 
  • Ability to provide an iterative approach for the solution deployment 
  • Providing additional development is easy, because all objects are well known 
  • The solution is reproduceable in any other environment or tenant 

Con 

  • Scripting means typing in files and for some SharePoint objects that is time consuming 
  • Because it’s so easy, to configure a site structure in the web interface, most customers won’t believe that defining a site structure will cost that time 

My advice from my own practical use and all my former SharePoint projects is, whenever you need to transport your solution from your development environment to any other stage (eg. the environment of your customer), use a PowerShell script to automate the creation of the site structure. Reduce the manual steps for a deployment to a minimum (the same as when we do any other development and need to deploy our solution). When you have developed any other kind of software that works with your SharePoint environment, also use automation to do the deployment.  

And, have in mind, there is another advantage, when using scripts and automation: you can reuse the objects and code you have developed. The strength, when developing today is, to reuse anything we have already done in any other project. Doing this, when defining a site structure via the web interface, is impossible. 

 
 

 
 

PowerShell PnP – Register Custom Action to Content Type

It seems, when registering a custom action with the Add-PnPCustomAction cmdlet, we need to use uppercase characters for the content type ID, as shown in the following example.

I took some time to figure this out, when my tab was not shown in the ribbon.

How does OneDrive for Business synchronize files?

One pager, provided by Microsoft, about the OneDrive for business client. It is using an installed Office application (2016 or newer) to synchronize Office files and it uses the Background Intelligent Transfer Service (BITS) for larger files.

How does OneDrive for Business synchronize files?

Add choice to choice field in SharePoint Online

To add a new choice value to an existing choice field in SharePoint Online, this small PowerShell code snippet could be used. To run the script, a connection to the SharePoint site must be established and the PowerShell PnP Extensions must be available on the computer. Then we can use this simple code (remember to use another fieldname 😉 ).