Export (0) Print
Expand All

Import-SPBusinessDataCatalogModel

 

Applies to: SharePoint Server 2013 Enterprise, SharePoint Foundation 2013

Topic Last Modified: 2014-02-11

Imports a Business Data Connectivity Model.

Import-SPBusinessDataCatalogModel -Identity <MetadataObject> -Path <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-LocalizedNamesIncluded <SwitchParameter>] [-ModelsIncluded <SwitchParameter>] [-PermissionsIncluded <SwitchParameter>] [-PropertiesIncluded <SwitchParameter>] [-SettingId <String>] [-WhatIf [<SwitchParameter>]]
Import-SPBusinessDataCatalogModel -Path <String> -ServiceContext <SPServiceContextPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-LocalizedNamesIncluded <SwitchParameter>] [-ModelsIncluded <SwitchParameter>] [-PermissionsIncluded <SwitchParameter>] [-PropertiesIncluded <SwitchParameter>] [-SettingId <String>] [-WhatIf [<SwitchParameter>]]

The Import-SPBusinessDataCatalogModel cmdlet imports a Business Data Connectivity Model. There are two types of Business Data Connectivity models: Model type (.bdcm) and Resource type (.bdcr). The Model type contains the base XML metadata, and can also include resource properties. The Resource type includes only resource properties.

 

Parameter Required Type Description

Identity

Required

Microsoft.SharePoint.BusinessData.Administration.MetadataObject

Specifies the Business Data Connectivity Metadata Store metadata object to import to.

Path

Required

System.String

Specifies the path and name to use.

The type must be a valid path in either of the following forms:

- C:\folder_name\file.bdcm

- \\server_name\folder_name\file.bdcm

- …\folder_name\file.bdcm

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

NoteNote:
When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

Force

Optional

System.Management.Automation.SwitchParameter

Overwrites the Business Data Connectivity Model if the file exists.

LocalizedNamesIncluded

Optional

System.Management.Automation.SwitchParameter

Specifies that names for business data fields in multiple languages are imported.

ModelsIncluded

Optional

System.Management.Automation.SwitchParameter

Specifies that models are included in the imported Business Data Connectivity Model file. A model contains the base XML metadata for a system.

PermissionsIncluded

Optional

System.Management.Automation.SwitchParameter

Specifies that permissions from the Business Data Connectivity Model are imported.

PropertiesIncluded

Optional

System.Management.Automation.SwitchParameter

Specifies that properties from the Business Data Connectivity Model are imported.

SettingId

Optional

System.String

Specifies the custom environment settings model slice to import.

The type must be a valid string that identifies a model slice; for example, ModelSlice1.

WhatIf

Optional

System.Management.Automation.SwitchParameter

Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

------------------EXAMPLE 1------------------

$MetadataStore = Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "Catalog" -ServiceContext http://contoso
Import-SPBusinessDataCatalogModel -Path "C:\folder\model.bdcm" -Identity $MetadataStore

This example gets the Business Data Connectivity Metadata Store and then imports a Business Data Connectivity Model of Model type to it from the path specified with the name model.

------------------EXAMPLE 2------------------

Import-SPBusinessDataCatalogModel -Path "C:\Program Files\Duet Enterprise\2.0\BDC Models\Reporting.en-us.bdcr -Identity $bdcCatalog -ModelsIncluded:$false 

This example imports a resource only file by using the ModelsIncluded parameter.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft