BaseDataImportExportBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# BaseDataImportExportBuilder Class

class `NXOpen.Features.VehicleDesign.``BaseDataImportExportBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Features.VehicleDesign.BaseDataImportExportBuilder` builder used to import and export expressions from and to a spreadsheet.

  To create a new instance of this class, use `NXOpen.Features.VehicleDesignCollection.CreateBaseDataImportExportBuilder()`

  Default values.

  Property | Value
  --- | ---
  ExportOption | NewItem
  OperateOption | Import
  OverrideExistingExpressions | 0

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
DatasetName | Returns or sets the name of the Teamcenter dataset from which the spreadsheet is to be imported from or exported to.
ExportOption | Returns or sets the option which indicates if the expressions are to be exported a new create item or an existing item in Teamcenter.
OperateOption | Returns or sets the option which indicates if the spreadsheet is to be imported or exported.
OverrideExistingExpressions | Returns or sets the value which indicates whether to override existing expressions in the work part when importing.
SpreadSheetFileName | Returns or sets the spreadsheet name which indicates the spreadsheet to be imported or exported.
SpreadsheetItemID | Returns or sets the item ID number which indicates the item that the spreadsheet is to be imported from or exported to.
SpreadsheetItemName | Returns or sets the item name of the spreadsheet in Teamcenter.
SpreadsheetItemRevision | Returns or sets the item revision of the spreadsheet that is to be imported from or exported to.
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
AssignItemNumber | Used to assign Item number and revision in Teamcenter .
AssignItemRevision | Used to assign Item revision in Teamcenter.
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetObject | Returns the object currently being edited by this builder.
SetObjectCreateBuilder | Sets `NXOpen.PDM.ObjectCreateBuilder`
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

BaseDataImportExportBuilderExportOptions Enumeration | This enum represents the option to indicate if the expressions are to be exported to a new item or an existing item in Teamcenter.
BaseDataImportExportBuilderOperateOptions Enumeration | This enum represents the import or export operate options

# Property Detail

## DatasetName

`BaseDataImportExportBuilder.``DatasetName`

  Returns or sets the name of the Teamcenter dataset from which the spreadsheet is to be imported from or exported to.

  `-------------------------------------`

  Getter Method

  Signature `DatasetName`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DatasetName`

  Parameters: | datasetName (str) –

  New in version NX8.5.0.

  License requirements: gateway (“UG GATEWAY”)

## ExportOption

`BaseDataImportExportBuilder.``ExportOption`

  Returns or sets the option which indicates if the expressions are to be exported a new create item or an existing item in Teamcenter.

  `-------------------------------------`

  Getter Method

  Signature `ExportOption`

  Returns: |
  Return type: | `NXOpen.Features.VehicleDesign.BaseDataImportExportBuilderExportOptions`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ExportOption`

  Parameters: | exportOption (`NXOpen.Features.VehicleDesign.BaseDataImportExportBuilderExportOptions`) –

  New in version NX8.5.0.

  License requirements: gateway (“UG GATEWAY”)

## OperateOption

`BaseDataImportExportBuilder.``OperateOption`

  Returns or sets the option which indicates if the spreadsheet is to be imported or exported.

  `-------------------------------------`

  Getter Method

  Signature `OperateOption`

  Returns: |
  Return type: | `NXOpen.Features.VehicleDesign.BaseDataImportExportBuilderOperateOptions`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `OperateOption`

  Parameters: | operateOptions (`NXOpen.Features.VehicleDesign.BaseDataImportExportBuilderOperateOptions`) –

  New in version NX8.5.0.

  License requirements: gateway (“UG GATEWAY”)

## OverrideExistingExpressions

`BaseDataImportExportBuilder.``OverrideExistingExpressions`

  Returns or sets the value which indicates whether to override existing expressions in the work part when importing.

  `-------------------------------------`

  Getter Method

  Signature `OverrideExistingExpressions`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `OverrideExistingExpressions`

  Parameters: | overrideExistingExpressions (bool) –

  New in version NX8.5.0.

  License requirements: gateway (“UG GATEWAY”)

## SpreadSheetFileName

`BaseDataImportExportBuilder.``SpreadSheetFileName`

  Returns or sets the spreadsheet name which indicates the spreadsheet to be imported or exported.

  `-------------------------------------`

  Getter Method

  Signature `SpreadSheetFileName`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SpreadSheetFileName`

  Parameters: | spreadSheetFileName (str) –

  New in version NX8.5.0.

  License requirements: gateway (“UG GATEWAY”)

## SpreadsheetItemID

`BaseDataImportExportBuilder.``SpreadsheetItemID`

  Returns or sets the item ID number which indicates the item that the spreadsheet is to be imported from or exported to.

  `-------------------------------------`

  Getter Method

  Signature `SpreadsheetItemID`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SpreadsheetItemID`

  Parameters: | spreadsheetItemID (str) –

  New in version NX8.5.0.

  License requirements: gateway (“UG GATEWAY”)

## SpreadsheetItemName

`BaseDataImportExportBuilder.``SpreadsheetItemName`

  Returns or sets the item name of the spreadsheet in Teamcenter.

  `-------------------------------------`

  Getter Method

  Signature `SpreadsheetItemName`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SpreadsheetItemName`

  Parameters: | spreadsheetItemName (str) –

  New in version NX8.5.0.

  License requirements: gateway (“UG GATEWAY”)

## SpreadsheetItemRevision

`BaseDataImportExportBuilder.``SpreadsheetItemRevision`

  Returns or sets the item revision of the spreadsheet that is to be imported from or exported to.

  `-------------------------------------`

  Getter Method

  Signature `SpreadsheetItemRevision`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SpreadsheetItemRevision`

  Parameters: | spreadsheetItemRevision (str) –

  New in version NX8.5.0.

  License requirements: gateway (“UG GATEWAY”)

# Method Detail

## AssignItemNumber

`BaseDataImportExportBuilder.``AssignItemNumber`

  Used to assign Item number and revision in Teamcenter .

  Signature `AssignItemNumber()`

  Returns: | a tuple
  Return type: | A tuple consisting of (itemId, itemName, itemRevision, idSensitivity, revSensitivity) itemId is a str. itemName is a str. itemRevision is a str. idSensitivity is a bool. revSensitivity is a bool.

  New in version NX8.5.0.

  License requirements: gateway (“UG GATEWAY”)

## AssignItemRevision

`BaseDataImportExportBuilder.``AssignItemRevision`

  Used to assign Item revision in Teamcenter.

  Signature `AssignItemRevision(itemId)`

  Parameters: | itemId (str) –
  Returns: | a tuple
  Return type: | A tuple consisting of (itemRevision, revSensitivity) itemRevision is a str. revSensitivity is a bool.

  New in version NX8.5.0.

  License requirements: gateway (“UG GATEWAY”)

## SetObjectCreateBuilder

`BaseDataImportExportBuilder.``SetObjectCreateBuilder`

  Sets `NXOpen.PDM.ObjectCreateBuilder`

  Signature `SetObjectCreateBuilder(objectCreateBuilder)`

  Parameters: | objectCreateBuilder (`NXOpen.PDM.ObjectCreateBuilder`) –

  New in version NX10.0.0.

  License requirements: gateway (“UG GATEWAY”)

## Validate

`BaseDataImportExportBuilder.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.