simatic it ua dm gateway for teamcenter configuration guide...be implemented by simatic it ua dm...

SIMATIC IT UA DMGateway forTeamcenterConfigurationGuide

Contents

Preface 5

Introduction 1-1

CLM4T and SIMATIC IT UA DM InteractionIntegration Story ────────────────────────────────────── 2-1

Basic ConfigurationMerge T4S Mapping ──────────────────────────────────── 3-1Add T4x Job Agent ───────────────────────────────────── 3-1Mapping Templates and Preferences ───────────────────────── 3-1Supported BOP Structures ──────────────────────────────── 3-2SIMATIC IT UA DM connection configuration ──────────────────── 3-3Addressing Multiple Simatic IT Servers ──────────────────────── 3-5Install Certificate ────────────────────────────────────── 3-6The File clm4t_mapping_config.sd ────────────────────────── 3-7Deployment Options ─────────────────────────────────── 3-8

150 Percent BOP ComponentsGeneral Remark ────────────────────────────────────── 4-1Demo Workflow Overview ──────────────────────────────── 4-1SIMATIC IT UA DM Material Definition ──────────────────────── 4-2

Create SIMATIC IT UA DM Material Definition ──────────────────────── 4-2Maintain SIMATIC IT UA DM Material Definition Fields ────────────────── 4-2Create and Associate Document to SIMATIC IT UA DM Material Definition ────── 4-2

SIMATIC IT UA DM Tool Definition ─────────────────────────── 4-3Create SIMATIC IT UA DM Tool Definition ────────────────────────── 4-3Maintain SIMATIC IT UA DMTool Definition Fields ───────────────────── 4-3Create and Associate Document to SIMATIC IT UA DM Tool Definition ───────── 4-3

SIMATIC IT UA DM Process ──────────────────────────────── 4-4Create SIMATIC IT UA DM Process ─────────────────────────────── 4-4Maintain SIMATIC IT UA DM Process ───────────────────────────── 4-4

SIMATIC IT UA DM Operation ────────────────────────────── 4-4Create SIMATIC IT UA DM Operation ───────────────────────────── 4-5Maintain SIMATIC IT UA DM Operation Fields ──────────────────────── 4-5Create and Associate Document to SIMATIC IT UA DM Operation ──────────── 4-6Associate Skill to Operation in SIMATIC IT UA DM ───────────────────── 4-6

SIMATIC IT UA DM Step ────────────────────────────────── 4-6Create SIMATIC IT UA DM Step ──────────────────────────────── 4-6Maintain SIMATIC IT UA DM Step Fields ─────────────────────────── 4-7Create and Associate Document to SIMATIC IT UA DM Step ─────────────── 4-7

SIMATIC IT UA DM Gateway for Teamcenter Configuration Guide 2© 2018 Siemens Product Lifecycle Management Software, Inc.

SIMATIC IT UA DM Data Collection Definition ──────────────────── 4-8SIMATIC IT UA DM Skill ────────────────────────────────── 4-8Create and Associate SIMATIC IT UA DM Document ──────────────── 4-9

100 Percent ComponentsPrepare 100 Percent BOM and BOP ────────────────────────── 5-1Transfer 100 Percent BOM and BOP to SAP ───────────────────── 5-5Transfer 100 Percent BOP to SIMATIC IT UA DM ─────────────────── 5-5

SIMATIC IT UA DM AsPlannedBoP ─────────────────────────────── 5-6

UADM and ERP interactionCreate WorkOrderHeader in SIMATIC IT UA DM ─────────────────── 6-1Create Confirmation in ERP ─────────────────────────────── 6-2

SIMATIC IT UA DM Non-Conformance NotificationImport Non-Conformance Notification ──────────────────────── 7-1Maintain Non-Conformance Notification Objects ───────────────── 7-2

DataviewDataview Configuration ───────────────────────────────── 8-1

CLM4T Glossary Topic A-1

Contents


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

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 SIMATIC IT UA DM Gateway forTeamcenter or those that have a legitimate right to use this documentation as part of their assignmenton behalf of the licensee to enable or support usage of the software for use within the boundaries of thelicense agreement.

© 2018 Siemens Product Lifecycle Management Software Inc.

Trademark notice:

Siemens, the Siemens logo and SIMATIC IT 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 SIMATIC IT UA DM Gateway for Teamcenter (CLM4T) software solution is an integration softwarethat provides data and process integration between Teamcenter® by Siemens Product LifecycleManagement Software Inc. and SIMATIC IT Unified Architecture Discrete Manufacturing by Siemens AG.CLM4T comes with a demo configuration assuming that Teamcenter Gateway for SAP Business Suite isin place in order to close the triangle with SAP ERP. The connection between ERP and MES is assumed tobe implemented by SIMATIC IT UA DM Gateway for SAP S/4HANA (CLM4S). Note that CLM4T may also beoperated without Teamcenter Gateway for SAP Business Suite, CLM4S and SAP ERP. In this case orderand order confirmation are out of scope.

CLM4T provides a wide range of automatic, interactive and workflow functions to transfer andsynchronize data between Teamcenter and SIMATIC IT UA DM.

This document details the components of Teamcenter - SIMATIC IT UA DM integration, which areavailable out of the box and configurable to meet customer specific solution requirements. It alsodescribes the prerequisites for the integration of SAP ERP using the Teamcenter Gateway for SAPBusiness Suite.

SIMATIC IT UA DM Gateway for Teamcenter Configuration Guide 1-1© 2018 Siemens Product Lifecycle Management Software, Inc.

1. Introduction

1-2 SIMATIC IT UA DM Gateway for Teamcenter Configuration Guide© 2018 Siemens Product Lifecycle Management Software, Inc.

2. CLM4T and SIMATIC IT UA DMInteraction

Integration Story

While SIMATIC IT UA DM Gateway for Teamcenter (CLM4T) only covers the integration of Teamcenterwith SIMATIC IT Unified Architecture Discrete Manufacturing, the integration story makes most sensewhen an ERP system is also included. In this chapter, we assume SAP Business Suite® is used as the ERPsystem, and the Teamcenter Gateway for SAP Business Suite is used for the integration betweenTeamcenter and SAP Business Suite®. CLM4T can be used with other ERP systems and integrationsolutions or without an ERP, though. Note that CLM4T does not cover shop floor automation.

The sample scenario assumes a structure with options and variants or unit or date effectivity applied tothe BOP and/or the BOM within Teamcenter. This results in a configurable structure in Teamcentercontaining more components than necessary to produce a single product. This is called 150% structureor in the context of MES: a master plan. A configured structure contains only those componentsnecessary to produce a single specific product (or unit) and is called a 100% structure. In the context ofMES, a pure 100% structure without detailed master data of the components is called a skeleton or "AsPlanned BOP".

This chapter will explain the overall integration scenario, which consists of three "closed loops" (businessuse cases spanning two or three systems).

Closed Loop 1

This closed loop handles the initial masterplan (150% unconfigured components) and skeleton transfers(100% configured structures) and supplies CLM4T with the necessary data to execute an order.


1. The Teamcenter engineer prepares and verifies the Bill Of Process (BOP), the Bill Of Materials(BOM) and the Bill Of Resources in Teamcenter Manufacturing Process Planner (MPP). He alsocreates and verifies the variability of the product using classic options and variants or unit or dateeffectivity. This step is not covered in this manual as it is not related to integration. For further helpon MPP, please consult the Teamcenter manuals. Please note that there are some restrictions andrequirements the authored data must conform to in order to support the CLM4T scenario. Thesewill be explained in the subsequent chapters.

2. The Teamcenter engineer (or another Teamcenter user) releases the components of the masterplan (master data like e.g. Material, Process, Operation, etc.) from Teamcenter to the target ERPand MES systems. Structures, relations and configurations are not relevant in this step. Instead, itonly cares about the building blocks of the unconfigured structures (150%).

3. The Teamcenter engineer (or another Teamcenter user) releases one or several configuredstructures (100% BOM and BOP, the "skeleton") from Teamcenter to SAP. This step assumes that allnecessary components of the structures have already been transferred in the previous step.

4. The SAP operator creates and releases an SAP Production Order to MES, using the business objectscreated in the previous SAP releases and additional ERP-internal processes. Note that order transferis not part of CLM4T but is implemented e.g. in CLM4S. If the product configuration used in the ERPorder is already known in the MES system, the MES system can immediately process and execute

2. CLM4T and SIMATIC IT UA DM Interaction


the order, if needed. If the MES system SIMATIC IT UA DM does not yet know the details of theproduct configuration, then it automatically triggers the download of the configured productionstructure (100 % BOP) from Teamcenter via CLM4T.

The sequence of the steps is not strictly required. For example, the transfers to SIMATIC IT UA DM andSAP can easily be split into smaller pieces and executed at different points in time and by differentoperators based on the maturity of sub-structures. Also, transfers may be repeated, e.g. if data errorshave been corrected. The only restriction is that all components of a structure must be known in thetarget system before the structures can be transferred.

