Teamcenter Gateway for Oracle EBS Configuration Guide

TeamcenterGateway forOracle EBS-ConfigurationGuide

Contents

Preface 5

Introduction 1-1

Basic ConfigurationThe File t4o_mapping_config.sd ──────────────────────────── 2-1Provide Oracle EBS Account Information ─────────────────────── 2-4

Accessible EBS DataEBS Fields T4O Can Read from ───────────────────────────── 3-1EBS Fields T4O Can Write to ─────────────────────────────── 3-3

Part Transfer - Inventory ItemIntroduction ───────────────────────────────────────── 4-1Global Preferences for Item ─────────────────────────────── 4-2Mapping Specifics for Item ─────────────────────────────── 4-4Maintain Item Basic Data ──────────────────────────────── 4-7

Create Item ──────────────────────────────────────────── 4-8Update Item ─────────────────────────────────────────── 4-9Generate Item ID ──────────────────────────────────────── 4-11Maintain Description ───────────────────────────────────── 4-14Read Item ──────────────────────────────────────────── 4-15Get Item Cost Information ────────────────────────────────── 4-15Get Item On-Hand Quantitiy ───────────────────────────────── 4-16Get Item Sub Inventory Information ──────────────────────────── 4-16

Maintain Item Revision ───────────────────────────────── 4-16Create Item Revision ────────────────────────────────────── 4-16Update Item Revision ───────────────────────────────────── 4-18Get Item Revision Information ──────────────────────────────── 4-18

Maintain Item in Orgs ────────────────────────────────── 4-18Get Item Organizations ──────────────────────────────────── 4-21

Maintain Item Category Assignments ──────────────────────── 4-21Assign Item to Category ─────────────────────────────────── 4-22Update Item Category Assignment ───────────────────────────── 4-23Delete Item Category Assignments for Category Set ────────────────── 4-23Delete All Item Category Assignments ─────────────────────────── 4-23Get Item Category Assignments ─────────────────────────────── 4-24

Maintain Item Catalog Assignment ───────────────────────── 4-24Assign Item to Catalog ──────────────────────────────────── 4-25Delete Item Catalog Assignment ────────────────────────────── 4-25Maintain Item Descriptive Elements ──────────────────────────── 4-25Get Item Descriptive Elements ──────────────────────────────── 4-27

Configuration Guide 2© 2019 Siemens

Maintain Item Cross References ─────────────────────────── 4-27Get Item Cross References ────────────────────────────────── 4-29

Maintain Attachments ───────────────────────────────── 4-30Create Attachment ─────────────────────────────────────── 4-34Update Attachment ────────────────────────────────────── 4-40Delete Attachment ─────────────────────────────────────── 4-41Delete All Attachments ──────────────────────────────────── 4-41Link Document to Several Items ─────────────────────────────── 4-41Get Attachments ──────────────────────────────────────── 4-42Export Attached File ────────────────────────────────────── 4-43

Maintain Item via ECO ────────────────────────────────── 4-43Implement ECO for Item ─────────────────────────────────── 4-47Transfer or Copy Engineering Item to Manufacturing ────────────────── 4-48Get ECOs for Item ─────────────────────────────────────── 4-49

Maintain Item Manufacturer Part Numbers ──────────────────── 4-49Get Manufacturer Numbers ───────────────────────────────── 4-51Get Manufacturer ─────────────────────────────────────── 4-51

Maintaining APC User Defined Attributes ───────────────────── 4-52

Product Structure Transfer - Bill Of MaterialIntroduction ───────────────────────────────────────── 5-1Global Preferences for BOM ─────────────────────────────── 5-2Mapping Specifics for BOM ─────────────────────────────── 5-5Maintain BOM Basic Data ──────────────────────────────── 5-9

Create BOM ──────────────────────────────────────────── 5-9Update BOM ────────────────────────────────────────── 5-16Create Alternate BOM ───────────────────────────────────── 5-18Update Alternate BOM ──────────────────────────────────── 5-18Read BOM ──────────────────────────────────────────── 5-18

Maintain BOM in Orgs ────────────────────────────────── 5-19Get BOM Organizations ──────────────────────────────────── 5-20

Maintain Reference Designators ─────────────────────────── 5-20Maintain Substitute Components ────────────────────────── 5-20Maintain Attachments ───────────────────────────────── 5-21

Create Attachment ─────────────────────────────────────── 5-22Update Attachment ────────────────────────────────────── 5-23Delete Attachment ─────────────────────────────────────── 5-23Delete All Attachments ──────────────────────────────────── 5-23Link Document to Several Items ─────────────────────────────── 5-23Get Attachments ──────────────────────────────────────── 5-23Export Attached File ────────────────────────────────────── 5-23

Maintain BOM via ECO ───────────────────────────────── 5-23Implement ECO for BOM ─────────────────────────────────── 5-27Transfer or Copy Engineering BOM to Manufacturing ────────────────── 5-27Get ECOs for BOM ─────────────────────────────────────── 5-28

Change Transfer - Engineering Change Order

Contents


Introduction ───────────────────────────────────────── 6-1Global Preferences for ECO ─────────────────────────────── 6-2Mapping Specifics for ECO ──────────────────────────────── 6-4Maintain ECO Basic Data ───────────────────────────────── 6-5

Create ECO ──────────────────────────────────────────── 6-5Update ECO ──────────────────────────────────────────── 6-6Read ECO ───────────────────────────────────────────── 6-7

Maintain ECO Revision ────────────────────────────────── 6-7Create ECO Revision ─────────────────────────────────────── 6-8Update ECO Revision ────────────────────────────────────── 6-8

Maintain ECO in Orgs ─────────────────────────────────── 6-9Get ECO Organizations ───────────────────────────────────── 6-9

Maintain Item via ECO ────────────────────────────────── 6-9Maintain BOM via ECO ────────────────────────────────── 6-9Implement ECO ─────────────────────────────────────── 6-9Maintain Attachments ───────────────────────────────── 6-10

Create Attachment ─────────────────────────────────────── 6-11Update Attachment ────────────────────────────────────── 6-12Delete Attachment ─────────────────────────────────────── 6-12Delete All Attachments ──────────────────────────────────── 6-12Link Document to Several Items ─────────────────────────────── 6-12Get Attachments ──────────────────────────────────────── 6-12Export Attached File ────────────────────────────────────── 6-12

Data TransferConfigure the T4O Menu Functions ────────────────────────── 7-1Configure the Transfer Window ──────────────────────────── 7-3Configure the Data Import ──────────────────────────────── 7-5Configure the EBS Dataview ────────────────────────────── 7-8Configure the EBS Forms Display ─────────────────────────── 7-15Configure the External Queries ──────────────────────────── 7-18

Query for Items ───────────────────────────────────────── 7-20Query for Item Templates ────────────────────────────────── 7-20Query for BOMs ──────────────────────────────────────── 7-20Query for ECOs ───────────────────────────────────────── 7-21

Troubleshooting T4O and EBS Errors 8-1

Glossary A-1

4 Configuration Guide© 2019 Siemens

PrefaceThis documentation cannot be used as a substitute for consulting advice, because it can never considerthe individual business processes and configuration. Despite our best efforts it is probable that someinformation about functionality and coherence may be incomplete.

Issue: December 2019

Legal notice:

All rights reserved. No part of this documentation may be copied by any means or made available toentities or persons other than employees of the licensee of the Teamcenter Gateway for Oracle E-Business Suite or those that have a legitimate right to use this documentation as part of theirassignment on behalf of the licensee to enable or support usage of the software for use within theboundaries of the license agreement.

© 2010-2019 Siemens Product Lifecycle Management Software Inc.

Trademark notice:

Siemens, the Siemens logo and Opcenter are registered trademarks of Siemens AG.

Camstar and Teamcenter are trademarks or registered trademarks of Siemens Product LifecycleManagement Software Inc. or its subsidiaries in the United States and in other countries.

Oracle is a registered trademark of Oracle Corporation.

SAP, R/3, SAP S/4HANA®, SAP Business Suite® and mySAP are trademarks or registered trademarks of SAPor its affiliates in Germany and other countries.

TESIS is a registered trademark of TESIS GmbH.

All other trademarks, registered trademarks or service marks belong to their respective holders.


1. IntroductionThe Teamcenter Gateway Oracle E-Business Suite (T4O) software solution is a general purposeintegration software that provides data and process integration between Teamcenter® by Siemens PLMand ORACLE® E-Business Suite by Oracle Corporation.

T4O provides a wide range of interactive and workflow functions to transfer and synchronize databetween Teamcenter and Oracle EBS.

Configuration Guide 1-1© 2019 Siemens

1. Introduction

1-2 Configuration Guide© 2019 Siemens

2. Basic Configuration

2.1 The File t4o_mapping_config.sd

The file t4o_mapping_config.sd in the directory <T4O_ROOT>\var\mmap\t4o_mapping_config is thefirst file that is read by the T4O software in the context with mapping functionality. It may contain basicsettings as well as variables which are supposed to be used in more than one mapping file (see how todefine the direct mapping of constants in chapter Further Basics in the Active Integration - GenericConfiguration Guide).

Since T4O V11.2.1, there is one generic mapping configuration file t4o_mapping_config.sd and severalEBS system specific sub files t4o_mapping_config_<ebs system id>.sd. The generic mappingconfiguration file t4o_mapping_config.sd only contains comprehensive settings valid for all EBSsystems, whereas each sub file t4o_mapping_config_<ebs system id>.sd contains EBS system specificsettings.

Caution:

• The file t4o_mapping_config.sd must not be renamed as T4O will read it and check there whichmapping files to use.

• The EBS system specific mapping configuration files need to be named in the following way:

t4o_mapping_config_<ebs system id>.sd

The <ebs system id> must be equal to the one specified in t4o_mapping_config.sd (see below).Don’t use any other file names!

• The generic file t4o_mapping_config.sd and all its sub files t4o_mapping_config_<ebs systemid>.sd are only read at T4O startup, not in every transaction. Therefore, it is impossibleevaluating anything there that changes during T4O runtime, because the result will be the samein every run. So for example if you want to get a time stamp and define that in this file, thecontent of this variable will be the same every time you use it. Please use the object typespecific mapping files for current calculations. Some Teamcenter related data are alsoimpossible to read there, most importantly the TC DB name: ::TcData(SiteIdName)

Generic Configuration File t4o_mapping_config.sd

The following basic configuration data can be set in generic mapping configuration filet4o_mapping_config.sd:

• EBS system IDs for configured EBS systems (TC preference key T4O_EBSLogonSystemList)Example:

set lstEbsSystems [list "EBS1" "EBS4" "EBS5" "EBS6" "EBS7" "EBS8"]


https://docs.plm.automation.siemens.com/content/pl4x/19.2/T4O/en_US/generic_configuration_guide/preface.html


For each of those systems, a corresponding file t4o_mapping_config_<ebs system id>.sd needs to beset up. If not yet existing, create respective file in directory <T4O_ROOT>\var\mmap\t4o_mapping_config.

• System login data; see chapter Provide Oracle EBS Account Information

• One of the paragraphs in this file is for telling T4O which files contain the customer accessiblemapping functions.Example:

source -relax t4o_item_mapping_template.sd

This means T4O has to read the content of the file t4o_item_mapping_template.sd. The argument -relax means the file is looked up in the memory first and only if its content is not there, the file isloaded from disc (only in the same directory <T4O_ROOT>\var\mmap\t4o_mapping_config). Inprinciple, the file names may be modified freely as long as the file extension .sd is kept. Every filestated there that has the file extension .sd is actually used for the mapping functionality. In fact theonly file T4O actually uses for the mapping is the compiled mapping file t4o_mapping_config.rfdt. Sothis is what you need to think about in order to create the compiled mapping file correctly.In order to not use a mapping file it is enough to not "source" it in t4o_mapping_config.sd. However,we strongly recommend keeping only those mapping files in the mmap directory that you really wantto use!

Caution:

Be sure to have the correct file names (the files located in <T4O_ROOT>\var\mmap\t4o_mapping_config) in the "source" section of this file

• One of the last sections of this file is for sourcing the TCL language files and for activating thepreferred language.Refer to the section starting with comment: # Source TCL language filesIn that example, the language is defined in variable strLanguageCode. Please check the file namesin <T4O_ROOT>/var/lang/T4O/ for getting all supported language codes. The value of variablestrLanguageCode is overwritten by the value of environment variable TP_LANGUAGE_CODE, ifdefined.

EBS System Specific Files t4o_mapping_config_<ebs system id>.sd

The following EBS system dependent configuration data can be set in files t4o_mapping_config_<ebssystem id>.sd (for every EBS system, you need to duplicate the listed settings, add them to a separatefile t4o_mapping_config_<ebs system id>.sd and change the values according to the new system):

• EBS connection settings (please see chapter Modify the File t4o_mapping_config.sd in the ActiveIntegration - Installation Guide for details)

• Definition of System Items Key Flexfield – only needed if the following factors are both relevant foryour system:



https://docs.plm.automation.siemens.com/content/pl4x/19.2/T4O/en_US/installation_guide/preface.html

https://docs.plm.automation.siemens.com/content/pl4x/19.2/T4O/en_US/installation_guide/preface.html

• The item numbers are configured to consist of more than one segment.

• Unique index MTL_SYSTEM_ITEMS_INTERFACE_UC1 has been created in your system.

There's no need to define the System Items Key Flexfield in the following cases (see the TeamcenterGateway for Oracle EBS - EBS Preparation Guide):

• You don’t use multi key flexfields for items at all.

• You use multi key flexfields for items but the recommended non-unique indexMTL_SYSTEM_ITEMS_INTERFACE_NC1 (instead of the unique one) is installed on your system.

• You use multi key flexfields for items but none of the above mentioned indexes is installed on yoursystem.

Caution:

• Please verify if your EBS system already fulfills the requirements for System Items KeyFlexfield, as described in chapter Requirements for System Items Key Flexfield in theTeamcenter Gateway for Oracle EBS - EBS Preparation Guide.

• Regardless of the index you are using, you need to consider the following in the item datamapping: The attribute P_ITEM_NUMBER needs to be specified in correct form, comprisingall segments separated by the delimiter, see chapter Set Key Flex Fields for Item for details.

• JDBC only: JDBC Log Level (INFO, ALL, FINE or FINEST)Example:

# Internal logging - possible values: INFO, ALL, FINE, FINER and FINESTset ::T4O_Defaults(JDBC:LOG_LEVEL:$strSystemId) "INFO";

• JDBC only: Oracle JDBC driver logging using the debug version of a JDBC driverIn order to enable JDBC driver logging, use a debug version of respective JDBC driver (replace the jarfile in <T4O_ROOT>/lib/modules directory of the T4O installation). Additionally, uncomment thefollowing line in the t4o_mapping_config_<ebs system id>.sd:

#set ::T4O_Defaults(JDBC:DEBUG_PROP_FILEPATH:$strSystemId) \"[rcwd]/var/conf/oracle_jdbc_logging.properties"

The JDBC driver logging properties can be configured in file <T4O_ROOT>/var/conf/oracle_jdbc_logging.properties.Once you have finished those configurations, a JDBC trace log will be created in directory<T4O_ROOT>/tmp.

• JDBC only: Switch to enabe/disabe SQL trace (TRUE or FALSE)Example:

The File t4o_mapping_config.sd


https://docs.plm.automation.siemens.com/content/pl4x/19.2/T4O/en_US/preparation_guide/preface.html



set ::T4O_Defaults(JDBC:ACTIVATE_SQL_TRACE:$strSystemId) "FALSE"

• ISG only: Switch for using TPCO encoding: If Unicode characters should be transferred via ISG and theXML parser fails while processing the payload, please set this value to TRUE. By default, this switch isdeactivated, as otherwise a "stronger" encoding function for the XML payload would be used.Therefore, only set this to TRUE, if you need to support transferring Unicode characters.Example:

set ::T4O_Defaults(ISG:USE_TPCO_ENCODING:$strSystemId) "FALSE"

You also have to set the following key to the correct TC encoding:

set ::T4X::TC::MAPPING::CtrlInfo(useTcCodePage) "utf-8"

You can find the encoding set currently used by Teamcenter in the TCserver syslog file, e.g.:

TC_CHARACTER_ENCODING_SET=UTF8

For more details about how to modify the T4x encoding, refer to respective section in chapter FurtherBasics in the Active Integration - Generic Configuration Guide.

2.2 Provide Oracle EBS Account Information

This functionality may be used in order to be able to work without having to enter EBS login data; it isalso known as EBS AutoLogin.

The settings described here have to be done in the file t4o_mapping_config.sd. Each modification ofthis file requires rebuilding the mapping; see chapter Mapping Best Practices in the Active Integration- Generic Configuration Guide.

Use Cases

• Storing and Using Oracle EBS Account Information in the Mapping

• Storing Oracle EBS Account Information for More Than One Oracle EBS Account to Be Used in aWorkflow






Caution:

• The AutoLogin line must not contain comment signs (#) nor any additional characters.

• Make sure to pair any opening and closing square brackets [ ] properly.

• Do not use a dollar sign in any password because TCL will try and replace the following part by avariable content that does not exist most probably.

• The defined AutoLogin is always used for AIG scripts and jobs, even if you did another login(especially another user) by the test login script for ITK or EBS, respectively.

• If any of the strings contains special characters (most likely for the password), enclose it inquotation marks.

Storing and Using Oracle EBS Account Information in the Mapping

In order to use any account information in the mapping, it has to be stored in the central database onthe BGS using the EBS connection test script. Afterwards, thefunction ::T4X::CONNECTION2EA::setCredentialsAlias4UseCase can be used in the mappingto define which credentials alias is used by T4O; see the T4O API Reference for details. Make sure thatthe alias used in the mapping matches the alias previously stored.

In general:

::T4X::CONNECTION2EA::setCredentialsAlias4UseCase T4O <Destination> <CredentialsAlias> <Mode>::T4X::CONNECTION2EA::selectActiveConnection2EA T4O * <Destination>

Example:

::T4X::CONNECTION2EA::setCredentialsAlias4UseCase T4O EBS4 MyCredentialsAlias WORKFLOW::T4X::CONNECTION2EA::selectActiveConnection2EA T4O "*" "EBS4"

The call of function setCredentialsAlias4UseCase defines the connection to EBS; more than onecan be defined in the T4O mapping.

The call of function selectActiveConnection2EA defines which of the defined connections T4Oshould use if not specified explicitly (e.g. using a workflow handler argument). It has to be setadditionally to a setCredentialsAlias4UseCase call in order to make sure that this EBS connectionshould be used by default.

Provide Oracle EBS Account Information


https://docs.plm.automation.siemens.com/docs/pl4x/19.2/en_US/API_Doc_t4o.zip

Caution:

• Since V10.1.3, T4O is shipped with new OOTB responsibilities. If upgrading from an olderversion, don’t forget to replace the old responsibility keys TESIS_INVENTORY_USER/TESIS_INVENTORY_SUPER_USER by the new keys T4O_READ_ONLY_USER/T4O_USER insetConnectionInfoPlain call.

• Only the parameter Mode is optional; if omitted, this Oracle EBS connection is used foreverything but SCRIPTING (see below).

• Be sure to write the values for Destination and Mode in upper case letters (unless theDestination is really defined with lower case letters which is usually not the case).

• If you need more than one Oracle EBS auto login (e.g. WORKFLOW for one user and SCRIPTINGfor another one), define them in separate lines.

• In any case (one or more accounts defined), you have to define the "active" Oracle EBSconnection (last line in the example above). This one will be used automatically if nothing elseis specified, e.g. by manual selection or workflow handler argument.

• Using this auto login means that many T4O EBS transactions will be done with the same EBSuser (also known as "Technical user", as defined here) although they are triggered fromdifferent human users. Please make sure that you are in compliance with Oracle EBS licensingrequirements when you define communication via a Technical user. Setting up suchcommunication is not meant to circumvent any licensing requirements per your softwarecontract with Oracle EBS; it is only meant for user convenience.

The parameter Mode determines for which transaction types this account information should be used.The possible key words are as follows:

• PORTAL: use this for all T4O transactions where a user uses the T4O Gateway Menu to initiate atransfer or is using the Dataview. Alternatively, you may specify a separate EBS login for handling eachportal transaction on each object type separately (the key words are always PORTAL<target_type> <transaction>), e.g.:

PORTALITEMDISPLAY

for Item Display

PORTALITEMCREATE_HID

for Item Create

PORTALITEMCHANGE_HID

for Item Change



PORTAL BOMDISPLAY

for BOM Display

PORTAL *EBSDATA_VIEW

for the EBS Dataview

• WORKFLOW: use this for all T4O transactions from a workflow, see below

• SCRIPTING: use this for the T4O Admin UI scriptsNote, that scripts using the T4O job functionality need BATCH instead

• BATCH: use this for T4O transactions launched from the T4O Job Server, including T4O Admin UIscripts using the T4O job functionality (each script with the word "job" in its name)

• QUERY: use this for the T4O user query functionality. In order to use it for specific queries only, addthe query name to this call (else it is used for any T4O user query), e.g.:

::T4X::CONNECTION2EA::setCredentialsAlias4UseCase T4O EBS4 MyCredentialsAlias QUERY T4O_DEMO_QUERY

• parameter omitted or using *: this is a combination of all the modes besides SCRIPTING

• ALL: supports all use cases, i.e., would be the same as * and SCRIPTING combined

Please consider the following specifics for parameter Mode:

• If you are in doubt which mode is the correct one for your desired functionality, start trying withoutthe last parameter for testing.

• If the value for Mode is none of the listed ones, T4O will ignore the line. So if it does not work asexpected, please check exactly the number and position of each parameter value and the spelling.

• Any mode that is not covered by such an AutoLogin definition will require a manual EBS login. Thusyou may have to login manually to the EBS although there was a successful transaction before.

• Those T4O EBS AutoLogins are cached in the tpapps process, only the one for SCRIPTING is cached onthe BGS. Therefore, after removing the SCRIPTING AutoLogin from the mapping and restarting the GS,T4O will not use any AutoLogin any more besides the one for SCRIPTING. This will still be available forthe Admin UI scripts as long as the BGS is running or it is deleted explicitly. This may be done in themapping using:

T4X::CONNECTION2EA::deleteConnectionInfo T4O $Destination SCRIPTING

• When only a SCRIPTING connection is defined (no other modes), you may omit the additional linewith selectActiveConnection2EA; any other usage needs that additional line.



• If such a line is added to the t4o_mapping_config.sd file, this account will be used for Oracle EBSaccess and the user will not be able using another Oracle EBS connection for the given mode bylogging in manually; not even another user name with the same Oracle EBS system.

Storing Oracle EBS Account Information for More Than One Oracle EBS Account to Be Usedin a Workflow

Please make sure T4O is working with all those EBS accounts as expected using the manual EBS login,before configuring the following!

In order to use different Oracle EBS systems in workflows (in one workflow job or using differentworkflow templates) do the following:

• Store and define each of the needed Oracle EBS accounts as described above using the script andsetCredentialsAlias4UseCase in the mapping, e.g.:::T4X::CONNECTION2EA::setCredentialsAlias4UseCase T4O EBS1MyCredentialsAlias::T4X::CONNECTION2EA::setCredentialsAlias4UseCase T4O EBS2MyOtherCredentialsAlias

• In each workflow template where one of those Oracle EBS accounts should be used, the workflowargument -use_EBS_system may be added to the corresponding T4O handler, e.g. with the valueEBS1 in the handler T4O-transfer-Item.

• This defined Oracle EBS system will be used in this and subsequent workflow tasks and jobs as long asthere is no other Oracle EBS system definition.

• In order to use the same EBS connection in each task of the same workflow template and checkingthis connection at the beginning of each workflow job, we recommend setting those arguments inthe rule handler T4O-validate-EBSLogon instead, i.e. before any T4O handler, e.g.:



T4O determines the EBS system to be used in a workflow handler as follows:

• As long as no T4O workflow handler with the argument -use_EBS_system was executed in thisT4O session (i.e. since T4O was started), T4O will use the Oracle EBS connection from the lastdefinition with selectActiveConnection2EA in the file t4o_mapping_config.sd in everyworkflow handler.

• As soon as a T4O workflow handler with the argument -use_EBS_system was executed, T4O willgo on using this EBS connection until another connection is defined.

• As this may result in different behavior when executing several jobs of the same workflow templates,we recommend either using the handler argument -use_EBS_system in every T4O workflowhandler, or not using it at all.



3. Accessible EBS Data

3.1 EBS Fields T4O Can Read from

This chapter describes how to identify the EBS fields you can read via T4O.

T4O provides test scripts for retrieving EBS object data (for Item, BOM, ECO, Routing and Configurator):<object_type> get data. If executing such a script for a valid EBS object (Item "CS13081301" inthe example below) and setting script parameter Show empty fields to TRUE, you will get allpossible read fields of respective object type:


The command for accessing a specific field of a previously read Oracle EBS objectis ::T4O::TC::MAPPING::EBSFieldMapping. Before calling that function, the EBS data must beretrieved via a function get<object_type>Info (e.g. ::TPEBS::ITEM::getItemInfo).

If using the EBSFieldMapping command in the "reverse mapping" in conjunction with functionstoreReverseMappingAttribute, the basic data of the EBS object should have already been readby T4O at this point. Thus, there is no need to explicitly retrieve the EBS data in that case.

However, explicitly reading EBS data is necessary in the following cases:

• for reading additional data of the EBS object; use a function get<additional_data>Info for thatpurposeExample: Getting cost information for an EBS item usingfunction ::TPEBS::ITEM::getItemCostsInfo

• for data federation, e.g. for the Dataview

• for data import

• in a test script

In order to get more information about function EBSFieldMapping, see the T4O API Reference.

Example for EBSFieldMapping:

set InvItemStatus [::T4O::TC::MAPPING::EBSFieldMapping Item \X_ITEM_REC:INVENTORY_ITEM_STATUS_CODE]

This example gets the inventory item status code of a previously read Oracle EBS item. The firstparameter of function EBSFieldMapping gets the Oracle EBS object type (e.g. Item, ECO, BOM), thesecond parameter gets the EBS field name that is structured as follows: (all sub-strings are separated by":"):

• First sub-string (X_ITEM_REC in above example) stands for an EBS record type used in respective T4OPL/SQL read call

• Second sub-string (INVENTORY_ITEM_STATUS_CODE in above example) contains the data field ofrespective EBS object type T4O should read from

If the PL/SQL API uses an EBS table type, the structure of second parameter of functionEBSFieldMapping is a bit different, e.g.:

set CompItemName [::T4O::TC::MAPPING::EBSFieldMapping BOM \X_BOM_COMPONENT_TBL:X_BOM_COMPONENT_TBL_ITEM:COMPONENT_ITEM_NAME:2]




This example reads the Oracle EBS component item name of second component record in the currentBOM component table. For table types, the second parameter of function EBSFieldMapping isstructured as follows (all sub-strings are separated by ":"):

• First sub-string (X_BOM_COMPONENT_TBL in above example) stands for an EBS table type used inrespective T4O PL/SQL read call

• Second sub-string (X_BOM_COMPONENT_TBL_ITEM in above example) stands for an EBS record typeused in respective T4O PL/SQL read call

• Third sub-string (COMPONENT_ITEM_NAME in above example) contains the data field of respectiveEBS object type T4O should read from

• Last sub-string (2 in above example) is a counter of the records in respective table

Read EBS data without trimming blanks

Same as with functions FieldMapping and IndexedFieldMapping (for getting Teamcenter datafields), function EBSFieldMapping (for getting EBS data fields) trims away leading and trailing blanksfrom the strings read from the EBS.

If you need to change that default behavior, add the optional parameter TrimValue to the call and setit to FALSE.

So if you want to keep the blanks from the EBS data, modify the call, e.g. from:

set xy [::T4O::TC::MAPPING::EBSFieldMapping ECO \X_FOUND_ECO_TBL:X_FOUND_ECO_TBL_ITEM:DESCRIPTION:$Index]

to:

set xy [::T4O::TC::MAPPING::EBSFieldMapping ECO \X_FOUND_ECO_TBL:X_FOUND_ECO_TBL_ITEM:DESCRIPTION:$Index FALSE]

See the T4O API Reference for more details.

3.2 EBS Fields T4O Can Write to

This chapter describes how to identify the EBS fields you can set in T4O mapping functions.

For setting Oracle EBS data in the mapping, T4O provides a data structure analogous to the Oracle EBSwrite functions (e.g. EGO_ITEM_PUB.Process_Item). This means that T4O can write to all fieldssupported by called PL/SQL APIs. For more details on supported fields of a specific PL/SQL API, pleaserefer to interface details page of the API in Oracle Integration Repository.

The T4O data structure to be filled with the EBS data is: ::EBSDat. That data structure is a global array.

EBS Fields T4O Can Write to



T4O provides a test script for getting detailed information about possible parameters to be used in themapping for Item, BOM, ECO, Routing, Configurator and Attachment: MISC get interfacedescription. This script will ask you for a Function Call (Item, BillOfMaterial,BillOfMaterial Variant, ChangeOrder, Routing or Attachment) and will return all relatedfields of the ::EBSDat array:



Any statement in the mapping that starts with "set ::EBSDat" hands data to Oracle EBS.

Example:

set ::EBSDat(Item:PARAMETER:P_DESCRIPTION) "T4O Transfer Test"

This example sets the description for the Item in Oracle EBS to T4O Transfer Test. The string inbraces specifies an element of the global array ::EBSDat and has the following structure (all sub-strings are separated by ":"):

• First sub-string (Item in above example) stands for the EBS object type.

• Second sub-string contains either the name of an EBS record type used in respective PL/SQL API or oneof the following T4O internal identifiers:

• PARAMETER (as in above example): for setting a simple PL/SQL API parameter

• CtrlParam: for setting a T4O internal control parameter

• Last sub-string (P_DESCRIPTION in above example) contains the data field of respective EBS objecttype T4O should write to.

If the PL/SQL API uses an EBS table type, the structure of an element in ::EBSDat array is a bit different,e.g.:

set ::EBSDat(Bom:P_BOM_COMPONENT_TBL:P_BOM_COMPONENT_TBL_ITEM:COMPONENT_ITEM_NAME:2) \ $ItemId

This example sets the Oracle EBS component item name of second component record in the currentBOM component table to the value in variable ItemId. The string in braces is structured as follows (allsub-strings are separated by ":"):

• First sub-string (Bom in above example) stands for the EBS object type.

• Second sub-string (P_BOM_COMPONENT_TBL in above example) contains the name of an EBS tabletype used in respective PL/SQL API.

• Third sub-string (P_BOM_COMPONENT_TBL_ITEM in above example) contains the name of an EBSrecord type used in respective PL/SQL API.

• Fourth sub-string (COMPONENT_ITEM_NAME in above example) contains the data field of respectiveEBS object type T4O should write to.

• Last sub-string (2 in above example) is a counter of the records in respective table.



Oracle EBS Inventory Item Fields

T4O can write to all inventory item related fields supported by the following PL/SQL APIs:

• EGO_ITEM_PUB.PROCESS_ITEM (full parameter-list version; display name: Process Item)

• EGO_ITEM_PUB.PROCESS_ITEM_REVISION

• EGO_ITEM_PUB.ASSIGN_ITEM_TO_ORG

• EGO_ITEM_PUB.PROCESS_ITEM_CAT_ASSIGNMENT

• INV_ITEM_CATALOG_ELEM_PUB.PROCESS_ITEM_DESCR_ELEMENTS

• MTL_CROSS_REFERENCES_PUB.PROCESS_XREF

For additional information on supported inventory item fields, please refer to respective PL/SQL APIdescription, e.g. in the Oracle Integration Repository.

Oracle EBS BOM Fields

T4O can write to all bill of material related fields supported by the following PL/SQL API:

• BOM_BO_PUB.PROCESS_BOM (multiple structures version; display name: "Process Multiple Structures/BOM")

For additional information on supported BOM fields, please refer to the BOM_BO_PUB API description,e.g. on "Create, Add or Update Bill of Material Business Entities" interface details page of OracleIntegration Repository.

Oracle EBS ECO Fields

T4O can write to all engineering change order related fields supported by the following PL/SQL API:

• ENG_ECO_PUB.PROCESS_ECO

For additional information on supported ECO fields, please refer to the ENG_ECO_PUB API description,e.g. on "Create or Update Change" interface details page of Oracle Integration Repository.

Oracle EBS Attachment Fields

T4O can write to all attachments related fields supported by the following PL/SQL API:

• T4O_DOC_1910.TP_PROCESS_DOCUMENT



Be aware that those fields can only be set in the context of one of the main transfers (Item, BOM, ECO),as the attachment transfer is implemented as a so called "additional" transfer.

For detailed information on supported attachment fields, please refer to the T4O_DOC_1123 APIdescription, e.g on "Teamcenter Gateway for Oracle EBS - Documents" interface details page of OracleIntegration Repository.



4. Part Transfer - Inventory Item

4.1 Introduction

Please read the Active Integration - Generic Configuration Guide first to understand the basics for thischapter.

Nomenclature

Teamcenter EBS

Item or Part (Inventory) Item: Master Item or Organization Item

ItemRevision or PartRevision Item Revision

T4O Specifics Compared to the Generic Mapping

Export

TargetTypeName ItemMapping template t4o_item_mapping_template.sd

Mapping namespace ::T4O::ITEM::CUSTOM::MAPPINGBasic mapping function TC_Object2EBS_ItemBasic reverse mapping function EBS_Item2TC_ObjectPreferences start with T4O_ItemHandler T4O-transfer-Item

T4O-validate-ItemSee the T4O API Reference for more details.

Import Job

Job type T4O_IMPORT_ITEMMapping template t4o_item_import_template.sd

Relationship between TC and EBS Objects

When initially transferring a TC Item to the EBS (based on a TC Item Revsion!), a corresponding Item iscreated in the EBS. If a new EBS Item is created, there will always be an initial Item Revision in the EBS(regardless whether Item Revision transfer is activated or not). Each further TC Item Revision will then bemapped to a corresponding Item Revision in the EBS. Therefore the relation between TC Item and EBSItem is 1:1, as well as the relation between TC Item Revision and EBS Item Revision.

If you are transferring Item Revisions to the EBS, please see chapter Maintain Item Revision.




Mapping Examples

The mapping examples of the following chapters can be found in file t4o_item_mapping_template.sd indirectory <T4O_ROOT>/var/template/capabilities/T4O. In this documentation, we refer to the examplesin that file in the following format:

<Capability Name> - <mapping file name>

Example:

Create Item - t4o_item_mapping_template.sd

The referenced example can be found in respective mapping template, by searching for theCapability Name. In the mapping template, the capability comment has the following format:

CapabilityName : <Capability Name>

The example starts right below the found comment, e.g.:

4.2 Global Preferences for Item

Please see chapter Object Transfer Specific Preferences in the Active Integration - GenericConfiguration Guide for information about how to configure the preferences for the object datamapping in general.

In the generic preferences, the <TargetTypeName> needs to be replaced by Item and the prefix<T4x> needs to be replaced by T4O.

The following basic preferences are available for defining the item data mapping from Teamcenter toEBS:





• T4O_ItemTypeList

• T4O_ItemDisplayableTypeList (optional)

• T4O_ItemMapping4

• T4O_ItemMapping2

• T4O_ItemFieldMapping2 (optional)

Definition of TC Item Revision Types Which Should be Supported

Example definition of two Item Revision types for usage with T4O:

T4O_ItemTypeList=ItemRevisionEBS2T4O_Item Revision

Caution:

Only Item Revisions (no Items) and Part Revisions can be defined! An item transfer is always basedon TC objects of class type ItemRevision or its children.

Use optional preference T4O_ItemDisplayableTypeList in order to enable only a subset of typesdefined with T4O_ItemTypeList for Item in the T4O GUI; see Definition of Teamcenter Objects YouWant to Support in the T4O GUI for details.

Definition of Related TC Objects That Contribute Relevant Attributes to the Mapping

Example for defining the related TC data objects from which you want to pass data to Oracle EBS viaT4O:

T4O_ItemMapping4EBS2T4O_Item Revision=items_tag:EBS2T4O_Itemitems_tag:EBS2T4O_Item:IMAN_master_form:EBS2T4O_Item Masteritems_tag:EBS2T4O_Item:#__getAllProperties__#:PropertiesIMAN_master_form_rev:EBS2T4O_Item Revision Master#__getAllProperties__#:PropertiesIMAN_classification:icm0

Definition of Related TC Objects To Store Back Information

Example for the configuration of the TC data objects which are allowed to receive data from Oracle EBSby T4O:

Global Preferences for Item


T4O_ItemMapping2EBS2T4O_Item Revision=EBS2T4O_Item RevisionIMAN_master_form_rev:EBS2T4O_Item Revision Masteritems_tag:EBS2T4O_ItemT4O_ItemMapping2ItemRevision=

The example contains the handling for the Item Revision Type EBS2T4O_Item Revision. It describesthe reverse mapping of data to the EBS2T4O_Item Revision Master using the Teamcenter relationIMAN_master_form_rev and to the EBS2T4O_Item Revision itself, as well as theEBS2T4O_Item.

In that example the key T4O_ItemMapping2ItemRevision is left empty, thus T4O does not store anydata to a Teamcenter ItemRevision.

Definition of Related Fields on TC Objects To Store Back Information

Example for specifying the TC attributes and properties where T4O should write to:

T4O_ItemFieldMapping2IMAN_master_form_rev:EBS2T4O_Item Revision Master=ebs2ItemNoebs2SentItem2EBSebs2SentItem2EBSDate

T4O_ItemFieldMapping2EBS2T4O_Item Revision=object_desc

T4O_ItemFieldMapping2items_tag:EBS2T4O_Item=item_id

4.3 Mapping Specifics for Item

Mapping from Teamcenter to Oracle EBS

The custom function that handles the item data mapping from Teamcenter to Oracle EBS isTC_Object2EBS_Item in mapping file t4o_item_mapping_template.sd. This function gets passed thetransaction ID (which is equal to the name of transaction log file), the Teamcenter item type and itemrevision type.

By default, the customer-specific item mapping function TC_Object2EBS_Item distinguishes twoitem transfer types depending on the value of attribute ebs2EcoNo (which is included into the ItemRevision Master form by the default T4O installation):

• ebs2EcoNo is empty: Normal Item transfer→ Mapping function TC_Object2EBS_Item_Standard is called which contains the actual itemmapping; see chapter Create Item



• ebs2EcoNo contains an ECO ID: Item transfer with ECO (as revised item)→ Mapping function TC_Object2EBS_Item_ECO is called which contains the actual ECO reviseditem mapping; see chapter Maintain Item via ECO

To see which fields are available for the mapping of Teamcenter data to Oracle EBS item data, have alook into chapter EBS Fields T4O Can Write to.

The fields of the ::EBSDat array to be filled with the EBS Item data begin with Item: (e.g.Item:PARAMETER:P_DESCRIPTION for the EBS Item description).

Mapping from Oracle EBS to Teamcenter ("reverse mapping")

The custom function that handles the item data reverse mapping from Oracle EBS to Teamcenter isEBS_Item2TC_Object.The input parameters of this function are the transaction ID (which is equal tothe name of transaction log file), the status, the corresponding Oracle EBS item number and the OracleEBS organization code. With this item number and organization code an enquiry is done to Oracle EBS.

In order to get information about which EBS fields T4O can read, refer to chapter EBS Fields T4O CanRead from.

By default, the customer-specific item reverse mapping function EBS_Item2TC_Object distinguishestwo item transfer types depending on the value of control parameter useEco4ItemTransfer (whichis set in the custom mapping function TC_Object2EBS_Item):

• useEco4ItemTransfer = FALSE: Normal Item transfer→ Reverse mapping function EBS_Item2TC_Object_Standard is called which contains the actualitem reverse mapping

• useEco4ItemTransfer contains any other value than FALSE: Item transfer with ECO (as reviseditem)→ Reverse mapping function EBS_Item2TC_Object_ECO is called which contains the actual ECOreverse mapping.

Mapping of additional Item Data ("additional transfer")

Besides the data of the item itself, it is possible to transfer some additional data. This means that thoseadditional data are created and maintained after the actual item transfer but within the sameTeamcenter workflow (T4O Item) or interactive functionalities like "Item Create". They are configured inthe same mapping file responsible for the item transfer (t4o_item_mapping_template.sd).

The following "additional transfers" are supported in the context of an item transfer:

• Create or update an Item Revision for an Item: Create Item Revision and Update Item Revision

• Assign an Item to another inventory organization: Maintain Item in Orgs

Mapping Specifics for Item


• Maintain Item category assignments: Maintain Item Category Assignments

• Maintain an Item catalog assignment: Maintain Item Catalog Assignment

• Maintain Item cross references: Maintain Item Cross References

• Maintain attachments for an Item: Maintain Attachments

• Implement the ECO linked to an Item: Implement ECO for Item

For each additional item data mapping, you will find a separate sub-function in item mapping templatet4o_item_mapping_template.sd. All those sub-functions contain a switch in order to activate ordeactivate respective additional transfer and they are called by the generic item mapping functionTC_Object2EBS_Item.

The following mapping status will cause T4O skipping the main item transfer (e.g. if the item alreadyexists and should be left unchanged), but executing all activated additional transfers only:

set Status "ADDITIONALUPDATESONLY"

This mapping status can be used as return status in the main mapping function TC_Object2EBS_Itemor any underlying function.

In general, all the above listed "additional transfers" are available for both item transfer types: standardand ECO based.

But by default, the standard item transfer only executes the following additional transfers (if activated inrespective sub-functions):

• Create an Item Revision for an Item

• Assign an Item to another inventory organization

• Assign an Item to a category

• Assign an Item to a Catalog Groupt including Descriptive Elements

• Assign cross references to an Item

• Assign document attachments to an Item

The ECO based item transfer only executes the following additional transfer (if activated in respectivesub-function) by default:

• Implement corresponding ECO for an Item



However, it is possible to use the default standard additional transfers also for ECO based item transfersand vice versa. You can control this by enabling the following switches (they’re disabled by default):

set ::EBSDat(Item:CtrlParam:PerformECOAdditionalTransfers4Standard) "TRUE"

This setting will allow executing ECO implementations also for standard item transfers.

set ::EBSDat(Item:CtrlParam:PerformStandardAdditionalTransfers4ECO) "TRUE"

This setting will allow executing all standard additional transfers (see list above) also for ECO based itemtransfers.

You may set those switches in generic item mapping function TC_Object2EBS_Item.

Transferring Several Sets of Similar Data in one Transaction ("multi transfer")

T4O offers this functionality in order to transfer several sets of data (e.g. organization specific Item datafor more than one organization) to EBS in one T4O transaction although these data actually need oneEBS transaction each. In fact, T4O transfers them in several steps to EBS (because otherwise EBS wouldnot store all the data correctly) but from the user’s point of view it appears as one transaction only. Theadvantage is that all the data can be defined more easily in the mapping without additional steps (e.g.using more than one workflow handler with different arguments).

T4O supports the "multi transfer" for ITEM, BOM, ECO and Routing.

Use function ::T4O::storeEBSDat2MultiTransferCache in order to take a snapshot ofthe ::EBSDat array for each single transaction. Therefore, all the data for one single transaction shouldbe set before the call of this function. For Item multi transfers, you should call it like the following:

::T4O::storeEBSDat2MultiTransferCache Item

For an example, refer to Create Item in Orgs via "Multi Transfer" from the Teamcenter Gateway forOracle EBS - Configuration Guide

4.4 Maintain Item Basic Data

Unlike in Teamcenter, all attribute values are stored on the EBS Item itself and not on the revision. Datacan be mapped from all Teamcenter entities that are connected by any kind of relation to the workflowtarget (ItemRevision).

The following chapters describe the main capabilities T4O provides for maintaining basic EBS Item data.

Maintain Item Basic Data


https://docs.plm.automation.siemens.com/content/pl4x/19.2/T4O/en_US/configuration_guide/preface.html


4.4.1 Create Item

Use Cases

• Create Item

• Check Item Exists

Create Item

T4O Configuration

For an example of setting the basic data for creating an EBS Item for the first time, refer to respectivesection in mapping function TC_Object2EBS_Item_Standard:

Create Item - t4o_item_mapping_template.sd

For testing that functionality, use test script ITEM create.

The following basic data for an EBS Item should be set in the ::EBSDat array:

• Item:PARAMETER:P_ITEM_NUMBER

• Item:PARAMETER:P_DESCRIPTION

• Item:CtrlParam:P_ORGANIZATION_CODE

In order to get a list of all fields you can set for Item creation, refer to chapter EBS Fields T4O Can Writeto.

If you want to use a different item number in Teamcenter and in EBS, it is useful to fill one of theTeamcenter attributes with the EBS item number.

Check Item Exists

T4O Configuration

T4O provides the function ::TPEBS::ITEM::checkItemExistence to check if an Item alreadyexists in the EBS. Please see the T4O API Reference for more details.




4.4.1.1 Set Key Flex Fields for Item

T4O Configuration

If in your EBS system multiple segments are configured for the System Items Key Flexfield, please makesure to specify the P_ITEM_NUMBER in proper form comprising all segments separated by the delimiter.

Example:

set ::EBSDat(Item:PARAMETER:P_ITEM_NUMBER) "$ItemId-$Description"

This example would set the item number for a flexfield that consists of two segments sepereated bydelimiter "-".

Please check if you need to define the structure of System Items Key Flexfield in filest4o_mapping_config_<ebs system id>.sd, see chapter The File t4o_mapping_config.sd.

4.4.1.2 Create Item from Template

T4O Configuration

For an example of applying a specific EBS Item Template when creating an Item in the EBS, refer torespective section in mapping function TC_Object2EBS_Item_Standard:

Create Item from Template - t4o_item_mapping_template.sd

In that example a template is applied for item creation, only if a template name is specified in attributeuser_data_3 (from item master form).

You need to specify the template ID instead of the template name in the ::EBSDat array. In order to getthe template ID for a given template name, use function getItemTemplateId.

4.4.2 Update Item

If the EBS Item has already been created in EBS or by T4O, each following transaction will be an ItemUpdate by default. In general, you can set the same attributes for updating an Item as for creating anItem (see chapter EBS Fields T4O Can Write to).

Use Cases

• Adding additional data to an Item

• Changing existing data on an Item

• Deleting existing data on an Item

Set Key Flex Fields for Item


• Check Item is Engineering Item

Adding additional data to an Item

T4O Configuration

In order to set additional data on an item, just specify respective fields in mapping functionTC_Object2EBS_Item_Standard.

Changing existing data on an Item

T4O Configuration

In order to change existing data, just adapt respective fields in mapping functionTC_Object2EBS_Item_Standard.

Deleting existing data on an Item

T4O Configuration

In order to clear a field in the EBS (set it to null in the database), do the following (in mapping functionTC_Object2EBS_Item_Standard):

• If you transfer an empty string to EBS, nothing will happen.

• For EBS ITEM (item, item revision and cross reference attributes only), BOM, ECO and Attachments:To clear an EBS Item, BOM, ECO or Attachments attribute you must call functionEBSClearAttribute for respective attribute:

::T4O::TC::MAPPING::EBSClearAttribute \"Item:PARAMETER:P_ITEM_CATALOG_GROUP_ID"::T4O::TC::MAPPING::EBSClearAttribute \"Attachment:PARAMETER:P_DOCUMENT_DESCRIPTION"

The first example clears the catalog group of respective item.The second example clears the description of respective attachment.



Caution:

• For EBS ITEM, clearing fields is possible only for the following attributes:

• Item: all elements of ::EBSDat array beginning with Item:PARAMETER:

• Item Revision: all elements of ::EBSDat array beginning with ItemRev:PARAMETER:

• Item Cross Reference: all elements of ::EBSDat array beginning withItemCrossReference:P_XREF_TBL:P_XREF_TBL_ITEM:

• To get all supported fields that can be cleared for Item, run test script MISC get interfacedescription for Function Call Item and search for ::EBSDat array names beginningwith the strings listed above; see chapter EBS Fields T4O Can Write to

• For EBS Item: Only call function EBSClearAttribute for an attribute that is nullable in EBSItem and that is included in the above list.

• For EBS BOM, ECO and Attachments: Generally, you can call function EBSClearAttribute forany attribute that is nullable in EBS BOM, ECO and Attachments.

Check Item is Engineering Item

T4O Configuration

T4O provides the function ::TPEBS::ITEM::checkItemIsEngineeringItem to check if an EBSItem is an engineering item or not.

Please see the T4O API Reference for more details.

In order to get an example and to test that functionality, use test script ITEM check engineeringitem.

4.4.3 Generate Item ID

T4O allows the interaction with EBS from Teamcenter "New Item" dialog box when assigning an Item ID.The functionality is controlled by preferences and a dedicated mapping file.

Use Cases

• Retrieve number from EBS (T4X_IDGEN_USE_EXTERNAL_NUMBER)

• Validate a number against EBS (T4X_IDGEN_EXTERNAL_VERIFY_OF_NUMBER)

Generate Item ID



After T4O retrieved the new number, it will validate if any object with this ID already exists in the othersystem. If the new number was retrieved from EBS, T4O checks in Teamcenter if an Item with thatnumber already exists. If the number was given from Teamcenter, T4O checks against EBS if this numberis already used.

For checking the Teamcenter ID against the EBS it can happen that the given number is already taken.Therefore the process runs a loop to draw the number. In default case the loop is limited to 10 attempts– if a free number is found earlier the loop will be discontinued. The number of attempts can be de-/increased by setting the preference T4X_IDGEN_max_loop, see below.

Specific Configuration in TC

Preferences for using the ID generation by T4O:

• Mandatory: Enable Teamcenter to load the additional T4x library libt4x_idgen:

TC_customization_libraries=libt4olibt4x_idgen

• Mandatory: Define a list of valid Item Types that will retrieve the number from EBS via T4O:

T4X_IDGEN_TypeList=EBS2T4O_Item

Item Types that are not listed will retrieve the number from Teamcenter naming rules (i.e. they willnot use this T4x functionality).

• Mandatory: Define the correct target system (usually T4O, but may also be T4S in a T4O installationthat is combined with T4S)

T4X_IDGEN_TargetSystem4EBS2T4O_Item =T4O

• Optional: Define the desired function to use (default: T4X_IDGEN_USE_EXTERNAL_NUMBER); see theuse cases below

• Optional: Define the maximum number of validation checks and repetitions before T4O aborts withan error (single integer value; default value is 10):

T4X_IDGEN_max_loop=10

T4O Configuration



There is one mapping file that contains functions for both use cases: t4o_idgen_mapping_template.sd

Please refer to the given examples in the mapping file in order to get more information on how to pull anumber from EBS, how to change the number to desired format or how to validate if an object alreadyexists in the EBS for given number.

Retrieve number from EBS (T4X_IDGEN_USE_EXTERNAL_NUMBER)

Retrieves the number from EBS as defined in the idgen mapping file.


Define to use function T4X_IDGEN_USE_EXTERNAL_NUMBER with the following preference setting:

T4X_IDGEN_Function4EBS2T4O_Item=T4X_IDGEN_USE_EXTERNAL_NUMBER

Specific Configuration in EBS

T4O retrieves a new number from EBS by getting the next available number of a given EBS databasesequence. Thus a database sequence must exist in the EBS database. → Ask your database administratorto create one.

Caution:

Make sure that your EBS system is configured to not allow the manual assignment of numbersthat are in the same range as the ones returned by used DB sequence. Thus it should be excludedthat the DB sequence (used for both, EBS auto-numbering and T4O IDGEN functionality) returns anumber that is already in use.

T4O Configuration

With that use case, the mapping function getReservedNumber will be called, which in turn will callthe item specific mapping function getReservedNumber4Item. Adapt those functions accordingly toyour specific needs.

In order to get the next available value of the EBS database sequence, you need to callfunction ::TPEBS::BASE::getNextDatabseSequenceNumber_SQL. Pass the database sequencename and according owner (usually the APPS schema) to it.

The example from the default mapping retrieves the next available number from EBS database sequenceT4O_AUTONUM_ITEM in APPS schema:

Generate Item ID (Retrieve number from EBS) - t4o_idgen_mapping_template.sd

Generate Item ID


Validate a number against EBS (T4X_IDGEN_EXTERNAL_VERIFY_OF_NUMBER)

Uses Teamcenter naming rules and then validates in EBS if an object already exists with this new ID inTeamcenter. A valid Teamcenter naming rule must be configured in BMIDE!


Define to use function T4X_IDGEN_EXTERNAL_VERIFY_OF_NUMBER with the following preferencesetting:

T4X_IDGEN_Function4EBS2T4O_Item=T4X_IDGEN_EXTERNAL_VERIFY_OF_NUMBER

T4O Configuration

With that use case, the mapping function checkIfObjectExists will be called, which in turn will callthe item specific mapping function checkIfObjectExists4Item. Adapt those functions accordinglyto your specific needs.

You may either use function ::TPEBS::ITEM::getItemId (organization independent) orfunction ::TPEBS::ITEM::checkItemExistence (organization dependent) in order to checkwhether an EBS item already exists for given ID; see the example from the default mapping:

Generate Item ID (Validate a number against EBS) -t4o_idgen_mapping_template.sd

4.4.4 Maintain Description

T4O supports transferring the EBS item attributes Description and Long Description.

Use Cases

• Set Description in Current EBS Session Language

• Set Description in Multiple Languages

Set Description in Current EBS Session Language

T4O Configuration

The description settings (attributes Description and Long Description) for the current EBSsession language are done via the base item settings, e.g.:

set ::EBSDat(Item:PARAMETER:P_DESCRIPTION) \"short description for current session language"



set ::EBSDat(Item:PARAMETER:P_LONG_DESCRIPTION) \"long description for current session language"

Set Description in Multiple Languages

T4O supports transferring the EBS item description in multiple languages during a single itemtransaction.

T4O Configuration

An example section for setting a description in multiple languages is included in mapping functionTC_Object2EBS_Item_Standard:

Maintain Description (Set Description in Multiple Languages) -t4o_item_mapping_template.sd

The item description settings in such a section are for languages additional to the current EBS sessionlanguage. However, the description settings for current session language are always done as describedabove!

4.4.5 Read Item

T4O Configuration

T4O provides the function ::TPEBS::ITEM::getItemInfo for getting detailed information of anexisting EBS item. If the item was found, the retrieved data will be returned in global TCLarray ::ItemResultDat.


In order to get an example and to test that functionality, use test script ITEM get data.

When transferring an item to the EBS, that function is internally called by T4O. Thus there is no need toexplicitly call that function in that case.

4.4.6 Get Item Cost Information

T4O Configuration

T4O provides the function ::TPEBS::ITEM::getItemCostsInfo for getting detailed costinformation for an existing EBS item. The retrieved data will be returned in global TCLarray ::ItemCostsResultDat.


Read Item




In order to get an example and to test that functionality, use test script ITEM COSTS get data.

4.4.7 Get Item On-Hand Quantitiy

T4O Configuration

T4O provides the function ::TPEBS::ITEM::getItemOnHandQuantity for getting the on-handquantity for an existing EBS item. The retrieved data will be returned in global TCLarray ::ItemOnHandResultDat.


In order to get an example and to test that functionality, use test script ITEM get onhand quantity.

4.4.8 Get Item Sub Inventory Information

T4O Configuration

T4O provides the function ::TPEBS::ITEM::::TPEBS::ITEM::getItemSubinventoryInfo forgetting detailed sub inventory information of an existing EBS item. The retrieved data will be returned inglobal TCL array ::ItemSubinventoryResultDat.


In order to get an example and to test that functionality, use test script ITEM COSTS get data.

4.5 Maintain Item Revision

Unlike in Teamcenter, an EBS Item Revision only stores a revision label, a description and an effectivitydate. So storing Item Revision specific attributes is not possible, apart from the description.

The following chapters describe the main capabilities T4O provides for maintaining EBS Item Revisions.

4.5.1 Create Item Revision

If a new item is created, there will always be an initial revision in Oracle EBS (regardless whether itemrevision transfer is activated or not). Creating any further Item Revisions is handled as an "additionaltransfer" (see Mapping of additional Item Data ("additional transfer")) and can be activated in themapping.

Use Cases

• Create Item Revision





• Check Item Revision Exists

Create Item Revision

T4O Configuration

Creating a new Item Revision for an Item is done in mapping functionTC_Object2EBS_Item_ItemRevTransfer (called by generic item mapping functionTC_Object2EBS_Item); for an example refer to the code in that function:

Create Item Revision - t4o_item_mapping_template.sd

For testing that functionality, use test script ITEM REVISION create.

The fields of the ::EBSDat array containing the data for an EBS Item Revision begin withItemRev:PARAMETER:.

In general, you need to consider the following for configuring the Item Revision Transfer in the mapping:

• Turn on the switch ItemRevTransfer, as by default:

set ::EBSDat(Item:CtrlParam:ItemRevTransfer) "TRUE"

• Set the new item revision in field ItemRev:PARAMETER:P_REVISION of the ::EBSDat array.

• Also define the fields ItemRev:PARAMETER:P_DESCRIPTION,ItemRev:PARAMETER:P_EFFECTIVITY_DATE and ItemRev:PARAMETER:P_REVISION_LABELfor the new revision.

• You need to specify the item (including organization) for which the item revision should bemaintained in fields ItemRev:PARAMETER:P_ITEM_NUMBER andItemRev:PARAMETER:P_ORGANIZATION_CODE.

• In the example of the mapping template, the P_EFFECTIVITY_DATE of the item revision is set byfunction ::T4O::getTimeString4Now. That function returns the time string for ‘now’ of the T4Osystem (host where GS is running).

• If you need to explicitly set a date in attribute P_EFFECTIVITY_DATE, the value has to be providedin the following format:

YYYY-MM-DDTHH:MM:SS.000<TIMEZONE for T4O system, e.g. +01:00>

For determining the time zone of the T4O system, use function T4O::getT4OTimezone:

set ::EBSDat(ItemRev:PARAMETER:P_EFFECTIVITY_DATE) \"2010-12-01T12:00:00.000[::T4O::getT4OTimezone]"

Create Item Revision


Check Item Revision Exists

T4O Configuration

T4O provides the function ::TPEBS::ITEM::checkItemRevExistence to check if an Item Revisionalready exists in the EBS. Please see the T4O API Reference for more details.

4.5.2 Update Item Revision

If the EBS Item Revision has already been created in EBS or by T4O, each following transaction will be anItem Revision Update by default.

T4O Configuration

In order to change existing data on an Item Revision, just adapt respective fields in mapping functionTC_Object2EBS_Item_ItemRevTransfer.

4.5.3 Get Item Revision Information

T4O Configuration

T4O provides the function ::TPEBS::ITEM::getItemRevInfo4Item for getting detailedinformation of all existing item revisions for an existing EBS item. The retrieved item revisions will bereturned in global TCL array ::ItemRevResultDat.


In order to get an example and to test that functionality, use test script ITEM REVISION get data.

4.6 Maintain Item in Orgs

EBS Organizations typically relate to business units or manufacturing/assembly locations of a company.Items are org specific, the exception is a set of attributes on the item like the unit of measure, which hasto be the same for all organizations (master controlled attributes).

When creating an EBS Item for the first time via T4O, it will be created in a master organization.Maintaining the Item in any further inventory organization can be implemented using one of thefollowing options:

• Pure assignment of an item to one or more organizations applying the attribute values from themaster item. This is handled as an "additional transfer" (see Mapping of additional Item Data("additional transfer")) and can be activated in the mapping.





• Full creation of one or more child items applying the attribute values from the mapping within oneitem transaction. This is handled as a "multi transfer" (see Transferring Several Sets of Similar Data inone Transaction ("multi transfer")).

Assign Item to Orgs via "Additional Transfer"

Use that option, if you want to assign an item to multiple organizations by just applying the attributevalues from the master item to all child items. This option is the same as using the "OrganizationAssignment" window in Oracle Forms UI.

T4O Configuration

Assigning an Item to another inventory organization via "additional transfer" is done by mappingfunction TC_Object2EBS_Item_AssignItem2Org (called by generic item mapping functionTC_Object2EBS_Item); for an example refer to the code in that function:

Maintain Item in Orgs (Assign Item to Org) - t4o_item_mapping_template.sd

For testing that functionality, use test script ITEM organization assignment.

The fields of the ::EBSDat array containing the data for an EBS organization assignment begin withAssignItem2Org:PARAMETER:.

In general, you need to consider the following for configuring the organization assignment in themapping:

• By default, no organization assignment will be created for the item. To activate organizationassignment, turn on the switch AssignItem2Org:

set ::EBSDat(Item:CtrlParam:AssignItem2Org) "TRUE"

• Set the new inventory organization in fieldAssignItem2Org:PARAMETER:P_ORGANIZATION_CODE of the ::EBSDat array.

• It is possible to assign the item to more than one organization by indexing the AssignItem2Orgsection of the ::EBSDat array, e.g. for assigning an item to organizations "S1" and "D1":

set ::EBSDat(AssignItem2Org:PARAMETER:P_ORGANIZATION_CODE:0) "S1"set ::EBSDat(AssignItem2Org:PARAMETER:P_ITEM_NUMBER:0) \$::EBSDat(Item:PARAMETER:P_ITEM_NUMBER)set ::EBSDat(AssignItem2Org:PARAMETER:P_PRIMARY_UOM_CODE:0) "" #set ::EBSDat(AssignItem2Org:PARAMETER:P_ORGANIZATION_CODE:1) "D1"set ::EBSDat(AssignItem2Org:PARAMETER:P_ITEM_NUMBER:1) \$::EBSDat(Item:PARAMETER:P_ITEM_NUMBER)set ::EBSDat(AssignItem2Org:PARAMETER:P_PRIMARY_UOM_CODE:1) ""

Maintain Item in Orgs


• As soon as you try to create an organization assignment that already exists for the item, you’ll get anerror message like the following:T4O (EBS Org Assign): Item CS13070102 already exists in the organization Chicago SubassemblyPlant. Please use a different item name/number.To avoid getting this error message, you can configure the mapping to only create the organizationassignment if it doesn’t exist yet. Therefore, use function getItemOrganizations beforehand, inorder to get all assigned organizations for an EBS item.

Create Item in Orgs via "Multi Transfer"

Use that option, if you want to create an item in multiple organizations by setting different data fordifferent organizations.

T4O Configuration

In order to implement that approach, you need to adapt the mapping functionTC_Object2EBS_Item_Standard like the following:

1. First set the data for the master item.

2. Call function ::T4O::storeEBSDat2MultiTransferCache in order take a snapshot ofthe ::EBSDat array for the master item.

3. Set the data for the child item. You only need to set those data that are different to the masteritem.

4. Again call function ::T4O::storeEBSDat2MultiTransferCache in order to take anothersnapshot of the ::EBSDat array for the current child item.

5. Repeat steps 3 + 4 for any further child item.

Example:

# For setting different data to different organizations, # set the different data between the "MultiTransferCache" calls:# common data:set ::EBSDat(Item:PARAMETER:P_ITEM_NUMBER) $ItemIdset ::EBSDat(Item:PARAMETER:P_DESCRIPTION) \[::T4X::TC::MAPPING::FieldMapping $Item "object_name"]set ::EBSDat(Item:PARAMETER:P_BOM_ENABLED_FLAG) "Y"set ::EBSDat(Item:PARAMETER:P_ENG_ITEM_FLAG) "N"# different data for master org V1:set ::EBSDat(Item:CtrlParam:P_ORGANIZATION_CODE) "V1"set ::EBSDat(Item:PARAMETER:P_ITEM_TYPE) ""set ::EBSDat(Item:PARAMETER:P_AUTO_SERIAL_ALPHA_PREFIX) "CS_"::T4O::storeEBSDat2MultiTransferCache Item# different data for child org S1:



set ::EBSDat(Item:PARAMETER:P_ORGANIZATION_CODE) "S1"set ::EBSDat(Item:PARAMETER:P_ITEM_TYPE) "AC_C70"::T4O::TC::MAPPING::EBSClearAttribute \"Item:PARAMETER:P_AUTO_SERIAL_ALPHA_PREFIX"::T4O::storeEBSDat2MultiTransferCache Item

Function ::T4O::storeEBSDat2MultiTransferCache takes a snapshot of the ::EBSDat array foreach single transaction. Therefore, all the data for one single transaction should be set before the call ofthis function.

Caution:

• Do not set any mapping data after these callsof ::T4O::storeEBSDat2MultiTransferCache.

• T4O executes the transfers in the same order as defined in the mapping. Therefore, be sure thatthe master item data is defined prior to any child item data, as the master item must existbefore creating a child item.

• If the different transfers have to set different variables, be sure to set all of them in eachtransfer. Else each variable that is not set explicitly will contain the value from the previoustransfer.

• If for child item creation, you need to transfer an empty attribute value that is not empty for themaster item, call function EBSClearAttribute for respective attribute, as withP_AUTO_SERIAL_ALPHA_PREFIX in the example above.

4.6.1 Get Item Organizations

T4O Configuration

T4O provides the function ::TPEBS::ITEM::getItemOrganizations for getting all organizationsto which an Item is assigned in the EBS. The retrieved organizations will be returned in global TCLarray ::ItemResultDat.


In order to get an example and to test that functionality, use test script ITEM get organizations.

4.7 Maintain Item Category Assignments

EBS Item Categories can be used like a multi value Item attribute with an underlying list of values. Thecategories and category sets both have to be created by an administrator beforehand.

Get Item Organizations



T4O allows maintaining item category assignments in the EBS. Maintaining item category assignmentsis handled as an "additional transfer" (see Mapping of additional Item Data ("additional transfer")) andcan be activated in the mapping.

T4O Configuration

In order to maintain one or more item category assignments while transferring the item to the EBS, theexample code section of mapping function TC_Object2EBS_Item_AssignItem2Category (calledby generic item mapping function TC_Object2EBS_Item) can be used; for an example refer to thecode in that function:

Maintain Item Category Assignments - t4o_item_mapping_template.sd

For testing that functionality, use test script ITEM CATEGORY create.

The fields of the ::EBSDat array containing the data for an EBS category assignment begin withAssignItem2Category:PARAMETER:.

In order to maintain an Item category assignment in the EBS, configure the following in the mapping:

• By default, nothing is done for category assignment. If you need to maintain a category assignment,turn on the switch AssignItem2Cat:

set ::EBSDat(Item:CtrlParam:AssignItem2Category) "TRUE"

• You need to set the category ID and category set ID in fieldsAssignItem2Category:PARAMETER:P_CATEGORY_ID andAssignItem2Category:PARAMETER:P_CATEGORY_SET_ID of the ::EBSDat array.

• You need to specify the item (plus organization) for which the category assignment should bemaintained in fields AssignItem2Category:CtrlParam:P_ITEM_NUMBER andAssignItem2Category:CtrlParam:P_ORGANIZATION_CODE.

4.7.1 Assign Item to Category

T4O Configuration

In order to assign an item to a category in the EBS, perform the main configuration steps for itemcategory assignments, as described in chapter Maintain Item Category Assignments. Nothing elseneeds to be done for assigning a new category to an item.

It is possible to assign the item to more than one category by indexing the AssignItem2Categorysection of the ::EBSDat array.



4.7.2 Update Item Category Assignment

T4O Configuration

In order to update an item category assignment in the EBS, configure the following in the mapping:

• Perform the main configuration steps for item category assignments, as described in chapterMaintain Item Category Assignments

• In order to do a "real" update of the category assignment, set the old category ID in fieldAssignItem2Category:PARAMETER:P_OLD_CATEGORY_ID and the new one in fieldAssignItem2Category:PARAMETER:P_CATEGORY_ID. Otherwise, if you don't set theP_OLD_CATEGORY_ID, the assignment will be deleted and recreated.

4.7.3 Delete Item Category Assignments for Category Set

T4O Configuration

In order to delete the item category assignments only for a given category set before the actual transferis performed, configure the following in the mapping:


• Activate the switch DeleteCategories4Set by setting it to TRUE; default: FALSE; inventory item,organization and category set ID are required, nothing else

4.7.4 Delete All Item Category Assignments

T4O Configuration

In order to delete all existing item category assignments within the current transfer, configure thefollowing in the mapping:


• Activate the switch DeleteAssignedCategories by setting it to TRUE; default: FALSE; inventoryitem and organization are required, nothing else

Update Item Category Assignment


4.7.5 Get Item Category Assignments

T4O Configuration

T4O provides the function ::TPEBS::ITEM::getItemCategoryAssignment for getting detailedinformation for an existing EBS item category assignment. The retrieved data will be returned in globalTCL array ::ItemCategoryResultDa.


In order to get an example and to test that functionality, use test script ITEM CATEGORY get data.

4.8 Maintain Item Catalog Assignment

Oracle EBS Catalogs

In Oracle EBS, catalogs allow users to identify items into unique groups. Those groups share theircommon traits with the catalogs. EBS Catalogs provide a classification system similar to the Teamcenterclassification but less powerful (no LOVs are supported under value). This makes it rather easy to map itin an export use case (make sure TC class matches EBS catalog group and TC characteristics match EBSname). The description of the EBS Item can be derived from the chosen classification (checkbox"Description Default").

T4O supports the assignment of an EBS item to a catalog group. Furthermore, you can configure T4O tomaintain the corresponding descriptive elements for an assigned catalog.

T4O Configuration

To define the catalog/descriptive elements data mapping, adapt the example code in functionTC_Object2EBS_Item_DescriptiveElementsAssignment (called by generic item mappingfunction TC_Object2EBS_Item); for an example refer to the code in that function:

Maintain Item Catalog Assignment - t4o_item_mapping_template.sd

If you need to create an EBS catalog group assignment based on a Teamcenter classification, you canread respective Teamcenter classification data and map those to the corresponding EBS catalog data.

Note that in EBS an item belongs to only one catalog group, whereas in Teamcenter an item or itemrevision can belong to more than one class. However, in EBS the composition of catalogs can behierarchical.




4.8.1 Assign Item to Catalog

T4O Configuration

In order to assign an item to a catalog, define a catalog group (catalog group ID!) in fieldItem:PARAMETER:P_ITEM_CATALOG_GROUP_ID of the ::EBSDat array.

For getting the catalog group ID for a catalog group code, usefunction ::TPEBS::ITEM::getCatalogGroupId4Code.

For an example refer to respective code section in functionTC_Object2EBS_Item_DescriptiveElementsAssignment:

Assign Item to Catalog - t4o_item_mapping_template.sd

4.8.2 Delete Item Catalog Assignment

T4O Configuration

Deleting an existing catalog group assignment can be achieved by callingfunction ::T4O::TC::MAPPING::EBSClearAttribute and passing fieldP_ITEM_CATALOG_GROUP_ID to it; see the mapping example in functionTC_Object2EBS_Item_DescriptiveElementsAssignment:

Delete Item Catalog Assignment - t4o_item_mapping_template.sd

4.8.3 Maintain Item Descriptive Elements

Maintaining item descriptive elements is handled as an "additional transfer" (see Mapping of additionalItem Data ("additional transfer")) and can be activated in the mapping.

Use Cases

• Create Descriptive Element

• Delete Descriptive Element

• Update Descriptive Element

T4O Configuration

In order to maintain one or more descriptive elements while transferring the item to the EBS, theexample code section of mapping functionTC_Object2EBS_Item_DescriptiveElementsAssignment (called by generic item mapping

Assign Item to Catalog


function TC_Object2EBS_Item) can be used; for an example refer to respective code section in thatfunction:

Maintain Item Descriptive Elements - t4o_item_mapping_template.sd

For testing that functionality, use test script ITEM DESCRIPTIVE ELEMENTS create.

The fields of the ::EBSDat array containing the data for EBS item descriptive elements begin withItemDescriptiveElement:.

In order to maintain Item descriptive elements in the EBS, configure the following in the mapping:

• By default, nothing is done for descriptive elements assignment. If you need to activate the transfer ofdescriptive elements, turn on the switch AssignItemDescriptiveElements:

set ::EBSDat(Item:CtrlParam:AssignItemDescriptiveElements) "TRUE"

• A requirement for transferring descriptive elements, is to define a catalog group to which the itemshould be assigned, see chapter Assign Item to Catalog.

• You need to specify the item for which the descriptive elements should be maintained in fieldItemDescriptiveElement:PARAMETER:P_ITEM_NUMBER.Note that the descriptive elements assignment is organization independent.

Create Descriptive Element

T4O Configuration

Creating a descriptive element assignment can be done via respective code section in functionTC_Object2EBS_Item_DescriptiveElementsAssignment:

Create a Descriptive Element - t4o_item_mapping_template.sd

If more than one EBS item descriptive element should be maintained in the same transfer, that codesection can be duplicated or used in a loop with ascending index. Don’t forget to initialize the datastructure for each descriptive element by callingfunction::TPEBS::ITEM::initItemDescriptiveElementStructure_P_ITEM_DESC_ELEMENT_TABLE.

Delete Descriptive Element

T4O Configuration

Deleting an existing descriptive element can be done by simply not transferring the element at all. Thismeans that for respective descriptive element, the mapping attributes ELEMENT_NAME,ELEMENT_VALUE and DESCRIPTION_DEFAULT either shouldn’t be set at all or should be set empty.



This deletion method is only possible if the flagItemDescriptiveElement:CtrlParam:CleanDescriptiveElement is set to TRUE (as bydefault). Otherwise, if this flag is set to FALSE, the mapping needs to delete all unnecessary descriptiveelements manually by sending the element name (ELEMENT_NAME:$Index) with an empty value(ELEMENT_VALUE:$Index).

Update Descriptive Element

T4O Configuration

Updating an existing Descriptive Element can be done by simply sending the element name(ELEMENT_NAME:$Index) with changed value (ELEMENT_VALUE:$Index).

If you need to update the item description using the item catalog description, turn on the switchItemDescriptiveElement:CtrlParam:UpdateItemDescription by setting it to TRUE.

If the UpdateItemDescription switch is activated, the organization needs to be specified in fieldItemDescriptiveElement:CtrlParam:OrgCode (but only in this case).

4.8.4 Get Item Descriptive Elements

T4O Configuration

T4O provides the function ::TPEBS::ITEM::getItemDescriptiveElements for getting detailedinformation of existing EBS item descriptive elements. The retrieved descriptive elements will bereturned in global TCL array ::ItemDescriptiveElementResultDat.


In order to get an example and to test that functionality, use test script ITEM DESCRIPTIVEELEMENTS get data.

4.9 Maintain Item Cross References

This feature is very similar to the EBS Item Categories, with the main difference that no list of value isbeing preset for "Value". That makes it the preferred choice as a mapping target for multi-valuedTeamcenter attributes and related objects like documents or designs.

Maintaining EBS item cross references via T4O is handled as an "additional transfer" (see Mapping ofadditional Item Data ("additional transfer")) and can be activated in the mapping.

Use Cases

• Create Cross Reference

Get Item Descriptive Elements



• Delete Cross Reference

• Update Cross Reference

T4O Configuration

In order to define the cross references data mapping, adapt the example code in functionTC_Object2EBS_Item_CrossReference (called by generic item mapping functionTC_Object2EBS_Item); for an example refer to respective code section in that function:

Maintain Item Cross References - t4o_item_mapping_template.sd

For testing that functionality, use test script ITEM CROSS REFERENCE create.

The fields of the ::EBSDat array containing the data for the EBS cross references begin withItemCrossReference:.

In order to maintain item cross references in the EBS, configure the following in the mapping:

• By default, nothing is done for cross references assignment. If you need to activate the transfer ofcross references, turn on the switch AssignItemCrossReferences:

set ::EBSDat(Item:CtrlParam:AssignItemCrossReferences) "TRUE"

• Specify the item for which the cross references should be maintained in fieldItemCrossReference:CtrlParam:P_ITEM_NUMBER of the ::EBSDat array.

Create Cross Reference

T4O Configuration

Creating a cross reference can be done via respective code section in functionTC_Object2EBS_Item_CrossReference:

Create Cross Reference - t4o_item_mapping_template.sd

If more than one EBS cross reference element should be maintained in the same transfer, that codesection can be duplicated or used in a loop with ascending index. Don’t forget to initialize the datastructure for each cross reference by callingfunction ::TPEBS::ITEM::initItemCrossReferenceStructure_P_XREF_TBL.

Cross reference assignments can be organization dependent or not. If an assignment is organizationdependent, you need to specify the organization id as well in fieldItemCrossReference:P_XREF_TBL:P_XREF_TBL_ITEM:ORGANIZATION_ID:<index>



Delete Cross Reference

T4O Configuration

Deleting an existing cross reference can be done by simply not transferring the element at all. This willonly be the case if the following flag is set to TRUE (as by default):

set ::EBSDat(ItemCrossReference:CtrlParam:CleanCrossReferences) "TRUE"

Update Cross Reference

T4O Configuration

Updating an existing cross reference can be done by sending the cross reference with changed attributevalues (e.g. the DESCRIPTION, CROSS_REFERENCE …).

Note that a "real Update" is only performed if NONE of the following attributes is changed, as those areused to identify the cross reference in the EBS:

• CROSS_REFERENCE_TYPE

• CROSS_REFERENCE

• ORGANIZATION_ID

If one of those attributes is changed, T4O first creates a new cross reference, as it can’t find the old crossreference in the EBS any more using the above mapping attributes for identification. Afterwards the oldcross reference is deleted in the EBS, as this one can’t be found in the mapping any more.

4.9.1 Get Item Cross References

T4O Configuration

T4O provides the function ::TPEBS::ITEM::getItemCrossReferences for getting detailedinformation of existing EBS item cross references. The retrieved cross references will be returned inglobal TCL array ::ItemCrossReferenceResultDat.


In order to get an example and to test that functionality, use test script ITEM CROSS REFERENCE getdata.

Get Item Cross References



4.10 Maintain Attachments

The "Document Attachments" functionality is an enhancement for T4O which supports the Oracle E-Business Suite feature "Attachments". The attachments feature enables users to relate unstructured datato almost any business object (Item, BOM, ECO, Routing) in the EBS. With T4O it is possible to maintainthose attachments from within TC.

Caution:

If you get the following error message when trying to update or delete an existing EBS attachmentvia T4O, this means that the attachment is currently locked by any user (e.g. open "Attachments"form for this attachment in Oracle Forms UI):

"T4O_DOC.TP_Attach_Document: Unexpected error: ORA-00054: resource busy and acquire withNOWAIT specified or timeout expired"

Thus, repeat the transfer at a later time when the attachment is released again (e.g. "Attachments"form for this attachment was closed in the meantime).


For transferring a TC file, the file (named reference) must be exported while transferring the TC item.You need to configure that using preferences, see chapter Create File Attachment.

In general, no TC object model changes will be required for maintaining attachments. However, for thefollowing use cases it is necessary to store an additional EBS attribute in TC:

• An attachment should be updated using the EBS attached document ID instead of the EBS sequencenumber (both are unique for attachments), as for instance the sequence number should be updatableor the automatic sequence number generation should be used. In this case the EBS attacheddocument ID must be determined based on the EBS document ID. Therefore, the EBS document IDneeds to be available in TC for any update transactions.

• The EBS "publish to catalog" feature will be used and such a published document should be linked toanother business object. In this case the ID of that document in EBS is necessary to create that link,thus it needs to be available in TC.

To be able to store that EBS attribute (document ID) in Teamcenter, we recommend creating a newform, e.g. the T4O Dataset Extension Form from the T4O demo template. For file transfers, theform should be attached to the corresponding TC dataset. For all other datatypes (Short Text, LongText, Web Page), the form should be attached directly to the Item Revision.

The T4O reverse mapping can then be used to populate this additional attribute and maybe some moreattributes on the extended form.

In order to make this additional form including all its attributes available in the mapping from TC toOracle EBS, you need to enhance the preferences T4O_ItemMapping4 by adding the extended form toit.



Example for adding the extended form T4O Dataset Extension Form to the preferenceT4O_ItemMapping4EBS2T4O_Item Revision:

T4O_ItemMapping4EBS2T4O_Item Revision=IMAN_specification:Text:ref_list/EBS2DatasetReference:EBS2Dataset Extension FormIMAN_specification:EBS2Dataset Extension Form

The first value in that example is for the extended form attached to the dataset (in case of file transfers)whereas the second value is for the extended form attached directly to the Item Revision (in case of anyother transfer than file).

In order to make that additional form including all its attributes available in the reverse mapping fromOracle EBS to TC, you need to enhance/add the following preferences:

• Add the extended form (e.g. the T4O Dataset Extension Form) to preferences T4O_ItemMapping2.Example for adding the extended form T4O Dataset Extension Form to preferenceT4O_ItemMapping2EBS2T4O_Item Revision:

T4O_ItemMapping2EBS2T4O_Item Revision=IMAN_specification:Text:ref_list/EBS2DatasetReference:EBS2Dataset Extension FormIMAN_specification:EBS2Dataset Extension Form

The first value again is for the extended form attached to the dataset (in case of file transfers)whereas the second value is for the extended form attached directly to the Item Revision (in case ofany other transfer than file).

• Specify the TC attributes of extended form which are allowed to receive data from Oracle EBS byadding preference(s) T4O_ItemFieldMapping2; add one preference for each value set in abovepreference T4O_ItemMapping2).Example according to above preference T4O_ItemMapping2EBS2T4O_Item Revision:

T4O_ItemFieldMapping2IMAN_specification:Text:ref_list/EBS2DatasetReference:EBS2Dataset Extension Form=ebs2DOCUMENT_IDebs2FILE_IDebs2PUBLISHED_TO_CATALOGebs2TRANSFER_STATUSebs2TRANSFER_DATE

T4O_ItemFieldMapping2IMAN_specification:EBS2Dataset Extension Form=ebs2DOCUMENT_IDebs2FILE_IDebs2PUBLISHED_TO_CATALOG

Maintain Attachments


ebs2TRANSFER_STATUSebs2TRANSFER_DATE

T4O Configuration

Maintaining attachments for an Item is handled as an "additional transfer" (see Mapping of additionalItem Data ("additional transfer")) and can be activated in the mapping.

To define the attachments data mapping for an item transfer, adapt the example code in functionTC_Object2EBS_Item_DocumentAttachment (called by generic item mapping functionTC_Object2EBS_Item).

Maintain Attachments - t4o_item_mapping_template.sd

For testing that functionality, use test script ATTACHMENT create.

The fields of the ::EBSDat array containing the data for the EBS attachments begin withAttachment:PARAMETER:.

In order to maintain (create, update, delete) attachments for an item in the EBS, configure the followingin the mapping:

• By default, nothing is done for document attachments assignment. If you need to activate the transferof document attachments, turn on the switch DocumentAttachmentTransfer:

set ::EBSDat(Item:CtrlParam:DocumentAttachmentTransfer) "TRUE"

• Set the attachments target type in ::EBSDat fieldAttachment:PARAMETER:P_EBS_TARGET_TYPE to ITEM.

• Specify the item for which the attachments should be maintained. Set the organization codein ::EBSDat field Attachment:PARAMETER:P_PK1_NAME and the item number in fieldAttachment:PARAMETER:P_PK2_NAME.

Reverse Mapping

In order to store information about an attachment transfer back to Teamcenter, you need to adapt oneof the item reverse mapping functions. In the OOTB mapping template t4o_item_mapping_template.sd,T4O provides the attachments specific reverse mapping functionEBS_Item2TC_Object_Standard_DocumentAttachment which is called by the standard itemreverse mapping function EBS_Item2TC_Object_Standard:

• By default, the reverse mapping for document attachments only is executed if the switchDocumentAttachmentTransfer was activated in mapping functionTC_Object2EBS_Item_DocumentAttachment.



• By default, the reverse mapping for document attachments writes to the T4O Dataset ExtensionForm which is provided by T4O in the demo template (see the preference requirements above). Thisform contains the following attributes:

• ebs2DOCUMENT_ID:ID of the document in EBS

• ebs2FILE_ID:ID of the file/text/URL in EBS

• ebs2PUBLISHED_TO_CATALOG:Flag whether the document already exists in the EBS catalog; TRUE|FALSE

• ebs2TRANSFER_STATUS:Transfer status; CREATED|UPDATED|ERROR

• ebs2TRANSFER_STATUS:Timestamp of the transfer

Caution:

As the same dataset extension form may be referenced by multiple items (in the case oftransferring shared documents), the EBS attached document ID isn’t saved on the extensionform, as this ID would be different for each item. That’s why we only save the document ID onthe dataset extension form (the same EBS document ID can be referenced by multiple items);see chapter Link Document to Several Items.

• You can navigate to the T4O Dataset Extension Form via the following statement (example for theextended form attached to the dataset in case of EBS datatype File):

set DatasetExtensionForm \

"$ItemRevisionType:IMAN_specification:Text:ref_list/EBS2DatasetReference: \EBS2Dataset Extension Form"

• The example from the mapping template fills the attributes on the dataset extension form for asuccessful transfer.

• You may also wan to clean up a shared folder by deleting the files which have been copied there forthis transfer (provided that the copied files have been saved to a TCL list before, see variablelstDocumentTransferFileList4Deletion in the mapping template); see the example in themapping template.



4.10.1 Create Attachment

The following EBS datatypes are supported when creating an attachment via T4O:

• Short Text (DATATYPE_ID=1 in table FND_DOCUMENTS)Text stored in the database containing less than 4000 characters.

• Long Text (DATATYPE_ID=2 in table FND_DOCUMENTS)Text stored in the database containing 4000 characters or more.

• Web Page (DATATYPE_ID=5 in table FND_DOCUMENTS)An URL reference to a web page which you can view with your web browser.

• File (DATATYPE_ID=6 in table FND_DOCUMENTS)Any file like an Image, PDF, MSWord…

Restrictions

• T4O automatically saves files into the DB table FND_LOBS. The storage type "file system" is not yetsupported.

• T4O only supports the above listed datatypes. Datatypes like Image (DATATYPE_ID=3 in tableFND_DOCUMENTS) and OLE Object (DATATYPE_ID=4 in table FND_DOCUMENTS) are not yetsupported, as they are stored in table FND_DOCUMENTS_LONG_RAW instead of table FND_LOBS asfor datatype File.

T4O Configuration

Once you provided the basic settings for attachment maintenance (see T4O Configuration), configurethe following in the mapping:

• Specify the attachment data fields:

• Attachment:PARAMETER:P_DOCUMENT_DESCRIPTION

• Attachment:PARAMETER:P_TITLE

• Attachment:PARAMETER:P_CATEGORY_NAME

• Attachment:PARAMETER:P_SEQ_NUM

If parameter P_SEQ_NUM is left empty, the sequence number is generated automatically by T4O whilecreating the attachment. T4O will determine the next free value in intervals of 10 (10, 20, 30…).But be aware that in that case, the attachment ID (P_ATTACHED_DOCUMENT_ID) must be used inorder to uniquely identify the attachment during an update transaction. For instructions on how todetermine this attachment ID, refer to chapter Update Attachment.



• If more than one EBS attachment should be handled in the same transfer, theAttachment:PARAMETER section of the ::EBSDat array can be duplicated or used in a loop withascending index. In that case, function ::TPEBS::ATTACHMENT::initAttachmentStructuremust be used for each index in order to initialize the array in a correct way.

4.10.1.1 Create File Attachment

Use Cases

• Create an EBS file using a shared folder accessible from both systems (TC and EBS)

• Create an EBS file directly via ISG/JDBC as a file stream (BLOB)

Caution:

The file transfer method of directly sending a file stream (BLOB) should only be applied for smallerfiles. For memory and performance reasons, we strongly recommend using a shared folderinstead for files greater than 5 MB. By default, the shared folder method is activated by thefollowing setting in the mapping:

set blnUseSharedFolder4FileTransfer "TRUE"


For transferring a TC file, the file (named reference) must be exported while transferring the TC item.This can be configured in the T4O_ItemMapping4 preferences.

Example for TC Item Revision type EBS2T4O_Item Revision and TC dataset type Text:

T4O_ItemMapping4EBS2T4O_Item Revision=IMAN_specification:TextIMAN_specification:Text:#__getAllProperties__#:PropertiesIMAN_specification:Text:ref_list/Text:ImanFileIMAN_specification:Text:ref_list/Text:ImanFile:#__getAllProperties__#:Properties

With those preference settings, T4O will automatically export the following additional objects whiletransferring an item revision of type EBS2T4O_Item Revision: the attached text dataset including allproperties and the physical text file (in turn including all properties) represented as a named referenceattached to the text dataset.

Those values must be adjusted accordingly, e.g. if any other relation than IMAN_specification isused or if any other dataset type than Text should be transferred.

T4O Configuration

Create File Attachment


For a mapping example refer to respective code section in functionTC_Object2EBS_Item_DocumentAttachment:

Create File Attachment - t4o_item_mapping_template.sd

Once you provided the basic settings for creating an attachment (see T4O Configuration), configure thefollowing in the mapping:

• Set the datatype of the EBS attachment in ::EBSDat fieldAttachment:PARAMETER:P_DATATYPE_NAME to File:

set ::EBSDat(Attachment:PARAMETER:P_DATATYPE_NAME) "File"

• Read the data of the TC dataset, e.g. the file name:

set strFullFileName [::T4X::TC::MAPPING::FieldMapping \"$ItemRevisionType:IMAN_specification:Text:ref_list/Text:ImanFile" \"FileName"]set strOrigFileName [::T4X::TC::MAPPING::FieldMapping \"$ItemRevisionType:IMAN_specification:Text:ref_list/Text:ImanFile" \"original_file_name"]

Caution:

You will not notice if there is more than one dataset of this type (including the relation); youwill only get the name of the first one.

• Set the EBS file name and content type in ::EBSDat fieldsAttachment:PARAMETER:P_FILE_NAME and Attachment:PARAMETER:P_CONTENT_TYPE.Possible values for parameter P_CONTENT_TYPE:

• application/xml

• image/jpeg

• image/png

• application/pdf

• application/msword

• application/excel



Caution:

If you get an error message like the following during a file transfer via T4O, contact your EBS DBA(maybe the value of profile option Upload File Size Limit should be increased):

"The file length exceeds the maximum value set in profile option Upload File Size Limit."

See chapter Requirements for Module Document Attachments in the manual TeamcenterGateway for Oracle EBS - EBS Preparation Guide for details.

Create an EBS file using a shared folder

This is the default method and it might be the preferred one in case of transferring large files from TC toEBS.

Using this method, the file must be copied to a shared folder where both, the EBS system and the TCsystem, have access to (write access for the TC system and read access for the EBS system).

T4O Configuration


Create an EBS file using a shared folder - t4o_item_mapping_template.sd

Perform the following configuration steps in the mapping:

• Provide the access string to the shared folder for each server (TC + EBS); variablesstrSharedFolder1 (TC) + strSharedFolder2 (EBS)) in the example

• Copy the file to the shared folder using the TCL command file copy.Pass the shared folder access string for the TC server (not the one for the EBS server) to the targetparameter of TCL command file copy.

• Specify the directory plus file name of the shared folder location, where the EBS has to read the filefrom in ::EBSDat fields Attachment:PARAMETER:P_SRC_DIRECTORY andAttachment:PARAMETER:P_SRC_FILE_NAME.The parameter P_SRC_DIRECTORY should be set to the shared folder access string for the EBS server(not the one for the TC server)!In contrast to the file stream method, the call of function getEncodedStream4File isn’t neededand should be skipped for performance reasons. Also leave the P_FILE_BLOB parameter empty!

• In order to clean up the content of the shared folder after the transfer, add the current file to the TCLlist lstDocumentTransferFileList4Deletion.

• This list should then be handled for clean-up in the reverse mapping.

Create File Attachment




Create an EBS file as a file stream (BLOB)

This method should only be applied when transferring smaller files!

T4O Configuration


Create an EBS file as a file stream (BLOB) - t4o_item_mapping_template.sd

Perform the following configuration steps in the mapping:

• Switch to the file stream method by deactivating the blnUseSharedFolder4FileTransfervariable in the default T4O mapping:

set blnUseSharedFolder4FileTransfer "FALSE"

• Set the ::EBSDat field Attachment:PARAMETER:P_FILE_BLOB to the file stream which iscreated with the help of function getEncodedStream4File.

4.10.1.2 Create URL Attachment

T4O Configuration


Create URL Attachment - t4o_item_mapping_template.sd


• Set the datatype of the EBS attachment in ::EBSDat fieldAttachment:PARAMETER:P_DATATYPE_NAME to Web Page:

set ::EBSDat(Attachment:PARAMETER:P_DATATYPE_NAME) "Web Page"

• Specify the URL in ::EBSDat field Attachment:PARAMETER:P_URL:

set ::EBSDat(Attachment:PARAMETER:P_URL) "http://www.siemens.com/plm"



4.10.1.3 Create Short Text Attachment

T4O Configuration


Create Short Text Attachment - t4o_item_mapping_template.sd


• Set the datatype of the EBS attachment in ::EBSDat fieldAttachment:PARAMETER:P_DATATYPE_NAME to Short Text:

set ::EBSDat(Attachment:PARAMETER:P_DATATYPE_NAME) "Short Text"

• Specify the text in ::EBSDat field Attachment:PARAMETER:P_TEXT:

set ::EBSDat(Attachment:PARAMETER:P_TEXT) "This is a short text"

4.10.1.4 Create Long Text Attachment

T4O Configuration


Create Long Text Attachment - t4o_item_mapping_template.sd


• Set the datatype of the EBS attachment in ::EBSDat fieldAttachment:PARAMETER:P_DATATYPE_NAME to Long Text:

set ::EBSDat(Attachment:PARAMETER:P_DATATYPE_NAME) "Long Text"

• Specify the text in ::EBSDat field Attachment:PARAMETER:P_TEXT:

set ::EBSDat(Attachment:PARAMETER:P_TEXT) "This is a long text"

Create Short Text Attachment


4.10.2 Update Attachment

T4O Configuration

Updating an existing attachment can be done by sending the attachment with changed attribute values(e.g. the P_DOCUMENT_DESCRIPTION).

For uniquely identifying an attachment in the EBS, we can either use the P_SEQ_NUM or theP_ATTACHED_DOCUMENT_ID. Therefore, a "real update" is only performed if at least one of those twoattributes is filled with an already existing value in the EBS. Otherwise, if none of those two attributescontains a valid EBS value (e.g. the attached document ID isn’t specified at all and the sequence numbercontains a changed value), T4O first creates a new document attachment, as it can’t find the oldattachment in the EBS any more using those mapping attributes for identification. Afterwards, the olddocument attachment is deleted in the EBS, as this one can’t be found in the mapping any more.

The following attributes can be updated for an attachment:

• P_SEQ_NUM → in this case the P_ATTACHED_DOCUMENT_ID must be used for identification!

• P_DOCUMENT_DESCRIPTION

• P_TEXT

• P_FILE_NAME

• P_URL

• P_TITLE

If updating an attachment via the attached document ID (P_ATTACHED_DOCUMENT_ID) instead of thesequence number, this ID has to be available in the mapping. In order to retrieve it, the existingattachments for the given object need to be read from EBS. Then the attached document ID can bedetermined based on the document ID on the extended form (provided that it was saved in one of theprevious transfers, see the reverse mapping).

Caution:

That approach will only work, if the document ID is unique for the current item. Usually this is thecase, except the same published document has been added more than once using multipleattachments. So for implementing this method you need to make sure that this scenario won’toccur.



4.10.3 Delete Attachment

T4O Configuration

Deleting an existing attachment can be achieved by simply not transferring the element at all.

4.10.4 Delete All Attachments

T4O Configuration

Deleting all existing attachments for the item before transferring any new attachment, configure thefollowing in the mapping:

• Set the ::EBSDat field Attachment:CtrlParam:DeleteExistingAttachments to TRUE.

• If you need to delete all existing attachments for an item without transferring any new attachment,the key attributes to uniquely identify the item should be specified in the following parameter. This isnecessary, as the key attributes are not specified in the Attachment:PARAMETER section ofthe ::EBSDat array in this case:

set ::EBSDat(Attachment:CtrlParam:ObjectKey4DeleteExistingAttachments) \[list "ITEM" $::EBSDat(Item:CtrlParam:P_ORGANIZATION_CODE) \$::EBSDat(Item:PARAMETER:P_ITEM_NUMBER)]

The value must be a TCL list with the following attributes:

• Target Type: ITEM

• Pk1: the EBS organization code

• Pk2: the EBS item number


Delete All Attachments - t4o_item_mapping_template.sd

4.10.5 Link Document to Several Items

T4O Configuration

If the same document should be linked to several business objects in the EBS, the following approachcan be used:

Delete Attachment


• The initial transfer has to be done in a standard way including the following attribute:

set ::EBSDat(Attachment:PARAMETER:P_USAGE_TYPE) "S"

If this attribute is set to S, the document will be created in a global catalog within the EBS and willthen be attached to the given item.

• In the following transfers, this globally available document can then be linked to other items by usingthe following attribute:

set ::EBSDat(Attachment:PARAMETER:P_DOCUMENT_ID) $intEbsDocumentId

Variable intEbsDocumentId should contain the document ID of the previously created shareddocument in this case. In order to have the document ID from a previous transfer available at thispoint, the document ID will be saved in TC (e.g. on the T4O Dataset Extension Form – see thepreference requirements) with each transfer; see chapter Maintain Attachments for explanationsabout the reverse mapping.If such a document ID is given, instead of creating a new document in the EBS, the existing documentwill be reused and linked.

• In order to update such a globally shared document, the following flag has to be enabled:

set ::EBSDat(Attachment:PARAMETER:P_ALLOW_SHARED_DOC_UPDATE) "TRUE"

If this flag is NOT set to TRUE, updating a globally shared attachment will result in an error. If set toTRUE, such an update will be successful, but be aware that this will affect all business objects with alink to this attachment.In order to find out if a globally shared attachment needs to be updated, the attribute "transfer date"can be used (see the example in the item mapping template).

• The deletion of an attachment that references a shared document would result in only removing theattachment itself. However, the shared document will be kept in the EBS as it may be referenced byother business objects.


Link Document to Several Items - t4o_item_mapping_template.sd

4.10.6 Get Attachments

T4O Configuration

T4O provides the function ::TPEBS::ATTACHMENT::getAttachmentInfo for getting all documentattachments for a specified EBS entity. The supported EBS entity types are: ITEM, BOM, ECO and RTG. Inorder to get the attachments for an existing EBS item, pass value ITEM to parameter



EBS_Target_Type. Additionally, you need to pass the item number to parameter Pk2_Name and theorganization code to parameter Pk1_Name. The retrieved descriptive elements will be returned in globalTCL array ::AttachmentResultDat.


In order to get an example and to test that functionality, use test script ATTACHMENT get info.

4.10.7 Export Attached File

T4O Configuration

T4O provides the function ::TPEBS::ATTACHMENT::exportFile4Id for exporting an EBS file for agiven file ID to a given location.


In order to get an example and to test that functionality, use test script ATTACHMENT export file.

4.11 Maintain Item via ECO

Besides transferring a Teamcenter item to a standard EBS inventory item, T4O also supports transferringa Teamcenter item to an EBS revised item within a specified ECO context.

Caution:

Transferring a revised item for multiple open ECOs is not yet supported.

Use Cases

• Add Revised ItemAdding a new revised item to a given EBS ECO

• Update Revised ItemUpdating an already existing revised item on a given EBS ECO

• Delete Revised ItemDeleting an already existing revised item on a given EBS ECO

For updating or deleting ECO revised items, the following key attributes will be used, in order to identifyan already existing revised item on an EBS ECO:

• REVISED_ITEM_NAME

• ECO_NAME

Export Attached File




• ORGANIZATION_CODE

• NEW_REVISED_ITEM_REVISION

• TRANSFER_OR_COPY

• START_EFFECTIVE_DATE

• EARLIEST_EFFECTIVE_DATE

T4O Configuration

The mapping for an ECO based item transfer is done in function TC_Object2EBS_Item_ECO (called bygeneric item mapping function TC_Object2EBS_Item); for an example refer to the code in thatfunction:

Maintain Item via ECO - t4o_item_mapping_template.sd

For creating a revised item on an ECO, the EBS requires the usage of an ECO name that is valid for theitem. In the default mapping, the ECO name is taken from the attribute ebs2EcoNo on the ItemRevision Master Form. Only if this attribute contains a value (either set manually in the Teamcenter GUIor filled by a previous ECO transfer), the item will be transferred within an ECO context (as defined inthe default mapping, but this is configurable!). If the specified ECO doesn’t exist yet, it will be createdduring the transfer.

The fields of the ::EBSDat array containing the data for the EBS ECO itself begin withChangeOrder:P_ECO_REC:.

The following basic data fields are available for specifying the ECO for which the revised item should bemaintained:

• ChangeOrder:P_ECO_REC:ECO_NAMEName of the ECO

• ChangeOrder:P_ECO_REC:ORGANIZATION_CODEOrganization code of the ECO

• ChangeOrder:P_ECO_REC:CHANGE_TYPE_CODEECO type; e.g. ECO

• ChangeOrder:P_ECO_REC:APPROVAL_STATUS_NAMEApproval status; e.g. Approved

• ChangeOrder:P_ECO_REC:DESCRIPTIONECO description



Consider the following when specifying the basic ECO data:

• There is an Oracle EBS restriction for the length of field ECO_NAME: Only a maximum length of 10characters is allowed. If you exceed the length of 10, you will get the following error:

• If you need to implement the ECO, see chapter Implement ECO for Item for details.

Add Revised Item

T4O Configuration

Just transferring a revised item that is not yet existing on the EBS ECO, will add it to the ECO.

The ::EBSDat fields containing the revised item data begin withChangeOrder:P_REVISED_ITEM_TBL:.

The following basic data for an EBS revised item can be set:

• ChangeOrder:P_REVISED_ITEM_TBL:P_REVISED_ITEM_TBL_ITEM:ECO_NAME:$IndexName of the ECO where the revised item should be added

• ChangeOrder:P_REVISED_ITEM_TBL:P_REVISED_ITEM_TBL_ITEM:ORGANIZATION_CODE:$IndexOrganization code of corresponding ECO

• ChangeOrder:P_REVISED_ITEM_TBL:P_REVISED_ITEM_TBL_ITEM:REVISED_ITEM_NAME:$IndexItem number of respective item to be added as revised item

• ChangeOrder:P_REVISED_ITEM_TBL:P_REVISED_ITEM_TBL_ITEM:NEW_REVISED_ITEM_REVISION:$IndexNew revision of the item to be added as revised item

• ChangeOrder:P_REVISED_ITEM_TBL:P_REVISED_ITEM_TBL_ITEM:NEW_REVISED_ITEM_REV_DESC:$IndexDescription of new item revision

• ChangeOrder:P_REVISED_ITEM_TBL:P_REVISED_ITEM_TBL_ITEM:MRP_ACTIVE:$Index

Maintain Item via ECO


MRP_ACTIVE flag; 1 (Active) | 2 (Inactive)

• ChangeOrder:P_REVISED_ITEM_TBL:P_REVISED_ITEM_TBL_ITEM:START_EFFECTIVE_DATE:$IndexEffective date of the item to be added as revised item

Caution:

For a revised item, don’t change the default settings of the ECO_NAME(ChangeOrder:P_REVISED_ITEM_TBL:P_REVISED_ITEM_TBL_ITEM:ECO_NAME:$Index) and ORGANIZATION_CODE(ChangeOrder:P_REVISED_ITEM_TBL:P_REVISED_ITEM_TBL_ITEM:ORGANIZATION_CODE:$Index), as those must be equal to the settings in the ECO header(ChangeOrder:P_ECO_REC:ECO_NAME andChangeOrder:P_ECO_REC:ORGANIZATION_CODE). Generally, if you want to adapt the ECOname, only change it in the header.

Consider the following when configuring the data mapping for a revised item:

• Be aware that the item transfer with ECO won’t create the inventory item itself, but it executes anormal ECO transfer with the specified item as a revised item. The item to be created as a revised itemfor the ECO should already exist in EBS Inventory Items. Otherwise, you would get an error messagelike the following:T4O (EBS): CS16042104 - Revised item CS16042104 does not exist in the organization V1.

• In the default mapping, the START_EFFECTIVE_DATE of revised item is set byfunction ::T4O::getTimeString4Now. This function returns the time string for ‘now’ for the T4Osystem (host where GS is running).

• If you need to explicitly set a date in attribute START_EFFECTIVE_DATE, the value has to beprovided in the following format:


For determining the time zone for the T4O system, use function T4O::getT4OTimezone.Example:set\::EBSDat(ChangeOrder:P_REVISED_ITEM_TBL:P_REVISED_ITEM_TBL_ITEM:START_EFFECTIVE_DATE:$Index)\"2010-12-01T12:00:00.000[::T4O::getT4OTimezone]"

Update Revised Item

T4O Configuration

Transferring a revised item that is already existing on the EBS ECO, will change respective revised itemattributes on the ECO.



Caution:

The key attributes for identifying an ECO revised item (see above) can't be changed during anupdate, except for START_EFFECTIVE_DATE.

In order to change that attribute, you need to set the changed value in the following attributestarting with prefix NEW_ (leave the original attribute value unchanged!):

• NEW_EFFECTIVE_DATE

Delete Revised Item

T4O Configuration

Not transferring a revised item that is already exiting on the EBS ECO, will delete respective revised itemfrom the ECO.

4.11.1 Implement ECO for Item

All changes stored on an EBS ECO only take effect as soon as the ECO is actually implemented. Thishappens asynchronously in Oracle EBS using concurrent programs.

ECO implementation is handled as an "additional transfer" in the context of an item transfer – eitherstandard or ECO based (see Mapping of additional Item Data ("additional transfer")). This means thatECO implementation is executed after the actual item transfer but within the same Teamcenterworkflow or interactive function.

T4O Configuration

In order to perform an ECO implementation without the actual item transfer, use the mapping statusADDITIONALUPDATESONLY (see Mapping of additional Item Data ("additional transfer")).

Implementing an ECO for an Item is done in mapping functionTC_Object2EBS_Item_ImplementECO (called by generic item mapping functionTC_Object2EBS_Item); for an example refer to the code in that function:

Implement ECO for Item - t4o_item_mapping_template.sd

The fields of the ::EBSDat array containing the data for an EBS ECO implementation begin withEcoRequest:PARAMETER:.

Consider the following when configuring the data mapping:

• Activate ECO implementation (deactivated by default): in ::EBSDat fieldChangeOrder:CtrlParam:IMPLEMENT_ECO:

Implement ECO for Item


set ::EBSDat(ChangeOrder:CtrlParam:IMPLEMENT_ECO) "TRUE"

• The transferred ECO will be implemented by submitting a request for concurrent program "Pre-Implementation in ECO implementation" (short name: "ENCACN") which in turn will initiateconcurrent program "Engineering Change Order Implementation" (short name: "ENCACNC").Therefore, ECO implementation is an asynchronous transfer. To validate if the concurrent program hasalready been finished and if it was successful, have look at the Oracle EBS Form "Requests". Thecorresponding Request ID can be found in respective T4O session log, e.g. search for the string"EBS_Item2TC_Object_ECO - EcoRequestId":

• For ECO implementation you need to set the fields of the EcoRequest section in the ::EBSDatarray. This section contains generic parameters for submitting a request (DESCRIPTION,START_TIME, SUB_REQUEST) as well as the parameters of concurrent program "Pre-Implementationin ECO implementation" (ECO_NAME, ORGANIZATION_ID).

• By default, the overall ECO will be implemented (as with the default mapping). But if you need to onlyimplement the revised item itself, set a value for fieldEcoRequest:PARAMETER:REVISED_ITEM_SEQUENCE_ID.

• Generally, the ECO implementation is an asynchronous transfer. However, T4O supports configuring itin a synchronous way by polling against the EBS in regular time intervals. That way the user will getfeedback if the ECO implementation was successful or not. But as the actual transfer still is done via aconcurrent program, this may block the transfer for a long time until the ECO implementation job hasfinished in the EBS.In order to configure that synchronous behavior, you need to specify the following ::EBSDat fields:

• ChangeOrder:CtrlParam:IMPLEMENT_ECO:RETRIEVE_RESULT:If set to TRUE, activates the synchronous behavior.

• ChangeOrder:CtrlParam:IMPLEMENT_ECO:LOOP_COUNTER:Defines the maximum number of loop cycles used to poll against the EBS to check if the ECOimplementation job has finished.

• ChangeOrder:CtrlParam:IMPLEMENT_ECO:LOOP_DELAY:Defines the wait time in milliseconds between each poll against the EBS to check if the ECOimplementation job has finished.

4.11.2 Transfer or Copy Engineering Item to Manufacturing

T4O supports transferring or copying an engineering item to manufacturing. This is the samefunctionality as provided by Oracle Forms UI on the Engineering Change Orders form with buttonsTransfer and Copy.



