Imagine Think Create Share : Powershell

How to: Programmatically read the ChangeLog in PowerShell

carloshm — Fri, 05 Jun 2009 15:33:00 GMT

Hi,

When I was working to get powershell scripts from MSDN samples to get/set information, I created too one for reading the changelog. It was a bit tricky to build, but I manage to port Querying for specific changes to PowerShell.

You can review the changelog API in the Microsoft SharePoint Developer Documentation Team Blog and MSDN (previous link):

We wanted to monitor which changes were been read by the crawl process and been able to filter specific changes.

## SharePoint Reference [void][System.Reflection.Assembly]::LoadWithPartialName("Microsoft.SharePoint") [void][System.Reflection.Assembly]::LoadWithPartialName("Microsoft.SharePoint.Administration") [void][System.Reflection.Assembly]::LoadWithPartialName("Microsoft.Office.Server.Search.Administration") [void][System.Reflection.Assembly]::LoadWithPartialName("Microsoft.Office.Server.Search") [void][System.Reflection.Assembly]::LoadWithPartialName("Microsoft.Office.Server")

function global:Get-ChangeLog($url, $minutes, $changetype)
{
trap [Exception] {
  write-error $("ERROR: " + $_.Exception.GetType().FullName);
  write-error $("ERROR: " + $_.Exception.Message);

  continue;
}

$s = new-Object Microsoft.SharePoint.SPSite($url);
$startTime = [System.DateTime]::Now.Subtract([System.TimeSpan]::FromMinutes($minutes));

$db_id = [Microsoft.SharePoint.Administration.SPContentDatabase].getmethod("get_Id");
$result_id = $db_id.Invoke($s.ContentDatabase, "instance,public", $null, $null, $null);

$db_CurrentChangeToken = [Microsoft.SharePoint.Administration.SPContentDatabase].getmethod("get_CurrentChangeToken");
$result_CurrentChangeToken = $db_CurrentChangeToken.Invoke($s.ContentDatabase, "instance,public", $null, $null, $null);

$startToken = New-Object Microsoft.SharePoint.SPChangeToken([Microsoft.SharePoint.SPChangeCollection+CollectionScope]::ContentDB, $result_id.ToString(), $startTime);

$changeQuery = New-Object Microsoft.SharePoint.SPChangeQuery($False, $False);
$changeQuery.User = $True;
$changeQuery.ContentType = $True;
$changeQuery.Add = $True;
$changeQuery.Delete = $True;
$changeQuery.Field = $True;
$changeQuery.File = $True;
$changeQuery.Folder = $True;
$changeQuery.Group = $True;
$changeQuery.GroupMembershipAdd = $True;
$changeQuery.GroupMembershipDelete = $True;
$changeQuery.Item = $True;
$changeQuery.List = $True;
$changeQuery.Move = $True;
$changeQuery.Rename = $True;
$changeQuery.Site = $True;
$changeQuery.SystemUpdate = $True;
$changeQuery.Update = $True;

$changeQuery.ChangeTokenStart = $startToken;
$changeQuery.ChangeTokenEnd = $result_CurrentChangeToken;

$db_GetChanges = [Microsoft.SharePoint.Administration.SPContentDatabase].getmethod("GetChanges", [Microsoft.SharePoint.SPChangeQuery]);
$result_GetChanges = $db_GetChanges.Invoke($s.ContentDatabase, "instance,public", $null, $changeQuery, $null);

write-Output $result_GetChanges | Where-Object { $_.ChangeType -eq $changetype };

$s.Dispose();
}

Get-ChangeLog -url http://your_site_url -minutes 120 -changetype Add

Take into account that the time will get changes based on UTC

Bye!

How to: Programmatically Manage the Crawl of a Content Source in PowerShell

carloshm — Tue, 31 Mar 2009 19:53:00 GMT

Hi,

If you have read my previous post you may think, why did you stop there? Well, that is what I thought too :), and started with this article from MSDN.

We wanted to start managing the crawling of our content source more programmatically, as we have seen that running several at the same time affects the overall process.

So running these powershell scripts as scheduled task and monitoring the status can improve in crawling.

You may improve them reusing the context and content sources and doing some pipeline

to be included in the overall file:

## SharePoint Reference
[void][System.Reflection.Assembly]::LoadWithPartialName("Microsoft.SharePoint")
[void][System.Reflection.Assembly]::LoadWithPartialName("Microsoft.SharePoint.Administration")
[void][System.Reflection.Assembly]::LoadWithPartialName("Microsoft.Office.Server.Search.Administration")
[void][System.Reflection.Assembly]::LoadWithPartialName("Microsoft.Office.Server.Search")
[void][System.Reflection.Assembly]::LoadWithPartialName("Microsoft.Office.Server")

To start an incremental crawl of the content source

function global:StartIncremental-Crawl($url, $csname)
{
trap [Exception] {
  write-error $("ERROR: " + $_.Exception.GetType().FullName);
  write-error $("ERROR: " + $_.Exception.Message);

  continue;
}

$s = new-Object Microsoft.SharePoint.SPSite($url);
$c = [Microsoft.Office.Server.Search.Administration.SearchContext]::GetContext($s);
$sc = new-Object Microsoft.Office.Server.Search.Administration.Content($c);

$cs = $sc.ContentSources[$csname];

$cs.StartIncrementalCrawl();

$s.Dispose();
}

StartIncremental-Crawl -url http://your_site_url -csname "your content source name"

