plmxml_export

Exports objects from Teamcenter in the PLM XML format. If there are files for export, as determined by transfer mode, a directory is created and the files are exported into that directory. The directory is named using the specified file name without the .xml extension. This utility is also used to extract file information from the database into a PLM XML file to prepopulate the FMS server caches (FSCs). For more information, see the load_fcccache and fscadmin utilities. Caution Do not use this utility to export organization objects from sites if the same organization objects are shared throughout a global organization. Warning The Business Modeler IDE application maintains most of the objects that affect the data model. Do not export the following objects. Importing the generated PLM XML file using the plmxml_import utility may cause data accuracy issues. ActivityTypeDef GRMRule PropBusinessOperation AliasTypeDef HideTypeRule (Type-Display rule) PropertyRule AppearenceGroupTypeDef IdContextRule RelationTypeDef ApplicationInterface ImanTypeDef StatusTypeDef CannedMethodRule ItemTypeDef StorageMediaTypeDef ChangeTypeDef ListOfValues ToolTypeDef CompoundPropDefRule NameFieldRule TypeBusinessOperation DatasetTypeDef NamingRule UOMTypeDef DeepCopyRule NoteTypeDef ViewTypeDef Extension OccurrenceTypeDef WorkAreaTypeDef FolderTypeDef OperationTypeDef FormTypeDef ProcessTypeDef Syntax plmxml_export [-u=user-id {-p=password | -pf=password-file} -g=group] -xml_file=xml-file-name -transfermode=transfermode-name {[-item=item-id | -key=[keyAttr1=keyVal1] [,keyAttr2=keyVal2]...[,keyAttrN=keyValN]] [-rev=item-revision-id] [-export_bom=yes | no] [-rev_rule=revision-rule] [-svrule=saved-variant-rule-name [:rev-id:rule-id]] | -class=class-name | -type=type-name | -ics_class=ics-class-name| -imantypedef=iman-type | -uid=uid-of-object | -foldername=folder-to-export} | [-template=workflow-template-name] {[-template_stage=workflow-template-stage] [-template_classification=workflow-template-classification]} [-locales=language-ID] [-session_options=opt1:val11[:val12...:val1N][;opt2:val21[:val22...:val2N]]... [;optN:valN1[...:valNN]]] [-query=query-name{user-entry-name1:val1[,user-entry-name2:val2]...[,user-entry-nameN:valN]}] [-log=log-file-location] [-h] Arguments -u Specifies the user ID. This is a user with Teamcenter administration privileges. Note If Security Services single sign-on (SSO) is enabled for your server, the -u and -p arguments are authenticated externally through SSO rather than being authenticated against the Teamcenter database. If you do not supply these arguments, the utility attempts to join an existing SSO session. If no session is found, you are prompted to enter a user ID and password. -p Specifies the password. This argument is mutually exclusive with the -pf argument. -pf Specifies the password file. For more information about managing password files, see Manage password files. This argument is mutually exclusive with the -p argument. -g Specifies the group associated with the user. If used without a value, the user's default group is assumed. -xml_file Specifies the full path of the file to which the data is exported. -transfermode Specifies the name of the transfer mode used to export the objects. This transfer mode specifies the traversal rules, filter rules, and property sets to be used for export. It determines what is exported from the system. If not specified, a default transfer mode is used. If -transfermode is set to justDatasetsOut, you must specify a revision ID using the -rev argument. -item Specifies the ID of the item to be exported. -key Specifies the keys of the items to be exported in PLM XML format. Use the following format: Copy [keyAttr1=keyVal1] [,keyAttr2=keyVal2]…[,keyAttrN=keyValN] To find the key of an object, use the get_key_string utility. For more information, see Multifield keys. -rev Specifies the revision ID of the item to be exported. If not specified, the configured revision (either specified or default) is exported for the item. -rev_rule Specifies the revision rule applied to export a BOM. This option is also used to determine the configured revision if the -rev option is not specified. If this option is not specified, the default revision rule is applied, as specified in the TC_config_rule_name preference. -svrule Specifies a saved variant rule to use when configuring the exported BOM. Optionally, specify a particular revision of a variant rule object by providing its revision ID and rule ID separated by colons. Use of the variant rule revision is supported for only Cfg0VariantCriteria, a revisable subclass of the VariantRule object. -class Exports all instances of a given class. Note You cannot use the -class argument to export scope rules (TransferModes, ClosureRules, FilterRules, PropertySets, ActionRules, and TransferOptionSets). To export rules, use the tcxml_export utility. To view the persistent object manager (POM) schema, open the Classes view in the Business Modeler IDE. If ListOfValues and BusinessRule are specified, all instances of subclasses of the specified class are also exported. Options to export organization information using -class: Option Description Person Export all persons User Export all users Role Export all roles Group Export all groups GroupMember Export all group members POM_imc Export all sites ImanVolume Export volumes ListOfValues Export all list of values ListOfValuesString Export string list of values ListOfValuesDate Export date list of values ListOfValuesDouble Export double list of values ListOfValuesInteger Export integer list of values ListOfValuesChar Export char list of values ListOfValuesTag Export reference list of values Options to export workspace objects using -class: Option Description Item Export all instances of items ItemRevision Export all instances of item revisions Folder Export all instances of folders Form Export all instances of forms Dataset Export all instances of datasets Alias Export all instances of alias EPMJob Export all instances of workflow jobs PSBOMView Export all instances of BOM views PSBOMViewRevision Export all instances of BOM view revisions Tool Export all instances of tools Options to export business rules using -class: Option Description BusinessRule Export all business rules NameRule Export all naming rules NameField Export all naming fields HideTypeRule Export all hide type rules of tools ImanCompoundPropDef Export all compound property rules of tools ImanGRM Export all GRM rules TypeCannedMethod Export all action rules Other options using -class: Option Description FormTypeDef Export all form type definitions ImanType Export all instances of Teamcenter types NoteType Export all note types PSViewType Export all view types UnitOfMeasure Export all defined unit of measures TaskType Export all defined task types PSOccurrenceType Export all occurrence types -type Exports all instances of a given type. -ics_class Exports the specified classification class, if it exists. -imantypedef Exports the definition of specified type. Options and their results for -imantypedef: Option Description ListOfValues Export list of values ImanQuery Export saved queries Tool Export tool definitions TaskType Export defined task types IdContext Export identifier contexts Status Export defined status StorageMedia Export storage media Note Export PS occurrence note types UnitOfMeasure Export unit of measures defined Occurrence Export occurrence types View Export view types RevisionRule Export revision rules for PS configuration Alias Export alias and its types Identifier Export identifier and its types WorkArea Export workarea OP Export operation ChangeTypeData Export changeid/changetypen Dataset Export dataset type definition ImanType Export all Teamcenter types ImanRelation Export relations AppearanceGroup Export appearancegroup types -export_bom Specifies that the BOM is exported. This argument must be used in conjunction with the -item argument. -uid Exports the object specified by the unique ID (UID). -foldername Exports the specified folder, if it exists. -template Specifies the name of the exported workflow template. -template_stage Specifies the stage type of the exported workflow template. This argument is used with the -template argument. Valid values are OBSOLETE_STAGE, UNDER_CONSTRUCTION_STAGE, or AVAILABLE_STAGE (default). If this option is not specified, the default value is used. -template_classification Specifies the classification type of the exported workflow template. This argument is used with the -template argument. Valid values are TASK_TEMPLATE and PROCESS_TEMPLATE (default). If this option is not specified, the default value is used. -session_options Specifies generic session options using colon separated name-value pairs. Name-value pairs can contain multiple values paired with a name. Options are delimited by commas. Multiple values in pairs are delimited by semicolons. -session_options can be used running customized code. Specifying options with the plmxml_export utility lets you process those same options with your customized code. -query Specifies a saved query to use when exporting an object. query-name is the saved query name. User entry names are atttribute-value pairs delimited by colons. Multiple pairs are delimited by commas. -query is intended for cases where a single object is returned. -locales Specifies the languages for the export. Separate multiple languages by commas. The language IDs should follow the standard Java locale naming conventions (for example, en_US). If no locales are specified for export, the database scalar value (primary attribute) is exported to PLM XML scalar fields. -log Specifies the full path of the export log file. If this option not specified, the log file is created in the $TC_TMP_DIR directory. If $TC_TMP_DIR is not defined, the log file is created in the system temporary directory (C:\TEMP on Windows or /tmp on Linux). -h Displays help for this utility. Environment As specified in Setting up a Teamcenter command-line environment. Files As specified in Log files produced by Teamcenter. Restrictions Siemens Digital Industries Software recommends you do not use the following transfer modes with this utility: BOMwriterExport JTDataExportDefault TIEPDXExportDefault TIEUnconfiguredExportDefault PLMXMLAdminDataExport Do not use this utility to export organization objects from sites if the same organization objects are shared throughout a global organization. Examples The following command exports item ABC00001, revision A, to a PLM XML file using the toPrimeSupplier transfer mode context. The default revision rule is applied. Copy plmxml_export -u=Tc-admin-user -p=password -g=group -xml_file=abc00001_A.xml -item=ABC00001 -rev=A -transfermode=toPrimeSupplier The following command exports item ABC00002, revision A to a PLM XML file using the toEnterprise transfer mode context by applying the specified revision rule and saved variant rule to apply to the BOM window: Copy plmxml_export -u=Tc-admin-user -p=password -g=group -xml_file=abc00002_A.xml -item=ABC00002 -rev_rule="Latest Released" -svrule="AlphaRelease" -transfermode=toEnterprise The following command exports all users to an XML file using the default context to export the data to PLM XML format: Copy plmxml_export -u=Tc-admin-user -p=password -g=group -xml_file=tcusers.xml -class=User The following command exports an object specified by the UID and uses the default context to export the data to PLM XML format. The UID should be a unique identifier in Teamcenter: Copy plmxml_export -u=Tc-admin-user -p=password -g=group -xml_file=myobj.xml -uid="QRw4LZ0g1YomJAAAAAAAAAAAAAA" The following command creates a PLM XML file containing all external file references associated with the top level item selected for cache prepopulation. Copy plmxml_export -u=Tc-admin-user -p=password -g=group -item=ITEM -rev=A -export_bom=yes -transfermode=justDatasetsOut -out=tickets.plmxml The following command exports the item with ID item1 to the PLM XML file item1.xml. The French and German translations of the localized properties on item1 that are identified for export (from the property set) are also exported to text elements. Copy plmxml_export -u=Tc-admin-user -p=password -g=group -item=item1 -locales=fr_FR,de_DE -xml_file=item1.xml The following command exports all partitions to an XML file using the default context to export the data to PLM XML format. In this example of exporting generic session options, -session_options is used to export selective partition scheme types. Copy plmxml_export -u=Tc-admin-user -p=password -g=group -xml_file=tcusers.xml -session_options= Multiple_partition_schemes:Ptn0SchemeFunctional;Ptn0SchemePhysical The following command uses the saved query “Design Element” to export the element with a user entry value of "Design Element Name". Double quote symbols surround the -query option value because the value includes spaces. Copy plmxml_export -u=Tc-admin-user -p=password -g=group-query="Design Element{Design Element Name:DE_QRY}" -xml_file=1234.xml -transfermode=4GDPIEDataExportDefault -rev_rule="Working; Any Status" Related Topics Transfer modes included with Teamcenter TC XML and PLM XML Configuration for Data Import and Export Multi-Site Collaboration