4G Populate utility

Note In previous Teamcenter versions, this utility was called 4gd_easy or 4gd_populate_cd. Generates a product design from an existing product or assembly structure. The product design has the following characteristics: The name of the product design you specify. A set of partitions of a single scheme, that is physical partitions or functional partitions. One or more reuse design elements with names derived from the names of the items from which the reuse design elements are realized. Transformation data is read from each level of the original product structure or assembly. The utility concatenates this data and uses it for design element to collaborative design transformations. Consequently, the collaborative design appears the same as the original assembly. If the original assembly includes absolute occurrences, it uses the absolute occurrence transformations. If the source item revision has bounding boxes attached, the same bounding boxes are attached to the new design element. By default, the utility configures the assembly with the Latest Working revision rule and the latest revision of the source assembly item. Optionally, you can specify a particular revision rule and a item revision. You can also optionally configure the structure by release date or effectivity. The utility places the new collaborative design in the Newstuff folder of the specified user. Syntax 4g_populate -u=user-id {-p=password | -pf=password-file} [-g=group] -i=item_id [-cd_type=type] [-preview_mode ] [-preview_file_name=preview file name] [-create_mode ] [-rev=revision] [-rule=revision_rule] [-date_effectivity=date_effectivity] [-end_item_id=end_item_id] [-release_date=release_date] [-map_file=file_name] [-batch_size=size] [-split_mode] [-number_of_batches=number_of_batches] [-split_directory=directory_path] [-pre_validate_mode ] [-pre_validation_report_file_name=file_path_name] [-child_assembly_validation] [-update] [-updateOfDesignChanges] [-h] Arguments General options: -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 user and password 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. -i= Specifies the item ID of the precise product structure or assembly to realize. -rev=revision (optional) Specifies the revision of the specified item. Default: Latest. -rule=revision rule (optional) Specifies the name of the revision rule to configure the source assembly. If the name of the rule contains spaces, you must enclose it in quotation marks, that is, “rev rule name”. Default: Latest Working. -cd_type=type (optional) Specifies the type of the product design. If a custom type is not specified, the type of product design created is collaborative design. -date-effectivity=date (optional) Specifies a date in string format (dd-mmm-yy) which must be appended to the specified revision rule. -end_item_id= end_item_id (optional) Specifies the item ID of the end item which must be appended to the specified revision rule. -release_date= release_date (optional) Specifies the release date in string format (DD-MMM-YY) which must be appended to the specified revision rule. -preview_mode Enables preview mode. -create_mode Enables create mode. -preview_file_name=file_name Specifies the full path of the preview file to create or update. Only valid if you enable preview mode. -map_file=file_name Specifies the full path of the existing mapping file that you created using the 4G Populate interface. -batch_size=size Defines the batch size to be used while creating 4GD objects. -split_mode Enables split mode. In split mode, multiple preview files are created. -number_of_batches=number_of_batches Determines the number of preview files created in split mode. The number of files is equal to the number of the design elements in the preview file divided by the number of batches. -split_directory=directory_path Full path to an existing directory, empty folder where split preview files will be created. You must have write access to this directory. -pre_validate_mode Enables pre-validation. Default: false -pre_validation_report_file_name=file_path_name Prevalidation report file system path including the file name. -child_assembly_validation (optional) Designates the entire child assembly for validation. -update Enables update mode. -updateOfDesignChanges (optional) Updates existing realizations of reuse design elements in the collaborative design. This option may be used to synchronize subordinate level changes if you do not want to deploy automatic synchronization. -h (optional) 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. Results are written to the bom_output.txt file in the c:\temp directory on Windows systems or /tmp directory on Linux systems. It lists the shape and reuse elements that are created, together with the total number of objects created. It also contains the time of the last run and total memory consumed. Restrictions None. Examples Copy 4g_populate -u=user1 -p=user1 -g=designer -pre_validate_mode -i=031080 -map_file=C:\map_files\generic_car_mapping.xml -pre_validation_report_file_name=C:\validation_files\pre_validation_report.xml The example above creates a validation report. Copy 4g_populate -u=user1 -p=user1 -g=designer -i=flip_fone_assembly -cd_name=flip_fone_CD -preview_mode -preview_file_name=C:\preview_files\flipfone_assembly_preview.xml -map_file=C:\map_files\flipfone_assembly_mapping.xml The example above creates or updates the flipfone_assembly_preview.xml preview file. You must create an Easy Preview dataset in Teamcenter and import the generated preview file to preview the product design using the 4G Populate interface. Copy 4g_populate -u=user1 -p=user1 -g=designer -i=031124 -cd_name=CD02 -preview_mode -cd_type=C2Cpd0CollaborativeDesign -preview_file_name=C:\preview_files\assy_preview.xml -map_file=C:\map_files\assy_mapping.xml The example above previews the C2Cpd0CollaborativeDesign product design. Copy 4g_populate -u=user1 -p=user1 -g=designer -i=031124 -cd_name=CD02 -preview_mode -date_effectivity=01-Sep-2017 -preview_file_name=C:\preview_files\assy_preview.xml -map_file=C:\map_files\assy_mapping.xml The example above previews the CD02 product design effective 01-Sep-2017. Copy 4g_populate -u=user1 -p=user1 -g=designer -i=031124 -cd_name=CD02 -preview_mode -released_date=01-Sep-2017 -preview_file_name=C:\preview_files\assy_preview.xml -map_file=C:\map_files\assy_mapping.xml The example above previews the CD02 product design that was released on 01-Sep-2017. Copy 4g_populate -u=user1 -p=user1 -g=designer -preview_file_name=C:\preview_files\flipfone_assembly_preview.xml -split_mode -split_directory=C:\preview_files\split_flipfone_preview_directory -number_of_batches=3 The example above splits the flipfone_assembly_preview.xml preview files into smaller preview files that can be executed simultaneously by the 4G Populate utility when creating the product design Copy 4g_populate -u=user1 -p=user1 -g=designer -create_mode -preview_file_name=C:\preview_files\flipfone_assembly_preview.xml The example above creates the flip_fone_CD 4GD product design in Teamcenter from the existing preview file. Copy 4g_populate -u=user1 -p=user1 -g=designer -create_mode -preview_file_name=C:\preview_files\0_Org_flipfone100.xml 4g_populate -u=user1 -p=user1 -g=designer -create_mode -preview_file_name=C:\preview_files\1_batch_flipfone100.xml 4g_populate -u=user1 -p=user1 -g=designer -create_mode -preview_file_name=C:\preview_files\2_batch_flipfone100.xml 4g_populate -u=user1 -p=user1 -g=designer -create_mode -preview_file_name=C:\preview_files\3_batch_flipfone100.xml 4g_populate -u=user1 -p=user1 -g=designer -create_mode -preview_file_name=C:\preview_files\4_batch_flipfone100.xml 4g_populate -u=user1 -p=user1 -g=designer -create_mode -preview_file_name=C:\preview_files\5_batch_flipfone100.xml The example above creates the flip_fone_CD 4GD product design in Teamcenter from existing split preview file. Error Reports By default, if you execute the 4g_populate with the -create_mode and -updateofDesignChanges arguments, a consolidated error report in the XML format at the location specified in the TC_TMP_DIR environment variable. If you do not set this environment variable, the error report is generated at the location from where the 4g_populate utility was executed. If you set the -split_mode argument, multiple error reports are generated. You can set the file name of the report in the 4GPopulate_ErrorReport_FileName environment variable. On setting this environment variable, a consolidated error report is generated for all the 4g_populate executions for a session. You can set this environment variable either as a user or as a system variable. If you set the environment variable from a command prompt, the consolidated error report is generated till you close the command prompt. If you do not specify the complete path in this environment variable, the error report is generated in the folder from where the utility was executed. While specifiying the complete path, do not include any spaces and quotation marks. In the consolidated error report, the latest run is always added as the first element. To view the error report, open it in any browser. Sample consolidated error report Report attribute Description Preview Contains the path of the file used in the 4g_populate uility. Failed Specifies the number of elements with errors. Failed Element Contains the details related to the failed execution.