Ips Data Upload 10-2-1 TSD

TECHNICAL DOCUMENT
Project Title: IPS_DATA_UPLOAD TECHNICAL DOCUMENTATION
RELEASED
Document Info
Revision: 11.2.1
Copyright © 2015 Siemens Industry Software. All rights reserved.
Copyright in this work is vested in Siemens Industry Software and the document is issued in confidence for the purpose
only for which it is supplied. It must not be reproduced in whole or in part or used for tendering or manufacturing purposes
except under an agreement or with the consent in writing of Siemens Industry Software and then only on the condition that
this notice is included in any such reproduction. No information as to the contents or subject matter of this document or
any part thereof arising directly or indirectly there from shall be given orally or in writing or communicated in any manner
whatsoever to any third party being an individual firm or company or any employee thereof without the prior consent in
writing of Siemens Industry Software.
SIEMENS Technical Document
Issued Date: 5th Mar 2015

Reference: 681319590.doc
CIRCULATION
No. Copies to Location
1 Project Library Internal Community Archive,
Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 13/01/10

Filename: 681319590.doc Page: 2 of 176
DOCUMENT HISTORY
Version Date Author Description
6.5.0a 20/11/2006 Guy Bursell Initial Technical Release for

IPS_DATA_UPLOAD version 6.5.0.
Technical Review and Training
6.5.0 24/11/2006 Guy Bursell Updated from Review and Feedback.
6.6.0 29/11/2006 Guy Bursell Added Checkin/Checkout functionality
Added boms mode missing data field ‘OccQty’

to data fields table in document.
6.7.0 12/01/2007 Guy Bursell Fixed error when check-in an object that is
checked-out to another user.
Enabled config/data fields to set ownership of

a BV/BVR on creation.
Fixed Signal 11 error when uploading large

BOMs on HP/UX.
7.4.0 31/03/2010 Tim Williams See major update list in section Appendix M:
Major updates. This version covers new
features from 6.8.0 through to 7.4.0.
7.6.0 25/10/2010 Tim Williams Includes updates from 7.5.0 and 7.6.0.
See major update list in section Appendix M:
Major updates.
Major updates for 7.7.0 mods.
Main changes:
1) Re-write of relations module to allow any

WSOM object to be attached to any other.
2) Setting of any In Context BOM Line

Attribute.

Add field validation options.
1) Added .POM field modifier to set ‘non

database mandatory attributes defined in
BMIDE.
2) Added .PARTICIPANT, .USER, .GROUP

and .GROUPMEMBER field modifiers.
3) Added support for shared effectivities with

an effectivity ID.
1) Added new pom module to create/update

general POM objects, e.g. CompanyLocation.
Major updates for 9.1.0 and 9.2.0 mods.
1) Added new .POM field modifier to set

individual properties with a POM call to
override BMIDE rules.
1) Added ability to update multiple items from

one data line. Currently only by searching on
item name to find items.
2) Changed some default values for setting

owner and status by parent to OFF.
1) Added new relation fields to filter on parent

and child owner or group, or specify with
PUIDs.
10.1.1 26/11/12 Tim Williams Added details and examples for creating
legacy and modular variant options and
conditions during a BOM import. See BOM
MODULE NOTES and examples in Appendix.
10.2.0 14/12/12 Tim William Added ability to release Identifier objects.

10.3.0 10/01/13 Tim William Can now set general properties on projects.
10.4.0 25/01/13 Tim Williams Added basic ability to create occurrence

effectivities.
10.5.0 18/03/13 Tim Williams Add support for multiple language properties
when using general colon property fields.
10.6.0 27/03/13 Tim Williams Added new field AlternateRevIDs to specify rev
IDs for alternate (substitute) revs for a BOM
child.
10.7.0 05/04/13 Tim Williams Added new option to generate basic ‘nnnnnn’
format item IDs.
10.8.0 27/04/13 Tim Williams Finished off creation of CC and SC SOS

objects.
10.9.0 20/06/13 Tim Williams Added new field AutoItemIDMapping to define

a value to be written to the auto IDs log file for
reference.
10.10.0 25/10/13 Tim Williams Added support to create, update and use
specific revision sequences.
10.11.0 06/12/13 Tim Williams Used new general TC_create_object function

to create items to allow for mandatory item
attributes.
Add new .FIND field modifier to find objects to

set on referenced attributes.
10.11.1 24/01/2014 Tim Williams Added missing documentation for workflow

mode that was added to IPS Data Upload
v7.0.0.
10.12.0 06/02/2014 Tim Williams 1) Added new legacy O&V fields

LVarOptErrorIfMsg and LvarOptErrorIfCond to
set Error If rules.
2) Option names can now indicate options on

items outside of the current BOM
11.0.0 03/04/2014 Tim Williams 1) Added support for MultiField Keys in Tc 10.1
to allow for multiple items with the same item
ID by specifying .KEY fields.
2) Added .BOM_OCC_KEY field modifier to

identify fields to use to identify occurrences to
update during a BOM update.
11.1.0 19/06/2014 Tim Williams 1) Added support for creating relations using

POM on sub-classes to ImanRelation.
11.2.0 03/12/2014 Tim Williams 1) Added .RESOURCE_POOL field modifier

for .PARTICIPANT fields.
11.2.1 05/03/2015 Tim Williams 1) Added some troubleshooting details re non

modifiable properties and shared memory
issues.
REFERENCE DOCUMENTS
Document Revision Date Doc Reference

CONTENTS
1. EXECUTIVE SUMMARY.....................................................................................................12
2. TECHNICAL OVERVIEW...................................................................................................13
2.1 Modes........................................................................................................................ 13
2.2 USAGE...................................................................................................................... 14
2.3 INPUT DATA FILE..................................................................................................... 15
2.3.1 [7.0.0] End of File....................................................................................................... 16
2.3.2 [7.0.0] General properties.......................................................................................... 16
2.3.2.1 [7.0.0] Field Modifiers................................................................................................. 17
2.3.2.2 [7.0.0] Relation properties (Tc8+)..............................................................................22
2.3.2.3 [7.1.0] Setting project................................................................................................. 22
2.4 CONFIGURATION OPTIONS...................................................................................22
2.4.1 [7.6.0] INCLUDE CONFIG FILE.................................................................................22
2.4.2 General Configuration Options...................................................................................23
2.5 RUNNING AN IMPORT............................................................................................. 26
2.6 [9.2.0] Overriding BMIDE rules on attributes..............................................................26
2.7 [11.0.0] MultiField Keys in Tc10+...............................................................................27
2.7.1 Introduction................................................................................................................ 27
2.7.2 Data Field modifiers................................................................................................... 27
2.7.3 Considerations........................................................................................................... 27
3. TROUBLESHOOTING..........................................................................................................29
3.1 The log file.................................................................................................................. 29
3.2 The Repeat File.......................................................................................................... 29
3.3 Debugging.................................................................................................................. 29
3.4 [8.1.0] Field Validation................................................................................................ 29
3.4.1 Command Line Arguments......................................................................................... 30
3.4.2 Configuration Options................................................................................................ 30
3.4.3 Example Report File................................................................................................... 30
4. ITEMS MODE.........................................................................................................................32
4.1 INPUT DATA FIELDS................................................................................................ 32
4.1.1 Item fields................................................................................................................... 32
4.1.2 Revision fields............................................................................................................ 32
4.1.3 Ownership fields......................................................................................................... 33
4.1.4 Miscellaneous fields................................................................................................... 33
4.1.5 Status fields............................................................................................................... 33
4.1.6 Item and ItemRevision Master Forms........................................................................34
4.1.7 Checkin/Checkout/Cancel Checkout..........................................................................34
4.2.1 Items/Revisions.......................................................................................................... 34
4.2.2 Miscellaneous............................................................................................................ 36
4.2.3 Owning Site................................................................................................................ 37
4.2.4 Status and Checkin/Checkout (CICO).......................................................................37
4.3 MODULE NOTES...................................................................................................... 41
4.3.1 RELEASE STATUS................................................................................................... 41
4.3.2 DATE RESTRICTIONS.............................................................................................. 42

4.3.3 CHECK IN / CHECK OUT / CANCEL CHECK OUT..................................................42

4.3.4 UN-RELEASING ITEMS/REVISIONS.......................................................................42
4.3.5 V7 EFFECTIVITIES................................................................................................... 43
4.3.6 CHANGING IDS......................................................................................................... 44
4.3.7 REVISING AND SAVE AS......................................................................................... 44
4.3.7.1 Revise/Save As/Change ID Summary.......................................................................45
4.3.8 [10.10.0] Revision Sequences....................................................................................45
4.3.9 [10.11.0] Setting mandatory attributes.......................................................................46
4.3.10 [10.11.0] Setting special attributes.............................................................................46
4.3.10.1 owning_project........................................................................................................... 46
4.3.10.2 project_list.................................................................................................................. 46
4.3.11 [11.0.0] MultiField Keys in Tc10+...............................................................................46
4.4 COMMAND LINE ARGUMENTS...............................................................................47
4.5 EXAMPLES................................................................................................................ 47
5. BOMS MODE..........................................................................................................................48
5.1.1 BOMs......................................................................................................................... 48
5.1.2 Absolute Occurrences................................................................................................ 50
5.1.3 Engineering Change................................................................................................... 50
5.1.4 Occurrence Notes...................................................................................................... 50
5.1.5 [10.4.0] Occurrence Effectivity...................................................................................50
5.1.6 [7.0.0] Options and Variants.......................................................................................51
5.1.6.1 Legacy Variants......................................................................................................... 51
5.1.6.2 Modular Variants........................................................................................................ 51
5.1.7 [7.0.0] General BOM Properties.................................................................................52
5.1.8 [7.6.0] Part / CAD Alignment (publish) links...............................................................52
5.2.1 BOMS........................................................................................................................ 54
5.2.2 Engineering Change................................................................................................... 56
5.2.3 [7.0.0] Options and Variants.......................................................................................56
5.2.5 [10.4.0] Occurrence Effectivity...................................................................................57
5.3 MODULE NOTES...................................................................................................... 58
5.3.1 BOM OCCURRENCE UPDATE.................................................................................58
5.3.2 CHILD SUBSTITUTION............................................................................................. 59
5.3.3.1 Introduction................................................................................................................ 60
5.3.3.2 Creating a link in the UI.............................................................................................. 60
5.3.3.3 Importing links............................................................................................................ 61
5.3.4 [7.0.0] Legacy and modular variants..........................................................................61
5.3.4.1 Creating options and values.......................................................................................61
5.3.4.2 Creating conditions..................................................................................................... 62
5.3.4.3 [10.12.0] Option Error Rules (Legacy).......................................................................63
5.3.5 [10.4.0] Occurrence Effectivities................................................................................64


5.5 EXAMPLES................................................................................................................ 64
5.5.1 General Example....................................................................................................... 64
6. FORMS MODE.......................................................................................................................65
6.1.1 Forms......................................................................................................................... 65
6.2.1 Forms......................................................................................................................... 65
6.3 MODULE NOTES...................................................................................................... 66
6.4.1 Forms......................................................................................................................... 66
6.5 EXAMPLES................................................................................................................ 66
7. LOVS MODE...........................................................................................................................67
7.1.1 Lovs........................................................................................................................... 67
7.2.1 Lovs........................................................................................................................... 67
7.3 MODULE NOTES...................................................................................................... 67
7.5 EXAMPLES................................................................................................................ 68
8. RELATIONS MODE..............................................................................................................69
8.1 [8.0.0] Any workspace objects...................................................................................69
8.2.1 Relations.................................................................................................................... 69
8.3.1 Relations.................................................................................................................... 72
8.4 MODULE NOTES...................................................................................................... 73
8.4.1 Sub Classed relations using BMIDE OVERRIDE.......................................................73
8.4.1.1 Setting default attributes............................................................................................ 74
8.4.1.2 Setting relation attributes........................................................................................... 74
8.4.1.3 Trial and error............................................................................................................. 75
8.5.1 Relations.................................................................................................................... 76
8.6 EXAMPLES................................................................................................................ 76
9.
MODE 78
9.1.1 Datasets..................................................................................................................... 78
9.1.2 Files........................................................................................................................... 79
9.1.3 Forms......................................................................................................................... 79
9.2.1 Datasets..................................................................................................................... 79

9.3 MODULE NOTES...................................................................................................... 80

9.5 EXAMPLES................................................................................................................ 81
10. FOLDER MODE.....................................................................................................................82
10.1.1 Folders....................................................................................................................... 82
10.2.1 Folders....................................................................................................................... 82
10.3 MODULE NOTES...................................................................................................... 83
10.5 EXAMPLES................................................................................................................ 83
11. PROJECTS MODE.................................................................................................................84
11.1.1 Projects...................................................................................................................... 84
11.2.1 Projects...................................................................................................................... 84
11.3 MODULE NOTES...................................................................................................... 85
11.5 EXAMPLES................................................................................................................ 85
12. CLASSIFICATION MODE...................................................................................................86
12.2.1 classification............................................................................................................... 86
12.3 MODULE NOTES...................................................................................................... 87
12.5 EXAMPLES................................................................................................................ 88
13. IDENTIFIERS MODE............................................................................................................89
13.1.1 Identifiers.................................................................................................................... 89
13.2.1 identifiers.................................................................................................................... 90
13.3 MODULE NOTES...................................................................................................... 90
13.5 EXAMPLES................................................................................................................ 92
14. MANUFACTURING MODE.................................................................................................93
14.1.1 Manufacturing............................................................................................................ 93
14.1.2 [7.0.0] CC and SC...................................................................................................... 94
14.1.2.1 Notes for SC and CC................................................................................................. 96
14.2.1 Manufacturing............................................................................................................ 96
14.2.2 [7.0.0] CC and SC...................................................................................................... 97
14.3 MODULE NOTES...................................................................................................... 98
14.4 COMMAND LINE ARGUMENTS.............................................................................100
14.5 EXAMPLES.............................................................................................................. 100

15. WORKFLOW MODE..........................................................................................................101

15.1 INPUT DATA FIELDS.............................................................................................. 101
15.1.1 Workflow.................................................................................................................. 101
15.1.2 Other relevant fields................................................................................................. 102
15.2 CONFIGURATION OPTIONS.................................................................................102
15.2.1 Workflow.................................................................................................................. 102
15.3 MODULE NOTES.................................................................................................... 103
15.5 EXAMPLES.............................................................................................................. 103
15.5.1 Quick example......................................................................................................... 103
15.5.1.1 Config file................................................................................................................. 103
15.5.1.2 Data File................................................................................................................... 104
16. [9.0.0] POM MODE..............................................................................................................106
16.1 INPUT DATA FIELDS.............................................................................................. 106
16.1.1 Pom fields................................................................................................................ 106
16.1.2 Parent fields............................................................................................................. 106
16.1.3 System fields............................................................................................................ 106
16.2 CONFIGURATION OPTIONS.................................................................................107
16.2.1 Pom.......................................................................................................................... 107
16.2.2 Other relevant options.............................................................................................. 108
16.3 MODULE NOTES.................................................................................................... 108
16.3.1 General methodology of the pom mode...................................................................108
16.3.1.1 Introduction.............................................................................................................. 108
16.3.1.2 Finding objects......................................................................................................... 109
16.3.1.3 Default values.......................................................................................................... 109
16.3.1.4 Create and Update option CSV lists.........................................................................109
16.3.1.5 Object references..................................................................................................... 109
16.3.1.6 Replacing referenced obejcts...................................................................................110
16.3.1.7 Setting properties for convenience...........................................................................110
16.3.1.8 Setting system properties......................................................................................... 111
16.3.2 Attaching to parent objects.......................................................................................111
16.3.3 Notes on creating a POM object..............................................................................111
16.5 EXAMPLES.............................................................................................................. 112
16.5.1 Creating/Updating Web Link forms..........................................................................112
16.5.1.1 Config file................................................................................................................. 112
16.5.1.2 Data file.................................................................................................................... 112
16.5.2 Creating/Updating CompanyLocation objects..........................................................113
16.5.2.1 Config file................................................................................................................. 113
16.5.2.2 Data file.................................................................................................................... 113
17. APPENDIX A: DATE FORMATTING SEQUENCES....................................................114
18. APPENDIX B: ITEMS MODULE EXAMPLES...............................................................116

19. APPENDIX C: BOM MODULE EXAMPLES..................................................................119

19.1 A simple BOM with ownership.................................................................................119
19.2 Unset sequence numbers........................................................................................ 120
19.3 Reset sequence numbers........................................................................................ 120
19.4 Pre delete by occurrence note.................................................................................121
19.5 Delete ALL occurrences........................................................................................... 121
19.6 Set InContext AbsOccID.......................................................................................... 122
19.7 Set InContext AbsOccID in Parent Assembly only on low level components...........124
19.8 Engineering change example...................................................................................125
19.9 Legacy Variants....................................................................................................... 127
19.9.1 Config File................................................................................................................ 127
19.9.2 Data File 1................................................................................................................ 128
19.9.3 Data File 2................................................................................................................ 129
19.9.4 Data File 3: Miscellaneous.......................................................................................131
19.9.5 Date File 4: Set If and Error If..................................................................................132
19.10 Modula Variants....................................................................................................... 133
19.10.1 Config File................................................................................................................ 133
19.10.2 Data File 1: Simple................................................................................................... 134
19.10.3 Data File 2................................................................................................................ 134
20. APPENDIX D: FORMS MODULE EXAMPLES.............................................................135
21. APPENDIX E: LOV MODULE EXAMPLES...................................................................137
22. APPENDIX F: RELATIONS MODULE EXAMPLES....................................................138
22.1 Other 8.0.0 examples............................................................................................... 139
23. APPENDIX G: DATASETS MODULE EXAMPLES......................................................144
24. APPENDIX H: FOLDERS MODULE EXAMPLES........................................................148
25. APPENDIX I: PROJECTS MODULE EXAMPLES........................................................149
26. APPENDIX J: CLASSIFICATION MODULE EXAMPLES..........................................150
27. APPENDIX K: IDENTIFIERS MODULE EXAMPLES.................................................152
28. APPENDIX L: MANUFACTURING MODULE EXAMPLES.......................................153
28.1 [7.0.0] CC / SC Example.......................................................................................... 158
29. APPENDIX M: MAJOR UPDATES...................................................................................160
TABLES
Table 2.1 Outline list of operation modes........................................................................................... 13
Table 2.2 Command line options........................................................................................................ 15

1. EXECUTIVE SUMMARY
The following document provides technical documentation for using the
IPS_DATA_UPLOAD utility developed by Siemens PLM, UK. This utility is used to provide
bulk data upload and data cleanup capability in Teamcenter Engineering and Teamcenter
UA.
The document outlines the functional modules in IPS_DATA_UPLOAD:
o Items
o Forms
o Datasets
o Folders
o BOMs
o Relations
o List of Values (LOVs) (Prior to UA only)
o Identifiers
o Projects
o Manufacturing (Including CC and SC objects and structures)
o Classification
o Workflow [7.0.0]
o Pom [9.0.0]
Each module has various configuration and data definition options, all of which are
described in this document.
The IPS_DATA_UPLOAD utility is available on Windows 2000/XP/2003/7 platform as well

as HP/UX 11x and Solaris UNIX platforms.

2. TECHNICAL OVERVIEW
The IPS_DATA_UPLOAD utility is a generic all-purpose tool used to import data into
Teamcenter Engineering and Teamcenter UA. It is capable of importing various types of
objects and data and operates in a number of modes to achieve this:
2.1 Modes
MODE NAME MODE ARG DESCRIPTION

Items items Used to import Items, ItemRevisions and set their object
properties. Also used to set Item Master and ItemRevision
Master form attributes.
Forms forms Used to import and populate Forms and attach them to
Items or ItemRevision objects.
Datasets datasets Used to import dataset objects and their associated files.
Datasets can be orphaned or attached to Item or
ItemRevision objects.
Folders folder_create Used to import folders. Folders can be imported into folder
folder_insert structures.
BOMs bom Used to import and build BOM structures and BOM related
properties.
Relations relations Used to allow imported data to be related or attached
together using specific relationships defined in Teamcenter
Engineering.
List of Values create_lovs Used to create and populate List of Values.
(LOVs)
[7.0.0] From version 7.0.0 the LOV mode is no longer
available in Tc UA.
Identifiers identifiers Used to set Alternate Identifiers on Items and
ItemRevisions.
Projects projects Used to create, update and assign Projects
Manufacturing mfg Used to Create and Update Teamcenter Manufacturing
objects and to create and update Manufacturing BOM
structures.
Classification inclass Create, Update and Delete Classification (In-Class) In-Class
Objects (ICOs).
Workflow workflow [7.0.0] Used to initiate workflow processes on items and
revisions.
Pom Pom [9.0.0] Used to create and update general POM objects.

Table 2.1 Outline list of operation modes
The ability to use the ips_data_upload utility requires the following pre-requisites:
1. Knowledge of the Teamcenter Engineering/UA data model Teamcenter

Administration.
2. Operating System
3. Business Data being imported.
The ips_data_upload utility itself allows a number of ways of setting configuration and
input data options; via command line arguments, a separate configuration file and even the
ability to place configuration options in the input data file!
If command line arguments are supplied they will override the configuration file and the data
file. The following order of precedence should be observed when specifying configuration
options:-
1. Command Line Argument

2. Data file configuration option
3. Configuration file configuration option
4. IMAN Preference Option.

2.2 USAGE
When running the utility, there are several command line arguments that it takes. These
arguments take the format:-
-option=<value>
The arguments are used to provide login user details, operating mode and data input file
and configuration files as shown in the table below:
OPTION DESCRIPTION
-h Displays the full usage
-u=<user_id> Where <user_id> is the iMAN login user ID
-p=<password> Where <password> is the iMAN users’ password
-g=<group> Where <group> is the users’ group to use
-m=<mode> Specifies the mode of operation, such as items, bom,
-mode=<mode> datasets or relations.
[7.0.0] Can also use –mode=<mode>.
-i=<input_data_file> Where <input_data_file> is the data file to upload
-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
the default filename will be input_data_file.log
-r=<repeat_file> Where is the repeat file which will contain a copy of any
data lines which caused an error. If not supplied the
default filename will be input_data_file.rep
-noautologin [7.0.0] Turns off auto login which would prompt for a user
name and password should any supplied values fail. This
would cause problems during batch processes. So by
turning off auto login with this argument allows the program
to terminate cleanly and provide details in the log file about
a login failure.
-report_file=<report_file> [7.0.0] This option turns off all create and update options
effectively just writing a report of objects found and not
found in the specified report file.
-v [6.9.0] Turns on verbose mode to get more detailed output
about relations being processed.
-h With just –h the full usage will be displayed. Otherwise
-h=<mode> | args specify a mode to get help on or args to get help on
arguments.
-debug=MAX Turns on program debug putput when running. Can be
any of the following: 1|2|4|8|16|32 | MAX
Typically this is set to MAX
-validation=<n> [8.1.0] Turns on field validation and will validate n data
lines. For example, to validate the first 2 data lines, use:-
-validation=2
Validation can also be turned on using configuration
options.

OPTION DESCRIPTION
See the trouble shooting section on [8.1.0] Field Validation.
-validation_import [8.1.0] If supplied turns on import with field validation.
-new_items_ids_log=<New [10.0.0] Specifies a file into which will be written any auto
item IDs log file> generated item IDs if AUTO GENERATE ITEM ID = ON.
Table 2.2 Command line options
The above arguments are generic and apply regardless of mode. Each mode, though, may
have its own set of arguments. To see the arguments specific to a mode use –h=<mode>.
2.3 INPUT DATA FILE

The input data file contains all of the information to be imported into Teamcenter
Engineering/UA. This file is a delimited file, typically using a [~] (tilde) character. The
format of the input data file follows a number of rules:-
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 any 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. 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.
An example of a header line defined using the tilde [~] as the field separator is shown
below.
!~ItemID~RevID~Desc~Name~Owner~Group
In this example, there are 6 fields defined using case sensitive keywords. An example of
the Header line followed by a data input line, and preceded by a configuration option is
shown below:
ITEM TYPE = Document

!~ItemID~RevID~Desc~Name~Owner~Group
GUY12345~A~The Item Description~ITEM-NAME~mr_user~operations
The above data line will create or find the Item GUY12345, Revision A, and set its Item
Description, Item Name and Owning User and Owning Group properties to the values
supplied.
If a field needs to be ignored during input, maybe because the column contains only
superfluous information, then insert Ignore: in the field name, e.g.:-

Ignore:Owner~Ignore:Group
[7.0.0] To set a property to a null or empty value use the keyword NULL as a value.
2.3.1 [7.0.0] End of File
[7.0.0] If a line containing END-OF-FILE is included in the file then processing will stop at
that line. This is useful to test just a few lines of a large input file.
[8.1.0] An alternative test import method is to use the validation options to control how many
lines are imported as a validation test (if any). See the trouble shooting section on [8.1.0]
Field Validation.
2.3.2 [7.0.0] General properties
IPS Data Upload has many predefined field names that can be used in the header line, like
ItemID and RevID in the example above. These are all detailed in the specific module
sections in the rest of this document and there are some predefined fields which are
mandatory for each mode.
To provide more flexibility version 7.0.0 introduced the ability to specify any general and
writable Teamcenter object property instead of using a predefined field name. If a non
writeable property is specified then an error will be given stating that the property cannot be
written too.
The format to specify a general property is:-
<OBJECT>:<property>
Where:-
<OBJECT> specifies the object by:-
type, e.g. Document, UGMASTER, Design BOMView Revision;
class specified within round brackets and can be a parent class,
e.g. (Item), (Dataset);
or keyword, e.g. I for Item, BV for BOMView.
<property> specifies the Teamcenter property name
Example:-
!~ItemID~DesignBOMView:owning_group ~Design BOMView Revision:owning_group
The following table shows the available keywords to identify objects:-
OPTION OBJECT
ACT Activity
I Item
R ItemRevision
FORM Form
DSET Dataset
FL Folder
MEPR MEProcess
MEPRREV MEProcessRevision
MEOP MEOperation
MEOPREV MEOperationRevision

OPTION OBJECT
BV BOMView
BVR BOMView Revision
BL BOM Line
NOTE: This is not available via a type or class.
BLCTXT [8.0.0] BOM Line In Context to another revision.
SC Structure Context
CC Collaboration Context
WFPROC Workflow Process
ATTACHMENT Attachment to item or revision
IDENTIFIER [10.2.0] Identifier
IDENTIFIER_REV [10.2.0] Identifier rev
PROJECT [10.3.0] Project.
NOTE: The general property owning_user requires a fully defined user identification containing
person name and user ID, e.g. Tim Williams(tim) as seen in Tc.
2.3.2.1 [7.0.0] Field Modifiers
Version 7.0.0 also introduced field modifiers which can be used with general properties in the
format:-
<OBJECT>:<property>[.<modifier>[.<modifier>[.<modifier>.<…>]]]
The following table shows the available modifiers:-
OPTION DESCRIPTION
.FILE Indicates that the value supplied in the data line for this field is
actually the name of a file containing the values to be set for this
field.
The root directory containing the value files can be set by the
configuration option VALUE FILES ROOT DIR.
This will typically be used for array or note fields. See the
example for ARRAY just below.
.DATE Indicates that the field is a date property for the format of the
supplied date values is specified in the configuration option
DATE FORMAT.
.ARRAY Indicates that the field is an array property.
By default values supplied for an array will be split on a comma,
but a different separator can be specified using the configuration
option MULTI VALUE SEPARATOR STRING.
Alternatively specify the values in a file, e.g.:
!~ItemID~RevID~RM:array_attr.ARRAY.FILE
000001~A~array_attr_list_000001A.txt
File array_attr_list_000001A.txt:
Value 1
Value 2
Value 3

OPTION DESCRIPTION
.UPPER Forces the value to be set as UPPER CASE.
.LOWER Forces the value to be set as lower case.
.TAG Indicates that the value supplied is the tag (or PUID) of an object
to be set in a typed or untyped reference property.
.BY_VAL Indicates that if a typed reference property has an LOV attached
to it then a value from the LOV has been specified instead of an
object tag.
.PARENT Indicates that the property value being set should be read from
the objects parent, e.g. for a revision set the property value to
the same as the value on its owning item.
The same result can be achieved by supplying a value of
$PARENT.
[11.0.0] When used in conjunction with a .KEY modifier on an
item ( I: ) field it distinguishes between parent and child
MultiField key fields for parent and child items in bom and
relation modes.
.PARTICIPANT [8.2.0] Used to set Participant relations, e.g. ProposedReviewer,
Analyst.
Must be used with .USER, .GROUP or .GROUP_MEMBER.
.USER [8.2.0] Specifies that the supplied value is a user name to find
the user object to attach, e.g. use with .PARTICIPANT to attach
a user.
.GROUP [8.2.0] Specifies that the supplied value is a group name to find
the group object to attach, e.g. use with .PARTICIPANT to
attach a group.
.GROUP_MEMBER [8.2.0] Specifies that the supplied value is a group member to
find the group member object to attach, e.g. use
with .PARTICIPANT to attach a group member.
The string format to specify a group member is:-
<group1[,group2[,…]]>/<role1[,role2[,…]]>/<user1[,user2[,…]]>
For example:-
dba/DBA/infodba
Multiple group member strings can be supplied separated by the
separator defined by the config option:-
MULTI VALUE SEPARATOR STRING.
The ‘/’ and ‘,’ separators can be specified using the config
options:-
GROUP MEMBER MAIN SEPARATOR
GROUP MEMBER MULTI VALUE SEPARATOR
.RESOURCE_POOL [11.2.0] Specifies that the supplied value is a resource pool to
add to a .PARTICIPANT field. The format is:-
<group>[/<role>[/NO_SUB_GROUPS]]
For example:-
dba - defaults to * for role
dba/*
dba/DBA
*/DBA

