当前位置:网站首页 > 更多 > 玩电脑 > 正文

[玩转系统] SharePoint Online:使用 PowerShell 从 CSV 文件更新列表项

作者:精品下载站 日期:2024-12-15 00:02:45 浏览:16 分类:玩电脑

SharePoint Online:使用 PowerShell 从 CSV 文件更新列表项


要求:使用 PowerShell 从 CSV 更新 SharePoint Online 列表。

PowerShell 从 CSV 文件更新 SharePoint Online 列表

您是否曾经需要从 CSV 文件更新 SharePoint Online 列表项?也许您需要对列表数据进行一些批量编辑。在本指南中,我们将向您展示如何使用 PowerShell 从 CSV 文件轻松更新 SharePoint Online 列表数据。

我们有一个名为“项目”的列表,其中包含一堆列,并且想要更新 CSV 文件中的项目。以下是用于从 CSV 更新 SharePoint Online 列表的 PowerShell CSOM 脚本:

[玩转系统] SharePoint Online:使用 PowerShell 从 CSV 文件更新列表项

用于从 CSV 更新列表项的 PowerShell 脚本:

在脚本中设置参数,确保 CSV 列与 SharePoint Online 列表中的相应字段内部名称进行映射,然后运行脚本:


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

#Parameters
$SiteURL = "https://crescent.sharepoint.com/sites/PMO"
$ListName= "Projects"
$CSVFile = "C:\Temp\ListData.csv"

#Setup Credentials to connect
$Cred = Get-Credential
 
Try {
    #Get the data from CSV file
    $CSVData = Import-CSV $CSVFile

    #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 List
    $List = $Ctx.Web.Lists.GetByTitle($ListName)
    $Ctx.Load($List)
    $Ctx.ExecuteQuery()

    #Loop through each Row in the CSV file and update the matching list item based on "ID"
    ForEach($Row in $CSVData)
    {
        Try {
            #Get list item to update
            $ListItem = $List.GetItemById($Row.ID)
            $Ctx.Load($ListItem)
            $Ctx.ExecuteQuery()

            #Update List Item
            $ListItem["ProjectName"] = $Row.'Project Name'
            $ListItem["IsActive"] = $Row.'Is Active'
            $ListItem["Start_x0020_Date"] = $Row.'Start Date'
            $ListItem["Status"] = $Row.'Status'
            $ListItem.Update()
            Write-host "Updated List Item:"$Row.ID
        }
        Catch {
            write-host "Error Updating Item $($Row.ID): $($_.Exception.InnerException.Message)" -foregroundcolor Yellow
        }
    }
}
Catch {
    write-host "Error: $($_.Exception.Message)" -foregroundcolor Red
}

该脚本适用于简单的字段类型,例如单行文本、多行文本、日期和时间、是/否等。如果您有一个包含复杂字段类型(例如人员或组、超链接或图片)的庞大列表,该怎么办?托管元数据、查找,并且您必须使用 PowerShell 从 CSV 更新列表项。这是我要更新的列表:

[玩转系统] SharePoint Online:使用 PowerShell 从 CSV 文件更新列表项

列表结构:

[玩转系统] SharePoint Online:使用 PowerShell 从 CSV 文件更新列表项

您知道,逐一更新列表可能是一项艰巨的任务。值得庆幸的是,PowerShell 通过从 CSV 文件导入数据,可以轻松地使您的列表保持最新状态。这是我的 CSV 文件,其中包含要更新的数据:

[玩转系统] SharePoint Online:使用 PowerShell 从 CSV 文件更新列表项

您可以在此处下载此 CSV 文件:

用于从 CSV 更新列表项的 PowerShell 脚本:

只需设置参数并确保数据的格式与 CSV 文件中的格式正确即可。列表项将使用给定 CSV 文件中的匹配 ID 字段值进行更新。


#Config Variables
$SiteURL = "https://crescent.sharepoint.com/sites/projects"
$ListName = "Projects"
$CSVFilePath = "C:\Temp\ListData.csv"
 
