Command

Get-PropertyMapping

Description

The command to get the property mappings from a source and destination list pair.

Examples

Get mappings from a source list and a destination list

# Connect to the source and destination sites
$srcSite = Connect-Site -Url "http://myfarm1/sites/mysourcesite"
$dstSite = Connect-Site -Url "http://myfarm1/sites/mydestinationsite"

# Retrieve the source list from the source site
$srcList = Get-List -Name "mysrclist" -Site $srcSite

# Retrieve the destination list from the destination site
$dstList = Get-List -Name "mydstlist" -Site $dstSite

# Retrieve existing property mappings between the source and destination lists
$mappingSettings = Get-PropertyMapping -SourceList $srcList -DestinationList $dstList

# Display the retrieved property mappings
$mappingSettings

# Example output:
# PropertyMappings        :     Author        -> Author
#                           KEY Created       -> Created
#                               Editor        -> Editor
#                               Modified      -> Modified
#                               <NO SOURCE>   -> MultipleColumn
#                               MyCustomField -> MyCustomField
#                           KEY Title         -> Title
# ContentTypeMappings     : 
# UserAndGroupMappings    : 
# PermissionLevelMappings : 
# SiteTemplateMappings    :

Get mappings from the file system and a destination list

# Connect to the destination site
$dstSite = Connect-Site -Url "http://myfarm1/sites/mydestinationsite"

# Retrieve the destination list from the destination site
$dstList = Get-List -Name "mydstlist" -Site $dstSite

# Load property mappings from a file system and associate them with the destination list
$mappingSettings = Get-PropertyMapping -FromFileSystem -DestinationList $dstList

# Display the retrieved property mappings
$mappingSettings

# Example output:
# PropertyMappings        :     Author      -> Author
#                           KEY Created     -> Created
#                               Editor      -> Editor
#                               Modified    -> Modified
#                               <NO SOURCE> -> MultipleColumn
#                               <NO SOURCE> -> MyCustomField
#                           KEY Title       -> Title
# ContentTypeMappings     : 
# UserAndGroupMappings    : 
# PermissionLevelMappings : 
# SiteTemplateMappings    :

Merge mappings with mappings from source list and destination list

# Set an initial property mapping for multiple source columns to a single destination column
$mappingSettings = Set-PropertyMapping -Source Col1,Col2,Col3 -Destination MultipleColumn

# Connect to the source and destination sites
$srcSite = Connect-Site -Url "http://myfarm1/sites/mysourcesite"
$dstSite = Connect-Site -Url "http://myfarm1/sites/mydestinationsite"

# Retrieve the source list from the source site
$srcList = Get-List -Name "mysrclist" -Site $srcSite

# Retrieve the destination list from the destination site
$dstList = Get-List -Name "mydstlist" -Site $dstSite

# Retrieve the property mappings, merging the initial mapping settings with the source and destination lists
$mappingSettings = Get-PropertyMapping -MappingSettings $mappingSettings -SourceList $srcList -DestinationList $dstList

# Display the final property mappings
$mappingSettings

# Example output:
# PropertyMappings        :     Author        -> Author
#                           KEY Created       -> Created
#                               Editor        -> Editor
#                               Modified      -> Modified
#                               Col1          -> MultipleColumn
#                               Col2          -> ───────┘
#                               Col3          -> ───────┘
#                               MyCustomField -> MyCustomField
#                           KEY Title         -> Title
# ContentTypeMappings     : 
# UserAndGroupMappings    : 
# PermissionLevelMappings : 
# SiteTemplateMappings    :

Get mappings from Box and a destination list

# Connect to the Box environment using an admin account
$box = Connect-Box -Email [email protected] -Admin

# Connect to the destination site
$dstSite = Connect-Site -Url "http://myfarm1/sites/mydestinationsite"

# Retrieve the destination list from the destination site
$dstList = Get-List -Name "mydstlist" -Site $dstSite

# Retrieve property mappings between the Box environment and the destination list
$mappingSettings = Get-PropertyMapping -Box $box -DestinationList $dstList

# Display the retrieved property mappings
$mappingSettings

# Example output:
# PropertyMappings        :     Author                -> Author
#                           KEY Created               -> Created
#                               Editor                -> Editor
#                               Modified              -> Modified
#                               MetadataTemplate_Text -> MetadataTemplate_Text
#                               <NO SOURCE>           -> MyCustomField
#                           KEY Title                 -> Title
# ContentTypeMappings     : 
# UserAndGroupMappings    : 
# PermissionLevelMappings : 
# SiteTemplateMappings    :

Syntax

Get-PropertyMapping-SourceList <List> -DestinationList <List> 
[-MappingSettings <MappingSettings>]

Get-PropertyMapping-FromFileShare <SwitchParameter> -DestinationList <List>
[-MappingSettings <MappingSettings>]

Get-PropertyMapping-Box <BoxInfo> -DestinationList <List>
[-MappingSettings <MappingSettings>]

Parameters

-Box <BoxInfo>

Specifies the source Box.

Required?	True
Default value	None
Accept pipeline input?	True (ByValue, ByPropertyName)
Accept wildcard characters?	False
Parameter set name	Box
Aliases	None

-DestinationList <List>

Specifies the destination list.

Required?	True
Default value	None
Accept pipeline input?	False
Accept wildcard characters?	False
Parameter set name	(All)
Aliases	None

-FromFileSystem <SwitchParameter>

Specifies that the source is the file system.

Required?	True
Default value	None
Accept pipeline input?	False
Accept wildcard characters?	False
Parameter set name	FileSystem
Aliases	None

-MappingSettings <MappingSettings>

Specifies the mapping settings.

Required?	False
Default value	None
Accept pipeline input?	True (ByValue, ByPropertyName)
Accept wildcard characters?	False
Parameter set name	(All)
Aliases	None

-SourceList <List>

Specifies the source list.

Required?	True
Default value	None
Accept pipeline input?	False
Accept wildcard characters?	False
Parameter set name	Default
Aliases	None