Now that all necessary data is available in MES, the SIMATIC IT UA DM operator can start the executionof the WorkOrder. The execution itself is not covered in this manual as it is not part of the integration.For details see the manuals of SIMATIC IT Unified Architecture Discrete Manufacturing. The non-conformance loop is also part of the execution and includes integration-relevant transfers and is coveredin the next section (Closed Loop 2). Finishing the WorkOrder is covered in the last section of this chapter(Closed Loop 3).

Closed Loop 2

In case a non-conformance is detected during order execution in SIMATIC IT Unified ArchitectureDiscrete Manufacturing that needs to be escalated to product development (engineering, i.e. the PLMsystem Teamcenter), CLM4T supports the automatic synchronization of a change object in Teamcenter.

Integration Story


1. A SIMATIC IT UA DM operator executes the WorkOrder on the shop floor.

2. The SIMATIC IT UA DM operator creates a Non-Conformance Notification (NCN) during WorkOrderexecution. Based on some decision logic in SIMATIC IT UA DM the NCN can be escalated toengineering (Teamcenter).

3. If the non-conformance is escalated, SIMATIC IT UA DM automatically triggers the creation of aspecific problem report object in Teamcenter. Teamcenter will automatically retrieve details on theNCN and populate the problem report with that data. In SIMATIC IT UA DM the status of the non-conformance will be updated.

4. The SIMATIC IT UA DM operator can verify NCN status.

5. A Teamcenter engineer will be notified of the new problem report and can verify it.

6. The Teamcenter engineer can view live data of the SIMATIC IT UA DM WorkOrder in the SITDataview in Teamcenter and start appropriate actions to correct engineering data (not requiringintegration).

When the corrections are completed, changed data must be updated in SAP and SIMATIC IT UA DM. Thatessentially means to repeat some of the steps from the previous section.



Closed Loop 3

This closed loop covers finishing the SIMATIC IT UA DM WorkOrder and the operation or orderconfirmation back to SAP Business Suite®.

1. When the SIMATIC IT UA DM work order is completed, SIMATIC IT UA DM will automatically confirmthe production order in SAP Business Suite®. Alternatively, based on MES-internal configuration,SIMATIC IT UA DM may confirm on an operation basis to notify the ERP of the progress. In this casethe ERP system will assume the order to be completed when all operations are confirmed. Notethat confirmation is not part of CLM4T, but is implemented in CLM4S.

2. The SAP operator can now finalize the production order and e.g. verify or correct goodsmovements. This is a SAP internal process and requires no CLM integration.

3. The Teamcenter engineer can view live data of the SIMATIC IT UA DM WorkOrder and the SAPproduction order and its components in the SIT or T4S Dataview in Teamcenter.

Integration Story


3. Basic Configuration

Merge T4S Mapping

In case you want to use T4S to provide integration from PLM (Teamcenter) to ERP (SAP), you must adaptyour T4S mapping. CLM4T provides a sample mapping for T4S. In the simplest use case, when there isno custom T4S mapping (only the OOTB T4S demo mapping), you can just delete any existing directory<T4x_GS_ROOT>/var/mmap/t4s_mapping_config and its content and then copy the CLM4Tsample mapping directory <T4x_GS_ROOT>/var/template/t4clm/mmap/t4s_mapping_configto <T4x_GS_ROOT>/var/mmap. If there is a custom mapping you want to keep, you will have to mergethe existing t4s_mapping_config with the CLM4T sample mapping.

Add T4x Job Agent

For some external events, CLM4T needs to execute jobs in the background (e.g. incoming web servicesfrom MES, long-running transfer workflows). Therefore the CLM4T GS instance(s) need to be configuredto have at least one Job Agent. For details on Job Agent creation, see chapter T4x Agent configurationin the Teamcenter Gateway - Generic Configuration Guide. Configuring at least one Job Agent isnecessary for the demo scenario to work. In case of several GS instances, at least one of the instanceshas to have a job agent. From a functional point of view a single one is enough to cover CLM4S andCLM4T functionalities.

Mapping Templates and Preferences

Please refer to Generic Preference Concept and Generic Mapping Concept in the TeamcenterGateway - Generic Configuration Guide to read more about how to configure preferences inTeamcenter and mapping in T4x.

CLM4T supports different Bill of Process (BOP) structures created differently in Teamcenter (seeSupported BOP Structures for details) while providing a single set of mapping files and workflows. Tomake this possible CLM4T provides a way to make the mapping for the master plan (150% components,no structure) more flexible by separating the different levels of the BOP. Each level has its own mappingfile. There is a second level mapping covering the level of the SIMATIC IT UA DM operations and a thirdlevel mapping file covering SIMATIC IT UA DM steps.

The master plan transfer (150% components, no structure) evaluates master data of the components,but for certain reasons it is useful to evaluate specific structures also: In Teamcenter assignments ofDCDs to an operation or step have to be made in context of a structure (occurrences) while SIMATIC ITUA DM assumes data points are related to operations or steps independent of a structure. In order toevaluate the correct data collections CLM4T evaluates the object to extract master data (e.g. foroperations and steps), and in a separate transfer task in the workflow it also evaluates the structurebelow operations and steps to transfer master data of data collections and relate them to their parent.


https://docs.plm.automation.siemens.com/tdoc/pl4x/18.2/CLM4T/#uid:index_xid1362995



Supported BOP Structures

The OOTB CLM4T demo scenario supports 3 Teamcenter BOP structure types. Each BOP type consists ofthree levels that correspond directly to the SIMATIC IT UA DM objects Process, Operation, and Step. Thefollowing table shows the possible combinations:

SIMATIC ITlevel

Classic BOP Compound BOP Plant BOP

Teamcenter Type TargetTypeNameTeamcenter

Type TargetTypeName Teamcenter Type TargetTypeName

Process(level 1)

MEProcess Process MEProcess Process Mfg0MEPlantBOP,Mfg0MEProcLine

Process

Operation(level 2)

MEOP Operation Mfg0MECompOP Operation Mfg0MEProcStatn PlantOperation

Step(level 3)

MEActivity,MENCProgram orMENCToolActivity

implicitly handledby Operation

Mfg0MEStep Step MEOP PlantStep

Explanations:

• In the interest of shortness, the table shows the Teamcenter item type names. However, the target ofan actual transfer and the name used in the preference definition must be the corresponding revisiontype.

• TargetTypeName is the name used in CLM4T workflow handlers and preferences in Teamcenter thatidentifies a certain type of transfer. Note that you have to use a specific type for certain PlantBOPtransfers.

• Most CLM4T demo workflow templates delegate workflow execution to the T4x job engine, so theinteractive user's Teamcenter session is not blocked. In the OOTB configuration, the job engine usesthe Teamcenter user "t4xbatch" to execute the tasks. In case of an error, the workflow is routed to aninteractive "Do" task that will pop up in the Teamcenter Inbox of user "engineer", who is intended tofix data errors and then complete the workflow.

• The CLM4T demo workflow templates CLM_Release_150PerCent_StandAloneObjects andCLM_Release_150PerCent_StandAloneObjects_PlantBOP can be used on all components of acomplete BOP. They consist of several tasks specific to certain parts of the BOP. It will pick the relevantparts in the corresponding tasks and ignore the irrelevant targets. This way you can select allcomponents of an expanded BOP in Manufacturing Process Planner and start the workflow on it. Incase of data errors in the workflow, do not abort the whole workflow instance and restart, butinstead, correct the error in the data and then complete the previously failed task or thecorresponding "Do" task.

• Classic BOP and compound BOP can be mixed, i.e. on the second level of the BOP under an MEProcessyou may use MEOPs (with or without Activities) and Mfg0MECompOPs in parallel.

• Teamcenter Activities do not have a specific TargetTypeName for the transfer. Instead, they aretransferred together with the operation (MEOP) they are attached to.



Caution:

• The CLM4T demo scenario as provided in the demo mapping and the "t4clm" demo template,including Teamcenter data types, workflow templates, preferences, users, etc. is only meant asa sample configuration and must not be applied to productive environments. Instead, it isnecessary to analyze customers needs and processes and create a customer specificconfiguration depending only on the base template "sit0gateway".

• While SIMATIC IT supports several levels of Processes, The CLM4T demo supports only a singleprocess level. To transfer a multi-level process BOP, transfer all the process "leafs" separately.

• The interpretation of an MEOP object is different depending on the structure type you areworking in: For a classic or a Compound BOP a Teamcenter MEOP translates to a SIMATIC IT UADM Operation, whereas for a PlantBOP a Teamcenter MEOP translates to a SIMATIC IT UA DMStep. For the master plan (150% no structure transfer) there are different Teamcenter workflowtemplates that take care of this difference. This is the reason why you can't mix a PlantBOPstructure with the other two types. All other actions (100% transfer) are identical.

• The top-level Process in all structure types has to have a single product structure assigned viathe GRM relation "Mfg Targets" and a single top-level work area with GRM relation "IMANMEWork area", else a later request to create a Teamcenter CollaborationContext object or aconfiguration request from CLM4T will fail.