Use Cases

• Transfer Engineering Item to Manufacturing

• Copy Engineering Item to Manufacturing

T4O Configuration

An example of how to configure that functionality in the mapping can be found in functionTC_Object2EBS_Item_ECO (called by generic item mapping function TC_Object2EBS_Item):

Transfer or Copy Engineering Item to Manufacturing -t4o_item_mapping_template.sd

4.11.3 Get ECOs for Item

T4O Configuration

T4O provides the function ::TPEBS::ITEM::getECOs4Item for getting all ECOs related to anexisting EBS item. The retrieved ECOs will be returned in global TCL array ::ItemResultDat.


In order to get an example and to test that functionality, use test script ITEM get ECOs.

4.12 Maintain Item Manufacturer Part Numbers

This feature enables T4O to maintain (create and delete) Manufacturer and Manufacturer Part Numbercombinations for an EBS Item.

Maintaining EBS Manufacturer Part Numbers via T4O is handled as an "additional transfer" (see Mappingof additional Item Data ("additional transfer")) and can be activated in the mapping.

Use Cases

• Create Manufacturer Part Numbers

• Delete Manufacturer Part Numbers

T4O Configuration

InIn order to define the Manufacturer Part Numbers data mapping, adapt the example code in functionTC_Object2EBS_Item_ManufacturerPartNumbers (called by generic item mapping functionTC_Object2EBS_Item); for an example refer to respective code section in that function:

Get ECOs for Item



Maintain Item Manufacturer Part Numbers - t4o_item_mapping_template.sd

For testing that functionality, use the following test scripts:

ITEM create manufacturer part number

ITEM delete manufacturer part number

The fields of the ::EBSDat array containing the data for the EBS Manufacturer Part Numbers beginwith ManufacturerPartNumber:.

In order to maintain Item Manufacturer Part Numbers in the EBS, configure the following in themapping:

• By default, nothing is done for the Manufacturer Part Number assignment. If you need to activate thetransfer of Manufacturer Part Numbers, turn on the switchManufacturerPartNumberTransfer::

set ::EBSDat(Item:CtrlParam:ManufacturerPartNumberTransfer) "TRUE"

Create Manufacturer Part Numbers

T4O Configuration

Creating a Manufacturer Part Number can be done via respective code section in functionTC_Object2EBS_Item_ManufacturerPartNumbers: :

Create Item Manufacturer Part Numbers - t4o_item_mapping_template.sd

If more than one EBS Manufacturer Part Number element should be maintained in the same transfer,that code section can be duplicated or used in a loop with ascending index. Don’t forget to initialize thedata structure for each cross reference by calling function::TPEBS::ITEM::initItemManufacturerPartNumberStructure_P_MPN_TBL $ intIndex.

Manufacturer Part Number assignments are organization dependent. You need to specify theorganization name in fieldManufacturerPartNumber:P_MPN_TBL:P_MPN_TBL_ITEM:ORGANIZATION_CODE:<index>

In addition, you need to specify at least the Item Number, the EBS Manufacturer and the ManufacturerPart Number using these fields:

ManufacturerPartNumber:P_MPN_TBL:P_MPN_TBL_ITEM: MFG_PART_NUM:<index>

ManufacturerPartNumber:P_MPN_TBL:P_MPN_TBL_ITEM: MANUFACTURER_NAME:<index>

ManufacturerPartNumber:P_MPN_TBL:P_MPN_TBL_ITEM: ITEM_NUMBER:<index>



Delete Manufacturer Part Numbers

T4O Configuration

Deleting one or all Manufacturer Part Numbers can be done via respective code section in functionTC_Object2EBS_Item_ManufacturerPartNumbers:

Delete Item Manufacturer Part Numbers - t4o_item_mapping_template.sd

Deleting all Manufacturer Part Numbers can be done using this function:

set rc_func [::TPEBS::ITEM::deleteAllManufacturerPartNumbers4Item "" ""$ItemNumber $OrgCode]

Deleting just one Manufacturing Part Number assignment can be done using this function:

set rc_func [::TPEBS::ITEM::deleteManufacturerPartNumber4Item $Mpn "" "" ""$MfrName $ItemNumber $OrgCode]

Keep in mind that it is not possible to create the same MFR/MPN twice in the EBS. Doing this will result inan "unique constraint violation" error. In order to avoid this error, it is recommended to delete allassignments prior to the transfer (in case that Teamcenter is the master of this data).

4.12.1 Get Manufacturer Numbers

T4O Configuration

T4O provides the function ::TPEBS::ITEM::getManufacturerPartNumbers4Item for gettingdetailed information of existing EBS Item Manufacturer Part Numbers. The retrieved Manufacturer PartNumbers will be returned in global TCL array ::ManufacturerPartNumberResultDat.


In order to get an example and to test that functionality, use test script ITEM get manufacturerpart numbers.

4.12.2 Get Manufacturer

T4O Configuration

T4O provides the function ::TPEBS::MFR::getManufacturerInfo for getting detailed informationof existing EBS Manufacturers. The retrieved Manufacturers will be returned in global TCLarray ::ManufacturerResultDat.


Get Manufacturer Numbers




In order to get an example and to test that functionality, use test script MFR get data.

4.13 Maintaining APC User Defined Attributes

Maintaining APC User Defined Attributes via T4O is handled as an "additional transfer" (see Mapping ofadditional Item Data ("additional transfer")) and can be activated in the mapping.

Use Cases

• Create APC User Defined Attributes

• Update APC User Defined Attributes

T4O Configuration

In order to define the APC User Defined Attributes data mapping, adapt the example code in functionTC_Object2EBS_Item_ ApcUserDefinedAttributes (called by generic item mapping functionTC_Object2EBS_Item); for an example refer to respective code section in that function:

Maintain Item APC User Defined Attributes - t4o_item_mapping_template.sd

For testing that functionality, use test script ITEM USER ATTRIBUTES create.

The fields of the ::EBSDat array containing the data for the EBS APC User Defined Attributes begin withItemUserDefinedAttributes:.

In order to maintain item user defined attributes in the EBS, configure the following in the mapping:

• By default, nothing is done for user defined attributes. If you need to activate the transfer of userdefined attributes, turn on the switch UserDefinedAttributesTransfer:set ::EBSDat(Item:CtrlParam:UserDefinedAttributesTransfer) "TRUE"

• Specify the item for which the user defined attributes should be maintained in fieldItemUserDefinedAttributes:CtrlParam:P_ITEM_NUMBER of the ::EBSDat array.

Create APC User Defined Attributes

T4O Configuration

Creating APC User Defined Attribute can be done via respective code section in functionTC_Object2EBS_Item_ApcUserDefinedAttributes:

Create APC User Defined Attributes - t4o_item_mapping_template.sd



If more than one EBS User Defined Attribute should be maintained in the same transfer, that codesection can be duplicated or used in a loop with ascending index. Don’t forget to initialize the datastructure for user defined attribute by callingfunction::TPEBS::ITEM::initItemUserDefinedAttributesStructure_P_ATTRIBUTES_DATA_TABLE with the corresponding table index as parameter.

User defined attribute assignments are organization dependent, so you need to specify the organizationas well in field ItemUserDefinedAttributes:CtrlParam:P_ORGANIZATION_CODE:<index>

Update APC User Defined Attributes

T4O Configuration

Updating existing user defined attributes can be done by sending the user defined attributes withchanged attribute values.

Maintaining APC User Defined Attributes


5. Product Structure Transfer - Bill OfMaterial

5.1 Introduction


Nomenclature

Teamcenter EBS

BOM view revision or Bill of Material BOM or Bills of Material

BOMLine (BOM line, BOM position) Component


Export

TargetTypeName BillOfMaterialMapping template t4o_bom_mapping_template.sd

Mapping namespace ::T4O::BOM::CUSTOM::MAPPINGBasic mapping functions TC_Object2EBS_BillOfMaterial

TC_Object2EBS_BillOfMaterialPositionBasic reverse mapping function EBS_BillOfMaterial2TC_ObjectPreferences start with T4O_BillOfMaterialHandler T4O-transfer-BillOfMaterial

T4O-validate-BillOfMaterialT4O-transfer-Item4BomLineT4X-attach-RevisionRuleSee the T4O API Reference for more details.

Import Job

Job type T4O_IMPORT_BOMMapping template t4o_bom_import_template.sd


Teamcenter BOM objects (often called view) are independent objects in Teamcenter. These objectscontain a structured list of Teamcenter objects and necessary information of the assembly, mostly of




more than one level. Teamcenter BOMs can be loaded differently by applying another Revision Rule to itwhile opening.

An EBS Bill of Materials can only be created for an already existing EBS Item. It is therefore not anentirely independent entity.

The EBS BOM is controlled by date effectivity. An EBS BOM component is never completely deleted fromthe bill, instead an end effective date is being set. This feature is aligned with the Item revision feature.So even though the bill is not revision specific on a data model level, it can be displayed/resolved specificto the effective date of a certain revision of the BOM header item. Also based on the effective date, thecorrect component revisions can be assigned.

T4O reads the Teamcenter BOM structure using a predefined revision rule. T4O always sends one levelof TC BOM to Oracle EBS. Sub assemblies have to be transferred in different transactions. T4O alsoallows transferring occurrence notes to BOM line specific data to Oracle EBS (e.g. the "bulk indicator",position text etc.). It is possible to distinguish between Item types, e.g. different Item types for designparts and raw materials.

Mapping Examples

The mapping examples of the following chapters can be found in file t4o_bom_mapping_template.sd indirectory <T4O_ROOT>/var/template/capabilities/T4O.

How to find a mapping example referenced in this documentation is described in the Introduction forPart Transfer - Inventory Item.

5.2 Global Preferences for BOM

Please see chapter Structure Transfer Specific Handling in the Active Integration - GenericConfiguration Guide for information about how to configure the preferences for the structure datamapping in general.

In the generic preferences, the <TargetTypeName> needs to be replaced by BillOfMaterial andthe prefix <T4x> needs to be replaced by T4O.

The following basic preferences are available for defining the BOM data mapping from Teamcenter toEBS:

• T4O_BillOfMaterialTypeList

• T4O_BillOfMaterialDisplayableTypeList (optional)

• T4O_BillOfMaterialMapping4

• T4O_BillOfMaterialHeaderTypeList (optional)

5. Product Structure Transfer - Bill Of Material




• T4O_BillOfMaterialHeaderMapping4 (optional)

• T4O_BillOfMaterialLineMapping4 (optional)

• T4O_BillOfMaterialOccurrenceNotes4 (optional)


• T4O_BillOfMaterialFieldMapping2 (optional)

Definition of TC BOM View Types Which Should be Supported

Example definition of two BOM view types for usage with T4O:

T4O_BillOfMaterialTypeList=viewMBOM

Use optional preference T4O_BillOfMaterialDisplayableTypeList in order to enable only asubset of types defined in T4O_BillOfMaterialTypeList for BOM in the T4O GUI; see Definition ofTeamcenter Objects You Want to Support in the T4O GUI for details.

Definition of the TC Revision Rule

Example definition to use the same revision rule (Latest Working) for both defined types:

T4O_BillOfMaterialMapping4view=Latest Working

T4O_BillOfMaterialMapping4MBOM=Latest Working

Definition of valid ItemRevision types for BOMHeader types

Example definition for one valid ItemRevision type to be used as BOMHeader type (to start a workflowfrom):

T4O_BillOfMaterialHeaderTypeList=EBS2T4O_Item Revision

Global Preferences for BOM



Example for the configuration of the TC data objects related to the BOM header object, from which youwant to pass data to Oracle EBS via T4O:

T4O_BillOfMaterialHeaderMapping4EBS2T4O_Item Revision=items_tag:EBS2T4O_Item

Example for the configuration of the TC data objects related to each BOM line type, from which youwant to pass data to Oracle EBS via T4O:

T4O_BillOfMaterialLineMapping4EBS2T4O_Item Revision=items_tag:EBS2T4O_Item

Caution:

If T4O_BillOfMaterialHeaderTypeList is not set, T4O applies the set of data defined in thepreference T4O_ItemMapping4.

Definition of the Occurrence Notes T4O Should Read

Example for the configuration of two occurrence notes to be read by T4O:

T4O_BillOfMaterialOccurrenceNotes4view=bl_has_childrenMy_OccNote



T4O_BillOfMaterialMapping2view=

view

structure_revisions:ItemRevision:IMAN_master_form_rev:ItemRevision Master

structure_revisions:EBS2T4O_Item Revision:IMAN_master_form_rev:EBS2T4O_ItemRevision Master

T4O_BillOfMaterialMapping2MBOM=

structure_revisions:ItemRevision:IMAN_master_form_rev:ItemRevision Master



The example shows the reverse mapping for two BOM view types to their Item Revision Master Formsand to the BOM view itself (for BOM view type view).



T4O_BillOfMaterialFieldMapping2view=

object_desc

T4O_BillOfMaterialFieldMapping2structure_revisions:EBS2T4O_ItemRevision:IMAN_master_form_rev:EBS2T4O_Item Revision Master=

ebs2ItemNo

ebs2SentBom2EBS

ebs2SentBom2EBSDate

T4O_BillOfMaterialFieldMapping2structure_revisions:ItemRevision:IMAN_master_form_rev:ItemRevision Master=

user_data_3

SentBOMToEBS

In this example, the ItemRevision Master Form is the same for both BOM view types, thus only onepreference FieldMapping is needed for using both of them.

5.3 Mapping Specifics for BOM


The custom function that handles the item data mapping from Teamcenter to Oracle EBS isTC_Object2EBS_BillOfMaterial in mapping file t4o_bom_mapping_template.sd. That functionhandles the BOM header mapping. The function responsible for the BOM positions mapping isTC_Object2EBS_BillOfMaterialPosition.

By default, the customer-specific BOM header mapping function TC_Object2EBS_BillOfMaterialdistinguishes two BOM header transfer types depending on the value of attribute ebs2EcoNo (which isincluded into the Item Revision Master form by the default T4O installation):

Mapping Specifics for BOM


• ebs2EcoNo is empty: Normal BOM header transfer→ Mapping function TC_Object2EBS_BillOfMaterial_Standard is called which contains theactual BOM header mapping; see chapter Create BOM

• ebs2EcoNo contains an ECO ID: BOM header transfer with ECO (as revised item)→ Mapping function TC_Object2EBS_BillOfMaterial_ECO is called which contains the actualECO revised item mapping; see chapter Maintain BOM via ECO

By default, the customer-specific BOM position mapping functionTC_Object2EBS_BillOfMaterialPosition distinguishes two BOM position transfer typesdepending on the value of control parameter useEco4BomTransfer (which is set in the BOM headermapping function TC_Object2EBS_BillOfMaterial, see above):

• useEco4BomTransfer = FALSE: Normal BOM position transfer→ Mapping function TC_Object2EBS_BillOfMaterialPosition_Standard is called whichcontains the actual BOM position mapping; see chapter Create BOM

• useEco4BomTransfer contains any other value than FALSE: BOM position transfer with ECO (asrevised component)→ Mapping function TC_Object2EBS_BillOfMaterialPosition_ECO is called which containsthe actual ECO revised component mapping; see chapter Maintain BOM via ECO

For the mapping of Teamcenter data to Oracle EBS item data, T4O supports the following Oracle EBSdata structures:

• Oracle EBS BOM header data

• Oracle EBS BOM revision data

• Oracle EBS BOM component data

• Oracle EBS BOM reference designator data

• Oracle EBS BOM substitute data

• Oracle EBS BOM operation sequence data

To see which fields are available, have a look into chapter EBS Fields T4O Can Write to.

The fields of the ::EBSDat array to be filled with the EBS Item data begin with Bom: (e.g.Bom:P_BOM_HEADER_TBL:P_BOM_HEADER_TBL_ITEM:ASSEMBLY_ITEM_NAME:1 for the EBSassembly item name).




The custom function that handles the BOM data reverse mapping from Oracle EBS to Teamcenter isEBS_BillOfMaterial2TC_Object.


By default, the customer-specific BOM reverse mapping function EBS_BillOfMaterial2TC_Objectdistinguishes two BOM transfer types depending on the value of control parameteruseEco4BomTransfer (which is set in the BOM header mapping functionTC_Object2EBS_BillOfMaterial, see above):

• useEco4BomTransfer = FALSE: Normal BOM transfer→ Reverse mapping function EBS_BillOfMaterial2TC_Object_Standard is called whichcontains the actual BOM reverse mapping

• useEco4ItemTransferr contains any other value than FALSE: BOM transfer with ECO (as reviseditem)→ Reverse mapping function EBS_BillOfMaterial2TC_Object_ECO is called which contains theactual ECO reverse mapping.

Mapping of additional BOM Data ("additional transfer")

Besides the data of the item itself, it is possible to transfer some additional data. This means that thoseadditional data are created and maintained after the actual BOM transfer but within the sameTeamcenter workflow (T4O BOM) or interactive functionalities like "BOM Create". They are configured inthe same mapping file responsible for the BOM transfer (t4o_bom_mapping_template.sd).

The following "additional transfers" are supported in the context of an BOM transfer:

• Maintain attachments for a BOM: Maintain Attachments

• Implement the ECO linked to a BOM: Implement ECO for BOM

For each additional item data mapping, you will find a separate sub-function in item mapping templatet4o_bom_mapping_template.sd. All those sub-functions contain a switch in order to activate ordeactivate respective additional transfer and they are called by the generic BOM mapping functionTC_Object2EBS_BillOfMaterial.



Mapping Specifics for BOM


This mapping status can be used as return status in the main mapping functionsTC_Object2EBS_BillOfMaterial and TC_Object2EBS_BillOfMaterialPosition or anyunderlying function.

In general, all the above listed "additional transfers" are available for both BOM transfer types: standardand ECO based.

But by default, the standard BOM transfer only executes the following additional transfer (if respectiveswitch is activated):

• Assigning document attachments to the BOM

The ECO based BOM transfer only executes the following additional transfer (if activated in respectivesub-function) by default:

• Implement corresponding ECO for a BOM

However, it is possible to use the default standard additional transfers also for ECO based BOM transfersand vice versa. You can control this by enabling the following switches (they’re disabled by default):

set ::EBSDat(Bom:CtrlParam:PerformECOAdditionalTransfers4Standard) "TRUE"

This setting will allow executing ECO implementations also for standard BOM transfers.

set ::EBSDat(Bom:CtrlParam:PerformStandardAdditionalTransfers4ECO) "TRUE"

This setting will allow executing all standard additional transfers (see list above) also for ECO based BOMtransfers.

You may set those switches in generic BOM mapping function TC_Object2EBS_BillOfMaterial.


T4O offers this functionality in order to transfer several sets of data (e.g. organization specific BOM datafor more than one organization) to EBS in one T4O transaction although these data actually need oneEBS transaction each. In fact, T4O transfers them in several steps to EBS (because otherwise EBS wouldnot store all the data correctly) but from the user’s point of view it appears as one transaction only. Theadvantage is that all the data can be defined more easily in the mapping without additional steps (e.g.using more than one workflow handler with different arguments).

Use function ::T4O::storeEBSDat2MultiTransferCache in order to take a snapshot ofthe ::EBSDat array for each single transaction. Therefore, all the data for one single transaction shouldbe set before the call of this function. For BOM multi transfers, you should call it like the following:

::T4O::storeEBSDat2MultiTransferCache BOM



For BOM, a snapshot of the ::EBSDat array must be taken after a complete mapping including headerand positions. Therefore, the multi transfer settings should be added to mapping functionsTC_Object2EBS_BillOfMaterialPostAction_Standard orTC_Object2EBS_BillOfMaterialPostAction_ECO respectively, as these functions are calledafter the general mapping (header and position mapping).

For an example, refer to Create BOM in Orgs via "Multi Transfer" from theTeamcenter Gateway forOracle EBS - Configuration Guide

5.4 Maintain BOM Basic Data

EBS BOMs can be either Engineering or Manufacturing Bills. Additionally to that, multiple differentalternates can be used to have different bills for the same Item in the same org.

The following chapters describe the main capabilities T4O provides for maintaining basic EBS BOM data.

5.4.1 Create BOM

Use Cases

• Create BOM

• Maintain Effectivity Dates on BOM Components

• Maintain Operation Sequence Numbers on BOM Components

• Create an empty BOM

• Create a dummy component in the EBS BOM

• Check BOM Exists

Create BOM

T4O Configuration

For an example of setting the basic data for creating an EBS BOM header for the first time, refer torespective section in mapping function TC_Object2EBS_BillOfMaterial_Standard:

Create BOM (header) - t4o_bom_mapping_template.sd

For testing that functionality, use test scripts BOM create and BOM create (extended).

The following basic data for an EBS BOM header should be set in the ::EBSDat array:

Maintain BOM Basic Data




• Bom:P_BOM_HEADER_TBL:P_BOM_HEADER_TBL_ITEM:ASSEMBLY_ITEM_NAME:1

• Bom:P_BOM_HEADER_TBL:P_BOM_HEADER_TBL_ITEM:ORGANIZATION_CODE:1

• Bom:P_BOM_HEADER_TBL:P_BOM_HEADER_TBL_ITEM:ASSEMBLY_TYPE:1

In order to get a list of all fields you can set for BOM creation, refer to chapter EBS Fields T4O Can Writeto

Caution:

Although the EBS BOM Header information has an index in the TCL array ::EBSDat, it is notpossible to use any other index than 1.

It is also not possible to specify more than one header at the same time.

For an example of setting the basic data for creating corresponding EBS BOM components, refer torespective section in mapping function TC_Object2EBS_BillOfMaterialPosition_Standard:

Create BOM (components) - t4o_bom_mapping_template.sd

The following basic data for an EBS BOM component should be set in the ::EBSDat array:

• Bom:P_BOM_COMPONENT_TBL:P_BOM_COMPONENT_TBL_ITEM:ORGANIZATION_CODE:$PositionIndex

• Bom:P_BOM_COMPONENT_TBL:P_BOM_COMPONENT_TBL_ITEM:ASSEMBLY_ITEM_NAME:$PositionIndex

• Bom:P_BOM_COMPONENT_TBL:P_BOM_COMPONENT_TBL_ITEM:START_EFFECTIVE_DATE:$PositionIndex

• Bom:P_BOM_COMPONENT_TBL:P_BOM_COMPONENT_TBL_ITEM:OPERATION_SEQUENCE_NUMBER:$PositionIndex

• Bom:P_BOM_COMPONENT_TBL:P_BOM_COMPONENT_TBL_ITEM:COMPONENT_ITEM_NAME:$PositionIndex

• Bom:P_BOM_COMPONENT_TBL:P_BOM_COMPONENT_TBL_ITEM:ITEM_SEQUENCE_NUMBER:$PositionIndex

The parameter PositionIndex of functionTC_Object2EBS_BillOfMaterialPosition_Standard contains the index of the current TC BOMPosition starting with 1.

In the ::EBSDat array, the index of the EBS BOM components also start with 1 (1,2,…).



Caution:

• Oracle EBS treats item related BOM positions as references to existing items. So each of thoseBOM positions has to exist as Item before creating the BOM in Oracle EBS, else Oracle EBS willprovide an error. This can be prevented in the mapping if you get the ItemNumber from aTeamcenter attribute that is only filled when the Oracle EBS Item is created. Of course it will notwork that way if you map the Teamcenter Item ID (or similar data independent from Oracle EBS)to the Oracle EBS ItemNumber.

• If a Teamcenter BOM contains alternative positions, T4O will transfer all of them to Oracle EBS(which may be useful or not, depending on your processes). If you do not want this behavior,you can prevent it in the mapping. As only the "preferred" alternative (the one you will see inTeamcenter STRUCTURE MANAGER) has a Find Number (or Sequence Number, respectively) inthe Teamcenter BOM, you can evaluate that . As this is no problem from neither T4O nor OracleEBS point of view, a BOM workflow job is not aborted by default and the user is not informeddirectly.

In order to perform some additional steps after the header and position mappings are complete, placethat code in functions TC_Object2EBS_BillOfMaterialPostAction_Standard orTC_Object2EBS_BillOfMaterialPostAction_ECO respectively. An example for code to be addedto those functions is the "multi transfer" for BOM, see Transferring Several Sets of Similar Data in oneTransaction ("multi transfer").

In order to perform a valid BOM transfer, T4O needs a few control parameters which are defined infunction TC_Object2EBS_BillOfMaterial:

• Bom:CtrlParam:EFFECTIVITY_DATE:This control parameter is important for the BOM read call. It specifies a reference date to be used forEFFECTIVITY_DISPLAY_TYPE filter, see below. The default value is the time string for ‘now’.Additionally, you can use this value in the definition for BOM line start effectivity date, or for an ECO ifthe BOM is maintained through an ECO.

• Bom:CtrlParam:EFFECTIVITY_DISPLAY_TYPE:This control parameter is important for the BOM read call to specify which components should beretrieved depending on the component effectivity. Following values are possible:

• ALL:Search for all components

• CURRENT:Search for only those components that are effective exactly at the reference date(EFFECTIVITY_DATE)

• FUTURE AND CURRENT (default):Search for only those components that are effective at the reference date (EFFECTIVITY_DATE)or in the future

Create BOM


• Bom:CtrlParam:OPERATION_SEQUENCE_NUMBER:This control parameter is important for the BOM read call to filter all components with the specifiedoperation sequence number. If this parameter is left empty, as in the default mapping, the operationsequence number will be ignored for the components query.

• Bom:CtrlParam:DISABLED_DATE:This control parameter can be used to close the effectivity date for deleted BOM lines. If left empty,the value of EFFECTIVITY_DATE will be taken.

• DELETE_GROUP_NAME:If this control parameter is defined (not empty), BOM lines will be deleted using this delete groupname instead of being closed via effectivity date.

Maintain Effectivity Dates on BOM Components

T4O Configuration

The effectivity dates on the BOM component level can be controlled with ::EBSDat field:

Bom:P_BOM_COMPONENT_TBL:P_BOM_COMPONENT_TBL_ITEM:START_EFFECTIVE_DATE:$PositionIndex

Example:

set\

::EBSDat(Bom:P_BOM_COMPONENT_TBL:P_BOM_COMPONENT_TBL_ITEM:START_EFFECTIVE_DATE:$PositionIndex)\

[::T4O::getTimeString4Now]

In this example the START_EFFECTIVE_DATE of EBS component is set byfunction ::T4O::getTimeString4Now. This function returns the time string for ‘now’ for the T4Osystem (host where GS is running).

If you need to explicitly set a date in attribute START_EFFECTIVE_DATE, the value has to be providedin the following format:


For determining the time zone of the T4O system, use function T4O::getT4OTimezone.

Example:

set\



::EBSDat(Bom:P_BOM_COMPONENT_TBL:P_BOM_COMPONENT_TBL_ITEM:START_EFFECTIVE_DATE:$PositionIndex)\

"2010-12-01T12:00:00.000[::T4O::getT4OTimezone]"

Caution:

The effectivity date can only be set while creating the BOM in Oracle EBS. Once set, it cannot bemodified any more. T4O will ignore the value for any BOM update transfer.

Maintain Operation Sequence Numbers on BOM Components

T4O Configuration

The operation sequence numbers on the BOM component level can be controlled with ::EBSDat field:

Bom:P_BOM_COMPONENT_TBL:P_BOM_COMPONENT_TBL_ITEM:OPERATION_SEQUENCE_NUMBER:$PositionIndex

Example:

set\

::EBSDat(Bom:P_BOM_COMPONENT_TBL:P_BOM_COMPONENT_TBL_ITEM:OPERATION_SEQUENCE_NUMBER:$PositionIndex)\

"1"

Create an empty BOM

By default, T4O will not allow using an empty Teamcenter BOM (i.e. a BOM that is stored without anyBOM position) but create an error instead. The same can happen if you skip every position inside themapping logic. In order to handle an empty BOM, first tell T4O to allow using an empty TeamcenterBOM by setting the following in the BOM header mapping:

set ::EBSDat(Bom:CtrlParam:allowEmptyBomTransfer) TRUE

Then it will handle the empty Teamcenter BOM and if this is used to create or modify an EBS BOM, thiswill be empty as well. In order to not use an empty BOM but not create an error, set the following lineadditionally:

set ::EBSDat(Bom:CtrlParam:skipEmptyBomTransfer) TRUE

The default values (used if they are not set explicitly in the mapping) of those two switches are FALSEeach.

Create BOM


The T4O BOM Workflow handler argument -no_transfer_of_empty_bom will also skip the emptyTeamcenter BOM, but only if it is stored empty, not if it gets empty by skipping its positions.

Caution:

Do not set both of them to TRUE because it is contradictory:

allowEmptyBomTransfer

means an empty BOM should be handled and transferred to EBS

skipEmptyBomTransfer

means it should be skipped, so it will not be processed at all and there will beno ERROR message

If you set both to FALSE a transfer of an empty BOM is aborted showing an ERROR message like:"Bill of Material transfer to EBS returns with status: EMPTY_BOM_ERROR".

Create a dummy component in the EBS BOM

In order to create an additional BOM component in the EBS that does not have a counterpart in theTeamcenter BOM, you have to tell T4O that it has to create an additional component and set all the datafor it. This might be helpful for example to avoid empty EBS BOMs or to set specific data additionally.

The following example shows how to create a dummy BOM component in the EBS (set this data in BOMheader mapping function TC_Object2EBS_BillOfMaterial_Standard):

# Define fix position number 9999 for this component; of course this

# must be a number that does not exist in any of the TC BOM lines shown in

# the Structure Manager:

set AddCompPosInd "9999"

# Initialize the T4O data of this new BOM line:

::TPEBS::BOM::initBomStructure_P_BOM_COMPONENT_TBL $AddCompPosInd

set \

::EBSDat(Bom:P_BOM_COMPONENT_TBL:P_BOM_COMPONENT_TBL_ITEM:ORGANIZATION_CODE:$AddCompPosInd)\

$::EBSDat(Bom:P_BOM_HEADER_TBL:P_BOM_HEADER_TBL_ITEM:ORGANIZATION_CODE:1)

set \



::EBSDat(Bom:P_BOM_COMPONENT_TBL:P_BOM_COMPONENT_TBL_ITEM:ASSEMBLY_ITEM_NAME:$AddCompPosInd)\

$::EBSDat(Bom:P_BOM_HEADER_TBL:P_BOM_HEADER_TBL_ITEM:ASSEMBLY_ITEM_NAME:1)

set \

::EBSDat(Bom:P_BOM_COMPONENT_TBL:P_BOM_COMPONENT_TBL_ITEM:START_EFFECTIVE_DATE:$AddCompPosInd)\

$::EBSDat(Bom:CtrlParam:EFFECTIVITY_DATE)

set \

::EBSDat(Bom:P_BOM_COMPONENT_TBL:P_BOM_COMPONENT_TBL_ITEM:OPERATION_SEQUENCE_NUMBER:$AddCompPosInd)\

"1"

set \

::EBSDat(Bom:P_BOM_COMPONENT_TBL:P_BOM_COMPONENT_TBL_ITEM:COMPONENT_ITEM_NAME:$AddCompPosInd)\

"DummyComp_01"

set \

::EBSDat(Bom:P_BOM_COMPONENT_TBL:P_BOM_COMPONENT_TBL_ITEM:ITEM_SEQUENCE_NUMBER:$AddCompPosInd)\

"9999"

set \

::EBSDat(Bom:P_BOM_COMPONENT_TBL:P_BOM_COMPONENT_TBL_ITEM:QUANTITY_PER_ASSEMBLY:$AddCompPosInd)\

"1"

Before transferring the BOM to EBS, make sure that an EBS item already exists for the dummycomponent to be added to the EBS BOM.

Check BOM Exists

T4O Configuration

Create BOM


T4O provides the function ::TPEBS::BOM::checkBomExistence to check if a BOM already exists inthe EBS. Please see the T4O API Reference for more details.

5.4.2 Update BOM

If the EBS BOM has already been created in EBS or by T4O, each following transaction will be a BOMUpdate by default. In general, you can set the same attributes for updating a BOM as for creating a BOM(see chapter EBS Fields T4O Can Write to).

Use Cases

• Adding additional data to a BOM Header

• Changing existing data on a BOM Header

• Deleting existing data on a BOM Header

• Add Component

• Update Component

• Delete Component

• Check BOM is Engineering BOM

For updating or deleting BOM components, the following key attributes will be used, in order to identifyan already existing component on an EBS BOM:

• START_EFFECTIVE_DATE

• OPERATION_SEQUENCE_NUMBER

• COMPONENT_ITEM_NAME

Adding additional data to a BOM Header

T4O Configuration

In order to set additional data on a BOM header, just specify respective fields in mapping functionTC_Object2EBS_BillOfMaterial_Standard.

Changing existing data on a BOM Header

T4O Configuration




In order to change existing data on a BOM header, just adapt respective fields in mapping functionTC_Object2EBS_BillOfMaterial_Standard.

Deleting existing data on a BOM Header

T4O Configuration

In order to clear a field on the BOM header, call function EBSClearAttribute for respective attributein mapping function TC_Object2EBS_BillOfMaterial_Standard. As it works the same as forItems, refer to Deleting existing data on an Item.

Add Component

T4O Configuration

Just transferring a component that is not yet existing on the EBS BOM, will add it to the BOM.

Update Component

T4O Configuration

Transferring a component that is already existing on the EBS BOM will change respective componentattributes on the BOM.

Caution:

The key attribute COMPONENT_ITEM_NAME can't be changed during an update!

In order to change the key attributes START_EFFECTIVE_DATE and OPERATION_SEQUENCE_NUMBERyou need to set the changed values in the following attributes starting with prefix NEW_ (leave theoriginal attribute values unchanged!)

• NEW_EFFECTIVITY_DATE

• NEW_OPERATION_SEQUENCE_NUMBER

Delete Component

T4O Configuration

Not transferring a component that is already exiting on the EBS BOM, will delete respective componentfrom the BOM. By default, there wouldn't be a "real" deletion of the component. Instead, the effectivitydate of the component would be closed according to the setting in control parameterBom:CtrlParam:DISABLED_DATE. Alternatively you can delete components using a delete groupname. In that case, specify respective delete group name in control parameterBom:CtrlParam:DELETE_GROUP_NAME.

Update BOM


Check BOM is Engineering BOM

T4O Configuration

T4O provides the function ::TPEBS::BOM::checkBomIsEngineeringBom to check if an EBS BOM isan engineering BOM or not.


In order to get an example and to test that functionality, use test script BOM check engineeringBOM.

5.4.3 Create Alternate BOM

T4O Configuration

In order to create an alternate BOM in the EBS, you need to specify ::EBSDat attributeBom:P_BOM_HEADER_TBL:P_BOM_HEADER_TBL_ITEM:ALTERNATE_BOM_CODE:1 in functionTC_Object2EBS_BillOfMaterial_Standard, e.g.:

set ::EBSDat(Bom:P_BOM_HEADER_TBL:P_BOM_HEADER_TBL_ITEM:ALTERNATE_BOM_CODE:1) "Prototype"

5.4.4 Update Alternate BOM

If the EBS Alternate BOM has already been created in EBS or by T4O, each following transaction willupdate the existing EBS Alternate BOM, by default.

5.4.5 Read BOM

T4O Configuration

T4O provides the function ::TPEBS::BOM::getBomInfo for getting detailed information of anexisting EBS BOM. If the BOM was found, the retrieved data will be returned in global TCLarray ::BomResultDat.


In order to get an example and to test that functionality, use test script BOM get data.

When transferring a BOM to the EBS, that function is internally called by T4O. Thus there is no need toexplicitly call that function in that case.





5.5 Maintain BOM in Orgs

Like for EBS Items, Bills of Materials are org specific in Oracle EBS, supporting plant/company specificmanufacturing/assembly of parts.

When creating a BOM for the first time, it will be created in a master organization. Maintaining the BOMin any further inventory organization can be implemented using the following approach:

• Full creation of one or more child BOMs applying the attribute values from the mapping within oneBOM transaction. This is handled as a "multi transfer" (see Transferring Several Sets of Similar Data inone Transaction ("multi transfer")).

Caution:

In contrast to Inventory Items, it is not possible to directly assign a BOM to multiple organizations(also not supported in Oracle Forms UI!).

Create BOM in Orgs via "Multi Transfer"

That approach will perform a full creation of a BOM in multiple organizations.

T4O Configuration

In order to implement that approach, you need to adapt the mapping functionTC_Object2EBS_BillOfMaterialPostAction_Standard.

Example for setting the same BOM data for different EBS organizations:

## Take a snapshot of the complete ::EBSDat and # store it for the object type "BOM"#::T4O::storeEBSDat2MultiTransferCache BOM## Now lets go through the EBSDat and # change all orgs (Header, Components...) to AU#foreach elem [array names ::EBSDat *ORGANIZATION_CODE*] { if { $::EBSDat($elem) != "" } { set ::EBSDat($elem) "AU" tpwrite -logchannel [::T4X::CORE::getSessionLogChannel] -mtype INTERN \ "$FunctionName - Changed ::EBSDat($elem) to >$::EBSDat($elem)<" }}#

Maintain BOM in Orgs


# Take another snapshot of the complete ::EBSDat and# store it again for the object# type "BOM"#::T4O::storeEBSDat2MultiTransferCache BOM

5.5.1 Get BOM Organizations

T4O Configuration

T4O provides the function ::TPEBS::BOM::getBomOrganizations to get all organizations to whicha BOM is assigned in the EBS. The retrieved organizations will be returned in global TCLarray ::BomResultDat.


In order to get an example and to test that functionality, use test script BOM get organizations.

5.6 Maintain Reference Designators

EBS Reference Designators offer the possibility to assign an individual string (often a number) toindividual occurrences of the same BOM component. As an example, if the bill "Car" contains four tires,individual position numbers (designators) can be assigned to each individual tire, even though they areall summed up in one component.

T4O supports the maintenance of reference designators for EBS BOM components.

T4O Configuration

The maintenance of reference designators for respective EBS BOM components can be configured inmapping function TC_Object2EBS_BillOfMaterialRefDes4Position_Standard (called bymapping functionTC_Object2EBS_BillOfMaterialPosition_Standard); for an example refer torespective code section in that function:

Maintain Reference Designators - t4o_bom_mapping_template.sd

The fields of the ::EBSDat array containing the data for the EBS reference designators begin withBom:P_BOM_REF_DESIGNATOR_TBL:.

5.7 Maintain Substitute Components

The concept of Substitutes in Oracle EBS is nearly identical to the one in Teamcenter, offering analternative part that can be used in the manufacturing/assembly substituting the main component. Themain difference to Teamcenter is that the quantity for each substitute component can differ.




T4O supports the maintenance BOM substitute components in the EBS.

T4O Configuration

The maintenance of substitute components for respective EBS BOM components can be configured inmapping function TC_Object2EBS_BillOfMaterialSubPos4Position_Standard (called bymapping functionTC_Object2EBS_BillOfMaterialPosition_Standard); for an example refer torespective code section in that function:

Maintain Substitute Components - t4o_bom_mapping_template.sd

The fields of the ::EBSDat array containing the data for the EBS substitute components begin withBom:P_BOM_SUB_COMPONENT_TBL:.


This chapter only provides some specific information about how to configure the BOM transfer in orderto include the assignment of EBS attachments. As the attachments transfer for BOM works the same wayas for Item, please refer to chapter Maintain Attachments to get some detailed information on how toconfigure the additional attachments transfer in general.


In order to configure T4O to export a TC file (named reference) attached to the BOM header object, youneed to add respective additional objects to one of the following preferences:

• T4O_ItemMapping4:→ if using the same settings for Item and BOM transfers

• T4O_BillOfMaterialHeaderMapping4:→ if using different settings for Item and BOM transfers

In order to make the attributes of extended form (e.g. the T4O Dataset Extension Form attached to thedataset or the Item Revision) available in the BOM mapping, enhance/add the following preferences:

• either T4O_ItemMapping4 or T4O_BillOfMaterialHeaderMapping4 (see above)


• T4O_BillOfMaterialFieldMapping2



T4O Configuration

Maintaining attachments for a BOM is handled as an "additional transfer" (see Mapping of additionalBOM Data ("additional transfer")) and can be activated in the mapping.

To define the attachments data mapping for a BOM transfer, adapt the example code in functionTC_Object2EBS_BillOfMaterial_DocumentAttachment (called by generic BOM mappingfunction TC_Object2EBS_BillOfMaterial).

Maintain Attachments - t4o_bom_mapping_template.sd


In order to maintain (create, update, delete) attachments for an item in the EBS, configure the followingin the mapping:


set ::EBSDat(Bom:CtrlParam:DocumentAttachmentTransfer) "TRUE"

• Set the attachments target type in ::EBSDat fieldAttachment:PARAMETER:P_EBS_TARGET_TYPE to BOM.

• Specify the BOM for which the attachments should be maintained. Set the organization codein ::EBSDat field Attachment:PARAMETER:P_PK1_NAME, the assembly item name in fieldAttachment:PARAMETER:P_PK2_NAME and the alternate BOM code in fieldAttachment:PARAMETER:P_PK3_NAME.


See chapter Create Attachment.


See chapter Create File Attachment.


See chapter Create URL Attachment.


See chapter Create Short Text Attachment.




See chapter Create Long Text Attachment.


See chapter Update Attachment.


See chapter Delete Attachment.


See chapter Delete All Attachments.


See chapter Link Document to Several Items.


See chapter Get Attachments.


See chapter Export Attached File.

5.9 Maintain BOM via ECO

Instead of transferring a Teamcenter BOM to a standard EBS BOM, T4O supports transferring it as arevised item (header) including respective revised components (positions) within a specified ECOcontext.

Use Cases

• Maintain BOM Header via ECO

• Maintain BOM Components via ECO

• Maintain Reference Designators via ECO

• Maintain Substitute Components via ECO

Create Long Text Attachment


Maintain BOM Header via ECO

T4O Configuration

The mapping for an ECO based BOM header transfer is done in functionTC_Object2EBS_BillOfMaterial_ECO (called by generic BOM header mapping functionTC_Object2EBS_BillOfMaterial); for an example refer to the code in that function:

Maintain BOM Header via ECO - t4o_bom_mapping_template.sd

For creating revised items and revised components on an ECO, the EBS requires the usage of an ECOname that is valid for the items and components. In the default mapping, the ECO name is taken fromthe attribute ebs2EcoNo on the Item Revision Master Form. Only if this attribute contains a value(either set manually in the Teamcenter GUI or filled by a previous ECO transfer), the BOM will betransferred within an ECO context (as defined in the default mapping, but it is configurable!).

As maintaining a revised item for a BOM header works the same as for an Item, refer to chapterMaintain Item via ECO for details on the configuration.

Maintain BOM Components via ECO

T4O Configuration

The mapping for an ECO based BOM components (→ revised components) transfer is done in functionTC_Object2EBS_BillOfMaterialPosition_ECO (called by generic BOM position mappingfunction TC_Object2EBS_BillOfMaterialPosition); for an example refer to the code in thatfunction:

Maintain BOM Components via ECO - t4o_bom_mapping_template.sd

The fields of the ::EBSDat array containing the data for the EBS revised components begin withChangeOrder:P_REV_COMPONENT_TBL:.

Caution:

For a revised component, don’t change the default settings of the ECO_NAME(ChangeOrder:P_REV_COMPONENT_TBL:P_REV_COMPONENT_TBL_ITEM:ECO_NAME:$PositionIndex) and ORGANIZATION_CODE(ChangeOrder:P_REV_COMPONENT_TBL:P_REV_COMPONENT_TBL_ITEM:ORGANIZATION_CODE:$PositionIndex), as those must be equal to the settings in the ECO header(ChangeOrder:P_ECO_REC:ECO_NAME andChangeOrder:P_ECO_REC:ORGANIZATION_CODE). Generally, if you want to adapt the ECOname, only change it in the header.

Consider the following when configuring the data mapping for revised components:



• A BOM transfer with ECO executes a normal ECO transfer with the specified BOM header as a reviseditem including specified BOM positions as revised components. Thus, the item and components to becreated as revised item and revised components should already exist in the EBS before the transfer isinitiated.

It is possible controlling whether a revised component (or any other sub-object of ECO) with action type"Change" will be sent to the EBS in any case, or whether it will only be sent if it is different to thecorresponding EBS BOM component.

In order to control whether a component should be transferred or not, configure the following:

• Activate function check4AttributeChanges_Components: Set the switchChangeOrder:CtrlParam:Check4AttributeChanges_Components in the BOM headermapping function TC_Object2EBS_BillOfMaterial_ECO to TRUE.

• Adapt the settings in function check4AttributeChanges_Components accordingly.

Function check4AttributeChanges_Components is called for each revised component with actiontype "Change".

In the default mapping example, a component only is transferred as revised component (with actiontype "Change") if at least one attribute in list lstAttributes has been changed (return status OK):The value of TC BOM line attribute (= value of revised component attribute to be sent) is different thanthe corresponding attribute of the EBS BOM component. If none of the attributes has been changed, thecomponent won’t be sent to the EBS at all and the ECO won’t be attached to it (return status SKIPPED).

Caution:

• Don’t forget to add any attribute to list lstAttributes that should be included in thecomparison. Otherwise, BOM component changes may get lost.

• Be careful to use the right compare logic for each attribute.

Examples:

• TC attribute is empty - EBS attribute is empty → can be handled as identical

• TC attribute is empty - EBS attribute is a number like 0.000000 → may be handled as identicaldepending on the corresponding TC and EBS data type

• TC attribute is a number like 0,00000 - EBS attribute is a number like 0.00000 → may behandled as identical depending on the corresponding TC and EBS data type

Maintain BOM via ECO


Caution:

If you need to clear an attribute on a BOM component via ECO, there is an Oracle restriction:Oracle tries to apply the default values of the original BOM and overwrites any cleared values.Thus, as a workaround, you need to transfer such a revised component with cleared attribute(s)twice by configuring a "multi transfer"; see Transferring Several Sets of Similar Data in oneTransaction ("multi transfer").

Maintain Reference Designators via ECO

T4O Configuration

The mapping for an ECO based reference designators transfer is done in functionTC_Object2EBS_BillOfMaterialRefDes4Position_ECO (called by functionTC_Object2EBS_BillOfMaterialPosition_ECO); for an example refer to the code in thatfunction:

Maintain Reference Designators via ECO - t4o_bom_mapping_template.sd

The fields of the ::EBSDat array containing the data for the EBS revised components begin withChangeOrder:P_REF_DESIGNATOR_TBL:

As for BOM components (see above), it is also possible to control whether a reference designator withaction type "Change" will be sent to the EBS in any case, or whether it will only be sent if it is different tothe corresponding EBS BOM reference designator. Use function check4AttributeChanges_RefDesand according switch in function TC_Object2EBS_BillOfMaterial_ECO for that purpose.

Maintain Substitute Components via ECO

T4O Configuration

The mapping for an ECO based substitute components transfer is done in functionTC_Object2EBS_BillOfMaterialSubPos4Position_ECO (called by functionTC_Object2EBS_BillOfMaterialPosition_ECO); for an example refer to the code in thatfunction:

Maintain Substitute Components via ECO - t4o_bom_mapping_template.sd

The fields of the ::EBSDat array containing the data for the EBS revised components begin withChangeOrder:P_SUB_COMPONENT_TBL:

As for BOM components (see above), it is also possible to control whether a substitute component withaction type "Change" will be sent to the EBS in any case, or whether it will only be sent if it is different tothe corresponding EBS BOM substitute component. Use functioncheck4AttributeChanges_Substitutes and according switch in functionTC_Object2EBS_BillOfMaterial_ECO for that purpose.



5.9.1 Implement ECO for BOM


ECO implementation is handled as an "additional transfer" in the context of a BOM transfer – eitherstandard or ECO based (see Mapping of additional BOM Data ("additional transfer")). This means thatBOM implementation is executed after the actual item transfer but within the same Teamcenterworkflow or interactive function.

T4O Configuration

Implementing an ECO for a BOM is done in mapping functionTC_Object2EBS_BillOfMaterial_ImplementECO (called by generic BOM mapping functionTC_Object2EBS_BillOfMaterial); for an example refer to the code in that function:

Implement ECO for BOM - t4o_bom_mapping_template.sd

Please refer to the examples in that file in order to get information about how to configure ECOimplementation for BOM transfers. As it works the same way for BOM as for Item, you may also have alook at chapter Implement ECO for Item.

5.9.2 Transfer or Copy Engineering BOM to Manufacturing

T4O supports transferring or copying an engineering BOM to manufacturing. This is the samefunctionality as provided by Oracle Forms UI on the Engineering Change Orders form with buttonsTransfer and Copy.

Use Cases

• Transfer Engineering BOM to Manufacturing

• Copy Engineering BOM to Manufacturing

T4O Configuration

An example of how to configure that functionality in the mapping can be found in functionTC_Object2EBS_BillOfMaterial_ECO (called by generic item mapping functionTC_Object2EBS_BillOfMaterial):

Transfer or Copy Engineering BOM to Manufacturing -t4o_bom_mapping_template.sd

Implement ECO for BOM


5.9.3 Get ECOs for BOM

T4O Configuration

T4O provides the function ::TPEBS::BOM::getECOs4BOM for getting all ECOs related to an existingEBS BOM. The retrieved ECOs will be returned in global TCL array ::BomResultDat.


In order to get an example and to test that functionality, use test script BOM get ECOs.




6. Change Transfer - Engineering ChangeOrder

6.1 Introduction


Nomenclature

Teamcenter Oracle EBS

ItemRevision or EngineeringChangeNotice Engineering Change Order (ECO)


Export

TargetTypeName ChangeOrderMapping template t4o_eco_mapping_template.sd

Mapping namespace ::T4O::ECO::CUSTOM::MAPPINGBasic mapping function TC_Object2EBS_ChangeOrderBasic reverse mapping function EBS_ChangeOrder2TC_ObjectPreferences start with T4O_ChangeOrderHandler T4O-transfer-ChangeOrder

T4O-validate-ChangeOrderSee the T4O API Reference for more details.

Import Job

Job type T4O_IMPORT_ECOMapping template t4o_eco_import_template.sd


Teamcenter and Oracle EBS both offer a change management as functionality to bundle several changesin one object. The aim is to activate different modifications on several engineering objects (e.g. bills ofmaterials) at the same time without having to process them all manually. T4O can link Oracle EBSchange objects (ECO) to other Oracle EBS objects whether the Teamcenter change management is usedor not. T4O passes data to the Oracle EBS ECO, no matter if they are stored in a Teamcenter changeobject or anywhere else.




Using Teamcenter Change Management, the Teamcenter change revisions can be used as T4O workflowtargets. T4O is looking for configured folders ("problem items", "solution items") automatically andtransfers all found and configured objects to Oracle EBS. This way of working provides a more tightconnection between Teamcenter and Oracle EBS change management.

The following examples only show the method where in Teamcenter no Change Object is used. Theinformation about the Oracle EBS ECO is stored in the Item Revision Master Form instead, which can behandled more easily in Teamcenter. This information may be used by the other data types in order tochange the Oracle EBS data object with this ECO. As the logic is exactly the same as with Item, it isdescribed more briefly here for ECO.

Mapping Examples

The mapping examples of the following chapters can be found in file t4o_eco_mapping_template.sd indirectory <T4O_ROOT>/var/template/capabilities/T4O.

How to find a mapping example referenced in this documentation is described in the Introduction forPart Transfer - Inventory Item.

6.2 Global Preferences for ECO

Please see chapter Object Transfer Specific Preferences in the Active Integration - GenericConfiguration Guide for information about how to configure the preferences for the object datamapping in general.

In the generic preferences, the <TargetTypeName> needs to be replaced by ChangeOrder and theprefix <T4x> needs to be replaced by T4O.

The following basic preferences are available for defining the ECO data mapping from Teamcenter toEBS:

• T4O_ChangeOrderTypeList

• T4O_ChangeOrderDisplayableTypeList (optional)

• T4O_ChangeOrderMapping4


• T4O_ChangeOrderFieldMapping2 (optional)

Definition of TC Item Revision Types Which Should be Supported

Example definition of two Item Revision types for usage with T4O:

6. Change Transfer - Engineering Change Order




T4O_ChangeOrderTypeList=ItemRevisionEBS2T4O_Item Revision

Use optional preference T4O_ChangeOrderDisplayableTypeList in order to enable only a subsetof types defined in T4O_ChangeOrderTypeList for ECO in the T4O GUI; see Definition of TeamcenterObjects You Want to Support in the T4O GUI for details.


Example for defining the related TC data objects from which you want to pass data to Oracle EBS viaT4O:

T4O_ChangeOrderMapping4ItemRevision=items_tag:Itemitems_tag:Item:IMAN_master_form:Item Masteritems_tag:Item:#__getAllProperties__#:PropertiesIMAN_master_form_rev:ItemRevision Master#__getAllProperties__#:Properties

T4O_ChangeOrderMapping4EBS2T4O_Item Revision=items_tag:EBS2T4O_Itemitems_tag:EBS2T4O_Item:IMAN_master_form:EBS2T4O_Item Masteritems_tag:EBS2T4O_Item:#__getAllProperties__#:PropertiesIMAN_master_form_rev:EBS2T4O_Item Revision Master#__getAllProperties__#:Properties



T4O_ChangeOrderMapping2EBS2T4O_Item Revision=IMAN_master_form_rev:EBS2T4O_Item Revision Master

The example contains the handling for the Item Revision Type EBS2T4O_Item Revision. It describesthe reverse mapping of data to the EBS2T4O_Item Revision Master using the Teamcenter relationIMAN_master_form_rev.



T4O_ChangeOrderFieldMapping2IMAN_master_form_rev:EBS2T4O_Item Revision Master=ebs2EcoNo

Global Preferences for ECO


ebs2SentEco2EBSebs2SentEco2EBSDate

6.3 Mapping Specifics for ECO


The custom function that handles the item data mapping from Teamcenter to Oracle EBS isTTC_Object2EBS_ChangeOrder in mapping file t4o_eco_mapping_template.sd.

To see which fields are available for the mapping of Teamcenter data to Oracle EBS ECO data, have alook into chapter EBS Fields T4O Can Write to.

The fields of the ::EBSDat array to be filled with the EBS ECO data begin with ChangeOrder: (e.g.ChangeOrder:P_ECO_REC:ECO_NAME for the EBS ECO name).


