CHUVASH.eu

CHunky Universe of Vigourous Astonishing SHarepoint :)

Minimal Download Strategy. Simple

2 Comments Posted by Anatoly Mironov on 2016-04-27

There are many correct ways (1, 2, 3, 4, 5…) of making scripts work with the Minimal Download Strategy Feature (MDS) in SharePoint 2013 and 2016. But to be honest – every time I need it, I get confused. So now it is time to find a simple solution for that.

Who is better at it than the developers of the SharePoint themselves? Look at the MDS code in the built-in Display Templates:

mds-001

Let’s keep it as simple as Item_Default.js, let’s take it as it is and create our own scripts. Here is a skeletton of and MDS-ready script:

function runMyCode() {
	var time = new Date().toISOString();
	console.log('runMyCode', time );
}
runMyCode();
if (typeof(RegisterModuleInit) == 'function') {
	var scriptUrl = '/Style Library/runMyCode.js';
  RegisterModuleInit(scriptUrl, runMyCode);
}

Which boils down to this in pseudocode:

Execute your code
Determine if MDS is enabled
If MDS is enabled
Register your code for execution

That’s it. No more overcomplicating.

Related findings

External scripts (outside SharePoint Site Collection, from CDN) within ScriptBlock of a custom action (like AddJSLink in PnP) work withou any MDS-adjustments. The ScriptBlock adds a script tag to the head of the html document, and it the js reference is added to every AjaxDelta load. I would need more time to find out why. The good news is: it is an argument for using more CDN solutions in SharePoint.

Old stuff

A while ago I wrote two blog posts about MDS. Now I realise they were overcomplicated and the solution required customizations of the master page and 3rd-party scripts.

javascript, sharepoint javascript, mds, Sharepoint, sharepoint 2013

Minimal Display Template

1 Comment Posted by Anatoly Mironov on 2016-04-13

We want to use our own Display Templates on Non-publishing sites – our team sites. Without the Publishing Feature activated you have to create an own javascript file. Here is short and concise instructions how to install it: Display Templates on Non-publishing Sites.

As described on that blog, you can make copy of an existing Item_Default.js and adjust to your needs.

I also asked Elio Struyf and I got the same tip. I did create my starter template. Here I want to share this very minimal javascript based Display Template. The real Minimal Display Template is in the SPCSR github repository: Item_Minimal.js It has been improved by Elio Stuyf himself 🙂

(function () {
  // Config contains variables that are defined in one place
  var config = {
    propertyMappings: { 'Path':null, 'Title':['Title'] }
  };
  var templateUrl;

  var register = function () {
      if ("undefined" !== typeof (Srch) && "undefined" !== typeof (Srch.U) && typeof (Srch.U.registerRenderTemplateByName) === "function") {
              Srch.U.registerRenderTemplateByName(templateUrl, render);
          }
    };
    render = function (ctx) {
      // Display template data
      var cachePreviousTemplateData = ctx.DisplayTemplateData;
        ctx.DisplayTemplateData = {
        'TemplateUrl': templateUrl,
        'TemplateType': 'Item',
        'TargetControlType': ['SearchResults', 'Content Web Parts'],
        'ManagedPropertyMapping': config.propertyMappings
        };
        var cachePreviousItemValuesFunction = ctx.ItemValues;
        ctx.ItemValues = function(slotOrPropName) {
                return Srch.ValueInfo.getCachedCtxItemValue(ctx, slotOrPropName);
        };

      // Retrieve managed property data
      var path = $getItemValue(ctx, 'Path');
      var title = $getItemValue(ctx, 'Title');

      // HTML markup for an item
      var htmlMarkup = String.format( '<div>' +
                        '<a href="{0}" title="{1}">{1}</a>' +
                                        '</div>', path, title);

        // Caching
        ctx.ItemValues = cachePreviousItemValuesFunction;
        ctx.DisplayTemplateData = cachePreviousTemplateData;

        // Return the HTML markup
        return htmlMarkup;
    };

  // Retrieve all the loaded scripts
  var allScripts = document.getElementsByTagName("script");
  // Get the last script file (this is the current DT file)
    var scriptUrl = allScripts[allScripts.length - 1].src;
    if (scriptUrl.indexOf('/_catalogs/') > 0) {
      // Remove the query string 
      if (scriptUrl.indexOf('?') > 0) {
        scriptUrl = scriptUrl.split("?")[0];
      }
      // Insert the site collection token
      templateUrl = '~sitecollection' + scriptUrl.substr(scriptUrl.indexOf('/_catalogs/'))
    // Register the template to load
    register();
      if (typeof (RegisterModuleInit) === "function" && typeof(Srch.U.replaceUrlTokens) === "function") {
          RegisterModuleInit(Srch.U.replaceUrlTokens(templateUrl), register);
      }
  }
})();