SIMATIC IT UA DM connection configuration

In <T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_mapping_config.sd you shouldconfigure the URL to access CLM4T services. There is a piece of template code included, which you canadapt:

set RootConnectString http://<nameOrIPofSITUAServer>/sit-svcset ConnectString [dict create \ BaseURL "${RootConnectString}" \ ODATAApplication "/Application/AppU4DM/odata" \ ODATARuntime "/runtime/AppU4DM/odata/File" \ TokenExecutable "[rcwd]/lib/token/getToken.exe" \ TokenAppName T4CLMIntegration \ TokenExpiresInSeconds 720]

Replace <nameOrIPofSITUAServer> in the first line with the actual hostname of your SIMATIC ITserver. Consult the administrator if necessary for any further adaptions on the URL. The next line addsadditional information to that URL. Usually, you will not need to modify these settings, as any OOTBCLM4T installation will use the same values.

BaseURL: Identical to the previously configured RootConnectString.

SIMATIC IT UA DM connection configuration


ODATAApplication:

the URL extension to be appended to the BaseURL in order to address the service layerwhen invoking SIMATIC IT UA DM commands.

ODATARuntime:

the URL extension to be appended to the BaseURL in order to read data from SIMATIC ITvia ODATA queries.

TokenExecutable:

the configured binary path is executed whenever CLM4T needs to extract a token fromthe certificate. The token is necessary in order to authenticate against the CLM4Tserver. For details on the certificate, see Install Certificate. The default value refers toa Windows binary delivered with CLM4T. The binary must take one parameter (theTokenAppName) and return the corresponding token on the standard output.

TokenAppName:

A name used during extraction of the token from the certificate.

TokenExpiresInSeconds:

This parameter determines the validity period of the created token as configured onthe server (CLM4T requests a new token after this period).

The configured ConnectString variable is then used in callslike ::CLM4T::CONNECTION2EA::setConnectionInfoPlain to build a named connection that isused in RAC or in the mappings in order to address a specific SIMATIC IT system. Several connectionsmay be configured here, allowing to address different SIMATIC IT systems if required. A "preferred"CLM4T connection can be defined by ::T4X::CONNECTION2EA::selectActiveConnection2EACLM4T"*" "UAFReal". This connection will be used if not otherwise specified.

Before each interaction with SIMATIC IT, CLM4T checks the connectivity using a simple and fast call tothe server. This can be configuredin ::CLM4T::CONNECTION2EA::CUSTOM::MAPPING::connectEA. The demo implementationcalls ::CLM4T::SERVICES::checkConnection. The following API will be used in this function:

Target System Used API

SIMATIC IT UA DM DependencyType



Caution:

If your SIMATIC IT exposes an SSL (https) URL, you need to tell CLM4T which certificates should beused, otherwise no certificates will be checked - opening the connection for man-in-the-middleattacks! Active Integration clients do not use certificates from the operating system certificatestore, so the certificates have to be specified using the optional AdditionalParameters entryin the dictionary when defining a connection. Here is an example:

::CLM4T::CONNECTION2EA::setConnectionInfoPlain SITUADMServerUingHTTPS [dict create \ BaseURL "https://<SITUADMServerUingHTTPSIPorName>:443/sit-svc" \ ODATAApplication "/Application/AppU4DM/odata" \ ODATARuntime "/runtime/AppU4DM/odata" \ TokenExecutable "[rcwd]/lib/token/getToken.exe" \ TokenAppName "" \ TokenExpiresInSeconds 720\ AdditionalArguments [list -cert [rcwd]/etc/cert/server_certificate.cer] \ -clientcert [rcwd]/etc/cert/client_certificate.cer]]

The difference is in the BaseURL ("https:") and the last two lines. The -clientcert option is onlynecessary when 2-way SSL is required. For details on -cert and -clientcert please seeCLM4T API Reference for the command tpco_httpClient.

Addressing Multiple Simatic IT Servers

CLM4T can address one or many SIMATIC IT servers based on some mapping logic. The delivered demomapping assumes the following restrictions:

• There is 1:1:1 relation between Teamcenter top-level-work area, SAP plant and SIMATIC IT UA DM top-level equipment element (also called enterprise or plant).

• Top-level Teamcenter work area and SIMATIC IT UA DM top-level equipment element (enterprise) aremapped according to identical names.

• The SAP production plant is mapped to the SIMATIC IT UA DM top-level equipment element(enterprise) exclusively by the ::SIT::PLANTMAPPING functionality (see below).

• Each SIMATIC IT server can handle several top-level equipment elements (enterprises). This essentiallymeans that a single CLM4T connection can be used to address several enterprises.

The mapping is defined by a triple of enterprise name (for SIMATIC IT UA DM and Teamcenter, ifapplicable), the SAP plant ID and the CLM4T connection name. In the demo mapping this is definedusing ::SIT::PLANTMAPPING functionality, similar to the following example:

Addressing Multiple Simatic IT Servers


https://docs.plm.automation.siemens.com/docs/pl4x/18.2/en_US/API_Doc_clm4t.zip

::SIT::PLANTMAPPING::add "Factory1" "1000" "SITConnectionA"::SIT::PLANTMAPPING::add "Factory2" "2000" "SITConnectionA"::SIT::PLANTMAPPING::add "Factory3" "3000" "SITConnectionB"

This is a global definition and should be defined in clm4t_custom_parameters.sd file. The exampledefines that the work area with name "Factory1" (the SIMATIC IT UA DM enterprise) maps to SAP plant1000 and the CLM4T connection "SITConnectionA" has to be used to address SIMATIC IT UA DM. Asecond enterprise "Factory2" is also hosted be the same SIMATIC IT server which can be addressed by theCLM4T connection "SITConnectionA", but maps to SAP plant 2000. Finally a separate SIMATIC IT serverhosts "Factory3" (SAP plant 3000) and can be addresses using CLM4T connection "SITConnectionB".

Whenever CLM4T needs to transfer data to SIMATIC IT, it determines the CLM4T connection based onthe top-level work area.

All incoming web service calls from SIMATIC IT carry an "Enterprise" field. Based on this value anysubsequent CLM4T, CLM4S or T4S action can determine the correct connection to SIMATIC IT. Thenamespace ::SIT::PLANTMAPPING contains all necessary procedures to uniformly access thepreviously defined plant mapping.

Note that in the demo scenario implementation the "Enterprise" value of an incoming call is copied tothe description field of the initiated Teamcenter workflow by CLM4T. This value always overrules anydefault ("preferred") connection and also overrules the connection that results from the top-level workarea or SAP plant. Since the 150% transfer does not know any structure, the demo scenario providesworkflow templates that transfer the master data either to only one SIMATIC IT server, or to severalservers. This can be adapted as needed using standard Teamcenter workflow definition and the CLM4Tlogon task.

Install Certificate

SIMATIC IT uses 2-legged OAuth 2.0 for authentication. This mechanism does not require the user toenter any credentials, but instead, the host running the service (each CLM4T GS host in our case) andthe SIMATIC IT host must have the identical certificate installed in the system's certificate store. Usually,this certificate is created and provided by the SIMATIC IT administrator. On Windows, such a certificate isa file with the extension .pfx. Usually, when double-clicking it, Windows will open a wizard to import itinto the local machines certificate store. The wizard may ask for a password, which should be providedby the administrator who created the certificate. Usually, the default settings for the wizard will workwell, and you should leave them unchanged unless the creator of the certificate tells you to.

Please do not forget to keep CLM4T server clock and SIMATIC IT server clock synchronized because ofattribute nbf (not before) in the payload part of the token.

The Chapter SIMATIC IT UA DM connection configuration describes how to configure CLM4T to usethe imported certificate. For more details on certificate handling, consult the SIMATIC IT manuals.



The File clm4t_mapping_config.sd

The file clm4t_mapping_config.sd in the directory <T4x_GS_ROOT>\var\mmap\clm4t_mapping_config isthe first configuration file of the CLM4T software that is read by each TCL worker thread or process. Itloads the rest of the mapping files and may contain basic settings as well as variables which aresupposed to be used in more than one mapping file.

The following basic settings can be configured in clm4t_mapping_config.sd:

• System login data, see chapter Configurable URL for UADM

• ::ITK::setConnectionParameter allows to set the Teamcenter connection parameters.

• ::CLM4T::CONNECTION2EA::selectActiveConnection2EA, ::CLM4T::CONNECTION2EA::readConnectionInfo4Sessionand ::CLM4T::CONNECTION2EA::setConnectionInfoPlain are used to setup theconnection(s) to SIMATIC IT. You can specify the connection URL which CLM4T uses, and set a defaultconnection to use, if no other connection has been specified, e.g. in the workflow. The onlyimplemented authentication method for CLM4T is 2-legged OAuth2 (see Install Certificate fordetails).

