Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "Configuring the Connection to Teamcenter with Teamcenter Connector 2506.0.0 and Below"
linktitle: "Connecting with Teamcenter Connector 2506.0.0 and Below"
linktitle: "Teamcenter Connector 2506.0.0 and Below"
url: /appstore/modules/siemens-plm/configuring-connection-2506/
weight: 3
weight: 4
description: "Describes the steps to configure the connection to your Teamcenter instance using Teamcenter Connector 2506.0.0 and below."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Configuring the Connection to Teamcenter"
url: /appstore/modules/siemens-plm/configuring-connection/
weight: 4
weight: 10
description: "Describes the connection configuration steps for Teamcenter."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Configuring the Connection to Teamcenter X"
url: /appstore/modules/siemens-plm/teamcenterx/
weight: 5
weight: 20
description: "Describes the steps to connect to Teamcenter X."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Upgrading Teamcenter Connector 2506.0.0 to 2512.0.0"
url: /appstore/industry/teamcenter-connector/upgrade-teamcenter-connector-2506-to-2512/
weight: 4
weight: 30
description: "Describes the steps to upgrade Teamcenter Connector 2506.0.0 to 2512.0.0 and discusses how breaking changes can be resolved."
aliases:
- /appstore/modules/siemens-plm/upgrade-teamcenter-connector-2506-to-2512/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "Configuring the Connection to Teamcenter with Teamcenter Connector 2512.0.0 and Above"
linktitle: "Connecting with Teamcenter Connector 2512.0.0 and Above"
linktitle: "Teamcenter Connector 2512.0.0 and Above"
url: /appstore/industry/teamcenter-connector/configuring-connection-2512/
weight: 2
weight: 3
description: "Describes the steps to configure the connection to your Teamcenter instance using Teamcenter Connector 2512.0.0 and above."
aliases:
- /appstore/modules/siemens-plm/configuring-connection-2512/
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
title: "Teamcenter Connector 2606"
url: /appstore/industry/teamcenter-connector/teamcenter-connector-2606/
weight: 2
description: "Describes Teamcenter Connector 2606, a unified Mendix Marketplace module for integrating Mendix with Teamcenter."
---

## Introduction

Teamcenter Connector 2606 is a unified Mendix Marketplace module that brings together everything you need to integrate Mendix with Teamcenter. It combines what were previously two separate Marketplace modules, Teamcenter Connector and Teamcenter Extension, with Teamcenter Extension containing two modules, Teamcenter Toolkit and the Extension add-on. Teamcenter Connector 2606 is a streamlined package that works seamlessly with Mendix 11.12 and above.

Teamcenter Extension has been rebuilt using the Web Extensibility Framework and is available as a Teamcenter service document. A Teamcenter service document is a container that you can create on a per-module basis. It stores everything related to your Teamcenter integrations within a specific module.

In previous versions, the Teamcenter Extension stored integrations and configurations on disk, in the resources folder, separate from your Mendix app. This made version control difficult and team collaboration more complex. With a Teamcenter service document, everything is stored inside the Mendix model, just like microflows, pages, and domain models. This means:

* Your integrations travel with your module when you export it or commit it to version control.
* You can have different Teamcenter service documents for different purposes within the same app.
* You can have different Teamcenter service documents for different Teamcenter instances, such as for test and production.

### Architecture Overview

The following diagram shows how all the pieces fit together:

```
Studio Pro 11.12+
├── Teamcenter service document ← stores integrations + connection settings
│ └── Extension UI (TypeScript / Web Extensibility Framework)
│ ├── Settings Tab
│ ├── Integrations Tab
│ ├── Integration Mapping Editor
│ └── Integration Configuration Dialogs
├── Generated Artifacts (per module)
│ ├── Domain Model (entities, associations, specializations)
│ └── Microflows (search, create, update, revise, get, relate, BOM)
└── TcConnector module (runtime — includes former Toolkit)
├── Published Microflows (Toolbox) [Published — Teamcenter icon]
├── Java Actions (Toolbox) [Published — Teamcenter icon]
├── Internal Actions [Private — no icon]
├── TcConnector Domain Model (base entities, BOMLine, search criteria)
├── CallTeamcenterService (custom SOA calls)
└── Authentication (Credentials / TcSSO / TcX SSO)
Teamcenter SOA Layer
(self-hosted v2506+ / Teamcenter X v2506+)
```

