Debug office Add-ins

You could get logs of internal errors on the Office Addin using following method. Its simple and easy and involved few steps achieve.

Open Windows registry editor (windows + R then regedit.exe) and follow the route “HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\Wef\Developer\” and mention your location to write logs.

2017-07-24_12-00-23

Notes 

  • Runtime logging feature available in Office desktop 2016 version.
  • You must be admin of the considered system to perform this.

Important!

Initially, this is kept blank and keep in mind to reverse it back since it leads to performance issues.

View Picker Tree view of SharePoint Online and On Prem

If you locking for short cut to integrate SharePoint site hierarchy. The following hack would be a better option if you not willing to custom build control.

✍ How achive?

/_layouts/15/PickerTreeView.aspx

SharePoint site hierarchy

Introduction to Script Lab – A Simplified but powerful way to Office Extendibility

Script Lab is a Microsoft garage project which initiated with summer hackathon held back in 2016. Creator main focus is to build a platform where build add-ins simple and with less knowledge curve for web developers. It is simple but it does not mean it is not powerful. Let’s go through below slider where you could kick start on developing Office extended apps.

click here if slider does not work. 

More information
https://www.microsoft.com/en-us/garage/project-details.aspx?project=script-lab

Github Repository
http://aka.ms/scriptlab

Get Script Lab
https://aka.ms/getscriptlab – install

Office Add-ins UX design patterns
https://github.com/OfficeDev/Office-Add-in-UX-Design-Patterns

Office JS API reference
https://dev.office.com/reference/add-ins/javascript-api-for-office

Azure Functions with SharePoint Online

Common trend we came and interesting figure we came up is moving towards Severless where we are not worry about infrastructure. “Azure Functions” is a compute offering which you allow to write custom logic with choice of C#, F# and JavaScript (as for May, 2017).

From the choices above I have chosen SharePoint CSOM (Client Side Object Model) to this sample but if you prefer JSOM or REST API with the requirement, you could go with those.

Lets checkout Azure Functions with SharePoint Online where both in same cloud group which call as SaaS (Software as a Service).

🛠 Step ♳ – Create an Azure Function

You could arrive there with simply following below reference which is common thing and described in every reference.

https://docs.microsoft.com/en-us/azure/azure-functions/functions-create-function-app-portal

🛠 Step ♴ – Adding SharePoint CSOM DLLs

To add SharePoint DLLs to Functions App environment, you required to arrive with Kudu environment.

 Function à Platform Features à Advanced Tools (Kudu)

Shortcut – You could arrive there with URL

https://<function name>.scm.azurewebsites.net/

After you arrived with Kudu portal, check for debug then PowerShell (Command prompt is also available but prefer PS). Navigate to bin folder which resides under following location under you function name and upload your SharePoint DLLs to the folder (i.e. Microsoft.SharePoint.Client.dll and Microsoft.SharePoint.Client.Runtime.dll)

☕ Learn more on Kudu – https://github.com/projectkudu/kudu

🛠 Step ♵ – Refer SharePoint references on the Function

After adding DLLs to the bin, you could arrive with function and start writing you logic within the run.csx.

You could refer added DLLs in the function as below in the top.

#r “Microsoft.SharePoint.Client.Runtime.dll”

#r “Microsoft.SharePoint.Client.dll”

🛠 Step ♶ – Imports references

This is typical step we are doing in any C# which is adding references.

using System;

using System.Security;

using System.Configuration;

using Microsoft.SharePoint.Client;

🛠 Step ♷ – Configuration Values in Azure Function

You will be required the user name, password, and site URL to your SharePoint, those could be done with the application settings as we were keep doing with the web.config files.

Navigate thorough below path and add your configurations where you will be references in function logic.

Click on Function à Platform Features à Application Settings à App settings à Add values as key/ value pairs

Above could be accessed as below in the code.

string userName = ConfigurationManager.AppSettings[“User”];

🛠 Step ♸ – Application Logic

You could write as your preference. In my sample on the gist which I have posted below is considered copying list items from one list to another. It’s really simple and you could able to expand the logic as you have done earlier with SharePoint CSOM.