• Sourcing of mapping files with source -relax.Example: source -relax clm4t_object_mapping.sd. This means CLM4T has to read thecontent of the file clm4t_object_mapping.sd. The argument -relax means the file is looked up inthe memory first and only if its content is not there, the file is loaded from disc (only in the samedirectory <T4x_GS_ROOT>\var\mmap\clm4t_mapping_config).In principle, 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 CLM4T actually uses for the mapping is the compiled mapping fileclm4t_mapping_config.rfdt. So this is what you need to think about in order to create the compiledmapping file correctly.In order to not use a mapping file, it is enough to not "source" it in clm4t_mapping_config.sd.However, we strongly recommend keeping only those mapping files in the mmap directory that youreally want to use!Be sure to have the correct file names (the files located in <T4x_GS_ROOT>\var\mmap\clm4t_mapping_config) in the "source" section of this file.

• In addition to the above mentioned settings, this is also the place to define the configuration formultiple SIMATIC IT UA DM servers (see chapter Addressing Multiple Simatic IT Servers) and toconfigure the language of internal messages directly returned by CLM4T.

• The code starting with set overlay... is only relevant in SPLM-internal development and testingenvironments and will not become active in any custom environment, so it can be ignoredcompletely.

• Configure the language of internal messages directly returned by CLM4T:Example:

The File clm4t_mapping_config.sd


set strLanguageCode "en_US" ; # default language (check /var/lang/CLM4T/ for more language codes)

Other possible languages can be found in the directory <T4x_GS_ROOT>\var\lang\CLM4T>.It is also possible to control the language using an OS environment variable:

set TP_LANGUAGE_CODE=de_DE

Deployment Options

The logical structure of a Closed Loop Manufacturing integration and the participating integrationproducts looks as follows:

The Active Integration product family allows to distribute functionalities to different locations or serversas needed. So it is possible to install two or three of the products (T4S, CLM4T and CLM4S) in a single GS(Gateway Service) instance or to distribute to several GS instances vertically (according tofunctionalities) or horizontally (scalability). In all scenarios it is highly recommended to keep a singleBGS (Basic Gateway Service) in the network to allow a single access point for logging and jobmanagement.

Single GS

This is an example of a simple installation with a single GS instance. It assumes that all three productsare installed using the Active Integration installer's "extend" option . Active Integration BGS, SIMATIC ITUA DM and SAP are each installed on a separate host. The GS is installed on the Teamcenter server host,because it needs to be called directly from the tcserver processes in the Teamcenter pool manager. (Thesize and number of the host boxes does not indicate any sizing or importance.)



Note that the GS instance can also address several SIMATIC IT UA DM instances, either on the same hostor on several hosts. In order to achieve more performance for incoming GS web service calls, one orseveral GS instances may be added on separate hosts that are not connected to the Teamcenter poolmanager but share only the Teamcenter 2-tier installation package (see Teamcenter Gateway -Installation Guideand the Teamcenter manuals).

Separate GS Instances for Teamcenter and SIMATIC IT UA DM

Due to the stricter requirements regarding accessability and fault tolerance it may be useful to separatethe ERP-MES functionality into one GS instance ("GS1") while the all PLM-related functionality resides onanother GS ("GS2"). In this case the BGS host should also be part of the MES network. It is required toinstall all three products on both GS instances, as the PLM-related functionalities access code that is partof the CLM4S product. Also it is recommended to share a single mapping as this makes managementand maintenance easier. In this sceanrio a failure of the Teamcenter host does not affect orderprocessing for materials that have already been transferred to SIMATIC IT UA DM and SAP.

Distribution of the functionalities can be achieved by taking these measures:

• The trigger script for SAP orders runs on "GS1" and the job agent on "GS1" is configured to processonly SAP-related jobs.

• In SIMATIC IT UA DM configuration keys, the URLs configured for CLM processing point to the hostname of "GS2" for Teamcenter related services of CLM4T (triggerSkeletonTransfer andupdateIssueReport) and to the host name of "GS1" for SAP related services of CLM4S(createProdOrderConfAsync and createProdOrderOperationConfAsync).

Deployment Options


https://docs.plm.automation.siemens.com/content/pl4x/18.2/CLM4T/en_US/Teamcenter_Gateway-Installation_Guide/preface.html

https://docs.plm.automation.siemens.com/content/pl4x/18.2/CLM4T/en_US/Teamcenter_Gateway-Installation_Guide/preface.html

The image shows only a single MES system for simplicity, but of course also in such a separatedenvironment each GS can address several instances of SIMATIC IT UA DM, maybe even in differentnetworks, but with connectivity to the BGS. SAP does not necessarily have to be part of themanufacturing network but can also be in the engineering network or another segment as long as theconnectivity is up.



4. 150 Percent BOP Components

General Remark

The following chapters give an overview of the capabilities of the SIMATIC IT UA DM Gateway forTeamcenter. This part of the manual in meant to support adaption of the solution to customer needs bylinking each capability to the piece of TCL code where it is implemented and can be adapted. Basicknowledge of the TCL programming language is necessary to understand or change the mapping logic.

The "Maintain" chapters describe how fields can be adapted. Note that "Maintain" in this context doesnot imply "Update": While the Active Integration platform supports updates of existing objects, theSIMATIC IT UA DM commands used to implement the capabilities in most cases do not support updatesof existing objects. Instead the result of such a call will be "success" but the data within the SIMATIC ITUA DM database will not have changed. Note that usually a clean Teamcenter release process wouldonly transfer released (i.e. unchangeable) objects to SIMATIC IT UA DM. In order to semantically changemaster data or structures, items, processes, operations, etc. have to be revised on Teamcenter side.When transferring the new revisions, they will establish new objects on SIMATIC IT UA DM side, hencestoring the changed values correctly.

Demo Workflow Overview

The CLM4T demo template t4clm comes with several sample workflows to transfer the BOPcomponents from Teamcenter to the target systems. Note that the demo workflows assume T4S to be inplace. The workflows can be adapted as needed (e.g. remove T4S components, adapt target system orconnection names) and can be used as templates for the creation of specific workflows. Some of theworkflows use other sub-workflows because they implement a repeated sequence of identical tasks.Here is an overview of the demo workflows that should be used for 150% transfers:

• CLM_Release_150PerCent_StandAloneObjects_Factory1: This workflow is an example to transfermaster data of a classic or compound BOP to a single SAP system and to a single SIMATIC IT UA DMinstance. The workflow can easily be extended to support a second or several SIMATIC IT UA DMinstances, see next item. The workflow handles all types of components that make up a BOP likematerials (items), process, operations, etc. as described in the following chapters. It does not transferany structure information.

• CLM_Release_150PerCent_StandAloneObjects_AllFactories: This workflow is an example to transfermaster data to a single SAP system and to two SIMATIC IT UA DM instances. It is an extension of theprevious workflow.

• CLM_Release_150PerCent_StandAloneObjects_PlantBOP: This workflow is similar to the first one(transfer to a single SAP and single SIMATIC IT UA DM system), but it covers a plant BOP instead of aclassic or compound BOP. The difference manifests in different TargetTypeNames in the handlerconfiguration, accepting different Teamcenter types and interpreting the type MEOP differently. SeeSupported BOP Structures for details. This workflow can also be extended to support severalSIMATIC IT UA DM systems, if needed.


SIMATIC IT UA DM Material Definition

Create SIMATIC IT UA DM Material Definition

Maintain SIMATIC IT UA DM Material Definition Fields

Create and Associate Document to SIMATIC IT UA DM Material Definition

Create SIMATIC IT UA DM Material Definition

The capability to create a Material Definition in SIMATIC IT UA DM is based on ItemRevision orPartRevision released from Teamcenter. The Material Definition transaction usesthe ::CLM4T::GENOBJ::CUSTOM::MAPPING::MESInputDatObject dictionary (see table belowfor detailed specification). The dictionary key MaterialList:dicts has a list of single dictionariesItemDict. Each of the ItemDict contains the fields mapping based on the T4x approach usingpreferences and mapping by calling ::T4X::TC::MAPPING::FieldMapping. To learn more aboutmapping by invoking perform function have a look at the performTransfer in <T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_material_mapping.sd.

In case of PartRevision all of the Part Logistics Form attributes such as Lot or Serialized are mapped tothe corresponding attributes in SIMATIC IT UA DM Material Definition. These attributs permit to createinstances of the Material in SIMATIC IT UA DM having characteristics like a batch or serial number.


SIMATIC IT UA DM PLMCreateMaterialDefinitionList

Maintain SIMATIC IT UA DM Material Definition Fields

The maintained fields are the keys of the ItemDict. Go to the TC_Object2MES_Object procedure in<T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_material_mapping.sd to get more details.Note that the same procedure populates the DocumentList:dicts used to create Documents andDocumentAssociationList:dicts used to associate the given DocumentList:dicts to theMaterial Definition in SIMATIC IT UA DM.

Create and Associate Document to SIMATIC IT UA DM Material Definition

The capability to transfer and associate a Document to SIMATIC IT UA DM Material Definition is based onthe document linked to the ItemRevision or PartRevision. Please refer to Create and Associate SIMATICIT UA DM Document for details.