The custom function that handles the BOM data reverse mapping from Oracle EBS to Teamcenter isEBS_ChangeOrder2TC_Object.


Mapping of additional ECO Data ("additional transfer")

Besides the data of the ECO itself, it is possible to transfer some additional data. This means that thoseadditional data are created and maintained after the actual ECO transfer but within the sameTeamcenter workflow (T4O ECO) or interactive functionalities like "ECO Create". They are configured inthe same mapping file responsible for the BOM transfer (t4o_eco_mapping_template.sd).

The following "additional transfers" are supported in the context of an BOM transfer:

• Implement the ECO: Implement ECO

• Maintain attachments for a BOM: Maintain Attachments

For each additional item data mapping, you will find a separate sub-function in item mapping templatet4o_eco_mapping_template.sd. All those sub-functions contain a switch in order to activate ordeactivate respective additional transfer and they are called by the generic ECO mapping functionTC_Object2EBS_ChangeOrder.





This mapping status can be used as return status in the main mapping functionTC_Object2EBS_ChangeOrder or any underlying function.


T4O offers this functionality in order to transfer several sets of data (e.g. organization specific ECO datafor more than one organization) to EBS in one T4O transaction although these data actually need oneEBS transaction each. In fact, T4O transfers them in several steps to EBS (because otherwise EBS wouldnot store all the data correctly) but from the user’s point of view it appears as one transaction only. Theadvantage is that all the data can be defined more easily in the mapping without additional steps (e.g.using more than one workflow handler with different arguments).

Use function ::T4O::storeEBSDat2MultiTransferCache in order to take a snapshot ofthe ::EBSDat array for each single transaction. Therefore, all the data for one single transaction shouldbe set before the call of this function. For ECO multi transfers, you should call it like the following:

::T4O::storeEBSDat2MultiTransferCache ECO

6.4 Maintain ECO Basic Data

Oracle EBS has a rather powerful change module, allowing the user to keep track of changes using anEngineering Change Order (ECO). It typically contains a set of changes caused by one design initiative ordefect affecting multiple objects.

The following chapters describe the main capabilities T4O provides for maintaining basic EBS ECO data.

6.4.1 Create ECO

Use Cases

• Create ECO

• Check ECO Exists

Create ECO

T4O Configuration

For an example of setting the basic data for creating an EBS ECO header for the first time, refer torespective section in mapping function TC_Object2EBS_ChangeOrder:

Create ECO (header) - t4o_eco_mapping_template.sd

For testing that functionality, use test scripts ECO create and ECO create (extended).

Maintain ECO Basic Data


The following basic data for an EBS ECO header should be set in the ::EBSDat array:

• ChangeOrder:P_ECO_REC:ECO_NAME

• ChangeOrder:P_ECO_REC:DESCRIPTION

• ChangeOrder:P_ECO_REC:ORGANIZATION_CODE

• ChangeOrder:P_ECO_REC:APPROVAL_STATUS_NAME

• ChangeOrder:P_ECO_REC:CHANGE_TYPE_CODE

In order to get a list of all fields you can set for Item creation, refer to chapter EBS Fields T4O Can Writeto

Caution:

There is an Oracle EBS restriction for the length of field ECO_NAME: Only a maximum length of 10characters is allowed. If you exceed the length of 10, you will get the following error:

Check ECO Exists

T4O Configuration

T4O provides the function ::TPEBS::ECO::checkChangeOrderExistence to check if an ECOalready exists in the EBS. Please see the T4O API Reference for more details.

6.4.2 Update ECO

If the EBS ECO has already been created in EBS or by T4O, each following transaction will be an ECOUpdate by default. In general, you can set the same attributes for updating an ECO as for creating anECO (see chapter EBS Fields T4O Can Write to).

Use Cases

• Adding additional data to an ECO Header

• Changing existing data on an ECO Header




• Deleting existing data on an ECO Header

Adding additional data to an ECO Header

T4O Configuration

In order to set additional data on an ECO header, just specify respective fields in mapping functionTC_Object2EBS_ChangeOrder.

Changing existing data on an ECO Header

T4O Configuration

In order to change existing data on an ECO header, just adapt respective fields in mapping functionTC_Object2EBS_ChangeOrder.

Deleting existing data on an ECO Header

T4O Configuration

In order to clear a field on the ECO header, call function EBSClearAttribute for respective attributein mapping function TC_Object2EBS_ChangeOrder. As it works the same as for Items, refer toDeleting existing data on an Item.

6.4.3 Read ECO

T4O Configuration

T4O provides the function ::TPEBS::ECO::getChangeOrderInfo for getting detailed informationof an existing EBS ECO. If the ECO was found, the retrieved data will be returned in global TCLarray ::EcoResultDat.


In order to get an example and to test that functionality, use test script ECO get data.

When transferring an ECO to the EBS, that function is internally called by T4O. Thus there is no need toexplicitly call that function in that case.

6.5 Maintain ECO Revision

The following chapters describe the main capabilities T4O provides for maintaining EBS ECO Revisions.

Read ECO



6.5.1 Create ECO Revision

T4O Configuration

Creating an ECO revision can be configured in base ECO mapping functionTC_Object2EBS_ChangeOrder; for an example refer to respective code snippet in that function:

Create ECO Revision - t4o_eco_mapping_template.sd

The fields of the ::EBSDat array containing the data for an EBS Item Revision begin withChangeOrder:P_ECO_REVISION_TBL:.

In general, you need to consider the following for configuring the Item Revision Transfer in the mapping:

• Initialize the data structure for an ECO revision by callingfunction ::TPEBS::ECO::initChangeOrderStructure_P_ECO_REVISION_TBL.

• Set the new item revision in fieldChangeOrder:P_ECO_REVISION_TBL:P_ECO_REVISION_TBL_ITEM:REVISION:$Index ofthe ::EBSDat array.

• You need to specify the ECO (including organization) for which the ECO revision should be maintainedin fieldsChangeOrder:P_ECO_REVISION_TBL:P_ECO_REVISION_TBL_ITEM:ECO_NAME:$Index andChangeOrder:P_ECO_REVISION_TBL:P_ECO_REVISION_TBL_ITEM:ORGANIZATION_CODE:$Index.

Be aware that creating/updating an ECO revision is not handled as an "additional transfer" in contrast tocreating/updating an item revision for an item transfer. This is the case, as the ECO revision transfer isexecuted in the same EBS API call as the ECO transfer itself (API EGO_ITEM_PUB.Process_ECO),whereas the item revision transfer is handled in a separate EBS API call (APIEGO_ITEM_PUB.Process_Item_Revision).

6.5.2 Update ECO Revision

If the EBS ECO Revision has already been created in EBS or by T4O, each following transaction will be anECO Revision Update by default.

T4O Configuration

In order to change existing data on an ECO Revision, just adapt respective ::EBSDat fields starting withChangeOrder:P_ECO_REVISION_TBL: in mapping function TC_Object2EBS_ChangeOrder.



6.6 Maintain ECO in Orgs

As all entities that are change controlled in the EBS are org specific, ECOs are as well.

When creating an ECO for the first time, it will be created in a master organization. Maintaining the ECOin any further inventory organization can be implemented using the following approach:

• Full creation of one or more child ECOs applying the attribute values from the mapping within oneECO transaction. This is handled as a "multi transfer" (see Transferring Several Sets of Similar Data inone Transaction ("multi transfer")).

Caution:

In contrast to Inventory Items, it is not possible to directly assign an ECO to multiple organizations(also not supported in Oracle Forms UI!).

6.6.1 Get ECO Organizations

T4O Configuration

T4O provides the function ::TPEBS::ECO::getChangeOrderOrganizations to get allorganizations to which an ECO is assigned in the EBS. The retrieved organizations will be returned inglobal TCL array ::EcoResultDat.


In order to get an example and to test that functionality, use test script ECO get organizations.

6.7 Maintain Item via ECO

To define the mapping for revised item maintenance in respect of a specific ECO, please see chapterMaintain Item via ECO.

6.8 Maintain BOM via ECO

To define the mapping for revised components maintenance in respect of a specific ECO, please seechapter Maintain BOM via ECO.

6.9 Implement ECO


Maintain ECO in Orgs



ECO implementation is handled as an "additional transfer" in the context of an ECO transfer (seeMapping of additional ECO Data ("additional transfer")). This means that ECO implementation isexecuted after the actual ECO transfer but within the same Teamcenter workflow or interactivefunction.

T4O Configuration

Implementing an ECO is done in mapping function TC_Object2EBS_ChangeOrder_ImplementECO(called by generic ECO mapping function TC_Object2EBS_ChangeOrder); for an example refer to thecode in that function:

Implement ECO - t4o_eco_mapping_template.sd

For testing that functionality, use test script ECO implement.

Please refer to the examples in those files in order to get information about how to configure ECOimplementation for ECO transfers. As it works the same way for ECO as for Item, you may also have alook at chapter Implement ECO for Item.


This chapter only provides some specific information about how to configure the ECO transfer in orderto include the assignment of EBS attachments. As the attachments transfer for ECO works the same wayas for Item, please refer to chapter Maintain Attachments to get some detailed information on how toconfigure the additional attachments transfer in general.


In order to configure T4O to export a TC file (named reference) attached to the Item Revision, you needto add respective additional objects to the preference T4O_ChangeOrderMapping4.

In order to make the attributes of extended form (e.g. the T4O Dataset Extension Form attached to thedataset or the Item Revision) available in the ECO mapping, enhance/add the following preferences:



• T4O_ChangeOrderFieldMapping2

T4O Configuration

Maintaining attachments for an ECO is handled as an "additional transfer" (see Mapping of additionalECO Data ("additional transfer")) and can be activated in the mapping.



To define the attachments data mapping for an ECO transfer, adapt the example code in functionTC_Object2EBS_ChangeOrder_DocumentAttachment (called by generic ECO mapping functionTC_Object2EBS_ChangeOrder).

Maintain Attachments - t4o_eco_mapping_template.sd


In order to maintain (create, update, delete) attachments for an ECO in the EBS, configure the followingin the mapping:


set ::EBSDat(ChangeOrder:CtrlParam:DocumentAttachmentTransfer) "TRUE"

• Set the attachments target type in ::EBSDat fieldAttachment:PARAMETER:P_EBS_TARGET_TYPE to ECO.

• Specify the ECO for which the attachments should be maintained. Set the organization codein ::EBSDat field Attachment:PARAMETER:P_PK1_NAME and the ECO name in fieldAttachment:PARAMETER:P_PK2_NAME.


See chapter Create Attachment.


See chapter Create File Attachment.


See chapter Create URL Attachment.


See chapter Create Short Text Attachment.


See chapter Create Long Text Attachment.

Create Attachment



See chapter Update Attachment.


See chapter Delete Attachment.


See chapter Delete All Attachments.


See chapter Link Document to Several Items.


See chapter Get Attachments.


See chapter Export Attached File.



7. Data Transfer

7.1 Configure the T4O Menu Functions

Please see chapter Menu based in the Active Integration - Generic Configuration Guide on how theT4x Gateway Menu works in general.


Modify the preference T4O_Gateway_Menu_Explorer_Entries in order to set the availablefunctions in the additional T4O menu "T4O Gateway" in "My Teamcenter". This does not affect theworkflow functionality but only specifies the functions the user may select from the menu.

Without having to do any additional adaptations, the same menu "T4O Gateway" will be shown in the"Structure Manager", the "Multi Structure Management" and the "Manufacturing Process Planer".

Each value for this preference consists of two parts:

• The object type it is used for

• The function for this object type

The possible "object types" are:

ITEM Inventory Item

BOM Bill of Material

ECO Engineering Change Order

The possible "functions" are (in brackets: the object type(s) this function works for):

CREATE_HID (all) creates an object of the desired type in Oracle EBS

CHANGE_HID (all) modifies the Oracle EBS object

DISPLAY (all) displays the EBS form for an object

Each function uses the mapping and sets the appropriate data to the Oracle EBS object and to theTeamcenter object. If a transaction type is specified for an object type that does not allow that, this willbe shown in the menu nevertheless without showing an error to the Teamcenter user. If this invalidtransaction is performed, an error message is shown.



If at least one entry for a specific type (e.g. Item) is given, the corresponding sub menu will appear; e.g.the entry ITEM_DISPLAY is sufficient to show the sub menu "Item" in the "T4O Gateway" menu. If thatpreference does not contain any entry ITEM_*, then the sub menu "Item" is not shown at all.

If that preference does not exist or is set empty then the menu point "EBS Connections..." is shown only.

Example:

T4O_Gateway_Menu_Explorer_Entries=EBSCONNECTITEM_CREATE_HIDITEM_CHANGE_HIDITEM_DISPLAYBOM_CREATE_HIDBOM_CHANGE_HIDBOM_DISPLAYECO_CREATE_HIDECO_CHANGE_HIDECO_DISPLAY

In the "T4O Gateway" menu, you will then find the corresponding entries, e.g. for ITEM: "Create Direct","Change Direct" and "Display". If you click one of the menu points "Create Direct" or "Change Direct" afterselecting one or multiple valid objects, T4O will open the "T4O Transfer Window" that shows theconfigured data for this object and transaction type and you can start the transaction by clicking"Perform".

Auto Perform


If you do not want to wait and click, you can configure T4O to start some transactions immediatelyusing the preference T4O_Gateway_AutoPerform. Whenever a transaction type stated as a value ofthis preference is selected from the "T4O Gateway", the "T4O Transfer Window" is opened and thetransaction will start immediately without waiting for the click on "Perform".

Example as shipped in the template file, i.e. all those Display transactions will be started automatically,any other will wait for the click on "Perform":

T4O_Gateway_AutoPerform=ECO_CREATE_HIDECO_CHANGE_HID

Definition of Teamcenter Objects You Want to Support in the T4O GUI


7. Data Transfer


This is controlled by the optional preference T4O_<TargetTypeName>DisplayableTypeList. Itcontains a subset of the values of T4O_<TargetTypeName>TypeList and means that T4O only hasto use those types in the GUI.

Example for enabling only one type for Item in the T4O GUI:

T4O_ItemDisplayableTypeList=EBS2T4O_Item Revision

Caution:

Leaving the key T4O_<TargetTypeName>DisplayableTypeList empty is the same as notstating it at all, i.e. then every data type that is configured withT4O_<TargetTypeName>TypeList is used in the T4O GUI.

Hiding the Gateway Menu


The T4O Gateway Menu can be switched off completely by setting the following preference (typelogical; by default it does not exist):

T4O.UI.GatewayMenu.Hide=true

A similar preference exists for each T4x product (e.g. T4S.UI.GatewayMenu.Hide). If there is morethan one T4x product installed in the same Teamcenter installation, it may be useful to switch all theT4x Gateway menus off and on with one preference only:

T4X.UI.GatewayMenu.Hide=true

If this is set, it will deactivate all the T4x Gateway menus, but if the preferenceT4O.UI.GatewayMenu.Hide=false is set additionally, the T4O Gateway Menu will be shown butnone of the other T4x Gateway menus.

7.2 Configure the Transfer Window

Please see chapter Configuration of Teamcenter GUI Extensions in the Active Integration - GenericConfiguration Guide for information about the general configuration of the T4x Transfer Window.

The following sections only highlight the T4O specifics compared to the generic configuration.


Example for defining the preferences:

Configure the Transfer Window




T4O.AttributesStylesheets=T4OStylesheetAttributesItemT4OStylesheetAttributesBillOfMaterial

T4O.AttributesStylesheets.T4OStylesheetAttributesItem.Types=EBS2T4O_Item Revision

T4O.AttributesStylesheets.T4OStylesheetAttributesItem.EaConnections=EBS1EBS2

T4O.AttributesStylesheets.T4OStylesheetAttributesItem.EaObjectTypes=Item

T4O.AttributesStylesheets.T4OStylesheetAttributesBillOfMaterial.EaObjectTypes=BillOfMaterial

The valid values for the EaObjectTypes preference are for T4O:

• Item

• BillOfMaterial

• ChangeOrder

According to those preferences you need to define the style sheets in Teamcenter.

The "t4oebsdemo" tem feature includes several example templates for defining the preferences as wellas defining the style sheets. Applying the templates for EBS object type Item will result in showing thefollowing attributes in the Transfer Window:

7. Data Transfer


7.3 Configure the Data Import

Please see chapter T4x Import Concepts in the Active Integration - Generic Configuration Guide forinformation about the general T4x import concepts.


In contrast to T4O transactions triggered from Teamcenter, all transfers from EBS to Teamcenter areexecuted asynchronously. This means that no immediate feedback can be delivered to EBS trigger eventand further that it takes some time until the data transfer is completed. The following describes themain T4O import use case:

1. An EBS database trigger is initiated while saving an Oracle EBS object.

2. The DB trigger creates an entry in custom EBS staging table (ZPTC table).

3. T4O scheduled trigger reads entry in staging table and creates a job.

4. The job is executed (as defined in mapping file).

a. Read EBS data.

b. Find related TC object.

Configure the Data Import



c. Create/update TC object.

d. Update TC attributes.

e. Additional actions are performed like set status, trigger a TC workflow, send email...

f. Update entry in staging table (status S or E).

5. The job status indicates success or failure of import.

Specific Configuration in EBS

The following steps need to be prepared in the EBS:

• Import the ZPTC table and ZPTC functions into EBS. This is automatically done with the execution ofinstall script T4O_XXTO_Install.sql; see chapter T4O Application – Installation Instructions in theTeamcenter Gateway for Oracle EBS - EBS Preparation Guide.

• Define a database trigger for those EBS object types which should be imported into Teamcenter, e.g.EBS Item; please see chapter T4O Database Trigger Templates in the Teamcenter Gateway forOracle EBS - EBS Preparation Guide.

T4O Configuration

T4O offers several pre-defined import jobs and import mapping templates. Be sure to use the correctmapping file to configure the data import for the given object type. Available types are:

EBS object typeZPTC entry:

OBJECT_TYP Job type Mapping template

Item ITEM T4O_IMPORT_ITEM t4o_item_import_template.sd

Bill of Material BOM T4O_IMPORT_BOM t4o_bom_import_template.sd

EngineeringChange Order

ECO T4O_IMPORT_ECO t4o_eco_import_template.sd

Additionally, T4O provides a job type and import mapping template to support other object types aswell. Additional configuration effort will be required to read EBS data within the mapping file:

ZPTC entry:OBJECT_TYP Job type Mapping template Usage

META T4O_IMPORT_META t4o_meta_import_template.sd This job type isused for any TCimport job that isnot necessarilyconnected to an

7. Data Transfer





ZPTC entry:OBJECT_TYP Job type Mapping template Usage

EBS business objectat all.

The following steps need to be performed for T4O configuration:

• Prepare the import mapping file t4o_<object_type>_import_template.sd and source it int4o_mapping_config.sd.For an item import job the following mapping procedures are processed (in that order):

getItemInfo Reads the related EBS Item information. Input parameter EBSItemNumber isretrieved from job attribute ImportObjectId.

selectTC_Object

Identifies the corresponding Teamcenter Item Revision. You can either use aTeamcenter query or if the material number matches the Item ID you can use ITKcalls to get the latest Item Revision.

createTC_Object

Creates a new TC object (Item and ItemRevision). If you do not want to create a newTC object but continue to the next import step, make sure that the procedureselectTC_Object always finds the correct object.

EBS_Item2TC_Object

Updates Teamcenter attributes using the storeReverseMappingAttributefunction.

updateTC_Object

Performs any other update function on the Teamcenter Item or ItemRevision, i.e.create an alternate ID object, trigger a workflow, set a status, create a form, create arelation…

cleanUp Performs any specific action at the end of job execution, e.g. send an email

Refer to chapter Object Import in the Active Integration - Generic Configuration Guide for moredetails. Also have a look into the T4O API Reference for details about those mapping procedures.

Caution:

If the mapping function returns the value SKIPPED, do not add a message as second listelement because T4O will then set the job status to ApplicationError. Return the StatusSKIPPED without a message and the job will finish with status FINISHED.

If you are using the multi-field key functionality, you need to adapt mapping functionsselectTC_Object and createTC_Object properly; please refer to chapter Teamcenter Multi-field Key Functionality in the Active Integration - Generic Configuration Guide for details.

• Configure the T4O Job Agent; see chapter Job Processing Concept in the Active Integration -Generic Configuration Guide

• Adapt and run the trigger script Trigger Z-Table import job (Task Management) andconfigure it to run every x minutes. That script will poll for new Z-Table entries and for each foundentry it will create a job.

Configure the Data Import







The example in that script checks the Z-Table for new entries only. It is an Oracle PL/SQL based querymechanism to read the table. As shown in that example, only table lines with a NULL entry in fieldsSTATUS and DELETED are used (basically, those are new entries, since all other lines which werealready processed would have an entry in those fields).For information about how to run that script, see chapter Scheduled triggers in the ActiveIntegration - Generic Configuration Guide.

7.4 Configure the EBS Dataview

Please see chapter Dataview in the Active Integration - Generic Configuration Guide for informationabout the general T4x dataview concepts.


The following EBS object types are supported for the T4O "EBS Dataview":

• Item

• Item

• Item Revisions

• Item Organization Assignments

• Item Catalog Assignment

• Item Catalog Descriptive Elements

• Item Category Assignments

• Item Cross References

• Item Costs

• Item Subinventory

• Item On Hand Quantity

• Item Document Attachments

• BOM

• BOM Header

• BOM Revisions

7. Data Transfer





• BOM Components

• BOM Substitute Components

• BOM Reference Designators

• BOM Component Operations

• BOM Organization Assignments

• BOM Document Attachments

• ECO

• ECO Header

• ECO Revisions

• ECO Revised Items

• ECO Revised Components

• ECO Reference Designators

• ECO Substitute Components

• ECO Revised Operations

• ECO Revised Operation Resources

• ECO Revised Operation Substitute Resources

• ECO Organization Assignments

• ECO Document Attachments

In order to open the Dataview select Window → Show View → Other… → Teamcenter Gateway → EBSData from the main menu.

To view the EBS specific information within Teamcenter, select an appropriate object (e.g. an ItemRevision) and the EBS object type you want to check. Then T4O will process the data for the selectedobject and the selected EBS object type according to the defined mapping, e.g. for a selected BOM viewRevision:

Configure the EBS Dataview


The EBS Dataview control area (the grey part) shows the following information:

• The current EBS connection, e.g. "EBS4".If more than one EBS connection is defined in your T4O installation, you can select another from thedropdown list:

When selecting a Teamcenter object that has been selected before in the same Teamcenter session,the EBS Dataview will show the data from the same EBS connection as the previous check, no matterif another EBS connection has been used in between.

• The current EBS object type, e.g. "tem". When clicking on the dropdown list, it will show all the EBSobject types configured for the selected Teamcenter object, e.g.:

When selecting the EBS Dataview, T4O will check for which EBS object types (ITEM, BOM…) theselected Teamcenter object is configured, i.e. it checks the T4O_*TypeList* preferences for the

7. Data Transfer


selected Teamcenter object type. The first one it finds is used as the type to show in the EBSDataview.However, T4O will remember the EBS object type a Teamcenter object has been used with the EBSDataview. So when selecting a Teamcenter object that has been used with the EBS Dataview before inthe same Teamcenter session, T4O will use the type that has been opened before.

• "Last Refreshed" is the date and time when the shown data have been processed

• The icon next to the time stamp shows the current processing status or/and result:

•

processing right now

•

the processing finished OK

•

the processing finished with an error and T4O could not get the requested data from EBS. In mostcases this is not really an error, but is just because the requested EBS object does not exist

• Click the refresh button to determine the data again from EBS immediately

The window content shows the desired EBS data as defined in the T4O mapping.

The EBS Dataview is also accessible within the T4O Transfer Window. The following example screenshotshows the EBS Dataview in the T4O Transfer Window after an Item Revision was selected and the T4Omenu point "Item" -> "Change Direct" was activated:



As the T4O Transfer Window is opened for a specific EBS object type, it does not allow switching it.


If you do not want to show the tab "EBS Data" in the T4O Transfer Window, disable it by removing thevalue CustomData from the list of tabs in preference T4O.UI.Transaction.Tabs. This preferencedefines which tabs are shown in the T4O Transfer Window. Its default values are:

T4O.UI.Transaction.Tabs= Attributes CustomData Status

Attributes Shows the Teamcenter data based on a given style sheet

CustomData Shows the EBS Dataview

Status Shows the detailed status messages

7. Data Transfer


T4O Configuration

EBS Dataview

Mapping template t4o_prop_mapping_template.sd

Mapping namespace ::T4O::PROP::CUSTOM::MAPPINGMapping function for handlingEBS Item data

GetEBSData_Item

Mapping function for handlingEBS BOM data

GetEBSData_BillOfMaterial

Mapping function for handlingEBS ECO data

GetEBSData_ChangeOrder

As the data to be shown needs to be read from Oracle EBS, T4O uses the same mechanism to get it as inany of the T4O reverse mapping functions, so call the same function EBSFieldMapping with the sameparameters here. Before the call of function EBSFieldMapping, make sure you will receive the data forrespective object type from EBS by calling function get<object_type>Info, e.g. getItemInfo (innamespace ::TPEBS::ITEM::). If you need to retrieve some additional data for an object type, callspecific get<additional_data>Info function, e.g. getItemCostsInfo (innamespace ::TPEBS::ITEM::) for getting Item Costs data.

In order to find the correct call to get the desired EBS data, see the T4O API Reference.

For identifying the EBS data fields T4O can read, refer to chapter EBS Fields T4O Can Read from.

Caution:

In order to identify the EBS objects correctly according to your Teamcenter settings, be sure toadapt the corresponding lines in the mapping file t4o_prop_mapping_template.sd (e.g. setItemNumber …) in the same way as in the corresponding lines in the mapping files for thoseobject types.

Please refer to the examples in the t4o_prop_mapping_template.sd for getting an overview of the EBSDataview configuration.

Example 1: Creating a section called "Main" for displaying EBS item data; code snippet beginning withthe comment # Create an expandable section for Main data

That example creates a section called "Main" containing the properties "Inventory Item Number","Inventory Item Id", "Inventory Organization", "Primary Unit of Measure" and "Engineering Item". Theentry "Engineering Item" is defined to be shown as a checkbox:




Example 2: Adding a dropdown list containing all organizations to which an item is assigned; codesnippet beginning with the comment # now we get all organizations for this item inorder to add a dropdown for all of them...

Example 3: Displaying the organization data for an EBS item in different tabs

# Create a new section for EBS Organization Data:begin -doc doc section -title "EBS Organization Data" \ –expanded true# In this example the organization codes AU and S1 are set fix:foreach Org {AU S1} { # Note that T4O needs to query the Item data from EBS for every # organization separately: set Status [::TPEBS::ITEM::getItemInfo $ItemNumber $Org] # Start a tab (=page):

7. Data Transfer


begin -doc doc page –title "EBS Organization $Org" set EngItemFlag [::T4O::TC::MAPPING::EBSFieldMapping Item \ X_ITEM_REC:ENG_ITEM_FLAG] create -doc doc property \ -name "Engineering Item" -value $EngItemFlag # Finish the tab: end -doc doc page}# Finish the section EBS Organization Data:end -doc doc section

Example 4: Showing the BOM positions in a table; code snippet beginning with the comment #Create a section for the EBS BOM positions

For more information about all T4x supported EA Dataview features, see Dataview in the ActiveIntegration - Generic Configuration Guide.

