3.1.4.92 ImportPackageWithProgress

  • Article

The ImportPackageWithProgress operation creates the following objects in the metadata store:

  • MetadataObjects contained by the specified MetadataModel, along with their Properties, localized names, and ACEs, if the "Model" value is specified for the packageContents element. The MetadataModel MUST be specified as an XML element that conforms to the Business Data Connectivity Model file format specified in [MS-BDCMFFS] section 2.1.3.34. If the MetadataModel contains a LobSystem that has the same name and type as a LobSystem in the metadata store, the LobSystem in the MetadataModel MUST be ignored by the protocol server, along with all LobSystemInstances contained by that LobSystem along with Properties, localized names, and ACEs of the ignored MetadataObjects. If the MetadataModel contains an Entity that has the same name, namespace, and version as an Entity in the metadata store, and if the names of the LobSystems that contain these Entities are identical, the Entity in the MetadataModel MUST be ignored by the protocol server, along with all MetadataObjects contained by the Entity or other ignored MetadataObjects, and along with the Properties, localized names, and ACEs of the ignored MetadataObjects.

  • Localized names, Properties, and ACEs corresponding to MetadataObjects contained by the specified MetadataModel, if the "Model" value is not specified for the packageContents element. The MetadataModel MUST be specified as an XML element that conforms to the Business Data Connectivity Model file format specified in [MS-BDCMFFS] section 2.2.3.28.

The protocol server MUST track the progress of this operation with the specified identifier. The protocol client can retrieve the progress of this operation by using the GetImportProgress operation with the specified identifier.

The following is the WSDL port type specification of the ImportPackageWithProgress WSDL operation.

 <wsdl:operation name="ImportPackageWithProgress" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
   <wsdl:input wsaw:Action="http://www.microsoft.com/Office/2009/BusinessDataCatalog/BusinessDataCatalogSharedService/ImportPackageWithProgress" message="tns:BusinessDataCatalogSharedService_ImportPackageWithProgress_InputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:output wsaw:Action="http://www.microsoft.com/Office/2009/BusinessDataCatalog/BusinessDataCatalogSharedService/ImportPackageWithProgressResponse" message="tns:BusinessDataCatalogSharedService_ImportPackageWithProgress_OutputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:fault wsaw:Action="http://www.microsoft.com/Office/2009/BusinessDataCatalog/BusinessDataCatalogSharedService/ImportPackageWithProgressArgumentExceptionFault" name="ArgumentExceptionFault" message="tns:BusinessDataCatalogSharedService_ImportPackageWithProgress_ArgumentExceptionFault_FaultMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:fault wsaw:Action="http://www.microsoft.com/Office/2009/BusinessDataCatalog/BusinessDataCatalogSharedService/ImportPackageWithProgressArgumentNullExceptionFault" name="ArgumentNullExceptionFault" message="tns:BusinessDataCatalogSharedService_ImportPackageWithProgress_ArgumentNullExceptionFault_FaultMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:fault wsaw:Action="http://www.microsoft.com/Office/2009/BusinessDataCatalog/BusinessDataCatalogSharedService/ImportPackageWithProgressArgumentOutOfRangeExceptionFault" name="ArgumentOutOfRangeExceptionFault" message="tns:BusinessDataCatalogSharedService_ImportPackageWithProgress_ArgumentOutOfRangeExceptionFault_FaultMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:fault wsaw:Action="http://www.microsoft.com/Office/2009/BusinessDataCatalog/BusinessDataCatalogSharedService/ImportPackageWithProgressBdcExceptionStateFault" name="BdcExceptionStateFault" message="tns:BusinessDataCatalogSharedService_ImportPackageWithProgress_BdcExceptionStateFault_FaultMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:fault wsaw:Action="http://www.microsoft.com/Office/2009/BusinessDataCatalog/BusinessDataCatalogSharedService/ImportPackageWithProgressInvalidOperationExceptionFault" name="InvalidOperationExceptionFault" message="tns:BusinessDataCatalogSharedService_ImportPackageWithProgress_InvalidOperationExceptionFault_FaultMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:fault wsaw:Action="http://www.microsoft.com/Office/2009/BusinessDataCatalog/BusinessDataCatalogSharedService/ImportPackageWithProgressMetadataExceptionStateFault" name="MetadataExceptionStateFault" message="tns:BusinessDataCatalogSharedService_ImportPackageWithProgress_MetadataExceptionStateFault_FaultMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:fault wsaw:Action="http://www.microsoft.com/Office/2009/BusinessDataCatalog/BusinessDataCatalogSharedService/ImportPackageWithProgressPackageFormatExceptionStateFault" name="PackageFormatExceptionStateFault" message="tns:BusinessDataCatalogSharedService_ImportPackageWithProgress_PackageFormatExceptionStateFault_FaultMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
 </wsdl:operation>

