0% found this document useful (0 votes)

645 views226 pages

Ips Data Upload 14-21-0 TSD

The IPS_DATA_UPLOAD Technical Documentation outlines the features and updates of the software, detailing its version history from 6.5.0 to 14.21.0. The document includes information about revisions, major updates, and specific functionalities added in each version. It is intended for internal use by Siemens Digital Industries Software and is protected under copyright.

Uploaded by

cad cad

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

645 views226 pages

Ips Data Upload 14-21-0 TSD

Uploaded by

cad cad

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 226

TECHNICAL DOCUMENT

Project Title: IPS_DATA_UPLOAD TECHNICAL DOCUMENTATION

RELEASED

Document Info
Revision: 14.21.0
Issued Date: 20th Mar 2024
Reference: IPS_DATA_UPLOAD_14_21_0_TSD.doc

Copyright in this work is vested in Siemens Digital Industries 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 Digital Industries
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 Digital Industries Software.
SIEMENS Technical Document

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.

7.7.0 11/02/2011 Tim Williams See major update list in section Appendix M:
Major updates for 7.7.0 mods.

8.0.0 21/06/2011 Tim Williams See major update list in section Appendix M:
Major updates for 8.0.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.

8.1.0 18/08/2011 Tim Williams See major update list in section Appendix M:
Major updates for 8.1.0 mods.

Add field validation options.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 2 of 226
SIEMENS Technical Document

8.2.0 24/10/2011 Tim Williams See major update list in section Appendix M:
Major updates for 8.2.0 mods.

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.

9.0.0 24/04/2012 Tim Williams See major update list in section Appendix M:
Major updates for 9.0.0 mods.

1) Added new pom module to create/update

general POM objects, e.g. CompanyLocation.

9.2.0 02/07/2012 Tim Williams See major update list in section Appendix M:
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.

10.0.0 31/08/2012 Tim Williams See major update list in section Appendix M:
Major updates for 10.0.0 mods.

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.

10.1.0 21/11/2012 Tim Williams See major update list in section Appendix M:
Major updates for 10.1.0 mods.

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 3 of 226
SIEMENS Technical Document

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 4 of 226
SIEMENS Technical Document

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) Doc update to add some troubleshooting

details re non modifiable properties and shared
memory issues.

11.2.2 10/09/2015 Tim Williams 1) Doc update to add missing dataset config
options.

11.2.3 22/09/2015 Tim Williams 1) Added help for Un-releasing in Items notes.

11.3.0 09/09/2015 Tim Williams 1) Started to add TAG input fields, starting with
DsetName.TAG.

12.0.0 15/01/2016 Tim Williams 1) A new config option PROPAGATION PATH

allows objects under items, revs and pom
objects to be updated.

2) Objects in the pom mode can now be

identified using the pid attribute for specifying
an object’s unique ID (tag).

3) In items mode items and revs can now be

identified using their unique IDs by supplying
the field ItemID.TAG and/or RevID.TAG.

4) Inactive projects can be assigned to objects

by setting PROJECT ASSIGN INACTIVE
PROJECTS = ON.

5) Projects can be assigned to objects without

the DPAM date being updated by setting
PROJECT UPDATE DPAM DATE = OFF

12.1.0 11/02/2016 Tim Williams 1) Made .APPEND and .FIND work together.

12.2.0 13/04/2016 Tim Williams 1) Improved support for ProjectObjectRelation

handling when assigning projects with or
without using PROPAGATION PATH.

12.3.0 11/05/2016 Tim Williams 1) Fixed problem with Auto generation of Item
IDs.

2) Added keyword options ITEM_TAG and

REV_TAG to be supplied in the
AutoItemIDMapping field

12.4.0 31/05/2016 Tim Williams 1) Improved Activity predecessor functionality.

12.5.0 15/07/2016 Tim Williams 1) Added owning_project update on PORs

when creating a POR or updating an object with

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 5 of 226
SIEMENS Technical Document

a POR.

2) Added config options to control which object

classes get their own POR created.

12.6.0 07/12/2016 Tim Williams 1) Enhanced .FIND to use ItemID and RevID

2) Allowed for creation and update of multiple

revision effectivities.

3) Enhanced EffEndItem field to accept a CSV

MFK string.

4) Fixed issues with DPAM date setting and

release status display output.

12.6.1 10/02/17 Tim Williams 1) Updated descriptions for AUTO GENERATE

ITEM ID.

12.7.0 25/08/17 Tim Williams 1) Fixed crash issue setting legacy O&V default

2) .FIND modifier now used to create MFK

items with .KEY.

3) .FIND can now use separate fields.

4) OOTB post-actions now run on item create.

5) EffStartDate and UnitStart now accept

ranges.

6) Subsequent rev lines now recognise a BAD

ITEM that wasn’t found or created.

7) Fixed issue to allow mandatory Description

to be set on item creation.

8) .KEY can now use separate fields.

12.8.0 21/09/17 Tim Williams 1) Added .TAG support to FormName field in

forms mode.

12.9.0 Tim Williams 1) Add support for .APPEND with

.PARTICIPANT.

12.10.0 Tim Williams 1) Added support to create forms of different

type with sub classes form types.

12.11.0 Tim Williams 1) Added option DUPLICATE FORM NAMES

13.0.0 22/02/18 Tim Williams 1) Added new folders mode to replace

folder_insert and folder_create modes.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 6 of 226
SIEMENS Technical Document

2) POM mode now accepts folder definitions to

put new Workspaceobject in a folder.

13.1.0 06/04/18 Tim Williams Added MFK support for bom fields SubstChild
and Alternates.

13.2.0 24/08/18 Tim Williams Added new create functionality to POM mode to
use general TCTYPE_create_object for better
object creation of general object types.

13.3.0 01/02/19 Tim Williams Updated for Tc 12 by disabling all ECM

functions accessed using ECID field.

14.0.0 21/08/19 Tim Williams 1) Added arguments for batch control, to set
batch size with either a start line or batch ID.

2) Added option to specify a default values

header line and data line so that default values
don’t have to be supplied on every data line.

14.1.0 27/09/19 Tim Williams 1) Added new config option:-

ALLOW ITEMID MFK FORMAT = ON|OFF

14.2.0 09/12/19 Tim Williams 1) Added support for setting attributes of type
table.

2) Can now use general ‘Object’ field with

datasets, folders, forms and relations
modes.

14.3.0 05/02/20 Tim Williams 1) Added option REGISTER APPLICATIONS.

14.4.0 07/02/20 Tim Williams 1) Added option SET EMPTY FIELDS TO

NULL.

14.4.1 11/03/20 Tim Williams 1) Added Object example in relation examples.

14.5.0 29/09/20 Tim Williams Updated for Tc 13.0. No functionality changes,

but many deprecated ITK functions replaced
with new ones.

14.5.1 11/11/20 Tim Williams Document update to add POM example to

update the Name of a PSViewType.

14.5.2 25/11/20 Tim Williams Added comment that by default, i.e. without
.APPEND option all participants are replaced.

14.6.0 27/11/20 Tim Williams Added extra control for setting and updating
participants.

14.7.0 15/12/20 Tim Williams Added .BO_CREATE field modifier.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 7 of 226
SIEMENS Technical Document

14.8.0 24/03/21 Tim Williams Added information about setting security

properties and extra details for supplying
default values.

14.9.0 29/03/21 Tim Williams 1) Allowed .FIND with ref’d attrs in pom mode.

2) Added BOM AUTO SET FIND NO option.

14.10.0 29/04/21 Tim Williams 1) Added support for general Object field in
pom mode.

14.11.0 17/06/21 Tim Williams 1) Added support for updating a specific

effectivity by matching on the End Item.

14.12.0 05/10/21 Tim Williams 1) Updated Tc 12.2+ mods to call new

IPS_<function> functions where new
<function>2 replaced deprecated functions.

14.13.0 21/10/21 Tim Williams 1) Added cfg option DEFAULT

CONFIGURATOR CONTEXT ID to set the
global configurator context ID.

14.14.0 25/11/21 Tim Williams 1) Updated control over update items, revs and
their attachments.

2) Reworked field finding for attachments and

revisions to hopefully improve performance.

3) Added the ability for the property

owning_user to be supplied as <user><multi-
sep><group>, e.g. tim,Engineering.

14.15.0 22/03/22 Tim Williams Added support for mandatory table attributes.

14.16.0 06/04/22 Tim Williams Fixed problem with security properties not
propagating OOTB during BOM creation.

14.17.0 30/05/23 Tim Williams 1) Added support to set and update Global
Alternates.
2) Updated all item find functions in mfg mode
to use new function to find items using MFK
fields.
3) Added new field FileOrigName in datasets
mode

14.18.0 27/06/23 Tim Williams 1) Updated BOM Occ search in mfg mode to
use RDV search to improve performance.

14.19.0 07/07/23 Tim Williams 1) Added support for existing BOM fields
TargetParentID and TargetParentRev to mrp
mode to find Process and Product children to
link under specific parents.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 8 of 226
SIEMENS Technical Document

2) Updated the rev searches for Process and

Product children to use supplied BOM REV
RULE.

14.19.1 13/07/23 Tim Williams Added document versioning details to

Executive Summary

14.20.0 18/01/24 Tim Williams Updated for Tc 2312.

14.21.0 20/03/24 Tim Williams Enhanced OV condition string processing to

allow an escape character, "\".

REFERENCE DOCUMENTS
Document Revision Date Doc Reference

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 9 of 226
SIEMENS Technical Document

CONTENTS
1. EXECUTIVE SUMMARY ............................................................................................ 18
1.1 Versioning ................................................................................................................... 18
2. TECHNICAL OVERVIEW ........................................................................................... 19
2.1 Modes ......................................................................................................................... 19
2.2 USAGE ........................................................................................................................ 20
2.3 INPUT DATA FILE ...................................................................................................... 22
2.3.1 [7.0.0] End of File ........................................................................................................ 23
2.3.2 [7.0.0] General properties ........................................................................................... 23
2.3.2.1 [7.0.0] Field Modifiers .................................................................................................. 24
2.3.2.2 [7.0.0] Relation properties (Tc8+) ............................................................................... 30
2.3.2.3 [7.1.0] Setting project .................................................................................................. 30
2.3.2.4 [12.7.0] Custom Field Identifiers ................................................................................. 31
2.3.3 [11.3.0] Supplying PUIDs (tags) for Input fields .......................................................... 31
2.3.4 [14.0.0] Setting default values ..................................................................................... 32
2.3.5 [14.2.0] Setting table attributes ................................................................................... 32
2.3.5.1 Replacing and Appending table attribute rows ........................................................... 33
2.3.5.2 Examples - Setting Table Attributes............................................................................ 33
2.3.6 [14.2.0] General ‘Object’ field ...................................................................................... 34
2.3.6.1 ‘Object’ Examples ....................................................................................................... 34
2.4 CONFIGURATION OPTIONS ..................................................................................... 35
2.4.1 [7.6.0] INCLUDE CONFIG FILE .................................................................................. 35
2.4.2 General Configuration Options ................................................................................... 36
2.5 RUNNING AN IMPORT .............................................................................................. 40
2.5.1 [14.0.0] Batch processing ........................................................................................... 40
2.5.1.1 Automated Batching .................................................................................................... 40
2.6 [9.2.0] Overriding BMIDE rules on attributes .............................................................. 45
2.7 [11.0.0] MultiField Keys in Tc10+ ................................................................................ 45
2.7.1 Introduction ................................................................................................................. 45
2.7.2 Data Field modifiers .................................................................................................... 46
2.7.3 [12.7.0] KEY field Identifier ......................................................................................... 46
2.7.3.1 Supported fields .......................................................................................................... 46
2.7.4 Item MFK string ........................................................................................................... 47
2.7.5 [14.17.0] .KEY plus .PROP ......................................................................................... 47
2.7.6 Considerations ............................................................................................................ 47
2.8 [12.0.0] Object Propagation ........................................................................................ 49
2.8.1 Propagation Fields ...................................................................................................... 49
2.8.2 Propagation path format ............................................................................................. 49
2.8.2.1 Propagation Type String ............................................................................................. 49
2.8.2.2 Propagation Relation String ........................................................................................ 52
2.8.3 Propagation path processing ...................................................................................... 53
2.8.4 Propagation considerations ........................................................................................ 53
2.8.5 [12.2.0] Setting ‘project_list’ (Project Assign) ............................................................. 54
2.8.6 [14.8.0] Setting security attributes like license_list ..................................................... 55
Unrestricted Copyright © 2023 Siemens Digital Industries Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 10 of 226
SIEMENS Technical Document

2.8.6.1 license_list ................................................................................................................... 55

2.8.6.2 gov_classification ........................................................................................................ 56
2.8.7 Propagation Examples ................................................................................................ 56
2.8.7.1 Items, revisions and standard attachments ................................................................ 56
2.8.7.2 Propagation path to update children in a BOM ........................................................... 57
2.8.7.3 Updating objects in a Folder using the pom mode ..................................................... 57
2.8.7.4 Update folders in a folder structure ............................................................................. 58
2.8.7.5 [14.8.0] Replace licenses for a parent and its BOM children ...................................... 58
3. TROUBLESHOOTING................................................................................................ 61
3.1 The log file ................................................................................................................... 61
3.2 The Repeat File ........................................................................................................... 61
3.3 Debugging ................................................................................................................... 61
3.4 [8.1.0] Field Validation ................................................................................................ 61
3.4.1 Command Line Arguments ......................................................................................... 62
3.4.2 Configuration Options ................................................................................................. 62
3.4.3 Example Report File.................................................................................................... 62
3.5 [11.2.1] Non Modifiable Properties .............................................................................. 63
3.5.1 Method 1 – Use a supplied keyword ........................................................................... 64
3.5.2 Method 2 – Use the POM modifier .............................................................................. 64
3.6 [11.2.1] Shared Memory Issues .................................................................................. 64
4. ITEMS MODE ............................................................................................................. 65
4.1 INPUT DATA FIELDS ................................................................................................. 65
4.1.1 Item fields .................................................................................................................... 65
4.1.2 Revision fields ............................................................................................................. 66
4.1.3 Ownership fields .......................................................................................................... 66
4.1.4 Miscellaneous fields .................................................................................................... 66
4.1.5 Status fields ................................................................................................................. 66
4.1.6 Item and ItemRevision Master Forms ......................................................................... 67
4.1.7 Checkin/Checkout/Cancel Checkout .......................................................................... 68
4.2 CONFIGURATION OPTIONS ..................................................................................... 68
4.2.1 Items/Revisions ........................................................................................................... 68
4.2.2 Attachments ................................................................................................................ 70
4.2.3 Owning Site ................................................................................................................. 71
4.2.4 Status, Effectivities and Checkin/Checkout (CICO) .................................................... 71
4.3 MODULE NOTES ....................................................................................................... 75
4.3.1 RELEASE STATUS .................................................................................................... 75
4.3.1.1 Un-releasing / Removing multiple statuses ................................................................ 76
4.3.2 DATE RESTRICTIONS ............................................................................................... 76
4.3.3 CHECK IN / CHECK OUT / CANCEL CHECK OUT ................................................... 76
4.3.4 UN-RELEASING ITEMS/REVISIONS ........................................................................ 77
4.3.5 EFFECTIVITIES .......................................................................................................... 77
4.3.5.1 Notes on V7 Effectivities ............................................................................................. 77
4.3.5.2 [12.6.0] Multiple Effectivities ....................................................................................... 78
4.3.5.3 [12.7.0] Effectivity ranges ............................................................................................ 78
Unrestricted Copyright © 2023 Siemens Digital Industries Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 11 of 226
SIEMENS Technical Document

4.3.5.4 [12.7.0] Finding End items .......................................................................................... 78

4.3.6 CHANGING IDS .......................................................................................................... 78
4.3.7 REVISING AND SAVE AS .......................................................................................... 79
4.3.7.1 Revise/Save As/Change ID Summary ........................................................................ 80
4.3.8 [10.10.0] Revision Sequences .................................................................................... 80
4.3.9 [10.11.0] Setting mandatory attributes ........................................................................ 81
4.3.10 [10.11.0] Setting special attributes .............................................................................. 81
4.3.10.1 owning_project ............................................................................................................ 81
4.3.10.2 project_list ................................................................................................................... 81
4.3.11 [11.0.0] MultiField Keys in Tc10+ ................................................................................ 81
4.3.12 [12.0.0] Object Propagation ........................................................................................ 81
4.3.13 [14.14.0] Attachments ................................................................................................. 82
4.3.14 [14.17.0] Global Alternates (I:global_alt_list) .............................................................. 82
4.4 COMMAND LINE ARGUMENTS ................................................................................ 84
4.5 EXAMPLES ................................................................................................................. 84
5. BOMS MODE .............................................................................................................. 85
5.1 INPUT DATA FIELDS ................................................................................................. 85
5.1.1 BOMs .......................................................................................................................... 85
5.1.2 Absolute Occurrences ................................................................................................. 87
5.1.3 Engineering Change ................................................................................................... 87
5.1.4 Occurrence Notes ....................................................................................................... 87
5.1.5 [10.4.0] Occurrence Effectivity .................................................................................... 87
5.1.6 [7.0.0] Options and Variants ....................................................................................... 88
5.1.6.1 Legacy Variants .......................................................................................................... 88
5.1.6.2 Modular Variants ......................................................................................................... 89
5.1.7 [7.0.0] General BOM Properties .................................................................................. 89
5.1.8 [7.6.0] Part / CAD Alignment (publish) links ................................................................ 89
5.2 CONFIGURATION OPTIONS ..................................................................................... 91
5.2.1 BOMS .......................................................................................................................... 91
5.2.2 Engineering Change ................................................................................................... 93
5.2.3 [7.0.0] Options and Variants ....................................................................................... 94
5.2.4 [7.6.0] Part / CAD Alignment (publish) links ................................................................ 94
5.2.5 [10.4.0] Occurrence Effectivity .................................................................................... 95
5.3 MODULE NOTES ....................................................................................................... 96
5.3.1 BOM OCCURRENCE UPDATE ................................................................................. 96
5.3.2 CHILD SUBSTITUTION .............................................................................................. 98
5.3.3 [7.6.0] Part / CAD Alignment (publish) links ................................................................ 99
5.3.3.1 Introduction ................................................................................................................. 99
5.3.3.2 Creating a link in the UI ............................................................................................... 99
5.3.3.3 Importing links ........................................................................................................... 100
5.3.4 [7.0.0] Legacy and modular variants ......................................................................... 100
5.3.4.1 Creating options and values ..................................................................................... 100
5.3.4.2 Creating conditions ................................................................................................... 101
5.3.4.3 [10.12.0] Option Error Rules (Legacy) ...................................................................... 102
Unrestricted Copyright © 2023 Siemens Digital Industries Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 12 of 226
SIEMENS Technical Document

5.3.5 [10.4.0] Occurrence Effectivities ............................................................................... 103

5.4 COMMAND LINE ARGUMENTS .............................................................................. 103
5.5 EXAMPLES ............................................................................................................... 103
5.5.1 General Example ...................................................................................................... 103
5.5.1.1 [13.1.0] Alternates example using different MFK definitions .................................... 103
6. FORMS MODE ......................................................................................................... 105
6.1 INPUT DATA FIELDS ............................................................................................... 105
6.1.1 Forms ........................................................................................................................ 105
6.2 CONFIGURATION OPTIONS ................................................................................... 105
6.2.1 Forms ........................................................................................................................ 105
6.3 MODULE NOTES ..................................................................................................... 106
6.3.1 [12.8.0] Using FormName.TAG ................................................................................ 106
6.4 COMMAND LINE ARGUMENTS .............................................................................. 106
6.4.1 Forms ........................................................................................................................ 106
6.5 EXAMPLES ............................................................................................................... 107
7. LOVS MODE ............................................................................................................. 108
7.1 INPUT DATA FIELDS ............................................................................................... 108
7.1.1 Lovs ........................................................................................................................... 108
7.2 CONFIGURATION OPTIONS ................................................................................... 108
7.2.1 Lovs ........................................................................................................................... 108
7.3 MODULE NOTES ..................................................................................................... 108
7.4 COMMAND LINE ARGUMENTS .............................................................................. 109
7.5 EXAMPLES ............................................................................................................... 109
8. RELATIONS MODE.................................................................................................. 110
8.1 [8.0.0] Any workspace objects .................................................................................. 110
8.2 INPUT DATA FIELDS ............................................................................................... 110
8.2.1 Relations ................................................................................................................... 110
8.3 CONFIGURATION OPTIONS ................................................................................... 113
8.3.1 Relations ................................................................................................................... 113
8.4 MODULE NOTES ..................................................................................................... 114
8.4.1 Sub Classed relations using BMIDE OVERRIDE ..................................................... 114
8.4.1.1 Setting default attributes ........................................................................................... 115
8.4.1.2 Setting relation attributes .......................................................................................... 115
8.4.1.3 Trial and error ............................................................................................................ 116
8.5 COMMAND LINE ARGUMENTS .............................................................................. 117
8.5.1 Relations ................................................................................................................... 117
8.6 EXAMPLES ............................................................................................................... 117
9. DATASETS MODE ................................................................................................... 119
9.1 INPUT DATA FIELDS ............................................................................................... 119
9.1.1 Datasets .................................................................................................................... 119
9.1.2 Files ........................................................................................................................... 120
9.1.3 Forms ........................................................................................................................ 120
9.2 CONFIGURATION OPTIONS ................................................................................... 120
9.2.1 Datasets .................................................................................................................... 120
9.3 MODULE NOTES ..................................................................................................... 122
Unrestricted Copyright © 2023 Siemens Digital Industries Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 13 of 226
SIEMENS Technical Document

9.4 COMMAND LINE ARGUMENTS .............................................................................. 122

9.5 EXAMPLES ............................................................................................................... 122
10. FOLDER MODE........................................................................................................ 123
10.1.1 Top Folders ............................................................................................................... 123
10.2 New in 13.0.0 ............................................................................................................ 123
10.3 INPUT DATA FIELDS ............................................................................................... 124
10.3.1 Folders ...................................................................................................................... 124
10.3.2 Top Folders ............................................................................................................... 124
10.3.3 Attaching objects ....................................................................................................... 124
10.4 CONFIGURATION OPTIONS ................................................................................... 125
10.4.1 Folders ...................................................................................................................... 125
10.4.2 Top Folders ............................................................................................................... 126
10.5 MODULE NOTES ..................................................................................................... 127
10.6 COMMAND LINE ARGUMENTS .............................................................................. 128
10.7 EXAMPLES ............................................................................................................... 128
11. PROJECTS MODE ................................................................................................... 129
11.1 INPUT DATA FIELDS ............................................................................................... 129
11.1.1 Projects ..................................................................................................................... 129
11.2 CONFIGURATION OPTIONS ................................................................................... 129
11.2.1 Projects ..................................................................................................................... 129
11.3 MODULE NOTES ..................................................................................................... 130
11.4 COMMAND LINE ARGUMENTS .............................................................................. 131
11.5 EXAMPLES ............................................................................................................... 131
12. CLASSIFICATION MODE ........................................................................................ 132
12.1 INPUT DATA FIELDS ............................................................................................... 132
12.2 CONFIGURATION OPTIONS ................................................................................... 132
12.2.1 classification .............................................................................................................. 132
12.3 MODULE NOTES ..................................................................................................... 133
12.4 COMMAND LINE ARGUMENTS .............................................................................. 134
12.5 EXAMPLES ............................................................................................................... 134
13. IDENTIFIERS MODE ................................................................................................ 135
13.1 INPUT DATA FIELDS ............................................................................................... 135
13.1.1 Identifiers ................................................................................................................... 135
13.2 CONFIGURATION OPTIONS ................................................................................... 136
13.2.1 identifiers ................................................................................................................... 136
13.3 MODULE NOTES ..................................................................................................... 136
13.4 COMMAND LINE ARGUMENTS .............................................................................. 138
13.5 EXAMPLES ............................................................................................................... 138
14. MANUFACTURING MODE ...................................................................................... 139
14.1 INPUT DATA FIELDS ............................................................................................... 139
14.1.1 Manufacturing ........................................................................................................... 139
14.1.2 [7.0.0] CC and SC ..................................................................................................... 141
14.1.2.1 Notes for SC and CC ................................................................................................ 142
14.2 CONFIGURATION OPTIONS ................................................................................... 142
14.2.1 Manufacturing ........................................................................................................... 142

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 14 of 226
SIEMENS Technical Document

14.2.2 [7.0.0] CC and SC ..................................................................................................... 144