#r "Microsoft.SharePoint.Client.Runtime.dll"
#r "Microsoft.SharePoint.Client.dll"
using System;
using System.Security;
using System.Configuration;
using Microsoft.SharePoint.Client;
public static void Run(TimerInfo myTimer, TraceWriter log)
{
string userName = ConfigurationManager.AppSettings["User"];
string password = ConfigurationManager.AppSettings["Pass"];
string spSite = ConfigurationManager.AppSettings["SharePointSiteUrl"];
const string listName = "List00";
const string listNameDestination = "List01";
log.Info($"Trigger function executed at: {DateTime.Now} with {userName} | {password} on {spSite}");
using (ClientContext ctx = new ClientContext(spSite))
{
// Authenticating to SPO
SecureString securePassword = new SecureString();
foreach (char c in password.ToCharArray())
securePassword.AppendChar(c);
ctx.Credentials = new SharePointOnlineCredentials(userName, securePassword);
// Getting all SPO list items
List myList = ctx.Web.Lists.GetByTitle(listName);
CamlQuery query = CamlQuery.CreateAllItemsQuery(100);
ListItemCollection collListItem = myList.GetItems(query);
ctx.Load(collListItem);
ctx.ExecuteQuery();
// Destination list item – create list items
List destinationList = ctx.Web.Lists.GetByTitle(listNameDestination);
ListItemCreationInformation itemCreateInfo;
foreach (ListItem oListItem in collListItem)
{
// Getting list item
string customColumnValue = Convert.ToString(oListItem["CustomColumn"]);
log.Info($" List Item retrieved from {listName} => {customColumnValue}");
// Writing values to destination list which are retrieved
if (!string.IsNullOrEmpty(customColumnValue)){
itemCreateInfo = new ListItemCreationInformation();
ListItem newItem = destinationList.AddItem(itemCreateInfo);
newItem["Title"] = customColumnValue;
newItem.Update();
log.Info($" Updating column Title with {listNameDestination} with {customColumnValue}");
ctx.ExecuteQuery();
}
}
}
}

view raw

run.csx

hosted with ❤ by GitHub

⌛ Motivations

You could use Azure Functions as Timer Jobs (which we had in SharePoint Server) with scheduling and web hooks and etc.

References – Azure Function Developer Guide

Enabling External Sharing | Multidomain Sharing in SharePoint Online

In SharePoint online environment most of the businesses facing issue with connecting with another business (B2B) or in technical terms connecting with another domain.

We have been using different methods with the Active Directly level which we known as “Federation”. But will see how we could share SharePoint site with multiple domains.

📓 Note : 

  • You must have either Microsoft account or organizational account to achieve this. 
  • Microsoft account must not be Live, Outlook or Hotmail, It could be Gmail, Yahoo or another. Then you should create a Microsoft account with your domain. Eg. “example@yahoo.com”.
  • Organizational account is account in another Office 365 tenant

How to share site with external domain user?

Firstly, you must enable External Sharing in the Office 365 admin center. This could be find easily with searching external sharing in the admin center.

ext 1

Second, Go site administration and select your SharePoint site and hit on “Share” on the ribbon. Make sure and best practice 🔖 to mention your external domain you sharing as below.

ext 2

Finally added user will be visible as below in the Office 365 admin center.

📌 Some useful resources :

In memory of Office SharePoint Server 2007 aka MOSS

Naturally we all expect end on everything, same applies to software in this days. Hopefully we could not see SharePoint 2007 living with us for ten years as for now after 10th October 2017, in a way This is with the good hope on modernize and evolve with the collaboration but in a way bad news for whom love classics.

What happens after deprecation?

  • No security update further
    • This will get managing this costly
    • No patches No hot fixes from Microsoft
  • No support
    • Need to migrate to version with life as sooner
    • Not guaranteed Office365 and cloud support
  • No technical content management
    • Less documentations and resources
    • Less community engagement

Key milestones to say good bye!


“Say good bye and make your modernization plans switched on”

REST and OData with Office365 APIs

When communicate with Office or SharePoint APIs, its important fact that knowledge on representational transfer protocol and OData protocols while moving with deep customization’s.

what is REST (Representational State Transfer)?

In simple terms REST is all about below;

  • Predefined set of stateless operation which identified by URL
  • Responses may contain HTML, JSON, XML or any other defined format which supported
  • GET, POST, PUT, DELETE are most common forms of HTTP verbs

rest_api

Eg.

GET:
http:///_api/web/lists/GetByTitle('Test')
GET:
https://outlook.office.com/api/v2.0/me/MailFolders/sentitems/messages/

what is OData (Open Data Protocol)?

  • Equipped with query and creational capabilities on REST APIs
  • Initiated by Microsoft in year 2007
  • Format [http or https]://<REST Endpoint URL>/<query>
http://<end point URI>?$select=value&$filter=condition$orderby=value

Open Standardization?
Standards which are developed with the involvement of community (mostly with developers). Open standards inherited to office 365 API development in following manners;
• Most of Office 365 APIs are exposed as a RESTful APIs
• Its implemented with OData 4.0 (as for year 2016)

OData queries?
OData queries is common standard which elaborated above also included in the SharePoint and Office365 end point data querying. Its ultra simple if you know the basics and played with this. Follow the following links and be expert on this.

www.odata.org : Official site for OData

graph.microsoft.io : Explore Microsoft Office365 API with queries

OData validator to validate your REST endpoints

Note : If you noticed there are versions associated with most of cloud based endpoints. Cloud services are continuously pushing changes to its services as sooner changes are ready, so then returned patterns may changed for same query. To avoid custom applications get break due to changed on endpoint, it classifies under version metadata. Simply you can pick any version which satisfies your requirement.