## How It Works

These steps describe how Teamcenter Connector 2606 works in a nutshell:

1. You start by creating a Teamcenter service document, where you configure your Teamcenter connection and create integrations.
2. The Teamcenter service document generates domain model entities and microflows specific to your integration needs, placing them directly in your module.
3. The generated microflows use predefined Teamcenter connector microflows for the integration with Teamcenter, using the TcConnector Java Actions to call Teamcenter's SOA layer.

## Prerequisites and Compatibility

Before working with Teamcenter Connector 2606, make sure your environment meets these requirements:

| Requirement | Supported versions |
| --- | --- |
| Mendix Studio Pro | 11.12.1 and above |
| Teamcenter (self-hosted) | 2606, 2512, 2506 |
| Teamcenter X | 2606, 2512, 2506 |

### Required Marketplace Modules

* Community Commons
* Encryption
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
---
title: "Getting Started with Teamcenter Connector 2606"
linktitle: "Getting Started"
url: /appstore/industry/teamcenter-connector/teamcenter-connector-2606-getting-started/
weight: 10
description: "Describes how to install, configure, and build your first Teamcenter Connector 2606 integration in Mendix Studio Pro, including setup, security, connection settings, and generating microflows and entities from a Teamcenter service document."
---

## Installation and Setup

Follow these steps to install and set up Teamcenter Connector 2606:

1. Download the module from Mendix Marketplace and import it in Studio Pro 11.12.
You do not need to download Teamcenter Extension separately, since it is already included.

2. Add the required dependencies. Make sure your app includes Community Commons and the Encryption module. These are both available in Mendix Marketplace.

3. Configure security:

1. Assign the `TcConnector.User` role to the relevant user roles in your app's security settings.
{{% alert color="info" %}} The **Administrator** role now only has access to `TcConnector.TeamcenterConfiguration`. For all integration work, use the **User** role. {{% /alert %}}
2. Click **Update Security** in Studio Pro to refresh entity access rules.

4. Enable the React client from your app settings. This is required for the Teamcenter service document to work properly.

## Contents of a Teamcenter Service Document

These are the details included in a Teamcenter service document:

* **Settings** – Configure the following:

* The connection to your Teamcenter instance. This is required so the Teamcenter service document can communicate with Teamcenter to retrieve business objects and properties, which allow you to build artifacts per your use case.
* Your authentication method, test the connection, and manage the sign-in state. You typically configure this once per Teamcenter service document, unless you need to switch environments.

{{< figure src="/attachments/appstore/industry-components/teamcenter/teamcenter2606/service-document-settings.png" alt="Settings tab of the Teamcenter service document" max-width=70% >}}

* **Integrations** – View and manage integrations:

* Check out an overview of all the integrations you have configured in this document.
* Check out the Teamcenter integration type, the entities and microflows that were generated, and when each integration was last modified. From here, you can:

* View the details of an integration.
* Edit an existing integration.
* Duplicate an integration. This is useful for creating variations.
* Delete integrations you no longer need.
* Navigate directly to the generated microflows and entities by double-clicking them.

* Add new integrations.

{{< figure src="/attachments/appstore/industry-components/teamcenter/teamcenter2606/service-document-integrations.png" alt="Integrations tab of the Teamcenter service document" max-width=100% >}}

You can have multiple Teamcenter service documents in a single app, each in its own module. This is useful for separating concerns. For example:

* A **Parts** module with a Teamcenter service document for part-related integrations.
* A **Workflows** module with a Teamcenter service document for workflow-related integrations.
* A **Documents** module with a Teamcenter service document for dataset and document integrations.

## Creating and Building a Teamcenter Service Document

The following steps walk you through creating and building a Teamcenter service document.

1. Create a Teamcenter service.

1. In the App Explorer, right-click the module where you want to create your integrations.
2. Select **Add other**, then select **Teamcenter service**.
3. Give the Teamcenter service a name, such as "PartsIntegrations" or "MainTeamcenterConnection".

1. Configure your connection.