To start a full crawl of the content source

function global:StartFull-Crawl($url, $csname)
{
trap [Exception] {
  write-error $("ERROR: " + $_.Exception.GetType().FullName);
  write-error $("ERROR: " + $_.Exception.Message);

  continue;
}

$s = new-Object Microsoft.SharePoint.SPSite($url);
$c = [Microsoft.Office.Server.Search.Administration.SearchContext]::GetContext($s);
$sc = new-Object Microsoft.Office.Server.Search.Administration.Content($c);

$cs = $sc.ContentSources[$csname];

$cs.StartFullCrawl();

$s.Dispose();
}

StartFull-Crawl -url http://your_site_url -csname "your content source name"

To pause a crawl in process

function global:Pause-Crawl($url, $csname)
{
trap [Exception] {
  write-error $("ERROR: " + $_.Exception.GetType().FullName);
  write-error $("ERROR: " + $_.Exception.Message);

  continue;
}

$s = new-Object Microsoft.SharePoint.SPSite($url);
$c = [Microsoft.Office.Server.Search.Administration.SearchContext]::GetContext($s);
$sc = new-Object Microsoft.Office.Server.Search.Administration.Content($c);

$cs = $sc.ContentSources[$csname];

$cs.PauseCrawl();

$s.Dispose();
}

Pause-Crawl -url http://your_site_url -csname "your content source name"

To resume a paused crawl

function global:Resume-Crawl($url, $csname)
{
trap [Exception] {
  write-error $("ERROR: " + $_.Exception.GetType().FullName);
  write-error $("ERROR: " + $_.Exception.Message);

  continue;
}

$s = new-Object Microsoft.SharePoint.SPSite($url);
$c = [Microsoft.Office.Server.Search.Administration.SearchContext]::GetContext($s);
$sc = new-Object Microsoft.Office.Server.Search.Administration.Content($c);

$cs = $sc.ContentSources[$csname];

$cs.ResumeCrawl();

$s.Dispose();
}

Resume-Crawl -url http://your_site_url -csname "your content source name"

To stop a crawl of the content source

function global:Stop-Crawl($url, $csname)
{
trap [Exception] {
  write-error $("ERROR: " + $_.Exception.GetType().FullName);
  write-error $("ERROR: " + $_.Exception.Message);

  continue;
}

$s = new-Object Microsoft.SharePoint.SPSite($url);
$c = [Microsoft.Office.Server.Search.Administration.SearchContext]::GetContext($s);
$sc = new-Object Microsoft.Office.Server.Search.Administration.Content($c);

$cs = $sc.ContentSources[$csname];

$cs.StopCrawl();

$s.Dispose();
}

Stop-Crawl -url http://your_site_url -csname "your content source name"

To check the crawl status values for a content source

function global:Get-CrawlStatus($url)
{
trap [Exception] {
  write-error $("ERROR: " + $_.Exception.GetType().FullName);
  write-error $("ERROR: " + $_.Exception.Message);

  continue;
}

$s = new-Object Microsoft.SharePoint.SPSite($url);
$c = [Microsoft.Office.Server.Search.Administration.SearchContext]::GetContext($s);
$sc = new-Object Microsoft.Office.Server.Search.Administration.Content($c);

Write-Output $sc.ContentSources;

$s.Dispose();
}

Get-CrawlStatus -url http://your_site_url | Format-Table -property CrawlStatus, CrawlStarted, CrawlCompleted

Enjoy!

How to: Programmatically Export the Crawl History to a CSV File in PowerShell

carloshm — Tue, 31 Mar 2009 18:51:00 GMT

Hi,

When I came across the article at MSDN How to: Programmatically Export the Crawl History to a CSV File I thought I would never create such a tool just for that specific feature, as you end up with additional requirements in order to create an admin tool.

But today I needed to get data from crawl history, and I didn't want to get them from SQL (remember it is not supported ;)), so I started to write down a simple powershell script to do it. And then I realized that for this atomic actions, indeed it is a great options!: you give admin people multiple commands that they can use/combine to monitor/get information about the environment (and yes many, many things more)

## SharePoint Reference
[void][System.Reflection.Assembly]::LoadWithPartialName("Microsoft.SharePoint")
[void][System.Reflection.Assembly]::LoadWithPartialName("Microsoft.SharePoint.Administration")
[void][System.Reflection.Assembly]::LoadWithPartialName("Microsoft.Office.Server.Search.Administration")
[void][System.Reflection.Assembly]::LoadWithPartialName("Microsoft.Office.Server.Search")
[void][System.Reflection.Assembly]::LoadWithPartialName("Microsoft.Office.Server")

function global:Get-CrawlHistory($url)
{
trap [Exception] {
  write-error $("ERROR: " + $_.Exception.GetType().FullName);
  write-error $("ERROR: " + $_.Exception.Message);

  continue;
}

$s = new-Object Microsoft.SharePoint.SPSite($url);
$c = [Microsoft.Office.Server.Search.Administration.SearchContext]::GetContext($s);
$h = new-Object Microsoft.Office.Server.Search.Administration.CrawlHistory($c);

Write-OutPut $h.GetCrawlHistory();

$s.Dispose();
}

Then you can just execute: Get-CrawlHistory -url http://your_site_url/ | Export-Csv your_path_and_file_name

Then you can import to excel and make some charts.

In order to filter the information some useful columns should be denormalized: CrawlType, ContentSourceID, Status.

Cheers!