14.3 MODULE NOTES ..................................................................................................... 145
14.4 COMMAND LINE ARGUMENTS .............................................................................. 147
14.5 EXAMPLES ............................................................................................................... 147
15. WORKFLOW MODE ................................................................................................ 148
15.1 INPUT DATA FIELDS ............................................................................................... 148
15.1.1 Workflow ................................................................................................................... 148
15.1.2 Other relevant fields .................................................................................................. 149
15.2 CONFIGURATION OPTIONS ................................................................................... 149
15.2.1 Workflow ................................................................................................................... 149
15.3 MODULE NOTES ..................................................................................................... 150
15.4 COMMAND LINE ARGUMENTS .............................................................................. 150
15.5 EXAMPLES ............................................................................................................... 150
15.5.1 Quick example .......................................................................................................... 150
15.5.1.1 Config file .................................................................................................................. 150
15.5.1.2 Data File .................................................................................................................... 151
16. [9.0.0] POM MODE ................................................................................................... 153
16.1 INPUT DATA FIELDS ............................................................................................... 153
16.1.1 Pom fields ................................................................................................................. 153
16.1.2 Parent fields .............................................................................................................. 154
16.1.3 System fields ............................................................................................................. 154
16.1.4 [14.10.0] ‘Object’ field................................................................................................ 154
16.2 [13.2.0] Object creation with TCTYPE_create_object .............................................. 155
16.2.1 Example to create a ContractWorkspace object ....................................................... 155
16.2.2 Complex Objects ....................................................................................................... 156
16.2.2.1 Example to create an item with revision and master forms ...................................... 156
16.2.3 Notes on creating Business Objects ......................................................................... 157
16.2.3.1 CreateInput properties .............................................................................................. 157
16.2.3.2 .BO_CI vs .CLASS and .FIND .................................................................................. 157
16.2.3.3 [14.7.0] .BO_CREATE vs .BO_CI ............................................................................. 157
16.2.3.4 No default attributes .................................................................................................. 158
16.2.3.5 .PROP vs .POM ........................................................................................................ 158
16.2.3.6 Restart Teamcenter .................................................................................................. 158
16.3 CONFIGURATION OPTIONS ................................................................................... 158
16.3.1 Pom ........................................................................................................................... 158
16.3.2 Other relevant options ............................................................................................... 159
16.3.2.1 [12.0.0] Object Propagation ...................................................................................... 160
16.4 MODULE NOTES ..................................................................................................... 161
16.4.1 General methodology of the pom mode.................................................................... 161
16.4.1.1 Introduction ............................................................................................................... 161
16.4.1.2 Finding objects .......................................................................................................... 161
16.4.1.3 Default values ........................................................................................................... 161
16.4.1.4 Create and Update option CSV lists ......................................................................... 161

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 15 of 226
SIEMENS Technical Document

16.4.1.5 Object references ...................................................................................................... 161

16.4.1.6 Replacing referenced objects ................................................................................... 163
16.4.1.7 Setting properties for convenience ........................................................................... 163
16.4.1.8 Setting system properties ......................................................................................... 163
16.4.2 Attaching to parent objects ....................................................................................... 163
16.4.2.1 [12.9.1] Updating parent objects ............................................................................... 164
16.4.3 Notes on creating a POM object ............................................................................... 164
16.5 COMMAND LINE ARGUMENTS .............................................................................. 165
16.6 EXAMPLES ............................................................................................................... 165
16.6.1 Creating/Updating Web Link forms ........................................................................... 165
16.6.1.1 Config file .................................................................................................................. 165
16.6.1.2 Data file ..................................................................................................................... 165
16.6.2 Creating/Updating CompanyLocation objects .......................................................... 165
16.6.2.1 Config file .................................................................................................................. 165
16.6.2.2 Data file ..................................................................................................................... 166
16.6.3 Update PSViewType Name ...................................................................................... 166
16.6.4 Creating a ScheduleTask and Schedule using .BO_CREATE ................................. 166
16.6.5 [14.9.0] Update occurrence UOM in all assemblies .................................................. 167
17. APPENDIX A: DATE FORMATTING SEQUENCES ............................................... 168
18. APPENDIX B: ITEMS MODULE EXAMPLES ......................................................... 170
19. APPENDIX C: BOM MODULE EXAMPLES ............................................................ 173
19.1 A simple BOM with ownership .................................................................................. 173
19.2 Unset sequence numbers ......................................................................................... 174
19.3 Reset sequence numbers ......................................................................................... 174
19.4 Pre delete by occurrence note .................................................................................. 175
19.5 Delete ALL occurrences ............................................................................................ 175
19.6 Set InContext AbsOccID ........................................................................................... 176
19.7 Set InContext AbsOccID in Parent Assembly only on low level components........... 178
19.8 Engineering change example ................................................................................... 179
19.9 Legacy Variants ........................................................................................................ 181
19.9.1 Config File ................................................................................................................. 181
19.9.2 Data File 1 ................................................................................................................. 182
19.9.3 Data File 2 ................................................................................................................. 183
19.9.4 Data File 3: Miscellaneous ........................................................................................ 185
19.9.5 Date File 4: Set If and Error If ................................................................................... 186
19.10 Modula Variants ........................................................................................................ 187
19.10.1 Config File ................................................................................................................. 187
19.10.2 Data File 1: Simple .................................................................................................... 188
19.10.3 Data File 2 ................................................................................................................. 188
20. APPENDIX D: FORMS MODULE EXAMPLES ....................................................... 189
21. APPENDIX E: LOV MODULE EXAMPLES ............................................................. 191
22. APPENDIX F: RELATIONS MODULE EXAMPLES ................................................ 192
22.1 Other 8.0.0 examples ................................................................................................ 193

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 16 of 226
SIEMENS Technical Document

23. APPENDIX G: DATASETS MODULE EXAMPLES ................................................. 198

24. APPENDIX H: FOLDERS MODULE EXAMPLES ................................................... 202
25. APPENDIX I: PROJECTS MODULE EXAMPLES .................................................. 203
26. APPENDIX J: CLASSIFICATION MODULE EXAMPLES ....................................... 204
27. APPENDIX K: IDENTIFIERS MODULE EXAMPLES .............................................. 206
28. APPENDIX L: MANUFACTURING MODULE EXAMPLES ..................................... 207
28.1 [7.0.0] CC / SC Example ........................................................................................... 212
29. APPENDIX M: MAJOR UPDATES .......................................................................... 214

TABLES
Table 1: Outline list of operation modes ............................................................................................... 19
Table 2: Command line options ............................................................................................................ 21
Table 3: [11.3.0] PUID input fields ........................................................................................................ 32
Table 4: List of modes than can use ‘Object’ field ................................................................................ 34

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 17 of 226
SIEMENS Technical Document

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 BOMs
o Forms
o List of Values (LOVs) (Prior to UA only)
o Relations
o Datasets
o Folders
o Projects
o Classification
o Identifiers
o Manufacturing (Including CC and SC objects and structures)
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, Solaris UNIX platforms and Linux. The various Unix builds will not be as
readily available as on Windows due to availability of platforms and VM images to build on.

1.1 Versioning
The IPS_DATA_UPLOAD executable version is made up like this:-

This document reflects any <MajorUpdate> and any <MinorToMediumUpdate>, but not a
<BugFix>.

So, in the document version the <BugFix> becomes a <DocFix>, where the <DocFix> is an
update to the document. This could be just some re-wording, or maybe adding some
description of old functionality that was previously missed out.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 18 of 226
SIEMENS Technical Document

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 and set and unset release statuses.
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 folders Used to import folders. Folders can be imported into folder
structures.
folder_create
folder_insert [13.0.0] New mode folders replaces folder_create and
folder_insert, though the old modes are still available.
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 GRM relationships defined in
Teamcenter.
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 since LOVs are defined in BMIDE.
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 1: Outline list of operation modes

The ability to use the ips_data_upload utility requires the following pre-requisites:

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 19 of 226
SIEMENS Technical Document

1. Knowledge of the Teamcenter Engineering/UA data model and 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. Teamcenter 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
Unrestricted Copyright © 2023 Siemens Digital Industries Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 20 of 226
SIEMENS Technical Document

OPTION DESCRIPTION
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 output when running. Can be
any of the following: 1|2|4|8|16|32 | MAX
Typically this is set to MAX.
Alternatively set the following environment variables:-
set DEBUG_MAX=1
set DEBUG_FILE_NAME=<debug_file>
See section 3.3 for further details on debugging.
-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.
See the trouble shooting section on [8.1.0] Field Validation.
-validation_import [8.1.0] If supplied turns on import with field validation.
See the trouble shooting section on [8.1.0] 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.
-batch_size [14.0.0] Specifies the number of data lines (so ignoring
config lines and header line) to process in a batch. Use
with -start_line or -batch_no.
-start_line [14.0.0] Specifies the data line number to start processing
a batch from. Use with -batch_size.
For example, if the batch size is 100 and the start line is
201, then lines 201 to 300 will be processed.
-batch_no [14.0.0] Specifies the batch number to process. Use with -
batch_size.
For example, if the batch size is 100 then batch number 3
is from line 201 to 300.

Table 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>.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 21 of 226
SIEMENS Technical Document

2.3 INPUT DATA FILE

The input data file contains all of the information to be imported into Teamcenter
Engineering/UA. Generally the data file contains optional configuration options; a header
line defining the fields to import which either contain internally known keywords, e.g. ItemID,
Owner, Group, or generic <type>:<property> strings, e.g. Item:object_name; and data
lines containing the values to set for each field defined in the header.
[14.0.0] A default values header line and data line can now be supplied for any fields to set
default values so that they don’t have to be supplied with every main data line. See section
2.3.4 - [14.0.0] Setting default values for full details.
This header and data lines are delimited, 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. [14.0.0] A default values header line, denoted with ‘^’, must be supplied before the
default values data line, which must immediately follow the default values header
line.
3. [14.0.0] A defaults header line and data line must come before the main header
line.
4. 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 [!].
5. The delimiter used in the input data file is identified as the character immediately
following the exclamation mark [!] on the header line.
6. The name of the data fields to use are specified immediately after the exclamation
mark and delimiter on the header line [!~].
7. Field names are either internally known key fields or general properties (colon
fields) defining an object type or class to match and the Tc property or attribute
name to set on that object. Fields can also have options modifier options separated
by a dot, e.g.:-
!~ItemID.TAG~RevID~*:owning_group.PROPAGATE
8. 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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 22 of 226
SIEMENS Technical Document

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 to.
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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 23 of 226
SIEMENS Technical Document

OPTION OBJECT
MEPRREV MEProcessRevision
MEOP MEOperation
MEOPREV MEOperationRevision
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. [12.0.0] This should no longer
be required, just the user ID, e.g. tim, should suffice. This along with other system properties,
e.g. owning_group, project_list that cannot be set with general property functions are trapped
and set using dedicated ITK functions.
[14.14.0] Added the ability for the property owning_user to be supplied as <user><multi-
sep><group>, e.g. tim,Engineering. This way both values get set at once.

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 24 of 226
SIEMENS Technical Document

OPTION DESCRIPTION
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
.UPPER Forces the value to be set as UPPER CASE.
.LOWER Forces the value to be set as lower case.
.BRACKET_VALUE [14.7.0] Extracts a value surrounded with round brackets.
For example a user property extracted from Tc and re-used as input for
the owning_user property:-
Tim Williams (tim)
Will extract tim as the value to set as the owning_user.
.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, .GROUP_MEMBER or
.RESOURCE_POOL.
By default the first data line will replace existing participants and
subsequent lines will append further participants.
[12.9.0] Can add the .APPEND field modifier to always append to
existing participants.
[NOTE] Without .APPEND then ALL current participants, even with
mixed participant types, will be replaced.
[14.6.0] Changed the default behaviour to be APPEND and added
extra control, thus:-
Now adds by default, instead of replace all.
Added new field modifier .REPLACE_ALL if do need to replace all.
Using .REMOVE will remove participant of specified type.
Using .REPLACE will replace all participants of the specified type.
.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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 25 of 226
SIEMENS Technical Document

OPTION DESCRIPTION
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
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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 26 of 226
SIEMENS Technical Document

OPTION DESCRIPTION
.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.
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.
NOTE 2: [12.6.0] If the class of object being searched for is descended
from Item or ItemRevision then the key fields ItemID and RevID can be
Unrestricted Copyright © 2023 Siemens Digital Industries Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 27 of 226
SIEMENS Technical Document

OPTION DESCRIPTION
used to find an item or rev. E.g.:-
Object.FIND=ItemRevision,ItemID,RevID
NOTE 3: [12.7.0] Separate fields can now be supplied to define the
.FIND class and attributes. See next row.
.FIND=<FieldID> [12.7.0] This is an alternative way of using the .FIND field modifier, to
that described in the previous row, which allows multiple fields to be
~<FieldID>:<Attr> used instead of supplying all values in one delimited field.
With this option a single Field Identifier value, which can be anything, is
supplied with the .FIND after an =’s sign, as opposed to a class and
attribute list.
The class to search on is supplied as the value for the .FIND field.
Additional fields are then supplied with the format:-
<FieldID>:<Attr>
Where the value is the attribute value to search on.
With this method the previous example can be defined as:-
I:project_list.POM.FIND=FindProject~FindProject:project_id~Find
Project:project_name
TC_project~Test *~Test
.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.
.KEY=<FieldID> [12.7.0] For property fields, and the EffEndItem field, requiring an item
to be found using MFKs the .KEY can be supplied with a Field Identifier
to find fields that specify the attributes and values to use to find an
MFK item. The value of the .KEY field must supply the item ID.
For example:-
EffEndItem.KEY=FindMFKItem~FindMFKItem:object_type~FindMF
KItem:my4_mfk_str_key1
M000001~MY4_MFK_Tag_Item~val1
.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 field can be used as well as or
instead of the fields specified with the BOM UPDATE ID FIELDS
configuration option
.PROPAGATE [12.0.0] Identifies fields to be set on propagated objects when using
PROPAGATION PATHs. These fields should also be set as colon
fields with the object type of *, e.g.:-
*:owning_user.PROPAGATE
See the section 2.8 for full details on propagating values to objects
under the current object being updated, e.g. item or rev.
TABLE_NAME [14.2.0] Specifies a name for a set of table column attribute fields to
set data on a table attribute, where the table column attributes are
specified as the properties with the table name as the type code.
The TABLE_NAME field, can also have a TABLE_COL modifier to
specify the first column name.
Unrestricted Copyright © 2023 Siemens Digital Industries Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 28 of 226
SIEMENS Technical Document

OPTION DESCRIPTION
The TABLE_NAME field is the master field for the object’s table
attribute.
Example:-
R:sub7_cost.TABLE_NAME=R_sub7_cost.TABLE_COL=sub7_discipl
ine.FIND=IPP2CostCategory,object_name~R_sub7_cost:sub7_mh~R
_sub7_cost:sub7_obsSkills
See section 2.3.5 - [14.2.0] Setting table attributes for full details.
TABLE_COL [14.2.0] Specifies a table column attribute name to be set for a
specified table name. Can be used on TABLE_NAME field, if required,
to specify a table column attribute.
See section 2.3.5 - [14.2.0] Setting table attributes for full details.

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
created or updated.
For example, to look for CompanyLocation objects using name
and type:-
!~CompanyLocation:object_name.KEY~CompanyLocation:objec
t_type.KEY
The attribute pid can be set as the KEY field to find an object by
its tag (Unique ID or PID).
.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
Unrestricted Copyright © 2023 Siemens Digital Industries Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 29 of 226
SIEMENS Technical Document

OPTION DESCRIPTION
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.
.BO_CI [13.2.0] This is like the .CLASS modifier above. But, where the
.CLASS is used to define a referenced object the .BO_CI is used
to specify a Create Input property, that is not a storage property
of the parent object.
An example is the revision Create Input property for Item,
where revision is not a storage property for Item.
.BO_CREATE [14.7.0] This is used the same as .BO_CI (described above), but
immediately creates the referenced object as opposed to only
pre-defining it and it getting created when the main object is
created.
Unfortunately trial an error will have to be used to determine
which to use. So try one option, then if it fails try the other.
For examples though, for items and revisions (which must both
exist and be related) .BO_CI is used.
Whereas for ScheduleTask and Schedule objects .BO_CI fails
and .BO_CREATE is required, maybe because a Schedule can
exist with a ScheduleTask..

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 30 of 226
SIEMENS Technical Document

2.3.2.4 [12.7.0] Custom Field Identifiers

Version 12.7.0 has introduced the concept of some field modifiers providing custom Field
Identifiers to indicate other fields that specify information to complete the action for that
field modifier.
Currently the field modifiers supporting Field Identifiers are .FIND and .KEY. The format is:-
.FIND=<FieldIdentifier>
.KEY=<FieldIdentifier>
The <FieldIdentifier>, which can be any string, is used the same as an OBJECT type code,
like I:, to find fields in the format:-
<FieldIdentifier>:<attribute>
For both the .FIND and .KEY modifiers the field headers provide attribute names to search
on and the data line contains the attribute value.
This feature is currently limited to:-
• Setting general properties on objects where the property requires an item to be found
using MFKs or some other object needs to be found using .FIND.
• When the .KEY modifier is used to find main objects use the standard .KEY format,
i.e. with no FieldIdentifier. The .FIND can also be used to locate objects for an
attribute that is an MFK attribute, i.e. a tag reference attribute.
• The EffEndDate field has specific functionality to find objects using this new .FIND
and .KEY functionality.
Example for EffEndDate field:-
Note: this is not a full header line! All the fields here are just to find an End Item using MFK
attributes where one attribute is a tag reference for which .FIND has been used.
EffEndItem.KEY=FindMFKItem~FindMFKItem:object_type~FindMFKItem:my4_mfk_str_k
ey1~FindMFKItem:my4_mfk_tag_company_loc.FIND=GetLocFIND~GetLocFIND:object_n
ame
M000001~MY4_MFK_Tag_Item~val1~CompanyLocation~loc1
Here the EffEndItem field is using .KEY with a field identifier named FindMFKItem which
has 3 fields defined. The EffEndItem field supplies the item ID M000001 and the 3 named
fields supply the MFK attributes to search on. Where the last field uses .FIND with a field ID
of GetLocFIND, for which there’s 1 field to define the attribute object_name to search on.

2.3.3 [11.3.0] Supplying PUIDs (tags) for Input fields

Starting with version 11.3.0 support has been added to specify PUIDs (or tags) to specify input
objects to update by adding the field modifier .TAG to the existing field names or using the pid
attribute on pom mode. The table below shows where this functionality has been added:-

VERSION MODE FIELD / DESCRIPTION

11.3.0 datasets DsetName.TAG
Specifies the tag of a dataset to update.
12.0.0 Pom <Class>.pid.KEY
Specifies the class and tag of an object to update.
12.0.0 Items ItemID.TAG and RevID.TAG
To specify an Item and /or Rev tag to updates.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 31 of 226
SIEMENS Technical Document

Table 3: [11.3.0] PUID input fields

2.3.4 [14.0.0] Setting default values

A default values header line and data line can now be supplied for any fields to set default
values so that they don’t have to be supplied with every main data line. These can be
supplied in the data file or the config file.
In the data file the default values header line is identified by a carat (^) at the start of the line
in the same way that the exclamation mark [!] identifies the main header line.
The default values header line must be supplied before the default values data line, which
must immediately follow the default values header line.
The defaults header and data lines must come before the main header line.
Alternatively the configuration options DEFAULT VALUES HEADER LINE and DEFAULT
VALUES DATA LINE can be used instead of a defaults header line and data line.
The defaults header line can duplicate fields specified in the main header, in which case a
value specified in the main data line will be used, but if blank will be replaced with the
default value. For this to happen the header fields must match exactly, as only a different
field modifier is required to treat the fields as separate. But, this can be useful to set a
property twice, maybe to clear a value first and then set a new value.
If a property needs to be provided twice, e.g. to clear the property and then set it, but with
exactly the same field header then the field will have to be added to the main header line
twice and two values supplied in the data lines. See example 2 below where a default
license_list field is set in the config file, but the gov_classification field is supplied twice in
the main header line as each field is exactly the same.
Example 1:-
# Set some defaults value
^~RM:project_id~RM:user_data_1~I:project_ids
Project Y~UD1~Project Y

!~ItemID~RevID~Desc~RevDesc~I:last_mod_date~I:creation_date
MAND-001~A~Item Desc~Rev Desc A~16-Mar-2018 10:00~15-Mar-2017 11:00

Example 2:-
DEFAULT VALUES HEADER LINE = (Item):license_list.REMOVE.PROPAGATE
DEFAULT VALUES DATA LINE = PSA-A

!~ItemID~(Item):license_list.PROPAGATE~(Item):gov_classification.PROPAGATE~
(Item):gov_classification.PROPAGATE
000226~PSA-B~NULL~UK OFFICIAL-SENSITIVE - NEED-TO-KNOW

2.3.5 [14.2.0] Setting table attributes

Table attributes require the name of the table property defined against an object, e.g. an
item or revision, and then the column attributes defined against the table. It’s these column
attributes that then have data defined in the data lines.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 32 of 226
SIEMENS Technical Document

If the TABLE_COL modifier is not used on the TABLE_NAME field then leave the data
value blank. When supplying TABLE_COL with the TABLE_NAME field and additional field
modifiers act on the table column attribute. If the TABLE_COL modifier is not added, then
additional modifiers act on the objects’ table attribute.
All normal and appropriate modifiers can be used with the table attribute fields to help set
data on table column attributes.
[14.15.0] Support has been added for the .MAND modifier on TABLE_COL fields to enable
addition of new table rows that have mandatory attributes defined.
However if specify any .MAND fields are specified for table attrs then the .TABLE_COL
modifier must not be used on the TABLE_NAME field. And instead of the TABLE_NAME
field value being blank it must specify the name of the table the attribute is linked to.
For example to set mandatory attributes on the table TW4_MandTRow:-
!~ItemID~Name~ItemType~R:sub7_attr_table.TABLE_NAME=MandTRow~MandTRow:su
b7_tpw_attr_int.MAND~MandTRow:sub7_tpw_attr_str.MAND
#00000546~Mand T Row test~TW4_MandTRow~TP4_Test_Table~10~ten
00000546~Mand T Row test~ TW4_MandTRow~TP4_Test_Table~10,20~ten,twenty

2.3.5.1 Replacing and Appending table attribute rows

Currently IPS Data Upload can only replace all existing values or append to them. If
replacing, this will only occur for the first data line for a given object if the same object key
data, e.g. ItemID and RevID is re-supplied. So multiple lines can be supplied to append
additional table attribute rows.
Note that additional data lines for the same object will also update all other property fields
supplied for each data line, unless their values are left blank.
Multiple values can also be supplied in one data line using a separator. By default the
separator is a comma (,), but the configuration option TABLE ATTR VALUE SEP can be
used to supply a different separator.
To only append new values the TABLE_NAME field needs to have the .APPEND field
modifier added, e.g.:-
R:sub7_cost.TABLE_NAME=R_sub7_cost.APPEND

2.3.5.2 Examples - Setting Table Attributes

Example 1 – Replace values and using TABLE_COL

The following example sets 3 rows of data, with three columns, on a table attribute defined
on the revision:-

TABLE ATTR VALUE SEP = #

!~ItemID~Name~ItemType~R:sub7_cost.TABLE_NAME=R_sub7_cost.TABLE_COL=sub7_discipli
ne.FIND=IPP2CostCategory,object_name~R_sub7_cost:sub7_mh~R_sub7_cost:sub7_obsSkills
00004001~20" Plet - Design Basis: AWP~SUB7_ActWrkPkg
~TimWCostTest1#TimWCostTest2#TimWCostTest1~38#28#18~STRUCTURAL
DESIGN#GEOTECHNICS#PROJECT ENGINEERING MANAGER

This example is setting values for the revision’s sub7_cost table attribute and specifying a
table name of R_sub7_cost. The same field is also defining a table column attribute, using

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 33 of 226
SIEMENS Technical Document

TABLE_COL, of sub7_discipline with the addition of the .FIND modifier to find an object of
class IPP2CostCategory to set against this (typed reference) table column attribute.
There are two additional fields defined for the table name of sub7_mh and sub7_obsSkills.
This example specifies all values on the one data line using the table attribute value
separator ‘#’.
Example 2 – Appending and not using TABLE_COL
Here’s the same example, but not using TABLE_COL and with the addition of .APPEND to
only append table rows and not replace any existing values:-
TABLE ATTR VALUE SEP = #
!~ItemID~Name~ItemType~R:sub7_cost.TABLE_NAME=R_sub7_cost.APPEND~R_sub7_cost:sub
7_discipline.FIND=IPP2CostCategory,object_name~R_sub7_cost:sub7_mh~R_sub7_cost:sub7_ob
sSkills
00004001~20" Plet - Design Basis: AWP~SUB7_ActWrkPkg~~Lead
Engineer#TimWCostTest2#Project Engineering Manager~33#43#53~STRUCTURAL
DESIGN#GEOTECHNICS#PROJECT ENGINEERING MANAGER
Note the blank value for the TABLE_NAME field and the extra field for the first table column
attribute sub7_discipline.

2.3.6 [14.2.0] General ‘Object’ field

In version 13.0.0 a general Object field header was added to find objects to attach to folders
in folder mode. It is used in conjunction with the .FIND or .TAG field modifiers to search for
an object (or sometimes objects) or specify an object’s PUID.
In 14.2.0 use of this field has been extended to other modes to find objects. It can be used
with the following modes:-
OPTION DESCRIPTION
datasets Used to find a parent object.
folders Used to find an object or objects to attach to folders.
forms Used to find a parent object.
relations Used to find parent objects in conjunction with .PARENT and child
objects with .CHILD.