Querying SharePoint Endpoints as below;

SharePoint REST service query option syntax
Courtesy : msdn.microsoft.com

 

Further references 

Clear | Remove | Delete Managed metadata (Taxanomy) column value in SharePoint List/ library

You may find many references to write into taxonomy columns (aka. managed metadata columns) but the clearing those is pretty much tricky.

Following code sample guide you through how you can clear the taxonomy column value in you custom client side application (JSOM) based on SharePoint.

//USAGE:
//clearWithValue =true => for clear saved taxanomy column values
//clearWithValue =false => wite into taxanomy column 

function saveValuesToManagedMetadataColumns(listName, fieldId, taxanomyLabel, siteUrl, clearWithValue) {

    //You many need seperate function to resolve GUID for the lable.
//Its based on your requirement and for now its hardcoded
    var taxonmyGuid = "9f75f519-51f8-4723-9182-7e8225a54031";
//Loading context and list
    var context = new SP.ClientContext(siteUrl);
    var list = context.get_web().get_lists().getByTitle(listName);
    //Getting item to update
    var camlQuery = new SP.CamlQuery();
    camlQuery.set_viewXml("<View>" +
        "<Query>" +
        "<Where><Eq>" +
        "<FieldRef Name=\'ID\'/>" +
        "<Value Type=\'Number\'>" + fieldId + "</Value>" +
        "</Eq></Where>" +
        "</Query>" +
        "</View>");
    var items = list.getItems(camlQuery);
//Load selected items to context
    context.load(items);
    //Loading MMS field
    var field = list.get_fields().getByInternalNameOrTitle("taxanomyColumnName");
    var txField = context.castTo(field, SP.Taxonomy.TaxonomyField);
//Load field to context
    context.load(txField);

    context.executeQueryAsync(function () {
        //getting term set ID
        var functionTermSetId = txField.get_termSetId().toString();
        //Term value build for update..this is not useful is your purpose only for clearing
//But for illustration..got below also to show off
        var termValue = new SP.Taxonomy.TaxonomyFieldValue();
        termValue.set_label(taxanomyLabel);
        termValue.set_termGuid(taxonmyGuid);
        termValue.set_wssId(-1);
//Iterate through collection and update
        var e = items.getEnumerator();
        while (e.moveNext()) {
            var item = e.get_current();

            //Save to taxanomy column
            if (clearWithValue == false)
                txField.setFieldValueByValue(item, termValue);

            //Clering taxanomy column
            if (clearWithValue == true)
                txField.validateSetValue(item, null);

            //Set noraml fields..If you have them too
            item.set_item('Title', metadataCollection.Title);

            item.update();
        }
        context.executeQueryAsync(function (sender, args) {
            console.log('Successfully updated item with ', args, serviceId, false);
        }, function (args) {
            console.log('Error on updating item with taxanomy value', args, serviceId, false);
        });

    }, function (args) {
        console.log('Internal server Error on updating item with taxanomy metadata', args, serviceId, false);
    });

}

References
http://sharepoint.stackexchange.com/questions/47719/how-can-i-set-empty-value-to-taxonomyfield-of-microsoft-sharepoint-client-taxono

Integrate SharePoint Documents with Office Web Apps in Custom Solutions

If you are finding way of integrating Office Web Apps(OWA)with your custom solution which built with SharePoint CSOM/ JSOM or with integration of any client site development. Specially in a scenario where you develop your own “SharePoint display template” following integration points will be useful;

View in office web apps

Following link will work; if your requirement is to open your document in OWA. This can be done with simply appending parameter as below;

<uri to your document>?Web=0

Eg:
http://mydomain.local/sites/OWASite/Documents/TechCentro.docx?Web=0

Edit SharePoint documents in OWA

Following way of integration with the Office Web apps which let you to pick your action is; means that whether your action may be read, edit or your default setting.

<Web absolute URi>_layouts/15/WopiFrame.aspx?sourcedoc=<Relative URi to document>&action=<Your action>

Summary of actions as below;

 

&action=default -> Gets default setting of the documents
&action=view    -> Open office app as a read only
&action=edit    -> Open office app as editable

Eg:

http://mydomain.local/sites/OWASite/_layouts/15/WopiFrame.aspx?sourcedoc=/sites/OWASite/Documents/BestPractices.docx&action=edit

You can be changed the default behavior with following approach
https://technet.microsoft.com/en-us/library/ee837425.aspx?f=255&MSPPError=-2147217396

Building URL to the Office Web Apps

If you thinking about how to build your URL; following illustration may be useful.

var owauri="_spPageContextInfo.webAbsoluteUrl" //absolute URL of the SharePoint site
+"/_layouts/15/WopiFrame.aspx?sourcedoc=" //static phrase
+"/sites/OWASite/Documents/TechCentro.docx" //Relative URL to the document
+"&action=edit //Action parameter

Useful resources

https://technet.microsoft.com/en-us/library/ff431685.aspx