#Function to get Lookup ID from Lookup Value
Function Get-LookupID($ListName, $LookupFieldName, $LookupValue)
{
    #Get Parent Lookup List and Field from Child Lookup Field's Schema XML
    $LookupField =  Get-PnPField -List $ListName -Identity $LookupFieldName
    [Xml]$Schema = $LookupField.SchemaXml
    $ParentListID = $Schema.Field.Attributes["List"].'#text'
    $ParentField  = $Schema.field.Attributes["ShowField"].'#text'
    $ParentLookupItem  = Get-PnPListItem -List $ParentListID -Fields $ParentField | Where {$_[$ParentField] -eq $LookupValue} | Select -First 1
  
    If($ParentLookupItem -ne $Null)
    {
        #Get the Parent Item ID
        Return $ParentLookupItem["ID"]
    }
    Else
    {
        Return $Null
    }
}
 
Try {
    #Connect to the Site
    Connect-PnPOnline -URL $SiteURL -Interactive
 
    #Get the data from CSV file
    $CSVData = Import-CSV $CSVFilePath
 
    #Get the List
    $List = Get-PnPList -Identity $ListName
     
    #Get fields to Update from the List - Skip Read only, hidden fields, content type and attachments
    $ListFields = Get-PnPField -List $ListName | Where { (-Not ($_.ReadOnlyField)) -and (-Not ($_.Hidden)) -and ($_.InternalName -ne  "ContentType") -and ($_.InternalName -ne  "Attachments") }
      
    #Loop through each Row in the CSV file and update the matching list item ID
    ForEach($Row in $CSVData)
    {
        #Get the List Item to update
        $ListItem = Get-PnPListItem -List $List -Id $Row.ID -ErrorAction SilentlyContinue
        If($ListItem -ne $Null)
        {
            $ItemValue = @{}            
            $CSVFields = $Row | Get-Member -MemberType NoteProperty | Select -ExpandProperty Name
            #Map each field from CSV to target list
            Foreach($CSVField in $CSVFields)
            {
                $MappedField = $ListFields | Where {$_.InternalName -eq $CSVField}
                If($MappedField -ne $Null)
                {
                    $FieldName = $MappedField.InternalName
                    #Check if the Field value is not Null
                    If($Row.$CSVField -ne $Null)
                    {
                        #Handle Special Fields
                        $FieldType  = $MappedField.TypeAsString 
                        If($FieldType -eq "User" -or $FieldType -eq "UserMulti") #People Picker Field
                        {
                            $PeoplePickerValues = $Row.$FieldName.Split(",")
                            $ItemValue.add($FieldName,$PeoplePickerValues)
                        }
                        ElseIf($FieldType -eq "Lookup" -or $FieldType -eq "LookupMulti") #Lookup Field
                        {
                            $LookupIDs = $Row.$FieldName.Split(",") | ForEach-Object { Get-LookupID -ListName $ListName -LookupFieldName $FieldName -LookupValue $_ }                
                            $ItemValue.Add($FieldName,$LookupIDs)
                        }
                        ElseIf($FieldType -eq "URL") #Hyperlink
                        {
	                        $URL = $Row.$FieldName.Split(",")[0]
	                        $Description = $Row.$FieldName.Split(",")[1]
                            $ItemValue.Add($FieldName,"$URL, $Description")
                        }
                        ElseIf($FieldType -eq "TaxonomyFieldType" -or $FieldType -eq "TaxonomyFieldTypeMulti") #MMS
                        {
                            $Terms = $Row.$FieldName.Split(",")
                            $ItemValue.Add($FieldName,$Terms)
                        }
                        Else
                        {
                            #Get Source Field Value and add to Hashtable
                            $ItemValue.Add($FieldName,$Row.$FieldName)
                        }
                    }
                }
            }
            Write-host "Updating List item ID $($Row.ID) with value:"
            $ItemValue | Format-Table
            #Update List Item value
            Set-PnPListItem -List $ListName -Identity $Row.ID -Values $ItemValue | Out-Null
        }
        Else
        {
            Write-host "Could not find item ID $($Row.ID) in the list, Skipped!" -f Yellow
        }
    }
}
Catch {
    write-host "Error: $($_.Exception.Message)" -foregroundcolor Red
}
注意:确保您的 CSV 列名称与列表列内部名称完全匹配。

请注意,此脚本会更新给定 CSV 文件中的现有列表项。如果要从 CSV 文件导入(添加新项目),请使用:SharePoint Online:使用 PowerShell 将 CSV 文件导入 SharePoint 列表

您需要 登录账户 后才能发表评论

取消回复欢迎 发表评论:

关灯