Benefits of js approach

If you choose to directly upload and mantain a javascript file you’ll get following benefits:

You can use the same display templates on Non-publishing sites and they work directly in SharePoint Foundation
You’ll get intellisense
You can run static code analysis agains your javascript code and you can create unit tests
It is more readable understandable from developer to developer
It is easier to follow best practices for javascript
It encourages reusing javascript components for Display Templates, CSR (JSLink) Templates.
You like TypeScript? Well, then it is best to skip the “grey” code in html comments.

Findings

You cannot use ‘use strict’ in your js file.

How to create a Display Template

Rename the Item_Minimal.js file to your name, update some properties.

Upload it to _catalogs/masterpage/Display Templates/Search/<your-folder>

Use ContentType: Display Template Code

displaytemplate-002

Template Level: Item and Managed Property Mappings displaytemplate-003

Create a new Result Type. Every time you update the Display Template (item properties) you have to update the Result Type.

displaytemplate-001

Moving from Minimal to Better

Of course the minimal display template is not enough. There is a whole lot of things we can do, I prepared some tips (my own “best practices”):

Learn the Search Display Template Syntax: Corey Roth – Useful js for Display Templates
Follow Elio Struyf’s 10 tips for working with Display Templates (except the first one – javascript is better 🙂 )
Prefer JavaScript Display Templates if you are a developer and you want to have a better control
Never update the built-in Display Templates.
Centralize reused parts of Display Templates – utilities, common parts, css. Use a CDN site for that.
Check out the SPCSR github repo, there are many Display Templates that you can use or be inspired from.
Create your own folder in _catalogs/masterpage/Display Template/Search to have all your Display Templates within a site collection.

javascript, sharepoint csr, Display Template, javascript, minimal, Sharepoint

SharePoint Utilities – a promising JavaScript Framework

1 Comment Posted by Anatoly Mironov on 2016-04-07

My colleagues at Bool have developed a new JavaScript framework for SharePoint – sharepoint utilities. It started on our DevDay last year – a whole free day when we could learn new things, try out new techniques or build something that was not even requested from a customer. I was not working on sharepoint utilities, so I almost forgot it until…

I recently re-discovered sharepoint utilities. It is on Github, it is MIT licensed and contributions are welcome. The core of sharepoint utilities (sputils) is a set of wrappers for Search, TermStore, REST that allow you be more productive as a developer.

What I find especially compelling with that it contains some other fundamental stuff that every SharePoint developer needs:

XHR, you only need to use sputils.rest.get or sputils.rest.post to make Ajax requests to SharePoint, no need for jQuery or sprequestexecutor.js
Promise, it contains a minimalist Promise framework – no need for jQuery.Deferred. All calls to SharePoint _api are wrapped in promises. So there is a better way of making calls to SharePoint.
DateTime, it contains some useful functions for working with dates and time.
Functional JavaScript. No need for underscore.js or lodash.js.

To me, XHR and Promises are two important parts that I need in every solution. So instead of linking jQuery and preparing reusable XHR functions for SharePoint, I’d recommend using sharepoint-utilities.

javascript, sharepoint framework, github, javascript, Sharepoint

A tiny tool for User Custom Actions

Leave a comment Posted by Anatoly Mironov on 2016-03-17

hehyuaf

Everybody loves User Custom Actions in SharePoint. That’s the only recommended way of customizing SharePoint. You have heard about it. Unfortunately there is no convinient way of administering them. People have their console applications or powershell scripts to add, update and delete user custom actions. It works but it is hard to open up Visual Studio or PowerShell every time you will try out an idea on a test site.

To overcome this, I have created a tiny little tool, packaged as a bookmarklet for your browser. When you click on it, it will show your existing user custom actions and you can add new user custom actions.

It is an ongoing little project, available on github, contributions are welcome. What’s left is:

Implement Delete operation
Implement Update operation
Improve the UI.

Here is how it looks today:

usercustomaction-001

To use this tool, add a new bookmark in your browser and copy the content of bookmarklet.html as the url.

Resources on that topic:

Creating a bookmarklet for Exporting Web Parts

REST API for User Custom Actions (MSDN)

What it can be used for

It can be used on test sites to try out ideas. But do not use it in Production. On ther other hand, parts of this script can be used in other scenarios, like adding new functionality by site owners directly from the browser, where data is predefined.

How to add a JavaScript code

You can use this boilerplate code to add a UserCustomAction, just put it into the textarea and click “Add new”:


var fileref=document.createElement("script");
fileref.setAttribute.src= "YOUR-SCRIPT";
document.getElementsByTagName("head")[0].appendChild(fileref);

Best practices for User Custom Actions

Add a ScriptBlock instead of ScriptSrc. In that way you can reference javascript and css files outside you site collection – ultimately from a CDN site.

javascript, sharepoint bookmarklet, customaction, javascript, Sharepoint, sharepoint 2013, usercustomaction

Provisioning Google Maps JSLink with SPMeta2

4 Comments Posted by Anatoly Mironov on 2015-12-15

kartta-000

Among PnP Samples there is a solution for using Google Maps. Great solution where where you can pick a point on a map and define a spacial area on the map. Unfortunately it is a sandbox solution. I rewrote it to a code based template with SPMeta2 Framework. Now it can be installed on any site very easily, without needing UserCode Service and a cumbersome process of uploading a wsp package and activating it. The code is very simple, you can see it on github.

kartta-001

Let’s take a look at it. It does not contain a single line of SharePoint Legacy XML. There are following SharePoint artefacts that are getting provisioned:

Two site columns (Location Point and Location Area)
A SharePoint List (Locations) with two additional fields mentioned above
Google Maps code in and CSR in a jslink file
Auxiliary pages for selecting points and areas on the map.

Field Definitions

In SPMeta2 everything is separated in meaningful definitions. First we define our fields. The preferred place in the VS solution is Definitions – IA – Fields.

kartta-002

List Definitions

Then we define our List – Locations. That is also a SPMeta2 Definition. List Definitions reside in Definitions – IA – Lists. We do not add fields in our list definition. The fields are added while “assembling” the model.

kartta-003

ListView Definitions

ListView Definitions are also in the Definitions – IA folder. We inherit from the OOB AllItems view:

kartta-004

Modules (a.k.a. Files)

Resource files like javascript, css, aspx, html and so on are Modules. They are in the “Modules – Implicit” folder. The internal structure is copied to the web folder. The upload of files is easy and is defined in the web model, see next section.

Web Model

Now it is time to pick the definitions and create a model. The most common model is a Web Model. The model is created programmatically and relies on “Add” methods: AddField, AddList and so on:

kartta-005

Provisioning

The actual provisioning is the most fun, it is easy and straight forward, it takes models and deploys it to a SharePoint site. You can easily switch between SSOM and CSOM.

kartta-006

Distribution

Another bonus of SPMeta2 Provisioning Framework is the ability to serialize and deserialize models to XML or JSON. In our project we define SharePoint Applications as SPMeta2 models serialized in XML and make them available for installation on any SharePoint Site. A SharePoint Application is a meaningful collection of SharePoint artefacts that becomes an entity and solves a business need.

Summary

This Maps solution is a simple solution, but it is a very powerful one, originally created by the PnP team. If we just redesign the Provisioning Part, it becomes awesome. SPMeta2 provides a solid, well defined, easy-to-understand framework for define code-first models for SharePoint Applications.

