European Sharepoint 2013 Hosting Blog

SharePoint 2013 Hosting – HostForLIFE.eu :: Programmatically “Apply Label To Items In List Or Library”

May 20th

Posted by Peter in European SharePoint 2013 Hosting

This post explains how to apply a label at list/library level in SharePoint Online by using Client Side Object Model in PowerShell. This script will help save us developers a lot of time in getting all the lists/libraries from a individual Site Colletion or subsites. So, here is the script.

Copy the below code to a .ps1 file.
Run the .ps1 file on the SharePoint PowerShell modules.
Configure the input parameters.

Source Code

Add-Type -Path "xxxxx\Microsoft.Online.SharePoint.PowerShell\Microsoft.SharePoint.Client.dll"    
Add-Type -Path "xxxxx\Microsoft.Online.SharePoint.PowerShell\Microsoft.SharePoint.Client.Runtime.dll"    
Add-Type -Path "xxxxx\Microsoft.Online.SharePoint.PowerShell\Microsoft.Online.SharePoint.Client.Tenant.dll"    
#Set parameter values  
$SiteURL="your site"  
$LibraryName="Library Name"  
$labelName=" your retension label name(Retain for 99 years)"  
#Setup Credentials to connect  
$Cred= Get-Credential  
$Credentials = New-Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($Cred.Username, $Cred.Password)  
#Setup the context  
$Ctx = New-Object Microsoft.SharePoint.Client.ClientContext($SiteURL)  
$Ctx.Credentials = $Credentials  
function GetSPODocLibraryFiles(){  
param  
    (  
        [Parameter(Mandatory=$true)] [string] $SiteURL  
         
    )    
try{  
        $Web = $Ctx.Web  
        $Ctx.Load($web)  
        #Get all immediate subsites of the site  
        $Ctx.Load($web.Webs)   
        $Ctx.executeQuery()  
        #Call the function to Get Lists of the web  
        Write-host "Processing Web :"$Web.URL  
        write-host -f White "Connected to Web";  
        }  
        catch  
        {  
          $Message= "Processing Web :$Web.URL $($_.Exception.Message)"   
          Write-Log -Message $Message -Level ERROR  
        }  
        #Loop All the lists or libraries if you want to apply it for all otherwise get the perticular library  
        $Lists = $Web.Lists   
        $Ctx.Load($Lists)  
        $Ctx.ExecuteQuery()  
  
        ForEach($Lib in $Lists)  
        {  
          #Get the List Name  
        if($Lib | Where-Object { $_.BaseType -Eq "DocumentLibrary" })  
         {  
            Write-host $Lib.Title       
            $Lib = $Ctx.Web.Lists.GetByTitle($LibraryName)  
            $Ctx.Load($Lib)  
            $Ctx.Load($Lib.RootFolder)  
            $Ctx.ExecuteQuery()  
  
  
        try  
      {  
  
     $listId = $Lib.Id  
     $ie = New-Object -com InternetExplorer.Application  
    try  
    {  
        $applyLabelUrl = "$($Web.URL)/_layouts/15/Hold.aspx?Tag=true&List={$($listId)}"  
        Write-Host $applyLabelUrl  
        $ie.visible = $true  
    
        $ie.navigate($applyLabelUrl)  
  
        for ($i = 0; $i -lt 300; $i++)  
        {   
            if ($ie.ReadyState -eq 4) { break }  
  
  
  
            if ($i -eq 299) { throw "Unable to start IE session to simulate HP RM turning off inheritence." }  
        }  
        #Start-Sleep -Seconds 40  
            $complianceTagDropDown = $ie.Document.getElementById('ctl00_PlaceHolderMain_inputFormSectionMain_ctl01_ComplianceTagDropDown')  
  
        for ($i = 1; $i -lt $complianceTagDropDown.options.length; $i++)  
            {   
                if ($complianceTagDropDown.options[$i].text -eq $labelName)  
                {  
                    $complianceTagDropDown.options[$i].selected = $true  
                    $isFound = $true  
                    break  
                }         
            }  
  
        if ($complianceTagDropDown.id -ne "ctl00_PlaceHolderMain_inputFormSectionMain_ctl01_ComplianceTagDropDown")  
        {  
            throw "Didn't get assurance that I found complianceTagDropDown"  
  
        }  
        else  
        {  
            $isFound = $false  
            for ($i = 1; $i -lt $complianceTagDropDown.options.length; $i++)  
            {   
                if ($complianceTagDropDown.options[$i].text -eq $labelName)  
                {  
                    $complianceTagDropDown.options[$i].selected = $true  
                    $isFound = $true  
                    break  
                }         
            }  
  
            if ($isFound -eq $false)  
            {  
                throw "Unable to select '$($labelName)' in complianceTagDropDown. No such option?"  
            }  
            $checkMark=$ie.Document.getElementById('ctl00_PlaceHolderMain_inputFormSectionMain_ctl01_DefaultComplianceTagSyncToListItems')  
            $checkMark.checked =$true  
            $saveButton = $ie.Document.getElementByID('ctl00_PlaceHolderMain_ctl00_RptControls_btnOK')  
            if ($saveButton.id -ne "ctl00_PlaceHolderMain_ctl00_RptControls_btnOK")  
            {  
                throw "Didn't get assurance that I found saveButton"  
            }  
            else  
            {  
                $saveButton.click()  
            }  
  
        }  
  
    }  
    finally  
    {  
        $ie.Parent.Quit()  
        Start-Sleep 1  
     }  
}  
  
finally  
{  
}  
  
}  
}  
  
}  
  
GetSPODocLibraryFiles -SiteURL $SiteURL

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