The protocol client sends a BusinessDataCatalogSharedService_ImportPackageWithProgress_InputMessage request message, and the protocol server MUST respond with a BusinessDataCatalogSharedService_ImportPackageWithProgress_OutputMessage response message, unless any faults occur.

If any one of the following conditions is met, the protocol server MUST instead respond with a SOAP fault containing the corresponding error complex type, serialized as specified in section 2.2.4. If more than one error condition is encountered, the protocol server MUST respond with exactly one error complex type, determined in an implementation-specific manner.

This operation raises a PackageFormatExceptionState (from namespace Microsoft.SharePoint.BusinessData) error under any of the following conditions:

  • The "Model" value is specified for the packageContents element, and the specified XML does not conform to the Business Data Connectivity Model file format specified in [MS-BDCMFFS] section 2.1.3.34.

  • The "Model" value is not specified for the packageContents element, and the specified XML does not conform to the Business Data Connectivity Model file format specified in [MS-BDCMFFS] section 2.2.3.28.

  • The updateModel element is set to "false", the "Model" value is specified for the packageContents element, and there is already another Model with the same name as the Model contained by the MetadataModel in the specified partition.

  • The updateModel element is set to "false", the "Model" value is specified for the packageContents element, and another Model with the same name already exists in the metadata store.

  • The security principal in whose context the protocol client is operating is not authorized to create or modify the specified Model.

  • The security principal in whose context the protocol client is operating is not authorized to create or modify the specified MetadataCatalog.

  • The updateModel element is set to "true", the "Model" value is specified for the packageContents element, and the Model contained by the MetadataModel does not exist in the specified partition.

  • The "Model" value is not specified for the packageContents element, and at least one of the MetadataObjects contained by the MetadataModel does not exist in the metadata store.

  • The "Model" value is specified for the packageContents element, and one of the LobSystems contained by the MetadataModel has the same name as a LobSystem in the metadata store. However, the LobSystem contained by the MetadataModel has a different type than the LobSystem in the metadata store.

  • The "Model" value is specified for the packageContents element, and one of the Entities contained by the MetadataModel has the same name, namespace, and version as an Entity in the metadata store. However, the names of the LobSystems that contain these Entities are different.

  • The "InlineProxies" value is specified for the packageContents element, and the specified MetadataModel contains a LobSystem with an associated Business Logic Module.

  • The "Model" value is specified for the packageContents element, and the specified MetadataModel contains a Method that contains more than one FilterDescriptor of type TimeStampFilter.

  • The "Model" value is specified for the packageContents element, and the specified MetadataModel contains a StreamAccessor that specifies ReturnTypeDescriptor that contains other TypeDescriptors.

  • The "Model" value is specified for the packageContents element, and the specified MetadataModel contains a StreamAccessor and the TypeDescriptor containing the ReturnTypeDescriptor of this MethodInstance contains another TypeDescriptor under its parent TypeDescriptor, and the LobSystem containing the Entity which contains this StreamAccessor has type specified as "Database".

  • The "Model" value is specified for the packageContents element, and the specified MetadataModel contains a MethodInstance, and the Method for which this MethodInstance is being created does not have a Parameter whose Direction is "In" or "InOut" and the type of this MethodInstance is one of the following values:

    • AccessChecker

    • AssociationNavigator

    • Associator

    • BinarySecurityDescriptorAccessor

    • BulkAssociatedIdEnumerator

    • BulkAssociationNavigator

    • BulkIdEnumerator

    • BulkSpecificFinder

    • ChangedIdEnumerator

    • DeletedIdEnumerator

    • Deleter

    • Disassociator

    • SpecificFinder

    • Updater

    • StreamAccessor

  • The "Model" value is specified for the packageContents element, and the specified MetadataModel contains a MethodInstance, the Method containing this MethodInstance does not contain a TimeStampFilter and the type of this MethodInstance is one of the following values:

    • ChangedIdEnumerator

    • DeletedIdEnumerator