sharepoint EF, google maps, jslink, Sharepoint, spmeta2

Setting up Raspberry Pi2 for a Dashboard Monitor

1 Comment Posted by Anatoly Mironov on 2015-12-14

I have set up Raspberry Pi as a Dashboard Monitor a couple of times. Here I want to summarize my steps. In fact, it is nothing special, a raspberry pi that is used as a browser showing a web based dashboard in full screen, but there are some important configuration steps needed to make it as good as possible.

Install Raspbian

Raspbian is the best operating system for Raspberry Pi. Just stick with that.

Expand file storage

When you boot up Raspberry Pi, the first thing you should do is to expand the file storage, otherwise it is hard to install anything. To do so, run raspi-config from command line and restart your raspberry pi after that.

dashboard-rasp-002

Rename your raspberry

You are advised to change the password. In my case I usually just want to keep the default password: “raspberry”. What I want is to change the hostname from raspberrypi to some unique hostname (in my example it will be “kallerasp”), so that I can access it from my network without running risk for name conflicts. To rename your raspberry, update the /etc/hostname file:

sudo vim /etc/hostname

After that restart your computer.

Install iceweasel

Iceweasel is a Firefox fork, which works just fine on the raspberry pi. Update your raspberry pi and install it:

sudo apt-get update
sudo apt-get upgrade -y
sudo apt-get install -y iceweasel

Make sure the screen is not getting blank

To use your raspberry pi as a dashboard monitor we need to prevent the screen from getting blank (dark).

cd /etc/lightdm
sudo cp lightdm.conf lightdm.conf.bak
sudo vim lightdm.conf

Update it so you have the following:

[SetDefaults]
xserver-command=X -s 0 -dpms

dashboard-rasp-001

Start dashboard page on startup

To automatically start iceweasel on startup, we need to configure autostart. To do so, run this from terminal:

cd ~/.config
mkdir autostart
cd autostart
vim .desktop

In the .desktop file write following:

[Desktop Entry]
Type=Application
Exec=iceweasel

Previously I had chromium-browser –kiosk http://someurl, but Chromiums is no longer available, and iceweasel does not have –kiosk parameter. On the other hand, you have to activate Full Screen the first time, then after OS restart iceweasel automatically will activate Full Screen and your dashboard page from the previous session.

Uncategorized bash, browser, dashboard, iceweasel, linux, raspberrypi

Chuvash Keyboard Layout for Mac

Leave a comment Posted by Anatoly Mironov on 2015-12-13

I’ve got a Mac and one of my first questions was: How can I write in Chuvash on my Mac, obviously 🙂 In this post I am going to tell how I created Chuvash Keyboard Layout. The solution and installation instructions are on Github:

Chuvash Keyboard Layout for Mac

cv-kbd-mac-000

What the heck is Chuvash?

For those who don’t know yet: Chuvash are people who live in Chuvash Republic in Russian Federation, and abroad, as me. We are 1.5 million. Chuvash is also a language, an official language of the Republic, a minority language, that is completely different from the second official language Russian. Chuvash uses Cyrillic letters, all 33 Russian letters plus 4 additional letters: A breve (Ӑ), E breve (Ӗ), C cedilla (Ҫ) and U with double acute (Ӳ).

Keyboard Layout

There is no official Chuvash keyboard layout. What we have is a de facto standard – a very humble layout. It is “humble” because it does not dare to put Chuvash letters on the buttons directly, they are accessible through modifiers: AltGr in Windows and Linux, Option on a Mac. To get A breve you press AltGr and A in the same time. That is not a good input method for Chuvash where additional letters with diacritics (breve, double acute and cedilla) are more common than some Russian letters. In fact, many Russian letters are just part of the Chuvash alphabet because the loan words are just imported in the original spelling.