The performTransfer procedure for associating the document uses thePLMAssociateDocumentToToolDefinitionList command in SIMATIC IT UA DM.




SIMATIC IT UA DM PLMCreateDocumentList

PLMAssociateDocumentToMaterialDefinitionList

SIMATIC IT UA DM Tool Definition

Create SIMATIC IT UA DM Tool Definition

Maintain SIMATIC IT UA DMTool Definition Fields

Create and Associate Document to SIMATIC IT UA DM Tool Definition

Create SIMATIC IT UA DM Tool Definition

The capability to create a Tool Definition in SIMATIC IT UA DM is e.g. based onMfg0MEEquipmentRevision or Mfg0MEResourceRevision release from Teamcenter. The Tool Definitiontransaction makes use of the ::CLM4T::GENOBJ::CUSTOM::MAPPING::MESInputDatObjectdictionary (see table below for detailed specification). The dictionary key ToolList:dicts has a list ofsingle dictionaries ItemDict. Each of the ItemDict contains the fields mapping based on the T4xapproach using preferences and mapping by calling ::T4X::TC::MAPPING::FieldMapping. Pleasealso refer to Mapping Templates and Preferences for more details about how to configure preferencesin Teamcenter and mapping in T4x.

To learn more about mapping by invoking perform function have a look at the performTransfer in<T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_tool_mapping.sd.


SIMATIC IT UA DM PLMCreateToolDefinitionList

Maintain SIMATIC IT UA DMTool Definition Fields

The maintained fields are the keys of the ItemDict. Go to the TC_Object2MES_Object procedure in<T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_tool_mapping.sd to get more details. Notethat the same procedure populates the DocumentList:dicts used to create Documents andDocumentAssociationList:dicts used to associate the given DocumentList:dicts to the ToolDefinition in SIMATIC IT UA DM.

Create and Associate Document to SIMATIC IT UA DM Tool Definition

The capability to transfer and associate Document to SIMATIC IT UA DM Tool Definition is based on thedocument linked to the corresponding object ItemRevision or PartRevision. Please refer to Create andAssociate SIMATIC IT UA DM Document for details.

SIMATIC IT UA DM Tool Definition


The performTransfer for the associating the document will be called usingPLMAssociateDocumentToMaterialDefinitionList command in SIMATIC IT UA DM.


SIMATIC IT UA DM PLMAssociateDocumentToToolDefinitionList

SIMATIC IT UA DM Process

Create SIMATIC IT UA DM Process

Maintain SIMATIC IT UA DM Process

Create SIMATIC IT UA DM Process

The capability to create a Process in SIMATIC IT UA DM is based on MEProcessRevision,Mfg0MEPlantBOPRevision or Mfg0MEProcLineRevision release from Teamcenter. The transaction makesuse of the ::CLM4T::GENOBJ::CUSTOM::MAPPING::MESInputDatObject dictionary (see tablebelow for detailed specification). The dictionary key ProcessList:dicts has a list of singledictionaries ItemDict. Each of the ItemDict contains the fields mapping based on the T4x approachusing preferences and mapping by calling ::T4X::TC::MAPPING::FieldMapping. Please also referto Mapping Templates and Preferences for more details about how to configure preferences inTeamcenter and mapping in T4x.

Please note that by default, function validateProcess will verify the Bill of Process (BOP) structureusing the variable ::CLM4T::CONFIGURATION::PlantList which defines all mandatoryattachments of a process revision.

To learn more about perform function have a look at the performTransfer in <T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_process_mapping.sd.


SIMATIC IT UA DM PLMCreateProcessList

Maintain SIMATIC IT UA DM Process

The maintained fields are the keys of the ItemDict. You can configure the the fields in theTC_Object2MES_Object procedure in <T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_process_mapping.sd.

SIMATIC IT UA DM Operation

Create SIMATIC IT UA DM Operation

Maintain SIMATIC IT UA DM Operation Fields



Create and Associate Document to SIMATIC IT UA DM Operation

Associate Skill to Operation in SIMATIC IT UA DM


The capability to create an Operation in SIMATIC IT UA DM is based on the MEOPRevision in the case ofclassic BOP structure, Mfg0MECompOPRevision in the case of compound BOP structure orMfg0MEProcStatnRevision in the case plant BOP release from Teamcenter. The transaction makes use ofthe ::CLM4T::GENOBJ::CUSTOM::MAPPING::MESInputDatObject dictionary (see table belowfor detailed specification). The dictionary key OperationList:dicts has a list of single dictionariesItemDict. Each of the ItemDict contains the fields mapping based on the T4x approach usingpreferences and mapping by calling ::T4X::TC::MAPPING::FieldMapping. Please also refer toMapping Templates and Preferences for more details about how to configure preferences inTeamcenter and mapping in T4x.

The preferences are organized in two sets and shipped by demo template. One set of the preferenceshas CLM4T_Operation* at the beginning and is defined for the classic and compound BOP structure.Another set of the preferences, containing CLML_PlantBOPOperation* is the configuration for thecorresponding object Mfg0MEProcStatnRevision (for plant BOP).

Caution:

In the demo configuration, the second level objects of the plant BOP structure do not support DCDattachments, because the used Teamcenter type Mfg0MEProcStatnRevision does not support DCDattachments. This is why there is no structure based transfer for the plant BOP Operation.

<T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_operation_mapping.sd operates as capsuleand handle different corresponding objects in Teamcenter depending on the chosen kind of the BOPstructure.

Target system Used API

SIMATIC IT UA DM PLMCreateOperationList

Maintain SIMATIC IT UA DM Operation Fields

The maintained fields are the keys of the ItemDict. To find this dictionary follow theTC_Object2MES_Object procedure in the <T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_operation_mapping.sd. Depending on the Teamcenter BOP structure type theTC_Object2MES_Object procedure executesthe ::CLM4T::GENBOM::CUSTOM::MAPPING::SECONDLEVEL::TC_Object2MES_Object orthe ::CLM4T::GENOBJ::CUSTOM::MAPPING::SECONDLEVEL::TC_Object2MES_Objectfunction call. Please go to the <T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_bom_second_level_mapping.sd or <T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_second_level_mapping.sd, to find the ItemDict that you can use to change the current fieldmapping or add the additional fields.



Create and Associate Document to SIMATIC IT UA DM Operation

The capability to transfer and associate Document to SIMATIC IT UA DM Operation is based on thedocument linked to the corresponding object, please refer to Create SIMATIC IT UA DM Operation forsupported Teamcenter objects. Read about Create and Associate SIMATIC IT UA DM Document tolearn how the generic configuration for the Document SIMATIC IT UA DM transfer looks like.

The procedure performTransfer for associating the document will be called usingPLMAssociateDocumentToOperationList command in SIMATIC IT UA DM.



PLMAssociateDocumentToOperationList

Associate Skill to Operation in SIMATIC IT UA DM

The capability to transfer and associate Skill to Operation in SIMATIC IT UA DM is based on the MOMSkilllinked to the corresponding object, please refer to SIMATIC IT UA DM Skill for more details about Skilltransfer.

The procedure performTransfer ensures that the associated Skills will be linked to the Operation byposting MESInputDatSkillAssociations dictionary using the generic commandLinkSkillToOperationList in SIMATIC IT UA DM.

Later if SIMATIC IT UA DM creates WorkOrderOperation from the Operation the associated Skills will betaken as well.


SIMATIC IT UA DM LinkSkillToOperationList

SIMATIC IT UA DM Step

Create SIMATIC IT UA DM Step

Maintain SIMATIC IT UA DM Step Fields

Create and Associate Document to SIMATIC IT UA DM Step

Create SIMATIC IT UA DM Step

The capability to create a Step in SIMATIC IT UA DM is based on Mfg0MEStepRevision in the case ofcompound BOP structure, MEOPRevision in case of plant BOP or MEActivity in case of classic BOPstructure release from Teamcenter. The transaction makes use ofthe ::CLM4T::GENOBJ::CUSTOM::MAPPING::MESInputDatSteps by classic BOP structure



or ::CLM4T::GENOBJ::CUSTOM::MAPPING::MESInputDatObjectdictionary (see table below fordetailed specification). The dictionary key StepList:dicts has a list of single dictionaries ItemDict.Each of the ItemDict contains the fields mapping based on the T4x approach using preferences andmapping by calling ::T4X::TC::MAPPING::FieldMapping. Please also refer to MappingTemplates and Preferences for more details about how to configure preferences in Teamcenter andmapping in T4x.

The preferences are organized in two sets and shipped by demo template. One set of the preferenceshas CLM4T_Step* at the beginning and is defined for the Mfg0MEStepRevision. Another set of thepreferences, with CLML_PlantBOPStep*, is the configuration for the MEOPRevision (for plant BOP).There is no need to set the preferences for the MEActivity in Teamcenter.

<T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_step_mapping.sd operates as a wrapper andhandles different corresponding objects in Teamcenter depending on the chosen kind of the BOPstructure.