Add-Type -Path "xxxxx\Microsoft.Online.SharePoint.PowerShell\Microsoft.SharePoint.Client.dll"

Add-Type -Path "xxxxx\Microsoft.Online.SharePoint.PowerShell\Microsoft.SharePoint.Client.Runtime.dll"

Add-Type -Path "xxxxx\Microsoft.Online.SharePoint.PowerShell\Microsoft.Online.SharePoint.Client.Tenant.dll"

#Set parameter values

$SiteURL="your site"

$LibraryName="Library Name"

$labelName=" your retension label name(Retain for 99 years)"

#Setup Credentials to connect

$Cred= Get-Credential

$Credentials = New-Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($Cred.Username, $Cred.Password)

#Setup the context

$Ctx = New-Object Microsoft.SharePoint.Client.ClientContext($SiteURL)

$Ctx.Credentials = $Credentials

function GetSPODocLibraryFiles(){

param

(

[Parameter(Mandatory=$true)] [string] $SiteURL

)

try{

$Web = $Ctx.Web

$Ctx.Load($web)

#Get all immediate subsites of the site

$Ctx.Load($web.Webs)

$Ctx.executeQuery()

#Call the function to Get Lists of the web

Write-host "Processing Web :"$Web.URL

write-host -f White "Connected to Web";

}

catch

{

$Message= "Processing Web :$Web.URL $($_.Exception.Message)"

Write-Log -Message $Message -Level ERROR

}

#Loop All the lists or libraries if you want to apply it for all otherwise get the perticular library

$Lists = $Web.Lists

$Ctx.Load($Lists)

$Ctx.ExecuteQuery()

ForEach($Lib in $Lists)

{

#Get the List Name

if($Lib | Where-Object { $_.BaseType -Eq "DocumentLibrary" })

{

Write-host $Lib.Title

$Lib = $Ctx.Web.Lists.GetByTitle($LibraryName)

$Ctx.Load($Lib)

$Ctx.Load($Lib.RootFolder)

$Ctx.ExecuteQuery()

try

{

$listId = $Lib.Id

$ie = New-Object -com InternetExplorer.Application

try

{

$applyLabelUrl = "$($Web.URL)/_layouts/15/Hold.aspx?Tag=true&List={$($listId)}"

Write-Host $applyLabelUrl

$ie.visible = $true

$ie.navigate($applyLabelUrl)

for ($i = 0; $i -lt 300; $i++)

{

if ($ie.ReadyState -eq 4) { break }

if ($i -eq 299) { throw "Unable to start IE session to simulate HP RM turning off inheritence." }

}

#Start-Sleep -Seconds 40

$complianceTagDropDown = $ie.Document.getElementById('ctl00_PlaceHolderMain_inputFormSectionMain_ctl01_ComplianceTagDropDown')

for ($i = 1; $i -lt $complianceTagDropDown.options.length; $i++)

{

if ($complianceTagDropDown.options[$i].text -eq $labelName)

{

$complianceTagDropDown.options[$i].selected = $true

$isFound = $true

break

}

if ($complianceTagDropDown.id -ne "ctl00_PlaceHolderMain_inputFormSectionMain_ctl01_ComplianceTagDropDown")

{

throw "Didn't get assurance that I found complianceTagDropDown"

}

else

{

$isFound = $false

for ($i = 1; $i -lt $complianceTagDropDown.options.length; $i++)

{

if ($complianceTagDropDown.options[$i].text -eq $labelName)

{

$complianceTagDropDown.options[$i].selected = $true

$isFound = $true

break

}

if ($isFound -eq $false)

{

throw "Unable to select '$($labelName)' in complianceTagDropDown. No such option?"

}

$checkMark=$ie.Document.getElementById('ctl00_PlaceHolderMain_inputFormSectionMain_ctl01_DefaultComplianceTagSyncToListItems')

$checkMark.checked =$true

$saveButton = $ie.Document.getElementByID('ctl00_PlaceHolderMain_ctl00_RptControls_btnOK')

if ($saveButton.id -ne "ctl00_PlaceHolderMain_ctl00_RptControls_btnOK")

{

throw "Didn't get assurance that I found saveButton"

}

else

{

$saveButton.click()

}

finally

{

$ie.Parent.Quit()

Start-Sleep 1

}

finally

{

}

GetSPODocLibraryFiles -SiteURL $SiteURL

Execute the program. Once it is executed successfully, you can see the label applied in the SharePoint List/Library.

SharePoint 2013 Hosting – HostForLIFE.eu :: CSS in SPFx

May 6th

Posted by Peter in European SharePoint 2013 Hosting

Styling is the most important part of web development. In this article, we will learn how to efficiently consume CSS in our Typescript file.

CSSType

This is an npm package available in the npm repository handle styled attribute in an HTML element.

Installation:

npm i csstype

1	npm i csstype

Necessary imports:

import * as CSS from 'csstype';

1	import * as CSS from 'csstype';

Properties are categorized into different uses and in several technical variations to provide typings that suit as many as possible. The good part is that it supports IntelliSense.

Default	Hyphen	Fallback	HyphenFallback
All	Properties	PropertiesHyphen	PropertiesFallback	PropertiesHyphenFallback
Standard	StandardProperties	StandardPropertiesHyphen	StandardPropertiesFallback	StandardPropertiesHyphenFallback
Vendor	VendorProperties	VendorPropertiesHyphen	VendorPropertiesFallback	VendorPropertiesHyphenFallback
Obsolete	ObsoleteProperties	ObsoletePropertiesHyphen	ObsoletePropertiesFallback	ObsoletePropertiesHyphenFallback
Svg	SvgProperties	SvgPropertiesHyphen	SvgPropertiesFallback	SvgPropertiesHyphenFallback

Categories

All – Includes Standard, Vendor, Obsolete and SVG
Standard – Current properties and extends subcategories StandardLonghand and StandardShorthand (e.g. StandardShorthandProperties)
Vendor – Vendor prefixed properties and extends subcategories VendorLonghand and VendorShorthand (e.g. VendorShorthandProperties)
Obsolete – Removed or deprecated properties
SVG – SVG-specific properties

Variations

Default – JavaScript (camel) cased property names
Hyphen – CSS (kebab) cased property names
Fallback – Also accepts an array of values e.g. string | string[]

Examples

Using default Properties:

var divStyle: CSS.Properties = {  
minHeight:'auto',  
maxHeight:'500px'    
};

var divStyle: CSS.Properties = {

minHeight:'auto',

maxHeight:'500px'

};

By default, it only supports a string if we need to pass number literals.

var divStyle: CSS.Properties<string | number> = {  
   minHeight:'auto',  
   maxHeight:'500px',  
   padding:10  
};

var divStyle: CSS.Properties<string | number> = {

minHeight:'auto',

maxHeight:'500px',

padding:10

};

We can consume this in our tsx file with the following:

<div  style={divStyle}>  </div>

1	<div style={divStyle}> </div>

Sometimes, we need to pass array of values for CSS that uses PropertiesFallback:

const divStyle: CSS.PropertiesFallback<string | number> = {  
  display: ['-webkit-flex', 'flex'],  
  color: 'white',  
  padding:10  
};

const divStyle: CSS.PropertiesFallback<string | number> = {

display: ['-webkit-flex', 'flex'],

color: 'white',

padding:10

};

Sometimes, there is an need for pseudo selectors, in that case:

const divStyle: { [P in CSS.SimplePseudos]?: CSS.Properties } = {  
  ':hover': {  
    display: 'flex',  
  },  
};

const divStyle: { [P in CSS.SimplePseudos]?: CSS.Properties } = {

':hover': {

display: 'flex',

};

It also support hyphen case, this will implemented by:

interface Style extends CSS.Properties, CSS.PropertiesHyphen {}  
const mydivstyle: Style = {  
  'flex-grow': 1,  
  'flex-shrink': 0,  
  'font-weight': 'normal',  
  backgroundColor: 'white',  
  'padding':'10 10 10 10'  
};

interface Style extends CSS.Properties, CSS.PropertiesHyphen {}

const mydivstyle: Style = {

'flex-grow': 1,

'flex-shrink': 0,

'font-weight': 'normal',

backgroundColor: 'white',

'padding':'10 10 10 10'

};

typestyle

This is also an npm package available in the npm repository. By using this package, we can write CSS in a typescript file.

Installation

npm i typestyle

Necessary imports:

import { style,stylesheet } from "typestyle";

1	import { style,stylesheet } from "typestyle";

Similar to the style attribute, we can assign classCss to className using the style method in typestyle, e.g.

const myclassname = style({paddingLeft: 'red',marginLeft:'10px'});

1	const myclassname = style({paddingLeft: 'red',marginLeft:'10px'});

We can consume this in our tsx file with:

<div className={myclassname}> </div>

1	<div className={myclassname}> </div>

Concept – Mixin

A mixin is an object that contains properties for reuse.

The style function can take multiple objects. This makes it easy to reuse simple style objects, e.g.

const redMaker = {color:'red'};  
const bigFont = {fontSize: '50px'};  
const bigRedClass = style(  
  redMaker,  
  bigFont  
);  
  
<div className={bigRedClass}>Hello world</div>

const redMaker = {color:'red'};

const bigFont = {fontSize: '50px'};

const bigRedClass = style(

redMaker,

bigFont

);

<div className={bigRedClass}>Hello world</div>

Concept – Interpolation

You can nest properties for different selectors using the $nest property. Any & in a key for $nest gets replaced with the generated class name when its written to CSS. For example, it allows super simple CSS pseudo class (&:hover, &:active, &:focus, &:disabled) customization. It also allows you to use pseudo-elements ,(e.g. ::after, &::before etc):, child selectors.

const mycolors = style({    
  transition: 'color .2s',    
  color: 'blue',    
  $nest: {    
    '&:hover': {    
      color: 'red'    
    },    
    '&::before': {    
      content:'Hello '    
    }  , '&>*': {  
      marginBottom: 10,  
    },  
    '&>*:last-child': {  
      marginBottom: '0px',  
    }  
  }    
});    
    
<h1 className={mycolors }world</h1>    
    
//output be Helloworld

const mycolors = style({

transition: 'color .2s',

color: 'blue',

$nest: {

'&:hover': {

color: 'red'

'&::before': {

content:'Hello '

} , '&>*': {

marginBottom: 10,

'&>*:last-child': {

marginBottom: '0px',

}

});

//output be Helloworld

Sometimes we need to implement the whole CSS file in the component. That can be achieved with the stylesheet class:

Implementation sample:

const myButton = {  
  border: 'solid thin red',  
  borderRadius: 2,  
  color: 'white',  
  padding: '4px 10px'  
};  
  
const css = stylesheet({  
  component: {  
      display: 'flex'  
  },  
  primaryButton: {  
      backgroundColor: 'darkblue',  
      ...myButton  
  },  
  secondaryButton: {  
      backgroundColor: 'teal',  
      ...myButton  
  }  
});  
  
<div className={css.component}>  
  <button className={css.primaryButton}>Primary</button>  
  <button className={css.secondaryButton}>Secondary</button>  
</div>

const myButton = {

border: 'solid thin red',

borderRadius: 2,

color: 'white',

padding: '4px 10px'

};

const css = stylesheet({

component: {

display: 'flex'

primaryButton: {

backgroundColor: 'darkblue',

...myButton

secondaryButton: {

backgroundColor: 'teal',

...myButton

}

});

<button className={css.primaryButton}>Primary</button>

<button className={css.secondaryButton}>Secondary</button>

</div>

Conclusion

In this article, we learned various types of CSS implementation in SPFx. I hope this helps someone. Happy coding 🙂

SharePoint 2013 Hosting – HostForLIFE.eu :: Create List Item Using PnP JS In SharePoint Framework

Apr 30th

Posted by Peter in European SharePoint 2013 Hosting

In this blog, you will see how to create list item using PnP JS in SharePoint Framework.

@pnp/sp

This package contains the fluent api used to call the SharePoint rest services. Refer to this link for more details.

Create List Item

Create SPFx solution

Open Node.js command prompt.

Create a new folder.

>md spfx-pnpjs-createitem

1	>md spfx-pnpjs-createitem

Navigate to the folder.

>cd spfx-pnpjs-createitem

1	>cd spfx-pnpjs-createitem

Execute the following command to create SPFx webpart.

>yo @microsoft/sharepoint

1	>yo @microsoft/sharepoint

Enter all the required details to create a new solution. Enter the webpart named CreateItem and select React framework.

Yeoman generator will perform scaffolding process and once it is completed, lock down the version of project dependencies by executing the following command.

>npm shrinkwrap

1	>npm shrinkwrap

Execute the following command to open the solution in the code editor.

>code

>code

Execute the following command to install the pnp sp library.

>npm install @pnp/sp --save

1	>npm install @pnp/sp --save

Create a new file named as “ICreateItemState.ts” under Components folder and update the code as shown below.

import { MessageBarType } from 'office-ui-fabric-react';  
export interface ICreateItemState {  
    title: string;  
    showMessageBar: boolean;    
    messageType?: MessageBarType;    
    message?: string;  
}

import { MessageBarType } from 'office-ui-fabric-react';

export interface ICreateItemState {

title: string;

showMessageBar: boolean;

messageType?: MessageBarType;

message?: string;

}

Open the component file “src\webparts\createItem\components\CreateItem.tsx” and update the code as shown below.

import * as React from 'react';  
import styles from './CreateItem.module.scss';  
import { ICreateItemProps } from './ICreateItemProps';  
import { ICreateItemState } from './ICreateItemState';  
import { escape } from '@microsoft/sp-lodash-subset';  
import { TextField } from 'office-ui-fabric-react/lib/TextField';  
import { MessageBar, MessageBarType, IStackProps, Stack } from 'office-ui-fabric-react';  
import { autobind } from 'office-ui-fabric-react';  
import { sp } from "@pnp/sp";  
import "@pnp/sp/webs";  
import "@pnp/sp/lists";  
import "@pnp/sp/items";  
  
const verticalStackProps: IStackProps = {  
  styles: { root: { overflow: 'hidden', width: '100%' } },  
  tokens: { childrenGap: 20 }  
};  
  
export default class CreateItem extends React.Component<ICreateItemProps, ICreateItemState> {  
  constructor(props: ICreateItemProps, state: ICreateItemState) {  
    super(props);  
    this.state = {  
      title: '',  
      showMessageBar: false  
    };  
  }  
  public render(): React.ReactElement<ICreateItemProps> {  
    return (  
      <div className={styles.container}>  
        <div className={styles.row}>  
          {  
            this.state.showMessageBar  
              ?  
              <div className="form-group">  
                <Stack {...verticalStackProps}>  
                  <MessageBar messageBarType={this.state.messageType}>{this.state.message}</MessageBar>  
                </Stack>  
              </div>  
              :  
              null  
          }  
          <div className={styles.row}>  
            <div className="form-group">  
              <TextField label="Title" required onChanged={this.onchangedTitle} />  
            </div>  
            <div className={`${styles.buttonRow} form-group`}>  
              <button type="button" className="btn btn-primary" onClick={this.createItem}>Submit</button>  
            </div>  
          </div>  
        </div>  
      </div>  
    );  
  }  
  
  @autobind  
  private onchangedTitle(title: any): void {  
    this.setState({ title: title });  
  }  
  
  @autobind  
  private async createItem() {  
    try {  
      await sp.web.lists.getByTitle('Customer Tracking').items.add({  
        Title: this.state.title  
      });  
      this.setState({  
        message: "Item: " + this.state.title + " - created successfully!",  
        showMessageBar: true,  
        messageType: MessageBarType.success  
      });  
    }  
    catch (error) {  
      this.setState({  
        message: "Item " + this.state.title + " creation failed with error: " + error,  
        showMessageBar: true,  
        messageType: MessageBarType.error  
      });  
    }  
  }  
}

import * as React from 'react';

import styles from './CreateItem.module.scss';

import { ICreateItemProps } from './ICreateItemProps';

import { ICreateItemState } from './ICreateItemState';

import { escape } from '@microsoft/sp-lodash-subset';

import { TextField } from 'office-ui-fabric-react/lib/TextField';

import { MessageBar, MessageBarType, IStackProps, Stack } from 'office-ui-fabric-react';

import { autobind } from 'office-ui-fabric-react';

import { sp } from "@pnp/sp";

import "@pnp/sp/webs";

import "@pnp/sp/lists";

import "@pnp/sp/items";

const verticalStackProps: IStackProps = {

styles: { root: { overflow: 'hidden', width: '100%' } },

tokens: { childrenGap: 20 }

};

export default class CreateItem extends React.Component<ICreateItemProps, ICreateItemState> {

constructor(props: ICreateItemProps, state: ICreateItemState) {

super(props);

this.state = {

title: '',

showMessageBar: false

};

}

public render(): React.ReactElement<ICreateItemProps> {

return (

{

this.state.showMessageBar

<MessageBar messageBarType={this.state.messageType}>{this.state.message}</MessageBar>

</Stack>

</div>

null

}

</div>

<button type="button" className="btn btn-primary" onClick={this.createItem}>Submit</button>

</div>

);

}

@autobind

private onchangedTitle(title: any): void {

this.setState({ title: title });

}

@autobind

private async createItem() {

try {

await sp.web.lists.getByTitle('Customer Tracking').items.add({

Title: this.state.title

});

this.setState({

message: "Item: " + this.state.title + " - created successfully!",

showMessageBar: true,

messageType: MessageBarType.success

});

}

catch (error) {

this.setState({

message: "Item " + this.state.title + " creation failed with error: " + error,

showMessageBar: true,

messageType: MessageBarType.error

});

}

Open the webpart file “src\webparts\createItem\CreateItemWebPart.ts” and add the OnInit() method.

public onInit(): Promise<void> {  
  return super.onInit().then(_ => {    
    sp.setup({  
      spfxContext: this.context  
    });  
  });  
}

public onInit(): Promise<void> {

return super.onInit().then(_ => {

sp.setup({

spfxContext: this.context

});

}

Deploy the solution

Execute the following commands to bundle and package the solution.

>gulp bundle --ship  

>gulp package-solution --ship

>gulp bundle --ship

>gulp package-solution --ship

Navigate to tenant app catalog – Example: https://c986.sharepoint.com/sites/appcatalog/SitePages/Home.aspx

Go to Apps for SharePoint library and upload the package file (sharepoint\solution\spfx-pnpjs-createitem.sppkg). Click Deploy.

Test the webpart

Navigate to the SharePoint site and add the app. Navigate to the page and add the webpart.

Result

Summary

Thus, in this blog, you saw how to create list items using PnP JS in SharePoint Framework.

SharePoint 2013 Hosting – HostForLIFE.eu :: Automation of Archival Large Libraries through Flow

Apr 23rd

Posted by Peter in European SharePoint 2013 Hosting

Hi guys, let’s explore a powerful automation for the archival of large libraries using PnP with CSOM PowerShell. This approach can be used for an automatic/semi-automatic/manual way, as per the business needs on a weekly/monthly/quarterly basis, as per the archival needs.

Pre-Requisites

Install all the necessary DLL files by just going to this link >> Click Download >> Select the Latest File. Once the installation is done, you can see a few DLL files automatically reflected on your Local Path, like:

“C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.dll”

“C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.Runtime.dll”

Also, install the SharePointPnPPowerShellOnline.msi by going to this link.

Maintain the same Columns, Data Types, Views both in Source Library and Target Library, mostly alldocuments.aspx

PowerShell Scripts Used

The library scan is performed with all Nested Folders and Files, whichever has the Archive Flag manually set to ‘True’ OR scanned if they are 1 year old/n number of days old as per your Archival Strategy[LibScan.ps1].

#Load SharePoint CSOM Assemblies  
Add - Type - Path "C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.dll"  
Add - Type - Path "C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.Runtime.dll"  
#Config Parameters  
$SiteURL = "https://sampleharenet.sharepoint.com/sites/classictest"  
$ListName = "PnPCopytoLib"  
$CSVPath = "D:\LibraryDocumentsInventory.csv"  
#Get Credentials to connect  
$Cred = Get - Credential  
Try {  
    #Setup the context  
    $Ctx = New - Object Microsoft.SharePoint.Client.ClientContext($SiteURL)  
    $Ctx.Credentials = New - Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($Cred.UserName, $Cred.Password)  
    #Get the Document Library  
    $List = $Ctx.Web.Lists.GetByTitle($ListName)  
    #Define CAML Query to Get All Files  
    $Query = New - Object Microsoft.SharePoint.Client.CamlQuery  
    $Query.ViewXml = "@<View Scope='RecursiveAll'> < Query > < Where > < And > < Eq > < FieldRef Name = 'FSObjType' / > < Value Type = 'Integer' > 0 < /Value></Eq > < Or > < Eq > < FieldRef Name = 'ArchivalFlag' / > < Value Type = 'Choice' > Yes < /Value></Eq > < Lt > < FieldRef Name = 'Created' / > < Value Type = 'DateTime'  
    IncludeTimeValue = 'True' > " + (get-date).adddays(-365).ToString("  
    yyyy - MM - ddTHH: mm: ssZ ") + " < /Value></Lt > < /Or> < /And> < /Where> < /Query> < /View>"  
    #powershell sharepoint online list all documents  
    $ListItems = $List.GetItems($Query)  
    $Ctx.Load($ListItems)  
    $Ctx.ExecuteQuery()  
    $DataCollection = @()  
    #Iterate through each document in the library  
    ForEach($ListItem in $ListItems) {  
        #Collect data  
        $Data = New - Object PSObject - Property([Ordered] @ {  
            FileName = $ListItem.FieldValues["FileLeafRef"]  
            RelativeURL = $ListItem.FieldValues["FileRef"]  
            CreatedBy = $ListItem.FieldValues["Created_x0020_By"]  
            CreatedOn = $ListItem.FieldValues["Created"]  
            ModifiedBy = $ListItem.FieldValues["Modified_x0020_By"]  
            ModifiedOn = $ListItem.FieldValues["Modified"]  
            FileSize = $ListItem.FieldValues["File_x0020_Size"]  
        })  
        $DataCollection += $Data  
    }  
    $DataCollection  
    #Export Documents data to CSV  
    $DataCollection | Export - Csv - Path $CSVPath - Force - NoTypeInformation  
    Write - host - f Green "Documents Data Exported to CSV!"  
}  
Catch {  
    write - host - f Red "Error:"  
    $_.Exception.Message  
}

#Load SharePoint CSOM Assemblies

Add - Type - Path "C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.dll"

Add - Type - Path "C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.Runtime.dll"

#Config Parameters

$SiteURL = "https://sampleharenet.sharepoint.com/sites/classictest"

$ListName = "PnPCopytoLib"

$CSVPath = "D:\LibraryDocumentsInventory.csv"

#Get Credentials to connect

$Cred = Get - Credential

Try {

#Setup the context

$Ctx = New - Object Microsoft.SharePoint.Client.ClientContext($SiteURL)

$Ctx.Credentials = New - Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($Cred.UserName, $Cred.Password)

#Get the Document Library

$List = $Ctx.Web.Lists.GetByTitle($ListName)

#Define CAML Query to Get All Files

$Query = New - Object Microsoft.SharePoint.Client.CamlQuery

$Query.ViewXml = "@<View Scope='RecursiveAll'> < Query > < Where > < And > < Eq > < FieldRef Name = 'FSObjType' / > < Value Type = 'Integer' > 0 < /Value></Eq > < Or > < Eq > < FieldRef Name = 'ArchivalFlag' / > < Value Type = 'Choice' > Yes < /Value></Eq > < Lt > < FieldRef Name = 'Created' / > < Value Type = 'DateTime'

IncludeTimeValue = 'True' > " + (get-date).adddays(-365).ToString("

yyyy - MM - ddTHH: mm: ssZ ") + " < /Value></Lt > < /Or> < /And> < /Where> < /Query> < /View>"

#powershell sharepoint online list all documents

$ListItems = $List.GetItems($Query)

$Ctx.Load($ListItems)

$Ctx.ExecuteQuery()

$DataCollection = @()

#Iterate through each document in the library

ForEach($ListItem in $ListItems) {

#Collect data

$Data = New - Object PSObject - Property([Ordered] @ {

FileName = $ListItem.FieldValues["FileLeafRef"]

RelativeURL = $ListItem.FieldValues["FileRef"]

CreatedBy = $ListItem.FieldValues["Created_x0020_By"]

CreatedOn = $ListItem.FieldValues["Created"]

ModifiedBy = $ListItem.FieldValues["Modified_x0020_By"]

ModifiedOn = $ListItem.FieldValues["Modified"]

FileSize = $ListItem.FieldValues["File_x0020_Size"]

})

$DataCollection += $Data

}

$DataCollection

#Export Documents data to CSV

$DataCollection | Export - Csv - Path $CSVPath - Force - NoTypeInformation

Write - host - f Green "Documents Data Exported to CSV!"

}

Catch {

write - host - f Red "Error:"

$_.Exception.Message

}

Output

We shall get all the List of Files to be Archived as per the above-highlighed conditions using a Where Clause at your Local Path: D:\LibraryDocumentsInventory.csv

It should contain the following columns:

FileName
RelativeURL
CreatedBy
CreatedOn
ModifiedBy
ModifiedOn
FileSize

Copying all the Scanned Files with their Relative Folder Paths from the Source Library to the Archive Target Library[CopyFiles.ps1]:

#Load SharePoint CSOM Assemblies  
CLS  
Add - Type - Path "C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.dll"  
Add - Type - Path "C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.Runtime.dll"  
#Function to Copy a File  
Function Copy - SPOFile([String] $SourceSiteURL, [String] $SourceFileURL, [String] $TargetFileURL) {  
    Try {  
        #Setup the context  
        $Ctx = New - Object Microsoft.SharePoint.Client.ClientContext($SourceSiteURL)  
        $Ctx.Credentials = New - Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($Credentials.Username, $Credentials.Password)  
        #Copy the File  
        $MoveCopyOpt = New - Object Microsoft.SharePoint.Client.MoveCopyOptions  
        $Overwrite = $True[Microsoft.SharePoint.Client.MoveCopyUtil]::CopyFile($Ctx, $SourceFileURL, $TargetFileURL, $Overwrite, $MoveCopyOpt)  
        $Ctx.ExecuteQuery()  
        Write - host - f Green $TargetFileURL " - File Copied Successfully!"  
    }  
    Catch {  
        write - host - f Red "Error Copying the File!"  
        $_.Exception.Message  
    }  
}  
$RootSiteURL = "https://samplesharenet.sharepoint.com"  
$SourceSiteURL = "https://samplesharenet.sharepoint.com/sites/classictest"  
$TargetSiteURL = "https://samplesharenet.sharepoint.com/sites/testsitearchival"  
$SourceSitePath = "/sites/classictest/"  
$TargetSitePath = "/sites/testsitearchival/"  
$SourceDocLibURL = "/PnPCopytoLib"  
$TargetDocLibURL = "/FlowArchiveLib2"  
#$TargetDocLibURL = "/FlowArchiveLib2/April_3rdWeek"  
for aby Batch wise Archivals  
$Credentials = Get - Credential  
Connect - PnPOnline - Url $TargetSiteURL - Credentials $Credentials  
$CSVPath = "D:\LibraryDocumentsInventory.csv"  
Import - Csv $CSVPath | ForEach - Object {  
    $SourceFileURL = $RootSiteURL + $_.RelativeURL  
    $temp = ($_.RelativeURL).Replace($SourceDocLibURL, $TargetDocLibURL)  
    $temp = ($temp).Replace($SourceSitePath, $TargetSitePath)  
    $TargetFileURL = $RootSiteURL + $temp  
    $temp = ($temp).Replace($TargetSitePath, "")  
    $temp = ($temp).Replace("/" + $_.FileName, "")  
    if ($TargetDocLibURL - ne "/" + $temp) {  
        Resolve - PnPFolder - SiteRelativePath $temp  
    }  
    #Call the  
    function to Copy the File  
    Copy - SPOFile $SourceSiteURL $SourceFileURL $TargetFileURL  
}

#Load SharePoint CSOM Assemblies

CLS

Add - Type - Path "C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.dll"

Add - Type - Path "C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.Runtime.dll"

#Function to Copy a File

Function Copy - SPOFile([String] $SourceSiteURL, [String] $SourceFileURL, [String] $TargetFileURL) {

Try {

#Setup the context

$Ctx = New - Object Microsoft.SharePoint.Client.ClientContext($SourceSiteURL)

$Ctx.Credentials = New - Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($Credentials.Username, $Credentials.Password)

#Copy the File

$MoveCopyOpt = New - Object Microsoft.SharePoint.Client.MoveCopyOptions

$Overwrite = $True[Microsoft.SharePoint.Client.MoveCopyUtil]::CopyFile($Ctx, $SourceFileURL, $TargetFileURL, $Overwrite, $MoveCopyOpt)

$Ctx.ExecuteQuery()

Write - host - f Green $TargetFileURL " - File Copied Successfully!"

}

Catch {

write - host - f Red "Error Copying the File!"

$_.Exception.Message

}

$RootSiteURL = "https://samplesharenet.sharepoint.com"

$SourceSiteURL = "https://samplesharenet.sharepoint.com/sites/classictest"

$TargetSiteURL = "https://samplesharenet.sharepoint.com/sites/testsitearchival"

$SourceSitePath = "/sites/classictest/"

$TargetSitePath = "/sites/testsitearchival/"

$SourceDocLibURL = "/PnPCopytoLib"

$TargetDocLibURL = "/FlowArchiveLib2"

#$TargetDocLibURL = "/FlowArchiveLib2/April_3rdWeek"

for aby Batch wise Archivals

$Credentials = Get - Credential

Connect - PnPOnline - Url $TargetSiteURL - Credentials $Credentials

$CSVPath = "D:\LibraryDocumentsInventory.csv"

Import - Csv $CSVPath | ForEach - Object {

$SourceFileURL = $RootSiteURL + $_.RelativeURL

$temp = ($_.RelativeURL).Replace($SourceDocLibURL, $TargetDocLibURL)

$temp = ($temp).Replace($SourceSitePath, $TargetSitePath)

$TargetFileURL = $RootSiteURL + $temp

$temp = ($temp).Replace($TargetSitePath, "")

$temp = ($temp).Replace("/" + $_.FileName, "")

if ($TargetDocLibURL - ne "/" + $temp) {

Resolve - PnPFolder - SiteRelativePath $temp

}

#Call the

function to Copy the File

Copy - SPOFile $SourceSiteURL $SourceFileURL $TargetFileURL

}

Just give your inputs as per the above-highlighted areas.

Precautions:

Use Only Site Collection Admin/Global Admin Login details for Logging in while the script running is on progress.

Try to hard code with password-protected security string oriented Token Management on the above scripts for no End User manual inputting involvement.

Output

You will find all the listed files from that CSV report which have been selected for Archival created with Meta Data properties preserved on the Target Archive Library.

Creative Idea

You can merge both the above scripts for Automation using Flow/Azure Functions and make them run on a Weekly/Monthly scheduled basis that promotes automation without Manual Intervention.

You can apply the above-discussed process with Large Lists too that needs to be Archived.

Note

Since we have a buffer size limit of 100 MB for a Complete Flow-based Copying of Files we are using PnP + CSOM PowerShell to run evergreen unlimited calls no pricing/no size limitation/metadata preserving, etc.

SharePoint 2013 Hosting – HostForLIFE.eu :: Download a File from SharePoint Document Library

Apr 16th

Posted by Peter in European SharePoint 2013 Hosting

In this blog, you will learn how to download a file from the SharePoint Document Library. First, you need to write a SharePoint file in your ASP.NET application server with the help of the CopyStream Method. Once you write the SharePoint file in the ASP.NET application server, then the user can download the file easily with the help of the Response.TransmitFile. Here is the complete code to download a file from Sharepoint:

protected void DownloadFile(object sender, EventArgs e) {  
    try {  
        string filePath = (sender as LinkButton).CommandArgument;  
        //SharePoint Credentials  
        string username = "sharepoint_user";  
        string password = "sharepoint_password";  
        var securePassword = new SecureString();  
        foreach(char c in password) {  
            securePassword.AppendChar(c);  
        }  
        var onlineCredentials = new NetworkCredential(username, password, "domain");  
        ClientContext clientContext = new ClientContext(filePath);  
        var url = string.Format("{0}", filePath);  
        string userRoot = System.Environment.GetEnvironmentVariable("USERPROFILE");  
        string downloadFolder = Path.Combine(Environment.ExpandEnvironmentVariables("%USERPROFILE%"), "Downloads");  
        WebRequest request = WebRequest.Create(new Uri(url, UriKind.Absolute));  
        request.Credentials = onlineCredentials;  
        WebResponse response = request.GetResponse();  
        Stream fs = response.GetResponseStream() as Stream;  
        using(FileStream localfs = System.IO.File.OpenWrite(Server.MapPath("~/Claim_Documents/") + "/" + Path.GetFileName(filePath))) {  
            CopyStream(fs, localfs);  
        }  
        string filename = Path.GetFileName(filePath);  
        Response.ContentType = "application/octet-stream";  
        Response.AppendHeader("Content-Disposition", "attachment;filename=" + filename);  
        string aaa = Server.MapPath("~/Claim_Documents/" + filename);  
        Response.TransmitFile(Server.MapPath("~/Claim_Documents/" + filename));  
        Response.End();  
    } catch (Exception ex) {  
        lblmsg.Text = ex.Message;  
    }  
}

protected void DownloadFile(object sender, EventArgs e) {

try {

string filePath = (sender as LinkButton).CommandArgument;

//SharePoint Credentials

string username = "sharepoint_user";

string password = "sharepoint_password";

var securePassword = new SecureString();

foreach(char c in password) {

securePassword.AppendChar(c);

}

var onlineCredentials = new NetworkCredential(username, password, "domain");

ClientContext clientContext = new ClientContext(filePath);

var url = string.Format("{0}", filePath);

string userRoot = System.Environment.GetEnvironmentVariable("USERPROFILE");

string downloadFolder = Path.Combine(Environment.ExpandEnvironmentVariables("%USERPROFILE%"), "Downloads");

WebRequest request = WebRequest.Create(new Uri(url, UriKind.Absolute));

request.Credentials = onlineCredentials;

WebResponse response = request.GetResponse();

Stream fs = response.GetResponseStream() as Stream;

using(FileStream localfs = System.IO.File.OpenWrite(Server.MapPath("~/Claim_Documents/") + "/" + Path.GetFileName(filePath))) {

CopyStream(fs, localfs);

}

string filename = Path.GetFileName(filePath);

Response.ContentType = "application/octet-stream";

Response.AppendHeader("Content-Disposition", "attachment;filename=" + filename);

string aaa = Server.MapPath("~/Claim_Documents/" + filename);

Response.TransmitFile(Server.MapPath("~/Claim_Documents/" + filename));

Response.End();

} catch (Exception ex) {

lblmsg.Text = ex.Message;

}

SharePoint 2013 Hosting – HostForLIFE.eu :: Daterange Picker in SPFX Web Part

Apr 9th

Posted by Peter in European SharePoint 2013 Hosting

Sometimes you have a requirement to allow a user to select a date range, but the react office fabric UI does not provide any control for selecting the date range. Therefore, you need to use a third party datepicker control supported in react. Here is a third party control for daterange picker:

https://www.npmjs.com/package/@wojtekmaj/react-daterange-picker

You need to install the below npm package in order to use this daterange picker:

npm i @wojtekmaj/react-daterange-picker

1	npm i @wojtekmaj/react-daterange-picker

Once you have installed package, you need to import your code as below:

import DateRangePicker from '@wojtekmaj/react-daterange-picker';

1	import DateRangePicker from '@wojtekmaj/react-daterange-picker';

Now you will be able to use date range picker in the render method, as shown below:

<DateRangePicker
onChange={this.onChange}
value={this.state.date}
/>

<DateRangePicker

onChange={this.onChange}

value={this.state.date}

There are also many other properties for this control, you can find that properties in the above-given URL.

Issue with IE browser

When you add DateRange Picker control to your SPFx web part, it will work fine in all browsers. However, it will create an issue for the Internet Explorer browser.

It will block your full web part from being displayed, so we will not load it in the IE browser.

To resolve this issue, you need to install npm package for polyfill using below command,

npm install polyfill

1	npm install polyfill

Once you have installed this package you need to add the below line of code after we have imported the daterange picker.

require('polyfill');

1	require('polyfill');

Now in the config.json file, add the below line of code in the externals section.

"polyfill": {


"path" : "https://cdn.polyfill.io/v3/polyfill.min.js?features=default,Array.prototype.includes,Array.prototype.find",


"globalName": "polyfill"


}

"polyfill": {

"path" : "https://cdn.polyfill.io/v3/polyfill.min.js?features=default,Array.prototype.includes,Array.prototype.find",

"globalName": "polyfill"

}

Now your web part will work in the IE browser. I hope this blog will help you!

SharePoint 2013 Hosting – HostForLIFE.eu :: Programmatically “Apply Label To Items In List Or Library”

SharePoint 2013 Hosting – HostForLIFE.eu :: CSS in SPFx

CSSType

Conclusion

SharePoint 2013 Hosting – HostForLIFE.eu :: Create List Item Using PnP JS In SharePoint Framework

@pnp/sp

Create List Item

Deploy the solution

Test the webpart

Summary

SharePoint 2013 Hosting – HostForLIFE.eu :: Automation of Archival Large Libraries through Flow

SharePoint 2013 Hosting – HostForLIFE.eu :: Download a File from SharePoint Document Library

SharePoint 2013 Hosting – HostForLIFE.eu :: Daterange Picker in SPFX Web Part

Issue with IE browser

BLOGROLL

Featured On

European Sharepoint 2013 Hosting Blog

SharePoint 2013 Hosting – HostForLIFE.eu :: Programmatically “Apply Label To Items In List Or Library”

SharePoint 2013 Hosting – HostForLIFE.eu :: CSS in SPFx

CSSType

Conclusion

SharePoint 2013 Hosting – HostForLIFE.eu :: Create List Item Using PnP JS In SharePoint Framework

@pnp/sp

Create List Item

Deploy the solution

Test the webpart

Summary

SharePoint 2013 Hosting – HostForLIFE.eu :: Automation of Archival Large Libraries through Flow

SharePoint 2013 Hosting – HostForLIFE.eu :: Download a File from SharePoint Document Library

SharePoint 2013 Hosting – HostForLIFE.eu :: Daterange Picker in SPFX Web Part

Issue with IE browser

BLOGROLL

Featured On

Tags