sexta-feira, novembro 21, 2014

SharePoint Hosted App: How to manage DateTimeControl Picker and Format with the correct Language and Culture

This article explains how convert the Raw Date from REST calls and manage Date Format base in different Languages and lcid and how to manipulate the Out of the Box SharePoint Control  DateTimeControl to display the correct Language in the DatePicker with the correct Date Format.  
This is very important when you are creating your App with multiple Languagues and you need to keep integrity of Regional settings bettwen your Hosted site and App Web Site and have to be done in dinamyc approach.

DateFormat SharePoint Hosted App example 

Let's go for steps:
  • Create a Site and define his Language
    • For this example a Site Collection was created base in Language "PT-pt" and Lcid 2070



Create a SharePoint Hosted App call "DateFormat", this solution shows the tips and trick about managing Dateformats, Culture and Languages using out of the box SharePoint controls and Raw dates from SharePoint Data.


Add DateTimeControl in App


Include the SharePoint Web control Markup DateTimeControl in the default.aspx Page.

When the SharePoint Hosted App is installed in the SharePoint Site access the App Web select the calendar Picker,
Since you create your Host site base in Language "PT-pt" and Lcid "2070" you are expecting to get the correct Language, but that don't happen like is shown in the image bellow.

PS:"The control has a LocaleId parameter but i dont include in the Control since the language can change and don't have access to server side code, everything should be made using JS"

If you access to F12 Developer tools you are able to see that the DatePicker control opens a iframe base in Parameters but the most interresting are the values from there, 
  • lcid: 1033
  • Langid:2070 


This is the reason the calendar appear with En-US Language in the calendar and not with PT-pt language, 

To get the correct values from the iframe parameter you can use the Regional Settings of the current Web.

For more information about the parameter see the 3 point "Calendar Options" in the following article, 
Using SharePoint’s DatePicker Control:

You can use REST call fill the needed parameters in the datepicker Iframe request.



Thef following code example call the Regional Settings and replace the parameters that i used in the Calendar picker with the lcid "1033" to correct lcid, for this case "2070":

$.ajax({
      url: getQueryStringParameter("SPAppWebUrl") + "/_api/Web/RegionalSettings",
      method: "GET",
      headers: { "Accept""application/json; odata=verbose" },
      success: function (data) {
          $(".ms-dtinput a").each(function () {
              $(this).attr("onclick", $(this).attr("onclick")
                  .replace(/cal=\d{1,2}/"cal=" + data.d.CalendarType)
                  .replace(/lcid=\d{4}/"lcid=" + data.d.LocaleId)
                  .replace(/ww=\d{7}/"ww=" + ("0000000" + data.d.WorkDays.toString(2)).slice(-7))
                  .replace(/fdow=\d{1}/"fdow=" + data.d.FirstDayOfWeek)
                  .replace(/fwoy=\d{1}/"fwoy=" + data.d.FirstWeekOfYear)
                  .replace(/hj=\d+/"hj=" + data.d.AdjustHijriDays)
                  .replace(/swn=\w+/"swn=" + data.d.ShowWeeks));
          });
      }
  });

After the change is made, access the datepicker and language appears correctly with the Date Format included as shown in image below.

If we access the html associated in the datepicker control, we are able to see the Lcid is different with the correct Regional Setting lcid "2070".


Convert REST/Raw Date to correct Format

After we correct the SharePoint Control DateTimeControl we should start to convert Date to string with the correct Language Format, for this the following example make the convertion of Date to String with the Language associated in the Site.

The following exame make a call to Object Web/Created to return the Date when the Site was created and include in a Text Box with the Date format associated with the Culture.

$.ajax({
        url: getQueryStringParameter("SPAppWebUrl") + "/_api/Web/created",
        method: "GET",
        headers: { "Accept""application/json; odata=verbose" },
        success: function (data) {
            $('#OutputDate').val(new Date(data.d.Created).format(Sys.CultureInfo.CurrentCulture.dateTimeFormat.ShortDatePattern));
        } 
    }); 

for this example the raw output date will be "2014-11-21T09:57:17" and the method "Date(data.d.Created).format(Sys.CultureInfo.CurrentCulture.dateTimeFormat.ShortDatePattern)" converts the Date to the Culture Date Format that is associated in the Server but by default is "1033" as shown bellow image.



To make the correct Date format convertion you need to include the following reference in your App Page, JS reference to SP.DateTimeUtil.js.

This SharePoint Object make the convertion to the correct Lcid for this case "PT-pt"

<SharePoint:ScriptLink Name="SP.DateTimeUtil.js" runat="server" LoadAfterUI="true"   />



Deploy the new version of the App and validate the Date format from the REST call and will be with the correct Date Format in this case for "PT-pt" and "2070".

After this change is made you can make the call to date and make the JS convertion from String to Date using the method "parseLocale"

var date = Date.parseLocale($('#OutputDate').val());

and returns the value as a date without having error of bad Format of Date 