1. Navigate to the **Settings** tab of the Teamcenter service document.
2. Provide your Teamcenter authentication option and credentials. For details, refer to the [Settings tab](/appstore/industry/teamcenter-extension/create-an-integration/#settings-tab) section of the Teamcenter Extension *Creating an Integration* page.

1. Test your connection.
Once you have entered your connection details, click **Sign In** to test the connection.
{{% alert color="warning" %}} The Teamcenter service document automatically clears your sign-in state when you edit or reset connection details. This is a security feature to ensure you are always using the correct credentials with the correct Teamcenter environment. {{% /alert %}}

1. Add your Teamcenter integration.

1. Click the **Integrations** tab at the top.
2. Click **Add integration**. Tiles representing all available integration types are displayed, such as **Search Item Revisions** and **Create Item with Item Revision**.
3. Click one of the integration type tiles to start configuring that specific type of integration. The **Object Mapping** page is displayed.

1. Fill in the required information on the **Object Mapping** page:

{{< figure src="/attachments/appstore/industry-components/teamcenter/teamcenter2606/object-mapping.png" alt="Object Mapping window" max-width=80% >}}

1. Teamcenter objects

1. Browse the Teamcenter object hierarchy.
2. Select the business object type you want to work with, such as **Item Revision** or **Dataset**.

2. Mendix entities

1. Choose whether to create a new entity or use an existing one.
If you create a new entity, the Teamcenter service generates an entity that is a specialization of the selected entity.
If you use an existing entity, you can select an entity you have already defined in your domain model.
2. When you are done, click **Select** to proceed.

3. Additional properties
Once you have selected the Teamcenter object type and Mendix entity, you can add additional properties, references, and relations to the list of default selected properties. Follow these steps:

1. Double-click the entity or select an entity and click **Select Elements** at the top.
2. Use the checkboxes to indicate:

* **Read** — Should this property be retrieved from Teamcenter?

Check failure on line 105 in content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2606-configuration/getting-started.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Mendix.Dashes] Remove spaces around the em dash (—). Or, to set off a list item intro or number range, use an en dash (–) instead. Raw Output: {"message": "[Mendix.Dashes] Remove spaces around the em dash (—). Or, to set off a list item intro or number range, use an en dash (–) instead.", "location": {"path": "content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2606-configuration/getting-started.md", "range": {"start": {"line": 105, "column": 19}}}, "severity": "ERROR"}
* **Write** — Should this property be sent to Teamcenter when creating or updating? Write checkboxes are only available in integrations where you can write data to Teamcenter.

Check failure on line 106 in content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2606-configuration/getting-started.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Mendix.Dashes] Remove spaces around the em dash (—). Or, to set off a list item intro or number range, use an en dash (–) instead. Raw Output: {"message": "[Mendix.Dashes] Remove spaces around the em dash (—). Or, to set off a list item intro or number range, use an en dash (–) instead.", "location": {"path": "content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2606-configuration/getting-started.md", "range": {"start": {"line": 106, "column": 20}}}, "severity": "ERROR"}

3. From the **Property Mapping** window, select the properties you need for your integration.

{{< figure src="/attachments/appstore/industry-components/teamcenter/teamcenter2606/property-mapping.png" alt="Property Mapping window" max-width=80% >}}

4. Teamcenter integration-specific panels
Depending on the integration type you choose, an additional configuration dialog window may be displayed. For example:

* Dataset integrations let you filter by dataset type.
* BOM integrations let you configure BOM window properties and revision rules.

Configure these integration-specific settings as needed.
For more information on each of the Teamcenter integrations, refer to the [integration guides](/appstore/modules/siemens-plm/teamcenter-extension/create-an-integration/integrations/).

1. Generate your integration.
Once you have configured everything, click **Generate**. The Teamcenter service document performs the following actions:

* Validates your integration to make sure everything is correct.
* Generates domain model entities, which are placed in your domain model as a tree for easy visualization.
* Generates microflows that implement the integration logic.
* Saves the integration to the Teamcenter service document.
* Navigates to the **Integrations** tab where the integration is now listed.

1. Explore the results.
Once the Teamcenter service document is fully generated, you are automatically returned to the **Integrations** tab. You can find your newly created integration in the list, along with links to:

* The generated microflows. Double-click to jump directly to them in Studio Pro. Double-click a microflow name to open it in Studio Pro, and see what exactly was generated.
* The generated entities. Double-click to jump directly to the domain model.

{{< figure src="/attachments/appstore/industry-components/teamcenter/teamcenter2606/integrations-result.png" alt="Results displayed on the Integration tab of the Teamcenter service window" max-width=100% >}}
Loading