Table 4: List of modes than can use ‘Object’ field

2.3.6.1 ‘Object’ Examples

datasets: Find a parent to create/update a dataset under:-

RELATION NAME = IMAN_reference

!~Object.FIND=IPP2CostCategory,object_name~DsetName~DsetType~FileRef~File
TimWCostTest1~%object_name%~Text~Text~file1.cfg

relations: Find parent and child objects to paste or cut a GRM relation:-
RELATION NAME = IMAN_reference

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 34 of 226
SIEMENS Technical Document

!~Object.PARENT.FIND=IPP2CostCategory,object_name~Object.CHILD.FIND=IPP2CostCategory,
object_name
TimWCostTest1~TimWCostTest

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 35 of 226
SIEMENS Technical Document

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, TOP FOLDER FOR LOGIN USER
ONLY = ON 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

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 36 of 226
SIEMENS Technical Document

FIELD DESCRIPTION
OUTPUT COL SIZE TYPE [6.9.0] These three options can be used to control the size
OUTPUT COL SIZE NAME of the output columns for the Type, Name and Status
columns respectively. Simply set them to the number of
OUTPUT COL SIZE characters required in the column.
STATUS
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.
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.
See the trouble shooting section on [8.1.0] Field Validation.
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 a
SEPARATOR .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 a
VALUE SEPARATOR .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
Unrestricted Copyright © 2023 Siemens Digital Industries Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 37 of 226
SIEMENS Technical Document

FIELD DESCRIPTION
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.
PROPAGATION PATH [12.0.0] Specifies a dot formatted set of type / relation paths
to find objects under other objects for updating.
This option can be supplied as many times as required to
provide multiple paths for different types of objects.
This option works in conjunction with fields identified with
the field modifier .PROPAGATE which indicates which field
values are to be propagated.
This option does not replace existing OOTB propagation
rules so should be used to propagate values to objects not
propagated by any defined Tc rules.
See section 2.8 - [12.0.0] Object Propagation for full details
on propagation paths.
PROJECT LIST UPDATE [12.2.0] Specifies how to update existing projects assigned

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 38 of 226
SIEMENS Technical Document

FIELD DESCRIPTION
OPTION to objects, Available options are:-
APPEND Appends to existing projects (Default)
REPLACE Replaces all existing projects with those
provided.
REMOVE Removes provided projects from existing
projects.
PROJECT LIST POR [12.2.0] ON | OFF flag to control if ProjectObjectRelation
CLEANUP (POR) objects should be removed from lower level objects
during a propagation traversal.
BATCH SIZE [14.0.0] Specifies a batch size for an import, i.e. the number
of data lines to be processed. Once reached the import will
stop.
See section 2.5.1 - [14.0.0] Batch processing for full details
on batching.
NOTE: This option behaves slightly different if used in a
data file since it gets read after log and repeat files have
already been created.
DEFAULT VALUES HEADER [14.0.0] Specifies a default values header line, with or
LINE without a preceding carat [^]. This can also be specified as
a single header line in the data file using the carat [^].
See section 2.3 – INPUT DATA FILE for further details.
DEFAULT VALUES DATA [14.0.0] Specifies a default values data line. This can also
LINE be specified as a single data line in the data file immediately
following the default values header line.
See section 2.3 – INPUT DATA FILE for further details.
TABLE ATTR VALUE SEP [14.2.0] Specifies a separator between data values for a
table column attribute field.
See section 2.3.5 - [14.2.0] Setting table attributes for full
details.
REGISTER APPLICATIONS [14.3.0] Used to provide a CSV list of additional internal Tc
Applications to register if needed. During pom mode
imports classes will automatically have their application
checked to see if it’s already registered.
This functionality was added to set the Application
SCHMGTV100 in order to update ScheduleTask objects.
SET EMPTY FIELDS TO [14.4.0] ON | OFF flag to control if empty field values should
NULL set properties to NULL, i.e. actually blank properties.
The default is OFF, which is the previous behaviour where
empty values are ignored.
NOTE: This applies to colon properties.
ALLOWED MAC ADDRESSES [14.9.0] Used to specify a secured file containing MAC
FILE address, one per line, of machines that are allowed to run
IPS Data Upload.
If the current machine’s MAC address is not found in the list
then IPS Data Upload will exit with no processing.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 39 of 226
SIEMENS Technical Document

FIELD DESCRIPTION
The MAC addresses should be entered in the file in dash
format, e.g.:-
00-0C-29-77-1C-62

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 TC_ROOT=C:\APPS\TCENG0913
C:\>SET TC_DATA=\\SERVER\SHARE\iman_data
C:\>%TC_DATA%\iman_profilevars
C:\> ips_data_upload_tc10_1_64bit_nti_12_0_0.exe –u=infodba –
p=infodba –i=<data_file_name> –cfg=<config_file_name> –m=<mode> -v

2.5.1 [14.0.0] Batch processing

Previously all batch processing of a large import file needed to be completely done via
management scripts. This included splitting a large data file into smaller chunks to help with
memory issues and caching slowdowns when a process has been running for a long time.
The script would then have to call IPS Data Upload for each split file.
With version 14.0.0 there are three new arguments to help with this by setting a batch size
and either a data line start position or a batch number. With these options the same master
data file can be processed each time without the need to split it into smaller files.
The main control option to trigger batch control is -batch_size=<batch_size> to set the
number of data lines to be processed, so ignoring any configuration lines, the header line
and any blank or comment lines.
Then there’s the option of either specifying a data line number to start at using
-start_line=<start_line>, or a batch number using -batch_no=<batch_no>.
This can also be used to run a small test, e.g. to just run the first 5 lines set a batch size of 5
and a batch number, or start line, of 1:-
C:\> ips_data_upload_tc10_1_64bit_nti_13_4_0.exe –u=infodba –
p=infodba –i=<data_file_name> –cfg=<config_file_name> –m=<mode> -v
-batch_size=5 -start_line=1

When using the batch options any log files (but not the debug file) and the repeat file will
have the batch size and the start line or batch number appended to the file name, e.g.
items_5_1.log, items_5_1.rep. A batch control script would need to control the name of the
debug file if required.

2.5.1.1 Automated Batching

An automated batching functionality will activate if only a batch size is provided, either from
the -batch_size argument or the BATCH SIZE config option supplied in either the config file
or the data file.
Unrestricted Copyright © 2023 Siemens Digital Industries Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 40 of 226
SIEMENS Technical Document

Though if the BATCH SIZE is supplied in the data file the batch size will be read after the
log and repeat file have been created, and after entries have already been written to the log
file. In this case the existing log and repeat files will be closed, renamed and re-opened.
With auto batching the log and repeat file names will include the batch size, the starting data
line number and a date string. The date string has been added to reduce potential problems
trying to rename the log and repeat files to file names that may already exist should a re-run
be performed.
The automated batching mechanism works by creating a BATCH STOP file, called
IDU_BATCH_STOP.TXT, when there are still lines to be processed. This file contains the
next start line and will be read if it exists. On processing the last data line in the file the
BATCH STOP file will be deleted. The BATCH STOP files gets created in the current
directory.
Messages will be written about actions performed on the BATCH STOP file, e.g.: -
First run
Creating BATCH STOP file 'IDU_BATCH_STOP.TXT' to start at line 6.
Reached end of batch! Stopping processing on data line 5 (file line 19)!
Last run
Found BATCH STOP file 'IDU_BATCH_STOP.TXT'.
[BST] BATCH START LINE = [6]
…
Removed BATCH STOP file 'IDU_BATCH_STOP.TXT'.

2.5.1.1.1 Example auto batch scripts

The following script examples are for Windows only.
The first script simply calls a second script that controls the looping which in turn calls a third
script to perform the import.
Script 1 – Initiate auto batch with supplied data file, config file, mode and batch size
call ..\run_tc10_1_BATCH_AUTO.bat items.txt items.cfg items 5

Script 2 ..\run_tc10_1_BATCH_AUTO.bat – Control the auto batch looping by the

existence of IDU_BATCH_STOP.TXT.
SET IDU_SCRIPT_DIR=%~dp0
SET IDU_SCRIPT=%IDU_SCRIPT_DIR%\run_upl_tc101_64bit.bat

SET IDU_DATA=%1
SET IDU_CFG=%2
SET IDU_MODE=%3
SET IDU_BATCH_SIZE=%4

SET IDU_BATCH_COUNTER=1

call %IDU_SCRIPT% %IDU_DATA% %IDU_CFG% %IDU_MODE% %IDU_BATCH_SIZE%

REM goto END

:GOTBATCH

if EXIST IDU_BATCH_STOP.TXT (
SET /A IDU_BATCH_COUNTER=IDU_BATCH_COUNTER+1
SET IDU_BATCH_COUNTER

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 41 of 226
SIEMENS Technical Document

call %IDU_SCRIPT% %IDU_DATA% %IDU_CFG% %IDU_MODE% %IDU_BATCH_SIZE%

goto GOTBATCH
) else (
goto END
)

:END

SET IDU_BATCH_COUNTER=

echo.
echo ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
echo B A T C H I N G F I N I S H E D
echo ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
echo.

Script 3 run_upl_tc101_64bit.bat – Perform the import

@echo off

rem set TC_KEEP_SYSTEM_LOG=1

set DEBUG_MAX=1
set Verbose=-v
set Verbose=

set ReportFile=-report_file=report_file.txt
set ReportFile=

set Validation=-validation=1 -validation_import

set Validation=-validation=2
set Validation=

set UPG=-u=infodba -p=infodba -g=dba

REM DEVELOPMENT VERSION...

set Prog_dir=%~dp0exe

set Prog=%Prog_dir%\ips_data_upload_tc10_1_64bit_nti_13_4_0.exe

REM --------------------------------------------------
REM Turn all BMIDE rules etc.
REM --------------------------------------------------
SET NR_BYPASS=ON

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 42 of 226
SIEMENS Technical Document

SET IMAN_BYPASS_CANNED_METHODS=ALL
SET BYPASS_RULES=ON
SET Bypass_property_rules=1
SET BMF_BYPASS_ALL_EXTENSION_RULES=ON

SET IMAN_BYPASS_CANNED_METHODS=
SET BYPASS_RULES=
SET Bypass_property_rules=
SET BMF_BYPASS_ALL_EXTENSION_RULES=
REM --------------------------------------------------

echo Prog = $Prog

echo Args = %*

set InFile=%1
set Cfg=%2
set Mode=%3
set Option=%4
set Option2=%5
set Option3=%6

echo
echo File = %InFile%
echo Cfg = %Cfg%
echo Mode = %Mode%
echo Option = %Option%
echo Option2 = %Option2%
echo Option3 = %Option3%
echo

set NewIdsFile=""
set BatchSize=
set StartAt=
set BatchID=
set BatchSizeVal=
set StartAtVal=
set BatchIDVal=

if "%Option%" == "NEW_IDS_FILE" (

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 43 of 226
SIEMENS Technical Document

set NewIdsFile=-new_items_ids_log=new_item_ids.txt
) else (
set BatchSizeVal=%Option%
)

if "%Option2%" == "0" (
set BatchIDVal=%Option3%
) else (
set StartAtVal=%Option2%
)

if NOT "%BatchSizeVal%" == "" set BatchSize=-batch_size=%BatchSizeVal%

if NOT "%StartAtVal%" == "" set StartAt=-start_line=%StartAtVal%
if NOT "%BatchIDVal%" == "" set BatchID=-batch_no=%BatchIDVal%

echo BatchSize = %BatchSize%

echo StartAt = %StartAt%
echo BatchID = %BatchID%

if NOT "%IDU_BATCH_COUNTER%" == "" (

set LOG_FILE=%Mode%_log_%IDU_BATCH_COUNTER%.txt
set TRACE_LOG=trace_tc10_1_%Mode%_%IDU_BATCH_COUNTER%.log

) else if NOT "%StartAtVal%" == "" (

set LOG_FILE=%Mode%_log.txt
set TRACE_LOG=trace_tc10_1_%Mode%_%StartAtVal%.log

) else if NOT "%BatchIDVal%" == "" (

set LOG_FILE=%Mode%_log.txt
set TRACE_LOG=trace_tc10_1_%Mode%_%BatchIDVal%.log

) else (
set LOG_FILE=%Mode%_log.txt
set TRACE_LOG=trace_tc10_1_%Mode%_log.txt
)

echo DEBUG_MAX = %DEBUG_MAX%

echo

echo.
echo %Prog% %UPG% -m=%Mode% -cfg=%Cfg% -i=%InFile% -o=%LOG_FILE% -noautologin

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 44 of 226
SIEMENS Technical Document

%Verbose% %ReportFile% %Validation% %NewIdsFile% %BatchSize% %StartAt% %BatchID%

echo.
%Prog% %UPG% -m=%Mode% -cfg=%Cfg% -i=%InFile% -o=%LOG_FILE% -noautologin
%Verbose% %ReportFile% %Validation% %NewIdsFile% %BatchSize% %StartAt% %BatchID% 2>
%TRACE_LOG%

rem pause

This last script for performing the import accepts an optional fourth argument to specify the
batch size and additional optional arguments to specify a start line and batch id, where the
batch id will be used if the start line is 0.

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 in 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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 45 of 226
SIEMENS Technical Document

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.
[14.17.0] The mfg mode now supports MultiField Keys either by using .KEY fields or item
MFK strings. This is for all mfg fields that search for an item.
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
M000001~A~PW6_MFK_TestType~val1~M000001~A~PW6_MFK_Type2~val2~20
M000001~A~PW6_MFK_TestType~val1~M000001~A~PW6_MFK_Type2~val2~20
M000001~A~PW6_MFK_TestType~val1~M000001~A~PW6_MFK_Type2~val1~10
M000001~A~PW6_MFK_TestType~val2~M000001~A~PW6_MFK_Type2~val1~10

2.7.3 [12.7.0] KEY field Identifier

In version 12.7.0 the .KEY field modifier was enhanced to take an identifier that is then used
to find other fields that contain the other values to fully define the KEY values to find an item.
The syntax is:-
<MainFieldName>.KEY=<MyIdentifier>~<MyIdentifier>=<mfk_attr1>~<MyIdentifier>=<mfk_
attr1>~…
Note 1: The <MainFieldName>.KEY field must contain the item ID.
Note 2: MyIdentifier must be unique for the set of fields to identify an item and must not be
same as a known IPS Data Upload field name keyword.

2.7.3.1 Supported fields

FIELD NAME VER EXAMPLE

EffEndItem 12.7.0 The following example sets the KEY Identifier as FindMFKItem and
provides 3 MFK fields for this identifier, the last of which uses
.FIND=<FindIdentifier> to find a Company Location object:-
…~EffEndItem.KEY=FindMFKItem~FindMFKItem:object_type~FindM
FKItem:my4_mfk_str_key1~FindMFKItem:my4_mfk_tag_company_loc.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 46 of 226
SIEMENS Technical Document

FIND=GetLocFIND~GetLocFIND:object_name
…~M000001~MY4_MFK_Tag_Item~val1~CompanyLocation~loc1
SubstChildID 13.1.0 The following example sets the KEY Identifier as MySubstItem and
provides 2 MFK fields for this identifier:-
!~ItemID~RevID~ChildID~SeqNo~SubstChildID.KEY=MySubstItem~M
ySubstItem:object_type~MySubstItem:my4_mfk_key1.KEY
000058~A~000059~1~M000001~MY4_MFK_Str_Item~val1
Alternates 13.1.0 The following example sets the KEY Identifier as MyAltItemID and
provides 2 MFK fields for this identifier:-
!~ItemID~RevID~ChildID~SeqNo~Alternates.KEY=MyAltItemID~MyAltI
temID:object_type~MyAltItemID:my4_mfk_key1.KEY
000058~A~000060~1~M000001~MY4_MFK_Str_Item~val1
I:global_alt_list 14.17.0 This special property field can use .KEY, .FIND or item MFK fields to find
one or multiple items.
ProcID 14.17.0 All mfg fields that look for an item now support using .KEY fields or an
item MFK string..
ProductTargetID
PlantTargetID
WorkID
OpID

2.7.4 Item MFK string

Some item ID fields also support an item MFK string which is a comma separated list of
attribute and value pairs, for example:-
item_id=M000001,object_type=MY4_MFK_Str_Item,my4_mfk_key1=val1

2.7.5 [14.17.0] .KEY plus .PROP

Previously fields using .KEY to find items couldn’t be used to find items for general
properties to be set as properties on other objects. But from 14.17.0 the .PROP modifier
can be used in addition to .KEY to find items to set as properties.
Currently, though, this is only supported on the field I:global_alt_list, for example:-
!~ItemID~I:global_alt_list~I:global_alt_list.KEY=GA1.PROP~GA1:object_type~I:global_alt_li
st.KEY=GA2.PROP~GA2:object_type
0405000~NULL~000084~Item~000083~Item

2.7.6 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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 47 of 226
SIEMENS Technical Document

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 48 of 226
SIEMENS Technical Document

2.8 [12.0.0] Object Propagation

The main new feature added in version 12.0.0 is the addition of the configuration option
PROPAGATION PATH which can be supplied as many times as required to provided dot
formatted type.relation paths to find objects under other objects to update values specified
by any field that has the .PROPAGATE field modifier.
Currently object propagation is supported from items and revisions, and key objects
specified using the pom mode.

2.8.1 Propagation Fields

All propagation fields need to be specified as a colon field and by adding the .PROPAGATE
field modifier. Since a field can be used to update several object types then a field type of
“*” can be used, e.g.:-
!~ItemID~*:Group.PROPAGATE~*:owning_project.PROPAGATE.FIND=TC_Project,project_id
This example will set Group and owning_project on any object found during propagation.
However, a specific class (in brackets) or type can also be used to match on specific objects
found during the propagation, e.g.:-
!~Folder:pid.KEY~Folder:owning_user.PROPAGATE~Folder:Group.PROPAGATE
QRQZ4itkqGvuWB~infodba~dba
This example will set owning_user and Group on the main Folder object, using pom mode,
and any objects of type Folder found under the main Folder if a PROPAGATION PATH is
set to find Folders under Folders, e.g.:-
PROPAGATION PATH = (Folder_).ATTR=contents.(Folder_):PROPAGATE

2.8.2 Propagation path format

The general format of a PROPAGATION PATH is a set of type and relation strings
separated by a dot, thus:-
<TypeString>.<RelationString>.<TypeString>.<RelationString>…
A path can end at any time on either a TypeString or RelationString. The full format is:-
<type|(Class[_])>[:UPDATE][:PROPAGATE][.GRM=<GRM>|Revisions[:<REV_RULE=<Rev
_Rule>]|.ATTR=<attr>|.PROP=<prop>][<type>…]
Each type of string has a basic definition, of an object type, class or relation type followed by
options separated by colon.

2.8.2.1 Propagation Type String

The TypeString acts as an object type filter and the format of a TypeString is:-
<type|(Class[_])>[:Option[:Option]] | *
So the basic format of a TypeString is either an object type, or a class name surrounded in
round brackets. If a class name is supplied then a following underscore can be added to
indicate that an object should be descended from the specified class.
For example Item or Design would be used to match specifically on objects of type Item or
Design. Whereas (Item) would be used to match on objects of class Item and (Item_)
would match on objects descended from the class of Item.
If the TypeString is an asterix (*) then all objects will be matched and processed.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 49 of 226
SIEMENS Technical Document

The first TypeString in a path is used to identify paths to use for the current object being
processed and will be processed after all other fields and existing functionality has been
carried out for that object. So, for example, when an item is being updated the propagation
will look for all propagation paths starting with a type string that will match the item by type
or class, e.g. (Item_). All subsequent TypeStrings will act as filters from the preceding
RelationString in the path.

2.8.2.1.1 Type String Options

The following options are available for a TypeString:-

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 50 of 226
SIEMENS Technical Document

OPTION DESCRIPTION
UPDATE As a propagation path is processed objects are found at each level, starting with
the main object, then relations and then a filtered set based on the type or class of
the related objects.
This UPDATE option indicates that the objects found at a particular level should be
updated. By default the objects found at the last level of a path will be updated
anyway, so the UPDATE is only required on intermediate TypeStrings. However, if
the :PROPAGATE option is also used then the last level objects will not be
updated since processing has not finished and this is not the last set of objects.
For example it a path starts from an item, then gets its revisions and then
Specification datasets, by default only the datasets would get updated. But if the
item and/or revisions should also be updated then the UPDATE option should be
used at the item and revisions level in the path, e.g.
(Item_):UPDATE.GRM=Revisions.*:UPDATE.GRM=IMAN_specification.(Dataset_)
PROPAGATE A propagation path can have many levels of alternating TypeStrings and
RelationStrings. Therefore to find and update several different types of object
under an object could require several full length paths. However, this will result in
the top level objects being found for each propagation path.
For example going through an item, then revisions and then to get the master
form, BOMView revision and IMAN_specification objects would require 3 full paths,
i.e.
(Item_):UPDATE.GRM=Revisions.*:UPDATE.GRM=IMAN_master_form
(Item_).GRM=Revisions.*.ATTR=structure_revisions
(Item_).GRM=Revisions.*.GRM=IMAN_specification.*
This will result in the revisions being found repeatedly for each path and so is
inefficient and will have a hit on performance.
By using the :PROPAGATE option an object at that level can be used to start a
new propagation as the main object and propagation paths starting with a
matching type or class for that object will be searched for. So the following is more
efficient than the example above:-
PROPAGATION PATH = (Item_).Revisions.*:UPDATE:PROPAGATE
PROPAGATION PATH = (ItemRevision_).GRM=IMAN_master_form
PROPAGATION PATH = (ItemRevision_).ATTR=structure_revisions
PROPAGATION PATH = (ItemRevision_).GRM=IMAN_specification.*
The first line gets all the revisions from an item, uses a ‘*’ to match any type of
revision then updates the revision and starts a new propagation from the revision.
Note, the :PROPAGATE option can also be added to a RelationString, so this line
could also be written as:-
PROPAGATION PATH = (Item_).Revisions:PROPAGATE
Here the :UPDATE option is not required to update the revisions since if the last
level is a RelationString all objects at that level will be updated. This is slightly
different to a final type string which does not update if :PROPAGATE is also used.
Now that the propagation has started again from each revision the list of
PROPAGATION PATHs will be searched for starting TypeStrings that match on
revision by type or class. There are 3 lines here, so each will be processed for
each revision, finding and updating the Revision Master Form, the BOMView
Revision (via the ATTR option) and finally all Specification objects.
Typically the :PROPAGATE option should be used on the last TypeString or
RelationString supplied.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 51 of 226
SIEMENS Technical Document

2.8.2.2 Propagation Relation String

The RelationString finds objects under an object either by a GRM relation, attached to
objects via an attribute or property, or a special case of revisions under an item.
The format of a RelationString is:-
[.GRM=<GRMType> | Revisions[:<REV_RULE=<Rev_Rule>] | .ATTR=<attr> |
.PROP=<prop>] [:PROPAGATE]
So the basic format of a RelationString is:-
<RelationType>=<RelationName>
With optional colon options, some general and some specific to the RelationType.

2.8.2.2.1 Relation String Options

The following table describes the available RelationTypes and options
RELATION TYPE / OPTION DESCRIPTION
GRM=<GRMType> Specifies a GRM relation under which to find objects, e.g.
GRM=IMAN_specification
Revisions Gets revisions under an item, by default all revisions will be got.
[:<REV_RULE=<Rev_Rule>] An optional Revision Rule can be used where Rev_Rule can be
one of:-
Revision Rule A Tc revision rule, e.g. Latest Released
LATEST Get latest rev only
ALL Get all revision (default behaviour)
ATTR=<attr> Gets objects attached via the attribute attr, e.g.
(Item_).ATTR=bom_view_tags
This gets the BOMView tags for an item.
PROP=<prop> Gets objects attached via the property prop, e.g.
(MEOPRevision).PROP=root_activity.*:UPDATE.PROP=contents
Gets the root activity attached to an MEOPRevision and then the
sub activities attached to the root activity under contents.
Trial and error may be required to determine whether the ATTR
or PROP option should be used for a particular value.
PROPAGATE See PROPAGATE for Type String Options above.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 52 of 226
SIEMENS Technical Document

2.8.3 Propagation path processing