OPTION DESCRIPTION
dba/*/NO_SUB_GROUPS
.POM [9.2.0] Sets the value using a POM function to override access
and any BMIDE rules set on the attribute, e.g.
write_only_if_null.
Alternatively the new config option SET COLON PROPS WITH
POM can be used to provide a CSV list of general property
fields to be set with POM functions. See section 2.4.2.
.LANG[=lang] [10.5.0] Specifies a field as a language field. By default the
value in the config option DEFAULT LANGUAGE will be used
as the language unless specified with the optional =lang, e.g.:-
R:object_name.LANG=fr_FR
Multiple language fields can be set in the same data file. For
example:-
DEFAULT LANGUAGE = fr_FR
!~ItemID~RevID~R:object_name.LANG~R:object_name.LANG=de_DE
000001~A~French name~German name
By default the language value status will be set to Approved, but
this can be defaulted with the config option DEFAULT
LANGUAGE STATUS.
NOTE: To be able to set languages against a property it must
be defined as a language field in BMIDE.
.MAND [10.11.0] Indicates a mandatory field. Currently only applies
when a new Item is created. Use it to indicate mandatory item,
rev and master form attributes so that they get set at the time of
creation.
For example, if object_desc has been set as mandatory for the
item use:-
I:object_desc.MAND
NOTE 1: The .POM modifier cannot be used in conjunction with

.MAND!
NOTE 2: To set mandatory master form attributes when the item
is created the field name must start with the master form type
and not the shortcuts IM or RM since these are not treated as
general properties. So, for example use:-
TW4_ItemMaster:project_id.MAND
And not
IM:project_id.MAND
NOTE 3: When setting the a mandatory attribute the type cannot
be determined, therefore if an array is being set with multiple
values add the .ARRAY field modifier, e.g.:-
I:<array_attr>.MAND.ARRAY
NOTE 4: Items with MANDatory properties, specified with
the .MAND field modifier, must be created in items mode. This
is because multiple sets of .MAND fields, i.e. for parent and child
items, are not supported.
.FIND=<search_attrs> [10.11.0] Finds other objects to set on referenced attributes.
For example can be used to find a TC_Project object to set as
the owning_project.

OPTION DESCRIPTION
The <search_attrs> specifies the class of object to find and the
attributes to search on in the format:-
<Class><sep><attr1>[<sep><attr2>[…]]
I.e. a class and at least one attribute separated by a
configurable separator using the config option FIND FIELD
DATA SEPARATOR, or a comma by default.
Values supplied in the data line, using the same separator, will
supply values for each attribute to search on. Any value can be
blank to not search on a specific attribute for that data line. A
blank value will perform no search at all.
If more than one value is found for a non-array attribute then the
first object will be set for the attribute. An array attribute will
have all objects set.
For example, to set owning_project:-
I:owning_project.FIND=TC_Project,project_id
Project X
Project Y
The first line here is the header field and the others are example
data values.
An asterix, *, can be used in a value to perform a wild card
search.
For example, to find a list of test projects to set as a project list
where the project ID starts with Test and the name = Test:-
I:project_list.POM.FIND=TC_project,project_id,project_name
Test *,Test
Note that this example also uses the .POM field modifier as
project_list is normally a non-modifiable attribute.
NOTE 1: Currently only string attributes can be searched on to
find objects using the .FIND modifier.
.KEY [11.0.0] Indicates MultiField Key fields to provide unique
property values to find specific items that can have the same
Item ID.
To provide different keys for parent and child items, e.g. in bom
mode child keys must be further identified by adding the .CHILD
modifier.
.CHILD [11.0.0] Indicates that a field is used to identify a child property.
This is used in conjunction with the .KEY modifier to differentiate
between parent and child MultiField Key fields.
.BOM_OCC_KEY [11.0.0] Identifies fields during a BOM update that are used to
identify an occurrence to be updated. This fields can be used as
well as or instead of the fields specified with the BOM UPDATE
ID FIELDS configuration option
2.3.2.1.1 [9.0.0] Pom module modifiers

The following field modifiers are specific to the pom module:-
OPTION DESCRIPTION
.KEY Used to indicate key fields to search on to find objects being

OPTION DESCRIPTION
created or updated.
For example, to look for CompanyLocation objects using name
and type:-
!
~CompanyLocation:object_name.KEY~CompanyLocation:object
_type.KEY
.CLASS Used to define the class name of an object to attach to a typed
or un-typed reference attribute.
For example to create a Web Link form and specify the WebLink
class (to store the url value) in the form’s data_file attribute:-
!
~Form:object_name.KEY~Form:object_type.KEY~Form:object_
desc~Form:data_file.CLASS~WebLink:url~
google~Web Link~Google
UK~WebLink~http://www.google.co.uk/
NOTE: This is just an example to create a form using the pom
mode, normally the form mode would be used.
.REPLACE Used to replace an existing referenced object stored in a typed
or un-typed reference attribute.
.PROP Used to specify that the value should be set as a general
property rather than using direct POM functions to do everything
directly.
This is useful for situations like the example described above for
.CLASS for creating forms in which case the WebLink class was
defined against the Form’s data_file attribute in one field and the
url in another. But by using the .PROP modifier this can be
specified in one field using Form:url.PROP.
Another important distinction here is that the .CLASS method
would look for an existing WebLink object with the specified url
and attach it to the current form. Which in the case of forms is
not good as the form could never be deleted as it would
reference a WebLink object attached to another form. Whereas
the .PROP method would create a new WebLink object every
time.
However, using the pom mode, the option CREATE POM
OBJECTS ALWAYS can be used to ensure a new object is
always created.
See the [9.0.0] POM MODE section for full details on creating/updating general POM objects.
2.3.2.2 [7.0.0] Relation properties (Tc8+)
Also supported from Teamcenter 8 onwards is the ability to set properties on relations when they
get created. For example when a form or dataset is attached to an item or revision then a
property can be set on the relation created between the two objects.
To set a relation property define a general property field with the relation name as the type, e.g.:-
IMAN_specification:<property>

2.3.2.3 [7.1.0] Setting project
Projects can now also be assigned to individual objects using the general properties format by
specifying any of the project_ids, project_list, projects_list property.
For example to set projects for any dataset use the field:-
(Dataset):project_ids
Or
DSET:project_ids.
Multiple projects can be supplied in a comma separated list with no spaces. A value of NULL will
un-assign all projects from the object. This can also be used as an alternative to set projects on
items and revs too.
The projects must already exist. This method will not create or update projects. Use the normal
projects mode and fields to do this. Errors will be provided for any project which does not exist.
2.4 CONFIGURATION OPTIONS

Configuration options are generally defined in the configuration file, although some can be
placed at the top of the data file before the header line. There are options to control a
variety of functions and take the format:-
OPTION NAME = <value>
The <value> may be user values, such as an Item or Form type for instance, or predefined
keywords such as ON or OFF for example, used for switching options. An example of
defining configuration options is shown below.
CREATE ITEMS = ON
FORM TYPE = Mfg Data Form
2.4.1 [7.6.0] INCLUDE CONFIG FILE
In version 7.6.6 a new configuration option INCLUDE was added to include another config
file, e.g. a global_config file to set general settings like DATE FORMAT.
Multiple INCLUDE options can be used and also nested through config files, e.g.
global_config.cfg
DATE FORMAT = %m/%d/%Y
DEFAULT REV = 01
NEWLINE TOK = |
SET BYPASS = ON
create_items_common.cfg
INCLUDE = global_config.cfg
CREATE ITEMS = ON
CREATE REVS = ON
UPDATE ITEMS = OFF
UPDATE REVS = OFF

create_document_items.cfg
INCLUDE = create_items_common.cfg
ITEM TYPE = Document
The included configuration files will be looked for in the same directory as the main
configuration file as specified with the –cfg argument, unless a specific path is supplied for
the included config file.
2.4.2 General Configuration Options
The following are general options which are not related to any specific module:-
FIELD DESCRIPTION
INCLUDE [7.6.0] Include another configuration file.
See section [7.6.0] INCLUDE CONFIG FILE above for
details.
MODE Re-set the mode. **OBSOLETED**
LOG FILE Override the default log file name.
REPEAT FILE Override the default repeat file name.
FOLDER NAME Default folder name for new items and other objects.
NOTE 1: Only new objects are placed in the specified
folder. To add existing objects to a folder use the
folder_insert or relations modes.
NOTE 2: If the folder does not exist it will be created. To
get the folder added to the import user’s Home folder set
TOP FOLDER = Home and prefix the FOLDER NAME
folder with \.
FOLDER TYPE Default Folder Type for folder creation/insertion.
NEWLINE TOK Newline token to allow multi line text entry into a Note form
attribute type. Default if not specified is ‘%#10;’
SET BYPASS ON|OFF flag to control if bypass privilege is available for
DBA user. (General All-module option).
UPDATE MODIFY DATES ON|OFF flag to control if the modification date on updated
objects should be changed.
NOTE: Requires SET BYPASS = ON
DATE FORMAT Describes the format date fields are in.
For example:
%d-%b-%Y %H:%M = 30-Apr-2003 07:50
%d/%m/%Y = 30/04/2003
%y%m%d = 03/04/30
Note: The format is the same as that used by the UNIX
date command. All of the options can be found by using
man date at the UNIX prompt.
The default is format is: 30-Apr-2003 07:50

FIELD DESCRIPTION
See Appendix A for all DATE FORMAT values available.
TC DATE FORMAT [10.0.1] Sets the date format used by Teamcenter in case it
can’t be read from timelocal_locale.xml.
NOTE: For Tc9.1 64bit this MUST be used as the value
from timelocal_locale.xml is not useable.
The typical Tc data format is:-
TC DATE FORMAT = %d-%b-%Y %H:%M
OUTPUT COL SIZE TYPE [6.9.0] These three options can be used to control the size
of the output columns for the Type, Name and Status
OUTPUT COL SIZE NAME
columns respectively. Simply set them to the number of
OUTPUT COL SIZE characters required in the column.
STATUS
MULTI VALUE SEPARATOR [7.0.0] Defines the separator used between values for an
STRING array property.
The default separator is a comma.
VALUE FILES ROOT DIR [7.0.0] Sets a root directory containing files which contain
values for properties define by a general property field with
the .FILE modifier. See section [7.0.0] General properties
for details.
LOG FILE FORMATS [7.0.0] Specifies formats for additional log files as a CSV list
containing one or more options from:-
CSV Creates a Comma Separated Values file with an
extension of .csv.
DELIM Creates a delimited file with an extension of
.txt.
The original log file is still written as normal.
DELIM FORMAT SEP [7.0.0] Specifies the delimiter to use with a LOG FILE
FORMAT of DELIM.
The default is the separator that was used in the log file.
DATA VALIDATION [8.1.0] ON|OFF flag to turn field validation off and on.
Validation can also be turned on using command line
arguments.
DATA VALIDATION [8.1.0] ON|OFF flag to turn import with field validation off
IMPORT and on.
DATA VALIDATION [8.1.0] Provides the name of a folder to put new objects
IMPORT FOLDER into, specifically for validation.
DATA VALIDATION LINE [8.1.0] Specifies how many lines to perform field validation
COUNT on.
GROUP MEMBER MAIN [8.2.0] Specifies the main separator in
SEPARATOR a .GROUP_MEMBER filed that separate the group, role
and user values.
The default value is a forward slash (/).
GROUP MEMBER MULTI [8.2.0] Specifies the value separator in

FIELD DESCRIPTION
VALUE SEPARATOR a .GROUP_MEMBER filed that separate individual group,
role and user values.
The default value is a comma (,).
SET COLON PROPS WITH [9.2.0] Provides a CSV list of general property fields (or
POM ‘colon’ (:) fields) which are to have their values set with
POM functions to override access and BMIDE rules on
attributes. This can be used instead of, or as well as, using
the .POM field modifier.
A value of ALL can also be supplied to set all general
property fields using POM.
The fields defined in the list can include their object type
prefix (I: for items, R: for rev etc) or not. If they do then
only the attribute for that object will be set using POM and
fields setting the same attribute for other objects will not. If
just the attribute name is supplied then all object type fields
setting that attribute will use POM.
For example:-
#SET COLON PROPS WITH POM = ALL
SET COLON PROPS WITH POM =
R:ContactName,dt7subject
!
~ItemID~RevID~R:ContactName~R:dt7subject~I:dt7subject
Will use POM for R:ContactName, R:dt7subject and
I:dt7subject.
DEFAULT LANGUAGE [10.5.0] Sets the default language for a field with a colon
header containing the modifier .LANG. E.g.:-
R:object_name.LANG
DEFAULT LANGUAGE [10.5.0] Sets the default language status for a language
STATUS field.
The default is Approved. Available options are:-
Approved
Pending
Review (for in-review)
Invalid
FIND FIELD DATA [10.11.0] Specifies the separator to use for a .FIND field
SEPARATOR modifier to separate the class and attributes names in the
header field and the values in the data to search on.
See .FIND in section [7.0.0] Field Modifiers.
2.5 RUNNING AN IMPORT

In order to run a data import, a Teamcenter Engineering sourced environment is required.
This involves setting a number of environment variables and is achieved as shown below,
on the Windows platform. These same environment variables are also required on other
platforms although the method of executing is slightly different.

C:\>SET IMAN_ROOT=C:\APPS\TCENG0913
C:\>SET IMAN_DATA=\\SERVER\SHARE\iman_data
C:\>%IMAN_DATA%\iman_profilevars
C:\> ips_data_upload_2007u_1_4_nti_7_3_3.exe –u=infodba –p=infodba
–i=data_file_name –cfg=config_file_name –m=mode -v
2.6 [9.2.0] Overriding BMIDE rules on attributes

Generally IPS Data Upload sets attributes using AOM (Access Object Manager) functions
after creation, or using object type specific functions upon creation, e.g. ITEM_create_item.
These functions check both access permissions and BMIDE rules on attributes and will fail if
the permissions or a rule disallows an attribute to be set, or not set for mandatory attributes.
However, POM (Persistent Object Manager) functions act at a higher level in the Tc class
hierarchy and effectively bypass access permissions and BMIDE rules. But they also
bypass built it object integrity checks. So setting a value with POM could potentially render
an object un-useable in Teamcenter and so great care must be taken setting values with
POM functions.
Some rules, like mandatory attributes, may cause the actual create function to fail. For
some object types it may be possible to use the pom module, introduced in IPS Data
Upload version 9.0.0, to create the objects instead. But if there’s a mandatory attribute set
on an item type and ITEM_create_item fails then it will be very difficult to create this with
POM as the revision also has to be created and linked correctly to the item, and master
forms may also be required and linked correctly to the item and rev too.
However, to update an existing object to set an attribute that has a BMIDE rule that
prevents the update, e.g. write_only_if_null, then the .POM field modifier or config option
SET COLON PROPS WITH POM, introduced in version IPS Data Upload version 9.2.0,
can be used to set the attribute using POM.
From IPS Data Upload version 9.1.0, with the creation of items mandatory attributes set on
the revision don’t require the new POM options since they are now set before the item is
saved. In 9.0.0, these were being set after the item was saved and so failed. This only
applies to general property (or colon) fields though. So the keyword fields like Name and
Desc are still set after the item is saved and will fail if set to mandatory in BMIDE. To set
these use their corresponding colon fields, e.g. R:object_name and R:object_desc.
2.7 [11.0.0] MultiField Keys in Tc10+
2.7.1 Introduction
Prior to Teamcenter 10 only one item could exist with an item ID, i.e. another item could not
have the same item ID as another item.
From Tc10 this is no longer the case with the introduction of MultiField Keys. Through
BMIDE additional item properties can be defined as MultiField Keys to be combined such
that their values produce an overall unique identification for each item.
Typically object_type acts as a default key so that items can be created with the same item
ID with different item types, but only one item per type. But, with another key defined as
well, then multiple items can be created with the same item ID and the same item type.
For IPS Data Upload this has required modifications across most modules since most of
them need to find an item so they now need to be able to handle multiple fields to define

values to use to search for an item and handle the situation where more than one item is
returned.
2.7.2 Data Field modifiers
To identify fields that are supplying a key value to search for an item the field modifier .KEY
is used, for example when object_type is a MultiField Key then I:object_type.KEY is used.
Item ID is treated as a key by default and so does not have the .KEY modifier added.
Some modules require more than one set of key fields, these are bom, relations and mfg,
although mfg does not support MultiField Keys in version 11.0.0 of IPS Data Upload.
For bom and relations distinction must be made between parent and child key fields. This
is done by adding the .PARENT and .CHILD modifiers respectively.
For example, a bom data file with keys may look like this:-
!~ItemID~RevID~I:object_type.KEY.PARENT~I:pw6_mfk_key1.KEY.PARENT~ChildID~ChildRev~I:object_type.KEY.CHILD~
I:pw6_mfk_key2.KEY.CHILD.BOM_OCC_KEY~SeqNo
M000001~A~PW6_MFK_TestType~val1~M000001~A~PW6_MFK_Type2~val1~10
2.7.3 Considerations
1. MultiField Key properties must be defined as Create Input properties in BMIDE as the
value must be supplied for item creation. If this is not done then there will be errors
received during item creation that the property is not a Create Input property.
2. Since MultiField Key properties are mandatory by definition they don’t have to be
specified as .MAND fields as well as all key fields have to be supplied with non-null
values to create an item.
3. If not all keys have fields specified and values supplied to find a single item then an
error will be given if more than one item is found.
4. Currently, in version 11.0.0 it’s not possible to update multiple items with the same key
values, if not all are defined for uniqueness, from a single data line, i.e. without
supplying all key values. So a separate line must be supplied for each item to be
updated by providing all of its unique key values.
5. Items with MANDatory properties, specified with the .MAND field modifier, must be
created in items mode. This is because multiple sets of .MAND fields, i.e. for parent
and child items, are not supported.

3. TROUBLESHOOTING
3.1 The log file

A log file is always produced when IPS_DATA_UPLOAD is run. This log file will report all
successes, failures and warnings. Where a failure or warning is encountered, information
about this event will also be shown in the log file. The log file will have the file extension:
.log.
At the top of the log file is a list of the configuration settings that were set during the upload.
[7.1.0] Only configuration options relevant to the mode used are included and true
configuration option names are used with options displayed whether or not they were set.
This provides a very useful resource of information to help see what options are available
and their syntax.
3.2 The Repeat File

Where errors or failures are encountered, a repeat file is generated at the same time. This
file will contain the line(s) from the data input file where an error or failure was encountered.
The repeat file will have the file extension: .rep.
The repeat file is itself an input data file and contains the original header line as well as all
failed data lines. Therefore once the problems have been solved the repeat file can be used
to input the data that originally failed.
3.3 Debugging
In some remote cases, where an error being encountered is complex or not reported, it may
be useful to have further detailed information. In this instance, a system log (.syslog) is
generated and automatically stored, typically, in the %TEMP% folder location on Windows.
In order for the syslog file to provide meaningful information, it is important the
accompanying .pdb file (Microsoft program debug database) exists in the same location as
the IPS_DATA_UPLOAD executable. This is only required on the Windows platform.
Low level debugging information can also be generated when the utility is run providing a
trace of the operation of the utility. The following environment variables should be set in the
sourced Teamcenter Engineering environment the utility is running in and takes the format:
DEBUG_MAX=MAX
DEBUG_FILE_NAME=<filename>
For example, on Windows use:-
C:\>SET DEBUG_MAX=MAX
C:\>SET DEBUG_FILE_NAME=c:\debug.log
C:\>Run upload
This will then create a debug trace in the file c:\debug.log which is typically very useful
to Siemens PLM Technical personnel in resolving any problems.
3.4 [8.1.0] Field Validation

New field validation is available in version 8.1.0.

Field Validation is used to validate that fields and values line up correctly in the data file and
will write a report for each line required, the default is one line, providing a list of <FIELD
NAME> : <FIELD VALUE> pairs and will indicate if there are fields without values specified
or values without fields specified.
Field validation is turned on with the DATA VALIDATION configuration option or the
–validation=n argument. The number of data lines to be validated can be specified and
these lines can optionally be imported.
By default the validated data lines will not be imported, but the configuration option DATA
VALIDATION IMPORT or the command line argument –validation_import can be used to
turn on import. In which case each validated line will also be imported.
Any errors encountered during the import, along with the normal import output will also be
written to the validation report file.
The name of the validation report file is <data_file>_field_report.txt.
3.4.1 Command Line Arguments

OPTION DESCRIPTION
-validation=<n> [8.1.0] Turns on field validation and will validate n data
lines. For example, to validate the first 2 data lines, use:-
-validation=2
-validation_import [8.1.0] If supplied turns on import with field validation.
3.4.2 Configuration Options

FIELD DESCRIPTION
DATA VALIDATION [8.1.0] ON|OFF flag to turn field validation off and on.
DATA VALIDATION IMPORT [8.1.0] ON|OFF flag to turn import with field validation off
and on.
DATA VALIDATION IMPORT [8.1.0] Provides the name of a folder to put new objects
FOLDER into, specifically for validation.
DATA VALIDATION LINE [8.1.0] Specifies how many lines to perform field validation
COUNT on.
3.4.3 Example Report File
** ERROR: Unknown identifier 'BadField' in header at position 13 -

ignored **
HEADER LINE
ItemID¦RevID¦Folder¦Name¦Desc¦I:project_list¦CreateDate¦Ignore:Own
er¦Ignore:Group¦Ignore:ModifyDate¦Ignore:LastModBy¦R:DocumentSubje
ct¦BadField
------------------------------------------------------------------

----
DATA LINE 1
DOC-700001¦01¦a/b/c/d¦Tooling¦Tooling Allocation Decision
Record¦¦01/01/2010 00:00:00¦¦¦¦¦Tooling Allocation Decision
Record¦Bad Field Value¦Duff1¦Duff2¦
FIELD VALUES
[ 1] ItemID : 'DOC-700001'
[ 2] RevID : '01'
[ 3] Folder : 'a/b/c/d'
[ 4] Name : 'Tooling'
[ 5] Desc : 'Tooling Allocation
Decision Record'
[ 6] I:project_list : ''
[ 7] CreateDate : '01/01/2010 00:00:00'
[ 8] Ignore:Owner : ''
[ 9] Ignore:Group : ''
[ 10] Ignore:ModifyDate : ''
[ 11] Ignore:LastModBy : ''
[ 12] R:DocumentSubject : 'Tooling Allocation
Decision Record'
[ 13] BadField : 'Bad Field Value'
VALUES WITH NO FIELDS (2)...
[ 14] : 'Duff1'
[ 15] : 'Duff2'
------------------------------------------------------------------
----
Line Action Obj Type Obj Name
Status - Notes
==================================================================
=================================
(0002)[0001] Document DOC-700001
ITEM EXISTS -
[0002] DocumentRevision DOC-700001 / 01
REV EXISTS - (SeqID 1)
3.5 [11.2.1] Non Modifiable Properties

Some system properties are unfortunately non-modifiable and result in an error like:-
ERROR: 38060 ERROR MSG:Property %1$s is not modifiable..

Examples of such properties are owning_user, owing_group and date_released.

These error occur when using the colon property format, such as R:date_released.
There are two methods to try to overcome this, but it depends on the property and how the
value is stored in Teamcenter, so some knowledge of the data model is important.
NOTE: Some properties, like project_list, where existing keywords did not exist, have been
coded to be recognised and set using appropriate ITK functions.
3.5.1 Method 1 – Use a supplied keyword
If the property is a standard system one like owning_user then look for an IPS Data Upload
supplied keyword, e.g. Owner, in the fields section for the mode being used, though most
can be found in the Items mode, in particular sections 4.1.3 Ownership fields and 4.1.5
Status fields.
3.5.2 Method 2 – Use the POM modifier
If it’s known that the property is stored in a single attribute in the database including links to
other existing objects, unlike status which has a separate status object created and
attached, then it may be possible to use the .POM field modifier to set the attribute directly.
If a reference is required to another object the .TAG field modifier can also be used with
.POM if the internal UID of the object to be references is known. Or the .FIND field modifier
could be used to specify the class and unique attribute values to find the required object, for
example:-
HEADER: I:project_list.POM.FIND=TC_project,project_id,project_name
VALUE: Test *,Test
3.6 [11.2.1] Shared Memory Issues

There have been reports that setting the preference
TC_USE_PREFS_SHARED_MEMORY to TRUE has resulted in IPS Data Upload
terminating abnormally after the copyright and header messages have been displayed. This
is possibly only on 64 bit. So the preference needs to be set to FALSE.

4. ITEMS MODE
This section outlines the input data field definitions, configuration options and usage
information for the items mode. The items mode is used to import data around the following
criteria:
o Create Items, Item Revisions and set/update their properties

o Apply Release Status
o Populate Item and ItemRevision Master forms
This mode is entered by default if no mode is specified in the command line options for the
utility or by setting the command line argument:
-m=items
4.1 INPUT DATA FIELDS
4.1.1 Item fields

FIELD DESCRIPTION
ItemID Item ID
Name Applies to Item if no Rev supplied, otherwise applies
the Rev Name.
Desc Applies to Item if no Rev supplied, otherwise applies
the Rev Description.
ItemName Specifically Item Name
ItemDesc Specifically Item Description
Uom Unit of Measure
NewItemID New Item ID to change existing Item ID to or "save as"
to depending on settings of CREATE ITEMS/UPDATE
ITEMS.
See section REVISING AND SAVE AS for further
details.
ItemType Specifies the Item Type to use.
OldItemID [6.10.0] Specifies an old item ID to look for in attached
relations to change to the current ID.
AutoItemIDMapping [10.9.0] Defines a reference mapping value to be
written to the auto generated IDs log file.

4.1.2 Revision fields

FIELD DESCRIPTION
RevID Revision ID
RevName Specifically Rev Name
RevDesc Specifically Rev Description
NewRevID New Rev ID to change existing Rev ID to or "save as"
to depending on settings of CREATE REVS/UPDATE
REVS
RevSeqID [10.10.0] Used to specify a specific revision sequence
to create or update.
NOTE: The specified sequence ID will only be created
if it’s larger than the current highest sequence ID. And
it’ll be created by successive check-outs/check-ins
until the required sequence ID is obtained.
4.1.3 Ownership fields

FIELD DESCRIPTION
CreateDate Creation Date
ModifyDate Last Modified Date
Owner Owning User
Group Owning Group
LastModBy Last Modified by user
OwningSite Owning Site. Use a value of “LOCAL” to unset the
site.
4.1.4 Miscellaneous fields

FIELD DESCRIPTION
Folder Folder Name to put new items in
Ignore:<Field> Used to Ignore a field, e.g.:-
Ignore:RevID

4.1.5 Status fields

FIELD DESCRIPTION
Status Release status name
ReleaseDate Release date (for both status object and workspace
object).
EffStartDate Effectivity Start Date
EffEndDate Effectivity End Date
UnitStart Unit Serial Number start
UnitEnd Unit Serial Number end
BOStatus Release status for Based On Item/Revision
BOReleaseDate Release date for Based On Item/Revision
EffEndItem Effectivity End Item ID
EffID [8.2.0] Specifies an effectivity ID.
4.1.6 Item and ItemRevision Master Forms

FIELD DESCRIPTION
IM:<attr> To set an Item Master form attribute.
IMD:<attr> To set an Item Master form date attribute.
RM:<attr> To set an Item Revision Master form attribute
RMD:<attr> To set an Item Revision Master form date attribute
NOTES: Item and Item Revision Master Forms
o The attribute name (replacing <attr> above) must be the real name from the
database and not the display name.
o If the attribute is defined in the database as a date then use IMD: or RMD:.
Then the date format configuration option (DATE FORMAT) can be used in
the configuration file to define the format of the dates supplied in the data
file.
4.1.7 Checkin/Checkout/Cancel Checkout

FIELD DESCRIPTION
CheckOutID Checkout Change ID (MAX 32 chars)
CheckOutReason Checkout Reason/Comment text (MAX 240 chars)

4.2.1 Items/Revisions
FIELD DESCRIPTION
CREATE ITEMS ON|OFF flag to control creation of Items
UPDATE ITEMS ON|OFF flag to control updating Items
CREATE REVS ON|OFF flag to control creation of Revisions
UPDATE REVS ON|OFF flag to control updating Revisions
UPDATE LATEST REV ON|OFF flag to use attach to latest rev/update the latest
rev.
[10.0.0] Added option ONLY to force finding latest rev
even if RevID supplied.
DEFAULT REV Default rev, if not supplied, when creating a new Item
ITEM TYPE Item Type to create new Items as
DEFAULT OWNER Default Owner, if not supplied in the data input file
DEFAULT GROUP Default Group, if not supplied in the data input file
UPDATE ITEM ATTACHMENTS ON|OFF flag to control if Item attachments have their
names updated to reflect a new ItemID. Default is ON
UPDATE REV ATTACHMENTS ON|OFF flag to control if Revision attachments have their
names updated to reflect a new ItemID and/or RevID.
Default is ON
AUTO GENERATE ITEM ID ON|OFF flag to control if ItemID should be auto generated
if ON and ItemID field is empty. Requires an ItemID
naming rule is in force in the Business Modeller.
AUTO GENERATE BASIC [10.7.0] ON|OFF flag to control if ItemID should be auto
ITEM ID generated when no naming rule exists, so will create
standard nnnnnn format IDs.
This uses USER_new_item_id which should use
"ITEM_id_prefix" and "ITEM_id_postfix" preferences.
ITEM REV ID SEPARATOR [6.8.0] Defines a set of alternative separators instead of
LIST those defined in the preferences:
FLColumnCatIVFSeparatorPref
FLColumnCatObjSeparatorPref
A max of 10 separator characters can be specified.
For example...
ITEM REV ID SEPARATOR LIST = /-_
For performance specify the most used character first.

ITEM REV ID NEW [6.8.0] Defines a new separator to be used on all objects
SEPARATOR in their new names, so all objects then have the same
separator.

FIELD DESCRIPTION
UPDATE ITEM ATTACHMENT [7.0.0] A CSV list of relation types in which to update
RELATIONS attachments to the item.
UPDATE REV ATTACHMENT [7.0.0] A CSV list of relation types in which to update
RELATIONS attachments to the item revision.
UPDATE DSET ATTACHMENT [7.0.0] A CSV list of relation types in which to update
RELATIONS attachments to the dataset.
USE ITEMS WITH DIFF [7.0.1] ON|OFF flag to control if an item found with a
CASE different case should be used. The default value is YES,
albeit if different behaviour than before this option existed.
This comes into play during the creation of an item where
the create fails with a duplicate ID error because Tc found
an existing item with an ID of different case to the one
supplied for creation. In which case if the flag is set to ON
then the existing item will be used and a WARNING is
added to the log, otherwise an error will be given.
ITEM REV RULE [7.1.0] Can be used instead of UPDATE LATEST REV to
identify a revision to update based on a revision rule.
ALLOW REPEAT ITEM AND [9.1.0] ON|OFF flag to control if the same item and rev on
REV LINES subsequent lines should be processed. The default is NO
and a message SAME REV is given and if subsequent
lines contain the same item and rev and the rev will not be
updated.
SEARCH FOR ITEMS BY [10.0.0] Used to find multiple items for update. The value
specifies the type of search and additional parameters.
Options are:-
NAME:<NameField> Specifies to search for items by
searching on item Name using the
data field specified by
<NameField>.
For example:-
NAME:ItemID
MATCH ITEM BY NAME AND [10.0.0] ON|OFF flag to control if an item with matching ID
ID and Name should be looked for in the items returned
when using SEARCH FOR ITEMS BY, and if not found
then create an item, if CREATE ITEMS = ON, using the
supplied values.
CREATE REV SEQS [10.10.0] ON|OFF to control if new revision sequences
should be created.
UPDATE REV SEQS [10.10.0] ON|OFF to control if existing revision sequences
should be updated.
SET PREV REV SEQ IMMUNE [10.10.0] ON|OFF to control if the previous revision
sequence should be set to immune (to prevent deletion on
purge) when a new revision sequence is created.
Default is OFF.

4.2.2 Miscellaneous
FIELD DESCRIPTION
MODE Re-set the mode. **OBSOLETED**
FOLDER NAME Default folder name for new items.
NOTE 1: Only new objects are placed in the specified
folder. To add existing objects to a folder use the
folder_insert or relations modes.
NOTE 2: If the folder does not exist it will be created. To
get the folder added to the import user’s Home folder set
TOP FOLDER = Home and prefix the FOLDER NAME
folder with \.
LOG FILE Override the default log file name
REPEAT FILE Override the default repeat file name
FOLDER TYPE Default Folder Type for folder creation/insertion
NEWLINE TOK Newline token to allow multi line text entry into a Note
form attribute type. Default if not specified is ‘%#10;’
SET BYPASS ON|OFF flag to control if bypass privilege is available for
DBA user. (General All-module option).
UPDATE MODIFY DATES ON|OFF flag to control if the modification date on updated
objects should be changed.
DATE FORMAT Describes the format date fields are in.
For example:
%d-%b-%Y %H:%M = 30-Apr-2003 07:50
%d/%m/%Y = 30/04/2003
%y%m%d = 03/04/30
Note: The format is the same as that used by the UNIX
date command. All of the options can be found by using
man date at the UNIX prompt.
The default is format is: 30-Apr-2003 07:50

See Appendix A for all DATE FORMAT values
available.
WILDCARD CHAR SINGLE Specifies an alternate character to use as a single wild
character
WILDCARD CHAR MULTI Specifies an alternative character to use as a multiple wild
character so that a ‘*’ can be used in the item ID.

4.2.3 Owning Site

FIELD DESCRIPTION
DEFAULT OWNING SITE Default Site name if not supplied in data file using
OwningSite field.
UPDATE REMOTE OBJECTS ON|OFF flag to control if objects which having Owning
Site set should be updated
4.2.4 Status and Checkin/Checkout (CICO)
FIELD DESCRIPTION
RELEASE STATUS Name of default release status to use
RELEASE ITEM ON|OFF flag to control if Item is to be released. (Default =
OFF)
BASED ON STATUS Default release status for Based On Item/Revision
RELEASE BASED ON ITEM ON|OFF flag to control if Based On Item is to be released.
(Default = OFF)
UPDATE REVS ATTACHS ON|OFF flag to control if the Revisions’ attachments are
STATUS released, and release them if not. (Default = ON)
RELEASE RELATIONS A Comma separated list of relations in which to release
objects. The default is IMAN_specification.
RELEASE NAMED REFS ON|OFF flag to control if forms stored as named
references in a dataset are released when applying a
status. (Default = ON).
UNRELEASE NAMED REFS ON|OFF flag to control if forms stored as named
references in a dataset are unreleased when unreleasing
objects. (Default = ON).
UNRELEASE ITEMS ON|OFF flag to control un-releasing Items
UNRELEASE REVS ON|OFF flag to control un-releasing Revisions
UNRELEASE KEEP LAST ON|OFF flag to control if the last status is to be kept, i.e.
to clean up multiple statuses
CREATE STATUS ON|OFF flag. Controls if non released objects should be
released

FIELD DESCRIPTION
UPDATE STATUS Controls how released objects should have their status
updated. Can be set to one of the following options:
Turns off ALL status updating
OFF
LAST (Default). Only the last status object on a released object
will be updated.
REPLACE ALL Replaces all existing status objects on a released object

with a new status with supplied values. Effectively
performing an un-release and a re-release.
ADD Adds a new status object to released objects. It will add
the same status name more than once.
ADD UNIQUE Like ADD, but only adds a new status if the object does
not already have a status object with the supplied status
name.
UNRELEASE Un-releases objects. Note: to use this option, no Status
field should be specified in the data fields.
Specifies that a specific status name only is to be
BY NAME updated. The specific status name is supplied using the
configuration option UPDATE STATUS NAME
UDPATE STATUS NAME Supplies a specific status name to match against and can
be used in several of the UPDATE STATUS options as
follows:
LAST The last status will only be updated if it matches,
otherwise any last status object will be updated.
ADD Only adds a new status object if it matches, otherwise a
new status will be added anyway.
ADD UNIQUE Only adds a new status object if it matches, otherwise a
new status will be added anyway or updated if already
existing.
BY NAME Specifies the actual status name which is to be modified.
USE PARENT STATUS ON|OFF flag to control if each object being released
should have a new status (OFF) or its parent’s status
attached (ON). (Default = OFF (Changed from ON in
10.0.0))
RELEASE OBJECTS FILTER Specifies a Class/Type filter to indicate which objects to
release/update. The format is:
(Class)[!Type1!Type2] for a class with excluded
types or Type1,Type2… for a comma separated list of
possible types to match

FIELD DESCRIPTION
ITEM RELEASE RELATIONS MUST BE SPECIFIED WHEN RELEASING VIA ITEMS
TO RELEASE RELATIONS,
Specifies a comma separated list of Revision relations to
find objects in. The following are valid keywords:
REVISIONS Specifies Revisions
BOMVIEW Specifies BOMViews
ALL Specifies all standard relations only, i.e. does not include
Revisions and BOMViews.
For example, to find BOMViews and Revisions use:

BOMVIEW,REVISIONS
REV RELEASE RELATIONS Specifies a comma separated list of Revision relations to
find objects in. The following are valid keywords:
BOMVIEW Specifies BOMViewRevisions
ALL Specifies all standard relations only, i.e. does not include
Revisions and BOMViewRevisions.
ACTIVITIES Specifies any MEActivities associated with an MEOP
Revision only.
DATASET RELEASE Specifies a comma separated list of dataset relations to
RELATIONS find objects in. The following keyword can be used:
ALL Specifies all standard relations.
RELEASE DATASET ON|OFF flag to control if dataset relations should be
RELATIONS released/updated.
UNRELEASE DATASET ON|OFF flag to control if dataset relations should be
RELATIONS unreleased.
PURGE DATASET VERSIONS ON|OFF flag to control if the non-latest versions of
ON RELEASE datasets should be purged when applying a release
status. The files in the Teamcenter volumes associated
with the purged datasets are also removed.
CREATE CICO ON|OFF flag to control if objects with NO current
Checkout should have the Check Out set.
Default = OFF.

FIELD DESCRIPTION
UPDATE CICO Options to define what action to take on an object which
already has a Check-Out set. Valid options are:
Turn off applying any update operation to an existing
OFF
Check-Out.
Perform a Check-In operation to an object with an existing
CHECK IN Check-Out.
CHECK OUT Perform a Check-Out operation to an object.
CANCEL CHECK OUT Perform a Cancel Checkout operation on a DATASET

object only.
Default = OFF.
CHECK OUT REASON Reason/Comment text to add when performing a Check-
Out on an object.
DEFAULT = “Checked-Out by IPS_DATA_UPLOAD” if
not specified and ‘CheckOutReason’ data field not used.
CICO OBJECTS FILTER Specifies to comma separated list of object types valid to
perform Check-In/Check-Out/Cancel Check-Out operation
on. The format is:
Type1,Type2…
To exclude certain Classes/Types from the
Check-In/Check-Out/Cancel Check-Out operations, the
format is:
(Class)[!Type1!Type2]
If this Configuration option is not specified, all objects will
be processed.

4.3 MODULE NOTES

The following points should be considered when using this mode:
1. In all modes of operation if the Item being operated on exists and has a different
Type to that supplied as a configuration option or input data file field value the
operation will not be performed.
2. If AUTO GENERATE ITEM ID = ON configuration option is set and the ItemID data
field has been left blank, the following rules are followed in generating an automatic
Item ID:
o Naming Rule for item_id must be attached to the Item Type in Business
Modeller.
o Auto Generation must not be turned off in Teamcenter Engineering.
o The top (first) pattern in item_id Naming Rule is always used.
3. To assign projects using the items mode, UPDATE ITEMS or UPDATE REVS must
be set to ON. This is not required if using projects mode.
4. V9 projects can be created, updated and assigned using the items mode to get
output from the items perspective. Alternatively, to get output from the project
perspective use the projects mode.
4.3.1 RELEASE STATUS
If no release status date is given, the date is taken from the time of program run.
When setting a release status, all Specification attachments of a Item Revision, and any
BOMViewRevisions (BVRs), are all given the same status as the rev. If multiple Revisions
of the same item are to be given a status, they need to be listed in the data file in the order
they are to be released as the dates are generated sequentially to avoid duplication.
If the release date is to be UPDATED to the current date/time then the header option is
required but the column must be left empty.
If a dataset is being released, because it is in the Specification Relation of a Revision being

released, and it has form objects attached as references then the forms will also get
released.
If a Revision is already released then by default all of the Specification objects and BVRs
will still be checked to see if they are released. If any attachments are found to not be
released then the release status object attached to the Revision will be attached to these
attachments. If just the release date is being updated this checking can be turned off by
setting the configuration option UPDATE REVS ATTACHS STATUS = OFF.

It is also possible to:

o Control if non released objects should be released or if released objects should
updated independently.
o Update status object properties without having to include the Status field in the
data file.
o Update specific status objects by name.
o Add new status objects to already released objects to create multiple statuses.
o Release dataset relations.
o Specify an object Class and/or Type Filter to release/update or exclude specific
objects.
4.3.2 DATE RESTRICTIONS
When using the following configuration option:

DATE FORMAT = %d/%m/%Y
The Operating System regional settings (on Windows this is called Locale) should be set to
English UK or English US to maintain correct date translations. This is true even if using
"dd/mm/yyyy". The results for given dates in none-English UK or English US region
settings may translate as follows:
1/10/2004 -> 1/1/2004 and 1/12/2004 -> 1/1/2004
4.3.3 CHECK IN / CHECK OUT / CANCEL CHECK OUT
The following points should be noted when using the Check-In/Check-Out functionality:
o The Check-In/Check-Out user will be the username specified when running

ips_data_upload.
o The following list is a valid list of classes of objects that can have a
Check-Out/Check-In performed: Item, ItemRevision, Form, Dataset,
Folder, PSBOMView, PSBOMViewRevision.
o This functionality is supported in modes: Items, bom, datasets, forms, folder_create,
folder_insert, forms.
o When wanting to perform Check-in/Check-out operations on TcManufacturing
objects (MEProcess+Rev, MEOP+Rev, MEWorkArea+Rev), specify these using
ItemID and RevID data line fields. Use the CREATE ITEMS = ON|OFF and
CREATE REVS = ON|OFF to control behaviour.
o The Check-in/Check-out functionality will check the corresponding mode UPDATE
<OBJECT> configuration option to verify if the operation is to be performed. I.e.
o Items; UPDATE ITEMS = ON must be set or no Checkin/Checkout will be
performed.
o The following additional configuration options are checked: UPDATE REVS
= ON, UPDATE DATASET = ON, UPDATE FORMS = ON, UPDATE
BOMS = ON.

4.3.4 UN-RELEASING ITEMS/REVISIONS
It is also possible to Un-Release Items, Revisions and attached BOMViews (BVs), BVRs
and Specification objects. Any forms attached to datasets will also be un-released.
To instigate the Un-Release functionality simply specify a release status of UNRELEASE. To

control whether items and/or revisions should be un-released there are configuration options
UNRELEASE ITEMS and UNRELEASE REVS which can be set to ON or OFF. The option
UPDATE ITEMS and UPDATE REVS must be on ON to un-release the corresponding
objects.
It is possible to just keep the last release status if an object has multiple statuses by setting
the configuration option UNRELEASE KEEP LAST = ON. The default is to remove all
status objects.
It is also possible to un-release all the Revisions in an Item or just the latest Revision by just
supplying the ItemID, so there is no need to specify any Revision IDs. If the configuration
option UPDATE LATEST REV = OFF is set (the default) then all of the Items' Revisions
will be un-released. If set to ON then just the latest revision will be un-released.
Once all of the status objects have been removed from the Item, Revisions and attachments
an attempt will be made to delete the status objects themselves. If however any of the
status objects are still attached to any other objects in the database an error 515110 will be
written to the syslog file. This is not a problem since all of the required objects will have
been un-released.
4.3.5 V7 EFFECTIVITIES
It is possible to set a single date range when using V7 effectivities.

The features of this are:
It automatically checks if V7 effectivity mode is active and sets the effectivity data
accordingly, including pre V7 effectivity if using pre V7 mode.
It uses the existing field headers, i.e. EffStartDate and EffEndDate.
It will only set single dates in V7 effectivity mode.
It only sets dates in V7 effectivity mode and not units.
It will un-release objects released using V7 effectivities.
If V7 effectivity is being used and the EffStartDate and EffEndDate columns are included,
but with no values then any existing pre V7 start and end dates will be applied as V7
effectivity dates, i.e. a pre V7 to V7 conversion.

It will update any existing effectivity dates, so long as there is only one set of dates. In V7
mode if there are more than one range of dates then they will not be updated and a
message will be given stating "Cannot update multiple V7 effectivities".
4.3.6 CHANGING IDS
If the NewItemID data field is supplied and configuration options CREATE ITEMS = OFF is
set but UPDATE ITEMS = ON is set, the Item ID will be changed to that supplied value.
If the NewRevID data field is supplied and configuration options CREATE REVS = OFF is
set but UPDATE REVS = ON is set, the Revision ID will be changed to that supplied value.
When either the Item or Revision ID is updated all corresponding objects which by default
have their names made up from a combination of the IDs will also be updated. This goes
for Master forms and BOM Views for both the Item and the Revision and all Revisions in the
item. These object names will only be updated if their old names matched the
corresponding combination with the original Item and Rev IDs.
Other attachments will also have their names updated if they contain
<ItemID><Separator><RevID> or just <ItemID> with the NewItemID and/or NewRevID.
This is on by default, but can be disabled using the configuration options UPDATE ITEM
ATTACHMENTS = OFF and UPDATE REV ATTACHMENTS = OFF.
For example:
If the Revision 000001/A is having the item ID changed to 999999 and Revision ID 1 then
the dataset called TEXT-000001/A-001 would be renamed to TEXT-999999/1-001.
NOTE: The NewItemID and NewRevID fields control the updating of IDs and the
revise/save as to new Revisions and Items depending on the setting of the relevant CREATE
and UPDATE options. In short, assuming UPDATE is ON then if CREATE is ON new objects
are created otherwise the ID on the existing objects are updated.
4.3.7 REVISING AND SAVE AS
If CREATE REVS =ON, the NewRevID data field is supplied and NewItemID is supplied
(and is equal to the existing Item ID OR is empty), OR NewItemID has not been supplied,
then the Revision is copied (Revised) within the Item. The new Revision ID is that of
NewRevID or generated by Teamcenter Engineering if empty (using
USER_new_revision_id()).
If the data field NewItemID is supplied and does NOT match the existing Item ID and
CREATE ITEMS is ON, a new Item is created using that ID and the value of NewRevID if
set. If NewItemID and/or NewRevID are empty, the default Teamcenter Engineering
behaviour for ID generation is used (USER_new_id() and USER_new_revision_id()).

UPDATE ITEMS and/or UPDATE REVS set to ON will control the updating of the NEW
Revision and OLD Item if a "revise" has occurred OR the NEW Item and NEW Revision if a
"save as" occurred. Caution must be exercised when setting the create date of the new
revision.
In Teamcenter Engineering V9+ a Deep Copy will also be performed on any new Items or
Revisions to perform any Deep Copy Rules that may be set.
The data fields NewItemID and NewRevID control the updating of IDs and the Revise/Save
As to new Revisions/Items depending on the setting of the relevant CREATE and UPDATE
options. In short, assuming UPDATE is ON then if CREATE is ON new objects are created
otherwise the ID on the existing objects are updated.
4.3.7.1 Revise/Save As/Change ID Summary
OBJECTIVE FIELDS REQUIRED ESSENTIAL CONFIG OPTIONS

REVISE ItemID CREATE ITEMS = OFF
(Copy rev to new rev in RevID – Existing Rev ID to be copied CREATE REVS = ON
same item)
NewRevID – Supply new rev, or leave
blank to get next rev ID.
SAVE AS ItemID – Existing Item ID to be copied CREATE ITEMS = ON
(Copy rev to new item) RevID – Existing Rev ID to be copied
NewItemID – Supply new rev ID,
different to ItemID, or leave blank to
get next ID. If supply same as ItemID
then only get REVISE action.
NewRevID – Supply new rev, or leave
CHANGE REV ID ItemID – Existing Item ID CREATE ITEMS = OFF
(Change existing Rev ID) RevID – Existing Rev ID CREATE REVS = OFF
NewRevID – Supply new rev, or leave UPDATE REVS = ON
CHANGE ITEM ID ItemID – Existing Item ID CREATE ITEMS = OFF
(Change existing Item ID) RevID – Existing Rev ID CREATE REVS = OFF
NewItemID – Supply new rev ID, UPDATE ITEMS = ON
different to ItemID, or leave blank to
get next ID. If supply same as ItemID
then only get REVISE action.
4.3.8 [10.10.0] Revision Sequences
Specific revision sequences can now be created and updated. By default, if the new field
RevSeqID is not specified then the active/latest sequence ID will be found and used for any
actions on a revision.
But, by using RevSeqID a previous revision sequence can be found and used as the
revision for actions, or a new later revision sequence created. Older, previously purged,
revision sequences cannot be re-created.

If there is a jump from the current active sequence ID to the new supplied sequence ID then
all sequences will be created in turn by performing multiple check-outs and check-ins with a
check-out message being added each time.
By default only 3 sequences are kept. These are all actually revisions, but only one (usually
the latest) is kept as active. Just like with dataset versions, when a new one is created the
oldest is deleted if required so that only 3 remain. But older revision sequences can be set
to immune so that they don’t get deleted (or purged) in this way. The config option SET
PREV REV SEQ IMMUNE can be set to ON to set the previous sequence to immune when
a new one is created. So as successive sequences are created during an import the older
ones can all become immune if required.
NOTE: There’s currently no feature to remove the immunity during an upload.
4.3.9 [10.11.0] Setting mandatory attributes
For Tc 8.3+ items are now created using a new general ITK function TC_create_object
which allows additional attributes to be set at creation time thus providing a means to create
items that have mandatory attributes defined on them in BMIDE.
Mandatory attributes need to be identified so that they can be set at item creation time.
This is done by adding the field modifier .MAND to the field name for each mandatory
attribute.
See the table entry for .MAND in section [7.0.0] Field Modifiers.
4.3.10 [10.11.0] Setting special attributes
4.3.10.1 owning_project
Owning project can be set by using the .FIND field modifier to find a TC_project object.
For example:-
!~ItemID~I:owning_project.FIND=TC_Project,project_id
000001~Project X
4.3.10.2 project_list
Although project_list can be set by supplying a comma separated list of project IDs which
uses the ITK function PROJ_assign_objects, the .FIND field modifier can also be used to
find projects using other attributes, other than just project_id, as well if required. This will
set project_list directly, but as it’s a non-modifiable attribute it also requires the .POM field
modifier. For example:-
!~ItemID~I:project_list.POM.FIND=TC_project,project_id,project_name
000001~Test *,Test
4.3.11 [11.0.0] MultiField Keys in Tc10+

Introduction

4.4 COMMAND LINE ARGUMENTS

FIELD DESCRIPTION
-t=<Item Type> Item Type
TCENG PREFERENCE equivalent:
IPS_IMP_Item_Type
-d=<Default Rev> Specify Default Revision ID to use
IPS_IMP_Default_Rev
-df=<Date Format> Date format to use.
IPS_IMP_Date_Format
Configuration Option equivalent: DATE FORMAT
-folder=<Folder Name> Target Folder Name for imported data.
IPS_IMP_Folder_Name
-update_latest No value required. Specify to Update the Latest Item
Revision
4.5 EXAMPLES
Simple example showing mixture of keywords and general properties:-
!~ItemID~RevID~I:object_desc~R:object_desc~R:owning_user~RM:project_id
000001~A~Test Item~Revision A~Tim Williams(tim)~Project X

More examples for items mode can be found in Appendix B.

See section 2.3.2 for full details on using general property fields, like R: and I:, and section
4.1.6 for further details on setting master form values.

5. BOMS MODE
information for the bom mode. The bom mode is used to import data around the following
criteria:

o Apply Release Status
o Create/Update BOMs
o [7.0.0] Set and update legacy and modular variants and conditions
This mode is specified in the command line options for the utility or by setting the command
line argument:
-m=bom
5.1.1 BOMs
FIELD DESCRIPTION
ParentID or ItemID Item ID of parent
ParentRev or RevID Rev ID of parent
ChildID Child Item ID
ChildRev Child Rev ID
Qty Quantity.
SeqNo Sequence number for occurrence
OccQty Occurrence Quantity.
Alternates Supplies a comma separated list of alternates/substitutes.
The config option ALTERNATES LIST SEPARATOR can
be used to specify a different separator to a comma.
AlternateRevIDs [10.6.0] Supplies a comma separated list of alternate
revision IDs. The list must be in sync with the item IDs
listed in the Alternates field. But blanks can be included
to select the latest rev for certain alternate items.
For example:-
…~Alternates~AlternateRevIDs~…
…~alt_item_1,alt_item_2,alt_item_3~A,,E~…
Will add revs A and E for alt_item_1 and alt_item_3, but
the latest rev for alt_item_2.

NOTE: The same separator used in the Alternates fields

must be used in this field.
New<FldName> Supplies a new value for a field which has been used to
identify occurrences to be update, i.e. NewSeqNo if
SeqNo is used for identification.
SubstChildID The Item ID of the Item to substitute the child
SubstChildRev The Revision ID of the Revision to substitute the child
Predecessor Item ID of predecessor part. (Used to provide
sequencing/flow in BOM).
PredSeqNo [7.0.0] Used in conjunction with PRED UPDATE ID
FIELDS to specify the Sequence Number of the
predecessor to find the correct occurrence.

5.1.2 Absolute Occurrences

FIELD DESCRIPTION
AbsOccID The Absolute Occurrence ID on the child occurrence.
OccType The Occurrence Type on the child occurrence.
ContextItemID Item ID (higher level) Assembly child is used in
ContextItemRevID Rev ID (higher level) Assembly child is used in
ContextAbsOccID Absolute Occurrence ID on child used in Context (higher
level) assembly
ContextParentAbsOccID Absolute Occurrence ID of immediate parent to child in
Context (higher level) assembly.
5.1.3 Engineering Change

FIELD DESCRIPTION
ECID The Engineering Change ID
ECRev The Engineering Change Rev ID
ECName The Engineering Change Name
ECDesc The Engineering Change Description
ECType The Engineering Change Type
5.1.4 Occurrence Notes

FIELD DESCRIPTION
ON:<Occ note> To set an occurrence note. This must be the internal
definition, not the display names.
NOTE: Any occurrence notes which do not exist as types will be created as occurrence
note types prior to Teamcenter Unified Architecture. From TcUA onwards occurrence notes
must first be created using the BMIDE.
5.1.5 [10.4.0] Occurrence Effectivity

FIELD DESCRIPTION
EffID [10.4.0] To set occurrence effectivity ID.
EffStartDate [10.4.0] To set occurrence effectivity Start Date.
NOTE: Only one date range can be set.
EffEndDate [10.4.0] To set occurrence effectivity End Date.

NOTE: If not supplied or left blank an open, UP, end date

will be set.
5.1.6 [7.0.0] Options and Variants
Version 7.0.0 introduced the ability to create and update variant options and conditions for
both legacy and modular variants.
Version 7.4.0 introduced the ability to create and update legacy variant rules.
5.1.6.1 Legacy Variants
FIELD DESCRIPTION
LVarOptName The Legacy Option Name
LVarOptDesc The Legacy Option Description
LVarOptVal The Legacy Option Value, which can be a CSV of values.
LVarOptDefVal The Legacy Option Default Value
LVarOptSetIfVal The Legacy Option Set If Value (Derived value)
LVarOptSetIfCond The Legacy Option Set If Condition.
This is a fully defined condition string. See Legacy
conditions below.
LVarOptCondition A Legacy Option condition to apply to an occurrence.
LVarOptAction Specifies an action to perform on an option. The possible
action values are..
delete deletes the option
replace replaces the option
LVarOptValAction Specifies an action to perform on an option value. The
possible action values are..
delete deletes the value
replace replaces the value
LVarRuleName The Legacy Rule Name.
LVarRuleDesc The Legacy Rule Description.
LVarRuleOptSet The Legacy Rule Option Set. This specifies a list of
options and values to be set by this rule. The format is...
<option> = <value> & <option> = <value> &...
See section 5.3.4.2.1 for further format details.
LVarOptErrorIfMsg [10.12.0] The Legacy Option Error If message.
LVarOptErrorIfCond [10.12.0] The Legacy Option Error If condition.

5.1.6.2 Modular Variants
FIELD DESCRIPTION
MVarOptName The Modular Option Name
MVarOptDesc The Modular Option Description
MVarOptVis The Modular Option Visibility, allowable options are:-
Public or Private.
MVarOptValType The Modular Option Value Type, allowable options are:-
STRING, INTEGER, LOGICAL or REAL
MVarOptVal The Modular Option Value, which can be a CSV of
values.
MVarOptDefVal The Modular Option Default Value
MVarOptCondition The Modular Option Condition
MVarOptAction The Modular Option Action, which can be one of the
following:-
delete to delete an existing option.
Set MVarOptName to * to delete ALL
options.
replace to replace the values of an existing option.
For both options UPDATE MODULAR VARIANT OPTION
must be set to ON.
5.1.7 [7.0.0] General BOM Properties
Any writable standard property can now be set by using the general property format as
described in section [7.0.0] General properties. For BOM Line properties using the type
keyword BL. For example:-
BL:bl_occurrence_name
BL:bl_occ_xform_matrix
BL:bl_is_occ_suppressed
The general property format can also be used to set specific ownership on just BOMViews
or BOMView Revisions too, with a field like:-
Design BOMView:owning_group.PARENT~Design BOMView Revision:owning_group
BV:owning_user
5.1.8 [7.6.0] Part / CAD Alignment (publish) links
To create a publish link the source and target parent BOM Item IDs, and optionally rev IDs,
and the Child item ID will need to be specified.
FIELD DESCRIPTION
TargetParentID Item ID of target parent.

TargetParentRev Rev ID of target parent rev.

If not specified the latest rev will be used.
TargetChildID Item ID of target child.
PublishLinkType Specifies the type of Publish Link.
Will default to PublishLink.
PublishLinkName Specifies the name of the Publish Link.
The default will be:-
<target_child_rev.object_string>-->
<source_child_rev.object_string>
truncated to the size of object_name.
This is the default UI behaviour.
PublishLinkDataFlags Defines the data flags to set as a CSV with values of:-
transform
shape
The default will be just transform.

5.2.1 BOMS
OPTION DESCRIPTION
BOM FORMAT Only “parent_child” is supported
VIEW TYPE The BOMViewRevision Type
SET BOMS PRECISE ON|OFF flag to control setting BOMS precise.
(Default = OFF, imprecise)
USE PS CREATE OCC ON|OFF flag to control which ITK function set is
used to create occurrences. If this is set to ON the
PS ITK functions will be used instead of BOM
functions.
PS functions are faster than BOM functions, which
is the reason for this option!!
PS functions are fine for simple BOM creation and
some updates, but more complex options such
Options & Variants must use BOM functions.
The default is OFF, i.e. use BOM functions.
CREATE BOMS ON|OFF flag to control creation of BVRs
UPDATE BOMS ON|OFF flag to control update of BVRs
BOM UPDATE OPTION BOMViewRevision update from:
ADD OCCURRENCES Adds occurrences to existing BOMViewRevision
REPLACE ALL Removes all occurrences from the BVR before
OCCURRENCES adding occurrences.
Update individual occurrences, but only the first one
UPDATE OCCURRENCES if multiple matches are found.
Update individual occurrences and update ALL
UPDATE ALL OCCURRENCES
matching occurrences.
BOM UPDATE ID FIELDS A comma separated list of fields to use to identify
occurrences to update.
For example, to match on ChildID and SeqNo;
ChildID,SeqNo
[11.0.0] This option can now be combined with, or
replaced by, fields flagged by the field modifier
.BOM_OCC_KEY. This allows many more fields,
including BL fields to identify different occurrence
properties, to be used to identify occurrences to be
updated.
ALTERNATES LIST SEPARATOR Specify a different separator than a comma when
supplying a list of alternate items
BOM UPDATE ADD OCCURRENCES ON|OFF flag to control if new occurrences should
be created. This will add occurrences that could
not be found during a BOM Update.
[10.0.0] Added new value of LATEST REV to force

OPTION DESCRIPTION
the latest rev of any found child to be added, thus
only effective for precise BOMs.
BOM UPDATE PRE DELETE ATTR Defines a BOM attribute to use to find occurrences
to be deleted before any updates for the BOM are
done
BOM UPDATE PRE DELETE VALUE Defines the value for the PRE DELETE ATTR to be
matched
BOM UDPATE DELETE FIELD Defines a field header name to be used to delete
Occurrences.
For example, the field name is user definable, i.e.
“DELETE THIS”
BOM UPDATE DELETE VALUE Defines the value for the DELETE FIELD to be
matched to identify occurrences to be deleted.
For example, “DELETE”
BOM SUBST CHILD OPTION REVISE|SUBST flag to control BOM Child
substation behaviour
BOM REVISE CHILD USE ON|OFF flag to control if existing Items/Revisions
EXISTING can be used in REVISE mode.
BOM REV RULE Revision Rule to use to set the revision rule to be
used to load a bom.. (Default = Latest Working).
[7.0.1] Can also be used to specify a revision rule in
case of problems adding BOM lines due to rev rule
errors.
PRED UPDATE ID FIELDS Used in conjunction with the new BOM field
PredSeqNo to find the correct predecessor
occurrence. An example of the new cfg option is:-
PRED UPDATE ID FIELDS =

Predecessor,PredSeqNo
BOM FIND OCC BY NAME AS ID [10.0.0] An ON|OFF flag to control if the supplied
ChildID should be used to find occurrences by
matching on the item Name instead of the item ID.
NOTE:
NOTE: If UPDATE BOMS = ON is set the BOMViewRevision will toggle to satisfy the setting
for SET BOMS PRECISE. I.e. if SET BOMS PRECISE = ON is set and the
BOMVewRevision is not precise, it will be toggled to Precise and vice-versa.
NOTE: The following configuration options are only used if BOM UPDATE OPTION is set to
UPDATE OCCURRENCES or UPDATE ALL OCCURRENCES:
1. BOM UPDATE ADD OCCURRENCES
2. BOM UPDATE PRE DELETE ATTR
3. BOM UPDATE PRE DELETE VALUE
4. BOM UPDATE DELETE FIELD

5. BOM UPDATE DELETE VALUE
5.2.2 Engineering Change

OPTION DESCRIPTION
CREATE EC ITEMS ON|OFF flag to control creation of EC Items
UPDATE EC ITEMS ON|OFF flag to control updating EC Items
CREATE EC REVS ON|OFF flag to control creation of EC Revisions
UPDATE EC REVS ON|OFF flag to control updating EC Revisions
EC TYPE EC Item Type to create new EC Items as
ADD CHILD TO EC FOLDER Name of defined EC ItemRevision psuedofolder to
copy the Child ItemRevision into.
For example, problem_items
SET EC IN BOM IC CONTEXT Set the EC ItemRevision as the Incremental
Change Context target in PSE when the BOM is
loaded.
EC FORMS LIST TO ADD A comma separated list of Form Types defined for
the EC Type to add to new EC Item Revisions. Use
the site preference defining the Relation to attach
the forms in.
EC PROCESS AUTO INIT ON|OFF flag to control whether a workflow process
should be started using the EC process template
defined in EC PROCESS TEMPLATE. (Default =
OFF).
EC PROCESS TEMPLATE Process Template defined for the EC Type.
EC PROCESS DESC Global Process description added when creating
workflow Processes.
NOTE: items mode can be used to set all Item and ItemRevision properties on EC
Items/ItemRevisions.
5.2.3 [7.0.0] Options and Variants

OPTION DESCRIPTION
CREATE LEGACY VARIANT OPTION ON|OFF flag to control creation of Legacy
Variant Options
UPDATE LEGACY VARIANT OPTION ON|OFF flag to control updating Legacy Variant
Options
CREATE LEGACY VRULE ON|OFF flag to control creation of Legacy
Variant Rules
UPDATE LEGACY VRULE ON|OFF flag to control update of Legacy Variant
Rules
UPDATE LEGACY VRULE OPTION Option to control the behaviour when updating

OPTION DESCRIPTION
Legacy Variant Rules.
The available options are:-
REPLACE – to replace the entire Option
Set. Must be used for new option sets! This is
the default option.
UPDATE – to update individual options
CREATE MODULAR VARIANT OPTION ON|OFF flag to control creation of Modular
Variant Options
UPDATE MODULAR VARIANT OPTION ON|OFF flag to control updating Modular Variant
Options
O&V CHECK FOR EXISTING RULE [11.0.0] ON|OFF flag to control if existing rules
should be checked for in order to prevent
duplications from being created.
By default this is ON, but can have major
performance issues. So set this to OFF if
performance is an issue.

OPTION DESCRIPTION
PUBLISH LINK TYPE Specifies the type of Publish Link.
Will default to PublishLink.
PUBLISH LINK DATA FLAGS Defines the data flags to set as a CSV with values
of:-
transform
shape
The default will be just transform.
5.2.5 [10.4.0] Occurrence Effectivity

OPTION DESCRIPTION
OCC EFF CREATE ON|OFF flag to control if new effectivity objects
should be created.
OCC EFF ALLOW MULTIPLES ON|OFF flag to set if multiple effectivities can be
set on a single occurrence.
OCC EFF ATTACH OPTION Option to control what should happen if an
occurrence already has an effectivity attached
which does not match the specified effectivity ID.
Available options are:-
REPLACE Replace all existing effectivities
ADD Add a new effectivity (if multiples
allowed)

OPTION DESCRIPTION
LEAVE Do nothing.
The default is LEAVE.

5.3 MODULE NOTES

1. It is recommended the data be sorted by the ParentID and ParentRev fields and a
parts list for a single parent should be wholly contained within the data file,
otherwise there is a possibility any children for that parent in a subsequent data file
may not be added under certain circumstances.
2. To control the creation of parent and child Items and Revisions use the options
CREATE ITEMS and CREATE REVS to provide any combination of PARENT and
CHILD as the value. For example:
CREATE ITEMS = PARENT - create parent items

CREATE ITEMS = CHILD - create child items
CREATE ITEMS = PARENT,CHILD - create parent and child items
CREATE REVS = PARENT - create parent revs
CREATE REVS = CHILD - create child revs
CREATE REVS = PARENT,CHILD - create parent and child revs
5.3.1 BOM OCCURRENCE UPDATE
This allows updating, deleting and adding of occurrences.
Any BOM attribute can be updated. Occurrences can be identified by one or a multiple of
attributes, for example just ChildID or ChildID and SeqNo if there are multiple occurrences
of the same child. By default occurrences will be matched just on the ChildID.
[11.0.0] Previously a comma separated list of field names was specified with the
configuration option BOM UPDATE ID FIELDS, but this did now allow any colon (:) fields to
be used. But, now any field can be flagged with the field modifier .BOM_OCC_KEY.
Any occurrences found will be updated with all supplied values. If a field is to be used to
identify an occurrence and this value is also to be updated then a second field should be
supplied with the same header name, but prefixed with "New". For example if matching on
"SeqNo" then a field with the header "NewSeqNo" should be used to supply the new
Sequence Number.
Several occurrences can be pre-deleted by specifying a particular attribute and value to look
for. All occurrences with this value will be deleted. Otherwise occurrences can be deleted
by 'marking' children in the data file. This is done by specifying a particular field and value
in the data file.
If an occurrence is not marked for delete, but cannot be found for update then it will be
added. However, there is an option to stop this if required. All options are configurable.


When identifying occurrences a [*] can be used in an identifying field to match any value, or
a value of NULL can be used to match empty values. Thus it would be possible, for
example, to unset the Sequence Number for ALL occurrences using a data file simply
containing:
!~ParentID~ChildID~SeqNo
Assembly123~*~NULL
5.3.2 CHILD SUBSTITUTION
In update mode children can now be substituted with either existing Items or Revisions, or
with Revised or Saved-As Revisions of the child.
Occurrences should be located as per the configuration option BOM OCCURRENCE UPDATE,
which by default is to match on just the ChildID field.
By setting BOM UPDATE OPTION = UPDATE ALL OCCURRENCES all found occurrences
will have their Item/Revision substituted.
All occurrences where substitution is done will retain all their existing occurrence attributes.
However, new values for any attribute can be supplied in the data file in the normal way. If
occurrence attributes are NOT to be kept then do not use these substitute options, but
instead, delete the existing occurrence using a delete field and add the replacement child as
a new occurrence.
This functionality uses the SubstChildID and SubstChildRev data fields along with BOM
SUBST CHILD OPTION and BOM REVISE CHILD USE EXISTING configuration options.
1. Substitution Mode – BOM SUBST CHILD OPTION = SUBST

Substitution mode is used to substitute an occurrence's Item or Revision with an
existing Item or Revision. If the replacement Item or Revision is not found a NOT
FOUND error message will be displayed. For imprecise BOMs only the
SubstChildID is required, although supplying the SubstChildRev will not cause
a problem. For precise BOMs, though, the Revision must be supplied too.
2. Substitution Mode – BOM SUBST CHILD OPTION = SUBST

Revise mode is used to either Revise the current occurrences’ Revision to create a
new Revision in the same Item or perform a Save As operation on the occurrences’
revision to create a new item. This is controlled by whether the Item ID supplied in
SubstChildID is the same as in ChildID. If they are the same a Revise is done,
if they are not the same then a Save As is performed. If the ChildRev is not
supplied then the Latest Revision of the occurrence will be Revised or Saved-As. If
the SubstChildRev does supply a new Revision then the system will assign the
new Revision, just as if doing an Assign when creating a revision in the interface.

If the Item supplied by SubstChildID for a Save-As operation already exists, or a

specified Revision for a Revise operation already exists then by default an EXISTS
error will be given. If, however, the existing Item or Revision is to be used to
substitute the occurrence Revision, then set the configuration option BOM REVISE
CHILD USE EXISTING = ON.
5.3.3.1 Introduction
This functionality adds the ability to create Part / CAD alignment links (or Publish Links (PL))
between an occurrence in a design (CAD) BOM and an occurrence in a business (Part)
BOM.
The occurrence within each BOM will be identified by its item ID.
This functionality is only available from Teamcenter 2007 UA onwards.
5.3.3.2 Creating a link in the UI

This requirement is to create the link as created through the UI menu option Tools ->
Structure Alignment -> Publish data.
This works on BOMS defined in a CC structure which is opened in the Multi Structure
Manager. For example:-
The link is created by viewing both BOMs, selecting an occurrence in each BOM and
selecting the Publish Data menu option, which provides the following dialog:-

This creates a PublishLink object of type PublishLink.
5.3.3.3 Importing links
Teamcenter calls the Part/CAD alignment links Publish Links and so in the output for
importing links many of the messages relating to the publish links are prefixed with PL.
To import links the data must include information about both the source and target children.
For the source child use the standard BOM fields ParentID, ParentRev and ChildID; and
for the target child use the new fields TargetParentID, TargetParentRev and
TargetChildID.
5.3.3.3.1 Example
Simple example to create part/CAD alignment links:-
!~ParentID~ParentRev~ChildID~TargetParentID~TargetParentRev~TargetChildID
New_Assy1~A~child1~New_Assy3~A~Sub_assy4
New_Assy1~A~child1~New_Assy3~A~child1
5.3.4 [7.0.0] Legacy and modular variants

The field names used by both types of variants are similar with names starting with L for
Legacy fields and M for Modular fields.
5.3.4.1 Creating options and values
For both legacy and modular variants the allowable options and their values must be
specified with one option at a time on separate data lines with only the parent specified, i.e.
the ChildID field, if supplied, must have a blank value.
All options and their values must be defined, in a series of data lines with just the Parent ID,
before supplying any data lines with children to specify the child conditions.
5.3.4.1.1 Legacy
Legacy options are created using the fields LVarOptName, LVarOptDesc, and
LVarOptVal. where LVarOptVal can take a CSV list of values.
For example:-
!~ItemID~ParentRev~ChildID~ChildRev~LVarOptName~LVarOptDesc~LVarOptVal
AHD54302~001~~~Load_Mainstream~Load_Mainstream GM Legacy Option.~Y,N

5.3.4.1.2 Modular
Legacy options are created using the fields MVarOptName, MVarOptDesc, MVarOptVis,
MVarOptValType and MVarOptVal, where:-
MVarOptValVis is one of Public or Private.
MVarOptValType is one of STRING, INTEGER, LOGICAL or REAL. Default is STRING.
MVarOptVal can take a CSV list of values.
For example:-
!
~ItemID~ParentRev~ChildID~ChildRev~MVarOptName~MVarOptDesc~MVarOptVis~MV
arOptValType~MVarOptCondition
BG00000020~A~~~MyOption006~Option desc~public~LOGICAL~
5.3.4.2 Creating conditions
Conditions for a child are specified on a line with the ChildID supplied, but after the options
and values have been defined.
5.3.4.2.1 Legacy
For legacy conditions, specified in the LVarOptCondition field, and for defining Option Sets
using the fields LVarRuleOptSet, CCSOSOptSet or SCSOSOptSet, the format is:-
[(]<clause>[&||]<clause>[)]
i.e. a series of clause separated by & (ampersand) for AND or | (pipe) for OR. Optionally a
set of clauses can be grouped with brackets, and again & or |’s used between bracketed
series.
For example:-
((AHD53175; M_LTL_C; ==; Y | AHD53175; M_LTL_K; ==; Y) & (AHD53175; M_LGW_1;
==; Y | AHD53175; M_LGW_2; ==; Y)) & (AHD53175; M_LCW_05; ==; Y | AHD53175;
M_LCW_07; ==; Y | AHD53175; M_LCW_09; ==; Y | AHD53175; M_LCW_10; ==; Y)
Each clause is specified with 4 or 5 fields with values separated by a semi colons (;), in the
format:-
<item_id>[;<rev_id>];<option_name>;<operator>;<values>
Where:-
<item_id> - is the item ID of the item that has the option defined on it.
<rev_id> - is the optional rev ID of the item with the option defined on it.
<option_name> - is the name of the option to be set.
<operator> - is one of:-
= or == for the set option equals this value
!= or <> for not equals
> for greater than
>= for greater than or equal to
< for less than
<= for less than or equal to

<values> - is the value to check against.
An alternative format for clause is:-
[<item_id>[/<rev_id>]]< option_name > <expr> <value>[|<value>|<…>]

For example:-
[AHD53175]M_LTL == Y|N
NOTE: If the item or revision cannot be found an error will be given. If the rev_id is not
supplied then the configuration option UPDATE LATEST REV can be set to ON to get the
latest revision.
5.3.4.2.2 Modular
For modular conditions, specified in the MVarOptCondition field, the string value as used
in the Tc UI is used in the data line. So the easiest method is to create some conditions, as
required, in the UI to get the format by looking at the property bl_occ_mvl_condition,
e.g.:-
but here’s the general format in its simplest form:-

<clause>[ and|or <clause>]
Where <clause> is in the format:-
<ItemID_of_item_owning_option>:'<option name>' <operator> <value>
e.g...
Assy1:'Test Number Option' = 1 or Assy1:'Test Option' = "Y"
For example:-
!
~ItemID~ParentRev~ChildID~ChildRev~MVarOptName~MVarOptDesc~MVarOptVis~MVar
OptValType~MVarOptCondition
BG00000020~A~BG00000006~@@~~~~~BG00000020:MyOption006 = true
5.3.4.3 [10.12.0] Option Error Rules (Legacy)
Option error rules can be specified with the fields LVarOptErrorIfMsg and
LVarOptErrorIfCond.
[11.0.0] By default any existing rules will be searched first to see if the current defined rule
already exists in order to prevent duplication. But, if there are many options defined then
this can have a major impact on performance, potentially hours instead of minutes. If
duplicates are unlikely to occur from the data being supplied and the performance is an
issue then the check for an existing rules can be turedn off by setting the configuration
option:-

O&V CHECK FOR EXISTING RULE = OFF
5.3.5 [10.4.0] Occurrence Effectivities
Occurrence effectivities can be set on BOM occurrences, but with limited functionality as
follows:-
 Effectivities must have an ID.
 It’s possible to create legacy or unified effectivities, depending upon the OOTB
preference CFMOccEffMode which can have the values legacy, maintenance or
upgrade.
 Only single date ranges can be created, but an end date can be left blank for open
ended (or UP).
 Multiple unified effectivities can be added to an occurrence.
 It will find existing effectivities to attach.
 Existing effectivities cannot be updated.

FIELD DESCRIPTION
-bf=<BOM Format> BOM Format option to use. Currently only one option
value is available: parent_child.
IPS_IMP_Bom_Format
Configuration Option equivalent: BOM FORMAT
-vt=<View Type> Specify the View Type to use.
IPS_IMP_View_Type
Configuration Option equivalient: VIEW TYPE
5.5 EXAMPLES
NOTE: More examples for bom mode can be found in Appendix C.
5.5.1 General Example

!~ItemID~RevID~ChildID~ChildRev~SeqNo~Qty~BL:bl_occurrence_name
000001~A~000002~A~10~2~Occ 000002

6. FORMS MODE
information for the forms mode. The forms mode is used to import data around the
following criteria:

o Create/Update Forms and attach them to an Item or Revision
line argument:
-m=forms
6.1.1 Forms
FIELD DESCRIPTION
ItemID Item ID to attach the form to
RevID The Rev ID of the ItemID to attach the form to
FormName The name of the form
FormDesc The description of the form
FormType The Form Type
F:<Attr> A form attribute to populate. This must be the must
be the real name from the database and not the
display name.
6.2.1 Forms
OPTION DESCRIPTION
UPDATE FORMS ON|OFF flag to control updating forms
CREATE FORMS ON|OFF flag to control creation of forms
FORM TYPE
RELATION NAME The relation type name to use.
For example, Spec, Manif, Ref, Req,
IMAN_custom_relation
RELATION PARENT TYPE The type of parent, either ITEM or REV.

6.3 MODULE NOTES

1. The forms mode should be avoided for just setting Item or ItemRevision Master form
attributes. The items mode should be used for these forms.
6.4.1 Forms
FIELD DESCRIPTION
-ft=<Form Type> Specify default Form Type to use.
IPS_IMP_Form_Type
Configuration Option equivalent: FORM TYPE
-ao=<Attach Obj Type> Attach to Object Type. Valid options are ITEM|REV.
Configuration Option equivalent: RELATION PARENT
TYPE
-rel=<Relation Name> Specify the Relation to use where Relation is one of:
Spec | Manif | Req | Ref.
Configuration Option equivalent: RELATION NAME
6.5 EXAMPLES
!~ItemID~RevID~FormType~FormName~F:object_desc~F:owning_user~F:charge_number
000001~A~ECO Sample Form~ECO-000001/A~Test ECO Form~Tim Williams(tim)~12
More examples for forms mode can be found in Appendix D.

7. LOVS MODE
information for the list of values (LOVS) mode. The LOVS mode is used to import data
around the following criteria:
o Populate/Re-populate existing LOVS
line argument:
-m=create_lovs
7.1.1 Lovs
FIELD DESCRIPTION
LovName The name of the LOV to populate
LovType The type of LOV, i.e. STRING, INT or DOUBLE
LovVal The value to add
7.2.1 Lovs
OPTION DESCRIPTION
LOV NAME The name of the LOV to populate
LOV TYPE STRING|INT|DOUBLE flag to control the LOV Type
7.3 MODULE NOTES

1. The List of Values (LOV) must be created first in Teamcenter Engineering prior to
using ips_data_upload to populate it.
2. The LOV module is not available with Tc UA onwards as BMIDE must be used.
3. The following is a mapping of the LOV types that can be populated in Teamcenter
Engineering by using ips_data_upload:
STRING = ListOfValuesString

INT = ListOfValuesInteger
DOUBLE = ListOfValuesDouble

The following command line arguments are valid in this mode and are specifically related to
lovs
FIELD DESCRIPTION
-lov=<LOV Name> Name of the LOV to populate.
Configuration Option equivalent: LOV NAME
-lt=<LOV Type> Specify the LOV Type of Data where LOV type is one
of: STRING | INT | DOUBLE.
Configuration Option equivalent: LOV TYPE
7.5 EXAMPLES
Examples for create_lovs mode can be found in Appendix E.

8. RELATIONS MODE
information for the relations mode. The relations mode is used mainly to import data around
the following criteria:
o Attach Items, Revisions, datasets or forms to Items or Revisions with a

specified relation
o Move attachments from one relation to another relation within an Item or
Revision
line argument:
-m=relations
8.1 [8.0.0] Any workspace objects

From version 8.0.0 it’s possible to create, and cut, relations between almost any two
workspace objects. Type fields allow the Tc type of the parent and child objects to be
specified.
Item ID, RevID, ParentType, ParentName and ParentRelation fields can also be used
together to specify a parent object within an item or revision, e.g. a dataset. While the Dset*
and Form* fields can still be used to specify a child dataset or form and in conjunction with
ChildID, ChldRev and ChildRelation can specify a dataset or form within another item or
revision.
CCName, CCType, SCName and SCType can be used to attach CC or SC objects as child
relations.
To attach objects to a CC or SC then use the mfg mode with the RelationName field or use
the relation mode with ParentType and ParentName fields to specify the CC or SC type
and name as required.
A folder can be specified as the parent or child. If the parent is a folder simply supply any
valid relation type for RelationName or none at all as the default is IMAN_specification. It
won’t be used, but is required to overcome the check for a valid relation type.
8.2.1 Relations
FIELD DESCRIPTION
^ItemID or ParentID The Item ID of the parent Item
[RevID or ParentRev] OPTIONAL. The Revision ID of the Parent Revision
*ChildID The ItemID of an item to be cut or pasted from/into the
parent.
[ChildRev] OPTIONAL. The Revision ID of the Revision to be cut
or pasted from/into the parent.
FormType The type of form to be cut or pasted from/into the
parent. Used with FormName.

FIELD DESCRIPTION
*FormName The name of the form to be cut or pasted from/into the
parent. Used with FormType.
DsetType The type of the dataset to be cut or pasted from/into the
parent. Used with DsetName.
*DsetName The name of dataset to be cut or pasted from/into the
parent. Used with DsetType.
RelationName The Name/Type of the relation to paste as, or cut from.
[11.1.0] When using RELATION BMIDE OVERRIDE =
ON and the relation is to be created in a class other than
that specified with RelationName, and not in the class
ImanRelation then add the field modifier:-
.ON_CLASS=ClassName
To specify the class to create the relation on, e.g.
RelationName.ON_CLASS=ComponentRelation
See Module Notes for further details.
[NewRelation] OPTIONAL. New relation name/type to move the child
object to.
For example, from RelationName to NewRelation.
<Relation>:<Property> [7.0.0] This is a general property format for setting
properties on the relation itself at the time of creating the
relation.
<Relation> is the relation name, i.e.
IMAN_specification.
<Property> is the name of a property on the
relation.
RelChildType [7.3.3] Used to specify any WSOM object type to be cut
or pasted from/into the parent. Used in conjunction with
RelChildName.
Using these fields different object types can be attached
in one import, e.g. datasets, forms and object types.
*RelChildName [7.3.3] Used to specify any WSOM object name to be
cut or pasted from/into the parent. Used in conjunction
with RelChildType.
Using these fields different object types can be attached
in one import, e.g. datasets, forms and object types.
ChildRelation [8.0.0] The relation between a Child item or revision
(using ChildID and ChildRev) and the required
workspace object to be attached to the parent object.
ParentType [8.0.0] The workspace type of the parent/primary object.
^ParentName [8.0.0] The name of the parent/primary object.
ParentRelation [8.0.0] The relation between a Parent item or revision
(using ParentID and ParentRev) and the required
workspace object to be attached to the parent object.
ChildOwner [10.1.0] The owner of the child/secondary object to be

FIELD DESCRIPTION
used in conjunction with name and type to find objects.
ChildGroup [10.1.0] The group of the child/secondary object to be
*ChildPUID [10.1.0] The database PUID of the child/secondary
object to be used on its own to find a specific object.
ChildClass [10.1.0] The class of the child/secondary object to be
used with the database PUID to validate the class of the
object.
Append ‘…’ to the class name to check for descended
from class. See note 4 below.
ParentOwner [10.1.0] The owner of the parent/primary object to be
ParentGroup [10.1.0] The group of the parent/primary object to be
^ParentPUID [10.1.0] The database PUID of the parent/primary object
to be used on its own to find a specific object.
ParentClass [10.1.0] The class of the parent/primary object to be
used with the database PUID to validate the class of the
object.
Append ‘…’ to the class name to check for descended
from class. See note 4 below.
^ NOTE: Only one of the parent fields ItemID, ParentID, ParentName or ParentPUID can
be used to find the parent/primary object. These fields are mutually exclusive.
* NOTE: Only one of the child fields ChildID, FormName, DsetName, RelChildName or
ChildPUID can be used to find the child/secondary object. These fields are mutually
exclusive.

8.3.1 Relations
OPTION DESCRIPTION
RELATION NAME The Name/Type of the relation to paste as
RELATION PARENT TYPE The type of parent object ITEM or REV.
If REV is used and no ParentRev or RevID is given in
the data file then the latest revision will be used.
RELATION CHILD TYPE The Type of child object ITEM or REV.
If REV is used and no ChildRev ID is given in the data
file then the latest revision will be used.
NEW RELATION NAME Optional new relation name/type to move the child
object to.
For example, from RelationName to NewRelation
CUT RELATIONS ON|OFF flag to turn on and off cutting of relations.
Default is OFF.
PASTE RELATIONS ON|OFF flag to turn on and off pasting of relations.
Default is OFF.
RELATION PARENT [8.0.0] The default relation to be used between a
RELATION parent item or revision and the desired parent
workspace object, if not specified with the field
ParentRelation.
RELATION CHILD [8.0.0] The default relation to be used between a child
RELATION item or revision and the desired child workspace
object, if not specified with the field ChildRelation.
RELATION MULTI PARENT [8.0.0] Specifies what to do if more than one parent
OPTION object is found. The available options are:-
NONE - Use none of them
FIRST - Use the first one
ALL - Use all of them
RELATION MULTI CHILD [8.0.0] Specifies what to do if more than one child
OPTION object is found. The available options are:-
NONE - Use none of them
FIRST - Use the first one
ALL - Use all of them
RELATION PARENT WSOM [8.0.0] The default parent workspace object type, if not
TYPE specified with the field ParentType.
RELATION CHILD WSOM [8.0.0] The default parent workspace object type, if not
TYPE specified with the field ParentType.
RELATION BMIDE [10.11.0] An ON|OFF flag to use POM functions for
OVERRIDE relations in order to override BMIDE rules.
The default is OFF.


8.4 MODULE NOTES

1. If ChildID, RevID, DsetName and DsetType are all supplied then the dataset will be
found in the specified child revision and copied to the parent Revision or item
Accordingly.
2. Both Parent and Child objects must already exist in Teamcenter Engineering. This
mode will not create the objects.
3. The following order of precedence is used for specifying a relation:
a. The Internal Teamcenter Engineering Relation Name
b. One of the following Keywords:
i. SPEC (IMAN_specification)
ii. MANIF (IMAN_manifestation)
iii. REQ (IMAN_requirement)
iv. REF (IMAN_reference)
IPS Data Upload only knows short cuts for these historic 4 relation types.
Apart from these the full system relation name must be used, i.e. not the
display name. So for Rendering (the display name), for example,
IMAN_Rendering (yes, UPPER case R) must be specified.
4. [10.1.0] When specifying a optional class with a PUID, to confirm the PUID used in is
the required class, e.g. ChildClass with ChildPUID then 3 dots can be appended to
the class name value supplied to check if the class is descended from the class
name specified, e.g. Item will check that the object is an Item, whereas Item… will
check that the object is descended from Item.
8.4.1 Sub Classed relations using BMIDE OVERRIDE
These notes apply to when having the following option set to create a GRM relation using
POM functions to override any rules set in BMIDE that would normally prevent the relation
from being created:-
RELATION BMIDE OVERRIDE = YES
By default if a class exists for the supplied relation name then an object will be created in
that class.
For example the OOTB Fnd0ListsParamReqments has a Business object and a class:-
But, if a direct class doesn’t exist, but the relation type is defined on a sub class to
ImanRelation then the class needs to be specified with the .ON_CLASS=class field
modifier added to the RelationName field.
For example the OOTB IMAN_MEComponent has a Business Object, but no direct class
but it’s defined on the class ComponentRelation:-

This needs to be defined in the data file as:-

!~…~RelationName.ON_CLASS=ComponentRelation
…~IMAN_MEComponent
So this will create the relation of type IMAN_MEComponent in the class of
ComponentRelation.
8.4.1.1 Setting default attributes
Sometimes a class will require some default attributes to be set. To test this try creating
one relation and if it returns the error “The instance cannot be saved because it contains
empty attributes.” then look in the corresponding syslog to find entries about empty
attributes, e.g.:-
NOTE - 2014/6/19-14:36:53.219 UTC - NoId - Instance 00007839 <gcGAAAKYYRLTNB-
gcGAAAKYYRLTNB>(ComponentRelation) attribute rel_subtype is empty -
Teamcenter.POM at d:\tc91w0201\src\foundation\pom\dms\dms_util.cxx(490)
NOTE: To get a syslog to remain in order to see this error it may be necessary to set the
environment variable TC_KEEP_SYSTEM_LOG=1, otherwise the syslog may get deleted.
Because different classes have different default attributes to be set at the time of creation
these need to be specified in the configuration file using the POM option POM DEFAULT
ATTRS FOR CLASS Class, for example:-
POM DEFAULT ATTRS FOR CLASS Fnd0ListsParamReqments =
description,name,fnd0SecondaryBomView,fnd0PrimaryBomView, fnd0SequenceNumber
POM DEFAULT ATTRS FOR CLASS ComponentRelation = rel_subtype
NOTE: The default attributes on a class may change with different versions of Teamcenter.
For example fnd0SequenceNumber on Fnd0ListsParamReqments exists in Tc 10.1, but
not in Tc 9.1.
8.4.1.2 Setting relation attributes
In either case still use the relation type in any field headers to set relation attributes, e.g.:-
Example 1
!
~ParentID~ParentRev~ChildID~ChildRev~RelationName~Fnd0ListsParamReqments:Fnd0p
arameter~Fnd0ListsParamReqments:Fnd0value~Fnd0ListsParamReqments:description
1000001-MAND~A~1000002-MAND~A~Fnd0ListsParamReqments~Size~99~Size=99?
Example 2
!
~ParentID~ParentRev~ChildID~ChildRev~RelationName.ON_CLASS=ComponentRelation
~IMAN_MEComponent:rel_subtype.POM
1000001-MAND~A~1000002-MAND~A~IMAN_MEComponent~99
In this second example the .POM modifier has been added to rel_subtype to use POM to
set it, otherwise the error “Property rel_subtype is not modifiable.” is received.

8.4.1.3 Trial and error
Until the class and attributes are defined correctly a relation may be created in the class of
ImanRelation only and not allow any attributes on sub class to be set because there is not
object in that class. This can give an error that he attribute does not exist on ImanRelation.
So it may be necessary to cut the relation by setting the config option:-
CUT RELATIONS = ON
temporarily to cut the relation before trying again.

8.5.1 Relations
FIELD DESCRIPTION
-rel=<Relation Name> Name of the Relation to populate.
Configuration Option equivalent: RELATION NAME
-newrel=<New Relation Specify the new Relation Name to populate.
Name>
Configuration Option equivalent: NEW RELATION
TYPE
8.6 EXAMPLES
1) Simple example:-
!~ItemID~RevID~RelChildName~RelChildType
000003~A~Text-000003/A~Text
000003~A~ECO_sample_000003/A~ECO Sample Form
2) [8.0.0] Simple example to copy a dataset in one rev to another rev:-

#----------------------------------------------
# Dataset in rev into another dataset in rev
#----------------------------------------------
!~ItemID~RevID~ParentName~ParentType~ChildID~ChildRev~DsetName~DsetType~RelationName
tim-98765~A~Text-tim-98765-1-txt~Text~tim-98765~A~Text-tim-98765-1-cfg~Text~IMAN_Rendering
3) [8.0.0] Simple example to paste Dataset(s) to Dataset(1) (with no regard to parent

revs!):-
#----------------------------------------------
# Dataset(s) to Dataset(1)
#----------------------------------------------
RELATION MULTI PARENT OPTION = FIRST

RELATION MULTI CHILD OPTION = ALL

!~ParentName~ParentType~DsetName~DsetType~RelationName
Text-tim-98765-1~Text~Text-tim-98765-1-cfg~Text~IMAN_Rendering
4) [10.1.0] Attach a user’s Home folder to the infodba’s Home folder:-

#----------------------------------------------
# Home folder to Home folder by user name
#----------------------------------------------
!~ParentName~ParentType~RelationName~ChildName~ChildType~ParentOwner~ChildOwner
Home~Folder~~Home~Folder~infodba~tim
5) [10.1.0] Attach object to object using PUIDs:-

#----------------------------------------------
# Home folder to Home folder by puids with optional class checks
#----------------------------------------------
!~ParentPUID~ChildPUID~ChildClass~ParentClass
#A1OAAAg9YRLTNB~AsPAAAAYYRLTNB~Folder~Folder...
AsPAAAAYYRLTNB~A1OAAAg9YRLTNB~Folder~Folder...
More examples for relations mode can be found in Appendix F at 22..

9. DATASETS MODE
information for the datasets mode. The datasets mode is used to import data around the
following criteria:
o Create Datasets/Update existing datasets’ properties

o Import files to datasets
o Update existing files or replace existing Named References
o Attach the datasets to Items/Revisions in a specified relation
line argument:
-m=datasets
9.1.1 Datasets
FIELD DESCRIPTION
ItemID The Item ID of the parent Item
[RevID] OPTIONAL. The Revision ID of the Parent Revision
*DsetName The name of the dataset to paste in
*DsetType The type of the dataset
*DsetDesc Dataset Description
DsetGroup Dataset Owning Group
*DsetOwner Dataset Owning User
*DsetCrtDate Dataset Create Date
*DsetModDate Dataset Mod Date
*DsetModBy Dataset Last Modified By User
NewDsetName New Dataset Name. Use DsetName to find the
dataset and NewDsetName to change the name of the
dataset.
Volume Defines the volume for new files imported
DsetID Dataset ID
DsetRev Dataset Revision
* NOTE: These fields can be replaced with the standard item header fields, but if creating
items at the same time then use the Dset header fields if the dataset is to have different

data to that of the item and rev. [7.0.0] Alternatively use specific general properties for
items, revisions and datasets as required.
9.1.2 Files
FIELD DESCRIPTION
FileRef The name of the dataset reference to attach to
File The name and path of the file to import
9.1.3 Forms
FIELD DESCRIPTION
FormName The Name of a form to add as a reference to the
dataset
FormType The Type of the form
FormRef The name of the dataset reference to attach to
F:<attr> The attribute name on the form to populate
The following input data fields are valid in this mode and are specifically related to
relations
FIELD DESCRIPTION
RelationName The Name/Type of the relation to paste as
9.2.1 Datasets
OPTION DESCRIPTION
CREATE DATASET ON|OFF flag to control creation of Datasets
UPDATE DATASET ON|OFF flag to control updating of Datasets

OPTION DESCRIPTION
DATASET TYPE The default dataset type for new datasets
SET OWNER BY PARENT ON|OFF flag to control owner settings
(DEFAULT = OFF (Changed from ON in 10.0.0))
FILE REF NAME Dataset reference to attach file to
UPDATE FILES ON|OFF flag to control updating file references
UPDATE FILE REF NAME Update file reference option from:
NEW REF Create new references only, do nothing if exists
ADD REF Add new reference, even one already exists
REPLACE REF Replace existing ref
NEW VERSION Create new version of dataset and replace
CREATE NEW DATASET VERSION ON|OFF flag to be used instead of NEW
VERSION option in UPDATE FILE REF NAME
option. This can be used in conjunction with the
3 other options for more flexibility.
FILE REF REPLACE OPTION Options to define REPLACE REF option from:
ALL REFS Replace ALL references with new reference
MATCH FILE NAME Replay only the reference with the same file
MATCH REF TYPE name
Replace ALL references with the reference type
provided with the new file
FORM REF NAME Dataset reference to attach form to
UPDATE FORMS ON|OFF flag to control updating form references
UPDATE FORM REF NAME Update file reference option from:
NEW REF Create new references only, do nothing if exists
ADD REF Add new reference, even one already exists
REPLACE REF Replace existing reference
NEW VERSION Create new version of form and replace
FORM REF REPLACE OPTION Options to define REPLACE REF option from:
ALL REFS
Replace ALL references with new reference
MATCH FORM TYPE
Replay only the reference with the same for type
RELATION NAME The Name/Type of the relation to paste as
RELATION PARENT TYPE The type of parent object ITEM or REV.
If REV is used and no ParentRev or RevID is
given in the data file then the latest revision will
be used.
NOTE: All items mode configuration options are available in this mode.

9.3 MODULE NOTES

1. For best performance sort the data file by ItemID, RevID, Dataset Name and Ref
Name fields.
2. If the Revision ID is not supplied in the data file then datasets will be attached to the
Item (Default) or the Latest Revision, depending on the setting of the configuration
option RELATION PARENT TYPE.

FIELD DESCRIPTION
-ds_type=<Dataset Type> Dataset Type.
Configuration Option equivalent: DATASET TYPE
-rel=<Relation Type> Specify the Relation to use where Relation is one of:
Spec | Manif | Req | Ref.
Configuration Option equivalent: FORM TYPE
-pt=<Parent Type> Parent Object type to attach to.
Configuration Option equivalent: RELATION PARENT
TYPE
9.5 EXAMPLES
!~ItemID~RevID~DsetType~DsetName~File~DsetDesc~DSET:owning_user
000001~A~Text~Text-000001/A~file1.txt~Dset Desc file1.txt~Tim Williams(tim)
More examples for datasets mode can be found in Appendix G.

10. FOLDER MODE

information for the folders mode. The folders mode is used to import data around the
following criteria:
o Create Folders with the ability to supply full folder paths

o Populate folders
line argument:
-m=folder_create
-m=folder_insert
10.1.1 Folders
FIELD DESCRIPTION
ItemID The ItemID of the Item to insert into the folder
Folder The Folder Name or Path
FolderDesc The folder Description
FolderPath A Folder Path to create (nested folder structure).
FolderType The Type of folder to use.
10.2.1 Folders
OPTION DESCRIPTION
FOLDER SEPERATOR Define the character separator in folder path.
Default = /
TOP FOLDER The Name of a TOP folder to create folders in
TOP FOLDER DESCRIPTION The description of the top folder
DEFAULT FOLDER DESCRIPTION Default description for new folders
PUT FAILS IN NEWSTUFF ON|OFF flag to control using Newstuff if any
folder inserts fail
GLOBAL FOLDER SEARCH ON|OFF flag to control if the whole database is
searched for a folder (ON) or just folders owned
by the login user (OFF)
TOP FOLDER TYPE The Type of the top folder. (Default is "Folder")

FOLDER TYPE The Name/Type of the Folder
10.3 MODULE NOTES

1. If any folders cannot be found, they will be created.
2. For the best performance, sort the data file by folder path.
3. If no Folder Type is specified by the FOLDER TYPE configuration option or

FolderType field a default Folder Type of “Folder” will be used.
4. If the configuration options TOP FOLDER = Home and TOP FOLDER TYPE =
Folder, new Folder objects will be created/inserted into the users’ Home folder.
5. Beware of non-folder mode imports, such as items, that create objects and use
FOLDER NAME (or the Folder field) to insert the new object into a folder IF owner
and group fields are supplied as these will also set the ownership of the folder!
This means that, by default, a second run will not find the folder as it will search for
folders owner by the log-in user. So it may be necessary to use the option GLOBAL
FOLDER SEARCH = ON in order to search for folders owned by other users, but this
will only work reliably if the supplied folder name is unique.
Alternatively use a second import using either the folder_insert or relations mode to
attach the new objects to the folder.

The following command line arguments are valid in this mode and are specifically related to
folders
FIELD DESCRIPTION
-tf=<TopFolder> Name of Top Folder to populate.
Configuration Option equivalent: TOP FOLDER
-fs=<Folder Seperator> Folder path separator. Single character separator.
i.e. FolderA/FolderB/FolderC; Seperator = /
Configuration Option equivalent: FOLDER SEPERATOR
10.5 EXAMPLES
Examples for folders mode can be found in Appendix H.

11. PROJECTS MODE

information for the projects mode. The projects mode is used to import data around the
following criteria:
o Create, Update Projects and assign team members

o Assign V9+ Projects to Items and Revisions.
line argument:
-m=projects
NOTE: This functionality is only available in Teamcenter Engineering Version 9 and later.
11.1.1 Projects
FIELD DESCRIPTION
ProjID MANDATORY. Project ID
ProjName Project Name. If not supplied then the name will be set
with the Project ID
ProjDesc ProjectDescription
ProjMemberUser Project Member user. If used without role and group
then all group members for the user will be assigned
ProjMemberGroup Project Member Group. Can be supplied without role
and user to assign just to a group.
ProjMemberRole Project Member Role. If used without user and role
then all group members with this role will be assigned.
ProjAdminUser Project Admin User
ProjPrivUser Project Privileged user. Can be a comma separated list
of privileged users.
ItemID The ID of the Item to be assigned to the project
RevID The ID of the Revision to be assigned to the project
11.2.1 Projects
OPTION DESCRIPTION
CREATE PROJECTS ON|OFF flag to control if Projects should be created if

OPTION DESCRIPTION
they do not exist
UPDATE PROJECTS ON|OFF flag to control if Projects should be updated if
they already exist
PROJECT ASSIGN TO TYPE ITEM|REV. Controls if the specified ITEM or REVision
should be assigned to the project. Assigning an item
also assigns its Revisions automatically (this is
standard TcEng bahaviour).
PROJECT APPEND MEMBERS ON|OFF flag to control if Project members can be
added (appended) to an existing project (team).
Default = OFF. If not used, any existing project
assigned team will be replaced!
11.3 MODULE NOTES

1. To assign Items or Revisions to a project then the login user must be a privileged
user for the project.
2. Use separate data lines to assign multiple Items/Revisions to a project, one line per
Item/Revision.
3. Issues may be encountered trying to delete any existing members which are not
present in the new team being specified. It is recommended only to assign the
team when the project is created.
4. Projects can be assigned in items mode.

None.
11.5 EXAMPLES
Examples for projects mode can be found in Appendix I.

12. CLASSIFICATION MODE

information for the classification mode. The classification mode is used to import data
around the following criteria:
o Create, Update or Delete ICOs (InClass Objects)

o Classify Items/Revisions
line argument:
-m=inclass

The following input data fields are valid in this mode and are specifically related to
classification
FIELD DESCRIPTION
IcsClassID MANDATORY. In-Class Class ID
IcoPUID InClass PUID (Tag)
IcoID Inclass ICO ID
IcsAttr: Inclass Attribute ID. Use repeatedly to specify as many
attribute IDs as required.
<inclass_attr_id>
ItemID The ID of the Item to be classified
RevID The ID of the Revision to be classified
12.2.1 classification
OPTION DESCRIPTION
INCLASS CREATE ICO ON|OFF flag to control if InClass ICOs should be
created if they do not exist
INCLASS UPDATE ICO ON|OFF flag to control if InClass ICOs should be
updated if they already exist

OPTION DESCRIPTION
INCLASS UPDATE ICO OPTION ICO update option from:
SINGLE ICO ONLY
Only singly classified objects can be updated
FIRST ICO
If multiple ICOs on an object, only update the first
ALL ICOS
Update all ICOs on an object
INCLASS DEFAULT CLASS ID <ClassID>
Specifies a default class ID
INCLASS ICO CLASSIFY OBJECT ITEM|REV. Controls if the specified ITEM or
REVision should be classified with the InClass
ICO
INCLASS ALLOW MULTIPLE ON|OFF flag to control if multiple ICOs are
CLASSIFICATION allowed to be classified on a single item or
revision. If OFF only one ICO classification is
allowed. This option only affects the creation of
ICOs and subsequent classification. So if the
item, or rev, is already classified and this option
is OFF then the ICO will not be created
12.3 MODULE NOTES

1. Use standard items mode fields to specify Item and Revision details, in particular
ItemID and RevID to specify the Item ID and optionally the Revision ID of the Item
or Revision to classify. All other 'items' fields can be used to create or update items
and revs too.
2. The Class ID can be defaulted in the configuration file or provided in a field.
3. If no IcoID or IcoPUID field is specified then the Item ID specified will be used as
the IcoID, or 'ItemID/RevID' if classifying the revision.
4. To update individual ICOs on an object which has multiple classifications then use
the IcoPUID.
5. To add multiple classification objects to one Item or Revision, ensure INCLASS

UPDATE ICO is OFF, otherwise only existing ICOs will be updated.
6. By specifying a Class ID of 'UNCLASSIFY' an Item or Rev can be unclassified.

This will remove ALL ICOs classifying an object.
7. By specifying a Class ID of 'DELETE' a specific ICO can be deleted. Any

references (links) from objects (i.e. Workspace Objects) classified by the specified

ICO will be deleted, but the Workspace Object will remain, before the ICO is
deleted. The delete is based on specifying the ICOs PUID in the IcoPUID field.

None.
12.5 EXAMPLES
Examples for classification mode can be found in Appendix J.

13. IDENTIFIERS MODE

information for the identifiers mode. The identifiers mode is used to import data around the
following criteria:
o Create Alternate Identifiers and Identifier Revisions

o Update Alternate Identifiers and Identifier Revisions
line argument:
-m=identifiers
13.1.1 Identifiers
FIELD DESCRIPTION
AlternateID Alternate ID
AlternateRevID Alternate ID Supplementary ID for Revision
AlternateIDContext ID Context to use – must be defined in Teamcenter
Engineering
AltIDName Alternate ID object Name
AltIDDesc Alternate ID object Description
AltRevIDName Alternate Revision Name
AltRevIDDesc Alternate Revision description
ItemID ItemID the Identifier object is to be attached to
RevID RevID the supplementary Identifier object is to be attached to
AltIDOwner Owning user
AltIDGroup Owning group
AltIDType [7.7.0] Alternate ID object Type
Status [10.2.0] A status to be applied to the item revision and also
the identifier (AltID) and/or identifier rev (AltIDRev) depending
on the new config options RELEASE IDENTIFIERS and
RELEASE IDENTIFIER REVS.
All standard status fields and config options also apply.

13.2.1 identifiers
OPTION DESCRIPTION
CREATE IDENTIFIERS ON|OFF flag to control if Identifiers should be created if
they do not exist
UPDATE IDENTIFIERS ON|OFF flag to control if Identifiers should be updated if
they already exist
ALTERNATE ID CONTEXT Default ID Context to use when creating Alternate IDs.
CREATE IDFR REVS ON|OFF flag to control if IdentifierRev objects should be
created if they do not already exist at the Supplied
Revision. Default = ON
UDPATE IDFR REVS ON|OFF flag to control if IdentifierRev objects should be
updated if they do already exist at the Supplied Revision.
Default = OFF
IDENTIFIER TYPE [7.7.0] Default identifier type.
RELEASE IDENTIFIERS [10.2.0] ON|FLAG to control the releasing of the identifier
object.
Default = OFF
RELEASE IDENTIFIER [10.2.0] ON|FLAG to control the releasing of the identifier
REVS rev object.
Default = ON
13.3 MODULE NOTES

1. Use standard items mode fields to specify Item and Revision details in particular
ItemID and RevID to specify the Item and Revision to attach the Alternate ID and
Supplemental Identifier to.
2. The AlternateID and AlternateRevID fields are mandatory requirements.
3. The Alternate ID Context must be supplied in either a data field or configuration

option. This is also a mandatory requirement.
4. The input fields Name and Desc will be used if no AltIDName and AltIDDesc
fields are specified. The input fields RevName and RevDesc will be used if no
AltRevIDName and AltRevIDDesc fields are specified.
5. If no Name field is specified at all, the default Identifier object name will be the same
as the ID.

6. Other cfg options, CREATE ITEMS, CREATE REVS, UPDATE ITEMS, UPDATE
REVS, UPDATE ITEM ATTACHMENTS etc. can be used in conjunction with
creating and updating Identifier objects.
7. [10.2.0] Status can now be applied to the identifier and/or identifier rev using the
standard status fields and/or config options. The status options will also be applied
to the supplied item revision.

8. When working in other modes (i.e. datasets), if CREATE or UPDATE IDENTIFIERS

is set appropriately, system properties will be propagated to Identifier objects.

None.
13.5 EXAMPLES
Examples for identifiers mode can be found in Appendix K.

14. MANUFACTURING MODE

information for the manufacturing (mfg) mode. The manufacturing mode is used to import
data around the following criteria:
o Create and Update MEProcess, MEOP and MEWorkArea objects

o Build MEProcess/MEOP Bill of Process (BOP)
o Create Activities
o MEActivity and MEOP sequencing (PERT charts)
o Consume Product and Plant into Process BOM
line argument:
-m=mfg
14.1.1 Manufacturing
FIELD DESCRIPTION
ProcID MEProcess ID
ProcRevID MEProcess Revision ID
ProcType MEProcess class Type
ProcName MEProcess Name
ProcDesc MEProcess Description
OpID MEOP ID
OpRevID MEOP Revision ID
OpType MEOP Class Type
OpName MEOP Name
OpDesc MEOP Description
WorkID MEWorkArea ID
WorkRevID MEWorkArea Revision ID
WorkType MEWorkArea Class Type
WorkName MEWorkArea Name
WorkDesc MEWorkArea Description
ActType MEActivity Class Type

FIELD DESCRIPTION
ActName MEActivity Name
ActDesc MEActivity Description
ActTime MEActivity time (Duration)
ActPreds Name of MEActivity Objects attached to MEOP which
are predecessor Activities. (Used to provide
sequencing/flow in MSE).
FormType MEActivity Form Type
FormName MEActivity Form Name
FormDesc MEActivity Form Description
F:<attr> MEActivity Form attribute to populate. This must the
real attribute name, not the display name.
PlantTargetID Item ID for Plant BOM to link/consume from
PlantTargetRevID Rev ID for Plant BOM to link/consume from
ProductTargetID Item ID for Product BOM to link/consume from
ProductTargetRevID Rev ID for Plant BOM to link/consume from
TargetChildSeqNo Occurrence Seq No in Product/Plant BOM
TargetChildID Occurrence Item ID in Product/Plant BOM
TargetChildRev Occurrence Rev ID in Product/Plant BOM
TargetChildAbsOccID Occurrence AbsOccID in Product/Plant BOM context
ProcChildID Occurrence Item ID of operation in Process BOM to
consume target occurrence
ProcChildRev Occurrence Rev ID of operation in Process BOM to
consume target occurrence
14.1.2 [7.0.0] CC and SC

Collaboration Context and Structure Context object and structure fields:-
FIELD DESCRIPTION
CCName Name of CC
NewCCName New Name for existing CC with name specified by
CCName.
CCType Type of CC
CCDesc Description of CC
CCOwner Owner of CC
CCGroup Group of CC
CCStatus Status of CC
CCCfgContext Cfg Context for CC
CCRevRule Rev Rule for CC
CCSOSName [10.8.0] Saved Option Set (SOS) Name for CC.

FIELD DESCRIPTION
CCSOSDesc [10.8.0] Saved Option Set (SOS) Desc for CC.
CCSOSOptSet [10.8.0] Saved Option Set (SOS) Option Set for CC
legacy options.
For example:-
AHD54302; Load_Mainstream; ==; Y &
[AHD54302]Tim_test = Y
This example show the two possible different formats
allowed for setting values for options.
SCName Name of SC
NewSCName New Name for existing SC with name
SCType Type of SC
SCDesc Description of SC
SCOwner Owner of SC
SCGroup Group of SC
SCStatus Status of SC
SCCfgContext Cfg Context for SC. To create the Cfg Context with
the same name as the SC specify the name as
$SC_NAME.
SCRevRule Rev Rule for SC
SCSOSName [10.8.0] Saved Option Set (SOS) Name for SC.
SCSOSDesc [10.8.0] Saved Option Set (SOS) Desc for SC.
SCSOSOptSet [10.8.0] Saved Option Set (SOS) Option Set for SC
legacy options.
For example:-
AHD54302; Load_Mainstream; ==; Y &
[AHD54302]Tim_test = Y
This example show the two possible different formats
allowed for setting values for options.
SCAttObjClass Class of object to attach to SC.
Use in conjunction with ItemID and RevID then set
SCAttObjClass to:-
ITEM - to attach the item
REV - to attach the revision
BVR - to attach the BomView Revision
SCAttObjType Type of object to attach to SC.
Use in conjunction with SCAttObjClass to verify the
type of item, rev or BVR to be attached.
CfgContextType Type of Cfg context

To set general properties for CC and SC objects use CC:<property> and SC:<property>.
14.1.2.1 Notes for SC and CC
1) To attach an item, rev or BVR to an SC supply an ItemID field with the required
item ID and RevID field with the required rev ID.
Then set SCAttObjClass to ITEM, REV or BVR as required.
2) To attach a form to an SC supply FormName, FormType and RelationName fields.
3) To create a CC -> SC structure supply as many lines as SC’s required with CC and
SC details.
14.2.1 Manufacturing
OPTION DESCRIPTION
CREATE PROCESSES ON|OFF flag to control creating MEProcesses if they
do not exist
UPDATE PROCESSES ON|OFF flag to control updating MEProcesses if the
already exist.
CREATE PROCESS REVS ON|OFF flag to control creating MEProcess Revisions
if they do not exist
UPDATE PROCESS REVS ON|OFF flag to control updating MEProcess Revisions
if the already exist.
CREATE OPERATIONS ON|OFF flag to control creating MEOPs if they do not
exist
UPDATE OPERATIONS ON|OFF flag to control updating MEOPs if the already
exist.
CREATE OPERATION REVS ON|OFF flag to control creating MEOP Revisions if
they do not exist
UPDATE OPERATION REVS ON|OFF flag to control updating MEOP Revisions if
they already exist
CREATE ACTIVITIES ON|OFF flag to control creating MEActivities if they
don’t already exist
UPDATE ACTIVITIES ON|OFF flag to control updating MEActivities if they
already exist
CREATE ACTIVITY FORMS ON|OFF flag to control creating forms if they do not
exist on an MEActivity.
UPDATE ACTIVITY FORMS ON|OFF flag to control updating forms if they already
exist on an MEActivity.
LINK OP TO PROCESS ON|OFF flag to control if Process BOM (MEProcess
MEOP(s) ) should be created and/or updated for the
MEProcess structure (BOP). If OFF objects are
created independently – no BOP structure

OPTION DESCRIPTION
PROCESS TYPE A valid MEProcess Type to use
OPERATION TYPE A valid MEOP Class Type to use
ACTIVITY TYPE A valid MEActivity Type to use
ACTIVITY FORM TYPE A valid Form Type to use
DEFAULT OWNER Default Owning User. Must be a valid user
DEFAULT GROUP Default Owning Group. Must be a valid group
CREATE WORKAREAS ON|OFF flag to control if MEWorkArea objects should
be created if they do not exist
UPDATE WORKAREAS ON|OFF flag to control if MEWorkArea objects should
be updated if they already exist.
CREATE WORKAREA REVS ON|OFF flag to control if MEWorkArea Revisions
should be created if they do not exist
UPDATE WORKAREA REVS ON|OFF flag to control if MEWorkArea Revisions
should be updated if they already exist
WORKAREA TYPE MEWorkArea Class Type. The valid name of
MEWorkArea Type to use.
LINK PRODUCT TO PROCESS ON|OFF flag to control linking Product structure root to
Process structure root.
LINK PLANT TO PROCESS ON|OFF flag to control linking Plant structure root to
Process structure root.
14.2.2 [7.0.0] CC and SC

Collaboration Context (CC) and Structure Context (SC) configuration options:-
OPTION DESCRIPTION
CREATE CC ON|OFF flag to control creating CC’s if they do not exist.
CREATE CC ALWAYS ON|OFF flag to control creating CC’s always, even if one
already exists with the same name.
UPDATE CC ON|OFF flag to control updating CC’s if they exist.
CREATE SC ON|OFF flag to control creating SC’s if they do not exist.
UPDATE SC ON|OFF flag to control updating SC’s if they exist.
CREATE CFG CONTEXT ON|OFF flag to control creating the CfgContext if one does
not exist for the SC.
UPDATE CFG CONTEXT ON|OFF flag to control updating the CfgContext if one
already exists for the SC.
CREATE CC STRUCTURE ON|OFF flag to control creating the CC’s structure if one
does not exist.
UPDATE CC STRUCTURE ON|OFF flag to control updating the CC’s structure if one
already exists.

OPTION DESCRIPTION
CREATE SC STRUCTURE ON|OFF flag to control creating the SC’s structure if one
does not exist.
UPDATE SC STRUCTURE ON|OFF flag to control updating the SC’s structure if one
already exists.
CC DEFAULT TYPE Sets the default Collaboration Context (CC) type.
The default is CCObject.
SC DEFAULT TYPE Sets the default Structure Context (SC) type.
The default is StructureContext.
CFG CONTEXT DEFAULT Sets the default Configuration Context type.
TYPE
The default is ConfigurationContext.
CREATE LEGACY VRULE Same option as used in BOM legacy VRule creation to
control the behaviour with creating CC and SC SOSs.
UPDATE LEGACY VRULE Same option as used in BOM legacy VRule update to
control the behaviour with updating CC and SC SOSs.
UPDATE LEGACY VRULE Same option as used in BOM legacy VRule update to
OPTION control the behaviour when updating CC and SC SOSs.
The available options are:-
REPLACE – to replace the entire Option Set. Must
be used for new option sets! This is the default option.
UPDATE – to update individual options
14.3 MODULE NOTES

1. Processes, Operations and WorkAreas can have their system properties set by
running in items mode after they have been created.
2. If PROCESS TYPE configuration option and ProcType data field are not set, the
Process Type will default to MEProcess. The data field value takes precedence
over the configuration option.
3. If OPERATION TYPE configuration option and OpType data field are not set, the
Operation Type will default to MEOP. The data field value takes precedence over the
configuration option.
4. If ACTIVITY TYPE configuration option and ActType data field are not set, the
Activity Type will default to MEActivity. The data field value takes precedence

5. The DEFAULT OWNER/DEFAULT GROUP options apply to all objects in mfg mode
and will be applied at create or update (if configuration allows) of an object.
6. The DEFAULT OWNER/DEFAULT GROUP is propagated to the Process, Process

Master form, Process Revision, Process Revision master form and BVs/BVRs. To
change other attachments, please use other modes. This is the same for
Operations.
7. See Section 2 for BOM module config settings/input fields. The BOM module
functionality is fully exposed to the MFG module and used to create Process<--
Operation structures.
8. All supplied object Types are validated before attempting to create objects.
9. Activities are Created in the context of an Operation. To create activities, the

Operation ID/Rev must be supplied.
10. If UPDATE ACTIVITY = OFF, any form updates are disabled no matter what
ACTIVITY FORM settings are present. If ACTIVITY UPDATE = ON, the
ACTIVITY FORM configuration options are then activated.
11. All mfg objects are created BEFORE being added to the Process structure.

12. Assumption: There will be only 1 form of a particular type with a specific name
attached to an Activity.
13. Use mfg mode to create all MEWorkArea objects and then use BOM mode to
create a Plant structure with bom data set.
14. If WORKAREA TYPE configuration option and WorkType data field are not set, the
WorkArea Type will default to MEWorkArea. The data field value takes precedence
15. If relation of ACTIVITIES is set in 'REV RELEASE RELATIONS' configuration

options list when applying a status to a MEOP Revision, the Activity_Root and all
subsequent attachments/Activities etc. will also have the same status applied. This
works recursively.
16. [7.7.0] Objects can be attached to SCs using a GRM relation by supplying the
RelationName field or the RELATION NAME option.

None.
14.5 EXAMPLES
Examples for mfg mode can be found in Appendix L.

15. WORKFLOW MODE

information for the workflow mode. The workflow mode is used to import data around the
following criteria:
o Create new workflow processes on specified target objects and add

reference objects
o Update existing workflow processes by adding new target or reference
objects
o Optionally initiate workflow processes
line argument:
-m=workflow
NOTE: This functionality does provide any functionality for assigning any users to any
tasks, or perform any actions on tasks in any way. It merely creates or updates workflow by
adding targets and references, and optionally initiating those processes.
15.1.1 Workflow
FIELD DESCRIPTION
WFProcessName The name of the workflow process to create or update.
This is a mandatory field.
WFProcessDesc The description to set on the workflow process.
WFProcessTpl The workflow template to create a new workflow process from.
WFProcessOwner The owning user to be set for the workflow process. This is the
responsible party for the process,
WFProcessGroup The owning group to be set for the workflow process.
WFAttachType Specifies where to attach objects to the workflow process from:-
TARGET Attach the item or rev as a target
REFERENCE Attach the item or rev as a reference
Alternatively, set a default value with the config option
WORKFLOW ATTACH TYPE.
If not value is specified then the default is TARGET.
WFAttachObject Specifies which object to attach, from:-
ITEM Attach the item.
REV Attach the rev

FIELD DESCRIPTION
Alternatively, set a default value with the config option
WORKFLOW ATTACH OBJECT.
If not value is specified then the default is REV.
WFInitiate Specifies if the workflow process should be initiated, by
supplying the value YES, this is the default behaviour, i.e.
initiate.
So supply some other value such as NO to stop new processes
form being initiated, or set the config option WORKFLOW
INITIATE PROCESS = NO.
15.1.2 Other relevant fields

FIELD DESCRIPTION
ItemID To find an item.
RevID To find a specific revision for the supplied item ID. If not
supplied, but a rev is to be attached, then the latest revision will
be attached if UPATE LATEST REV = ON..
CCName To find a Collaboration Context object.
FolderContents To supply the name of a folder containing objects to be added to
the workflow process.
FolderType Supply with FolderContents to find a folder of a specific
type.
15.2.1 Workflow
OPTION DESCRIPTION
CREATE WF PROCESS ON|OFF flag to control if new workflow processes should
be created if they do not exist.
The default is ON.
CREATE WF PROCESS ON|OFF flag to control if new workflow processes should
ALWAYS always be created even if one already exists with the same
name.
The default is OFF.
UPDATE WF PROCESS ON|OFF flag to control if existing workflow processes
should be updated. This allows updating of properties of
the workflow process and adding additional target and
reference objects.
The default is OFF.
WORKFLOW TEMPLATE The name of the workflow template to base a new
workflow process on.
WORKFLOW ATTACH TYPE Set a default attachment type, from:-
TARGET Attach the item or rev as a target

OPTION DESCRIPTION
REFERENCE Attach the item or rev as a reference
The default is TARGET.
WORKFLOW ATTACH Set a default attachment object type, from:-
OBJECT
ITEM Attach the item.
REV Attach the rev
The default is REV.
WORKFLOW INITIATE ON|OFF flag to control if new workflow processes should
PROCESS be initiated.
The default is ON.
WORKFLOW INDIVIDUAL ON|OFF flag to control if new workflow processes should
PROCESSES be created for each object found, e.g. in a folder.
The default is ON.
15.3 MODULE NOTES

1. Supplying multiple data lines with the same process name will add any supplied objects
to the same process, unless CREATE WF PROCESS ALWAYS is ON (and CREATE WF
PROCESS is on) in which case a new process will be created for each data line.
This will internally store lists of target and reference objects, as specified with these
multiple data lines, and on the last supplied line for the process name, the process will
be created (and optionally initiated) or updated as required.
2. General workflow properties can be set using WFPROC:<property_name>.
See the section [7.0.0] General properties for further details on setting general
properties.
3. A workflow template must be supplied to create new workflow processes.

None.
15.5 EXAMPLES
15.5.1 Quick example
15.5.1.1 Config file
UPDATE WF PROCESS = ON
CREATE WF PROCESS = ON
CREATE WF PROCESS ALWAYS = OFF
WORKFLOW INITIATE PROCESS = OFF
#WORKFLOW TEMPLATE = Test Process


WORKFLOW ATTACH TYPE = TARGET

WORKFLOW ATTACH OBJECT = REV
#WORKFLOW INDIVIDUAL PROCESSES = ON
UPDATE LATEST REV = ON
OUTPUT COL SIZE TYPE = 30

OUTPUT COL SIZE NAME = 24
OUTPUT COL SIZE STATUS = 28
CREATE ITEMS = OFF
TOP FOLDER = Home
LOG FILE FORMATS = CSV,DELIM
15.5.1.2 Data File
WORKFLOW TEMPLATE = 0-Test

UPDATE WF PROCESS = ON
!~ItemID~RevID~WFProcessName
000017~A~000017-A-0-Test
000019~A~000017-A-0-Test
#------------------
END-OF-FILE
#------------------
WORKFLOW INDIVIDUAL PROCESSES = OFF
!
~WFProcessName~WFProcessDesc~WFProcessTpl~WFProcessOwner~WFProcessGrou
p~WFAttachType~WFAttachObject~WFInitiate~ItemID~CCName~FolderContents
WF-tim-1~First test workflow~0-TEST Check Conf
Child~tim~Designers~TARGET~REV~NO~New_Assy2
Child~tim~Designers~REFERENCE~~NO~~~TEST UPLOAD FOLDER
Child~tim~Designers~REFERENCE~REV~YES~New_Assy1XX
WF-tim-2~First test workflow~0-TEST-Xtrac
MRP~tim~Designers~TARGET~REV~NO~000010


MRP~tim~Designers~TARGET~REV~NO~New_Assy1XX
MRP~tim~Designers~REFERENCE~~NO~~~UPLOAD FOLDER FOR CCs
MRP~tim~Designers~REFERENCE~~YES~~CC_test_upl_3
#------------------
END-OF-FILE
#------------------
WORKFLOW INDIVIDUAL PROCESSES = ON
!
~WFProcessName~WFProcessDesc~WFProcessTpl~WFProcessOwner~WFProcessGrou
p~WFAttachType~WFAttachObject~WFInitiate~FolderContents
Child~tim~Designers~TARGET~~YES~TEST UPLOAD FOLDER
Child~tim~Designers~TARGET~~YES~UPLOAD FOLDER FOR CCs
#------------------
END-OF-FILE
#------------------

16. [9.0.0] POM MODE

information for the pom mode to create and update general POM objects.
This mode is specified using the command line argument:-
-m=pom
WARNING: This is a very powerful mode and with great power comes great responsibility
so great care should be taken, with comprehensive testing, when using this mode as it’s
possible to create and update data that may cause problems with the data in Teamcenter.
See General methodology of the pom mode for full instructions on using this mode.

There are no specific pre-defined field names for this mode as all fields used are dynamic to
specify the class and attribute to which a value applies. Although some pre-existing fields
from other modes can be used to specify parent objects to attach objects to and to specify
system fields to be set.
Field modifiers can also be used, see 2.3.2.1 [7.0.0] Field Modifiers, including some specific
to the pom mode which are defined in 2.3.2.1.1 [9.0.0] Pom module modifiers.
16.1.1 Pom fields
Pom fields are dynamic as they need to specify a class and an attribute name, for
example:-
CompanyLocation:object_name.KEY
This specifies the class as CompanyLocation and the attribute as object_name. This
example is also specified as being a key field to search on by the .KEY modifier.
16.1.2 Parent fields
Parent fields defined for the Relations mode can be used to find parents for the primary
pom objects being created or updated, i,e:-
ItemID or ParentID
[RevID or ParentRev]
RelationName
ParentType
ParentName
16.1.3 System fields

FIELD DESCRIPTION
Name Set the primary object’s Name.
Desc Set the primary object’s Description.
CreateDate Set the primary object’s Create Date.

FIELD DESCRIPTION
ModifyDate Set the primary object’s Modify Date.
Owner Set the primary object’s Owner.
Group Set the primary object’s Group.
LastModBy Set the primary object’s Last Modified By.
Status Set the primary object’s Release Status.
16.2.1 Pom
OPTION DESCRIPTION
POM PRIMARY CLASS Defines the class of the primary object being created.
If not supplied then the first class listed in CREATE
POM OBJECTS will be used as the primary class.
CREATE POM OBJECTS Defines a comma separated list of object classes to be
created.
For example if a Web Link form is to be created then its
WebLink data object must also be created and so the
following list would be required:-
CREATE POM OBJECTS = Form,WebLink
NOTE: The CSV list must NOT contain spaces around
the commas.
CREATE POM OBJECTS Defines a comma separated list of object classes to be
ALWAYS created ALWAYS, i.e even if one exists with the same
KEY values.
As in the above example for creating a Web Link form a
WebLink data object must always be created since no
two forms should reference the same data object.
Therefore this option would be set to:-
CREATE POM OBJECTS ALWAYS = WebLink
NOTE: If this class is not defined in the CREATE POM
OBJECTS list then it will be added to it by default.
UPDATE POM OBJECTS Defines a comma separated list of object classes to be
updated.
For example if a Web Link form is to be updated and its
WebLink data object is also to be updated then the
following list would be required:-
UPDATE POM OBJECTS = Form,WebLink
NOTE: The CSV list must NOT contain spaces around
the commas.

OPTION DESCRIPTION
UPDATE MULTI POM Specifies what to do if more than one pom object is
OBJECTS OPTION found. The available options are:-
NONE - Update none of them
FIRST - Update the first one
ALL - Update all of them
NOTE: This applies to all classes being updated as
defined by UPDATE POM OBJECTS.
FIND POM OBJECTS IF NOT ON|OFF flag to control if objects should be found by a
IN PARENT general search, i.e. not in the specified parent, or only
attached to a specified parent when ParentID and
ParentRev fields are specified to define a parent, for
example.
Default is OFF.
POM DEFAULT ATTRS FOR Specifies a comma separated list of attributes to be
CLASS <class_name> defaulted wiuth null values for a the specified
<class_name>, for example to set some default
attributes for the class CompanyLocation:-
POM DEFAULT ATTRS FOR CLASS
CompanyLocation =
object_desc,url,owning_organization,owning_project,
region,state_province
16.2.2 Other relevant options
Se the section 2.4.2 General Configuration Options for general options that can also be
used.
When parent fields are used then the following relation options, as defined in 8.3.1
Relations, can be used:-
RELATION NAME
RELATION PARENT TYPE
RELATION CHILD TYPE
RELATION PARENT RELATION
RELATION MULTI PARENT OPTION
RELATION PARENT WSOM TYPE

16.3 MODULE NOTES
16.3.1 General methodology of the pom mode
16.3.1.1 Introduction
The pom mode is designed to be able to create almost any object in the Teamcenter data model and
set attributes directly. So this bypasses general ITK functions that would validate such data to ensure
data integrity. It also bypasses general access rules too. Therefore great care should be taken and
extensive testing should be done when using this mode and with the aid of an SQL query tool to see
exactly what gets created/updated in the database to ensure that the desired results are achieved
and that Teamcenter still behaves correctly with the affected objects.
16.3.1.2 Finding objects
Objects will either be found by searching the database, looking in a parent object (see Attaching to
parent objects) or found attached to referenced attributes (see Object references).
To find objects stored in the database some KEY attributes for a class need to be specified as values
to search on and are specified using the header field modifier .KEY, for example to search for Form
objects using object_name and object_type the following fields would be used:-
!~Form:object_name.KEY~Form:object_type.KEY
Key fields are only used for searching and will not be updated. To update a key field supply the field
again without the .KEY modifier.
16.3.1.3 Default values
Type specific ITK functions, e.g. item specific, would also set any required default attributes for an
object being created, but this does not happen when using low level POM functions as used by the
pom mode. Therefore it’s necessary to supply values for all attributes for an object, or at least
specify which attributes should be set to a null default value based on an attributes data type. See
the Notes on creating a POM object section below on a method to help find out all of the attributes
that need to be set or defaulted for a class.
16.3.1.4 Create and Update option CSV lists
The CREATE and UPDATE options for the pom module work differently to other modes as they
supply a comma separated list of classes to create or update rather than a simple ON/OFF flag.
This is because a data file may supply data for several objects to be created or updated and linked
together through referenced attributes. So it may be that a primary object is to be updated but a new
secondary object created.
16.3.1.5 Object references
Many attributes in the Teamcenter data model are typed or un-typed references to other objects. The
typed attributes have to a specific (or typed) class of object attached whereas un-typed attributes can
have almost any type of object attached. The pom mode does provide some ability to set these
attributes.
This is done by specifying a referenced attribute with the .CLASS modifier added to its field header.
The supplied value for this field then supplies the class name of the secondary object that will be
attached to the referenced attribute in the primary object. Subsequent header fields will then be
prefixed with the class name of the secondary object’s class name to set values for that object. The

pom mode has been designed to allow this to happen recursively, i.e. to attach further objects to
referenced attributes in the secondary object.
For example a Form object has a data file object attached to it in the data_file attribute, where the
data file object contains the custom attributes that a user would set on a form, whereas the actual
form object contains the system properties like create date, owner etc.
To use a specific example the Form of type Web Link uses a data object class called WebLink (no
space) which has an attribute url. Since the primary object here is a Form then all fields setting
values on the Form must be prefixed with Form and any fields setting values on the data object
prefixed with WebLink. The link between the two occurs on the Form attribute data_file which must
have the .CLASS modifier and a corresponding data value of WebLink thus:-
!~…~Form:data_file.CLASS~…
…~WebLink~…
A Form object is a Workspace object and requires certain attributes to be populated like Name, Type
and Description. But there are also other values which must at least be defaulted and these can
increase with subsequent versions of Teamcenter. At 8.3 the attributes owning_organization and
owning_project must be set. If specific values don’t need to be set then these can be defaulted in
the configuration file with a specific option to default Form attributes, thus:-
POM DEFAULT ATTRS FOR CLASS Form = owning_organization,owning_project
Some system attributes still get defaulted by Teamcenter though. For example, Workspace object
attributes like owner, group, create date, last modified date and last modified by will be defaulted by
default. And then are some known attributes which get set by default by IPS Data Upload depending
upon the object’s class. For example for a Workspace object attributes like gov_classification and
wso_thread will get defaulted, and for a Form form_file and data_file will get defaulted.
But all other attributes need to be specified in the data file. So bringing it all together for a Web Link
form we have:-
16.3.1.5.1 Config example

This example will update existing forms if found, or create new forms if not. It will also update an
existing WebLink object already attached to a form, or if not then ALWAYS create a new one, hence
no .KEY fields are required for WebLink as no search is required.
CREATE POM OBJECTS = Form
FIND POM OBJECTS IF NOT IN PARENT = ON
SET BYPASS = ON
16.3.1.5.2 Data example

!
~Form:object_name.KEY~Form:object_type.KEY~Form:object_desc~Form:data_file.CLASS~WebLin
k:url~ParentID~ParentRev~RelationName~Owner~CreateDate
google2~Web Link~Google
Search~WebLink~http://www.google.com/~000028~A~IMAN_reference~infodba~16-Mar-2000 10:00
google~Web Link~Google UK~WebLink~http://www.google.co.uk/~000028~A~IMAN_reference~~16-
Mar-2000 10:00

16.3.1.6 Replacing referenced obejcts
If a primary object needs updating and it’s secondary object replaced with another one then use
the .REPLACE modifier as well as the .CLASS modifier, for example:-
!~…~Form:data_file.CLASS.REPLACE~…
…~WebLink~…
NOTE: The original object attached to the attribute will not be deleted from the database.
16.3.1.7 Setting properties for convenience
For convenience it’s possible to specify a property (as opposed to an attribute) using the .PROP field
modifier which will get Teamcenter to do a lot of work for you. In the above example for setting the
url attribute on the WebLink data object in a Web Link form it’s easier to set this as a property on the
Form, thus:-
!~Form:object_name.KEY~Form:object_type.KEY~Form: object_desc ~Form:url.PROP~…
google2~Web Link~Google Search~http://www.google.com/~
instead of specifying the WebLink as a referenced object to the Form’s data_file attribute, as above,
using:-
!
~Form:object_name.KEY~Form:object_type.KEY~Form:object_desc~Form:data_file.CLASS~WebL
ink:url~
google2~Web Link~Google Search~WebLink~http://www.google.com/~
16.3.1.8 Setting system properties
Various system properties can be set on the primary object using known field keywords, see System
fields for a list of these.
Also the keywords Name and Desc can be used instead object_name and object_desc.
16.3.2 Attaching to parent objects
Primary objects can be:-

 Created and attached to a GRM relation in a parent object.
 Found in a parent object under a GRM relation and updated.
 Found in the database and attached to a GRM relation in a parent object.
Use relation mode parents field, see Parent fields, and configuration options to specify a GRM
parent and GRM type.
By default the parent object(s) will be searched to see if the required primary object(s), using the
defined .KEY fields, is already attached to the specified GRM relation under the parent object(s). If
it’s found then it will be updated if it’s in the list defined by UPDATE POM OBJECTS, otherwise it’ll be
created if it’s in the list defined by CREATE POM OBJECTS.
Alternatively the config option FIND POM OBJECTS IF NOT IN PARENT can be set to ON to search
for the primary object in the database if it wasn’t found already attached to the parent. In which case
if the primary object is found then it’ll be attached to the parent.
16.3.3 Notes on creating a POM object
Using CompanyLocation as an example:-

1) Start by using the minimum of key fields, e.g. object_name and object_type, to get a CREATE
FAILED, e.g.:-
!~CompanyLocation:object_name.KEY~CompanyLocation:object_type.KEY
Siemens~CompanyLocation
2) Check the syslog for empty attributes, e.g.:-

Instance 000077e8 <gUA9E$ogI4WWSA>(CompanyLocation) attribute owning_organization is empty
Instance 000077e8 <gUA9E$ogI4WWSA>(CompanyLocation) attribute owning_project is empty
Instance 000077e8 <gUA9E$ogI4WWSA>(CompanyLocation) attribute region is empty
Instance 000077e8 <gUA9E$ogI4WWSA>(CompanyLocation) attribute country is empty
Instance 000077e8 <gUA9E$ogI4WWSA>(CompanyLocation) attribute postal_code is empty
Instance 000077e8 <gUA9E$ogI4WWSA>(CompanyLocation) attribute state_province is empty
Instance 000077e8 <gUA9E$ogI4WWSA>(CompanyLocation) attribute city is empty
Instance 000077e8 <gUA9E$ogI4WWSA>(CompanyLocation) attribute street is empty
3) Any of these that are not required to have a specific value need to be added to a config option to
set default empty values for, e.g.:-
POM DEFAULT ATTRS FOR CLASS CompanyLocation =
owning_organization,owning_project,region,state_province
4) All others should be set in the data file as non KEY fields, e.g.:-
!
~CompanyLocation:object_name.KEY~CompanyLocation:object_type.KEY~CompanyLocation:countr
y~CompanyLocation:postal_code~CompanyLocation:city~CompanyLocation:street
Siemens~CompanyLocation~UK~GU15 3SY~Camberley~Knoll Road
5) If still get CREATE FAILED check the syslog again for further empty attributes, e.g.:-
Instance 000077f2 <gYH9UDlMI4WWSA>(CompanyLocation) attribute object_desc is empty
Instance 000077f2 <gYH9UDlMI4WWSA>(CompanyLocation) attribute url is empty

There are no new specific arguments for this mode. Everything is controlled by configuration options
and field headers.

16.5 EXAMPLES
16.5.1 Creating/Updating Web Link forms
This example will update existing forms if found, or create new forms if not. It will also update an
existing WebLink object already attached to a form, or if not then ALWAYS create a new one, hence
no .KEY fields are required for WebLink as no search is required.
CREATE POM OBJECTS = Form
SET BYPASS = ON
16.5.1.2 Data file
!
~Form:object_name.KEY~Form:object_type.KEY~Form:object_desc~Form:data_file.CLASS~WebLin
k:url~ParentID~ParentRev~RelationName~Owner~CreateDate
google2~Web Link~Google
Search~WebLink~http://www.google.com/~000028~A~IMAN_reference~infodba~16-Mar-2000 10:00
google~Web Link~Google UK~WebLink~http://www.google.co.uk/~000028~A~IMAN_reference~~16-
Mar-2000 10:00
16.5.2 Creating/Updating CompanyLocation objects
CREATE POM OBJECTS = CompanyLocation

CREATE POM OBJECTS ALWAYS = OFF
UPDATE POM OBJECTS = CompanyLocation

#FIND POM OBJECTS IF NOT IN PARENT = OFF
POM DEFAULT ATTRS FOR CLASS CompanyLocation =

object_desc,url,owning_organization,owning_project,region,state_province,ABG_Approved_For_Wipe
s,ABG_Approved_For_Medical,ABG_Approved_For_Hairdryers,ABG_Approved_For_Cosmetics,AB
G_Approved_For_Aerosols
SET BYPASS = ON
UPDATE MODIFY DATES = OFF

16.5.2.2 Data file
!
~CompanyLocation:object_name.KEY~CompanyLocation:object_type.KEY~CompanyLocation:countr
y~CompanyLocation:postal_code~CompanyLocation:city~CompanyLocation:street~ParentID~Parent
Rev~RelationName~CompanyLocation:last_mod_date
Siemens~CompanyLocation~UK~GU15 3SY~Camberley~Knoll
Road~000010~A~IMAN_reference~01-Apr-2000 09:00

17. APPENDIX A: DATE FORMATTING SEQUENCES

The following can be used with the DATE FORMAT configuration option.
OPTION DESCRIPTION
%a locale's abbreviated weekday name (Sun..Sat)
%A locale's full weekday name, variable length (Sunday..Saturday)
%b locale's abbreviated month name (Jan..Dec)
%B locale's full month name, variable length (January..December)
%c locale's date and time (Sat Nov 04 12:02:33 EST 1989)
%C century (year divided by 100 and truncated to an integer) [00-99]
%d day of month (01..31)
%D date (mm/dd/yy)
%e day of month, blank padded ( 1..31)
%F same as %Y-%m-%d
%g the 2-digit year corresponding to the %V week number
%G the 4-digit year corresponding to the %V week number
%h same as %b
%H hour (00..23)
%I hour (01..12)
%j day of year (001..366)
%k hour ( 0..23)
%l hour ( 1..12)
%m month (01..12)
%M minute (00..59)
%n a newline
%N nanoseconds (000000000..999999999)
%p locale's upper case AM or PM indicator (blank in many locales)
%P locale's lower case am or pm indicator (blank in many locales)
%r time, 12-hour (hh:mm:ss [AP]M)
%R time, 24-hour (hh:mm)
%s seconds since `00:00:00 1970-01-01 UTC' (a GNU extension)
%S second (00..60); the 60 is necessary to accommodate a leap second
%t a horizontal tab
%T time, 24-hour (hh:mm:ss)
%u day of week (1..7); 1 represents Monday
%U week number of year with Sunday as first day of week (00..53)
%V week number of year with Monday as first day of week (01..53)
%w day of week (0..6); 0 represents Sunday

OPTION DESCRIPTION
%W week number of year with Monday as first day of week (00..53)
%x locale's date representation (mm/dd/yy)
%X locale's time representation (%H:%M:%S)
%y last two digits of year (00..99)
%Y year (1970)
%z RFC-822 style numeric timezone (-0500) (a nonstandard extension)
%Z time zone (e.g., EDT), or nothing if no time zone is determinable

18. APPENDIX B: ITEMS MODULE EXAMPLES
To Create or update items, setting owner, group, create date and

Project ID on the revision master form. Put any new items into the
folder "Upload Tests".
Config File
-------------------------------
CREATE ITEMS = ON
UPDATE ITEMS = ON
CREATE REVS = ON
UPDATE REV S = ON

TOP FOLDER = Home
FOLDER NAME = \Upload Tests
DEFAULT REV =A
ITEM TYPE = Item
Data File
-------------------------------
!~ItemID~RevID~Owner~Group~CreateDate~RM:project_id~RMD:date_valid_from
BomAssy1~A~williams~designers~16/03/1997~Project X~01/04/1997
BomChild1~A~williams~designers~16/03/1997~Project X~01/04/1997

To Perform a Check-Out on an ItemRevision and all attachments that

can have a Check-Out set. No Item/Item Attachmnents are checked!
Any objects that have an existing Check-Out set will be Checked-In –
these objects will NOT have the Check-Out set.
Config File
-------------------------------
CREATE ITEMS = ON
UPDATE ITEMS = OFF
CREATE REVS = ON
UPDATE REVS = ON
UPDATE REV ATTACHMENTS = ON
UPDATE ITEM ATTACHMENTS = OFF
UPDATE FORMS = ON
UPDATE DATASET = ON
UPDATE BOMS = ON
#New CICO config options

CREATE CICO = ON
UPDATE CICO = CHECK IN
CHECK OUT REASON = Guy's Check-Out test
Data File
-------------------------------
!~ItemID~RevID
GUY98765~A

To Perform a Checkin-On all Checked-Out objects attached to an

ItemRevision. No Item/Item Attachments are checked! The Change_id
is supplied in the data field. No existing Check-Outs will be
changed.
Config File
-------------------------------
CREATE ITEMS = ON
UPDATE ITEMS = OFF
CREATE REVS = ON
UPDATE REVS = ON
UPDATE FORMS = ON
UPDATE DATASET = ON
UPDATE BOMS = ON

CREATE CICO = ON
UPDATE CICO = OFF
Data File
-------------------------------
!~ItemID~RevID~CheckOutID
GUY98765~A~CID_982KDME8001

19. APPENDIX C: BOM MODULE EXAMPLES
19.1 A simple BOM with ownership

To create a basic BOM, set the Quantity in the BOM for each
occurrence added and set owner, group and CreateDate properties on
the Items.
Config File
-------------------------------
MODE = bom
BOM FORMAT = parent_child
DATE FORMAT = %d/%m/%y %H:%M:%S
FOLDER NAME = Upload Tests
DEFAULT REV =A
SET BOMS PRECISE = OFF
Data File
-------------------------------
ITEM TYPE = Item
VIEW TYPE = Design
!~ItemID~ChildID~Qty~Owner~Group~CreateDate
BomAssy1~BomChild1~2~williams~designers~16/03/1997

19.2 Unset sequence numbers

Blank all sequence numbers in a BOM...
Config File
-------------------------------
CREATE BOMS = ON
UPDATE BOMS = ON
BOM UPDATE OPTION = UPDATE ALL OCCURRENCES
Data File
-------------------------------
!~ParentID~ChildID~SeqNo
Assembly123~*~NULL
19.3 Reset sequence numbers

Reset sequence numbers (from 10,20,30... to 1,2,3...), matching
occurrences on ChildId and SeqNo...
Config File
--------------------------------
BOM UPDATE OPTION = UPDATE OCCURRENCES
BOM UPDATE ID FIELDS = ChildID,SeqNo
Config File
--------------------------------
!~ParentID~ChildID~SeqNo~NewSeqNo
Assembly123~Child1~10~1

19.4 Pre delete by occurrence note

To Pre-delete occs with Occ Note "RDN Letter" set and then update
occurrences by matching on ChildID and SeqNo. Update Qty and RDN
Letter, do NOT add any occurrences which are not found and delete
occurrences where RDN Letter = X.
Config File
-------------------------------
BOM UPDATE ID FIELDS = ChildID,SeqNo
BOM UPDATE ADD OCCURRENCES = OFF
BOM UPDATE PRE DELETE ATTR = RDN Letter
BOM UPDATE PRE DELETE VALUE = *
BOM UPDATE DELETE FIELD = RDN Letter
BOM UPDATE DELETE VALUE =X
Data File
-------------------------------
!~ParentID~ChildID~SeqNo~Qty~ON:RDN Letter
Assembly123~Child1~1~2~C
Assembly123~Child2~2~20~R
Assembly123~Child3~3~5~C
Assembly123~Child4~4~0~X
Assembly123~Child5~5~0~X
19.5 Delete ALL occurrences

Delete ALL occurrences in Assembly123…
Config File
-------------------------------
BOM UPDATE ADD OCCURRENCES = OFF
BOM UPDATE PRE DELETE ATTR = ChildID
BOM UPDATE PRE DELETE VALUE = *
Data File
-------------------------------
!~ParentID~ChildID

Assembly123~*
19.6 Set InContext AbsOccID

Set InContext AbsOccID in Parent Assembly XSUPERCAR...
Config File
-------------------------------
UPDATE BOMS = ON
CREATE BOMS = ON
BOM UPDATE ID FIELDS = ChildID,AbsOccID,SeqNo
BOM REV RULE = RR Latest Agreed Scenery
Data File
-------------------------------!
~ParentID~ParentRev~ChildID~ChildRev~SeqNo~AbsOccID~ContextItemID~ContextItem
RevID~ContextAbsOccID~ContextParentAbsOccID
XSUPERCAR~A~XCAR99~A~10~Vectra~~~~
XCAR99~A~XAXLE99~A~10~RearAxle~XSUPERCAR~A~Vectra-RearAxle~Vectra
XAXLE99~A~XWHEEL~A~10~LeftWheel~XSUPERCAR~A~Vectra-RearAxle-
LeftWheel~Vectra-RearAxle
XWHEEL~A~XWHEELNUT~A~10~nut1~XSUPERCAR~A~Vectra-
RearAxle-LeftWheel-nut1~Vectra-RearAxle-LeftWheel
XAXLE99~A~XWHEEL~A~20~RightWheel~XSUPERCAR~A~Vectra-
RearAxle-RightWheel~Vectra-RearAxle
RearAxle-RightWheel-nut1~Vectra-RearAxle-RightWheel
XCAR99~A~XAXLE99~A~20~FrontAxle~XSUPERCAR~A~Vectra-
FrontAxle~Vectra

XAXLE99~A~XWHEEL~A~10~LeftWheel~XSUPERCAR~A~Vectra-
FrontAxle-LeftWheel~Vectra-FrontAxle
FrontAxle-LeftWheel-nut1~Vectra-FrontAxle-LeftWheel
XAXLE99~A~XWHEEL~A~20~RightWheel~XSUPERCAR~A~Vectra-
FrontAxle-RightWheel~Vectra-FrontAxle
FrontAxle-RightWheel-nut1~Vectra-FrontAxle-RightWheel

19.7 Set InContext AbsOccID in Parent Assembly only on low level

components
To set InContext AbsOccID in Parent Assembly only on low level
components!... (This assumes the above XSUPERCAR structure exists
with NO AbsOccIDs set.)
Config File
-------------------------------
UPDATE BOMS = ON
CREATE BOMS = ON
BOM UPDATE ID FIELDS = ChildID,AbsOccID
Data File
-------------------------------!
~ParentID~ParentRev~ChildID~ChildRev~SeqNo~AbsOccID~ContextItemID~ContextItem
RevID~ContextAbsOccID
XWHEEL~A~XWHEELNUT~A~10~nut1~XSUPERCAR~A~Vectra-RearAxle-LeftWheel-nut1
XWHEEL~A~XWHEELNUT~A~10~nut1~XSUPERCAR~A~Vectra-RearAxle-RightWheel-nut1
XWHEEL~A~XWHEELNUT~A~10~nut1~XSUPERCAR~A~Vectra-FrontAxle-LeftWheel-nut1
XWHEEL~A~XWHEELNUT~A~10~nut1~XSUPERCAR~A~Vectra-FrontAxle-RightWheel-nut1

19.8 Engineering change example

To Create an Engineering Change Item/Rev, create/attach the form
type, copy the BOM child ItemRev to the problem_items pseudo folder,
set Unit/EndItem effectivity when releasing the EC ItemRevision and
then to create/initiate a workflow process with the EC ItemRevision
as the target of the job.
**NOTE: rerun ips_data_upload in forms mode to populate any of the

created forms.
Config File
--------------------------------
UPDATE BOMS = ON
CREATE BOMS = ON
BOM UPDATE ID FIELDS = ChildID
BOM REV RULE = Latest Working
CREATE ITEMS = ON
CREATE REVS = ON
UPDATE ITEMS = ON
UPDATE REVS = ON
SET BYPASS = ON
CREATE DATASET = OFF
UPDATE DATASET = OFF
REV RELEASE RELATIONS = IMAN_specification,BOMVIEW
CREATE STATUS = ON
UPDATE STATUS = LAST
CREATE EC ITEMS = ON
UPDATE EC ITEMS = ON
CREATE EC REVS = ON
UPDATE EC REVS = ON
EC TYPE = WA
ADD CHILD TO EC FOLDER = problem_items
SET EC IN BOM IC CONTEXT = ON
EC FORMS LIST TO ADD = Checklist Template Form
EC PROCESS AUTO INIT = ON
EC PROCESS TEMPLATE = CMII WA
EC PROCESS DESC = MES PROCESS NON-CONFORMANCE

Data File
-------------------------------
!
~ParentID~ParentRev~ChildID~ChildRev~ECID~ECRev~ECName~ECDesc~ECType~Stat
us~EffEndItem~UnitStart~UnitEnd
IC_PROC1~A~IC_OP10~A~WA98765443~A~~This is a test~WA~Released~IC_PROC1
~1234~1234

19.9 Legacy Variants

Here are some customer sample files used for testing legacy variants. Each files contains
several example separated by the line marker END-OF-FILE which terminates processing.
So each test would be done by moving the data lines and line marker to the top of the file.
19.9.1 Config File

DATE FORMAT = %m/%d/%y %H:%M
CREATE BOMS = ON
UPDATE BOMS = ON
CREATE ITEMS = OFF

CREATE REVS = OFF
UPDATE ITEMS = ON
UPDATE REVS = ON

BOM UPDATE ADD OCCURRENCES = ON
FOLDER NAME = GM Load

VIEW TYPE = view
MULTI VALUE SEPARATOR STRING = ,
CREATE LEGACY VARIANT OPTION = ON

UPDATE LEGACY VARIANT OPTION = ON
CREATE LEGACY VRULE = ON

UPDATE LEGACY VRULE = ON
UPDATE LEGACY VRULE OPTION = REPLACE
RELATION NAME = IMAN_specification

SET BYPASS = ON
USE ITEMS WITH DIFF CASE = ON
BOM REV RULE = Any Status; Working

USE PARENT STATUS = OFF

SET OWNER BY PARENT = OFF
19.9.2 Data File 1

!~ItemID~ChildID~LVarRuleName~LVarRuleDesc~LVarRuleOptSet~VRULE:owning_group
IQN-0~~IPSTestRule1~[IQN-0]I = SIN~[IQN-0]I = SIN & IQN-0; COMPL; =; S & [IQN-0]POTEN =
70~Engineering
#IQN-0~~IPSTestRule1~[IQN-0]POTEN = 12~[IQN-0]POTEN = 12~Engineering
END-OF-FILE
!
~ItemID~Name~ChildID~LVarOptName~LVarOptVal~LVarOptCondition~LVarOptAction~LVarOptDefV
al~LVarOptSetIfVal~LVarOptSetIfCond
IQN-0~IQN~~POTEN~10,12,15,25,70,80,SIN,xxxxxxxx~ ~~15~SIN~[IQN-0]I = SIN
END-OF-FILE
!~ItemID~Name~ChildID~LVarOptName~LVarOptVal~LVarOptCondition~LVarOptAction
IQN-0~IQN~~*~~ ~delete
END-OF-FILE
IQN-0~IQN~~COMPL~N,S~ ~
IQN-0~IQN~~MARCA~I,xxxxxxxx~ ~
IQN-0~IQN~~COLO1~NEGRT,xxxxxxxx~ ~
IQN-0~IQN~~COLO2~NEGRT,xxxxxxxx~ ~
IQN-0~IQN~~CLASE~I,xxxxxxxx~ ~
IQN-0~IQN~~PLAMP~E27,E40,xxxxxxxx~ ~
IQN-0~IQN~~O~1,xxxxxxxx~ ~
IQN-0~IQN~~C~P1,VL,xxxxxxxx~ ~
IQN-0~IQN~~E~SIN,xxxxxxxx~ ~
IQN-0~IQN~~R~SIN,xxxxxxxx~ ~
IQN-0~IQN~~F~SIN,xxxxxxxx~ ~
IQN-0~IQN~~I~CON,SIN,SINC,xxxxxxxx~ ~
IQN-0~IQN~~LAMPA~H,M,S,SIN,xxxxxxxx~ ~
IQN-0~IQN~~POTEN~10,12,15,25,70,80,SIN,xxxxxxxx~ ~
IQN-0~IQN~~TENSI~220,230,240,SIN,xxxxxxxx~ ~
IQN-0~IQN~~FRECU~50,60,SIN,xxxxxxxx~ ~

IQN-0~IQN~~ARRAN~TR,IDL,IDM,IDT,IDY,SIN,xxxxxxxx~ ~
IQN-0~IQN~~DONIV~LM,TP,SIN,xxxxxxxx~ ~
IQN-0~IQN~~REACT~ELT,ETI,LAY,SIN,xxxxxxxx~ ~
IQN-0~IQN~~FOTOC~SIN,xxxxxxxx~ ~
IQN-0~IQN~~MCONT~SIN,xxxxxxxx~ ~
IQN-0~IQN~~CEMER~SIN,xxxxxxxx~ ~
IQN-0~IQN~~PFUSI~SIN,xxxxxxxx~ ~
IQN-0~IQN~~EMBAL~ST~ ~delete
IQN-0~IQN~~EMBAL~ST~ ~
IQN-0~IQN~13-00532-30x~TORNILLO DIN-7985A M5x10 IN H~~IQN-0; COMPL; ==; S & IQN-0; I;
==; CON|SINC~
IQN-0~IQN~13-02106-30x~ARANDELA DIN-6798-A p. M 6 IN~~(IQN-0; COMPL; ==; S & IQN-0; C;
==; VL & IQN-0; I; ==; CON|SINC) | [IQN-0]POTEN = 10|12|15~
IQN-0~IQN~52-62003-04~MARCO P/VIDRIO IQN-250 NEGRT ~~
IQN-0~IQN~13-00535-30~TORNILLO DIN-7985A M5x20 IN H~~IQN-0; C; ==; P1|VL~
IQN-0~IQN~13-00905-01~ARANDELA VISTOP M 5 BI~~IQN-0; C; ==; P1|VL~
IQN-0~IQN~52-62000-02~REFLECTOR DE.ASIM. IQN-150 ~~IQN-0; COMPL; ==; S~
IQN-0~IQN~13-00581-02~TORNILLO DIN-7500C M 5x 8 CI P~~IQN-0; COMPL; ==; S & IQN-0; C; ==;
VL~
END-OF-FILE
IQN-0~IQN~~Tim1~A,B,C~ ~delete
IQN-0~IQN~~Tim3~A,B,D~ ~
END-OF-FILE
19.9.3 Data File 2

!
~ItemID~ParentRev~ChildID~ChildRev~Ignore:ItemType~BL:bl_occurrence_name~LVarOptName~LVar
OptDesc~LVarOptVal~LVarOptCondition~BL:bl_occ_xform_matrix~BL:bl_quantity
#AHD54302~001~~~~~Load_Mainstream~Load_Mainstream GM Legacy Option.~Y,N~~~~~~~~~
#AHD54302~001~~~~~Tim_test~Tim_test GM Legacy Option.~Y,N~~~~~~~~~
AHD54302~001~AHD53108~001~CORP_Proc_Plan~MAINSTREAM MODULE~~~~AHD54302;
Load_Mainstream; ==; Y & [AHD54302]Tim_test = Y~1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1~
AHD53175~186~~~~~M_LTL_C~M_LTL_C GM Legacy Option.~Y,N~~~~~~~~~
AHD53175~186~~~~~M_LTL_K~M_LTL_K GM Legacy Option.~Y,N~~~~~~~~~
AHD53175~186~~~~~M_LGW_1~M_LGW_1 GM Legacy Option.~Y,N~~~~~~~~~


AHD53175~186~~~~~M_LCW_05~M_LCW_05 GM Legacy Option.~Y,N~~~~~~~~~
AHD53175~186~~~~~M_LBS_03~M_LBS_03 GM Legacy Option.~Y,N~~~~~~~~~
AHD53175~186~ANA47803~006~CORP_Install~IA-RR LP WRG HARN JUNC-1-MM~~~~(AHD53175;

M_LTL_C; ==; Y | AHD53175; M_LTL_K; ==; Y) & (AHD53175; M_LGW_1; ==; Y | AHD53175;
M_LGW_2; ==; Y | AHD53175; M_LGW_3; ==; Y | AHD53175; M_LGW_4; ==; Y) & (AHD53175;
M_LCW_05; ==; Y | AHD53175; M_LCW_07; ==; Y | AHD53175; M_LCW_09; ==; Y | AHD53175;
M_LCW_10; ==; Y | AHD53175; M_LCW_14; ==; Y) & (AHD53175; M_LBS_03; ==; Y | AHD53175;
M_LBS_43; ==; Y | AHD53175; M_LBS_53; ==; Y)~1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1~
AHD53175~186~ANA47803~006~CORP_Install~IA-RR LP WRG HARN JUNC-1-MM~~~~((AHD53175;

M_LGW_2; ==; Y | AHD53175; M_LGW_3; ==; Y | AHD53175; M_LGW_4; ==; Y)) & ((AHD53175;
M_LCW_05; ==; Y | AHD53175; M_LCW_07; ==; Y | AHD53175; M_LCW_09; ==; Y | AHD53175;
M_LCW_10; ==; Y | AHD53175; M_LCW_14; ==; Y) & (AHD53175; M_LBS_03; ==; Y | AHD53175;
M_LBS_43; ==; Y | AHD53175; M_LBS_53; ==; Y))~1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1~
AHD53175~186~ANA47803~006~CORP_Install~IA-RR LP WRG HARN JUNC-1-MM~~~~((AHD53175;

M_LGW_2; ==; Y)) & (AHD53175; M_LCW_05; ==; Y | AHD53175; M_LCW_07; ==; Y | AHD53175;
M_LCW_09; ==; Y | AHD53175; M_LCW_10; ==; Y)~1 0 0 0 0 1 0 0 0 0 1 0 0 0 0
1~~0~~~vzs8yy~delp.c-e.suplr~3/25/2009 12:30
#-------------------------
END-OF-FILE
#-------------------------
!~ItemID~ParentRev~ChildID~ChildRev~BL:bl_variant_condition
AHD54302~001~AHD53108~001~[AHD54302]Load_Mainstream = Y AND [AHD54302]Tim_test = Y
#-------------------------
END-OF-FILE
#-------------------------
!~ItemID~ChildID~ItemType~BL:bl_occurrence_name~LVarOptCondition
AHD54302~AHD53108~CORP_Proc_Plan~MAINSTREAM MODULE~AHD54302; Load_Mainstream;
==; Y

#-------------------------
END-OF-FILE
#-------------------------
19.9.4 Data File 3: Miscellaneous

# -------------------------------------------
# Legacy variants
# -------------------------------------------
!
~ItemID~ChildID~Qty~SeqNo~ON:Test~Uom~RM:project_id~MVarOptName~MVarOptDesc~MVarOpt
Vis~MVarOptValType~MVarOptVal~MVarOptDefVal~MVarOptCondition~LVarOptName~LVarOptDesc
~LVarOptVal~LVarOptCondition~MVarOptAction~LVarOptAction~LVarOptValAction
# Delete Option...
New_Assy2~~1~10~Test Note 1~mm~Project test~~~~~~~~L Option 2~Legacy option
2~val1,val2,val3~~~delete
# Legacy option
#New_Assy2~~1~10~Test Note 1~mm~Project test~~~~~~~~L Option 2~Legacy option 2~val1,val2,val3
New_Assy1XX~~1~10~Test Note 1~mm~Project test~~~~~~~~L Option 1~Legacy option

1~val5,val6,val7~~~~replace
New_Assy1XX~~1~10~Test Note 1~mm~Project test~~~~~~~~POTEN~Spanish option
1~10,12,15,25,70,80,SIN
New_Assy1XX~~1~10~Test Note 1~mm~Project test~~~~~~~~POTEN~Spanish option 1~70~~~~delete
#New_Assy1XX~Sub_assy2~1~10~Test Note 1~mm~Project test~~~~~~~~~~~IQN-0; COMPL; ==; S &

IQN-0; I; ==; CON|SINC
New_Assy1XX~Sub_assy2~1~10~Test Note 1~mm~Project test~~~~~~~~~~~New_Assy1XX; L Option 1;
==; val1 & New_Assy1XX; POTEN; ==; 10|80
#New_Assy1XX~Child1~1~10~Test Note 1~mm~Project test~~~~~~~~~~~New_Assy2; L Option 2; ==;
val2
END-OF-FILE
# Delete Option...
#New_Assy1~~1~10~Test Note 1~mm~Project test~OPTION7~~~~~~~~~~~delete

New_Assy1~~1~10~Test Note 1~mm~Project test~*~~~~~~~~~~~delete
# public OPTION1 string "A multi list STRING option" = "Value 1", "Value 2", "Value 3" default "Value
1"
New_Assy1~~1~10~Test Note 1~mm~Project test~Option 1~A New STRING
option~public~STRING~"Value1", "Value2", "Value3"~Value3
# public 'OPTION WITH SPACE' real "A real range" = >=10.5, <=19.5
New_Assy1~~1~10~Test Note 1~mm~Project test~Option 2~OPTION WITH SPACE~public~real~>=10.5,
<=19.5
# public OPTION7 integer "Integer with range" = 1 to 100, 201 to 300 default 1
New_Assy1~~1~10~Test Note 1~mm~Project test~OPTION7~Integer with range~public~integer~1 to 100,
201 to 300~1
New_Assy1~~1~10~Test Note 1~mm~Project test~OPTION S2~Free Integer~public~integer~~0
New_Assy1~Sub_assy1~1~10~Test Note 1~mm~Project test
New_Assy1~Child1~1~10~Test Note 1~mm~Project test~~~~~~~New_Assy1:'Option 1' = "Value2" or

New_Assy1:'Option 1' = "Value3"
New_Assy1~Sub_assy2~1~10~Test Note 1~mm~Project test
# public OPTIONX logical "A new logical" default true

Sub_assy1~~1~10~Test Note 1~mm~Project test~OPTIONX~A new logical~public~logical~~true
Sub_assy1~~1~10~Test Note 1~mm~Project test~Option 1~A New STRING
option~public~STRING~"Value1", "Value2", "Value3"~Value3
#Sub_assy1~Child1~1~10~Test Note 1~mm~Project test~~~~~~~New_Assy1:'Option 1' = "Value2" and
Sub_assy1:'OPTIONX' = true~~~~~
Sub_assy1~Child1~1~10~Test Note 1~mm~Project test~~~~~~~Sub_assy1:'Option 1' = "Value1" and
Sub_assy1:'OPTIONX' = true~~~~~
19.9.5 Date File 4: Set If and Error If

# Set only Set If Val and condition
!~ItemID~ParentRev~ChildID~ChildRev~LVarOptName~LVarOptSetIfVal~LVarOptSetIfCond
AHD54302~001~~~[AHD54301]OPT1~value1-2~[AHD54301]OPT2 = value2-2

#-------------------------
END-OF-FILE
#-------------------------
# Set only Error If msg and condition
!~ItemID~ParentRev~ChildID~ChildRev~LVarOptName~LVarOptDesc~LVarOptVal~Ignore:LVarOptDefVal~LVarOptErrorIf
AHD54302~001~~~[AHD54301]OPT1~~~value1-1~OPT 2 value value2-2 NOT ALLOWED~[AHD54301]OPT2 = value2-2
#-------------------------
END-OF-FILE
#-------------------------
19.10 Modula Variants

Here are some customer sample files used for testing modular variants. Each files
contains several example separated by the line marker END-OF-FILE which terminates
processing. So each test would be done by moving the data lines and line marker to the top
of the file.
19.10.1 Config File

DATE FORMAT = %m/%d/%y %H:%M
CREATE BOMS = ON
UPDATE BOMS = ON
CREATE ITEMS = OFF

CREATE REVS = OFF
UPDATE ITEMS = ON
UPDATE REVS = ON

BOM UPDATE ADD OCCURRENCES = ON
FOLDER NAME = GM Load

VIEW TYPE = view

MULTI VALUE SEPARATOR STRING = ,
CREATE MODULAR VARIANT OPTION = ON

UPDATE MODULAR VARIANT OPTION = ON
RELATION NAME = IMAN_specification

SET BYPASS = ON
USE ITEMS WITH DIFF CASE = ON
BOM REV RULE = Any Status; Working
USE PARENT STATUS = OFF

SET OWNER BY PARENT = OFF
19.10.2 Data File 1: Simple

!
~ItemID~ParentRev~ChildID~ChildRev~MVarOptName~MVarOptDesc~MVarOptVis~MVarOptValType
~MVarOptCondition
BG00000020~A~BG00000006~@@~~~~~BG00000020:MyOption006 = true
19.10.3 Data File 2

20. APPENDIX D: FORMS MODULE EXAMPLES
To create a "Company" form setting the form attributes

"_elm_company_01" and “_elm_company_02". In this example the
configuration options have all been commented out in the config
file and added to the top of the date file.
Config File
-------------------------------
#MODE = create_forms
#FORM RELATION = Reference
#FORM TYPE = Company
#FORM PARENT TYPE = ITEM
Data File
-------------------------------
CREATE FORMS = ON
UPDATE FORMS = ON
FORM TYPE = Company
RELATION PARENT TYPE = ITEM
RELATION NAME = Reference
!~ItemID~RevID~Name~Desc~F:_elm_company_01~F:_elm_company_02
TestAssy~A~Comp FormA~Company Form~Services~Casing

Create or update items and revisions setting Project ID on the

revision master form in forms mode to create a "Custom Form" form in
a Specification relation, setting attributes "cust_attr_1" and
"cust_attr_2".
If the revision already exists and so does the Custom Form then the
Custom Form and the revision master form will be updated. Otherwise
the revision and the Custom Form will be created.
Put any new items into the folder "New items".
Config File
-------------------------------
CREATE ITEMS = ON
UPDATE ITEMS = ON
CREATE REVISIONS = ON
UPDATE REVISIONS = ON
CREATE FORMS = ON
UPDATE FORMS = ON
FORM TYPE = Custom Form
RELATION NAME = Spec
FOLDER NAME = New items
DEFAULT REV =A
Data File
-------------------------------
ITEM TYPE = Item
!~ItemID~RevID~RM:project_id~F:cust_attr_1~F:cust_attr_2
BomAssy1~A~Project X~Value 1~Value 2
BomChild1~A~Project X~Value 1~Value 2

21. APPENDIX E: LOV MODULE EXAMPLES
To populate an LOV with string values.
Config File
-------------------------------
LOV NAME = TEST_LOV
LOV TYPE = STRING
Data File
-------------------------------
!~LovName~LovType~LovVal
TEST_LOV~STRING~Value 2

22. APPENDIX F: RELATIONS MODULE EXAMPLES
To attach a child dataset to the parent Revision in the defined

relation. The first child will be attached in a relation of Des,
the second child line will move the existing child from a
Requirements relation to a Specification relation (due to NEW
RELATION NAME config option) and the third child will move from a
reference relation to a Specification.
Config File
-------------------------------
RELATION NAME = Ref
RELATION PARENT TYPE = REV
NEW RELATION NAME = Spec
Data File
-------------------------------
!~ItemID~ParentRev~DsetName~DsetType~RelationName~NewRelation
Engine7~A~Engine7/A~UGMASTER~~des
Engine7~O~Engine7/O~UGPART~Req~
Engine7~Q~Engine7/Q~Text~Ref~Spec
To attach a child Item to a Parent Item Revision using the specified

relation.
Config File
-------------------------------
RELATION NAME = Ref
#NEW RELATION NAME = Spec
Data File
-------------------------------
!~ItemID~ParentRev~ChildID~RelationName
000002~A~000003~Spec
000002~A~000003~ref
000002~A~000003~req

To attach an existing child Form to a Parent Item Revision using the

specified relation.
Config File
-------------------------------
RELATION NAME = Ref
NEW RELATION NAME = Spec
Data File
-------------------------------
!~ItemID~ParentRev~FormName~RelationName
tim-00002~tim-00001-txt~Req
22.1 Other 8.0.0 examples

#----------------------------------------------
#----------------------------------------------
RELATION PARENT RELATION = IMAN_specification

RELATION CHILD RELATION = IMAN_reference
# Hdr for cut...

CUT RELATIONS = ON
!~ItemID~RevID~ParentName~ParentType~Ignore:ChildID~Ignore:ChildRev~FormName~FormType~RelationName
# Hdr for paste...

#!~ItemID~RevID~ParentName~ParentType~ChildID~ChildRev~FormName~FormType~RelationName
tim-98765~A~Text-tim-98765-1-txt~Text~tim-98765~A~A GeneralDesignElement form~GeneralDesignElement~IMAN_Rendering
#===================================================================
END-OF-FILE
#===================================================================
#-------------------------
# Item to Item
#-------------------------

RELATION CHILD TYPE = ITEM
UPDATE LATEST REV = OFF

!~ItemID~ChildID~RelationName
tim-98765~tim-34567~IMAN_reference
#-------------------------
# Item to Rev
#-------------------------

RELATION CHILD TYPE = ITEM
#-------------------------
# Rev to Item
#-------------------------

RELATION CHILD TYPE = REV
#-------------------------
# Rev to Rev
#-------------------------

RELATION CHILD TYPE = REV
!~ItemID~ChildID~ChildRev~RelationName
tim-98765~tim-34567~A~IMAN_reference
#-------------------------------------
# Cut dataset from dataset in rev
#-------------------------------------
CUT RELATIONS = ON
!~ItemID~RevID~ParentName~ParentType~DsetName~DsetType~RelationName
tim-98765~A~Text-tim-98765-1-txt~Text~Text-tim-98765-1-cfg~Text~IMAN_Rendering

#----------------------------------------------
#----------------------------------------------
!~ItemID~RevID~ParentName~ParentType~ChildID~ChildRev~DsetName~DsetType~RelationName
tim-98765~A~Text-tim-98765-1-txt~Text~tim-98765~A~Text-tim-98765-1-cfg~Text~IMAN_Rendering
#-------------------------
# CC and SC into Rev
#-------------------------
!~ItemID~ParentRev~CCName~CCType~SCName~SCType
tim-98765~A~CC_test_publish_link~CCObject~~
tim-98765~A~CC_test_publish_link~CCObject~source_bom~StructureContext
#----------------------------------------------
# Dataset(s) to Rev
#----------------------------------------------
!~ItemID~ParentRev~DsetName~DsetType
tim-98765~A~Text-tim-98765-1~Text~
tim-98765~A~tim-98765~Text~
#----------------------------------------------
# Dataset(s) to Dataset(1)
#----------------------------------------------

#RELATION MULTI PARENT OPTION = ALL
#RELATION MULTI CHILD OPTION = FIRST

!~ParentName~ParentType~DsetName~DsetType~RelationName
Text-tim-98765-1~Text~Text-tim-98765-1-cfg~Text~IMAN_Rendering
#----------------------------------------------
# WSOM(s) to WSOM(1)
#----------------------------------------------


!~ParentName~ParentType~ChildName~ChildType~RelationName
#Text-tim-98765-1~Text~Text-tim-98765-1-cfg~Text~IMAN_Rendering
#Text-tim-98765-1~Text~A GeneralDesignElement form~GeneralDesignElement~IMAN_Rendering
Text-tim-98765-1~Text~Home~Folder~IMAN_Rendering
#----------------------------------------------
# WSOM(s) to Rev
#----------------------------------------------

UPDATE LATEST REV = OFF


!~ItemID~RevID~ChildName~ChildType~RelationName
tim-98765~~Text-tim-98765-1-cfg~Text~IMAN_reference
tim-98765~A~A GeneralDesignElement form~GeneralDesignElement~IMAN_reference
tim-98765~A~Home~Folder~IMAN_reference
#----------------------------------------------
# Form(s) to Rev
#----------------------------------------------
!~ItemID~ParentRev~FormName~FormType
tim-98765~A~A GeneralDesignElement form~GeneralDesignElement
#----------------------------------------------
# Form(s) to Rev, move to IMAN_ref
#----------------------------------------------
FORM TYPE = GeneralDesignElement
!~ItemID~ParentRev~FormName~Ignore:FormType~NewRelation
tim-98765~A~A GeneralDesignElement form~GeneralDesignElement~IMAN_reference

#----------------------------------------------
# WSOM(s) to Folder
#----------------------------------------------
#RELATION MULTI PARENT OPTION = FIRST

RELATION MULTI PARENT OPTION = ALL

!~ParentName~ParentType~ChildName~ChildType~RelationName
TEST UPLOAD FOLDER~Folder~Text-tim-98765-1-cfg~Text~IMAN_reference

23. APPENDIX G: DATASETS MODULE EXAMPLES
The following configuration file is used in all examples shown in

this section.
Config File
-------------------------------
#============================================
# General options
#============================================
FOLDER NAME = IMPORT_FILES
DEFAULT REV =A
PUT FAILS IN NEWSTUFF = ON
SET BYPASS = ON
DEFAULT OWNER = williamt
DEFAULT GROUP = designer
CREATE ITEMS = ON
UPDATE ITEMS = ON
CREATE REVS = ON
UPDATE REVS = ON
#============================================
# Dataset specific options
#============================================
DATASET TYPE = Text
CREATE DATASET = ON
UPDATE DATASET = ON
#SET OWNER BY PARENT = OFF
#============================================
# Dataset File Reference Options
#============================================
FILE REF NAME = Text
#UPDATE FILE REF NAME = ADD REF
#UPDATE FILE REF NAME = NEW REF
UPDATE FILE REF NAME = REPLACE REF
#UPDATE FILE REF NAME = NEW VERSION
#FILE REF REPLACE OPTION = ALL REFS

FILE REF REPLACE OPTION = MATCH FILE NAME

#============================================
# Dataset Form Reference options
#============================================
FORM TYPE = ECRForm
UPDATE FORMS = ON
FORM REF NAME = Form
#UPDATE FORM REF NAME = ADD REF
#UPDATE FORM REF NAME = NEW REF
UPDATE FORM REF NAME = REPLACE REF
#UPDATE FORM REF NAME = NEW VERSION
#FORM REF REPLACE OPTION = MATCH FORM TYPE
FORM REF REPLACE OPTION = ALL REFS
#============================================
# Relation details for attaching new datasets
#============================================
RELATION NAME = REF
Example 1: Create Item, dataset and import file
Data File
-------------------------------
!
~ItemID~RevID~Name~Desc~RM:project_id~DsetName~FileRef~File~DsetDesc~Relation
Name
tim-00001~2~DS Test~Dataset Test~DS Testing~tim-00001-cfg~Text~file2_tim.cfg~A Text
DS with cfg ref~Req
tim-00001~2~DS Test~Dataset Test~DS Testing~tim-00001-txt~Text~file1_tim.txt~A Text
DS with txt ref
tim-00001~2~DS Test~Dataset Test~DS Testing~tim-00001-txt~Text~file2_tim.txt

Example 2: Create Item, dataset and import form and set group
ownership.
Data File
-------------------------------
!
~ItemID~RevID~Name~Desc~RM:project_id~DsetName~DsetType~FormRef~FormType~
F:project_id~F:series_desc~FormDesc~Group
tim-00002~A~DS Test with Form~Dataset Test with Form~DS Testing~tim-00001-
txt~FormTest~Form~Item Master~DS Form Testing1~~~
tim-00002~~DS Test with Form~Dataset Test with Form~DS Testing~tim-00001-
txt~FormTest~Form~CMSForm~DS Form Testing7~DS Form Testing1~DS Form
Testing2~designer
Example 3: Create Item, dataset and set properties with standard

system input fields (as described in Items mode).
Data File
-------------------------------
!
~ItemID~Name~Desc~RM:project_id~DsetName~FileRef~File~CrtDate~ModDate~ModBy~
Owner~Group
tim-00001~DS Test~Dataset Test~DS Testing~tim-00001-txt~Text~file1_tim.txt~01-Aug-
1999 00:00~02-Aug-1999~williamt~williamt~designer
tim-00001~DS Test~Dataset Test~DS Testing~tim-00001-cfg~Text~file2_tim.cfg

To create/find a dataset and Perform a Checkin on the dataset itself

whilst not affecting other objects.
Config File
-------------------------------
CREATE ITEMS = ON
UPDATE ITEMS = OFF
CREATE REVS = ON
UPDATE REVS = ON
CREATE DATASET = ON
UPDATE DATASET = ON

CREATE CICO = OFF
UPDATE CICO = CHECK IN
CICO OBJECTS FILTER = Text
Data File
-------------------------------
!~ItemID~RevID~DsetName~DsetType
GUY98765~A~GUYTXT_0001~Text

24. APPENDIX H: FOLDERS MODULE EXAMPLES
Creating folders.
Config File
-------------------------------
TOP FOLDER = MasterUploadFolder
SET BYPASS = OFF
FOLDER SEPARATOR =.
TOP FOLDER DESCRIPTION = This is the top folder
DEFAULT FOLDER DESCRIPTION = This is an upload folder
PUT FAILS IN NEWSTUFF = ON
GLOBAL FOLDER SEARCH = ON
Data File
-------------------------------
FOLDER SEPARATOR = /
!~ItemID~Folder~FolderDesc
200001~TestFolder/SubFolder/SubFolder2~This is SubFolder2
200002~TestFolder3/SubFolder/SubFolder2~This is SubFolder2
200003~TestFolder4~This is TestFolder4
#000003~TestFolder/SubFolder/SubFolder3~This is SubFolder3
#000004~TestFolder/SubFolderX/SubFolder3~This is SubFolder3
#000005~TestFolder2/SubFolderY/SubFolder3~This is SubFolder3 in TestFolder2

25. APPENDIX I: PROJECTS MODULE EXAMPLES
Creating/Updating and Assigning Projects.
Config File
-------------------------------
CREATE PROJECTS = ON
UPDATE PROJECTS = ON
#PROJECT ASSIGN TO TYPE = ITEM
PROJECT ASSIGN TO TYPE = REV
# This option can be used to assign the latest revision when only
# supplying the item ID.
# Use the following update options to assign to items or revisions

# if not using the projects mode. If using the "projects" mode
# then these are not required for the assign to work.
UPDATE ITEMS = ON
UPDATE REVS = ON
Data File
-------------------------------
!
~ProjID~ProjName~ProjDesc~ProjMemberUser~ProjMemberGroup~ProjMemberRole~Proj
AdminUser~ProjPrivUser~ItemID
#PR-67890~PR-67890~Upload test project 67890~tim~Engineering~Designer~tim~tim
#PR-34567~~Upload test project 34567~tim~Engineering~Designer~tim~tim~000001
PR-34567~~Upload test project 34567~tim~Project Administration~Project
Administrator~tim~tim~000001
PR-12677~~Upload test project 12677~tim~Engineering~Designer~tim~tim~000001
PR-12677~~~~~~~~000002

26. APPENDIX J: CLASSIFICATION MODULE EXAMPLES
The following configuration file is used in all examples shown in

this section.
Config File
-------------------------------
# Item and revision options...
#CREATE ITEMS = ON
#UPDATE ITEMS = ON
#CREATE REVS = ON
#UPDATE REVS = ON
# Classification options...
#INCLASS CREATE ICO = OFF
INCLASS UPDATE ICO = OFF
#INCLASS UPDATE ICO OPTION = SINGLE ICO ONLY
#INCLASS UPDATE ICO OPTION = FIRST ICO
INCLASS UPDATE ICO OPTION = ALL ICOS
#INCLASS DEFAULT CLASS ID = 1000
INCLASS ICO CLASSIFY OBJECT = ITEM

#INCLASS ICO CLASSIFY OBJECT = REV
INCLASS ALLOW MULTIPLE CLASSIFICATION = ON

# Class attributes, for reference
# Attr 1000 = Material - String 32
# Attr 1001 = Material (LOV) - LOV
# Attr 1002 = Length - Real 4.2
# Attr 1003 = Diameter - Real 4.2

Example 1: Create an ICO, classifying an item and updating it’s

ItemRevision Master form at the same time.
Data File
-------------------------------
!
~IcoPUID~IcsClassID~IcoID~ItemID~IcsAttr:1000~IcsAttr:1001~IcsAttr:1002~Ignore:IcsAttr
:1003~RM:project_id
#ApNFL4wOVpZy6A~TEST-Bolts-Square~000001~000001~Some sort of
metal~AL~987.5~15.87~Project Inclass
~TEST-Bolts-Square~Ico000001~000005~Some sort of metal~STL~123.5~9.1~Project
Inclass
~TEST-Bolts-Square~~000005~Some sort of metal~STL~123.5~9.1~Project Inclass
~TEST-Bolts-Hex~~000005~Some sort of metal~STL~123.5~9.1~Project Inclass
#pNFL4wOVpZy6A~TEST-Bolts-Square~000001~000001~Some sort of
metal~AL~987.5~15.87~Project Inclass
#~UNCLASSIFY~000001~000001~Steel~Steel~10~Project Inclass
NOTE: The ICOPuid in lines 1 and 5 was extracted using a PLMXML export. The ICOPuid
allows specific ICOs to be updated. The last line was used to test unclassifying an Item.
Example 2: Creating an ICO and updating its attributes without an

Item.
Data File
-------------------------------
!~IcsClassID~IcoID~IcsAttr:1000~IcsAttr:1001~IcsAttr:1002
TEST-Bolts-Square~Ico000022~Some sort of metal~STL~1234.12
Example 3: How to delete a specific ICO give its PUID, which was
taken from a PLMXML export.
Data File
-------------------------------
!~IcoPUID~IcsClassID
AJBJZ03olhbFzC~DELETE
QFFJZwmvlhbFzC~DELETE

27. APPENDIX K: IDENTIFIERS MODULE EXAMPLES
To create an Identifier/Supplemental Identifier objects and then, on

the second line, revise the Supplemental Identifier object.
Config File
-------------------------------
CREATE ITEMS = OFF
UPDATE ITEMS = OFF
#UPDATE ITEM ATTACHMENTS = OFF
#UPDATE REV ATTACHMENTS = OFF
CREATE REVS = OFF
UPDATE REVS = OFF
SET BYPASS = ON
#UPDATE LATEST REV = ON
CREATE IDENTIFIERS = ON
UPDATE IDENTIFIERS = ON
CREATE IDFR REVS = ON
UPDATE IDFR REVS = ON
ALTERNATE ID CONTEXT = Supplier Part
Data File
-------------------------------
!
~ItemID~RevID~AlternateID~AlternateRevID~AltIDName~AltIDDesc~AltRevIDName~AltRe
vIDDesc~AltIDOwner~AltIDGroup
GUY987~A~BB6781~02~BB6781~A Test Altid part~PLATE 10x10~AltID revision
description~bursell~dba
GUY987~B~BB6781~03~BB6781~A Test Altid part~PLATE 10x10~AltID revision
description~bursell~dba

28. APPENDIX L: MANUFACTURING MODULE EXAMPLES
The following configuration file is used in the first eight examples

shown in this section.
Config File
-------------------------------
#MEProcess options
CREATE PROCESSES = ON
UPDATE PROCESSES = ON
CREATE PROCESS REVS = ON
UPDATE PROCESS REVS = ON
PROCESS TYPE = MEProcess
#MEOP options
CREATE OPERATIONS = ON
UPDATE OPERATIONS = ON
CREATE OPERATION REVS = ON
UPDATE OEPRATION REVS = ON
OPERATION TYPE = MEOP
#LINK OP TO PROCESS = OFF
LINK OP TO PROCESS = ON
#MEActivity options
CREATE ACTIVITIES = ON
UPDATE ACTIVITIES = ON
ACTIVITY TYPE = MEActivity
#MEActivity Form options
ACTIVITY FORM TYPE = RR_Activity Form
CREATE ACTIVITY FORMS = ON
UPDATE ACTIVITY FORMS = ON
#BOM module cfg options
UPDATE BOMS = ON
CREATE BOMS = ON
#ownership
DEFAULT OWNER = bursell
DEFAULT GROUP = Trent1700

Example 1: CREATE INDEPENDENT PROCESS
Data File
-------------------------------
ProcID~ProcRevID~ProcName~ProcType~ProcDesc
PROCESS1~A~MY PROCESS 1~MEProcess~My Process Description
Example 2: CREATE INDEPENDENT OPERATION
Data File
-------------------------------
OpID~OpRevID~OpName~OpType~OpDesc
OPN1~A~MY OPERATION 1~MEOP~My Operation Description
Example 3: CREATE/UPDATE OPERATION AND CREATE/UPDATE ACTIVITY ON

OPERATION
Data File
-------------------------------
OpID~OpRevID~ActName~ActDesc~ActType~ActTime
OPN2~A~ACT1~My Activity Description~MEActivity~43.2
Example 4: CREATE/UPDATE OPERATION AND CREATE/UPDATE ACTIVITY ON

OPERATION & CREATE/UPDATE ACTIVITY FORM + ATTRIBUTES
Data File
-------------------------------
OpID~OpRevID~ActName~ActDesc~ActType~ActTime~FormName~FormType~FormDesc
~F:rr_activity_detail_text~F:rr_activity_std_text
OPN2~A~ACT1~My Activity Description~MEActivity~43.2~ACT1FORM~RR_Activity
Form~My Form Description~the first attribute value~the,second,attr,array,values

Example 5: CREATE/UPDATE PROCESS+OPS and BUILD BOM (Process<--

Operation). This requires LINK OP TO PROCESS = ON configuration
option is set.
Data File
-------------------------------
ProcID~ProcRevID~OpID~OpRevID~SeqNo
PROCESS1~A~OPN1~A~10
PROCESS1~A~OPN2~A~20
Example 6: ADD MULTIPLE ACTIVITIES TO AN OPERATION
Data File
-------------------------------
OpID~OpRevID~ActName~ActDesc~ActType~ActTime~FormName~FormType~FormDesc
~F:rr_activity_detail_text~F:rr_activity_std_text
OPN2~A~ACT1~My Activity Description~MEActivity~43.2~ACT1FORM~RR_Activity
OPN2~A~ACT2~My Activity Description 2~MEActivity~5~ACT2FORM~RR_Activity
Example 7: ADD ADD ACTIVITY SEQUENCING (FLOWS)
Data File
-------------------------------
ProcID~ProcRevID~OpID~OpRevID~SeqNo~Predecessor~ActName~ActPreds
PROC1~A~OP1~A~10~ACT1~
PROC1~A~OP1~A~20~ACT2~ACT1
Example 8: ADD OPERATION SEQUENCING (FLOWS)
Data File
-------------------------------
ProcID~ProcRevID~OpID~OpRevID~SeqNo~Predecessor
PROC1~A~OP1~A~10~
PROC1~A~OP2~A~20~OP1

To consume occurrences from XSUPERCAR structure (See sample in BOMs

Mode) with InContext Absolute Occurrence data set. Create Process
structure in the same file.
Config File
-------------------------------
#MEProcess options
CREATE PROCESSES = ON
UPDATE PROCESSES = ON
CREATE PROCESS REVS = ON
UPDATE PROCESS REVS = ON
PROCESS TYPE = MEProcess
#MEOP options
CREATE OPERATIONS = ON
UPDATE OPERATIONS = ON
CREATE OPERATION REVS = ON
UPDATE OEPRATION REVS = ON
OPERATION TYPE = MEOP
LINK OP TO PROCESS = ON
#MEActivity options
CREATE ACTIVITIES = ON
UPDATE ACTIVITIES = ON
ACTIVITY TYPE = MEActivity
#MEActivity Form options
ACTIVITY FORM TYPE = RR_Activity Form
CREATE ACTIVITY FORMS = ON
UPDATE ACTIVITY FORMS = ON
#MEWorkArea options
CREATE WORKAREAS = ON
UPDATE WORKAREAS = ON
CREATE WORKAREA REVS = ON
UPDATE WORKAREA REVS = ON
WORKAREA TYPE = MEWorkarea
#BOM module cfg options (Mandatory)
UPDATE BOMS = ON
CREATE BOMS = ON
BOM UPDATE ID FIELDS = ChildID,AbsOccID


#Ownership
DEFAULT OWNER = bursell
DEFAULT GROUP = Trent1700
LINK PRODUCT TO PROCESS = ON
LINK PLANT TO PROCESS = ON
Data File
-------------------------------!
~ProcID~ProcRevID~ProcType~ProcName~ProcDesc~OpID~OpRevID~OpType~OpName
~OpDesc~SeqNo~Predecessor~ActName~ActType~ActTime~ActDesc~ActPreds~Product
TargetID~ProductTargetRevID~PlantTargetID~PlantTargetRevID~OccType~TargetChildID
~TargetChildRevID~TargetChildAbsOccID~TargetChildSeqNo~ProcChildID~~~
GPROC1~A~MEProcess~GPROC1-NAME~Process
Description~GOP1~A~MEOP~OP1~Op1 Description~10~~10~MEActivity~23.76~Activity
10~~~~~~~~~~~~~~
GPROC1~A~~~~GOP1~A~MEOP~OP1~Op1 Description~10~~20~MEActivity~99~Activity
20~10~~~~~~~~~~~~~
GPROC1~A~~~~GOP1~A~MEOP~OP1~Op1 Description~10~~30~MEActivity~10~Activity
30~20~~~~~~~~~~~~~
GPROC1~A~~~~GOP2~A~MEOP~OP2~Op2
Description~20~GOP1~~~~~~~~~~~~~~~~~~
Description~30~GOP2~~~~~~~~~~~~~~~~~~
Description~40~GOP3~~~~~~~~~~~~~~~~~~
GPROC1~A~~~~GOP4~A~MEOP~OP4~~40~~10~MEActivity~123.909~Activity
10~~~~~~~~~~~~~~
GPROC1~A~~~~GOP4~A~MEOP~OP4~~40~~20~MEActivity~14~Activity
20~10~~~~~~~~~~~~~
GPROC1~A~~~~~~~~~~~~~~~~XSUPERCAR~A~~~MEConsumed~XWHEEL~A~Vectra-
RearAxle-LeftWheel~~GOP1~~~
RearAxle-RightWheel~~GOP2~~~
FrontAxle-LeftWheel~~GOP3~~~
FrontAxle-RightWheel~~GOP4~~~
FrontAxle-RightWheel~~GOP4~~~
GPROC1~A~~~~~~~~~~~~~~~~~~STWORK1~A~MEWorkArea~STWORK0001~A~F1_
WorkArea1~~GOP1~~~
To Release an MEOP Revision, and also Status any MEActivities (any
other other attachments to Activity_Root/MEActivities).

Config File
-------------------------------
CREATE ITEMS = OFF
UPDATE ITEMS = OFF
CREATE REVS = OFF
UPDATE REVS= ON
REV RELEASE RELATIONS = SPECIFICATION,BOMVIEW,ACTIVITIES
UPDATE REVS ATTACHS STATUS = ON
UNRELEASE REVS = ON
CREATE STATUS = ON
#UPDATE STATUS = UNRELEASE
Data File
-------------------------------
!~ItemID~RevID~Status
GOP1~A~Released
TCG02000105315~A~Released
28.1 [7.0.0] CC / SC Example

Config File
-------------------------------
# Must set BOM FORMAT for mfg mode even though irrelevant for CC creation!
CREATE ITEMS = OFF

CREATE REVS = OFF
CREATE CC = ON
CREATE CC ALWAYS = ON
CREATE CC = ON
UPDATE CC = OFF
CREATE SC = ON
UPDATE SC = ON

CREATE CFG CONTEXT = ON

UPDATE CFG CONTEXT = ON
CREATE CC STRUCTURE = ON
UPDATE CC STRUCTURE = ON
CREATE SC STRUCTURE = ON
UPDATE SC STRUCTURE = ON
CC DEFAULT TYPE = MECollaborationContext

SC DEFAULT TYPE = MEProductContext
CFG CONTEXT DEFAULT TYPE = ConfigurationContext
LOG FILE FORMATS = CSV
FOLDER NAME = TEST UPLOAD FOLDER
Data File
-------------------------------
!
~CCName~NewCCName~CCType~CCDesc~CCOwner~CCGroup~CCStatus~CCCfgCont
ext~CCRevRule~CCSOSName~SCName~NewSCName~SCType~SCDesc~SCOwner~SC
Group~SCStatus~SCCfgContext~SCRevRule~SCSOSName~Ignore:CfgContextType~Item
ID~SCAttObjClass~SCAttObjType
CC_test_upl_2~~MECollaborationContext~Test CC 2~tim~dba~Released~CC1~Latest
Working~CC1_SOS1~SC~~~An SC~tim~dba~Released~SC Cfg~Latest
Working~SC_SOS1~CfgCtxType~Sub_assy1~REV~
Working~CC1_SOS1~Product~Product~MEProductContext~Test Product
SC~tim~dba~Released~Product Cfg~Latest
Working~SC_SOS1~~Sub_assy1~BVR~Design
Working~CC1_SOS1~Plant~Plant~MEPlantContext~Test Plant
SC~tim~dba~Released~Plant Cfg~Latest Working~SC_SOS1~~Sub_assy2~BVR~
Working~CC1_SOS1~Process~Process~MEProcessContext~Test Process
SC~tim~dba~Released~Process Cfg~Latest Working~SC_SOS1~~New_Assy1~BVR~
CC_test_upl_3~~MECollaborationContext~Test CC 3~~Designers~Released~CC1~Latest
Working~CC1_SOS1~SC~~~An SC~~Designers~Released~SC Cfg~Latest
Working~SC_SOS1~CfgCtxType~Sub_assy1~REV~

29. APPENDIX M: MAJOR UPDATES

The table below shows major functionality updates by version. The Link column can be
used to go to the relevant section in the document.
Fixes to solve issues are not included here. Review the current VERSION_MODS.txt file to
get a full list of all fixes and updates for ALL versions of IPS Data Upload.
Version TOPIC Update Link
6.8.0 ITEM REV 1) Fixed problem with objects in revisions not being renamed 4.2
SEPARATOR correctly when changing the item and rev ids due to different
separators being used, e.g. a / in the master form and a - in
UGMASTER. Solved by checking for both separators
defined in the preferences FLColumnCatIVFSeparatorPref
and FLColumnCatObjSeparatorPref.
2) Added a new configuration option ITEM REV ID

SEPARATOR LIST to define a set of alternative separators
instead of those defined in the preferences mentioned
above. A max of 10 separator characters can be specified.
For example...
ITEM REV ID SEPARATOR LIST = /-_
For performance specify the most used character first.
3) Added a new configuration option ITEM REV ID NEW

SEPARATOR to define a new separator to be used on all
objects in their new names, so all objects then have the
same separator.
6.9.0 VERBOSE 1) Added new config option VERBOSE OUTPUT and argument 2.2
-v to add additional output. For now this includes attachment
details when processing items and revisions, e.g. for
changing IDs.
OUTPUT 2) Added new config options to control the output column 2.4.2
DISPLAY sizes:-
OUTPUT COL SIZE TYPE, OUTPUT COL SIZE NAME,
OUTPUT COL SIZE STATUS.
6.10.0 OLD ITEM ID 1) Added new field OldItemID to specify an old item ID to look 4.1
for in attached relations to change to the current ID.
7.0.0 VARIANTS 1) Added ability to create and update legacy and modular 5.1.6
options and set variant conditions.
CC & SC 2) Added ability to create and update Collaboration Context and 14.1.2
Structure Context objects and build their structures complete
with Configuration Context objects. Ownership details and
release status can be set on CC and SC objects.
CC FORMS 3) Ability to attach forms to CC objects. The forms can be 14.1.2.1

independently statused.

GROUP 4) Allow Group to be set without Owner by getting current object -

owner.
END-OF-FILE 5) Added END-OF-FILE check to stop processing data file. 2.3.1

This is handy to break up a file to test just the first few lines.
BL PROPS 6) Added ability to set occurrence translation matrices via the 2.3.2
new general property assignment, e.g.
BL:bl_occ_xform_matrix
MODE 7) Added -mode arg equal to -m arg, to fix many confusions 2.2
over the arg name!
TYPED REFS 8) Added ability to set typed/untyped reference attributes by 2.3.2.1

using TAG and BY_VAL field modifiers.
OOTB PROPS 9) Allow OOTB property names to be used in header line 2.3.2
instead of keywords.
ARRAYS 10) Ability to enter multiple values for array attributes. This 2.4.2
includes a new configuration option MULTI VALUE
SEPARATOR STRING to define the separator used
between values. The default separator is a comma.
ARRAY FILE 11) Ability to specify a file name to contain multiple values. Also 2.3.2.1
added new configuration option VALUE FILES ROOT DIR
to set the root directory containing the ‘values’ files.
BV OWNER 12) Better definition of BOMView Revision ownership via OOTB 2.3.2
property names.
ACT OWNER 13) Better definition of Activity ownership via OOTB property 2.3.2
names.
OCC NAME 14) Added ability to set occurrence names via OOTB property 2.3.2
names.
NULL VALS 15) Allow for a value of NULL to blank form values. 2.3
UOM IN UA 16) For UA do not create UOMs if they don’t exist. --
NOTES IN UA 17) For UA do not create Note Types if they don’t exist. --
LOVS IN UA 18) For UA disabled the LOV mode. --
BL VAL REF 19) Allow typed reference attributes to be set by value. Added 2.3.2.1
new field option BY_VAL to do this.
REL ATTRS 20) Allow attributes to be set on relations for Tc8+. 2.3.2.1
LOG FILE 21) Added new option LOG FILE FORMATS with options CSV 2.4.2
FORMATS and DELIM to write an additional log file that's easier to
process programatically.
7.0.1 DUP ID 1) Added Check for duplicate ID and try to find item using --
ITEM_find_item to check for different case ID.
To control if the existing item should be used a new config


option was added which is:-
USE ITEMS WITH DIFF CASE = YES|NO
Defaulted to YES, albeit it different behaviour than before.
A WARNING is added to the log.
FORM FOLDER 2) Added functionality to put new forms created using FORMS --
mode into a supplied folder.
BOM REV RULE 3) BOM Import now can use BOM REV RULE to specify a --
revision rule in case of problems adding BOM lines due to
rev rule errors.
7.1.0 PROJECTS 1) Added support to set projects on any object, using general 2.3.2.3
properties for projects, i.e. project_ids, project_list,
projects_list.
LOG FILE 2) Started to set true config option names in log file settings 3.1
section. Done General and Items settings so far as these
are always shown.
LOG FILE 3) Made report settings section more appropriate to current 3.1
mode.
LOG FILE 4) Now showing options with blank values to show what's 3.1
available.
DUP ITEM ID 5) Added check for duplicate identifier if create item fails due to --
duplicate identifier ID with a different case.
ITEM REV 6) Added new configuration option ITEM REV RULE which can 4.2.1
RULE be used instead of UPDATE LATEST REV to identify a
revision to update based on a revision rule.
7.2.0 PREDECESSO 1) Added ability to use SeqNo to help find unique predecessors 5.
R MATCHING by adding a new cfg option PRED UPDATE ID FIELDS and
a new BOM field PredSeqNo. An example of the new cfg
option is:-
PRED UPDATE ID FIELDS = Predecessor,PredSeqNo
7.3.0 BLANK MFG 1) Updated MFG mode to allow blank revisions for ProcRevID, --
REVS OpRevID and WorkRevID. So, for new items the general
DEFAULT REV, or "A" if not set, will be used, and for
updates the latest rev will be found if UPDATE LATEST REV
is ON.
LOG FILE 2) Updated log settings to show true option names for Mfg, 3.1
BOM, Files, Forms and Relation settings.
7.3.3 RELATIONS 1) Added new fields RelChildType and RelChildName to 8.2.1

specify the type and name of any WSOM object to be cut
from a relation or pasted into one. Thus datasets, forms and
other objects, except items and revisions, can be cut/pasted

with one data file. Items and Revisions require their own
data file using ChildID and ChildRev fields.
7.4.0 VARIANTS 1) Enhanced legacy variant option condition processing to **

handle nested brackets with &'s and |'s. Can also still handle
multiple values with |'s too.
DATA FILE 2) Increased both max line length and max field length to --
20,000 to allow for large condition strings!
VARIANTS 3) Added new fields LVarOptDefVal to set default values and 5.1.6.1
LVarOptSetIfVal and LVarOptSetIfCond to set Set If
(derived) values and their conditions. The conditions are
supplied in the same format as Load If conditions on
occurrences.
VARIANT RULE 4) Added new functionality to create and update saved legacy **
variant rules with options set.
7.4.1 SUMMARY Added new summary lines for:- --

Item Att's UPDATED and
Rev Att's UPDATED
7.4.3 DATES 1) Improved date formatting to remove potential problems with --

different language (locale) settings and DST settings.
2) Fixed fatal crash issue when consuming parts in MFG

module.
Problem was introduced by Predessor update fields in 7.2.0.
7.4.6 BOM UPDATE Fixed problem with BOM UPDATE OPTION = UPDATE ALL --
OCCURRENCES not working. Only one occurrence would get
updated.
This problem was probably introduced in 7.2.0.
7.5.0 CFG INCLUDE Added new configuration option INCLUDE to include another --
config file, e.g. a global_config file to set general settings like
DATE FORMAT.
Multiple INCLUDE options can be used and also nested through

config files, e.g.
INCLUDE = global_config.cfg
INCLUDE = common_create_items.cfg
The included configuration files will be looked for in the same

directory as the main configuration file as specified with the
–cfg argument, unless a specific path is supplied for the
included config file.
7.6.0 PART->CAD Added new functionality to create Part/CAD alignment links (or 2.4.1,
LINK publish links) between occurrences in different BVRs. 5.2.4
This creates the new fields:-
TargetParentID
TargetParentRev

PublishLinkType
PublishLinkName
and uses the existing field (from MFG mode) TargetChildID.
With the new configuration options:-
PUBLISH LINK TYPE

PUBLISH LINK DATA FLAGS
7.7.0 IDENTIFIERS 1) Add option and field to define type of Identifier. 13.
Option = IDENTIFIER TYPE
Field =AltIDType
BOM 2) Fixed problem during BOM import where an existing child

revision would get updated if CREATE ITEMS = ON and
UPDATE REVS = OFF which also prevented the child being
added to the BOM.
Now Create Parent and Child item flags default to off, child
revisions (and items) can be updated with normal item mode
fields obeying the settings UPDATE ITEMS and UPDATE
REVS, and any errors setting item and rev properties will
NOT prevent the BOM being created.
This problem was introduced in 7.3.6.
RELATIONS 3) Fixed problem with relation properties, using

<rel_type>:<prop>,
were not getting set in Tc 8.1+.
BOM 4) Fixed BOM upload crash if ChildID was blank. This is a valid
situation to update properties on the parent and set parent
options for V & O.
GENERAL 5) Added timing messages to help with analysing and

estimating performance and upload timings, for example...
...
Initialisation took [10.91] seconds
...
[14] total lines read
[4] data lines read in [1.22] seconds
[0.30] seconds per data line
...
FORMS 6) Stopped form searching, for orphaned forms (not attached to

anything), always setting a parent class of Form, thus never
finding forms sub classed from Form.
Now searches on Form Type if supplied, else POM class of
Form.
CC & SC 7) A GRM relation can now be defined to add objects to SCs

(Structure Contexts) by adding the RelationName field or
using the RELATION NAME option.
DATE & TIME 8) Fixed DST date issue with <prop>: fields. This code was not

using the same DST fix added in 7.4.3! So this fixes an hour
being added to times during summer (DST) months.
8.0.0 RELATIONS 1) The relations module was completely re-written to provide 8.1
functionality to create/cut relations between any 2 workspace
objects.
BOM 2) Added new general property code BLCTXT:<prop> to set 2.3.2

BOM Line attributes In Context to another assembly as
specified using the existing InContext fields ContextItemID
and ContextItemRevID.
8.1.0 VALIDATION 1) Added field validation options, including options to specify 3.4
how many data lines to validate and whether or not to import
them.
FIELD LENGTH 2) Added check for field value length to report error if value to
long, since the AOM ITK function used caused memory
errors when trying to set a value that was too long.
8.2.0 PARTICIPANTS 1) Added functionality to set Participant relations, e.g. 2.3.2.1

ProposedReviewer, Analyst. Requires new field
modifiers .PARTICIPANT with .USER, .GROUP 2.4.2
or .GROUP_MEMBER.
EFFECTIVITIES 2) Added multiple effectivity date range support and a new field 4.1.5
EffID to allow creation and update of multiple effectivities
with Effectivity IDs and allowing for shared effectivities by
searching for existing effectivities with the supplied EffID.
9.0.0 POM OBJECTS 1) Added functionality to create and update almost any type of 15.
object using POM functions.
9.1.0 REPEAT REVS 1) Added new option ALLOW REPEAT ITEM AND REV LINES 4.2.1
to process consecutive lines with the same item and rev ids
in items mode.
9.2.0 POM FIELDS 1) Added new .POM field modifier to allow a colon property to 2.3.2.1
be set using a POM function to override BMIDE rules on
attributes.
POM FIELDS 2) Added new CFG option SET COLON PROPS WITH POM to 2.4.2
supply a CSV list of general property fields which are to have
their values set with POM functions.
10.0.0 MULTI ITEM 1) Added new option SEARCH FOR ITEMS BY = 4.2.1
UPDATE NAME:<NameField> to search for items by name instead of
item ID, which allows multiple items to be updated from one
data line. <ItemField> is the name of the field that contains
the name to search on, e.g. NAME:ItemID searched on
name using the value from the ItemID field.
This works in items mode for updating items and also
datasets mode for creating/updating datasets attached to the
found items or revisions.

MATCH ID & 2) Added new ON|OFF option MATCH ITEM BY NAME AND ID 4.2.1
NAME which checks if any of the items found using the new option
SEARCH FOR ITEMS BY (decribed above in 3)) has a
matching item ID and name. If one isn't found then, if
CREATE ITEMS = ON, a new item will be created using the
fields supplied.
LATEST ONLY 3) Added new option value ONLY to the option UPDATE 4.2.1
LATEST REV which forces the latest rev to be found even if
the RevID field is supplied.
FIND OCC BY 4) Added new BOM option BOM FIND OCC BY NAME AS ID = 5.2.1
NAME ON|OFF to match occurrences during a BOM update by
checking Item Name against the value supplied in ChildID.
ADD LATEST 5) Added new option value LATEST REV to BOM UPDATE 5.2.1
ADD OCCURRENCES to always find the latest revision of a
child even if ChildRev is supplied.
NEW IDs LOG 6) Added new arg -new_items_ids_log=<New item IDs log file> 2.2
to specify a file name into which auto generated item IDs will
be written to. The file will only be created if the config option
AUTO GENERATE ITEM ID = ON.
NEW ITEM 7) New items now get name set to ID if name field not supplied.
NAME
BY PARENT 8) Changed default settings for SET OWNER BY PARENT and

USE PARENT STATUS to OFF instead of ON to stop
attachments being updated with nothing to do and providing
misleading output and potential errors.
10.0.1 DATE FORMAT 1) Added new config option TC DATE FORMAT option which
must be used in Tc 9.1 64bit.
10.1.0 RELATION 1) Added new fields ChildOwner, ChildGroup, ChildPUID, 8.2.1

FIELDS ChildClass, ParentOwner, ParentGroup, ParentPUID and
ParentClass to relations mode to allow children and parents
to be found filtered by owning user and/or group (including
existing type and name search), OR found using their PUIDs
with optional class check.
10.2.0 IDENTIFIER 1) Added ability to set a status on identifier and identifier rev 13.1.1
STATUS objects using the standard status fields and config options
when using the identifier mode. New config options
RELEASE IDENTIFIERS and RELEASE IDENTIFIER REVS
were added to help control which objects get released.
IDENTIFIER 2) Can now also set general properties on IDENTIFIERS and 2.3.2
PROPS IDENTIFIER REVS.
10.3.0 PROJECT 1) Added ability to set general properties on projects using 2.3.2
PROPERTIES PROJECT:<attr> or TC_Project:<attr>.
10.4.0 OCCURRENCE 1) Added ability to set basic occurrence effectivities with limited 5.1.1,
EFFECTIVITY functionality. 5.2.5

10.5.0 MULTI 1) Added ability to set property values with different languages. 2.3.2.1,
LANGUAGE This is done by adding the field modifier .LANG[=lang], with 2.4.2
PROPERTIES new configuration options to set the DEFAULT LANGUAGE
and DEFAULT LANGUAGE STATUS.
10.6.0 ALTERNATE / 1) Added new field AlternateRevIDs to specify rev IDs for alternate 5.1.1
SUBSTITUTE (substitute) revs for a BOM child.
REV IDS
10.7.0 BASIC AUTO 1) Added new config flag option AUTO GENERATE BASIC 4.2.1
ITEM ID ITEM ID to generate basic item ID.
GENERATION
10.8.0 CC/SC SOS 1) Completed functionality to create CC and SC SOS (Variant 14.1.2
rule) creation and update complete with defining an option
set. 14.2.2
10.9.0 AUTO ITEM ID 1) Added new field AutoItemIDMapping to define a value to be 4.1.1
AMPPING written to the auto IDs log file for reference.
10.10.0 REVISION 1) Added new support to create and update revision sequences, 4.1.2
SEQUENCES with support to add datasets to specific sequences. 4.2.1
4.3.8
10.11.0 ITEM CREATE 1) Items can now be created with mandatory attributes. 2.3.2.1
MAND ATTRS 4.3.9
.FIND FLD MOD 2) Typed and un-typed reference attributes can now have 2.3.2.1
& OWNING objects found to set by using the new .FIND=<class>,<attr> 4.3.10.1
PROJECT field modifier.
This can be used to set owning_project.
POM 3) GRM relations can be created using POM functions to 8.3.1

RELATIONS override BMIDE rules that may otherwise prevent the
relation from being created.
10.12.0 LEGACY O&V 1) Added new legacy O&V fields LVarOptErrorIfMsg and 5.1.6.1
ERROR IF LVarOptErrorIfCond to set Error If rules.
19.9.5
2) Option names can now indicate options on items outside of
the current BOM.
11.0.0 MULTI FIELD 1) Added support for MultiField Keys in Tc 10.1 to allow for 2.7
KEYS multiple items with the same item ID by specifying .KEY
fields or just checking on item type.
FIND OCC IN 2) Added .BOM_OCC_KEY field modifier to identify fields to 2.3.2.1

BOM UPDATE use to identify occurrences to update during a BOM update.
EXISTING O&V 3) Added O&V CHECK FOR EXISTING RULE option to stop 5.3.4.3
RULES searching for existing option and variant rules to improve

performance.
11.1.0 RELATION SUB 1) Added support/fix to allow setting relation properties on sub 8.4.1
CLASSES classed relations under ImanRelation when using
RELATION BMIDE OVERRIDE to creation the relation with
POM.
11.2.0 RESOURCE 1) Added .RESOURCE_POOL field modifier 2.3.2.1

POOL for .PARTICIPANT fields.


Ips Data Upload 10-2-1 TSD

Uploaded by

Copyright:

Available Formats

You might also like

Ips Data Upload 10-2-1 TSD

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Ips Data Upload 10-2-1 TSD

Uploaded by

Copyright:

Available Formats

TECHNICAL DOCUMENT

Project Title: IPS_DATA_UPLOAD TECHNICAL DOCUMENTATION

Issued Date: 5th Mar 2015

1 Project Library Internal Community Archive,

Copyright © 2015 Siemens Industry Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 13/01/10

Version Date Author Description

6.5.0a 20/11/2006 Guy Bursell Initial Technical Release for

Technical Review and Training

6.5.0 24/11/2006 Guy Bursell Updated from Review and Feedback.

6.6.0 29/11/2006 Guy Bursell Added Checkin/Checkout functionality

Added boms mode missing data field ‘OccQty’

Enabled config/data fields to set ownership of

Fixed Signal 11 error when uploading large

1) Re-write of relations module to allow any

2) Setting of any In Context BOM Line

Copyright © 2015 Siemens Industry Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 13/01/10

Add field validation options.

1) Added .POM field modifier to set ‘non

2) Added .PARTICIPANT, .USER, .GROUP

3) Added support for shared effectivities with

1) Added new pom module to create/update

1) Added new .POM field modifier to set

1) Added ability to update multiple items from

2) Changed some default values for setting

1) Added new relation fields to filter on parent

10.2.0 14/12/12 Tim William Added ability to release Identifier objects.

Copyright © 2015 Siemens Industry Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 13/01/10

10.4.0 25/01/13 Tim Williams Added basic ability to create occurrence

10.8.0 27/04/13 Tim Williams Finished off creation of CC and SC SOS

10.9.0 20/06/13 Tim Williams Added new field AutoItemIDMapping to define

10.11.0 06/12/13 Tim Williams Used new general TC_create_object function

Add new .FIND field modifier to find objects to

10.11.1 24/01/2014 Tim Williams Added missing documentation for workflow

10.12.0 06/02/2014 Tim Williams 1) Added new legacy O&V fields

2) Option names can now indicate options on

2) Added .BOM_OCC_KEY field modifier to

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 13/01/10

POM on sub-classes to ImanRelation.

11.2.0 03/12/2014 Tim Williams 1) Added .RESOURCE_POOL field modifier

11.2.1 05/03/2015 Tim Williams 1) Added some troubleshooting details re non

Copyright © 2015 Siemens Industry Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 13/01/10

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 13/01/10

4.3.3 CHECK IN / CHECK OUT / CANCEL CHECK OUT..................................................42

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 13/01/10

5.4 COMMAND LINE ARGUMENTS...............................................................................64

Copyright © 2015 Siemens Industry Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 13/01/10

9.3 MODULE NOTES...................................................................................................... 80

Copyright © 2015 Siemens Industry Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 13/01/10

15. WORKFLOW MODE..........................................................................................................101

Copyright © 2015 Siemens Industry Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 13/01/10

19. APPENDIX C: BOM MODULE EXAMPLES..................................................................119