7.5 Configure the EBS Forms Display

T4O supports the direct display of an Oracle EBS form for a selected Teamcenter item revision.

Prerequisites

• Make sure that you have installed Oracle EBS certified browser and JRE versions on all clients whereyou use EBS Forms Display.

Configure the EBS Forms Display




• Make sure that the Oracle Forms UI is running in general (without T4O) on your client, before tryingto display a form via T4O.


By default, T4O directly executes a display action without opening a Transfer Window. If you need tomodify this standard behavior, to open a Transfer Window before actually executing the display action(e.g. for changing the connection in the course of a display action), you need to set preferenceT4O.Actions.Display.SilentPerform like the following:

T4O.Actions.Display.SilentPerform=false

In most cases, Windows knows a default web browser; then this one will be used, but UNIX/Linux do notknow a default web browser in most cases. So if the operating system does not use a default webbrowser automatically or it does not work as expected, set the following preference to tell T4O exactlywhich one to use (example: Firefox in the stated path /usr/bin in UNIX):

T4O.UI.HttpDisplay.ExternalBrowser.Executable=/usr/bin/firefox

In order to find a suitable Firefox in UNIX/Linux, enter the following in a command shell:

type firefox

T4O Configuration

The data mapping for this functionality is included in the mapping file for respective EBS object type(e.g. t4o_item_mapping_template.sd for EBS Item).

You can adapt the behavior of EBS Forms Display in the following mapping functions:

• getDisplay_FunctionName:In this function, you can adapt the name of respective form function to be displayed in EBS. Findexamples in the mapping templates for respective EBS object types:

• ::T4O::ITEM::CUSTOM::MAPPING::getDisplay_FunctionName

• ::T4O::BOM::CUSTOM::MAPPING::getDisplay_FunctionName

• ::T4O::ECO::CUSTOM::MAPPING::getDisplay_FunctionName

Description for the Item example:The first part of that example retrieves information about the current item type from EBS (i.e. ifcurrent item is of type "Engineering Item" or "Manufacturing Item"). Depending on the retrieved itemtype, the form function name is set to either ENG_INVIDITM for engineering items orINV_INVIDITM for manufacturing items. Those standard form functions are not accessible to T4Oresponsibilities (T4O_READ_ONLY_USER and T4O_USER) used with JDBC. In this case, T4O uses by

7. Data Transfer


default its own form functions with prefix T4O_. Thus the string T4O_ is added in front of the formfunction name, if T4O responsibilities T4O_READ_ONLY_USER and T4O_USER are used.

Caution:

Make sure that the responsibility you are using to display EBS forms via T4O has access to theform function specified here.

• getDisplay_Parameters:This function sets the parameter list for respective form function to be displayed. Find examples in themapping templates for respective EBS object types:

• ::T4O::ITEM::CUSTOM::MAPPING::getDisplay_Parameters

• ::T4O::BOM::CUSTOM::MAPPING::getDisplay_Parameters

• ::T4O::ECO::CUSTOM::MAPPING::getDisplay_Parameters

Description for the Item example:That example sets the item number (item ID respectively) and organization code (organization IDrespectively) for the EBS Item to be displayed. That information is then appended to the parameter listfor respective form function. As for item display also the "charts of accounts id" is required, this one isretrieved from EBS and added to the parameter list. For all responsibilities other than the T4Oresponsibilities T4O_USER and T4O_READ_ONLY_USER, also the query_only parameter withvalue YES is appended to the parameter list. Note that in this example the master item form would bedisplayed, as parameter org_mode is set to Y. If you need to display the organization item forminstead of the master item form, set the org_mode to N instead.General description:T4O generally displays EBS forms in read-only mode, which is achieved by setting form functionparameter query_only to YES. For this reason, if used form function doesn’t have the query_onlyparameter attached, it needs to be done here:

• For T4O responsibilities T4O_USER and T4O_READ_ONLY_USER, the T4O form functions (e.g.T4O_INV_INVIDITM) are used by default, which already have the query_only=YES parameterattached.

• For any other responsibilities than the T4O ones, the standard form functions (e.g.INV_INVIDITM) are used by default, which do not have the query_only paramter attached; sothis is done by the following mapping line:

append rc " query_only=YES"

Configure the EBS Forms Display


Caution:

• If you’re using any other responsibilities than the T4O ones, you need to keep the following inmind: For "Engineering Change Orders" form (ENGFDECN) the query_only parameter is notapplicable (see Oracle bugs 1537576 and 20180721 for details). In order to display this formin read-only mode, used responsibility must not have function "Engineering Change Orders:Update" (ENG_ENGFDECN_UPDATE) included. Therefore, removing function "EngineeringChange Orders: Update" from your responsibility will display the form in read-only mode.

• Due to Oracle bug 13682654 (find bug details on Oracle Support sites), BOM forms in read-only mode will open the "Find Bills" dialog instead of the BOM form itself. However, forsecurity reasons, the query_only parameter is attached to T4O BOM form functionsT4O_ENG_BOMFDBOM and T4O_BOM_BOMFDBOM, by default:

If you want to change this behavior in order to directly show up the BOM form (but NOT inread-only mode), you need to remove the query_only parameter from those two T4O BOMform functions.

• The "Find Bills" dialog for BOM display opens up with empty settings:

Just clicking "Find" or hitting enter will open the already selected BOM.

7.6 Configure the External Queries

Please see chapter External Queries in the Active Integration - Generic Configuration Guide forinformation about how to configure the external queries in general.

7. Data Transfer





Example for telling Teamcenter to use the additional library libt4x_query:

TC_customization_libraries=libt4olibt4x_query

Example for defining the query names:

T4X_SupportedUserQueries=T4O_ITEM_QUERYT4O_ECO_QUERY

Example for defining which T4x product has to execute the queries (in our case T4O):

T4X_QUERY_TargetSystem4T4O_ITEM_QUERY=T4O

T4X_QUERY_TargetSystem4T4O_ECO_QUERY=T4O

T4O Configuration

Export

Mapping template t4o_query_mapping_template.sd

Mapping namespace ::T4O::QUERY::CUSTOM::MAPPINGBasic mapping function executeQueryDefault Item mapping function executeQuery4ItemDefault ECO mapping function executeQuery4ChangeOrder

T4O provides the following search functions, which can be called in respective mapping functions (e.g.executeQuery4Item):

• Query for Items

• Query for Item Templates

• Query for BOMs

• Query for ECOs

Configure the External Queries


7.6.1 Query for Items

T4O Configuration

T4O provides the function ::TPEBS::ITEM::getItemList3 for getting a list of EBS Items matchingthe given search criteria (match code search). The retrieved data will be returned in global TCLarray ::ItemResultDat.


In order to get an example and to test that functionality, use test script ITEM get list (extended).

Caution:

If in your EBS system multiple segments are configured for the System Items Flexfield, please beaware that the first parameter ItemNumber expects a value comprising all segments separated bythe delimiter, e.g. "KHR*-*" for a flexfield that consists of two segments separated by delimiter "-".In that example, "KHR*" would not be a valid search criteria.

7.6.2 Query for Item Templates

T4O Configuration

T4O provides the function ::TPEBS::ITEM::getTemplateList2 for getting a list of EBS ItemTemplates matching the given search criteria (match code search). The retrieved data will be returned inglobal TCL array ::EbsResultDat.


In order to get an example and to test that functionality, use test script ITEM get template list.

7.6.3 Query for BOMs

T4O Configuration

T4O provides the function ::TPEBS::BOM::getBomList3 for getting a list of EBS BOMs matching thegiven search criteria (match code search). The retrieved data will be returned in global TCLarray ::BomResultDat.


In order to get an example and to test that functionality, use test script BOM get list (extended).

7. Data Transfer





7.6.4 Query for ECOs

T4O Configuration

T4O provides the function ::TPEBS::ECO::getChangeOrderList3 for getting a list of ECOsmatching the given search criteria (match code search). The retrieved data will be returned in global TCLarray ::EcoResultDat.


In order to get an example and to test that functionality, use test script ECO get list (extended).

Query for ECOs



7. Data Transfer


8. Troubleshooting T4O and EBS ErrorsThis chapter contains some hints on specific problems with the T4O handling after it is basically running.

Some but not all of the following error conditions may be handled in the T4O mapping and checked withthe mapping test scripts.

• If you find the following T4O error message, this means that the payload for an ISG call containsunexpected characters (‘{‘ in this example):"T4O(EBS): ERROR org.apache.axiom.om.OMException:com.ctc.wstx.exc.WstxUnexpectedCharException: Unexpected character '{' (code 123) in prolog;"To solve the problem, enable the following switch in t4o_mapping_config_<ebs system id>.sd:

set ::T4O_Defaults(ISG:USE_TPCO_ENCODING:$strSystemId) "TRUE"

Additionally, you have to set the correct Teamcenter encoding (same value as in the TCserver syslogfile -> search for TC_CHARACTER_ENCODING_SET), e.g.:

set ::T4X::TC::MAPPING::CtrlInfo(useTcCodePage) "cp1252"

For details see chapter The File t4o_mapping_config.sd

• A message like"Function call failed for >TP_PROCESS_ITEM< due to missing grants or active EBS maintainancemode!"occurs in one of the following cases:

• Active EBS maintenance mode→ Deactivate the EBS maintenance mode, e.g. using the adadmin utility

• T4O tries to access a function (e.g. TP_PROCESS_ITEM) via JDBC, but the used responsibility(which the user selected for login) doesn't have access to that function.→ Add the missing function (e.g. TP_PROCESS_ITEM) to respective responsibility menu.Alternatively, reload the T4O menu templates using FNDLOAD utility; see the Teamcenter Gatewayfor Oracle EBS - EBS Preparation Guide for details.

• A message like"PLS-00904: insufficient privilege to access object APPS.XXTO_T4O_ITEM_1910_TP_PROC81"occurs if T4O tries to access an object (e.g. APPS.XXTO_T4O_ITEM_1910_TP_PROC81) via theXXTO schema, but the XXTO schema doesn't have enough grants.→ Add the missing grant to the XXTO schema. Alternatively, rerun the T4O EBS-side base installationscript (including scripts for setting up required grants and synonyms); see the Teamcenter Gatewayfor Oracle EBS - EBS Preparation Guide for details.

• If the error message"PIPE COMMAND STOPS BY PIPE SERVER EXIT, COMMAD-TIMEOUT OR CRASH"






occurs, please have a look into one of the following system log files in order to get more informationabout the cause of the error:

• ISG: de.tesis.plmware.soaclient.SoaC.log

• JDBC: de.tesis.plmware.objects.Object.log

Usually, a Java stacktrace is shown in those log files, which provides further information about theerror cause.Otherwise, if no stacktrace is shown and the last entry of such a log file begins with"tpnci_startECMDClient", this points to the fact that the Java process couldn’t start at all. Possiblereasons may be:

• Missing Java Runtime Environment

• Missing jars in the Java class path

• After an Item Revision Update, the EBS message"INV_ITEM_GRP.Insert_Revision_Record: Unexpexted error: ORA-01403: no data found"probably means that you forgot to specify the organization ID in the mapping.

• If using ISG, a message like"java.io.FileNotFoundException: <Oracle>/inst/apps/<context>/soa/PLSQL/<web_service_number>/SUBMIT_REQUEST.wsdl (No such file or directory)"means that a specific web service wasn’t deployed in the Integration Repository (in this example theweb service FND_REQUEST.SUBMIT_REQUEST).

• The message"Oracle error -20001: ORA-20001: SQL_PLSQL_ERROR: N, ROUTINE, MO_GLOBAL.SET_ORG_ACCESS,N, ERRNO, -20001, N, REASON, ORA-20001: APP-FND-02938: Multi-organization routine failed toinitialize a session for the product: &PRODUCT. Please inform your support representative. has beendetected in MO_GLOBAL.INIT"means that the application for used responsibility (the responsibility used for EBS Login) is notregistered for MOAC (Multi-Org Access Control). To solve the problem, perform the following steps:

• Confirm that the application is not defined in table FND_MO_PRODUCT_INIT, by executing thefollowing query in sqlplus (as APPS user):

SELECT *FROM FND_MO_PRODUCT_INITWHERE application_short_name='<application_short_name>';

• If above query doesn’t return any rows, register the application in sqlplus (as APPS user):

exec FND_MO_PRODUCT_INIT_PKG.register_application('<application_short_name

8. Troubleshooting T4O and EBS Errors


>','SEED','N');commit;

• The function ::TPEBS::ITEM::getItemInfo returns with NOT_FOUND even though therequested item exists in the EBS: This may be due to the System Items Flexfield definition has beenchanged (e.g. after a patch installation), but wasn’t compiled again.Thus try the following to fix the problem:

• Unfreeze and freeze the System Items Flexfield (-> uncheck and check again the "Freeze FlexfieldDefinition" flag)

• Compile the System Items Flexfield definition (-> Save)

For example, this problem may occur after the installation of patch 13881020, see the TeamcenterGateway for Oracle EBS - EBS Preparation Guide for details.

• The function TP_Process_Item returns with error BOM_PARSE_ITEM_ERROR: This error may occur ifyou connected to the EBS system with a wrong language.

• An Item is created without a revision. This points to the Oracle bug "18161814 - PROCESS_ITEMCREATES ITEM WITHOUT ITEM REVISION". Therefore, the patch "18161814" is probably missing in yourEBS system. Please refer to the Teamcenter Gateway for Oracle EBS - EBS Preparation Guide.

• The following error message may occur if a wrong version of JDBC driver is used (see the TeamcenterGateway for Oracle EBS - EBS Preparation Guide for details):"PLS-00307: too many declarations of 'GET_TYPE_SHAPE' match this call"

• If there isn’t returned any error when trying to create a BOM component with operation sequencenumber 10 even though there doesn’t exist a routing for the header item, this points to the Oralcebug "17750170 : PROCESS_BOM ALLOWS TO CREATE OPERATIONS WITH OPSEQNO 10 EVEN THOUGHTHERE IS".→ Please check if the patch "17750170" is installed in your EBS system; refer to the TeamcenterGateway for Oracle EBS - EBS Preparation Guide.

• The EBS message"<EBS model> cannot be locked because it is currently locked by <ebs user>"occurs during a CDL rules import in the following case: The model to which the rules should beimported is locked by another user than the one who is importing the rules. If the model is locked bythe same user who is trying to import the rules, this should not be a problem.

• If T4O returns an error message like"The following user ID does not have a person ID assigned to it: 9726"while transferring an object, that can have the following reasons:

• Your FND user doesn’t have a person assigned.

• The responsibility you are using is not valid for your FND user.









For details, see the Teamcenter Gateway for Oracle EBS - EBS Preparation Guide and the followingOracle Support notes:

• "Eco Erroring With User ID Does Not Have A Person ID Assigned (Doc ID 1412206.1)"

• "INCOIN: Item Open Import fails with INV_IOI_ERR on LOGIN_USER_ID (Doc ID 565915.1)"

• The T4O error message "Invalid Date specified ..." indicates missing patches "14659883" and"18855074". Please see the Teamcenter Gateway for Oracle EBS - EBS Preparation Guide.

• If you get one of the following error messages when connecting to EBS via ISG, please follow theinstructions in Oracle Support note "SAML Authentication on EBS R12 Gateway is Failing withORABPEL-11622 (Doc ID 1506467.1)":"ORABPEL-11622""Missing class: oracle.tip.adapter.fw.log.ISGLogObjectPerRequest"

• If you observe missing error messages when transferring ECOs via T4O, this may be a consequence ofapplied patch 13777030. In this case you may need to install patch 16305221 in order to solve theproblem, see Oracle Support note "Not All Errors From Eng_Eco_Pub.Process_Eco Returned After Patch13777030:R12.ENG.C (Doc ID 1543239.1)" for details (also refer to the Teamcenter Gateway forOracle EBS - EBS Preparation Guide).

• EBS 12.2 specific: If you get the error message "INV_IOI_NON_REL_CATG" when trying to delete thecatalog group (by passing NULL to parameter P_ITEM_CATALOG_GROUP_ID in call ofEGO_ITEM_PUB.PROCESS_ITEM), this probably occurs due to an incorrect setup of profile option"Enable PIM for Telco Features". In order to solve this, change the value of profile option "Enable PIMfor Telco Features" from Yes to No. Refer to Oracle Support note "Get Error INV_IOI_NON_REL_CATGWhen Try To Create Item (Doc ID 1595998.1)" for details.

8. Troubleshooting T4O and EBS Errors






A. Glossary

A

ABAPABAP is a proprietary programming language of the SAP AG.

Adminis the term used in this document for people who install and configure Teamcenter and its components.This is in contrast to the "user" role.

Admin UIWeb based administrative user interface of the GS and BGS.

AIGThe entire Active Integration Gateway product family.

AIG_ROOTPlease see GS_ROOT and BGS_ROOT. This term is used if something is true for both the GS and BGS.

AI-ObjectApplication-Interface Object

APIApplication Programming Interface.

AppsSee "GS".

AppServerApplication Server.

B

BAPIThe Business Application Programming Interface allows external programs to access objects andbusiness processes in SAP.

BGSBasic Gateway Service.

Configuration Guide A-1© 2019 Siemens

BGS_ROOTThe installation directory of the Basic Gateway Service (e.g. C:\Siemens\BGS).

BMIDETeamcenter Business Modeler IDE (Integrated Development Environment)

BOMA Bill Of Materials is a list of the parts or components and their quantities that are required to build aproduct.

BOM HeaderA BOM Header is the top item of a BOM. BOMs can have multiple levels, so this often means the topitem of the actual level.

BOPThe Bill Of Process describes a manufacturing process and lists the operations and steps with all theirinstructions, consumed materials, resources, work places and machines.

C

CCObjectCollaboration Context Object

CEPCamstar Enterprise Platform

Change MasterThe Engineering Change Master (ECM) contains the metadata to a change number.

CharacteristicAn characteristic is an attribute of a SAP class.

CIOCamstar Interoperability

D

Data CarrierPlease see Vault.

A. Glossary

A-2 Configuration Guide© 2019 Siemens

DataviewThe Dataview is an extension to the Teamcenter RAC and is deployed as part of the TEM installationprocess of the Teamcenter Gateway. The Dataview is used to display the real-time data of externalapplications, associated with Teamcenter objects.

Dataview mark-upis the language understood by the Dataview. The Dataview receives messages written in this languagefrom the T4x server. Such messages can be formatted as XML or JSON. Normally users do not see suchmessages. They may however appear in log files or error messages. The so called prop mapping (e.g.t4s_prop_mapping_template.sd) contains TCL commands that compose messages in the Dataviewmark-up.

DCDData Collection Definition

DIRDIR is the abbreviation for a SAP Document Info Record.

Document KeyA Document Info Record is identified by the combination of Document Type, Document Number,Document Part and Document Version.

Document StructureA Document Structure is like a Bill Of Materials for Documents.

E

EAstands for Enterprise Application, any software or set of computer programs used by business users toperform various business functions in context of current integration's portfolio with Teamcenter.

ECNThe Engineering Change Notice can also be called an Engineering Change Note, Engineering ChangeOrder (ECO), or just an Engineering Change (EC).

EPMEnterprise Process Modeling

EWIElectronic Work Instructions


F

File StreamMethod of transfer to send an original to SAP.

FN4SClosed Loop Manufacturing for SAP S/4HANA®

G

Gateway MenuAn additional menu item of the Teamcenter Gateway software available in the Teamcenter RAC.

GRMThe Generic Relationship Management provides a general way in which two objects can be associatedvia a relationship.

GSGateway Service, manages the communication between Enterprise Applications.

GS_ROOTThe installation directory of the Gateway Service (e.g. C:\Siemens\GS).

GUIGraphical user interface.

GUIDGlobally Unique Identifier

I

IDGENThe IDGEN is a mechanism to get an external ID from the ERP system when assigning a Teamcenter ID.

Inspection PlanContains characteristics to be inspected in an operation and equipment to be used.

iPPEIntegrated Product and Process Engineering is a module that can be used to mange products with manyvariants.

A. Glossary


ITKThe Integration Toolkit (ITK) is a set of software tools provided by Siemens PLM Software that you canuse to integrate third-party or user-developed applications with Teamcenter.

J

JCOThe Java Connector is an interface to . In the context of it is now mostly replaced by the Netweaver RFCinterface.

JDBCJava Database Connectivity is an application programming interface (API) for the programming languageJava, which defines how a client may access a database.

JobTeamcenter Gateway features asynchronous transfer. This datatransfer is managed via a Job.

Job PoolThe Job Pool contains all finished and unprocessed Jobs. It is managed by the BGS.

Job ServerThe Job Server on the Basic Gateway Service (BGS) manages the Job and distribution them to the JobAgent for processing.

JSONJavaScript Object Notation is a lightweight data-interchange format1.

K

KProKpro stands for Knowledge Provider. See also Data Carrier.

L

LOVList of Values

1 JSON.org


http://www.json.org/

M

MappingThe mapping is part of the T4x configuration. It contains the code that controls the behavior of the datatransfer between Teamcenter and the ERP system.

MFKMulti-key functionality in Teamcenter.

MMMM is the abbreviation for a SAP Material Master.

MOMManufacturing Operations Management

N

NCNNon-Conformance Notification

NetWeaver RFC SDKThe NetWeaver RFC SDK contains libraries for 3rd party applications to connect to . It can be obtainedfrom the SAP ONE Support Launchpad.

O

Object KeyThe Object Key is a string that contains the ID of an Enterprise Application object. If the identifier is acombination of multiple keys, then the Object Key is a combination of those keys in a defined order andformat.

Object LinkA relation between SAP objects like Material Master and Document Info Record.

Object Management RecordBelongs to a SAP Change Number and Documents changes of one particular SAP object like a MaterialMaster.

OOTBOut of the box

A. Glossary


OriginalA representation of a file in SAP.

OSS NoteThe OSS Note is an online patch service for SAP. The patch can be identified by the OSS Notes number.

P

PIRPIR is an abbreviation for a SAP Purchase Info Record.

Portal TransactionThis means that a transfer to SAP that is not triggered by a workflow handler but via the Gateway Menu.

R

RACstands for Rich Application Client also referred to as rich client or portal.

Revision LevelUsed to show changes with reference to a change to a SAP Material Master or Document Info Record.

RFCRemote Function Call (SAP)

S

SAPSAP S/4HANA® / SAP Business Suite®

SAP GUIThis is the application for the SAP Business Suite® and SAP S/4HANA®.

SAP LogonThis is the application that a user needs to start the SAP GUI for a particular system. It may also refer tothe process of logging in to SAP in Teamcenter via .

SAP Portal iView URLCan be used to show sap content in a browser window.

Session LogShows one log file for each Teamcenter session. Written if T4x transactions are executed


SSLSecure Sockets Layer.

T

T4O_ROOTPlease see GS_ROOT

T4S 4-Tier Client (SAP Lite)The 4-Tier Client or SAP Lite is a stripped down GS. It´s only purpose is to open the SAP GUI on aTeamcenter 4-Tier Client.

T4xThe entire Teamcenter Gateway product family.

TAOThe ACE ORB is a open-source and standards-compliant real-time C++ implementation of CORBA basedupon the Adaptive Communication Environment (ACE).

TargetTypeNameThis is the T4x internal name for the transaction type. E.g. MaterialMaster orDocumentInfoRecord.

TCTeamcenter

TCLis a high-level, general-purpose, interpreted, dynamic programming language.

TCPCMTeamcenter Product Cost Management

TCPCM4STeamcenter Product Cost Management Gateway for SAP S/4HANA

TEMTeamcenter Environment Manager

Transaction CodeA Transaction Code is a quick access code for a Transaction in the SAP GUI:

A. Glossary


Transaction LogThe Transaction Log is a T4x logfile on the BGS. It contains log information for a specific T4x transaction.

Transfer WindowThe Transfer Window triggers transactions via the Gateway Menu.

Transport PackageA file that contains functions that can be imported to SAP.

U

UOMUOM stands for Unit of Measure.

URIUnified Resource Identifier: a generalized from of a resource locator (URL) and resource name (URN),which just identifies a resource, but is not necessarily sufficient to locate (find) the resource. URIs areoften used to identify configurations in Java and other languages. See https://en.wikipedia.org/wiki/Uniform_Resource_Identifier for more details.

URLUnified Resource Locator: a string with a certain format, allowing to load a resource from a network.URLs are a specific form or URNs.

User Exit (SAP)A User Exit is a code for a program that is called if an object like an MaterialMaster has been changed orupdated. In the context of T4S it is often used to initiate the process to trigger a transfer from SAP toTeamcenter.

User LogThe User Log is a T4x logfile on the BGS. If you define a customized logchannel, the information iswritten into a User Log of that name.

V

Value SetA Value Set is the SAP term for a list of selectable values for a characteristic.


https://en.wikipedia.org/wiki/Uniform_Resource_Identifier

https://en.wikipedia.org/wiki/Uniform_Resource_Identifier

VaultThe Vault is a server where a SAP DocumentInfoRecord original is stored. A synonym is also Data Carrier.

W

WBSWBS is an abbreviation for a SAP Work Breakdown Structure.

X

XMLExtensible Markup Language is designed to store and transport data in a format that is both human- andmachine-readable.

XRTstands for XML Rendering Template, also known as XML Rendering Stylesheet. These are XMLdocuments stored in datasets that define how parts of the Teamcenter user interface are rendered. Theyare used for the Rich Client as well as the Active Workspace.

Z

ZPTCThis is the short name for a Z-Table with the name /TESISPLM/ZPTC, used to trigger a transfer from SAP.

Z-Table"Z" is a well-known prefix name for custom tables in the SAP world. A special table used with is thetable /TESISPLM/ZPTC.

A. Glossary


Siemens Industry Software

HeadquartersGranite Park One5800 Granite ParkwaySuite 600Plano, TX 75024USA+1 972 987 3000

AmericasGranite Park One5800 Granite ParkwaySuite 600Plano, TX 75024USA+1 314 264 8499

EuropeStephenson HouseSir William Siemens SquareFrimley, CamberleySurrey, GU16 8QD+44 (0) 1276 413200

Asia-PacificSuites 4301-4302, 43/FAIA Kowloon Tower, Landmark East100 How Ming StreetKwun Tong, KowloonHong Kong+852 2230 3308

About Siemens PLM SoftwareSiemens PLM Software is a leading globalprovider of product lifecycle management(PLM) software and services with 7 millionlicensed seats and 71,000 customersworldwide. Headquartered in Plano, Texas,Siemens PLM Software workscollaboratively with companies to deliveropen solutions that help them turn moreideas into successful products. For moreinformation on Siemens PLM Softwareproducts and services, visitwww.siemens.com/plm.

© 2019 Siemens. Siemens, the Siemenslogo and SIMATIC IT are registeredtrademarks of Siemens AG. Camstar, D-Cubed, Femap, Fibersim, Geolus, I-deas, JT,NX, Omneo, Parasolid, Solid Edge,Syncrofit, Teamcenter and Tecnomatix aretrademarks or registered trademarks ofSiemens Industry Software Inc. or itssubsidiaries in the United States and inother countries. All other trademarks,registered trademarks or service marksbelong to their respective holders.

Teamcenter Gateway for Oracle EBS Configuration Guide

Documents

Transcript of Teamcenter Gateway for Oracle EBS Configuration Guide