The reason why this humble keyboard layout was introduced and became a de facto standard was a will to provide a fully functional Russian keyboard layout with a bonus – being able to write in Chuvash, although a hard way. It is hard to write, but it is very simple to have (you don’t need to switch input sources), it is easy to explain: want a diacritic, just press AltGr and the corresponding plain letter. I created the same layout for Mac, too. In future a better, more Chuvash, keyboard layout must be designed and agreed upon.

Keyboard Layouts on Mac

AFAIK, there is no keyboard layout (“input source”) for any minority language in Russia. On the other hand the process of creating and installing a custom keyboard layout is easiest on a Mac. I followed the steps described on Salvatore Testa’s blog: I installed Ukulele and created a new keyboard layout based on Russian PC. That bundle that is saved from Ukulele needs to be copied to ~/Library/Keyboard Layouts/ folder. Then (presumably after a computer restart), Chuvash can be added as an input source. Custom keyboard layouts are just files (bundles) in a user’s home folder. No need for Administrator rights (as in Windows for installing a custom keyboard layout as an exe file), no sudo access to X11 folder (as in Linux).

What I would like to wish is the presence of Chuvash and other minority languages’ keyboard layouts directly Out-of-the-Box on Mac OS, iOS, Android and Windows. Linux is the only OS family that natively supports Chuvash keyboard layout.

Other minority languages

I am just curious: what languages have already had custom keyboard layouts ready for install. I found those ones:

Some words in Chuvash and Russian

I want this text to be searchable and findable, so here come summary of this blog post in Chuvash and Russian.

Макинтош валли чӑваш сарӑмӗ

Чӑваш сарӑмӗ Линукс, Виндовс, татат Андроид оператив системисенче пуррине халӑх пӗлет-ҫкӗ. Паян эпӗ Маккинтош (Mac OS) валли чӑваш сарӑмне турӑм. Вӑл виндовсри тата линуксри пекех, мӑйракаллисене ҫырас тесен Option (Alt) пускӑчне пусса мӑйракасӑррине пӗрле пусмалла. Option + А – Ӑ пулать. Ку ҫӗнни мар. Сарӑмӗ тата мӗнле лартмалли ку вырӑнта тупӑнать (хальлӗх акӑлчанла, анчах вӗҫ ӑнлантарнине ӳкерчӗклентертӗм).

Чувашская раскладка на Макинтош

Теперь есть чувашская раскладка для Mac OS, она такая же как и на Виндовс и Линукс. Чтобы написать Ӑ нужно нажать на Option (Alt) и на букву А. Раскладку и инструкцию по установке можно найти на этой странице (инструкция на английском пока, но все шаги проиллюстрированы картинками).

Working with Ukulele

I won’t go into details about how to work with Ukulele. But I was very surprised how easy it was to update the keyboard layout.

cv-kbd-mac-006

And more surprised I became when I saw that Chuvash was present in the list of available languages. cv-kbd-mac-007

Just to compare, Chuvash exists as a language in many systems in the Open Source world and close to it: Linux, Firefox, Wikipedia… For Microsoft Chuvash does not exist. No LCID, no locale, no way of referencing cv and cv-RU. There is one exception – Skype, but it was added before Skype was bought by Microsoft. I really hope it can be changed in future.

cv-kbd-mac-008

The last step was to rename to Chuvash – PC and generate an ID within the range for Cyrillic keyboards.

Microsoft again (update 2015-12-14)

After I installed my Chuvash keyboard layout and I was glad, suddenly I could not open Word, it just crashed. I didn’t realize that it was due my custom keyboard layout. How painful, that Microsoft products crash on a custom keyboard layout. Sigh.

Chuvash Latin Script (update 2016-02-06)

I found that ABC Extended Keyboard Layout on Mac lets me write in Chuvash Latin Script using following dead keys:

Option b = Breve (ă, ĕ and maybe ĭ)
Option u = Diaeresis (ü)
Option c = Cedilla (ş)
Option v = Caron (š)

Other turkic languages

ı: Option+w and then i
ə: Shift+Option+: and then a

Chuvash, Uncategorized Chuvash, kbd, keyboard, keyboard layout, mac, osx, ukulele

My first Office Add-In