SIMATIC IT UA DM PLMCreateStepList


The maintained fields are the keys of the ItemDict. To find this dictionary follow theTC_Object2MES_Object procedure in the <T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_step_mapping.sd. Depending on the Teamcenter BOP structure type theTC_Object2MES_Object procedure executesthe ::CLM4T::GENBOM::CUSTOM::MAPPING::THIRDLEVEL::TC_Object2MES_Object orthe ::CLM4T::GENOBJ::CUSTOM::MAPPING::THIRDLEVEL::TC_Object2MES_Object functioncall. Please go to the <T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_bom_third_level_mapping.sd or <T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_third_level_mapping.sd, accordingly to find the ItemDict that you can use to change thecurrent field mapping or add the additional fields.

Create and Associate Document to SIMATIC IT UA DM Step

The capability to transfer and associate Document to SIMATIC IT UA DM Step is based on the documentlinked to the corresponding object, please refer to Create SIMATIC IT UA DM Step for supportedTeamcenter objects. Read about Create and Associate SIMATIC IT UA DM Document to learn how thegeneric configuration for the Document SIMATIC IT UA DM transfer looks like.

Caution:

The capability to transfer and associate Document to SIMATIC IT UA DM Step for MEActivity as acorresponding is not supported.

The procedure performTransfer for associating the document will be called usingPLMAssociateDocumentToStepList command in SIMATIC IT UA DM.




SIMATIC IT UA DM PLMAssociateDocumentToStepList

SIMATIC IT UA DM Data Collection Definition

By default, if an object corresponding to an Operation or a Step has a Data Collection Definition (DCD) inTeamcenter, CLM4T creates and associates a DCD in SIMATIC IT UA DM. This is done by populating thedictionary ::CLM4T::GENBOM::CUSTOM::MAPPING::MESInputDatDCDs for the TeamcenterOperation in <T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_bom_second_level_mapping.sd.

Similarly, for the Teamcenter Step thedictionary ::CLM4T::GENBOM::CUSTOM::MAPPING::MESInputDatStepDCDs in<T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_bom_third_level_mapping.sd is used.

Please note the DCD supported types are configured in the ::CLM4T::CONFIGURATION::DCDList inthe <T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_custom_parameter.sd. These parametersare used for the data extraction in Teamcenter. To add a new type, you need to add a new dict intothe ::CLM4T::CONFIGURATION::DCDList. Please do not forget to extend the preferences after all.

The performTransfer (see table above for the command) for the creation will be called in theappropriated mapping.


SIMATIC IT UA DM PLMCreateOperationDCDList

PLMCreateStepDCDList

SIMATIC IT UA DM Skill

Demo scenario uses custom object MOMSkill as a corresponding object for the SIMATIC IT UA DM Skill.CLM4T creates Skill and associates it to the Operation during Operation transfer in the SIMATIC IT UADM. It is done by populating the dictionaries for the Teamcenter Skill as follows:

Note that CLM4T calls a generic SIMATIC IT UA DM command in contrast to the PLM commands used forother transfers. The procedure ::CLM4T::TOOLBOX::searchInSITQuery will be executed to makesure that the skill with the same name does not exist in SIMATIC IT.


SIMATIC IT UA DM CreateSkill

ODATA Query: /Skill$filter=NId=<SkillName>



Create and Associate SIMATIC IT UA DM Document

By default, if the object in Teamcenter has a document, CLM4T creates and associates the Document inthe SIMATIC IT UA DM. It is done by populating thedictionaries ::CLM4T::GENOBJ::CUSTOM::MAPPING::MESInputDatDocuments with a keyDocumentList:dicts and DocumentList as value and anotherkey ::CLM4T::GENOBJ::CUSTOM::MAPPING::MESInputDatDocumentAssociations with a keyDocumentAssociationList:dicts and DocumentAssociationsList. Please note theDataSetType, MIMEType and the Reference are configured inthe ::CLM4T::CONFIGURATION::FileHandlingDatasetMap in the <T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_custom_parameter.sd. These parameters are used for the data extractionin Teamcenter. To extract a new data type from Teamcenter, you need to add a new key named exactlyas the object_type, e.g. for a .pdf file it must be PDF or for .docx - MSWordX. Please do not forget toextend the preferences afterwards.

The performTransfer for the document transfer uses always the same commandPLMCreateDocumentList by posting the payload during transfer to SIMATIC IT UA DM.

The transfer for associating the document will be called in a different way. Please have a look in theappropriate mapping file.



PLMAssociateDocumentToMaterialDefinitionList

PLMAssociateDocumentToOperationList

PLMAssociateDocumentToStepList

PLMAssociateDocumentToToolDefinitionList

Create and Associate SIMATIC IT UA DM Document


5. 100 Percent Components

Prepare 100 Percent BOM and BOP

Note:

This capability is not primarily related to the integration or to Closed Loop Manufacturing. Manualcreation of 100% CCObjects is possible and valid, but error prone. Therefore the demo scenarioprovides a helper workflow and a web service to automate the creation of the CCObject. Howeverthe creation can be replaced by any other process as needed without influencing the overall CLMscenario.

Workflow to Create CCObject

The capability to create the 100% CCObject that represents the SIMATIC IT UA DM AsPlannedBoP issupported by a Teamcenter workflow. Demo scenario covered two possibilities to configure 100 percentstructures by applying:

• revision rule using unit effectivity and/or

• variant rule using variant conditions.

Before you start the workflow, copy the Item or the ItemRevision of the BOM header and, if applicable avariant rule to the Teamcenter clipboard. The Item or ItemRevision will become the end item for theconfiguration and the variant rule will be used to configure options and variants. In order to transfer the100 Percent structures in Teamcenter, please start the workflowCLM_CreateCC_4_100PerCent_Structures (see "1" in the below image) on the BOP header objectrevision, for example on the MEProcessRevision in Manufacturing Process Planner (MPP, see "2"). In thenext step paste the Item or ItemRevision from the Teamcenter clipboard into References folder ("3"):


If you use classic variant rule to configure structures, add in addition to the Item a variant rule as shownin following figure.

As a result, you will find the Do task in My Worklist to perform. If you select the task, you will see a formin the "Viewer". In the next step you have to fill out the form as follows:



Please note that the value of the field "BOM Alternate" (field "1") will be used to create BOM Alternative,Routing Group Counter and Product Version in SAP as well. Furthermore, it will be used as the name ofthe SIMATIC IT UA DM AsPlannedBoP. The field Sample Unit ("3") is used for CCObject only and has nocorresponding field in SAP or SIMATIC IT. The Unit Range ("4") will be stored as a string in the ProductionVersion description in SAP.

The same workflow can be used to create the CCObject using classic options and variants. The form stillneeds the BOM Alternate, CC Object Name and Unit Range as input. In addition to the end item thevariant rule has to be attached as reference to the workflow.

