Kategoriarkiv: PowerShell

Export SharePoint List Data To Xml through PowerShell

Today my colleague Johannes Milling wrote an awesome post:

Export SharePoint List Data To XML Directly from the GUI

He uses the old and forgotten RPC-based web service owssvr.dll (that has existed since SharePoint 2003). This url pattern is used to get the xml-formatted list data for a specific ListView:

http://&lt;site_url&gt;/_vti_bin/owssvr.dll?Cmd=Display&amp;List=&lt;list guid&gt;&amp;View=&lt;view guid&gt;&amp;Query=*&amp;XMLDATA=TRUE

1	http://<site_url>/_vti_bin/owssvr.dll?Cmd=Display&List=<list guid>&View=<view guid>&Query=*&XMLDATA=TRUE

To automate this I have written a PowerShell function. All the details are in the comments:

function Export-OIPSPListDataAsXml {
&lt;#
.Synopsis
   Exports list items as xml
.DESCRIPTION
   This function uses a built-in hidden service owssvr.dll in SharePoint
.PARAMETER Web
   SPWeb or a url for the SPWeb object where the list resides
.PARAMETER ListName
   List Name (List Title)
.PARAMETER ViewName
   Name of the List View to export the data
.EXAMPLE
   Export-OIPSPListView -Web http://myawesomesite -ListName &quot;Teddy Bears&quot; -ViewName &quot;All Items&quot;
.EXAMPLE
   Export-OIPSPListView -Web $webInstance -ListName &quot;Top Links&quot; -ViewName &quot;All Items&quot;
.Notes
    Name: Export-OIPSPListDataAsXml
    Author: Anatoly Mironov
    Last Edit: 2014-09-11
    Keywords: SPList, SPWeb, SPListView, Xml
.Link

http://chuvash.eu

#&gt;
    [CmdLetBinding()]
    param(
	[Parameter(Mandatory=$true)]
    [Microsoft.SharePoint.PowerShell.SPWebPipeBind]$Web,
    [Parameter(Mandatory=$true)]
    [string]$ListName,
    [Parameter(Mandatory=$true)]
    [string]$ViewName)

    $spWeb = $Web.Read()
    $list = $spWeb.Lists[$ListName]
    if (!$list) { throw &quot;List $ListName on web $($spWeb.Url) could not be found&quot; }
    $view = $list.Views[$ViewName]
    if (!$view) { throw &quot;View $ViewName on web $ListName could not be found&quot; }
    $url = &quot;{0}/_vti_bin/owssvr.dll?Cmd=Display&amp;List={1}&amp;View={2}&amp;Query=*&amp;XMLDATA=TRUE&quot; `
            -f $spWeb.Url, $list.ID, $view.ID
    $wc = New-Object Net.WebClient
    $wc.UseDefaultCredentials = $true
    $wc.DownloadString($url)
}

function Export-OIPSPListDataAsXml {

.Synopsis

Exports list items as xml

.DESCRIPTION

This function uses a built-in hidden service owssvr.dll in SharePoint

.PARAMETER Web

SPWeb or a url for the SPWeb object where the list resides

.PARAMETER ListName

List Name (List Title)

.PARAMETER ViewName

Name of the List View to export the data

.EXAMPLE

Export-OIPSPListView -Web http://myawesomesite -ListName "Teddy Bears" -ViewName "All Items"

.EXAMPLE

Export-OIPSPListView -Web $webInstance -ListName "Top Links" -ViewName "All Items"

.Notes

Name: Export-OIPSPListDataAsXml

Author: Anatoly Mironov

Last Edit: 2014-09-11

Keywords: SPList, SPWeb, SPListView, Xml

.Link

http://chuvash.eu

[CmdLetBinding()]

param(

[Parameter(Mandatory=$true)]

[Microsoft.SharePoint.PowerShell.SPWebPipeBind]$Web,

[Parameter(Mandatory=$true)]

[string]$ListName,

[Parameter(Mandatory=$true)]

[string]$ViewName)

$spWeb = $Web.Read()

$list = $spWeb.Lists[$ListName]

if (!$list) { throw "List $ListName on web $($spWeb.Url) could not be found" }

$view = $list.Views[$ViewName]

if (!$view) { throw "View $ViewName on web $ListName could not be found" }

$url = "{0}/_vti_bin/owssvr.dll?Cmd=Display&List={1}&View={2}&Query=*&XMLDATA=TRUE" `

-f $spWeb.Url, $list.ID, $view.ID

$wc = New-Object Net.WebClient

$wc.UseDefaultCredentials = $true

$wc.DownloadString($url)

}

Unhide a hidden SPField using PowerShell

Another task that’s much harder than it should be. Setting the hidden property of a SPField to false.

First you get the field itself. In this example we change the setting of the field in the library, but it could just as well be done on the site level.

$web = Get-SPWeb http://MyWeb
$list = $web.Lists["MyList"]
$field = $list.Fields.GetFieldByInternalName("MyField")

$web = Get-SPWeb http://MyWeb

$list = $web.Lists["MyList"]

$field = $list.Fields.GetFieldByInternalName("MyField")

Then, when you have the actual field, you just need a bit of reflection magic.

$type = $field.GetType()
$mi = $type.GetMethod("SetFieldBoolValue",[System.Reflection.BindingFlags]$([System.Reflection.BindingFlags]::NonPublic -bor [System.Reflection.BindingFlags]::Instance))
$mi.Invoke($field, @("CanToggleHidden",$true))
$field.Hidden=$false
$field.Update()

$type = $field.GetType()

$mi = $type.GetMethod("SetFieldBoolValue",[System.Reflection.BindingFlags]$([System.Reflection.BindingFlags]::NonPublic -bor [System.Reflection.BindingFlags]::Instance))

$mi.Invoke($field, @("CanToggleHidden",$true))

$field.Hidden=$false

$field.Update()

I don’t know why, but simply setting field.Hidden = $false doesn’t work. But the code above does!

Solution comes from here.

Load git into PowerShell

Just a little productivity tip. If you use git on Windows, you probably already have the Github for Windows application. This application adds the Git Shell:

The Git Shell will open a PowerShell window and execute shell.ps1 from the Github directory:

What it won’t do is to load your personal PowerShell profile. I want to use my PowerShell profile that creates some links and adjust the look-and-feel and the promt of the shell. By the way I have published my profile.ps1 as a gist:

my profile.ps1

I also want to have git in PowerShell available directly. The answer is in the shell.ps1 in the Github folder:

So add this line to your profile.ps1 as I did:

. (Resolve-Path &quot;$env:LOCALAPPDATA\GitHub\shell.ps1&quot;)

1	. (Resolve-Path "$env:LOCALAPPDATA\GitHub\shell.ps1")

That’s it. If you haven’t seen the “DOT” in PowerShell scripts, it is called dot sourcing, it will execute the script and keep all the variables and references within the script.

An alternative

If you do not have Github for Windows, there is another way to load git functionality into PowerShell:

Downloading and Making git module available in PowerShell