Leave a comment Posted by Anatoly Mironov on 2015-11-11

Yesterday I participated in the Hackathon at European SharePoin Conference in Stockholm. The main goal was to learn more about Office Add-Ins. I wanted to create a very very simple app to learn the basics. Here in this post I’ll provide some links and describe the steps needed to start developing your Office Add-Ins.

The Add-in I created is an Outlook Add-In, it is called “Joke Inserter” and with it you can insert a random Chuck Norris joke. It is just for fun, but it demonstrated how an add-in can be installed, made available in “New E-mail” and interact with the e-mail you are writing.

Github Hackathon

All the code is on github. The random jokes come from The Internet Chuck Norris Database. As I said, the jokes were just for fun, this add-in is of course, not a business app. During the hackathon I got help from Pretish Abraham, Jeremy Thake and …

This is the result:

Prerequisites

Any OS, I happened to have Windows 🙂
git, nodejs, npm (they should be in the $env:PATH)

Install following npm packages globally:

npm install -g tsd yeoman generator-office gulp

Creating the Add-In

Now with the yeoman support it is very easy:

Create a folder and scaffold an app:

mkdir joke-inserter
cd-joke-inserter
yo office

After that update the manifest file: Icon Url, and Support Url

Start the application on localhost:

gulp serve-static

Go to your Outook.office365.com. Click on Manage Apps and add the manifest file from your solution. I uploaded this app on azure: https://kultar.azurewebsites.net/appcompose/home/home.html. You can try this app by installing the manifest file in you Outlook client.

Now when one is done with that simple fun add-in, it is very easy to go ahead and create real add-ins that provide value to you and your colleages.

Resources:

Use yo to scaffold your Office Add-In

sharepoint add-in, app, Apps, office365, sharepoint2013

Working with resx files in Visual Studio

3 Comments Posted by Anatoly Mironov on 2015-11-05

Today I found a nice Visual Studio Extension for working with localization and resx files: Resx Resource Manager. This extension provides an additional view in your project and scans all the resx files. I would recommend it to all projects where you have to translate your interface. Here is how it looks in my project:

It can also assist with some machine translation from Bing and MyMemory:

Another good thing is the Export and Import to and from Excel. Wonderful if you need help from Non-developers.

programming extension, l10n, localization, resx, tips, translation, Visual Studio

Copy SharePoint WebDav Address to Clipboard

Leave a comment Posted by Anatoly Mironov on 2015-11-05

While configuring SharePoint sites and helping users I often use File Explorer View for editing pages, resources like css and javascript. In IE there is a dedicated button in the ribbon for that. Sometimes it works, sometimes it doesn’t, because of permissions or other restrictions. Anyway, I use Firefox and Chrome while troubleshooting and developing, so I have created a bookmarklet for copying the webdav address of a site that is open in the browser.

var uri = _spPageContextInfo.webAbsoluteUrl.replace(/https?:\/\//i, "\\\\").replace(/\//g, "\\");
window.prompt("Copy to clipboard: Ctrl+C, Enter", uri);

Unfortunately, there is no copy function in javascript, the prompt solution plus Ctrl-C works fine.

The bookmarklet:

javascript:void%20function(){var%20o=_spPageContextInfo.webAbsoluteUrl.replace(/https%3F:\/\//i,%22\\\\%22).replace(/\//g,%22\\%22);window.prompt(%22Copy%20to%20clipboard:%20Ctrl+C,%20Enter%22,o)}();

Enjoy

sharepoint bookmarklet, explorer, file, google chrome, javascript, webdav

← Older posts

Newer posts →

	Anatoly Mironov on It is time to standardize the…
	Holger Küsgens on JSGrid Basics
	roshanjv on JSGrid Basics
	Filippo Bertuzzi on Export any web part from a Sha…
	Filippo Bertuzzi on Export any web part from a Sha…
	Ben on Export any web part from a Sha…
	Fred on Export Any Web Part using a…
	Fred on Export any web part from a Sha…
	Jasveer Singh on Publishing Visio diagrams as h…
	Syed Shoaib Adil on Make javascript code work with…