Finally check the "Complete" radio button ("5") and click "Save" (6"). This will create the CCObject withthe name as provided in field "2".

Prepare 100 Percent BOM and BOP


Web Service to Create CCObject

As an alternative to the workflow also a web service can be called to create a CCObject and trigger thedownload of the 100% skeleton. This may be especially be helpful when T4S, CLM4S and SAP are notavailable and an ERP system has to be emulated.

Caution:

This web service is delivered on an as-is basis. It may change in the future breaking compatibilitywith this version and in its current version it has some drawbacks: The JSON payload contains anembedded JSON that has to be escaped in a non-intuitive way. It is not capable to attach aTeamcenter variant rule, so no options and variants can be used.

The endpoint has to be configured in SIMATIC IT UA DM (or any other system) as follows:

http://{{CLM4TGSInstance}}:11301/updateWorkOrderCC

Request-Example:

{ "OrderID": "OrderForMultiSITTest", "RoutingUID": "68665674374D74306F24244E4644", "TargetProductUID": "78665174374D74306F24244E4644", "Enterprise": "Factory1", "ConfigurationParameter": "{\\\"EffectivityUnit\\\": \\\"1\\\",\\\"EffectivityParams\\\": [{\\\"Name\\\": \\\"ID\\\", \\\"Value\\\": \\\"50076677\\\"}]}"}

Field Type Description

OrderID String CCObject name

RoutingUID String BOP header tag

TargetProductUID String BPM header tag

Enterprise String Enterprise from SIMATIC IT UA DM

ConfigurationParameter String Parameters in JSON (escaped string)

Success-Response:

HTTP/1.1 200 OK{ "status": "OK", "message": "Import job (ID 596d2a2f5bed28f3926261e8) was created"}

Error-Response:



HTTP/1.1 500 { "status": "ERROR", "message": "The job cannot be created."}

Transfer 100 Percent BOM and BOP to SAP

The capability to transfer the 100% structures to SAP is supported by theCLM_Release_100PerCent_Structures_SAPOnly workflow. The workflow uses standard T4Sfunctionality only and is therefore not described in detail here.

First, search and identify the CCObject containing the 100% configuration in Teamcenter. The demotemplate contains the saved query CLM4TFindCCObjectByName, so that you can easily find the 100%CCObject (e.g. the one created in the previous step).

At the end of the transfer, CLM4T will store the mapping between SAP and Teamcenter by using the SAPconcatenated object's Ids as a key and the Teamcenter CCObject UID hex encoded as a value for thecurrent transfer.

set IDMappingKey [::CLM4S::IDMAPPING::buildConfigurationIDKey \ $Info(InternalMaterialNumber) $Info(PlantId) $GroupId $GroupCounter \ $Info(ProductionVersion)]set IDMappingValue [tpco_scanHEX16 $Info(CCObjectTag)]

This is necessary to provide the information originating from Teamcenter for later processing it duringorder download and confirmation, as implemented e.g. in the SIMATIC IT UA DM Gateway for SAP S/4HANA.

Transfer 100 Percent BOP to SIMATIC IT UA DM

The transfer of the 100 Percent BOP to SIMATIC IT UA DM usually gets triggered by SIMATIC IT UA DM bycalling the web API published on the CLM4T GS instance. The endpoint has to be configured in SIMATICIT UA DM configuration keys in the section "CLM4T Integration" as follows:

http://{{CLM4TGSInstance}}:11301/triggerSkeletonTransferService

Request-Example:

{ "PBOPIdentID": "77776274655057304a4569394d42", "Enterprise": "Factory1"}

Transfer 100 Percent BOM and BOP to SAP



PBOPIdentID String CCObject unique Id from Teamcenter

Enterprise String Enterprise from SIMATIC IT UA DM

Success-Response:

HTTP/1.1 200 OK{ "JobID": "77776274655057304a4569394d4241414141414141414141414141", "status": "OK", "message": "Skeleton export workflow created"}

Error-Response:

HTTP/1.1 500 { "status": "ERROR", "message": "Skeleton export workflow creation failed!"}

Please read more about the SIMATIC IT UA DM AsPlannedBoP.

The transfer can also be triggered by manually starting the workflow"CLM_Release_100PerCent_Structures_SITOnly" on a configured 100% CCObject as created using theprocedure described in Prepare 100 Percent BOM and BOP.

SIMATIC IT UA DM AsPlannedBoP

The SIMATIC IT UA DM AsPlannedBoP is represented in Teamcenter as configured structure saved asCCObject.

The SIMATIC IT UA DM AsPlannedBoP contains the information about the dependencies betweenSIMATIC IT UA DM Operations. It will be used to create a Work Order. The Work Order Header based onthe production order from the ERP system will be merged with the linked objects. The Work Order thenrefers to the SIMATIC IT UA DM AsPlannedBoP, which will be validated.

If SIMATIC IT UA DM AsPlannedBoP already exists in SIMATIC IT UA DM and is up-to-date, the SIMATIC ITUA DM Work Order can be executed and is visible for the operator. Otherwise SIMATIC IT UA DMautomatically triggers an event to download the SIMATIC IT UA DM AsPlannedBoP from Teamcenter (seeTransfer 100 Percent BOP).

Creating the SIMATIC IT UA DM AsPlannedBoP requires a sequence of API calls that link and associate thepreviously created catalogue objects. Finally if everything worked well, CLM4T issues a "PLMSubmit"command. If any error occurred (either on CLM4T side or reported as a result of a web service call toSIMATIC IT UA DM), CLM4T will try to issue a "PLMRollback" command to revert all changes.



The functionality is implemented by thenamepsace ::CLM4T::PLMXML::OBJECT::CUSTOM::MAPPING in <T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_plmxml_routing_mapping.sd. This mapping file uses PLMXML to extractthe necessary information in procedure PLMXML_Data2EA_Object and transform it into a set ofdictionaries which will then be send to SIMATIC IT UA DM commands in performEATransfer. Thismapping is usually called from the workflow CLM_Release_100PerCent_Structures_SITOnlyafter having created a Teamcenter AI object containing the PLMXML file content.


SIMATIC IT UA DM PLMCreateAsPlannedBoP

PLMCreateStepMaterialSpecificationFullList

PLMCreateStepToolSpecificationFullList

PLMLinkOperationToStepFullList

PLMCreateStepDependencyList

PLMCreateOperationEquipmentSpecLocationFullList

PLMCreateOperationMaterialSpecificationFullList

PLMCreateOperationToolSpecificationFullList

PLMLinkProcessToOperationFullList

PLMCreateOpDependencyList

PLMSubmit

PLMRollback

SIMATIC IT UA DM AsPlannedBoP


6. UADM and ERP interaction

Create WorkOrderHeader in SIMATIC IT UA DM

Caution:

This chapter is valid only for Teamcenter, ERP and SIMATIC IT UA DM integration scenarios. It doesnot apply for ERP and SIMATIC IT UA DM only integration scenarios.

The capability to create a WorkOrderHeader in SIMATIC IT UA DM based on the production order fromthe ERP system. According to the demo scenario, the following steps are required:

• Configure T4S or T4S4 to maintain the Z-Table and implement the creation of the PROD_ORDER entry(stands for Production Order) in Z-Table. This can be done for example on release or save ProductionOrder user exits.

• Start trigger script called "MOM Service Start PO Import Trigger" in the CLM4T GS Admin UI to checkthe Z-Table for the created Production Order. Learn more about the Script-based (scheduled)Triggers in the Teamcenter Gateway - Generic Configuration Guide.

• Create a production order in SAP.

Caution:

To create a Production Order in SAP use only MaterialMaster and Plant transferred fromTeamcenter to SAP and SIMATIC IT UA DM and Production Version created by CLM4T fromTeamcenter.

For the implementation mapping details you can take a closer look at <T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_work_order_header_steps.sd. Please note that the mapping contains socalled steps. The list of steps ProdOrderStepsCustom can be extended.

Moreover remember, that the enrichWithTCData step requires the data synchronization during 100Percent transfer to SAP, in particular byinvoking ::CLM4S::IDMAPPING::buildConfigurationIDKeyor ::CLM4S::IDMAPPING::readMapping to get the linkage between Teamcenter configurationparameters and SAP.

Important: The enrichmentList must be executed before mapProdOrder2WorkOrderHeader step,i.e. prepare the data for the transferring.

And finally the execution of the callSITCreateWorkOrderHeader step to post the payload with acommand named PLMCreateWorkOrderHeader.




SIMATIC IT UA DM PLMCreateWorkOrderHeader

SAP BAPI_PRODORD_GET_DETAIL

Create Confirmation in ERP

Create Confirmation in ERP is the capability to send a confirmation about completion from the SIMATICIT UA DM Operator Landing Page to ERP system.

Caution:

This chapter is valid only for Teamcenter, ERP and SIMATIC IT UA DM integration scenarios. It doesnot apply for Teamcenter and SIMATIC IT UA DM only integration scenarios. The following featuresare shipped with CLM4S and not with CLM4T.

By default, you can decide either to send the confirmation by each of the Work Order Operations or onlyby completion of the whole Work Order in SIMATIC IT UA DM. In case, if a component in SAP has abackflash flag, CLM4S does not transfer any data from SIMATIC IT UA DM and uses only proposal datafrom SAP.

If you use components with serial number without backflash in SAP, the dictionary keyProdOrderConf:GOODSMOVEMENTS:SERIALNO_AUTO_NUMBERASSIGNMENT:$index has to bechanged to "X". This means again that SAP assigns serial number automatically, regardless from inputsin SIMATIC IT UA DM. In contrast to serial number, by using components with batchId CLM4S is able totransfer the batchId value from SIMATIC IT UA DM as shown in the following example (backflash is notset in SAP ).

set SITMaterialItemValue [dict get $SITODATADictConsumedMat\MaterialItem BatchId]if {$SITMaterialItemValue ne "null"} { dict set res ProdOrderConf:GOODSMOVEMENTS:BATCH:$index\ $SITMaterialItemValue} else { dict set res\ ProdOrderConf:GOODSMOVEMENTS:SERIALNO_AUTO_NUMBERASSIGNMENT:$index ""}

Note that the current mapping supports either serial number auto assignment or batch numberassignment, but not both at the same time.

• If the execution of the SIMATIC IT UA DM Work Order Operation is completed, SIMATIC IT UA DM sendsa signal to trigger confirmation for the corresponding operation in the production order. Add the URLas followed (please adapt the <GSInstance>):http://<GSInstance>:11301/pxml/createProdOrderOperationConfAsync.Request-Example:{ "orderId": "000100004298", "Enterprise": "Factory1" }




orderId String Production order unique ID from SAP with leading zeroes will be used for SAP BAPIcall.

Enterprise String Enterprise from SIMATIC IT UA DM.

Success-Response:

HTTP/1.1 200 OK{ "status": "QUEUED", "message": "9bba11525aec537240317d57"}

Error-Response:

HTTP/1.1 500 Internal Server Error{ "status": "ERROR", "message": "The job cannot be created"}

The Web API above calls the following BAPI's:



BAPI_PRODORDCONF_GET_HDR_PROP

BAPI_PRODORDCONF_CREATE_HDR

OData query to retrieve the data for the given Work Order and Work Order Operation:


SIMATIC IT UA DM WorkOrder?$expand=ProductionType($select=NId),WorkOrderOperations($filter=Sequence%20eq%20'0010')&$filter=NId%20eq%20'000100001234'

OData query to retrieve the ActualConsumedMaterials data for the given WorkOperationNId:


SIMATIC IT UA DM WorkOrderOperation?$expand=ActualConsumedMaterials($expand=MaterialItem,ToBeConsumedMaterial($expand=MaterialDefinition))&$filter=NId%20eq%20'34059838-8fb8-4b7e-9c1b-8d9f14b54426'



• If the execution of the SIMATIC IT UA DM Work Order is completed, SIMATIC IT UA DM sends a signalto trigger confirmation for the entire production order in ERP system by calling the web API in CLM4S:http://<GSInstance>:11301/pxml/createProdOrderConfAsync.Request-Example for SAP and SIMATIC IT UA DM integration scenarios only:

{ "confirmationId": "000000014298", "Enterprise": "Factory1"}

Request-Example for Teamcenter, SAP and SIMATIC IT UA DM integration scenarios:

{ "orderId": "000100004298", "operationId": "0040", "Enterprise": "Factory1"}


orderId String Production order unique ID from SAP.

operationId String Occurrence ID tag from Teamcenter hex- encoded, CLM4T and CLM4Sintegration scenario only.

confirmationId String Confirmation ID from SAP for operation, CLM4S standalone integrationscenario only.


Success-Response:

HTTP/1.1 200 OK{ "status": "QUEUED", "message": "9bba11525aec537240317d67"}

Error-Response:


The web API must be configured in SIMATIC IT UA DM configuration keys in the section "CLM4TIntegration" accordingly.The payload for this API consists only of orderId and Enterprise for the completed SIMATIC IT UADM Work Order. For the Work Order Operation operationId is the additional attribute in the



payload. The data for the Work Order or Work Order Operation will be retrieved from SIMATIC IT UADM in the step getWorkOrderExecutionData via an OData query. For more details please take alook at <T4x_GS_ROOT>/var/mmap/clm4s_mapping_config/clm4s_operation_conf_config.sd foroperation confirmation and <T4x_GS_ROOT>/var/mmap/clm4s_mapping_config/clm4s_production_order_conf_config.sd for production order.If the backflash flag is enabled for the component in SAP, CLM4S sends the confirmation usingproposal data from SAP otherwise CLM4S retrieves the ActualConsumedMaterials from SIMATICIT UA DM and sends it to SAP instead of proposal for values.The Web API above calls the following BAPI's:



BAPI_PRODORDCONF_GET_TT_PROP

BAPI_PRODORDCONF_CREATE_TT

• OData query to retrieve the ActualConsumedMaterials data for the given WorkOperationNId:


SIMATIC IT UA DM WorkOrder?$expand=ParentOrder($select=NId),ProducedMaterialItems($expand=MaterialItem),FinalMaterial,ProductionType($select=NId),WorkOrderOperations($expand=ActualConsumedMaterials($expand=MaterialItem,ToBeConsumedMaterial($expand=MaterialDefinition)))&$filter=NId%20eq%20'000100001234'



7. SIMATIC IT UA DM Non-ConformanceNotification

Import Non-Conformance Notification

The capability to transfer the SIMATIC IT UA DM Non-Conformance Notification (NCN) to Teamcenter isbased on the Problem Report (PR). According to the demo scenario, the operator can rise a SIMATIC ITUA DM NCN during the execution of the operation in shop floor, might attach documents and save it. Inthe next step, the foreman as a SIMATIC IT UA DM user can send the SIMATIC IT UA DM NCN toTeamcenter by changing the status to NOTIFYING-ENGINEERING-ISSUE. As a result, the SIMATIC ITUA DM triggers an event to send the NCN by posting on the preconfigured endpoint in CLM4T:

http://<CLM4TGSInstance>:11301/pxml/updateIssueReport

Request-Example:

{ "NonConformanceID": "NCN-123", "Enterprise": "Factory1"}


NonConformanceID String NCN unique Id from SIMATIC IT UA DM.


Success-Response:

HTTP/1.1 200 OK { "JobID": "9bba11525aec537240317d57", "NonConformanceID": "NCN-123", "ProblemReportUID": "426C5270505841766F4C61696343", "completed": true, "status": "OK", "message": "Problem report was successfully created" }

Error-Response:



CLM4T creates the import job to create a PR. Please note that you have the possibility to configure in<T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_custom_parameter.sd a differentcorresponding object like Issue Report (IR) by changing as followed:

variable IssueReportType IssueReportvariable IssueReportRevision Avariable ReferenceFolder CMReferences

You can change the default IssueReportRevision or the corresponding ReferenceFolder aswell.

Explore in more detail <T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_issuereport_import_mapping.sd especially the implementation of the functionImportIssueReport. The current mapping executes the following steps:

• Create object.

• Get data for SIMATIC IT UA DM NCN by calling OData query.

• Download files (if needed).

• Associate objects to the preconfigured reference folder.

After the job execution, CLM4T sends the notification to SIMATIC IT UA DM in case if the job executedcorrectly, SIMATIC IT UA DM NCN status is updated to NOTIDIED-ENGINEERING-ISSUE.

Maintain Non-Conformance Notification Objects

The maintained fields are configured in the ImportIssueReport function in the mapping file<T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_issuereport_import_mapping.sd. Please notethat every object exposed from the OData query from SIMATIC IT UA DM has to be exist in Teamcenter.

OData query to retrieve details for Non-Conformance Notification (NCN)


SIMATIC IT UA DM NonConformance?$filter=NId%20eq%20'NCN-123'&$expand=WorkOrder($expand=FinalMaterial),WorkOrderOperation

OData query for attachments

7. SIMATIC IT UA DM Non-Conformance Notification



SIMATIC IT UA DM NonConformanceHistory?$filter=NonConformance%20eq%20'NCN-123'&$expand=Attachments($expand=Document)

The function getObjectAndAttach seeks for the object and attaches to the just created PR. Thedownload of the files attached to the SIMATIC IT UA DM NCN will be started at the end of the procedure.

Maintain Non-Conformance Notification Objects


7. SIMATIC IT UA DM Non-Conformance Notification


8. Dataview

Dataview Configuration

The CLM4T Dataview extension for the Teamcenter RAC needs no configuration once the demotemplate is installed. However, if you want to change the mapping or add a new field, please learn firstabout how to configure the Dataview in the Teamcenter Gateway - Generic Configuration Guide.

<T4x_GS_ROOT>/var/mmap/clm4t_mapping_config/clm4t_prop_mapping.sd includes all functionsrelated to the Dataview handling.

OData query to retrieve data for the given PBOPIdentID by clicking on MECollaborationContextin Teamcenter


SIMATIC IT UA DM WorkOrder?$filter=PBOPIdentID%20eq%20'524F6174356A5F584A4569394D42'

OData query to retrieve the data for the given ERPOrder by clicking on ProblemReportRevision inTeamcenter


SIMATIC IT UA DM WorkOrder?$filter=ERPOrder%20eq%20'NCN-123'



8. Dataview


A. CLM4T Glossary Topic

<

<T4x_GS_ROOT>The installation directory of the Gateway Service (e.g. C:\Siemens\GS).

A

Admin UITeamcenter Gateway Administrative User Interface.

B

BGSBasic Gateway Service.

BOMA Bill Of Materials is a list of the parts or components and their quantities that are required to build aproduct.

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

D

DCDData Collection Definition

G

GSGateway Service, manages the communication between Enterprise Applications.

SIMATIC IT UA DM Gateway for Teamcenter Configuration Guide A-1© 2018 Siemens Product Lifecycle Management Software, Inc.

GUIGraphical user interface.

N

NCNNon-Conformace Notification

T

TEMTeamcenter Environment Manager.

U

URLUnified Resource Locator: a string with a certain format, allowing to load a resource from a network.URLs are a specific form or URNs.

Z

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. CLM4T Glossary Topic

A-2 SIMATIC IT UA DM Gateway for Teamcenter Configuration Guide© 2018 Siemens Product Lifecycle Management Software, Inc.

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, a business unit ofthe Siemens Industry Automation Division,is a leading global provider of productlifecycle management (PLM) software andservices with 7 million licensed seats and71,000 customers worldwide.Headquartered in Plano, Texas, SiemensPLM Software works collaboratively withcompanies to deliver open solutions thathelp them turn more ideas into successfulproducts. For more information onSiemens PLM Software products andservices, visit www.siemens.com/plm.

© 2018 Siemens Product LifecycleManagement Software Inc. Siemens, theSiemens logo 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 Product Lifecycle ManagementSoftware Inc. or its subsidiaries in theUnited States and in other countries. Allother trademarks, registered trademarks orservice marks belong to their respectiveholders.