Propagation processing will only be carried out if there’s at least one PROPAGATION PATH
defined and will start from a main object currently being processed during an upload.
Currently this applies to items, revisions and the main object defined using the pom mode.
For the case of items and revisions, when not running in pom mode, the existing behaviour
of automatically processing attachments will not occur when a PROPAGATION PATH is
supplied
For this main object the propagation process will look for any propagation paths where the
first TypeString matches the type or class of the object. Every path that matches will be
processed.
If a subsequent RelationString is defined then the objects in that relation will be obtained
from the current object. Otherwise the current object(s) will be updated, unless the
:PROPAGATE option is supplied. If it is then propagation will start from each of the current
set of objects. If these objects do need to be updated then the :UPDATE option should be
used as well as the :PROPAGATE.
If there is no subsequent TypeString then the current objects found from the last
RelationString will be updated, even if :PROPAGATE is supplied. If the :PROPAGATE
option is supplied then propagation will start from each of the current set of objects. If a
subsequent TypeString is supplied then it will be used to filter the current set of objects
returned from the last RelationString and if the :UPDATE option is supplied then the current
set or relation objects will be updated before filtering with the TypeString.

2.8.4 Propagation considerations

1) If the last path string is a TypeString all current objects will be updated unless
:PROPAGATE is supplied. If these objects should be updated then add the
:UPDATE option too.
2) If the last path string is a RelationString all current objects will be updated even if
:PROPAGATE is supplied.
3) If all objects found from a RelaitonString are to be carried forward regardless of type
or class then supply an asterix (*) for the TypeString. This will typically be required for
Revisions under an item.
4) Existing behaviour of updating item and revision attachment will not occur if at least
one PROPAGATION PATH is supplied.
5) A PROPAGATION PATH can have many levels defined of alternating TypeStrings
and RelationStrings. But if several paths are supplied where a portion of the path is
repeated then use the :PROPAGATE option for better efficiency and performance.
6) A summary line will be reported stating how many Propagated objects were
successfully updated and how many failed.
7) All PROPAGATION PATHs supplied will be verified when the configuration file is read
during initialisation to check that all supplied types, classes, relation types and
revision rules are valid. Property names cannot be checked during initialisation
because they depend on the object type. Attribute names will only be checked if the
previous TypeString specified a class name.
8) Existing UPDATE options, e.g. for item, revisions, forms, datasets etc will not apply to
any objects found via PROPAGATION PATHs, they will all be updated since they’ve
been found via specific path options with optional control from the :UPDATE option.
However, the standard UPDATE options still apply to the main object found. Also,
even if the UPDATE option is off, e.g. UPDATE ITEMS = OFF, propagation will still
occur for that object.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 53 of 226
SIEMENS Technical Document

9) If an item and a revision ID is supplied then the standard behaviour is to process both
objects, therefore propagation will occur for both the item and the revision. Therefore
if PROPAGATION PATHs are supplied to propagate from Items and Revisions, then
the revisions will get propagated and updated twice, so be careful.
10) All fields with the .PROPAGATE field modifier will be set on propagated objects.
These fields must also be a colon field, but if the value is to be set on different object
types then the type must be a *, e.g. *:owning_user.PROPAGATE. These fields will
also be ignored for the main object being processed which won’t match on the type of
‘*’.
This is the same in pom mode. But if the main object is also to be updated, e.g. if it’s
a Folder, then put the actual type in, e.g. Folder:owning_user.PROPAGATE.
11) Propagation objects being updated will be displayed in the output, and if running with
verbose output by supplying the –v argument then a line will also be written to the
output for each parent relation object found during the propagation.
12) If running in report mode and with verbose on objects found during propagation will be
reported on with the status PRPG REPORTED. If not in report mode any object
updated will have the status PRPG UPDATED or PRPG UPDATE FAILED upon an
error.
13) Any propagation object to be updated does not have any fields defined to match on,
i.e. by *, (Class) or type, then a status of PRPG NO FIELDS TO SET will be displayed
and a summary line added for Propagation Objs NO FIELDS TO SET.
14) Check-in and Check-out can also be carried out on propagation objects, obeying the
existing CREATE CICO and UPDATE CICO options. For all Check-in and Check-out
considerations see the section 4.3.3.
Though, with propagation cancelling check-outs will be attempted on any propagation
object and not just Datasets, and existing UPDATE options do not have to be set to
ON, e.g. UPDATE ITEMS, UPDATE DATASET etc.

2.8.5 [12.2.0] Setting ‘project_list’ (Project Assign)

When assigning projects to objects Tc uses OOTB propagation rules to also assign
revisions and datasets to the project. The assigned projects can be seen in the Project IDs
(project_ids) and Project Objects (project_list) properties against each object.
If the assigned projects on the item are changed, for example, this is reflected against the
propagated objects too. Tc keeps track of the propagated objects in an object of class
ProjectObjectRelation (POR) via an attribute propagation_obj_list.
A POR is created for every object that has project assigned to it. For example, you can
assign a project to the item and get a POR for the item listing the item, revisions, datasets
any other objects defined in the Tc propagation rules. If a project is then separately
assigned to a revision, maybe with a different project, then a POR will be created for the
revision listing the revision, datasets etc. The Project IDs property will then show the
project for the item and the project from the revision against the revision and datasets. If a
Project Remove is then done on the rev the POR for the revision will be deleted, but not the
POR for the item, so the revision will still show the project that was assigned to the item.
Some objects though are not support by the Tc propagation rules, e.g. MEActivity objects.
IPS Data Upload can perform this propagation to these objects via the PROPAGATION
PATH configuration option. Prior to version 12.2.0 assign projects via propagation using the
field *:project_list.PROPAGATE a POR would have been created for each object updated
while traversing the PROPAGATION PATH options. In version 12.2.0 a POR will only be
created for the top object updated which can be the item or the revision. All subsequent
objects will then be added to this parent POR. If the parent object already has a POR it will
be updated.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 54 of 226
SIEMENS Technical Document

If a sub object already has a POR it will be removed by default, but this can be disabled by
setting the new config option PROJECT LIST POR CLEANUP = OFF.
Project lists can now also be updated, using the project_list property, as follows:-
UPDATE OPTION DESCRIPTION HOW?
APPEND Appends the supplied Just supply the project_list field and
(Default action) project or CSV project list the list of projects, e.g.:-
to any currently assign !~ItemID~I:project_list
projects. 000001~ProjectX
000002~ProjectX,ProjectY
CLEAR Totally clears the projects Supply a project value of NULL, e.g.:-
currently assigned. !~ItemID~I:project_list
000001~NULL
REPLACE Totally clears the projects Use the config option
currently assigned and PROJECT LIST UPDATE OPTION =
assigns the new projects REPLACE
specified.
Or the field modifier .REPLACE, e.g.:-
!~ItemID~I:project_list.REPLACE
000001~ProjectY
REMOVE Removes a project from Use the config option
the currently assigned PROJECT LIST UPDATE OPTION =
projects. REMOVE
Or the field modifier .REMOVE, e.g.:-
!~ItemID~I:project_list.REMOVE
000001~ProjectY

2.8.6 [14.8.0] Setting security attributes like license_list

The security properties license_list, gov_classification and ip_classification now use
specific API calls to set them, rather than generic property setting functions. This is to
provide better OOTB propagation rules (now defined in Propagation Rules in BMIDE) to be
applied by Teamcenter.
This should negate the need to use IPS Data Upload PROPAGATION PATHs to be used to
set these values on objects under items and revisions, or as defined by specific Tc defined
rules. Though propagation paths could still be useful to update all children in a BOM to
receive the same security as the top parent.

2.8.6.1 license_list

The property license_list can use the field modifiers .REPLACE and .REMOVE with the
default being to append licenses. With .REPLACE all current licenses will be replaced with
the supplied license(s) and .REMOVE will remove just the supplied license(s).
A value of NULL can be also used to clear all current licenses.
A license_list field can also be supplied more than once if required, e.g. to remove or clear
a set of licenses and then set a new license.
An example has been provided below, 2.8.7.5, to initially remove existing licenses and add a
new one, with PROPAGATION PATHS to update all children in BOMs.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 55 of 226
SIEMENS Technical Document

2.8.6.2 gov_classification

The property gov_classification may well be set up with a hierarchy propagation rule in
BMIDE, so that if the value is set to a lower level on the item then the previous higher level
will still be set on any existing revisions.
If it’s required to override this and also set the lower value on existing revisions then the
property field can be added twice, first to set the value to NULL to remove any existing
classification and then again to supply the new value.
See example 2.8.7.5.

2.8.7 Propagation Examples

2.8.7.1 Items, revisions and standard attachments

An Item, its attachments, its Revisions and the revisions’ attachments can all be updated by
supplying only the item, via its ItemID or tag, thus:-

2.8.7.1.1 Data File

!~ItemID~*:owning_group.PROPAGATE~*:owning_project.PROPAGATE.FIND=TC_Project,project_id
000023~dba~Project Y

2.8.7.1.2 Config File

SET BYPASS = ON

CREATE ITEMS = ON
UPDATE ITEMS = OFF

CREATE REVS = ON
UPDATE REVS = OFF

UPDATE LATEST REV = OFF

# -- Match objects descended from the class Item, update the item then find the IMAN_master_form
via the GRM relation and update it.
PROPAGATION PATH = (Item_):UPDATE.GRM=IMAN_master_form
# -- Update the item’s BOMViews
PROPAGATION PATH = (Item_).ATTR=bom_view_tags

# -- These paths do the same, and find all revisions, update them and propagate
#PROPAGATION PATH = (Item_).Revisions:REV_RULE=ALL:.*:UPDATE:PROPAGATE
#PROPAGATION PATH = (Item_).Revisions:PROPAGATE
# -- This path also find all revisions, propagates, but doesn’t update the revs!
#PROPAGATION PATH = (Item_).Revisions.*:PROPAGATE

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 56 of 226
SIEMENS Technical Document

# -- This active path only find the Latest Working revs, update and propagates
PROPAGATION PATH = (Item_).Revisions:REV_RULE=Latest Working:PROPAGATE

# -- Update the revision’s master form

PROPAGATION PATH = (ItemRevision_).GRM=IMAN_master_form
# -- Update the revision’s BOMView Revisions
PROPAGATION PATH = (ItemRevision_).ATTR=structure_revisions
# -- Update all the revision’s Specification attachments and propagate
PROPAGATION PATH = (ItemRevision_).GRM=IMAN_specification:PROPAGATE

# -- For MEOPRevisions update the root activity and any contents descended from the class
MEActivity and propagate
PROPAGATION PATH =
(MEOPRevision).PROP=root_activity.*:UPDATE.PROP=contents.(MEActivity_):PROPAGATE
# -- Update all contents of an MEAtivity object
PROPAGATION PATH = (MEActivity_):UPDATE.PROP=contents

#-- Update any objects attached to Datasets under the GRM relation Rendering.
PROPAGATION PATH = (Dataset_).GRM=IMAN_Rendering

2.8.7.2 Propagation path to update children in a BOM

PROPAGATION PATH =
(ItemRevision_).ATTR=structure_revisions.*:UPDATE.PROP=bvr_occurrences.*.ATTR=child_item.*:UPDAT
E:PROPAGATE

2.8.7.3 Updating objects in a Folder using the pom mode

2.8.7.3.1 Data File

Update and propagate the owning user and group for objects the in the Folder specified by
its tag (PID).
# -- Header to also update the Folder, using Folder:
#!~Folder:pid.KEY~Folder:owning_user.PROPAGATE~Folder:Group.PROPAGATE
# -- Header to NOT update the folder, using *:
!~Folder:pid.KEY~*:owning_user.PROPAGATE~*:Group.PROPAGATE
QRQZ4itkqGvuWB~user1~Engineering

2.8.7.3.2 Config File

SET BYPASS = ON

UPDATE POM OBJECTS = Dataset,Folder

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 57 of 226
SIEMENS Technical Document

# -- Find all items found in the contents attribute of a Folder, update them and propagate
PROPAGATION PATH = (Folder_).ATTR=contents.(Item_):UPDATE:PROPAGATE

# -- Update master forms, revisions, BVs, BVRs and specification objects

PROPAGATION PATH = (Item_).GRM=IMAN_master_form
PROPAGATION PATH = (Item_).Revisions:REV_RULE=ALL:PROPAGATE
PROPAGATION PATH = (Item_).ATTR=bom_view_tags
PROPAGATION PATH = (ItemRevision_).GRM=IMAN_specification
PROPAGATION PATH = (ItemRevision_).GRM=IMAN_master_form
PROPAGATION PATH = (ItemRevision_).ATTR=structure_revisions

2.8.7.4 Update folders in a folder structure

2.8.7.4.1 Data File

!~Folder:pid.KEY~Folder:owning_user.PROPAGATE~Folder:Group.PROPAGATE
QRQZ4itkqGvuWB~infodba~dba

2.8.7.4.2 Config file

SET BYPASS = ON

UPDATE POM OBJECTS = Folder

PROPAGATION PATH = (Folder_).ATTR=contents.(Folder_):PROPAGATE

2.8.7.5 [14.8.0] Replace licenses for a parent and its BOM children

2.8.7.5.1 Data File

!~ItemID~(Item):license_list.PROPAGATE~(Item):gov_classification.PROPAGATE~
(Item):gov_classification.PROPAGATE
000226~B~NULL~UK OFFICIAL-SENSITIVE - NEED-TO-KNOW
000326~C~NULL~UK OFFICIAL-SENSITIVE - TRACEABLE
000426~D~NULL~UK OFFICIAL-SENSITIVE - TRACEABLE

2.8.7.5.2 Config file

SET BYPASS = ON

UPDATE REMOTE OBJECTS = ON

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 58 of 226
SIEMENS Technical Document

CREATE ITEMS = OFF

# UPDATE ITEMS is OFF as all updates will occur through propagation
UPDATE ITEMS = OFF

CREATE REVS = OFF

UPDATE REVS = OFF

UPDATE LATEST REV = OFF

LOG FILE FORMATS=CSV

# [1] If an object is descended from class Item, update it, work through all of its revisions and
propagate from them.
PROPAGATION PATH = (Item_):UPDATE.Revisions:REV_RULE=ALL:.*:PROPAGATE
# [2] If an object is descended from class ItemRevision, work through it’s BOM structure
PROPAGATION PATH =
(ItemRevision_).ATTR=structure_revisions.*.PROP=bvr_occurrences.*.ATTR=child_item.*:PROPAG
ATE
# [3] If an object is descended from class ItemRevision get its item in case the BOM is precise
PROPAGATION PATH = (ItemRevision_).ATTR=items_tag

#DEFAULT VALUES HEADER LINE = I:license_list.REMOVE

#DEFAULT VALUES DATA LINE = A,B,D

DEFAULT VALUES HEADER LINE = (Item):license_list.REMOVE.PROPAGATE

DEFAULT VALUES DATA LINE = A

2.8.7.5.3 Notes
• The properties are only being set on items to rely on OOTB propagation rules to
update objects under the item.
• The fields setting the properties start with (Item) to update any object descended
from the class Item.
• The gov_classification field has been entered twice in the main header line and
data lines, firstly with a value of NULL to remove the existing classification and then
again to provide the new value.
This is to allow a lower value to be set and overridden on existing revisions.
• UPDATE ITEM is set to OFF as all item updates have been controlled by the first
PROPAGATION PATH entry with the (Item_):UPDATE phrase. Otherwise an extra
update and output line will occur for each item.
• DEFAULT VALUES have been set for the license_list for the item to remove existing
values so it doesn’t have to be added to each data line.
This couldn’t be done for the gov_classification though, because it uses exactly
the same field header twice, which means that the default value field would be
Unrestricted Copyright © 2023 Siemens Digital Industries Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 59 of 226
SIEMENS Technical Document

found in the main header line and only used to provide a default value if the data
line didn’t supply a value. Only a different modifier is required for this not to happen,
i.e. for the default field to be treated as a separate field.
• For propagation of BOM structures, to update the children in any BOM, there are
three PROPAGATION PATH entries in the config file and each property to be
updated on the objects found during the propagation have the .PROPAGATION
field modifier.
Comments in the config file describe what each PROPAGATION PATH is for.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 60 of 226
SIEMENS Technical Document

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 61 of 226
SIEMENS Technical Document

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

------------------------------------------------------------------

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 62 of 226
SIEMENS Technical Document

----
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..

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 63 of 226
SIEMENS Technical Document

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 64 of 226
SIEMENS Technical Document

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
[12.0.0] Supports the .TAG modifier to supply the tag
of an item to update.
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.
[12.3.0] Use the values ITEM_TAG or REV_TAG to
write the new item’s item or rev tag to the log file.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 65 of 226
SIEMENS Technical Document

4.1.2 Revision fields

FIELD DESCRIPTION
RevID Revision ID
[11.3.0] Supports the .TAG modifier to supply the tag
of a revision to update. Can be supplied without the
ItemID field.
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
Unrestricted Copyright © 2023 Siemens Digital Industries Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 66 of 226
SIEMENS Technical Document

FIELD DESCRIPTION
object).
EffStartDate Effectivity Start Date
[12.7.0] EffStartDate can now accept a dated range to
set date ranges on a single effectivity. With a range
the EffEndDate is not required. The dates supplied in
the range must be in the Teamcenter date format.
The DATE FORMAT option will not be used to re-
format dates in a range.
Date range example:-
16-Mar-2010 10:00 to 16-Mar-2014 10:00; 17-Mar-
2014 10:00 to 16-Mar-2018 10:00
Each range is separated using “ to “ and ranges are
separated with “; “.
To see other examples, set some ranges on an
effectivity on a status object in Teamcenter and look at
the properties of the status object.
EffEndDate Effectivity End Date
UnitStart Unit Serial Number start
[12.7.0] UnitStart can now accept a unit range to set
ranges on a single effectivity. With a range the
UnitEnd is not required.
Unit range example:-
1-5, 8-20, 21-UP
Each range is separated using “-“ and ranges are
separated with “, “.
To see other examples, set some ranges on an
effectivity on a status object in Teamcenter and look at
the properties of the status object.
UnitEnd Unit Serial Number end.
Can be UP or SO.
BOStatus Release status for Based On Item/Revision
BOReleaseDate Release date for Based On Item/Revision
EffEndItem Effectivity End Item ID
[14.11.0] Can now take the field modifier .REPLACE
to be used in conjunction with EFFECTIVITY UPDATE
OPTION = UPDATE END ITEM. This will replace
existing ranges on the matched end item’s effectivity.
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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 67 of 226
SIEMENS Technical Document

FIELD DESCRIPTION
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 CONFIGURATION OPTIONS

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 68 of 226
SIEMENS Technical Document

FIELD DESCRIPTION
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.
[10.7.0] If rules are not defined then basic IDs can be
generated instead by setting AUTO GENERATE BASIC
ITEM ID = ON.
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.
NOTE: AUTO GENERATE ITEM ID must also be set to
ON.
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.
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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 69 of 226
SIEMENS Technical Document

FIELD DESCRIPTION
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 [10.10.0] ON|OFF to control if the previous revision
IMMUNE sequence should be set to immune (to prevent deletion on
purge) when a new revision sequence is created.
Default is OFF.
ALLOW ITEMID MFK [14.1.0] ON|OFF flag to control whether an “=”s sign in the
FORMAT ItemID field is used to specify a MultiField Key (MFK)
format.
When ON the “=” sign specifies an MFK value.
When OFF the “=” sign will simply be part of the ID.
Default is ON.
UPDATE ITEM POR GROUPS [14.16.0] Used to specify a CSV list of POR Security
Groups to filter on when updating them, e.g. by adding
new BV and BVR objects to them for propagation of
security values, e.g.:-
UPDATE ITEM POR GROUPS = Security Group
II,Security Group III
If not used then all of the item and rev’s PORs will be
updated by having the new objects added.

4.2.2 Attachments
FIELD DESCRIPTION
UPDATE ITEM ON|OFF flag to control if Item attachments have their
ATTACHMENTS 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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 70 of 226
SIEMENS Technical Document

FIELD DESCRIPTION
UPDATE ITEM ATTACHMENT [7.0.0] A CSV list of relation types in which to update
RELATIONS attachments to the item. Accepts the following keywords
as values:-
* : All relations
ALL : All relations
NONE : No relations [14.0.0]
[14.14.0] Now also accepts IM and BV to find the Item
Master form and the BOMView.
UPDATE REV ATTACHMENT [7.0.0] A CSV list of relation types in which to update
RELATIONS attachments to the item revision. Accepts the following
keywords as values:-
* : All relations
ALL : All relations
NONE : No relations [14.0.0]
[14.14.0] Now also accepts RM and BVR to find the
Revision Master form and the BOMView Revision.
UPDATE DSET ATTACHMENT [7.0.0] A CSV list of relation types in which to update
RELATIONS attachments to the dataset.

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, Effectivities 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 BOMView,IMAN_specification.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 71 of 226
SIEMENS Technical Document

FIELD DESCRIPTION
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
UPDATE STATUS Controls how released objects should have their status
updated. Can be set to one of the following options:

OFF Turns off ALL status updating

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.
NOTE: This will always result in ReleaseDate being set, if
not supplied then the current date and time will be used.
To retain the existing Release Date use LAST or BY
NAME.

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.
Un-releases objects. Note: to use this option, no Status
UNRELEASE field should be specified in the data fields, except for
UNRELEASE.
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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 72 of 226
SIEMENS Technical Document

FIELD DESCRIPTION
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
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.

NONE [14.0.0] Don’t release any attachments, just the item.

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.
NONE [14.0.0] Don’t release any attachments, just the revision.
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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 73 of 226
SIEMENS Technical Document

FIELD DESCRIPTION
EFFECTIVITY UPDATE [12.6.0] Specifies how to update revision effectivities thus.
OPTION
ADD Adds a new effectivity.
REPLACE The first data line for the same revision and status will
replace all existing effectivities and subsequent data lines
will add effectivities.
UPDATE LAST Updates the last effectivity.
UPDATE END ITEM [14.11.0] Existing effectivities will be searched for the End
Item being specified. If not found a new effectivity will be
created, otherwise the existing effectivity for that end item
will be updated.
By default any new ranges will be appended. Otherwise
the field modifier .REPLACE can be used on the
EffEndItem field to replace the existing ranges on the
effectivity for that end item.
CREATE CICO ON|OFF flag to control if objects with NO current
Checkout should have the Check Out set.
Default = OFF.
UPDATE CICO Options to define what action to take on an object which
already has a Check-Out set. Valid options are:

OFF Turn off applying any update operation to an existing

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 74 of 226
SIEMENS Technical Document

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:

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 75 of 226
SIEMENS Technical Document

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.1.1 Un-releasing / Removing multiple statuses

To un-released objects, i.e. delete the status object attached to objects, the main trigger is
to set a status of UNRELEASE either by using the field Status or the configuration option
RELEASE STATUS.
To remove all but the latest status in the case where objects have multiple statuses also set
the configuration option UNRELEASE KEEP LAST.
By default all objects with an UPDATE flag set to ON will be un-released. To control which
objects are or are not un-released then set the appropriate configuration options to ON or
OFF, e.g.:-
UNRELEASE ITEMS = ON
UNRELEASE REVS = OFF

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.
[12.0.0] It is also support during propagation, e.g. in items and pom mode.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 76 of 226
SIEMENS Technical Document

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.
o There is no check for Folders. They will be updated anyway.

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 EFFECTIVITIES

4.3.5.1 Notes on V7 Effectivities

For reference these notes regard V7 effectivities vs pre v7 effectivities:-

• 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 will un-release objects released using V7 effectivities.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 77 of 226
SIEMENS Technical Document

• 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.5.2 [12.6.0] Multiple Effectivities

Multiple data lines can be supplied to create multiple effectivities on the same status objects.
For each subsequent line the ItemID, RevID and Status must be the same.
What happens to existing effectivities can be controlled with the configuration option
EFFECTIVITY UPDATE OPTION. Which has the following values:-

EFFECTIVITY UPDATE [12.6.0] Specifies how to update revision effectivities thus.

OPTION
ADD Adds a new effectivity.

REPLACE The first data line for the same revision and status will
replace all existing effectivities and subsequent data lines
will add effectivities.

UPDATE LAST Updates the last effectivity.

4.3.5.3 [12.7.0] Effectivity ranges

The fields EffStartDate and UnitStart now accept ranges. The ranges will be applied to
current single effectivity. So each effectivity, see Multiple Effectivities above, can have a
multiple range.
Example ranges:-
DATE 16-Mar-2010 10:00 to 16-Mar-2014 10:00; 17-Mar-2014 10:00 to 16-Mar-2018 10:00
UNIT 1-5
UNIT 1-5, 8-20, 21-UP

4.3.5.4 [12.7.0] Finding End items

Effectivity End Items are supplied using the field EffEndItem. This field will accept the
various field modifiers to find objects, i.e. .TAG, .FIND and .KEY to find MFK items.
For example:-
EffEndItem.FIND=Item,item_id

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 78 of 226
SIEMENS Technical Document

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 79 of 226
SIEMENS Technical Document

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
blank to get next rev ID.
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
blank to get next rev ID.
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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 80 of 226
SIEMENS Technical Document

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+

Multiple items with the same Item ID can be created in Tc 10+ using MultiField
keys. See section 2.7 - [11.0.0] MultiField Keys in Tc10+ for full details.

4.3.12 [12.0.0] Object Propagation

Propagation paths can be defined to update objects attached to the main object specified
with the .KEY fields. See section 2.8 -

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 81 of 226
SIEMENS Technical Document

