tcxml_import

Imports objects into Teamcenter from a TC XML file. The tcxml_import utility uses the PS_bvr_import_new_occ operation. The low-level TC XML arguments of this utility provide access to site consolidation functionality. To use those arguments, you must set a license key value for the SITCONS_AUTH_KEY environment variable. Open a support case on Support Center to get this license key. Caution Do not use the tcxml_import utility for importing administration data. For importing administration data, use the admin_data_import utility. Property values can be updated in bulk. See Process for updating property values in bulk. Syntax tcxml_import [-u=user-id{-p=password | -pf=password-file} -g=group] -file=xml-file-name [-xsl=xsl-file-name] [-errorcontinue={yes | no} ] [ [-site=site-name] [-transfermode=transfer-mode] [-optionset=option-set-name] ] | [ [-scope_rules [-scope_rules_mode=ignore | overwrite] ] ] [-requiredLang=locale-code-1, locale-code-2, ..., locale-code-n] [-allowedLang=locale-code-1, locale-code-2, ..., locale-code-n] ] | [-low_level {-file=file-name} [-bulk_load {-site=site-name -file=file-name} ] [-tcfile_import] [-islands=island-list] [-bypassSiteCheck] [-session_options=option-1:value-1, option-2:value-2,...option-n:value-n] [-session_options_file=options-file-name] [-briefcase] [-dryrun [=validateXMLBeforeXslt]] [-validate [=validateXMLBeforeXslt]] [-h] Arguments -u Specifies the user ID. 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. 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. -file Specifies the input TC XML file containing the objects to import into Teamcenter. -xsl Specifies the input XSL file to apply to the TC XML file before import. See TC_ROOT\data\Mapping_of_copy_stable_id.xsl as an example. -errorcontinue Indicates whether to continue the import after encountering an error. The default value is yes. If you specify no and the utility encounters an error, the utility rolls back all of the changes performed during the current import. -site Specifies the owning exporting site from which input TC XML data is generated. This argument is mutually exclusive with the -scope_rules and -scope_rules_mode arguments. The argument is not valid for bulk loading a briefcase file. -transfermode Specifies the transfer mode name that is to be used for import. If this argument is not specified, the utility uses the TIEImportDefault transfer mode. This argument is mutually exclusive with the -scope_rules and -scope_rules_mode arguments. -optionset Specifies the option set name that contains options to use during import. This argument is mutually exclusive with the -scope_rules and -scope_rules_mode arguments. To import a briefcase file created using bulk extract, specify the option set with the opt_bulk_load_bcz value set to TRUE. -scope_rules Specifies that the input XML data contains scope rules, that is, transfer modes, closure rules, filter rules, property sets, actions rules, or transfer options sets. This argument is mutually exclusive with the -site, -transfermode, and -optionset arguments. See Restrictions. -scope_rules_mode Specifies the import behavior when an imported rule already exists in the database. If set to ignore, the rule is not imported. If set to overwrite, the existing database rule is overwritten. If you do not specify this argument, ignore behavior is used. If you do not specify the -scope_rules argument, this argument is invalid. -requiredLang Specifies a list of comma separated locale values. This list is used to ensure that localized attributes in the imported data have at least one representation that can be used as the attribute primary language at the importing site. It also defines a priority order for the exporter to determine the attribute primary language. The valid locale values must match the Java locale naming convention that consists of two groups of two-character identifiers separated by an underscore character () for a particular combination of language and region. For example, zh_CN represents Simplified Chinese in China and en_US represents English in the United States. -allowedLang Specifies a list of comma separated locale values. This list is used to get additional representations for localized attributes in the imported data for use at the importing site. The valid locale values must match the Java locale naming convention that consists of two groups of two-character identifiers separated by an underscore character () for a particular combination of language and region. For example, zh_CN represents Simplified Chinese in China and en_US represents English in the United States. -low_level Performs a fast import using POM level APIs. Fast import is normally used for consolidation of site databases. You must specify only the -file argument; all other arguments are ignored during fast imports. This argument provides access to site consolidation functionality and requires setting a license key value for the SITCONS_AUTH_KEY environment variable. Open a support case on Support Center to get this license key. If you import 4th Generation Design (4GD) data, you must run the appmodel_fix_scope utility at the target site to ensure 4GD data is represented properly. -bulk_load Performs a fast import of legacy data from a file containing low-level TC XML formatted data or a low-level TC XML briefcase file. You must specify only the -file and -site arguments; all other arguments are ignored when bulk loading low-level data. The -site argument is not valid for bulk loading a briefcase file. Be aware of the following items: If the -file argument specifies a briefcase (.bcz) file, the utility switches to low-level briefcase import mode. If you specify any optional arguments (with the exception of the -optionset argument) when importing a briefcase file, they are ignored. If you do not specify the -optionset argument, the utility uses the BulkLoadDefault transfer option set. If you provide a transfer option set, it must contain the opt_bulk_load_bcz option set to TRUE. The import uses the volume specified in the TC XML if the TIE_Volume_Map preference is not set or does not specify a volume mapping for the volume named in the TC XML. If the TIE_Volume_Map preference specifies a volume mapping for the volume named in the TC XML, the import uses the mapped volume. If the mapped volume is unavailable, the volume specified by opt_use_default_volume is used. If opt_use_default_volume is not set to true, an error is returned. -tcfile_import Imports ImanFile objects using a low-level TC XML formatted GSID-based file. This argument is valid only with the -low_level or -bulk_load arguments. -islands Imports one or more specific islands identified by island-list. -islands is valid only with the -low_level and -bulk_load arguments. Previous islands in the TC XML file (with higher ID values) must already exist in the database for an island to be imported successfully. island-list is a comma-delimited list of island IDs or ranges of IDs, such as "10,8,7-5,3-". If no closing of a range is provided, all of the remaining islands in the TC XML file are imported. -bypassSiteCheck If specified, this switch bypasses the check that prevents the utility from updating objects at the same site and the check that prevents the update of replica objects. Note If you are using this utility in a Multi-Site environment, run the utility at each of the sites to update the objects belonging to the respective sites. Users have the capability of performing updates on replica objects, eliminating the need to re-replicate all updated objects. Use this argument only with the -bulk_load argument for bulk update of attributes of local objects and import of archived audit records. Because this argument requires the -bulk_load argument that provides access to site consolidation functionality, SITCONS_AUTH_KEY must be set to a license key value. -session_options Specifies a comma-separated list of option name-value pairs. Names and values are delimited by colons, for example: Copy ContinueOnError:TRUE,GenerateReport:TRUE -session_options_file Specifies an ASCII file containing session option settings using option name-value pairs. Use this option instead of the -session_options option when you are reusing long lists of session option name-value pairs and when values contain system-reserved special characters. Place one name-value pair on each line of the file as follows: Copy option_1:value_1 option_2:value_2 . . . option_n:value_n Set an option only once in the file. -briefcase Specifies the imported file is formatted as a briefcase file. The file is specified with the -file option. Briefcase files exported using -bulk_extract are not supported by -briefcase. -dryrun When importing a low level briefcase file, specifies that a simulated import be run and the imported TC XML be validated. Warnings and errors in the TC XML are reported in the file specified by -file (with a .html extension). If -dryrun=validateXMLBeforeXslt is specified, the exported TC XML is validated before the XSLT is applied to it. The briefcase file is not imported in either case. -dryrun cannot be used with the -validate option. -validate When importing a low level briefcase file, specifies that the imported TC XML be validated. Two levels of validation occur: In the first validation level, configuration aspects of the briefcase file such as the user, transformation rules, data types, and the target site are validated. In the second pass, the objects in the briefcase file are validated. If errors are found in the first pass, the briefcase file is not imported. If errors are found only in the second pass, the briefcase file is imported. Whenever warnings or errors are found, they are reported in the file specified by -file (with a .html extension). If -validate=validateXMLBeforeXslt is specified, the internal (pre-export) TC XML is validated instead of the exported TC XML. -validate cannot be used with the -dryrun option. -h Displays help for this utility. Environment As specified in Setting up a Teamcenter command-line environment. Files As specified in the Log files produced by Teamcenter. Restrictions When importing transfer option sets, if a local option set at the exporting site is specified for import, the utility assigns the local site as the site reference and the imported option becomes local to the importing site. If a remote option at the exporting site is specified for import, the site reference of that option set is expected to exist in the database at the importing site. If it is not, the import fails. To avoid this failure, you must manually create the option set before attempting the import. Not all Teamcenter data is supported for import. For a list of objects that are supported, see Teamcenter Data Exchange. Examples The following example imports objects specified by the -file argument: Copy tcxml_import -file=file_name.xml The following example imports objects specified by the -file argument according to the rules given in transfer mode specified by the -transfermode argument: Copy tcxml_import -file=xml-file-name -transfermode=transfer-mode-name The following example imports objects specified by the -file argument and uses the value specified by the -site argument as the exporting site for this import: Copy tcxml_import -file=file_name.xml -site=site_ID The following example imports objects specified by the -file argument and uses the value specified by the -xsl argument to apply transformation on the input XML file: Copy tcxml_import -file=file_name.xml -xsl=xsl_file The following example imports objects specified by the -file argument and uses the value specified by the -errorcontinue argument to determine whether to roll back the import if an error occurs: Copy tcxml_import -file=file_name.xml -errorcontinue=yes The following example imports objects specified by the -file argument and uses the value specified by the -optionset argument to access the options that must be used during import: Copy tcxml_import -file=file_name.xml -optionset=option_set_name The following example imports objects specified with the -file argument with localizable attribute values in en_US and fr_FR locales: Copy tcxml_import -file=file_name.xml -requiredlanguage=en_US -allowedlanguage=fr_FR The following example imports archived audit records from the file AuditExport.xml: Copy tcxml_import -bulk_load -bypassSiteCheck -file=c:/temp/AuditExport.xml The following example sets session option values specified in the external sess_opts.cfg file and imports ImanFile objects with physical files from the volume in the specified path: Copy tcxml_import -bulk_load -tcfile_import -session_options_file=c:\config\sess_opts.cfg -file=c:/temp0001.xml -source_volume=c:\temp\source_volume The following example explicitly sets session option values and imports objects with the -file argument with the specific island IDs: Copy tcxml_import -file=exportitem.xml -islands=10,8,7-5,3- -session_options=opt_traverse_ref_org:false, objsForOwnXfer:1857876201:wjUx4xecAAgcRA The following example simulates a low-level briefcase import, validating the imported low-level TC XML and generating an error report (and no briefcase file). Copy tcxml_import -file=d:\Temp\report.html -optionset=TIEConfiguredLLBCZExportDefault -briefcase -dryrun The following example simulates a low-level briefcase import, validating the internal low-level TC XML and generating an error report without importing the briefcase file. Copy tcxml_import -file=d:\Temp\report.html -optionset=TIEConfiguredLLBCZExportDefault -briefcase -dryrun=validateXMLBeforeXslt The following example performs a low-level briefcase import, validating the exported TC XML and importing the briefcase file if no warnings or errors are encountered. If errors or warnings are encountered, a report file is created. Copy tcxml_import -file=d:\Temp\briefcase.bcz -optionset=TIEConfiguredLLBCZExportDefault -briefcase -validate Related Topics TC XML and PLM XML Configuration for Data Import and Export Multi-Site Collaboration