Parameter
|
Description
|
setClientFileName
|
The absolute file path where output jar is created. Client filename must not exist. It is a place holder where client is expecting the output jars to be stored. If the file path is not provided, then the information is exported to a random temporary location. PTC recommends that you set this parameter for export.
|
setCollection
|
wtCollection containing persistable objects to export. Persistable objects for which Import/Export handler exists and is supported for export. List of objects that are supported OOTB can vary based on the format type used. Refer to the related standards documentation for details.
|
setFormatType
|
ExportImportFormatType enumeration is used to define the format for the export. Supported format types are:
• PLM_FORMAT – to export in the PLMS message format
• STEP_FORMAT – to export in the STEP format
• WNC_FORMAT – to export in the Windchill format. Windchill format refers to XMLs based on the standard DTD definitions provided by the object owners. This is the default format type.
|
setIxFormatType
|
IXFormatTypeis used to define information such as protocol, implementation method, format type and version. This is used for STEP format-based export.
IXFormatType object must always be created using the following method:
IXFormatTypeHelper.getIXFormatType
Set the following information:
• setProtocol - IXFormatProtocolType – the protocol in which export is performed.
• setImplementationMethod – IXFormatImplementationMethodType – the implementation method for export like XML, Part 21, Part 28.
|
Parameter
|
Description
|
getMessages
|
Vector of messages which provides status messages of export. This is similar to messages which are polled during UI export operation.
|
getObjectCount
|
Number of objects that were exported or imported.
|
getOutcome
|
Outcome of the operation whether it is success or failure. The value is True for success and False for failure.
|
getFailureMessage
|
Failure information like exceptions during export or import.
|
Parameter
|
Description
|
setContainer
|
Container, where import is performed.
|
setDataFile
|
IXBStreamer represents the file to be imported.
|
setIxFormatType
|
IXFormatType. For more details, refer to the section “Export” in this topic. This must be used for STEP based import. It must be same as the parameter used while performing the export of the file.
|
setRepository
|
IxbSTEPRepository object is the input for STEP file import. It encapsulates information such as, file and format type required for import.
|
|
Consider the file through streamer object instead of repository.
|
Class
|
API
|
Purpose
|
ObjectExportParameters
ObjectImportParameters
|
setDetailedLog
|
To extract detailed information of export/import operation. This information is captured in memory in status object. In case of large data export or import it is recommended not to use this.
|
ObjectExportParameters
ObjectImportParameters
|
setValidation
|
To avoid DTD validation during export/import. This is required during development use case. In production setup, do not deploy this API with false.
|
ObjectImportParameters
|
setDataFile
|
Streamer file to use for importing WNC_FORMAT or PLM_FORMAT files. IXBSvrStreamer object is used to encapsulate the file information for import.
|
ObjectImportParameters
|
setUseExtendedMapping
|
To support extended mapping for AP242 protocol mapping of metadata. For more details, refer to Configuring Metadata Mapping.
|