[12.0.0] Object Propagation for full details on propagation paths.

For example an item can be supplied and propagation paths defined to update all revisions
under the item along with any attached objects to the item and the revisions.
In pom mode a folder could be specified and paths set up to update all objects attached to
the folder, including items and then again all of its revisions and objects attached to the item
and revisions.

4.3.13 [14.14.0] Attachments

In version 14.14.0 controls over updating items, revs and their attachments has been
updated as follows:-
1) Item and Rev attachments can now be updated independently of the item and rev, i.e.
by setting UPDATE ITEMS|REVS = OFF and with UPDATE ITEM|REV
ATTACHMENTS = ON.

Previously to update item and rev attachments the item and rev had to have their
update options turned on too.
2) UPDATE ITEM|REV ATTACHMENT RELATIONS now accept IM,BV|RM,BVR.

For example:-

UPDATE REV ATTACHMENT RELATIONS = RM,BVR,IMAN_specification

The config options for attachments control which objects are found. If only

4.3.14 [14.17.0] Global Alternates (I:global_alt_list)

A single or multiple Global Alternates can be defined using a one or more fields specifying
the special property field I:global_alt_list. These fields can use .KEY.PROP, .FIND, item
MFK strings or simply a CSV of item IDs.
Note: When using .KEY then .PROP is also required to specify this field as a property to be
set rather than just finding an item on which other properties are to be set.
A value of NULL can be used to clear all Global Alternates from an item.
The modifier .REPLACE can be used to replace all existing Global Alternates on an item
with the new specified items.
The modifier .REMOVE can be used to remove the specified Global Alternates from an item.
By default any specified items will be added to the existing Global Alternates on an item.
Examples:-
MULTI VALUE SEPARATOR STRING = |

# Remove one and add one using item MFK strings

!~ItemID~I:global_alt_list.REMOVE~I:global_alt_list
#0405000~0043978
0405000~item_id=000084,object_type=Item~item_id=0043978,object_type=Item

END-OF-FILE

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 82 of 226
SIEMENS Technical Document

# Replace all with new using item MFK strings

!~ItemID~I:global_alt_list.REPLACE
#0405000~0043978
0405000~item_id=000084,object_type=Item|item_id=000083,object_type=Item

END-OF-FILE

# Add GAs by using MFK fields, with a clear first and using .KEY
!~ItemID~I:global_alt_list~I:global_alt_list.KEY=GA1.PROP~GA1:object_type~I:global_alt_list.KEY
=GA2.PROP~GA2:object_type
0405000~NULL~000084~Item~000083~Item

END-OF-FILE

# Add GAs by use MFK fields, with a clear first and using .FIND
!~ItemID~I:global_alt_list~I:global_alt_list.FIND=GA1~GA1:item_id~GA1:object_type~I:global_alt_li
st.FIND=GA2~GA2:item_id~GA2:object_type
#0405000~0043978
0405000~NULL~Item~000084~Item~Item~000083~Item

END-OF-FILE

# Clear GA list
!~ItemID~I:global_alt_list
#0405000~0043978
0405000~NULL

END-OF-FILE

# Global Alts with simple CSV of item IDs

!~ItemID~I:global_alt_list
0405000~000084,000083

END-OF-FILE

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 83 of 226
SIEMENS Technical Document

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
TCENG PREFERENCE equivalent:
IPS_IMP_Default_Rev
-df=<Date Format> Date format to use.
TCENG PREFERENCE equivalent:
IPS_IMP_Date_Format
Configuration Option equivalent: DATE FORMAT
-folder=<Folder Name> Target Folder Name for imported data.
TCENG PREFERENCE equivalent:
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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 84 of 226
SIEMENS Technical Document

5. BOMS MODE
This section outlines the input data field definitions, configuration options and usage
information for the bom mode. The bom 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
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 INPUT DATA FIELDS

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.
If the quantity value is 0 or starts with A then the quantity
will be set as A/R.
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.
[13.1.0] This field now supports MFK item definitions.
If a KEY field Identifier is used then a single data line must
be supplied for each alternate/substitute item. See 2.7.3.
Or a list of MFK strings can be supplied, but since an MFK
string contains a comma then the ALTERNATES LIST
SEPARATOR must be used to specify a different
separator. See 2.7.4.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 85 of 226
SIEMENS Technical Document

See examples below.

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 updated, i.e. NewSeqNo if
SeqNo is used for identification.
SubstChildID The Item ID of the Item to substitute the child.
[13.1.0] This field now supports MFK item definitions using
a KEY field Identifier. See 2.7.3.
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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 86 of 226
SIEMENS Technical Document

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

[13.3.0] These fields no longer work in Teamcenter 12+!

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 87 of 226
SIEMENS Technical Document

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.
NOTE: If the name contains space or ‘/’s surround the
name with “double quotes”., e.g.:-
[DIC0005]"TOWER/HUB HEIGHT"
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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 88 of 226
SIEMENS Technical Document

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 89 of 226
SIEMENS Technical Document

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 90 of 226
SIEMENS Technical Document

5.2 CONFIGURATION OPTIONS

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 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
the latest rev of any found child to be added, thus
only effective for precise BOMs.
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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 91 of 226
SIEMENS Technical Document

OPTION DESCRIPTION
supplying a list of alternate items.
NOTE: These ‘alternates’ are now called
Substitutes in Teamcenter.
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
Can also use:-
BOM UPDATE ID FIELDS = ChildID,SeqNo
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.
BOM AUTO SET FIND NO [14.9.0] An ON|OFF flag to control if the auto
setting of Find (Sequence) numbers is used, just as
in Structure Manager.
BOM UPDATE ITEM PORS [14.16.0] ON|OFF flag to set if any new BV and
BVR objects are added to any of the assembly item
or rev POR objects so security attributes get
propagated down to the BV and BVR.

NOTE:

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 92 of 226
SIEMENS Technical Document

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 93 of 226
SIEMENS Technical Document

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
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.
DEFAULT CONFIGURATOR CONTEXT [14.13.0] Specifies the Item Id of a default
ID Configurator Context ID to be used when setting
the BL:bl_formula property to set values to be
used with Product Configurator.

5.2.4 [7.6.0] Part / CAD Alignment (publish) links

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 94 of 226
SIEMENS Technical Document

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)
LEAVE Do nothing.
The default is LEAVE.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 95 of 226
SIEMENS Technical Document

5.3 MODULE NOTES

The following points should be considered when using this mode:

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 not 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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 96 of 226
SIEMENS Technical Document

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 97 of 226
SIEMENS Technical Document

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 UPDATE ID FIELDS,
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. Revise Mode – BOM SUBST CHILD OPTION = REVISE

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 98 of 226
SIEMENS Technical Document

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 [7.6.0] Part / CAD Alignment (publish) links

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:-

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 99 of 226
SIEMENS Technical Document

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
Unrestricted Copyright © 2023 Siemens Digital Industries Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 100 of 226
SIEMENS Technical Document

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 101 of 226
SIEMENS Technical Document

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.
[14.21.0] Enhanced OV condition string processing to allow an escape character, "\", before
special characters ‘(‘, ‘)’, ‘|’ and ‘&’ to allow them be part of the string itself and not treated as
a special character, e.g.:-
(AHD53175; M_LTL_C$TW$)

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~~~MyOption006~Option desc~public~LOGICAL~
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:-

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 102 of 226
SIEMENS Technical Document

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.

5.4 COMMAND LINE ARGUMENTS

FIELD DESCRIPTION
-bf=<BOM Format> BOM Format option to use. Currently only one option
value is available: parent_child.
TCENG PREFERENCE equivalent:
IPS_IMP_Bom_Format
Configuration Option equivalent: BOM FORMAT
-vt=<View Type> Specify the View Type to use.
TCENG PREFERENCE equivalent:
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

Simple example showing mixture of keywords and general properties:-
!~ItemID~RevID~ChildID~ChildRev~SeqNo~Qty~BL:bl_occurrence_name
000001~A~000002~A~10~2~Occ 000002

5.5.1.1 [13.1.0] Alternates example using different MFK definitions

Using a KEY field Identifier for single alternate definitions per data line:-

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 103 of 226
SIEMENS Technical Document

!~ItemID~RevID~ChildID~SeqNo~Alternates.KEY=MyAltItemID~MyAltItemID:object_type~MyAltItemI
D:my4_mfk_key1.KEY
000058~A~000060~1~M000001~MY4_MFK_Str_Item~val1
000058~A~000060~1~M000001~MY4_MFK_Str_Item~val2

Using MFK strings for multiple alternate definitions per data line:-
ALTERNATES LIST SEPARATOR = |

!~ItemID~RevID~ChildID~SeqNo~Alternates
000058~A~000060~1~000062|000063
000058~A~000060~1~item_id=M000001,object_type=MY4_MFK_Str_Item,my4_mfk_key1=val1|item
_id=M000001,object_type=MY4_MFK_Str_Item,my4_mfk_key1=val2

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 104 of 226
SIEMENS Technical Document

6. FORMS MODE
This section outlines the input data field definitions, configuration options and usage
information for the forms mode. The forms mode is used to import data around the following
criteria:

o Create Items, Item Revisions and set/update their properties

o Populate Item and ItemRevision Master forms
o Create/Update Forms and attach them to an Item or Revision

This mode is specified in the command line options for the utility or by setting the command
line argument:

-m=forms

6.1 INPUT DATA FIELDS

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
[12.8.0] The .TAG field modifier can now be used to
specify the TAG (or PUID) of a form. This may be
required if there are several forms under a revision
relation with the same name.
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.
Object [14.2.0] This is a general field used with .FIND to find
objects. Can be used here to find a general parent to
attach datasets to.
See section 2.3.6 for full details.

6.2 CONFIGURATION OPTIONS

6.2.1 Forms
OPTION DESCRIPTION
UPDATE FORMS ON|OFF flag to control updating forms

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 105 of 226
SIEMENS Technical Document

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.
DUPLICATE FORM NAMES [12.11.0] ON|OFF flag to control creating duplicate
forms under an item or revision with the same name.

6.3 MODULE NOTES

The following points should be considered when using this mode:

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.3.1 [12.8.0] Using FormName.TAG

The forms mode will allow other object types to be specified with the .TAG modifier, e.g. the
actual storage class objects that stores a form’s values.
Using this method to update form storage class values is faster than going through the form.
To do this the class of the form storage class must be used in the header and the .POM
modifier used. Also the Form Type should not be specified in a field or the configuration file.
For example, to update the CostAmount attribute on a CostDataForm that stores data in
the CostDataClass class:-
!~FormName.TAG~(CostDataClass):CostAmount.POM
# CostDataForm 1 - This is the actual storage data class object and not the form!
QdYl761XqGvuWB~50
NOTE 1: This is using the orphaned form functionality, i.e. not parent item or rev is
specified.
NOTE 2: The CostDataClass is surrounded in round brackets.
NOTE 3: Objects can only be updated using .TAG and not created.
NOTE 4: When supplying the TAG of a form then FORM TYPE can be used to verify the
type of the form found with the TAG.

6.4 COMMAND LINE ARGUMENTS

6.4.1 Forms
FIELD DESCRIPTION
-ft=<Form Type> Specify default Form Type to use.
TCENG PREFERENCE equivalent:
IPS_IMP_Form_Type

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 106 of 226
SIEMENS Technical Document

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
Simple example showing mixture of keywords and general properties:-
!~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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 107 of 226
SIEMENS Technical Document

7. LOVS MODE
This section outlines the input data field definitions, configuration options and usage
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

This mode is specified in the command line options for the utility or by setting the command
line argument:

-m=create_lovs

7.1 INPUT DATA FIELDS

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 CONFIGURATION OPTIONS

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

The following points should be considered when using this mode:

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 108 of 226
SIEMENS Technical Document

7.4 COMMAND LINE ARGUMENTS

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 109 of 226
SIEMENS Technical Document

8. RELATIONS MODE
This section outlines the input data field definitions, configuration options and usage
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
This mode is specified in the command line options for the utility or by setting the command
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 INPUT DATA FIELDS

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 110 of 226
SIEMENS Technical Document

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 111 of 226
SIEMENS Technical Document

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
used in conjunction with name and type to find objects.
*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
used in conjunction with name and type to find objects.
ParentGroup [10.1.0] The group of the parent/primary object to be
used in conjunction with name and type to find objects.
^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.
Object [14.2.0] This is a general field used with .FIND to find
objects. Can be used here with .PARENT and/or
.CHILD added to find general parent and child objects.
See section 2.3.6 for full details.

^ 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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 112 of 226
SIEMENS Technical Document

8.3 CONFIGURATION OPTIONS

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 113 of 226
SIEMENS Technical Document

8.4 MODULE NOTES

The following points should be considered when using this mode:

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 an 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:-

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 114 of 226
SIEMENS Technical Document

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:Fnd0
parameter~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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 115 of 226
SIEMENS Technical Document

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 the 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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 116 of 226
SIEMENS Technical Document

8.5 COMMAND LINE ARGUMENTS

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 rev
#----------------------------------------------

!~ItemID~RevID~ChildID~ChildRev~DsetName~DsetType~RelationName
tim-98765~A~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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 117 of 226
SIEMENS Technical Document

#----------------------------------------------

!~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...

6) [14.4.0] Find parent and child objects, using general Object field, to paste or cut a GRM
relation:-
RELATION NAME = IMAN_reference

!~Object.PARENT.FIND=IPP2CostCategory,object_name~Object.CHILD.FIND=IPP2Cost
Category,object_name
TimWCostTest1~TimWCostTest

More examples for relations mode can be found in Appendix F at 22.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 118 of 226
SIEMENS Technical Document

9. DATASETS MODE
This section outlines the input data field definitions, configuration options and usage
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
o Create Items, Item Revisions and set/update their properties

This mode is specified in the command line options for the utility or by setting the command
line argument:

-m=datasets

9.1 INPUT DATA FIELDS

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.
[11.3.0] Supports the .TAG modifier to supply the tag
of a dataset to update.
*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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 119 of 226
SIEMENS Technical Document

Object [14.2.0] This is a general field used with .FIND to find

objects. Can be used here to find a general parent to
attach datasets to.
See section 2.3.6 for full details.

* 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
FileOrigName [14.17.0] Sets the original file name of the imported
file. So, on export the file will get this name instead of
the file name on disk when it was imported.

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 CONFIGURATION OPTIONS

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
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))
Unrestricted Copyright © 2023 Siemens Digital Industries Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 120 of 226
SIEMENS Technical Document

OPTION DESCRIPTION
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 if one already exists
REPLACE REF Replace existing ref, see FILE REF REPLACE
OPTION for replace control options.

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.
DUPLICATE DATASET NAMES ON|OFF flag to allow datasets to be created with
the same name when set to ON. Basically, when
ON, existing datasets will not be looked for, thus
always creating a new one.
NOTE: Currently there is only one option to allow
individual datasets with the same name to be
updated. This is by supplying the dataset PUID
(tag) with the header field DsetName.TAG.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 121 of 226
SIEMENS Technical Document

NOTE: All items mode configuration options are available in this mode.

9.3 MODULE NOTES

The following points should be considered when using this mode:

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.

9.4 COMMAND LINE ARGUMENTS

FIELD DESCRIPTION
-ds_type=<Dataset Dataset Type.
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
Simple example showing mixture of keywords and general properties:-
!~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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 122 of 226
SIEMENS Technical Document

10. FOLDER MODE

This section outlines the input data field definitions, configuration options and usage
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

This mode is specified in the command line options for the utility or by setting the command
line argument:

-m=folders
-m=folder_create
-m=folder_insert

It’s also possible to attach objects to folders using the Folder field, or FOLDER NAME config
option, in other modes.

10.1.1 Top Folders

The Top folder functionality allows a top folder, or folders, to be found, or created, in
which to insert the specified folder, i.e. the folder in which objects are to be attached
or the first folder in a folder path.

The Top folder has separate configuration options and fields so one or more Top
folders can be found in which to insert the specified folder or folders. So it’s
possible to find the Top folder(s) with a different type and ownership to the specified
folder(s).

For example, the Top folder might be the login user’s Home or Newstuff folder, or a
Company Top folder.

10.2 New in 13.0.0

Version 13.0.0 replaces the folder_create and folder_insert modes with just
folders, though the original two modes are still available. However, any folder
attachment from other modes, like items, will use the new folder functionality for
creating or updating folders and attaching to them.

The new folders mode offers the following new general areas of functionality:-

• Options to control the creation and updating of folders in keeping with other
modes.
• More control of searching for folders, and top folders, using specified owner
and group.
• Support for multiple folders and top folders with option to control which if any
of the multiple folders found are processed.
• Attach general Workspace objects, using an Object field, to folders.
Unrestricted Copyright © 2023 Siemens Digital Industries Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 123 of 226
SIEMENS Technical Document

10.3 INPUT DATA FIELDS

10.3.1 Folders
FIELD DESCRIPTION
ItemID The ItemID of the Item to insert into the folder
Folder The Folder Name or Path.
[13.0.0] NOTE: To update properties on existing folders
use FL:<property> field headers.
FolderDesc The folder Description
FolderPath A Folder Path to create (nested folder structure).
FolderType The Type of folder to use.
FolderOwner [13.0.0] The folder owner. Used to find folders and set
on new folders. Use FL:owning_user to update folder
owner.
FolderGroup [13.0.0] The folder group. Used to find folders and set
on new folders. Use FL:owning_group to update
folder group.

10.3.2 Top Folders

FIELD DESCRIPTION
TopFolderName [13.0.0] Used to find/create a different Top Folder.
User with TopFolderOwner and TopFolderGroup to
find Top Folders with specific ownership.
NOTE: To update properties on existing Top Folder use
TOP_FL:<property> field headers.
TopFolderType [13.0.0] The Type of Top Folder to find/create when
using TopFolderName to find/create a different top
folder.
TopFolderDesc [13.0.0] The description of a Top Folder to set on create
or update.
TopFolderOwner [13.0.0] The Top Folder owner. Used to find folders
and set on new folders. Use TOP_FL:owning_user to
update folder owner.
TopFolderGroup [13.0.0] The Top Folder group. Used to find folders and
set on new folders. Use TOP_FL:owning_group to
update folder owner.

10.3.3 Attaching objects

FIELD DESCRIPTION
ItemID The ItemID of the Item to insert into the folder.
[13..0.0] If multiple items are found with the same ID
then they will all be attached.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 124 of 226
SIEMENS Technical Document

Object [13.0.0] The Object field can be used with an object

finding field modifier like .TAG or .FIND to find other
workspace objects to attach.
For example, to attach forms by name, use:-
Object.FIND=Form,object_name
All objects found will be attached.

10.4 CONFIGURATION OPTIONS

10.4.1 Folders
OPTION DESCRIPTION
FOLDER CREATE [13.0.0] ON|OFF flag to control if new folders
should be created.
FOLDER UPDATE [13.0.0] ON|OFF flag to control if existing folders
should be updated.
FOLDER NAME Default folder name to insert new items into.
FOLDER SEPERATOR Define the character separator in folder path.
Default = /
FOLDER TYPE The Name/Type of the 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)
MULTIPLE FOLDERS OPTION [13.0.0] Specifies what to do if multiple folders are
found, i.e. whether or not to process any.
Available options are:-
NONE Don’t process any
FIRST Only process the first one
ALL Process all of them
FOLDER PATH SUB FOLDER [13.0.0] Specifies what to do about sub folders
OPTION when using folder paths, with options to find
existing folders or create new ones.
Available options are:-
ATTACHED OR EXISTING Search for folders
in the parent folder first, then if none
found search for existing folder(s) in
the database. If found try to attach
them.
EXISTING Search for existing folder(s) in the
database. If found try to attach them.
ATTACHED ONLY Search for folders in the

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 125 of 226
SIEMENS Technical Document

parent folder and if not found then

flag as NOT FOUND even if FOLDER
CREATE is OFF.
NEW Check if the folder already exists in
the parent folder, if not then create a
new folder and attach it to the parent.
FOLDER PATH UPDATE OPTION [13.0.0] Specifies what folder(s) in a folder path
should be updated.
Available options are:-
LAST Only update the last folder in the path.
ALL Update all folders in the path.

10.4.2 Top Folders

OPTION DESCRIPTION
TOP FOLDER CREATE [13.0.0] ON|OFF flag to control if new Top Folders
should be created.
TOP FOLDER UPDATE [13.0.0] ON|OFF flag to control if new Top Folders
should be updated.
TOP FOLDER The Name of a Top folder to create folders in.
TOP FOLDER TYPE The Type of the Top folder. (Default is "Folder")
TOP FOLDER DESCRIPTION The description of the Top folder
TOP FOLDER FOR LOGIN USER [13.0.0] ON|OFF flag to only find the Top Folder(s)
ONLY for the login user.
NOTE: This will override the TopFolderOwner and
TopFolderGroup fields and TOP FOLDER OWNER
and TOP FOLDER GROUP options.
TOP FOLDER OWNER [13.0.0] Specifies the owner for searching and
setting on Top folders.
TOP FOLDER GROUP [13.0.0] Specifies the group for searching and
setting on Top folders.
MULTIPLE TOP FOLDERS [13.0.0] Specifies what to do if multiple Top folders
OPTION are found, i.e. whether or not to process any.
Available options are:-
NONE Don’t process any
FIRST Only process the first one
ALL Process all of them
TOP FOLDER SUB FOLDER [13.0.0] Specifies what to do about folders being
OPTION attached to the Top folder(s), with options to find
existing folders or create new ones.
Available options are:-
ATTACHED OR EXISTING Search for folders
in the parent folder first, then if none
found search for existing folder(s) in

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 126 of 226
SIEMENS Technical Document

the database. If found try to attach

them.
EXISTING Search for existing folder(s) in the
database. If found try to attach them.
ATTACHED ONLY Search for folders in the
parent folder and if not found then
flag as NOT FOUND even if FOLDER
CREATE is OFF.
NEW Check if the folder already exists in
the parent folder, if not then create a
new folder and attach it to the parent.
FOLDER PATH CHECK FOLDER [13.0.0] ON|OFF flag to control if the folder type is
TYPE used when searching for folders in folders.
The default is OFF so that when using folder
paths, if the middle folder has a different type to
that specified then it will still be found.

10.5 MODULE NOTES

The following points should be considered when using this mode:

1. If any folders cannot be found, they will be created if FOLDER CREATE is set to ON.
If the folders exist they will only be updated if FOLDER UPDATE is ON.

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 owned 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.
[pre 13.0.0] Alternatively use a second import using either the folder_insert or
relations mode to attach the new objects to the folder.

[13.0.0] The general Owner and Group fields still apply to folders, for which the above
still holds true. However, the new FolderOwner and FolderGroup options can be
used to specify different ownership values for the folder(s). Also control is available
in the case where multiple folders are found with the option MULTIPLE FOLDERS
OPTION.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 127 of 226
SIEMENS Technical Document

10.6 COMMAND LINE ARGUMENTS

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.7 EXAMPLES
Examples for folders mode can be found in Appendix H.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 128 of 226
SIEMENS Technical Document

11. PROJECTS MODE

This section outlines the input data field definitions, configuration options and usage
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.

This mode is specified in the command line options for the utility or by setting the command
line argument:

-m=projects

NOTE: This functionality is only available in Teamcenter Engineering Version 9 and later.

11.1 INPUT DATA FIELDS

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 CONFIGURATION OPTIONS

11.2.1 Projects
OPTION DESCRIPTION
CREATE PROJECTS ON|OFF flag to control if Projects should be created if

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 129 of 226
SIEMENS Technical Document

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!
PROJECT UPDATE DPAM [12.0.0] ON|OFF flag to control if the Date Proj
DATE Assignment Modified (DPAM) date is modified.
Default is ON for OOTB behaviour.
PROJECT ASSIGN [12.0.0] ON|OFF flag to control if inactive projects can
INACTIVE PROJECTS be assigned to objects.
By default inactive projects cannot be assigned
resulting in an error. By setting this option to ON the
project will be temporarily made active to allow the
assignment.
Note that the project will not appear in the Project IDs
property unless the project is set to active in Tc, though
evidence can be seen in the project_list attribute if the
Print Object tab is used via Window->Show View-
>Other….
Default is OFF for OOTB behaviour.

11.3 MODULE NOTES

The following points should be considered when using this mode:

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 130 of 226
SIEMENS Technical Document

11.4 COMMAND LINE ARGUMENTS

None.

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 131 of 226
SIEMENS Technical Document

12. CLASSIFICATION MODE

This section outlines the input data field definitions, configuration options and usage
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

This mode is specified in the command line options for the utility or by setting the command
line argument:

-m=inclass

NOTE: This functionality is only available in Teamcenter Engineering Version 8 and later.

12.1 INPUT DATA FIELDS

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
<inclass_attr_id> attribute IDs as required.

ItemID The ID of the Item to be classified

RevID The ID of the Revision to be classified

12.2 CONFIGURATION OPTIONS

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 132 of 226
SIEMENS Technical Document

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

The following points should be considered when using this mode:

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 133 of 226
SIEMENS Technical Document

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.