With the correct Date Object you are able to make the necessary changes in your SharePoint Hosted App without incorrect formats and issues in SharePoint controls.
A big thank you to my colleague "Selim Gezgin".

Support Articles:
Using SharePoint’s DatePicker Control:

Hope you like this article,
Kind regards,
André Lage

quinta-feira, outubro 09, 2014

How many Ribbons options can you hide in a minute? How much productive can you be!

I see a lot of article talking the SharePoint ribbon manipulation using Css and Javascript, but do you really want to use JS and CSS for this type of task?
After review a lot of this articles about CSS and JS i ask my self,  how much time/effort is enough to manage this type of customizations almost all of them take minimal 1 hour "find the Ribbon location, create CSS and JS, upload file do Library, edit web part and include reference to files, do the same task for "Add, edit, View Form", do the same for other Libraries,,,,"

After review the time here are a list of problems founded with this approach:
  • Multiple WebPart with injected javascript could turn pages slow. 
  • Custom JS code could break the MDS and afect the load page performance
  • Harder to hide/show Ribbons associated to permissions, requires code.
  • This approach could not follow company policies and could require changes in CSS
  • A lot of this Custom code don't have documentation to explain what was done and where was implemeted "Pages" turnning very hard to other developers/consultant understand changes or migrations
SharePoint already has Objects to make this type of management in a way you can be compliant with your client, follow the company policies and avoid issues described before and Migrations
The problem here there isn't user interfaces to manage this objects and Ribbons options and here the Processlynx Custom Action and Ribbon Manager could help.

If you are a developer and you want to do it by yourself here are nice documentation you about UX in SharePoint 2013 that could help you understand the effort associated and the Processlynx Ribbon Manager app is trying to avoid that.
SharePoint 2013 and SharePoint Online solution packs

If you are a developer here a article that explains the XML structure with the complexity of Ribbons.
Examples of Ribbons Customization in SharePoint 2013

The Processlynx Ribbon Manager app compiles all this options needed to support the Management of Ribbons and Customs Actions like"Ribbons Locations, Image Locations, Content types associate, lists and others options" to became more efficient and fast customizations in SharePoint Sites.

Processlynx Ribbon Manager App 
Processlynx Custom Action and Ribbon Manager
You can make a test using the free Office Store version limited to App Web
Processlynx Custom Action And Ribbon Manager Demo

This video shows how easy the app hide Ribbons using a user friendly App interface and SharePoint UserCustomAction Object in background, for this case used the "PLX Custom Action and Ribbon Manager", this example hideRibbons options from the rich text edit option from Wiki Pages.



This video show another example on how you can select a specific list and Wiki pages and hide some Ribbons locations.

Hidden Locations from Library 

  • Ribbon.Library.Actions.Sync
  • Ribbon.Library.Actions.MyLinks
Hidden Locations from Wiki Page

  • Ribbon.WikiPageTab.PubPageActions.Preview
  • Ribbon.WikiPageTab.Share.ViewAnalyticsReport
  • Ribbon.WikiPageTab.PubPageActions.SetHomePage




Support Links:
Processlynx Custom Action and Ribbon Manager
New features released for app Processlynx Custom Action and Ribbon Manager
Processlynx Custom Action And Ribbon Manager Demo
Examples of Ribbons Customization in SharePoint 2013

Hope you like this Article
Kind regards, 
André Lage

quinta-feira, outubro 02, 2014

Export/Import SharePoint objects using JSON and REST in App

One big request from IT Managers and Office 365 SharePoint Site is about Migrations of data and SharePoint Objects from SharePoint Site, yes there is a lot of tools that help you making this type of migration,we hear a lot about moving users, Lists, Content types but how this really works...
We can have multiple ways since SharePoint Object Model Server Side, Client Side Object Model or REST operations as examples.
This example show how you can use the data in JSON base from REST operations and SharePoint Objects from SharePoint Sites then change it and import to different SharePoint sites .

The created SharePoint App model shows how we can export and import SharePoint Objects using JSON and REST with Javascript.

This type of method can be very useful to move SharePoint Site Configurations to multiple sites, for this example used the "RoleDefinition" object to export a existing RoleDefinition Object and import with a different name using JSON data.



Support documents:
"Users, groups, and roles REST API reference"
http://msdn.microsoft.com/en-us/library/office/dn531432(v=office.15).aspx
"How to Convert REST Call to SharePoint JSOM Object (ECMAScript)"
http://aaclage.blogspot.ch/2014/04/how-to-convert-rest-call-to-sharepoint.html


How the App Works?

The app get a existing RoleDefinition permission Name in the SharePoint site and make a REST operation to return the JSON data associated.
The first thing was get the Name of a permission in Permission Levels, you can access the page following the Top Right Menu "Site settings > Site Permissions > Ribbon "Permissions Levels"".





Export JSON Roledefinition

When the Permission name is selected access to ExportImport App and select the Option "Export RoleDefinition JSON" and the JSON data is displayed in the TextArea.



