• admin

IPS Data Upload Utility for Migration - Part 2



Pre Requisites for using IPS Data Upload utility

  • Knowledge of Teamcenter data model (to identify modes & prepare input files)

  • Knowledge of Teamcenter administration (to run utility, to enable & collect logs, to run sql queries if needed to do post validation)

  • Operating system (to know the supported OS for executing IPS)

  • Business data imported into Teamcenter. (to know real names of objects, relations & attributes)

IPS data upload has number of ways of setting configuration and input data options.


- via command line arguments
- a separate configuration file 
- place configuration options in the input data file

Command line arguments take precedence over the other option, it will override the configuration file and the input data file.


Following is the order of precedence with respect to configuration options.

  1. Command line argument

  2. Input data file configuration option

  3. Configuration file option

  4. Teamcenter preference option

When running the IPS Data Upload utility, there are several command line argument that it takes. The arguments take the format,

-option=<value>

The arguments are used to provide login user details, mode, input data & configuration files.


Few commonly used options & its usage are,

-u=<user_id>

where user id is the Teamcenter user id

-p=<password>

where password is the Teamcenter user password

-g=<group>

where group is the Teamcenter user group

-m=<mode>
-mode=<mode>

where mode specifies the mode of operation such as items, bom, datasets, folders or relations. Refer Part 1 blog for details on various modes.

-i=<input_data_file>

where input_data_file is the data file to be uploaded.

-cfg=<config_file>

where config_file is the configuration options file

-o=<output_file>

where output_file is the output log file. If not supplied, it takes the input data file name.

-r=<repeat_file>

where repeat file contains the data lines that are failed. If not supplied, it takes the input data file name with extension as .rep.

-h

to display the full usage of the utility


Input data file

Input data file contains all the information to be imported into Teamcenter. Even though the input data file allows adding configuration options at the top of the file (above header line), it is advisable to use configuration file. With both input & configuration file in place, it enables reusability of input file with different configuration options and reduces manual errors.


Input file should start with header lines (if configuration options are managed in config file, else input file should start with config options followed by header line). Header line defines the field to be imported which either contain internally known keywords or type with property names.

Internal Keywords 
    Eg: ItemId, RevId, Name, Owner, Group

Type:Property strings 
    Eg: I:object_name, R:object_name, IM:object_name,RM:object_name

Where I indicates Item, R indicates Revision, IM indicates Item Master, RM indicates Item Revision Master.


Header lines should be followed with data lines containing the values for each field defined in the header.


The header and data lines are delimited, typically used delimiter is ~(tilde) character.


Rules for the format of input file:

  1. Any line beginning with a [#] character or left blank is ignored.

  2. A header line describing the fields to be imported must be supplied before data lines. This line is denoted by starting with an exclamation mark [!].

  3. The delimiter used in the input data file is identified as the character immediately following the exclamation mark [!] on the header line.

  4. The name of the data fields to use are specified immediately after the exclamation mark and delimiter on the header line [!~].

  5. The header line can be preceded with configuration lines, just as they would be supplied in the configuration file.

  6. If the option is supplied in both the data file and the config file then the data file value takes precedence and overrides the config file value.

Example:

!~ItemID~RevID~Desc~Name~Owner~Group

An example of the Header line followed by a data input line, and preceded by a configuration option is shown below:

ITEM TYPE = Item
!~ItemID~RevID~Desc~Name~Owner~Group
DEMO123~A~The Item Description~ITEM-NAME~admin~dba