8. To set values in an array attribute surround each value with {}, e.g.:-
{value1}{value2}{value3}

12.4 COMMAND LINE ARGUMENTS

None.

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 134 of 226
SIEMENS Technical Document

13. IDENTIFIERS MODE

This section outlines the input data field definitions, configuration options and usage
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

This mode is specified in the command line options for the utility or by setting the command
line argument:

-m=identifiers

NOTE: This functionality is only available in Teamcenter Engineering Version 9 and later.

13.1 INPUT DATA FIELDS

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 135 of 226
SIEMENS Technical Document

13.2 CONFIGURATION OPTIONS

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

The following points should be considered when using this mode:

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 136 of 226
SIEMENS Technical Document

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 137 of 226
SIEMENS Technical Document

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.

13.4 COMMAND LINE ARGUMENTS

None.

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 138 of 226
SIEMENS Technical Document

14. MANUFACTURING MODE

This section outlines the input data field definitions, configuration options and usage
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

This mode is specified in the command line options for the utility or by setting the command
line argument:

-m=mfg
NOTE: This functionality is only available in Teamcenter Engineering Version 9 and later.

14.1 INPUT DATA FIELDS

14.1.1 Manufacturing
FIELD DESCRIPTION
ProcID MEProcess ID
[14.17.0] Now supports item MFK fields.
ProcRevID MEProcess Revision ID
ProcType MEProcess class Type
ProcName MEProcess Name
ProcDesc MEProcess Description
OpID MEOP ID
[14.17.0] Now supports item MFK fields.
OpRevID MEOP Revision ID
OpType MEOP Class Type
OpName MEOP Name
OpDesc MEOP Description
WorkID MEWorkArea ID
[14.17.0] Now supports item MFK fields.
WorkRevID MEWorkArea Revision ID
WorkType MEWorkArea Class Type
WorkName MEWorkArea Name

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 139 of 226
SIEMENS Technical Document

FIELD DESCRIPTION
WorkDesc MEWorkArea Description
ActType MEActivity Class Type
ActName MEActivity Name
ActDesc MEActivity Description
ActTime MEActivity time (Duration)
ActPreds Name of MEActivity Objects attached to MEOP which
(to create PERT are predecessor Activities. (Used to provide
activity flow chart) sequencing/flow in MSE).
[12.4.0] The ActPreds field will now accept a CSV list
of activity names, or a CSV of activity tags if the .TAG
field modifier is used.
[12.4.0] Existing activity predecessors can be updated
as follows:-
Clear – Use the value NULL to clear all
predecessors on an activity.
Replace – Use the .REPLACE field modifier to
replace all existing predecessors on an
activity with those supplied.
Remove – Use the .REMOVE field modifier to remove
the specified activities.
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
[14.17.0] Now supports item MFK fields.
PlantTargetRevID Rev ID for Plant BOM to link/consume from
ProductTargetID Item ID for Product BOM to link/consume from
[14.17.0] Now supports item MFK fields.
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
TargetParentID 14.19.0] Specifies the parent in which to find
TargetChildID immediately under.
TargetParentRev [14.19.0] Specifies the rev for the parent in which to
find TargetChildRev immediately under.
ProcChildID Occurrence Item ID of operation in Process BOM to
consume target occurrence

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 140 of 226
SIEMENS Technical Document

FIELD DESCRIPTION
ProcChildRev Occurrence Rev ID of operation in Process BOM to
consume target occurrence
ProcParentID [14.19.0] Specifies the parent in which to find
ProcChildID immediately under.
ProcParentRev [14.19.0] Specifies the rev for the parent in which to
find ProcChildID immediately under.

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.
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.
See section 5.3.4.2.1 for further format details.
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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 141 of 226
SIEMENS Technical Document

FIELD DESCRIPTION
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.
See section 5.3.4.2.1 for further format details.
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 CONFIGURATION OPTIONS

14.2.1 Manufacturing
OPTION DESCRIPTION

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 142 of 226
SIEMENS Technical Document

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
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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 143 of 226
SIEMENS Technical Document

OPTION DESCRIPTION
WORKAREA TYPE MEWorkArea Class Type. The valid name of
MEWorkArea Type to use.
LINK PRODUCT TO ON|OFF flag to control linking Product structure root to
PROCESS 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.
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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 144 of 226
SIEMENS Technical Document

OPTION DESCRIPTION
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

The following points should be considered when using this mode:

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
over the configuration option.

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.
Unrestricted Copyright © 2023 Siemens Digital Industries Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 145 of 226
SIEMENS Technical Document

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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 146 of 226
SIEMENS Technical Document

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
over the configuration option.

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.

17. [14.17.0] Fields that need to find items to set data on, or link together, now support
item MFK fields using .KEY or ,FIND fields, or using item MFK strings.

14.4 COMMAND LINE ARGUMENTS

None.

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 147 of 226
SIEMENS Technical Document

15. WORKFLOW MODE

This section outlines the input data field definitions, configuration options and usage
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

This mode is specified in the command line options for the utility or by setting the command
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 INPUT DATA FIELDS

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 148 of 226
SIEMENS Technical Document

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 CONFIGURATION OPTIONS

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 149 of 226
SIEMENS Technical Document

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.

15.4 COMMAND LINE ARGUMENTS

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 150 of 226
SIEMENS Technical Document

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
WF-tim-1~First test workflow~0-TEST Check Conf
Child~tim~Designers~REFERENCE~~NO~~~TEST UPLOAD FOLDER
WF-tim-1~First test workflow~0-TEST Check Conf
Child~tim~Designers~REFERENCE~REV~YES~New_Assy1XX
WF-tim-2~First test workflow~0-TEST-Xtrac
MRP~tim~Designers~TARGET~REV~NO~000010

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 151 of 226
SIEMENS Technical Document

WF-tim-2~First test workflow~0-TEST-Xtrac

MRP~tim~Designers~TARGET~REV~NO~New_Assy1XX
WF-tim-2~First test workflow~0-TEST-Xtrac
MRP~tim~Designers~REFERENCE~~NO~~~UPLOAD FOLDER FOR CCs
WF-tim-2~First test workflow~0-TEST-Xtrac
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
WF-tim-1~First test workflow~0-TEST Check Conf
Child~tim~Designers~TARGET~~YES~TEST UPLOAD FOLDER
WF-tim-2~First test workflow~0-TEST Check Conf
Child~tim~Designers~TARGET~~YES~UPLOAD FOLDER FOR CCs

#------------------
END-OF-FILE
#------------------

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 152 of 226
SIEMENS Technical Document

16. [9.0.0] POM MODE

This section outlines the input data field definitions, configuration options and usage
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.
[13.2.0] The pom mode can now, optionally, create general business objects using the
general object creation function TCTYPE_create_object. See [14.10.0] ‘Object’ field
The general field Object can be used to provide PUIDs (tags) of differing classes. Or the
.FIND modifier could be used to find specific objects by class and attributes.
This is useful if common attributes for objects of different classes need to be updated, e.g.
owning_group.
The config option to define which classes to be updated is not required.
For example, setting owning_group to dba for a dataset, BV and BVR:-
SET BYPASS = ON
DEFAULT VALUES HEADER LINE = *:owning_group
DEFAULT VALUES DATA LINE = dba

!~Object~Ignore:Type
h7CAQsVTo13TJC~Text
ikJAQsVTo13TJC~BV
ioIAQsVTo13TJC~BVR
[13.2.0] Object creation with TCTYPE_create_object for full instructions on using this
method for object creation.

16.1 INPUT DATA FIELDS

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 153 of 226
SIEMENS Technical Document

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.
[12.0.0] An existing object’s tag (or unique ID) can be supplied by supplying the pid attribute
as the key, for example:-
Folder:pid.KEY~Folder:owning_user.PROPAGATE~Folder:Group.PROPAGATE
QRQZ4itkqGvuWB~user1~Engineering
[13.2.0] A field name key word, BOType, has been added to indicate that the new object
create functionality, using TYTYPE_create_object, should be used.

FIELD DESCRIPTION
<Class>:BOType [13.2.0] Indicates to use TCTYPE_create_object to create
objects instead of POM functions. The value provided on the
data line will be the Business Object type to be created.

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 / creation_date Set the primary object’s Create Date.
ModifyDate / last_mod_date Set the primary object’s Modify Date.
Owner / owning_user Set the primary object’s Owner.
Group / owning_group Set the primary object’s Group.
LastModBy / last_mod_user Set the primary object’s Last Modified By.
Status Set the primary object’s Release Status.

16.1.4 [14.10.0] ‘Object’ field

The general field Object can be used to provide PUIDs (tags) of differing classes. Or the
.FIND modifier could be used to find specific objects by class and attributes.
This is useful if common attributes for objects of different classes need to be updated, e.g.
owning_group.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 154 of 226
SIEMENS Technical Document

The config option to define which classes to be updated is not required.

For example, setting owning_group to dba for a dataset, BV and BVR:-
SET BYPASS = ON
DEFAULT VALUES HEADER LINE = *:owning_group
DEFAULT VALUES DATA LINE = dba

!~Object~Ignore:Type
h7CAQsVTo13TJC~Text
ikJAQsVTo13TJC~BV
ioIAQsVTo13TJC~BVR

16.2 [13.2.0] Object creation with TCTYPE_create_object

Using TCTYPE_create_object to create objects means that the system sets all of the other
object attributes that otherwise had to be set as default attributes with the original POM
creation method. It can also create objects and set values on parent classes that the
original POM creation method could not do.
The trigger for creating objects with TCTYPE_create_object is to supply a header field name
with the keyword field BOType for a Class, e.g. NNB4_ContractWorkspace:BOType, and
the actual Business Object type, defined as a value in the data line, to be created for the
class.
Other fields to be set for that object are supplied as usual for the pom mode. So .KEY
fields are used to define values to be set at creation time and to search for existing objects.
Other fields to be set at creation time, i.e. if they’re mandatory, but not required for
searching are supplied with the .MAND field modifier.
Any other fields that can be set after creation are automatically flagged as .PROP fields by
default as opposed to using POM functions to set values. If values are specifically to be set
with POM functions then the .POM field modifier can be used. This may be required for
some attributes of some object types if an application privilege error is received setting
values as properties.

16.2.1 Example to create a ContractWorkspace object

SET BYPASS = ON
CREATE POM OBJECTS = NNB4_ContractWorkspace
UPDATE POM OBJECTS = NNB4_ContractWorkspace
BO CREATE SAVE WITH EXTENSIONS = OFF
TOP FOLDER = Home
TOP FOLDER FOR LOGIN USER ONLY = ON
!~NNB4_ContractWorkspace:BOType~NNB4_ContractWorkspace:prg0PlanId.KEY~NNB4_
ContractWorkspace:object_name.KEY~NNB4_ContractWorkspace:prg0State~Folder~NNB
4_ContractWorkspace:prg0PlanCode
NNB4_ContractWorkspace~GEN00005~GEN00005~Complete~Contracts~NULL
NNB4_ContractWorkspace~GEN00006~GEN00006~Complete~Contracts~CodeX
This example creates an object for the class NNB4_ContractWorkspace with the Business
Object type NNB4_ContractWorkspace.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 155 of 226
SIEMENS Technical Document

16.2.2 Complex Objects

Some support has been provided for complex objects that also require other objects, of
which a very good example is an Item which must have a Revision and each can have a
Master Form.
Item is quite a special case because it doesn’t have an attribute in the data model pointing
to Revisions. In fact Revisions have an items_tag attribute to store the tag (or PUID) of the
item they’re attached to. However in the BMIDE definition for Item under the Operation
Descriptor tab the CreateInput sub tab contains a property revision. It is this attribute that
must be used with TCTYPE_create_object to define a revision of an item.
However, since revision isn’t a property of Item, and since revisions aren’t actually stored
under items the same definition for defining the Business Objects to create an item and a
revision cannot also be used to find an item and specific revision. Which means that the
same input file can’t be used to update existing items and revisions and create new ones.
Hence, although this method can be used to create items and revisions, and their master
forms it’s recommended to use the items mode to create and update items.
But, the item to revision model is useful to demonstrate how the new functionality can be
used to create complex objects and highlight the potential issue with create vs update.

16.2.2.1 Example to create an item with revision and master forms

CREATE POM OBJECTS = Item

!~Item:BOType~Item:revision.BO_CI~revision:BOType~Item:IMAN_master_form.BO_CI=
IMF~revision:IMAN_master_form_rev.BO_CI=RMF~IMF:BOType~RMF:BOType~Item:ite
m_id.KEY~Item:object_name.MAND~Item:object_desc~revision:item_revision_id.KEY~Do
cument Revision:object_name.MAND~IMF:object_name.MAND~RMF:object_name.MAND
Document~ItemRevision~DocumentRevision~Form~Form~Document
Master~DocumentRevision Master~doc001~create object~Created by CO~001~co
Rev~doc001~doc001/001
Here are some observations from this example:-
1. The first field Item:BOType defines the Item Type, which has the value Document in
the data line.
2. There are multiple uses of the BOType field used to specify the object type for each
sub object, i.e. the revision and master forms. For example, the third field
revision:BOType supplies the Business Object type for the Revision as
DocumentRevision in the data line.
3. The original pom mode functionality uses the .CLASS field modifier to indicate a sub
object to be found or created. This can still be used with the new BO object creation,
however, this would error on the revision property, so here a new field modifier
.BO_CI (for Business Object Create Input) has been used to distinguish it as a Create
Input property only.
The second field, then, Item:revision.BO_CI is the link between the item and revision
via the Create Input property revision.
4. The master forms are linked to Item and Revision using the 4th and 5th fields
respectively as:-
Item:IMAN_master_form.BO_CI=IMF~revision:IMAN_master_form_rev.BO_CI=RMF
These fields specify alternative field names, with =<FieldID>, to be used to define the
values for the master forms. So here the Field Ids are IMF and RMF and their
respective value fields are:-
IMF:BOType~RMF:BOType
and
IMF:object_name.MAND~RMF:object_name.MAND
Unrestricted Copyright © 2023 Siemens Digital Industries Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 156 of 226
SIEMENS Technical Document

16.2.3 Notes on creating Business Objects

16.2.3.1 CreateInput properties

As mentioned just above, the Business Object Item has a special Create Input property
revision, which is not a an actual property under Item for storing the puid of the revision.
However, several actual Item properties are also defined as Create Input properties, like
item_id and object_name. Which is good as only Create Input properties can be used, at
creation time, to create objects using this functionality. I.e. only Create Input properties can
be defined in .KEY and .MAND fields. Any other properties to be set must not have .KEY or
.MAND added and will be set after the object has been created.
Some object types don’t have Create Input properties defined. For example ImanVolume
does not have volume_name defined. It can be added though, but care must be taken. In
the example of ImanVolume, although volumes can be created with this functionality and all
necessary properties set, the volumes created in Tc can’t be used as they also need to be
defined with the FSC. This is just an example where problem may arise.

16.2.3.2 .BO_CI vs .CLASS and .FIND

As shown in the Item example just above, the new .BO_CI field modifier is used like
.CLASS to specify a sub object class, but cannot find objects. So, the .BO_CI modifier is to
be used when the Create Input property is not an actual property of the object being
created, e.g. revision for the Business Object Item.
If the Create Input property is also an actual property of the object then .CLASS can be
used and then a search should also be done to find and update existing objects or create
new ones.
Alternatively if it’s known that a sub object, or referenced object already exists then the
.FIND modifier can be used to find the existing object, to find an ImanVolume object for a
group as shown in the following example.

16.2.3.2.1 Example using .FIND

CREATE POM OBJECTS = Group
UPDATE POM OBJECTS = Group
!~Group:BOType~Group:name.KEY~Group:description.KEY~Group:volume.FIND=ImanVol
ume~ImanVolume:volume_name
Group~IPS~Created by IPS Data Upload~ImanVolume~volume01

16.2.3.3 [14.7.0] .BO_CREATE vs .BO_CI

When using .BO_CI all of the data for the objects to be created, e.g. an item, its revision and
the master forms, is pre-defined and when the top object is created all of the other objects
are created too by the Tc API.
But, when this was tried with a ScheduleTask object and a Schedule object (as a sub/child
object to the ScheduleTask) the ScheduleTask failed to create. So .BO_CREATE was
added in order to fully create the Schedule object at its time of definition and the tag of the
new Schedule passed to the ScheduleTask definition.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 157 of 226
SIEMENS Technical Document

16.2.3.4 No default attributes

With the original POM creation functionality a list of attributes to have a default value set
was required using POM DEFAULT ATTRS FOR CLASS. But with the new BO create
method this is no longer required.

16.2.3.5 .PROP vs .POM

With the original POM creation functionality all fields would be set using POM functions.
This can allow none application privilege attributes to be set most times, but not attributes
on parent classes. The field modifier .PROP could be used to set a value as property rather
than an attribute.
With the new BO create functionality this is reversed. By default values will be set as
properties, without needing to supply .PROP. If an attribute is to be set directly with POM
then .POM will need to be added.

16.2.3.6 Restart Teamcenter

Many object types created using this method may not be able to be successfully refreshed
within Teamcenter, e.g. Groups. So restart Teamcenter to be sure of seeing any creates or
updates performed correctly.

16.3 CONFIGURATION OPTIONS

16.3.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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 158 of 226
SIEMENS Technical Document

OPTION DESCRIPTION
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.
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 ON|OFF flag to control if objects should be found by a
NOT 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

BO CREATE SAVE WITH [13.2.0] An ON|OFF option to control if new BO objects

EXTENSIONS created using TCTYPE_create_objects are saved with
extensions or not.
Default is ON – Do save with extensions.

16.3.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
Unrestricted Copyright © 2023 Siemens Digital Industries Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 159 of 226
SIEMENS Technical Document

RELATION MULTI PARENT OPTION

RELATION PARENT WSOM TYPE

16.3.2.1 [12.0.0] Object Propagation

Propagation paths can be defined to update objects attached to the main object specified
with the .KEY fields. See section 2.8 -

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 160 of 226
SIEMENS Technical Document

[12.0.0] Object Propagation for full details on propagation paths.

For example a Folder could be specified and all objects in the contents attribute updated,
with further paths defined to update objects under these contents.

16.4 MODULE NOTES

16.4.1 General methodology of the pom mode

16.4.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.4.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.4.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.4.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.4.1.5 Object references

Many attributes in the Teamcenter data model are typed or un-typed references to other objects. The
typed attributes have 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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 161 of 226
SIEMENS Technical Document

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. Then there are some known attributes, so no need to specify them, 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.4.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
CREATE POM OBJECTS ALWAYS = WebLink
UPDATE POM OBJECTS = Form,WebLink
FIND POM OBJECTS IF NOT IN PARENT = ON
POM DEFAULT ATTRS FOR CLASS Form = owning_organization,owning_project
SET BYPASS = ON

16.4.1.5.2 Data example

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 162 of 226
SIEMENS Technical Document

google~Web Link~Google UK~WebLink~http://www.google.co.uk/~000028~A~IMAN_reference~~16-

Mar-2000 10:00

16.4.1.6 Replacing referenced objects

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.4.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.4.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.4.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 [13.2.0] A field name key word, BOType, has been added to
indicate that the new object create functionality, using TYTYPE_create_object, should be used.

Parent fields, and configuration options to specify a GRM parent and GRM type.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 163 of 226
SIEMENS Technical Document

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.4.2.1 [12.9.1] Updating parent objects

To update the parent object add the PARENT to the config option UPDATE POM OBJECTS and add
fields starting with the parent's class or type, or the value PARENT can be used.
For example:-
UPDATE POM OBJECTS = Form,PARENT
!~ParentID~ParentRev~RelationName~Form:object_type.KEY~Form:object_name.KEY~Form:CostA
mount.PROP~PARENT:object_desc
delete_2~A~IMAN_specification~CostDataForm~CostData-001~33~Form updated

16.4.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:count
ry~CompanyLocation:postal_code~CompanyLocation:city~CompanyLocation:street

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 164 of 226
SIEMENS Technical Document

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

16.5 COMMAND LINE ARGUMENTS

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

16.6 EXAMPLES

16.6.1 Creating/Updating Web Link forms

16.6.1.1 Config file

16.6.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.6.2 Creating/Updating CompanyLocation objects

16.6.2.1 Config file

CREATE POM OBJECTS = CompanyLocation

CREATE POM OBJECTS ALWAYS = OFF
UPDATE POM OBJECTS = CompanyLocation

FIND POM OBJECTS IF NOT IN PARENT = ON

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 165 of 226
SIEMENS Technical Document

#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,ABG
_Approved_For_Aerosols

SET BYPASS = ON
UPDATE MODIFY DATES = OFF

16.6.2.2 Data file

!~CompanyLocation:object_name.KEY~CompanyLocation:object_type.KEY~CompanyLocation:count
ry~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

16.6.3 Update PSViewType Name

A short example to update the name attribute of a PSViewType object found by searching on the
current name value. So the name attribute is specified twice, once with the .KEY modifier to find the
object to update and then again with the new value.

UPDATE POM OBJECTS = PSViewType

!~PSViewType:name.KEY~PSViewType:name
Engineering~richard

16.6.4 Creating a ScheduleTask and Schedule using .BO_CREATE

# Add owning_user and owning_group
SET BYPASS = ON

CREATE POM OBJECTS = Schedule,ScheduleTask

UPDATE POM OBJECTS = Schedule,ScheduleTask

DATE FORMAT = %d/%m/%Y %H:%M:%S

DEFAULT VALUES HEADER LINE = ScheduleTask:owning_user~ScheduleTask:owning_group~

schedule_tag:owning_user~ schedule_tag:owning_group
DEFAULT VALUES DATA LINE = tim~Engineering~tim~Engineering

!~ScheduleTask:BOType~ScheduleTask:schedule_tag.BO_CREATE~schedule_tag:BOType~Sched
uleTask:item_id.KEY~ScheduleTask:object_name.MAND~ScheduleTask:start_date.POM~ScheduleT
ask:finish_date.POM~ScheduleTask:task_type~ScheduleTask:fnd0IsSchSummaryTask~ScheduleTa
sk:wbs_code~ScheduleTask:duration~ScheduleTask:work_estimate~schedule_tag:item_id.KEY~sch
edule_tag:object_name.MAND~schedule_tag:object_desc~schedule_tag:start_date.POM~schedule_t
ag:finish_date.POM~schedule_tag:published~schedule_tag:is_public~schedule_tag:dates_linked~sch
edule_tag:fnd0IsLegacy~schedule_tag:recalc_type~schedule_tag:fnd0SummaryTask.FIND=Sched
uleTask,item_id

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 166 of 226
SIEMENS Technical Document

ScheduleTask~Schedule~Schedule~05320L010~T.05320L010~30/09/2020 08:30~10/10/2020
08:30~6~1~~100~200~05330L~P.05330L~Projeto 05330L~30/09/2020 08:30~01/01/2021
08:30~TRUE~TRUE~TRUE~FALSE~0~05320L010~

Notes
1. .BO_CREATE is used, in conjunction with :BOType, on the top referencing object, in this
case the ScheduleTask to reference a Schedule object via the property schedule_tag.
2. The Schedule object is also created using :BOType with schedule_tag:BOType.
3. The item_id field for each object type uses .KEY as they are search fields.
4. The name fields for each object type uses .MAND as they are mandatory, but not search,
fields.
5. All further fields for the Schedule object use the field prefix schedule_tag.
6. The date fields are using .POM because for some reason they would not get set otherwise.
7. The last field, schedule_tag:fnd0SummaryTask.FIND=ScheduleTask,item_id, links the
new Schedule object back to the new ScheduleTask via the property fnd0SummaryTask
using .FIND to find it.

16.6.5 [14.9.0] Update occurrence UOM in all assemblies

This example shows how to update the PSOccurrence uom_tag in all assemblies for a child item (so
imprecise):-

UPDATE POM OBJECTS = PSOccurrence

UPDATE MULTI POM OBJECTS OPTION = ALL
SET BYPASS = ON

!~PSOccurrence:child_item.KEY.FIND=Item,item_id~PSOccurrence:uom_tag.FIND=UnitOfMeasure,s
ymbol
SHOPRT01~kg
SHOPRT02~kg

NOTE: A modification in 14.9.0 allows the .FIND field modifier to be used to find objects to be set on a
referenced attribute.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 167 of 226
SIEMENS Technical Document

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 168 of 226
SIEMENS Technical Document

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 169 of 226
SIEMENS Technical Document

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

DATE FORMAT = %d/%m/%Y

TOP FOLDER = Home
FOLDER NAME = \Upload Tests
DEFAULT REV =A
ITEM TYPE = Item
DATE FORMAT = %d/%m/%Y

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
BomChild2~A~williams~designers~16/03/1997~Project X~01/04/1997
BomChild3~A~williams~designers~16/03/1997~Project X~01/04/1997

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 170 of 226
SIEMENS Technical Document

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 171 of 226
SIEMENS Technical Document

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.

#New CICO config options

CREATE CICO = ON
UPDATE CICO = OFF
CHECK OUT REASON = Guy's Check-Out test