Code:
function ExportJson() {
    var executor = new SP.RequestExecutor(SPAppWebUrl);
 
    executor.executeAsync({
        url: SPAppWebUrl + "/_api/SP.AppContextSite(@target)/Web/Roledefinitions?$filter=Name eq '" + $('#Roledefinition').val() + "'&@target='" + SPHostUrl + "'",
        method: "GET",
        headers: { "Accept""application/json; odata=verbose" },
        success: function (data) { $('#ExportJSON ').val(data.body); SP.UI.Notify.addNotification('Roledefinitions exported with Success!!'false); },
        error: function (sender, args) {
            SP.UI.Notify.addNotification('Request failed. ' + sender.statusText + '\n' + sender.statusCode);
        }
    });
}

Import JSON Roledefinition

Copy the JSON data and paste in the Import JSON TextArea and provide a new Name for the RoleDefinition and select "Import new Roledefinition JSON".
This operation will send a POST Method by REST with the JSON data and properties associated in the Body of the message to SharePoint.
After this the object should be created with success.


Code:

function ImportJson() {
    var item = JSON.parse($('#ImportJSON').val()).d;
    var executor = new SP.RequestExecutor(SPAppWebUrl);
    if (item.results.length == 1) {
        executor.executeAsync({
            url: SPAppWebUrl + "/_api/SP.AppContextSite(@target)/web/roleDefinitions?@target='" + SPHostUrl + "'",
            method: "POST",
            body: "{ '__metadata': { 'type': 'SP.RoleDefinition' }, 'BasePermissions':{ '__metadata': { 'type': 'SP.BasePermissions' }, 'High': '" + item.results[0].BasePermissions.High + "','Low':'" + item.results[0].BasePermissions.Low + "'}, 'Description': '" + item.results[0].Description + "', 'Name': '" + $('#NameRoledefinition').val() + "', 'Order': " + item.results[0].Order + " }'",
            headers: {
                "content-type""application/json; odata=verbose"
            },
            success: function (data) { SP.UI.Notify.addNotification('New role "' + $('#NameRoledefinition').val() + '" Roledefinitions imported with Success!!'); },
            error: function (sender, args) {
                SP.UI.Notify.addNotification('Request failed. ' + sender.statusText + '\n' + sender.statusCode);
            }
        });
    } else {
        SP.UI.Notify.addNotification('More than 1 item'false);
    }
   
}

After the success Message from the last operation, you can refresh the Permission Level Page and validate if the new RoleDefinition was created with sucess.





For the ExportImport App Project you can access the following link: http://1drv.ms/1xDqjhT

Hope you like this Article, 
Kind regards, 
André Lage

terça-feira, setembro 30, 2014

Microsoft Power Query for Excel - Easy access to Office 365 data and other connectors

Today i tested the new version of the "Microsoft Power Query for Excel Plug-in" and have to say "Microsoft did a brilliant work on call External data from Excel".
Here where you can download the "Microsoft Power Query for Excel
http://www.microsoft.com/en-us/download/details.aspx?id=39379

This is a "must-have" in every Excel document.

I used, tested and love it, if you work heavily with excel this is a plug-in to have in Excel Document and will be very useful to call external data.

Access your SharePoint List data stored in Office 365 with Plug-in
Here a little manual on how we can access to sharePoint data using the Plug-in in Excel.

Install the plug-in to Excel 2013 "Microsoft Power Query for Excel" and open the excel.
Select the Ribbon "Power Query" and select the option "From Other Sources > From SharePoint List", this option will open a conection to your Office365.




Select the SharePoint Url where is located the List data you want to manage in the Excel file.


Select the type of authentication since this is Office 365, select tthe option "Organization Account" and "sign in" with your Office365 account. This credential will be stored and used to access Office365 data.


After the authentication is made with success a new option call "Navigator" appear where is listed all Lists from the SharePoint Site.



In this option you are able to select your List datasource, for this example i used a List call "PLXRecyclingBin" where i store my UserCustomActions for maintenance and select the option "Edit" to manage the datasource.


Query Editor

When the Query Edit is selected a new dialog form is open where we have multiple options "select Columns, Grouping, Split, Counts, Merge Query, etc etc" that help the Management of the data, super powerful


Choose Columns

One of the option we can use in the Query editor is the column selector where columns of the List are displayed and we can choose what should be shown. 


Group By 

Another great option is the "Group By", this option provide View where we can group by field and define operations asscoiated for this case was select "Count Rows".



Workbook Query 

After the query editor is finish need to cose and the new view appears in excel with te defined content, easy easy.... even with preview in the Datasource.



Select Multiple Lists

The add-in is so powerfull that is possible call mutliple List and make possible connections between them, but that is another article. 



Power Query Connector Views

Here a view of the existing connectors "SharePoint, Office 365, Active Directory, Odata, Azure, Exchange, Facebook also?!?!...."




Hope you like this article,
Kind regards,
André Lage