Data File
-------------------------------
!~ItemID~RevID~CheckOutID
GUY98765~A~CID_982KDME8001

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 172 of 226
SIEMENS Technical Document

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
DATE FORMAT = %d/%m/%Y
BOM FORMAT = parent_child
!~ItemID~ChildID~Qty~Owner~Group~CreateDate
BomAssy1~BomChild1~2~williams~designers~16/03/1997
BomAssy1~BomChild2~3~williams~designers~16/03/1997
BomAssy1~BomChild3~5~williams~designers~16/03/1997

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 173 of 226
SIEMENS Technical Document

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
Assembly123~Child2~30~2
Assembly123~Child3~30~3

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 174 of 226
SIEMENS Technical Document

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 OPTION = UPDATE OCCURRENCES
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 OPTION = UPDATE OCCURRENCES
BOM UPDATE ADD OCCURRENCES = OFF
BOM UPDATE PRE DELETE ATTR = ChildID
BOM UPDATE PRE DELETE VALUE = *

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 175 of 226
SIEMENS Technical Document

19.6 Set InContext AbsOccID

Set InContext AbsOccID in Parent Assembly XSUPERCAR...

Config File
-------------------------------
BOM FORMAT = parent_child
UPDATE BOMS = ON
CREATE BOMS = ON
BOM UPDATE OPTION = UPDATE OCCURRENCES
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
XWHEEL~A~XWHEELNUT~A~20~nut2~XSUPERCAR~A~Vectra-
RearAxle-LeftWheel-nut2~Vectra-RearAxle-LeftWheel
XWHEEL~A~XWHEELNUT~A~30~nut3~XSUPERCAR~A~Vectra-
RearAxle-LeftWheel-nut3~Vectra-RearAxle-LeftWheel
XWHEEL~A~XWHEELNUT~A~40~nut4~XSUPERCAR~A~Vectra-
RearAxle-LeftWheel-nut4~Vectra-RearAxle-LeftWheel
XAXLE99~A~XWHEEL~A~20~RightWheel~XSUPERCAR~A~Vectra-RearAxle-
RightWheel~Vectra-RearAxle
XWHEEL~A~XWHEELNUT~A~10~nut1~XSUPERCAR~A~Vectra-
RearAxle-RightWheel-nut1~Vectra-RearAxle-RightWheel
XWHEEL~A~XWHEELNUT~A~20~nut2~XSUPERCAR~A~Vectra-
RearAxle-RightWheel-nut2~Vectra-RearAxle-RightWheel
XWHEEL~A~XWHEELNUT~A~30~nut3~XSUPERCAR~A~Vectra-
RearAxle-RightWheel-nut3~Vectra-RearAxle-RightWheel
XWHEEL~A~XWHEELNUT~A~40~nut4~XSUPERCAR~A~Vectra-
RearAxle-RightWheel-nut4~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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 176 of 226
SIEMENS Technical Document

XWHEEL~A~XWHEELNUT~A~10~nut1~XSUPERCAR~A~Vectra-
FrontAxle-LeftWheel-nut1~Vectra-FrontAxle-LeftWheel
XWHEEL~A~XWHEELNUT~A~20~nut2~XSUPERCAR~A~Vectra-
FrontAxle-LeftWheel-nut2~Vectra-FrontAxle-LeftWheel
XWHEEL~A~XWHEELNUT~A~30~nut3~XSUPERCAR~A~Vectra-
FrontAxle-LeftWheel-nut3~Vectra-FrontAxle-LeftWheel
XWHEEL~A~XWHEELNUT~A~40~nut4~XSUPERCAR~A~Vectra-
FrontAxle-LeftWheel-nut4~Vectra-FrontAxle-LeftWheel
XAXLE99~A~XWHEEL~A~20~RightWheel~XSUPERCAR~A~Vectra-FrontAxle-
RightWheel~Vectra-FrontAxle
XWHEEL~A~XWHEELNUT~A~10~nut1~XSUPERCAR~A~Vectra-
FrontAxle-RightWheel-nut1~Vectra-FrontAxle-RightWheel
XWHEEL~A~XWHEELNUT~A~20~nut2~XSUPERCAR~A~Vectra-
FrontAxle-RightWheel-nut2~Vectra-FrontAxle-RightWheel
XWHEEL~A~XWHEELNUT~A~30~nut3~XSUPERCAR~A~Vectra-
FrontAxle-RightWheel-nut3~Vectra-FrontAxle-RightWheel
XWHEEL~A~XWHEELNUT~A~40~nut4~XSUPERCAR~A~Vectra-
FrontAxle-RightWheel-nut4~Vectra-FrontAxle-RightWheel

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 177 of 226
SIEMENS Technical Document

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.)

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~20~nut2~XSUPERCAR~A~Vectra-RearAxle-LeftWheel-nut2
XWHEEL~A~XWHEELNUT~A~30~nut3~XSUPERCAR~A~Vectra-RearAxle-LeftWheel-nut3
XWHEEL~A~XWHEELNUT~A~40~nut4~XSUPERCAR~A~Vectra-RearAxle-LeftWheel-nut4
XWHEEL~A~XWHEELNUT~A~10~nut1~XSUPERCAR~A~Vectra-RearAxle-RightWheel-nut1
XWHEEL~A~XWHEELNUT~A~20~nut2~XSUPERCAR~A~Vectra-RearAxle-RightWheel-nut2
XWHEEL~A~XWHEELNUT~A~30~nut3~XSUPERCAR~A~Vectra-RearAxle-RightWheel-nut3
XWHEEL~A~XWHEELNUT~A~40~nut4~XSUPERCAR~A~Vectra-RearAxle-RightWheel-nut4
XWHEEL~A~XWHEELNUT~A~10~nut1~XSUPERCAR~A~Vectra-FrontAxle-LeftWheel-nut1
XWHEEL~A~XWHEELNUT~A~20~nut2~XSUPERCAR~A~Vectra-FrontAxle-LeftWheel-nut2
XWHEEL~A~XWHEELNUT~A~30~nut3~XSUPERCAR~A~Vectra-FrontAxle-LeftWheel-nut3
XWHEEL~A~XWHEELNUT~A~40~nut4~XSUPERCAR~A~Vectra-FrontAxle-LeftWheel-nut4
XWHEEL~A~XWHEELNUT~A~10~nut1~XSUPERCAR~A~Vectra-FrontAxle-RightWheel-nut1
XWHEEL~A~XWHEELNUT~A~20~nut2~XSUPERCAR~A~Vectra-FrontAxle-RightWheel-nut2
XWHEEL~A~XWHEELNUT~A~30~nut3~XSUPERCAR~A~Vectra-FrontAxle-RightWheel-nut3
XWHEEL~A~XWHEELNUT~A~40~nut4~XSUPERCAR~A~Vectra-FrontAxle-RightWheel-nut4

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 178 of 226
SIEMENS Technical Document

19.8 Engineering change example

[13.3.0] This functionality no longer works in Teamcenter 12+!
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
--------------------------------
BOM FORMAT = parent_child
UPDATE BOMS = ON
CREATE BOMS = ON
BOM UPDATE OPTION = UPDATE OCCURRENCES
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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 179 of 226
SIEMENS Technical Document

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 180 of 226
SIEMENS Technical Document

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

BOM FORMAT = parent_child
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

UPDATE LATEST REV = ON

BOM UPDATE OPTION = UPDATE OCCURRENCES

BOM UPDATE ADD OCCURRENCES = ON
BOM UPDATE ID FIELDS = ChildID

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 181 of 226
SIEMENS Technical Document

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~LVarOptD
efVal~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

!~ItemID~Name~ChildID~LVarOptName~LVarOptVal~LVarOptCondition~LVarOptAction
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~ ~

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 182 of 226
SIEMENS Technical Document

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

!~ItemID~Name~ChildID~LVarOptName~LVarOptVal~LVarOptCondition~LVarOptAction
IQN-0~IQN~~Tim1~A,B,C~ ~delete
IQN-0~IQN~~Tim2~A,B,C~ ~delete
IQN-0~IQN~~Tim3~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~
LVarOptDesc~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_LGW_2~M_LGW_2 GM Legacy Option.~Y,N~~~~~~~~~
AHD53175~186~~~~~M_LGW_3~M_LGW_3 GM Legacy Option.~Y,N~~~~~~~~~
AHD53175~186~~~~~M_LGW_4~M_LGW_4 GM Legacy Option.~Y,N~~~~~~~~~

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 183 of 226
SIEMENS Technical Document

AHD53175~186~~~~~M_LCW_05~M_LCW_05 GM Legacy Option.~Y,N~~~~~~~~~

AHD53175~186~~~~~M_LCW_07~M_LCW_07 GM Legacy Option.~Y,N~~~~~~~~~
AHD53175~186~~~~~M_LCW_09~M_LCW_09 GM Legacy Option.~Y,N~~~~~~~~~
AHD53175~186~~~~~M_LCW_10~M_LCW_10 GM Legacy Option.~Y,N~~~~~~~~~
AHD53175~186~~~~~M_LCW_14~M_LCW_14 GM Legacy Option.~Y,N~~~~~~~~~
AHD53175~186~~~~~M_LBS_03~M_LBS_03 GM Legacy Option.~Y,N~~~~~~~~~
AHD53175~186~~~~~M_LBS_43~M_LBS_43 GM Legacy Option.~Y,N~~~~~~~~~
AHD53175~186~~~~~M_LBS_53~M_LBS_53 GM Legacy Option.~Y,N~~~~~~~~~

AHD53175~186~ANA47803~006~CORP_Install~IA-RR LP WRG HARN JUNC-1-

AHD53175~186~ANA47803~006~CORP_Install~IA-RR LP WRG HARN JUNC-1-

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_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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 184 of 226
SIEMENS Technical Document

#-------------------------

19.9.4 Data File 3: Miscellaneous

# -------------------------------------------
# Legacy variants
# -------------------------------------------

!~ItemID~ChildID~Qty~SeqNo~ON:Test~Uom~RM:project_id~MVarOptName~MVarOptDesc~MVar
OptVis~MVarOptValType~MVarOptVal~MVarOptDefVal~MVarOptCondition~LVarOptName~LVarO
ptDesc~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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 185 of 226
SIEMENS Technical Document

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
#-------------------------

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 186 of 226
SIEMENS Technical Document

# Set only Error If msg and condition

!~ItemID~ParentRev~ChildID~ChildRev~LVarOptName~LVarOptDesc~LVarOptVal~Ignore:LVarOptDefVal~LVarOptEr
AHD54302~001~~~[AHD54301]OPT1~~~value1-1~OPT 2 value value2-2 NOT ALLOWED~[AHD54301]OPT2 = value2

#-------------------------
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

BOM FORMAT = parent_child
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

UPDATE LATEST REV = ON

BOM UPDATE OPTION = UPDATE OCCURRENCES

BOM UPDATE ADD OCCURRENCES = ON
BOM UPDATE ID FIELDS = ChildID

FOLDER NAME = GM Load

VIEW TYPE = view
MULTI VALUE SEPARATOR STRING = ,

CREATE MODULAR VARIANT OPTION = ON

UPDATE MODULAR VARIANT OPTION = ON

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 187 of 226
SIEMENS Technical Document

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~MVarOptValT
ype~MVarOptCondition
BG00000020~A~~~MyOption006~Option desc~public~LOGICAL~
BG00000020~A~BG00000006~@@~~~~~BG00000020:MyOption006 = true

19.10.3 Data File 2

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 188 of 226
SIEMENS Technical Document

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 189 of 226
SIEMENS Technical Document

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
BomChild2~A~Project X~Value 1~Value 2
BomChild3~A~Project X~Value 1~Value 2

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 190 of 226
SIEMENS Technical Document

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
TEST_LOV~STRING~Value 5
TEST_LOV~STRING~Value 7
TEST_LOV~STRING~Value 100

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 191 of 226
SIEMENS Technical Document

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
RELATION PARENT TYPE = REV
#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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 192 of 226
SIEMENS Technical Document

Config File
-------------------------------
RELATION NAME = Ref
RELATION PARENT TYPE = REV
NEW RELATION NAME = Spec

Data File
-------------------------------
!~ItemID~ParentRev~FormName~RelationName
tim-00002~tim-00001-txt~Req

22.1 Other 8.0.0 examples

#----------------------------------------------
# Dataset in rev into another dataset in rev
#----------------------------------------------

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 PARENT TYPE = ITEM

RELATION CHILD TYPE = ITEM
UPDATE LATEST REV = OFF

!~ItemID~ChildID~RelationName

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 193 of 226
SIEMENS Technical Document

tim-98765~tim-34567~IMAN_reference

#-------------------------
# Item to Rev
#-------------------------

RELATION PARENT TYPE = REV

RELATION CHILD TYPE = ITEM
UPDATE LATEST REV = ON

!~ItemID~ChildID~RelationName
tim-98765~tim-34567~IMAN_reference

#-------------------------
# Rev to Item
#-------------------------

RELATION PARENT TYPE = ITEM

RELATION CHILD TYPE = REV
UPDATE LATEST REV = ON

!~ItemID~ChildID~RelationName
tim-98765~tim-34567~IMAN_reference

#-------------------------
# Rev to Rev
#-------------------------

RELATION PARENT TYPE = REV

RELATION CHILD TYPE = REV
UPDATE LATEST REV = ON

!~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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 194 of 226
SIEMENS Technical Document

#----------------------------------------------
# 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

#-------------------------
# 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 = FIRST

#RELATION MULTI PARENT OPTION = ALL

#RELATION MULTI CHILD 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

#----------------------------------------------
# WSOM(s) to WSOM(1)
#----------------------------------------------

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 195 of 226
SIEMENS Technical Document

RELATION MULTI PARENT OPTION = FIRST

#RELATION MULTI PARENT OPTION = ALL

#RELATION MULTI CHILD OPTION = FIRST

RELATION MULTI CHILD OPTION = ALL

!~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
#----------------------------------------------

RELATION PARENT TYPE = REV

UPDATE LATEST REV = OFF

RELATION MULTI PARENT OPTION = FIRST

#RELATION MULTI PARENT OPTION = ALL

#RELATION MULTI CHILD OPTION = FIRST

RELATION MULTI CHILD OPTION = ALL

!~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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 196 of 226
SIEMENS Technical Document

tim-98765~A~A GeneralDesignElement form~GeneralDesignElement~IMAN_reference

#----------------------------------------------
# WSOM(s) to Folder
#----------------------------------------------

#RELATION MULTI PARENT OPTION = FIRST

RELATION MULTI PARENT OPTION = ALL

#RELATION MULTI CHILD OPTION = FIRST

RELATION MULTI CHILD OPTION = ALL

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 197 of 226
SIEMENS Technical Document

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
UPDATE LATEST REV = 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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 198 of 226
SIEMENS Technical Document

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
RELATION PARENT TYPE = REV

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 199 of 226
SIEMENS Technical Document

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 200 of 226
SIEMENS Technical Document

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
UPDATE REV ATTACHMENTS = ON
UPDATE ITEM ATTACHMENTS = OFF
CREATE DATASET = ON
UPDATE DATASET = ON

#New CICO config options

CREATE CICO = OFF
UPDATE CICO = CHECK IN
CHECK OUT REASON = Guy's Check-Out test
CICO OBJECTS FILTER = Text

Data File
-------------------------------
!~ItemID~RevID~DsetName~DsetType
GUY98765~A~GUYTXT_0001~Text

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 201 of 226
SIEMENS Technical Document

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
#000006~TestFolder/SubFolderX/SubFolder3~This is SubFolder3
#000007~TestFolder/SubFolderX/SubFolder3~This is SubFolder3

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 202 of 226
SIEMENS Technical Document

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.
UPDATE LATEST REV = ON

# 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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 203 of 226
SIEMENS Technical Document

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
UPDATE LATEST REV = 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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 204 of 226
SIEMENS Technical Document

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 205 of 226
SIEMENS Technical Document

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 206 of 226
SIEMENS Technical Document

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
BOM FORMAT = parent_child
UPDATE BOMS = ON
CREATE BOMS = ON
BOM UPDATE OPTION = UPDATE OCCURRENCES
#ownership
DEFAULT OWNER = bursell
DEFAULT GROUP = Trent1700

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 207 of 226
SIEMENS Technical Document

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 208 of 226
SIEMENS Technical Document

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~FormDes
c~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
OPN2~A~ACT2~My Activity Description 2~MEActivity~5~ACT2FORM~RR_Activity
Form~My Form Description~the first attribute value~the,second,attr,array,values

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 209 of 226
SIEMENS Technical Document

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)
BOM FORMAT = parent_child
UPDATE BOMS = ON
CREATE BOMS = ON
BOM UPDATE OPTION = UPDATE OCCURRENCES
BOM UPDATE ID FIELDS = ChildID,AbsOccID

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 210 of 226
SIEMENS Technical Document

BOM REV RULE = RR Latest Agreed Scenery

#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~ProductT
argetID~ProductTargetRevID~PlantTargetID~PlantTargetRevID~OccType~TargetChildID~T
argetChildRev~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~~~~~~~~~~~~~~~~~~
GPROC1~A~~~~GOP3~A~MEOP~OP3~Op3
Description~30~GOP2~~~~~~~~~~~~~~~~~~
GPROC1~A~~~~GOP4~A~MEOP~OP4~Op4
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~~~
GPROC1~A~~~~~~~~~~~~~~~~XSUPERCAR~A~~~MEConsumed~XWHEEL~A~Vectra-
RearAxle-RightWheel~~GOP2~~~
GPROC1~A~~~~~~~~~~~~~~~~XSUPERCAR~A~~~MEConsumed~XWHEEL~A~Vectra-
FrontAxle-LeftWheel~~GOP3~~~
GPROC1~A~~~~~~~~~~~~~~~~XSUPERCAR~A~~~MEConsumed~XWHEEL~A~Vectra-
FrontAxle-RightWheel~~GOP4~~~
GPROC1~A~~~~~~~~~~~~~~~~XSUPERCAR~A~~~MEConsumed~XWHEEL~A~Vectra-
FrontAxle-RightWheel~~GOP4~~~
GPROC1~A~~~~~~~~~~~~~~~~~~STWORK1~A~MEWorkArea~STWORK0001~A~F1_W
orkArea1~~GOP1~~~
To Release an MEOP Revision, and also Status any MEActivities (any
other other attachments to Activity_Root/MEActivities).

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 211 of 226
SIEMENS Technical Document

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!
BOM FORMAT = parent_child

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

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 212 of 226
SIEMENS Technical Document

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~ItemI
D~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~
CC_test_upl_2~~MECollaborationContext~Test CC 2~tim~dba~Released~CC1~Latest
Working~CC1_SOS1~Product~Product~MEProductContext~Test Product
SC~tim~dba~Released~Product Cfg~Latest
Working~SC_SOS1~~Sub_assy1~BVR~Design
CC_test_upl_2~~MECollaborationContext~Test CC 2~tim~dba~Released~CC1~Latest
Working~CC1_SOS1~Plant~Plant~MEPlantContext~Test Plant
SC~tim~dba~Released~Plant Cfg~Latest Working~SC_SOS1~~Sub_assy2~BVR~
CC_test_upl_2~~MECollaborationContext~Test CC 2~tim~dba~Released~CC1~Latest
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~

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 213 of 226
SIEMENS Technical Document

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 correctly 4.2
SEPARATOR 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 -v to add 2.2
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 sizes:- 2.4.2
DISPLAY 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 for in 4.1
attached relations to change to the current ID.

7.0.0 VARIANTS 1) Added ability to create and update legacy and modular options and set 5.1.6
variant conditions.

CC & SC 2) Added ability to create and update Collaboration Context and Structure 14.1.2
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 independently 14.1.2.1
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. This is handy 2.3.1
to break up a file to test just the first few lines.

BL PROPS 6) Added ability to set occurrence translation matrices via the new general 2.3.2

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 214 of 226
SIEMENS Technical Document

Version TOPIC Update Link

property assignment, e.g. BL:bl_occ_xform_matrix

MODE 7) Added -mode arg equal to -m arg, to fix many confusions over the arg 2.2
name!

TYPED REFS 8) Added ability to set typed/untyped reference attributes by using TAG 2.3.2.1
and BY_VAL field modifiers.

OOTB PROPS 9) Allow OOTB property names to be used in header line instead of 2.3.2
keywords.

ARRAYS 10) Ability to enter multiple values for array attributes. This includes a 2.4.2
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 added 2.3.2.1
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 property 2.3.2
names.

ACT OWNER 13) Better definition of Activity ownership via OOTB property names. 2.3.2

OCC NAME 14) Added ability to set occurrence names via OOTB property names. 2.3.2

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 new field 2.3.2.1
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 and DELIM 2.4.2
FORMATS 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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 215 of 226
SIEMENS Technical Document

Version TOPIC Update Link

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 properties 2.3.2.3
for projects, i.e. project_ids, project_list, projects_list.

LOG FILE 2) Started to set true config option names in log file settings section. 3.1
Done General and Items settings so far as these are always shown.

LOG FILE 3) Made report settings section more appropriate to current mode. 3.1

LOG FILE 4) Now showing options with blank values to show what's available. 3.1

DUP ITEM ID 5) Added check for duplicate identifier if create item fails due to duplicate --
identifier ID with a different case.

ITEM REV RULE 6) Added new configuration option ITEM REV RULE which can be used 4.2.1
instead of UPDATE LATEST REV to identify a revision to update
based on a revision rule.

7.2.0 PREDECESSOR 1) Added ability to use SeqNo to help find unique predecessors by adding 5
MATCHING 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, OpRevID --
REVS 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, BOM, Files, 3.1
Forms and Relation settings.

7.3.3 RELATIONS 1) Added new fields RelChildType and RelChildName to specify the type 8.2.1
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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 216 of 226
SIEMENS Technical Document

Version TOPIC Update Link

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 publish 2.4.1,
LINK 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.
Unrestricted Copyright © 2023 Siemens Digital Industries Software. All rights reserved.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 217 of 226
SIEMENS Technical Document

Version TOPIC Update Link

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 functionality 8.1
to create/cut relations between any 2 workspace objects.

BOM 2) Added new general property code BLCTXT:<prop> to set BOM Line 2.3.2
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 how many 3.4
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. ProposedReviewer, 2.3.2.1
Analyst. Requires new field modifiers .PARTICIPANT with .USER,
.GROUP or .GROUP_MEMBER. 2.4.2

EFFECTIVITIES 2) Added multiple effectivity date range support and a new field EffID to 4.1.5
allow creation and update of multiple effectivities with Effectivity IDs
and allowing for shared effectivities by searching for existing
effectivities with the supplied EffID.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 218 of 226
SIEMENS Technical Document

Version TOPIC Update Link

9.0.0 POM OBJECTS 1) Added functionality to create and update almost any type of object 15
using POM functions.

9.1.0 REPEAT REVS 1) Added new option ALLOW REPEAT ITEM AND REV LINES to process 4.2.1
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 be set using 2.3.2.1
a POM function to override BMIDE rules on attributes.

POM FIELDS 2) Added new CFG option SET COLON PROPS WITH POM to supply a 2.4.2
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 = NAME:<NameField> to 4.2.1
UPDATE 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 which 4.2.1
NAME 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 LATEST REV 4.2.1
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 = ON|OFF 5.2.1
NAME 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 ADD 5.2.1
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> to specify 2.2
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.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 219 of 226
SIEMENS Technical Document

Version TOPIC Update Link

10.1.0 RELATION 1) Added new fields ChildOwner, ChildGroup, ChildPUID, ChildClass, 8.2.1
FIELDS 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 objects using 13.1.1
STATUS 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 IDENTIFIER 2.3.2
PROPS 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. This is 2.3.2.1,
LANGUAGE done by adding the field modifier .LANG[=lang], with new configuration 2.4.2
PROPERTIES 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 (substitute) 5.1.1
SUBSTITUTE revs for a BOM child.
REV IDS

10.7.0 BASIC AUTO 1) Added new config flag option AUTO GENERATE BASIC ITEM ID to 4.2.1
ITEM ID generate basic item ID.
GENERATION

10.8.0 CC/SC SOS 1) Completed functionality to create CC and SC SOS (Variant rule) 14.1.2
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 written to 4.1.1
AMPPING the auto IDs log file for reference.

10.10.0 REVISION 1) Added new support to create and update revision sequences, with 4.1.2
SEQUENCES 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 objects found to 2.3.2.1
& OWNING set by using the new .FIND=<class>,<attr> field modifier. 4.3.10.1
PROJECT This can be used to set owning_project.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 220 of 226
SIEMENS Technical Document

Version TOPIC Update Link

POM 3) GRM relations can be created using POM functions to override BMIDE 8.3.1
RELATIONS 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 multiple items 2.7
KEYS 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 use to 2.3.2.1
BOM UPDATE identify occurrences to update during a BOM update.

EXISTING O&V 3) Added O&V CHECK FOR EXISTING RULE option to stop searching 5.3.4.3
RULES 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 classed 8.4.1
CLASSES relations under ImanRelation when using RELATION BMIDE
OVERRIDE to creation the relation with POM.

11.2.0 RESOURCE 1) Added .RESOURCE_POOL field modifier for .PARTICIPANT fields. 2.3.2.1
POOL

11.3.0 DATASET TAG 1) Added .TAG support for DsetName field to supply a dataset tag (PUID) 2.3.2.4
to update a dataset by tag, e.g. in the case of multiple datasets in a
revision with the same name. 9.1.1

12.0.0 PROPAGATION 1) Added propagation support from items, revs and pom objects by 2.8
supplying the new config option PROPAGATION PATH as many times
as required..

POM TAG 2) Added tag input support for pom mode by supplying the field 2.3.2.4
<Class>.pid.KEY, e.g. Folder.pid.KEY..
16.1.1

ITEM, REV TAG 3) Added .TAG support for ItemID and RevID fields to supply an item 2.3.2.4
and/or rev tag (PUID) to update an item and/or rev by tag.
4.1.1

4.1.2

ASSIGN 4) Added new config option PROJECT ASSIGN INACTIVE PROJECTS to 11.2.1
INACTIVE control assigning inactive projects to objects.
PROJECTS

DPAM UPDATE 5) Added new config option PROJECT UPDATE DPAM DATE to 11.2.1
control updating of DPAM date when assigning projects to
objects.
POM SYSTEM 6) Better support has been added to pom owner and date system 16.1.3
FIELDS attributes so that attribute names or keywords can be supplied, e.g. for
User/owning_user and Group/owning_group.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 221 of 226
SIEMENS Technical Document

Version TOPIC Update Link

12.1.0 APPEND & FIND 1) Got .APPEND and .FIND field modifiers working together.

12.2.0 PROJECT LIST 1) Improved processing of Project Object Relation objects when setting 2.8.5
project_list attribute with and without using propagation.
2.4.2
2) Stopped .FIND working with project_list property since this now uses
dedicated code to set the project list, and project object relations if
required.

12.3.0 ID AUTO GEN 1) Fixed problem with Auto generation of Item IDs only writing new ID to 4.1.1
the New IDs Log file for every other item.

2) Added keyword options ITEM_TAG and REV_TAG to be supplied in

the AutoItemIDMapping field to extract the item or rev tag (UID) into
the log file for subsequent input back into IDU.

12.4.0 ACTIVITY 1) Improved Activity predecessor functionality by allowing a CSV of 14.1.1

PREDECESSOR Activity names or tags by adding the .TAG field modifier. Also added
(PERT Chart) some update functionality by using .REPLACE and .REMOVE field
modifiers and recognition of the NULL value to clear predecessors.

12.5.0 POR CONTROL 1) Added new config option to specify parent classes of objects to have
their own POR created when setting owning_project.

2) Added new config option to specify parent classes for objects under
which all objects will have their own POR created when setting
owning_project when using a PROPGATION PATH.

3) When setting owning_project on an object and it has its own POR the
POR’s owning_project will also be updated.

4) When creating a POR on an object its owning_project will be set to that

of the object.

12.6.0 ENHANCED 1) Enhanced .FIND modifier to allow ItemID and RevID keywords for 2.3.2.1
.FIND attribute names if searching for an item or item revision. Instead of
using a general enquiry on attributes these will specifically search for
an item or revision. Additional attributes cannot be included.

MULTI EFFS 2) Improved setting of revision effectivities to allow multiple effectivities 4.2.4
with options to replace them all or add additional ones with the config
option EFFECTIVITY UPDATE OPTION.

MFKs IN 3) Enhanced EffEndItem to find items using multikey fields using a single
EffEndItem MFK string, e.g.

item_id=M000001,object_type=PW6_MFK_TestType,pw6_mfk_key1=val1

which is a CSV list of attributes and values that specify all key fields.

NULL DPAM 4) Fixed problem with DPAM date not being set to NULLDATE for an
DATE object's new POR, upon setting project_list, when the option
PROJECT UPDATE DPAM DATE = OFF.

RELEASE 5) Fixed problem with revision release status line being written with blank
STATUS type and name columns. These columns now repeat the item rev type,

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 222 of 226
SIEMENS Technical Document

Version TOPIC Update Link

DISPLAY item id and rev id.

12.7.0 LEGACY O&V 1) Fixed crash on second line setting legacy Option & Variants default
DEFAULT VAL value.

.FIND WITH 2) The .FIND field modifier is now used with .KEY fields in creating MFK
.KEY AND MFK items. Previously the .FIND was only used in setting a tag reference
value and in finding an MFK item in the first place.

MULTI FIELDS 3) Enhanced the .FIND to allow attributes and values to be supplied in 2.3.2.1
WITH .FIND different fields where a field identifier code is supplied in the .FIND
header as .FIND=<FieldIdentifier> and its value supplies the class to 2.3.2.4
search in.

OOTB ITEM 4) Fixed an issue where OOTB post-action extensions, like createObject,
PSOT ACTIONS were not run after an item was created.

EFFECTIVITY 5) Enhanced effectivity fields EffStartDate and UnitStart to accept 4.1.5

RANGES ranges by the recognition of " to " in the date range and "," or "-" in the
unit range

BAD ITEM MSG 6) Fixed an issue where subsequent lines supplying a different rev for the
same item did not recognise that the item was not previously found or
created, which resulted in the misleading message "ITEM EXISTS AS
[]" for each subsequent revision line. This is now changed to BAD
ITEM with a corresponding line written to the repeat file.

MANDATORY 7) Fixed problem where items could not be created for types that had
ITEM Description set as mandatory. If a 'Desc' or 'I:object_desc' fields is
DESCRIPTION supplied then the value will be set at item creation time, so no need to
supply .MAND.

MULTI FIELDS 8) Enhanced .KEY field modifier to take a single field identifier, i.e. 2.3.2.1
WITH .KEY .KEY=<FieldIdentifier>, to identify the fields providing the attributes
and values used in the item MFK definition. The value of the .KEY 2.3.2.4
field itself supplies the item ID.

12.8.0 FORM .TAG 1) Enhanced the FormName field in forms mode to use the .TAG 6.1.1
modifier.

12.9.0 PARTICIPANT 1) Enhanced .PARTICIPANT field modifier to use .APPEND field modifier 6.1.1
APPEND to append participants to any existing ones.

12.10.0 FORM TYPE 1) Updated Folder create for different folder types to cater for sub-classed
folder types.

12.11.0 DUPLICATE 1) Added new config option DUPLICATE FORM NAMES = ON|OFF to 6.2.1
FORMS control the creation of multiple forms with the same name in an item or
revision.

13.0.0 FOLDERS Added new folders mode to replace folder_insert and folder_create 10
modes.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 223 of 226
SIEMENS Technical Document

Version TOPIC Update Link

13.1.0 MFK SUPPORT Added MFK support for bom fields SubstChild and Alternates. 2.7.3

5.1.1

13.2.0 CREATE 1) Added general object create functionality using TCTYPE_create_object 16.1.4
OBJECTS to the pom mode. This allows for simpler data definition to create objects,
i.e. no need to define default attributes, and creation of more object types.

2) pom mode now accepts folder definitions to put new Workspace

Objects in a folder.

13.3.0 Tc 12 : ECM Updated for Tc 12, but had to disable ECM functions accessed using the 5.1.3
ECID field as they are now deprecated with no replacement.

14.0.0 BATCH 1) New arguments to offer batch control by specifying a batch size (for the 2.2
CONTROL, number of data lines to process) and either a starting data line or a batch
number. 2.5.1
DEFAULT
VALUES LINE 2) A default values header line and data line can now be supplied to set 2.3
default property values for any fields. These can alternatively be supplied
in configuration options. 2.3.4

3) Added support for "creation_date" and "last_mod_date" in colon fields.

4) Added option value NONE to ITEM/REV RELEASE RELATIONS and

UPDATE ITEM/REV ATTACHMENT RELATIONS.

5) Added %FORMAT% notation to DsetName field to allow the dataset

name to be derived from item and rev properties, e.g.:-
%I.item_id%/%R.item_revision_id%

14.1.0 “=”s IN ItemID 1) Added new config option ALLOW ITEMID MFK FORMAT. 4.2.1

14.2.0 TABLE ATTRS 1) Added functionality to set table attributes. 2.3.5

2) The Object.FIND=… field can now be used to find parent objects in

datasets, forms and relations modes, as well as children for relations.

14.3.0 REGISTER 1) Added functionality to automatically check if a class’s application is 2.4.2

APPLICATIONS registered. But, also added option REGISTER APPLICATIONS to specify
classes.

14.4.0 BLANK VALUES 1) Added config option SET EMPTY FIELDS TO NULL = ON|OFF. 2.4.2

14.5.0 TC 13.0 1) Updated for Tc 13.0. No new functionality.

14.6.0 PARTICIPANTS 1) Added extra control for setting and updating participants. 2.4.2

2) Added check for property last_mod_user to set it correctly.

14.7.0 BO CREATE 1) Added .BO_CREATE field modifier to work like .BO_CI, but to create 2.3.2.1.1
sub/child objects immediately rather than simply define all objects before 16.2.3.3
creating the top object.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 224 of 226
SIEMENS Technical Document

Version TOPIC Update Link

2) With .BO_CREATE and .BO_CI existing objects will now be found and 16.6.4
updated.

3) Added .BRACKET_VALUE field modifier to extract a bracket value. 2.3.2.1

4) Fixed date field re-formatting getting done twice if the .POM field
modifier was used.

14.8.0 SECURITY Now uses specific API calls to set colon properties gov_classification, 2.8.6
ATTRS ip_classification and license_list.

14.9.0 POM ATTR 1) Allow the .FIND field modifier to be used to find objects to be set 16.6.5
.FIND on a referenced attribute.
BOM AUTO 2) Added new ON|OFF config option BOM AUTO SET FIND NO to 5.2.1
FIND NO control automatic setting of BOM occurrence Find (Seq) numbers.
CHECK MAC If set to ON this will override the SeqNo field.
ADDRESS 2.4.2
3) Added option ALLOWED MAC ADDRESSES FILE to specify a
file name with allowed MAC addresses to check if current machine
is allowed to run IPS Data Upload.

14.10.0 POM OBJECT 1) Added support for general Object field in pom mode. The
default to be supplied is a tag. It supports tags of different classes
and the format *.<attr> to specify common attributes, e.g.
*.owning_group.

14.11.0 EFF END ITEM 1) Added new effectivity update option UPDATE END ITEM to 4.1.5
UPDATE allow an existing end item effectivity to be updated. The
4.2.4
EffEndItem field will also take the .REPLACE modifier.

14.13.0 DEFAULT 1) Added cfg option DEFAULT CONFIGURATOR CONTEXT ID to 5.2.3

CONFIG set the global configurator context ID for setting the Variant
CONTEXT ID Formula BOM Line property with BL:bl_formula.

14.14.0 ATTACHMENTS 1) Updated item and rev attachments to be updated independently. 4.3.13

2) Reworked field finding for attachments and revisions to hopefully

improve performance.

3) Added the ability for the property owning_user to be supplied

as <user><multi-sep><group>, e.g. tim,Engineering.

14.15.0 .MAND TABLE Added support for mandatory table attributes. 2.3.5
ATTRIBUTES

14.16.0 BOM OOTB Fixed problem with security properties not propagating OOTB 5.2.1
POR during BOM creation by using new config option
PROPAGATION 4.2.1
BOM UPDATE ITEM PORS = ON.

Also added the following option to filter updated POR Groups:-

UPDATE ITEM POR GROUPS = <csv,of,POR,GroupNames>

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 225 of 226
SIEMENS Technical Document

Version TOPIC Update Link

14.17.0 GLOBAL ALTS 1) Added support to set and update Global Alternates using 4.3.14
I:global_alt_list.
MFG MFK 2) Updated all item find functions in mfg mode to use new function 2.7.3.1
ITEMS to find items using MFK fields.
ORIG FILE 3) Added new field FileOrigName in datasets mode to set the 9.1.2
NAME
original file name of an imported file.

14.18.0 RDV BOM 1) Updated BOM Occ search in mfg mode, for linking, to use RDV n/a
Search search to improve performance.

14.19.0 MRP CHILD IN 1) Added support for existing BOM fields TargetParentID and 14.1.1
PARENT TargetParentRev, and new fields ProcParentID and
ProcParentRev to mrp mode to find Product and Process children
to link under specific parents.

2) Updated the rev searches for Process and Product children to

use supplied BOM REV RULE.

Project: IPS_DATA_UPLOAD Technical Documentation Date Printed: 01/07/24

Filename: IPS_DATA_UPLOAD_14_21_0_TSD.doc Page: 226 of 226

Active Workspace Fundamentals
No ratings yet
Active Workspace Fundamentals
222 pages
NX 2412 Release Notes
No ratings yet
NX 2412 Release Notes
156 pages
Beginners Guide To Learn NXOpen Programming
No ratings yet
Beginners Guide To Learn NXOpen Programming
32 pages
Basic Teamcenter: Bill of Material Concept
No ratings yet
Basic Teamcenter: Bill of Material Concept
8 pages
TCPB Client+Core English
No ratings yet
TCPB Client+Core English
283 pages
Performing A Human Task Analysis: Preparing The Working Environment Creating A Manikin and Workspace
No ratings yet
Performing A Human Task Analysis: Preparing The Working Environment Creating A Manikin and Workspace
83 pages
NXOpen Getting Started
No ratings yet
NXOpen Getting Started
137 pages
(ENG) Product Structure Definition
No ratings yet
(ENG) Product Structure Definition
45 pages
Teamcenter9: Siemens PLM Software (RU)
No ratings yet
Teamcenter9: Siemens PLM Software (RU)
67 pages
Mbom Engine Nacell
No ratings yet
Mbom Engine Nacell
10 pages
Capital Harness XC - 231918
100% (1)
Capital Harness XC - 231918
10 pages
Designs and Structure Management
No ratings yet
Designs and Structure Management
155 pages
Business Modeler IDE Best Practices Guide V2.16
No ratings yet
Business Modeler IDE Best Practices Guide V2.16
228 pages
DS WhitePapers 3DEXPERIENCE R2019x Windows Oracle On Premise Installation V1.0
100% (1)
DS WhitePapers 3DEXPERIENCE R2019x Windows Oracle On Premise Installation V1.0
128 pages
Basic PLM Introduction
No ratings yet
Basic PLM Introduction
18 pages
What's New Teamcenter 2312
No ratings yet
What's New Teamcenter 2312
48 pages
DS WhitePapers 3DEXPERIENCE On The Cloud Native Apps Batch Installation
No ratings yet
DS WhitePapers 3DEXPERIENCE On The Cloud Native Apps Batch Installation
19 pages
Simulation Process MGMT
No ratings yet
Simulation Process MGMT
274 pages
Teamcenter Integrated Material Management
No ratings yet
Teamcenter Integrated Material Management
67 pages
TcIC V13.2.1.2 - Installation Manual
No ratings yet
TcIC V13.2.1.2 - Installation Manual
6 pages
MyTeamcenter Training Manual
No ratings yet
MyTeamcenter Training Manual
61 pages
Structure Discovery Admin
No ratings yet
Structure Discovery Admin
58 pages
Teamcenter 2007 Installation Mt00300
No ratings yet
Teamcenter 2007 Installation Mt00300
286 pages
SWX Installation Guide
No ratings yet
SWX Installation Guide
141 pages
Tcii Users Guide
No ratings yet
Tcii Users Guide
334 pages
Aerospace and Defense Install Config
No ratings yet
Aerospace and Defense Install Config
26 pages
T4S4-AW Add-On Installation Guide
No ratings yet
T4S4-AW Add-On Installation Guide
62 pages
Basic ITK Customization Concept Part-02
No ratings yet
Basic ITK Customization Concept Part-02
1 page
Teamcenter Start Guide TCM
No ratings yet
Teamcenter Start Guide TCM
146 pages
Prisonbreaker 1.5 by Jake11price
0% (1)
Prisonbreaker 1.5 by Jake11price
118 pages
CIM Combined Model Release Notes: Document Organization
No ratings yet
CIM Combined Model Release Notes: Document Organization
68 pages
Ips Data Upload 10-2-1 TSD
No ratings yet
Ips Data Upload 10-2-1 TSD
176 pages
ReleaseNotes ControlPlus V2.5.0
No ratings yet
ReleaseNotes ControlPlus V2.5.0
18 pages
Report Builder
No ratings yet
Report Builder
20 pages
Catia Comparison Features PDF
No ratings yet
Catia Comparison Features PDF
23 pages
DS WhitePapers Concurrent Engineering With 3DEXPERIENCE
No ratings yet
DS WhitePapers Concurrent Engineering With 3DEXPERIENCE
34 pages
FaithPLM Solutions SOA White Paper
No ratings yet
FaithPLM Solutions SOA White Paper
7 pages
Siemens PLM JT Plus PDF User Guide Mi 61338 A3 Tcm27 58010
No ratings yet
Siemens PLM JT Plus PDF User Guide Mi 61338 A3 Tcm27 58010
7 pages
Briefcase Browser
No ratings yet
Briefcase Browser
64 pages
Release Notes iX-230SP1 PIEN340E PDF
No ratings yet
Release Notes iX-230SP1 PIEN340E PDF
41 pages
Role of Manufactured Item Definition App
No ratings yet
Role of Manufactured Item Definition App
30 pages
Teamcenter Document Manager
No ratings yet
Teamcenter Document Manager
11 pages
2052 PLMEurope 24.10.17-17-30 BALASUNDARAM-KANTHI INTELIZIGN ENGINEERING SERV Active Workspace For External Data Aggregation and Search
No ratings yet
2052 PLMEurope 24.10.17-17-30 BALASUNDARAM-KANTHI INTELIZIGN ENGINEERING SERV Active Workspace For External Data Aggregation and Search
18 pages
Part Design 2019x
No ratings yet
Part Design 2019x
28 pages
Free Windows 10 Pro Product Key
78% (9)
Free Windows 10 Pro Product Key
3 pages
2bizbox Quick Start Tutorial v3.0.0
No ratings yet
2bizbox Quick Start Tutorial v3.0.0
24 pages
Tc14.0.0.0 ActiveWorkspace6.2.2 README
No ratings yet
Tc14.0.0.0 ActiveWorkspace6.2.2 README
5 pages
Visualization Errors
No ratings yet
Visualization Errors
34 pages
DS WhitePapers DataModelCustomizerTool
No ratings yet
DS WhitePapers DataModelCustomizerTool
18 pages
3 Master Model Concept Misconceptions - The PLM Dojo
No ratings yet
3 Master Model Concept Misconceptions - The PLM Dojo
9 pages
FMSCacheSizingTool Instructions v1 2
No ratings yet
FMSCacheSizingTool Instructions v1 2
27 pages
Tennis Industry Magazine
No ratings yet
Tennis Industry Magazine
64 pages
Teamcenter 10.1. Installation On Windows Servers Guide. Publication Number PLM00013 J
No ratings yet
Teamcenter 10.1. Installation On Windows Servers Guide. Publication Number PLM00013 J
398 pages
87 Eng
No ratings yet
87 Eng
35 pages
Bim and Modular Mep Systems For Super-Tall and Mega-Tall Buildings
No ratings yet
Bim and Modular Mep Systems For Super-Tall and Mega-Tall Buildings
10 pages
Degree (BCA) Marks Card
No ratings yet
Degree (BCA) Marks Card
1 page
Client For Ms Office
No ratings yet
Client For Ms Office
136 pages
Deploying Document Management
No ratings yet
Deploying Document Management
112 pages
Assembly Arrangements With Unigraphics NX2
No ratings yet
Assembly Arrangements With Unigraphics NX2
13 pages
Electronic Evidence in Tanzania
100% (1)
Electronic Evidence in Tanzania
171 pages
Shared Memory Best Practices Guide V1.0
No ratings yet
Shared Memory Best Practices Guide V1.0
20 pages
Teamcenter
No ratings yet
Teamcenter
2 pages
Apriso WhitePaper How Next Gen MOM Can Drive
No ratings yet
Apriso WhitePaper How Next Gen MOM Can Drive
10 pages
6044Q1 Specimen Software Engineering
No ratings yet
6044Q1 Specimen Software Engineering
4 pages
Designcontext
No ratings yet
Designcontext
52 pages
As - Built - Manager
No ratings yet
As - Built - Manager
168 pages
Gs - Product - Visualization
No ratings yet
Gs - Product - Visualization
288 pages
PLM Express Chart Catia v5
No ratings yet
PLM Express Chart Catia v5
2 pages
Program Planning
No ratings yet
Program Planning
160 pages
Clearance - DB - Admin
No ratings yet
Clearance - DB - Admin
260 pages
Clearancedb Admin Guide
No ratings yet
Clearancedb Admin Guide
220 pages
Lesson 2 Empowerment Midterm
No ratings yet
Lesson 2 Empowerment Midterm
5 pages
Service - Manager
No ratings yet
Service - Manager
256 pages
Content MGMT
No ratings yet
Content MGMT
286 pages
Service - Planner
No ratings yet
Service - Planner
192 pages
Service - Execution
No ratings yet
Service - Execution
148 pages
Ecad - Viewer
No ratings yet
Ecad - Viewer
126 pages
Gs - Customization
No ratings yet
Gs - Customization
12 pages
Dispatcher Install and Configure
No ratings yet
Dispatcher Install and Configure
106 pages
Cacheless Search Deployment
No ratings yet
Cacheless Search Deployment
52 pages
Data Share Manager
No ratings yet
Data Share Manager
36 pages
DPV Tutorial
No ratings yet
DPV Tutorial
36 pages
Manufacturing Based On Feature Recognition Using N
No ratings yet
Manufacturing Based On Feature Recognition Using N
6 pages
Itimti C Tce Oracledbsetup
No ratings yet
Itimti C Tce Oracledbsetup
21 pages
SIH JurisAI - Ctrl+Shift+Hack
No ratings yet
SIH JurisAI - Ctrl+Shift+Hack
6 pages
West Module
No ratings yet
West Module
56 pages
Ebook Cloud Landscape and Smart Platform Decisions
No ratings yet
Ebook Cloud Landscape and Smart Platform Decisions
16 pages
Jake S Resume Anonymous
No ratings yet
Jake S Resume Anonymous
1 page
JT2Go Desktop Frequently Asked Questions
No ratings yet
JT2Go Desktop Frequently Asked Questions
6 pages
Team Center IDA
No ratings yet
Team Center IDA
2 pages
IncIDFA OOPSLA25
No ratings yet
IncIDFA OOPSLA25
51 pages
अभियोजन जर्नल, वर्ष ३, अंक १ । - 1608015140
No ratings yet
अभियोजन जर्नल, वर्ष ३, अंक १ । - 1608015140
369 pages
7.1 5.18 John The Ripper
No ratings yet
7.1 5.18 John The Ripper
10 pages
Uts 3 Minute Thesis
100% (3)
Uts 3 Minute Thesis
6 pages
SDE 1 Fullstack
No ratings yet
SDE 1 Fullstack
3 pages
FAQ - Scalability - Performance - and - Quick Sizer - Public - Cloud-ERP - V1 (Official Format)
No ratings yet
FAQ - Scalability - Performance - and - Quick Sizer - Public - Cloud-ERP - V1 (Official Format)
11 pages
OS Functions Definition of Systems and Its Information
No ratings yet
OS Functions Definition of Systems and Its Information
14 pages
Cisco Secure Firewall Threat Defense Hardening Guide Version 72 - Last Updated 30 April 2022
No ratings yet
Cisco Secure Firewall Threat Defense Hardening Guide Version 72 - Last Updated 30 April 2022
18 pages
Nits 02-03 Dec
No ratings yet
Nits 02-03 Dec
23 pages
Fall Semester 2024-25 - SWE4007 - TH - AP2024252000662 - 2024-09-13 - Reference-Material-I
No ratings yet
Fall Semester 2024-25 - SWE4007 - TH - AP2024252000662 - 2024-09-13 - Reference-Material-I
21 pages
The Notorious PM Quadtree: The Instrument of Your Torture
No ratings yet
The Notorious PM Quadtree: The Instrument of Your Torture
56 pages
Expectation Handling
No ratings yet
Expectation Handling
13 pages
Docker Project
No ratings yet
Docker Project
20 pages
TheAgileCoach 2025edition AgileScrumGuide Com
No ratings yet
TheAgileCoach 2025edition AgileScrumGuide Com
5 pages
Transcom Itv
No ratings yet
Transcom Itv
20 pages
C209 Java Eclipse Guide
No ratings yet
C209 Java Eclipse Guide
16 pages
Valentini 2009
No ratings yet
Valentini 2009
11 pages
Differences Between SAP S4 HANA and Other ERPs
No ratings yet
Differences Between SAP S4 HANA and Other ERPs
4 pages
Examples:: (Optional Parameter) Text Format Response As Text (Default), XML Format
No ratings yet
Examples:: (Optional Parameter) Text Format Response As Text (Default), XML Format
2 pages