diff --git a/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2506-configuration/_index.md b/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2506-configuration/_index.md index 46f2f4ee8d0..b9a6b5f4b5c 100644 --- a/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2506-configuration/_index.md +++ b/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2506-configuration/_index.md @@ -1,14 +1,16 @@ --- title: "Configuring the Connection to Teamcenter with Teamcenter Connector 2506.0.0 and Below" -linktitle: "Connecting with Teamcenter Connector 2506.0.0 and Below" -url: /appstore/modules/siemens-plm/configuring-connection-2506/ -weight: 3 +linktitle: "Teamcenter Connector 2506.0.0 and Below" +url: /appstore/industry/teamcenter-connector/configuring-connection-2506/ +weight: 4 description: "Describes the steps to configure the connection to your Teamcenter instance using Teamcenter Connector 2506.0.0 and below." +aliases: + - /appstore/modules/siemens-plm/configuring-connection-2506/ --- The following pages describe the steps needed to configure the connection between your Mendix app and your Teamcenter instance using Teamcenter Connector 2506.0.0 and below: -* [Configuring the Connection to Teamcenter](/appstore/modules/siemens-plm/configuring-connection/) -* [Configuring the Connection to Teamcenter X](/appstore/modules/siemens-plm/teamcenterx/) +* [Configuring the Connection to Teamcenter](/appstore/industry/teamcenter-connector/configuring-connection/) +* [Configuring the Connection to Teamcenter X](/appstore/industry/teamcenter-connector/teamcenterx/) For information applying to Teamcenter Connector 2512.0.0 and above, refer to [Configuring the Connection to Teamcenter 2512.0.0 and Above](//appstore/industry/teamcenter-connector/configuring-connection-2512/). diff --git a/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2506-configuration/configuring-connection.md b/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2506-configuration/configuring-connection.md index 469c9415b57..e689869cef3 100644 --- a/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2506-configuration/configuring-connection.md +++ b/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2506-configuration/configuring-connection.md @@ -1,8 +1,10 @@ --- title: "Configuring the Connection to Teamcenter" -url: /appstore/modules/siemens-plm/configuring-connection/ -weight: 4 +url: /appstore/industry/teamcenter-connector/configuring-connection/ +weight: 10 description: "Describes the connection configuration steps for Teamcenter." +aliases: + - /appstore/modules/siemens-plm/configuring-connection/ --- {{% alert color="info" %}} This page describes the steps needed to configure the connection between your Mendix app and your Teamcenter instance using Teamcenter Connector 2506.0.0 and below. For information applying to Teamcenter Connector 2512.0.0 and above, refer to [Configuring the Connection to Teamcenter with Teamcenter Connector 2512.0.0 and Above](/appstore/industry/teamcenter-connector/configuring-connection-2512/). {{% /alert %}} diff --git a/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2506-configuration/teamcenterx.md b/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2506-configuration/teamcenterx.md index e7ab17b4cb0..ff19b45610f 100644 --- a/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2506-configuration/teamcenterx.md +++ b/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2506-configuration/teamcenterx.md @@ -1,8 +1,10 @@ --- title: "Configuring the Connection to Teamcenter X" -url: /appstore/modules/siemens-plm/teamcenterx/ -weight: 5 +url: /appstore/industry/teamcenter-connector/teamcenterx/ +weight: 20 description: "Describes the steps to connect to Teamcenter X." +aliases: + - /appstore/modules/siemens-plm/teamcenterx/ --- {{% alert color="info" %}} This page describes the steps needed to configure the connection between your Mendix app and your TeamcenterX instance using Teamcenter Connector 2506.0.0 and below. For information applying to Teamcenter Connector 2512.0.0 and above, refer to [Configuring the Connection to Teamcenter with Teamcenter Connector 2512.0.0 and Above](/appstore/industry/teamcenter-connector/configuring-connection-2512/). {{% /alert %}} diff --git a/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/upgrading-2506-to-2512.md b/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2506-configuration/upgrading-2506-to-2512.md similarity index 99% rename from content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/upgrading-2506-to-2512.md rename to content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2506-configuration/upgrading-2506-to-2512.md index 80b1babf205..ac18c970be3 100644 --- a/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/upgrading-2506-to-2512.md +++ b/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2506-configuration/upgrading-2506-to-2512.md @@ -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/ diff --git a/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/teamcenter-configuration-guide.md b/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2512-configuration.md similarity index 98% rename from content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/teamcenter-configuration-guide.md rename to content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2512-configuration.md index 18f4ed60b55..e67ccf3d45d 100644 --- a/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/teamcenter-configuration-guide.md +++ b/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2512-configuration.md @@ -1,14 +1,14 @@ --- 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/ --- -{{% alert color="info" %}} The following page describes the steps needed to configure the connection between your Mendix app and your Teamcenter instance using Teamcenter Connector 2512.0.0 and above. For information applying to Teamcenter Connector 2506.0.0 and below, refer to [Configuring the Connection to Teamcenter 2506.0.0 and Below](/appstore/modules/siemens-plm/configuring-connection-2506/). {{% /alert %}} +{{% alert color="info" %}} The following page describes the steps needed to configure the connection between your Mendix app and your Teamcenter instance using Teamcenter Connector 2512.0.0 and above. For information applying to Teamcenter Connector 2506.0.0 and below, refer to [Configuring the Connection to Teamcenter 2506.0.0 and Below](/appstore/industry/teamcenter-connector/configuring-connection-2506/). {{% /alert %}} ## Connecting your Mendix App to Teamcenter diff --git a/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2606-configuration/_index.md b/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2606-configuration/_index.md new file mode 100644 index 00000000000..44b42acd2af --- /dev/null +++ b/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2606-configuration/_index.md @@ -0,0 +1,72 @@ +--- +title: "Teamcenter Connector 2606" +url: /appstore/industry/teamcenter-connector/unified-teamcenter-connector/ +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 diff --git a/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2606-configuration/getting-started.md b/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2606-configuration/getting-started.md new file mode 100644 index 00000000000..6aec97b7dc5 --- /dev/null +++ b/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2606-configuration/getting-started.md @@ -0,0 +1,136 @@ +--- +title: "Getting Started with Teamcenter Connector 2606" +linktitle: "Getting Started" +url: /appstore/industry/teamcenter-connector/unified-teamcenter-connector-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? + * **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. + + 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/industry/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% >}} diff --git a/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2606-configuration/migrate-to-2606.md b/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2606-configuration/migrate-to-2606.md new file mode 100644 index 00000000000..22d385c42f1 --- /dev/null +++ b/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2606-configuration/migrate-to-2606.md @@ -0,0 +1,158 @@ +--- +title: "Migrating to Teamcenter Connector 2606" +url: /appstore/industry/teamcenter-connector/migrating-to-unified-teamcenter-connector/ +weight: 20 +description: "Describes how to migrate an existing app from Teamcenter Connector 2512 and Extension v4.x to Teamcenter Connector 2606, including pre-migration steps, breaking changes, deprecated microflows, and Java actions." +--- + +## Introduction + +Teamcenter Connector 2606 contains both the Teamcenter Connector and the Teamcenter Extension. From this version onwards, the Teamcenter Extension does not need to be downloaded separately. If you have an existing app using Teamcenter Connector 2512 and the Teamcenter Extension v4.x, you can migrate to version 2606. + +This migration involves some breaking changes, but they are outweighed by the benefits: + +* Unified module +* Modern Extension framework +* Improved security +* Better error handling + +## Pre-Migration Checklist + +Follow these steps carefully to avoid issues: + +1. Upgrade to Studio Pro 11.12.1 or above. If you are using Studio Pro 10, you must upgrade before importing Teamcenter 2606. +2. Have only one developer perform the migration. If multiple developers migrate simultaneously, there will be duplicate artifacts. Coordinate with your team and designate one person to handle the migration, then have others pull the updated code from version control. +3. Migrate from Teamcenter 2512. If the project still contains an older version of the Teamcenter Connector, such as 2506 or older, first follow the steps for [Upgrading Teamcenter Connector 2506.0.0 to 2512.0.0](/appstore/industry/teamcenter-connector/upgrade-teamcenter-connector-2506-to-2512/). +4. Make a backup. Before starting, either create a full backup of your app or commit all current changes to version control. This gives you a safety net in case you need to roll back. + +## Migration Process + +Follow these steps in this exact order to ensure a proper migration: + +1. Prepare your environment. + + 1. Open your app in Studio Pro 11.12.1 or above. + 1. Make sure all changes are committed, if using version control, or backed up. + +2. Move the Toolkit contents to the TcConnector module. + + 1. Remove the old TcConnector module from your project, and ignore the errors for now. + 1. Rename the old TeamcenterToolkit module to TcConnector module, then remove the TeamcenterToolkit module. By doing this, the old Toolkit references in the project are now pointing to the TcConnector module. + {{% alert color="info" %}} This step does not change the BOMapping. This is fixed in a later step. {{% /alert %}} + +3. Import the new connector. + + 1. Remove the TeamcenterExtension module under add-ons, as the old extension is not compatible with version 2606 of the Teamcenter Connector. + 1. Download the Teamcenter Connector 2606 from Mendix Marketplace. This now also contains the new version of the extension. + {{% alert color="info" %}} The Teamcenter Extension is no longer included in Extensions. It is available as a new Service Document, similar to a microflow. You can find it by right-clicking the module, selecting **Add other**, then selecting **Teamcenter service**. {{% /alert %}} + +4. Resolve breaking changes. + + 1. Studio Pro displays errors where your microflows or domain model reference things that have changed. Work through these systematically. + + The most common issues you will encounter are: + + * Errors in microflows that were generated by the Teamcenter Extension can best be recreated by the new version of the extension. Refer to step 9 for details. + * Missing microflows/Java actions can be found in the [Deprecated Microflows and Their Replacements](#deprecated-microflows) and [Deprecated Java Actions and Their Replacements](#deprecated-java) tables. + * References to `TeamcenterToolkit.*` — Change these to `TcConnector.*`, because Toolkit was merged into TcConnector. + * References to `FileType` — Change these to `NamedReference`. + * Microflows that handle the Boolean return value from `Login` — Remove this handling, as `Login` now throws an exception instead. + * Refer to [Breaking Changes](#breaking-changes) on this page. + +5. Update security. + + 1. Click **Update Security** in Studio Pro. + 1. Make sure that all attributes on persistent entities have read rights. The **Administrator** role now only has access to Teamcenter Configuration, so assign the **User** role to module roles that need entity access. + +6. Enable the React client. + + 1. In your App Settings, go to the **Runtime** tab. + 1. Select **Yes** next to **Use React client**. + +7. Create a Teamcenter Service Document. + + 1. In the module where your Teamcenter integrations live, right-click and select **Add others**, then click **Teamcenter Service**. + 1. Give it a name. + +8. Reconfigure your connection. + + 1. Open the Teamcenter Service Document and go to the **Settings** tab. + 1. Enter your Teamcenter URL and authentication settings. + 1. Click **Sign In** and log in to Teamcenter. + +9. Recreate your integrations. + + Your existing domain model entities and microflows are still in your app. However, you need to regenerate them using the new Extension to take advantage of improvements and ensure compatibility with the new connector. To do that, follow these steps: + + 1. In the Service Document, click **+Add integration** and start a journey that matches each of your existing integrations. + 1. Configure the integration the same way as before. The journey types and options are the same. + 1. Click **Generate** to save and generate the integration. + 1. Replace the old microflows with the newly generated microflows. + 1. You can use the **Duplicate** feature on the **History** tab to create variations of an integration without reconfiguring from scratch. + +10. Test thoroughly. + + 1. Run each generated microflow against your Teamcenter instance. + 1. Verify that search, create, update, and retrieval operations work as expected. + 1. Test error handling by triggering error conditions, such as invalid search criteria. + 1. If you have automated tests, run them to ensure integration behavior is correct. + +## Breaking Changes {#breaking-changes} + +This is a comprehensive table of breaking changes and actions to take for each one: + +| Area | Change | Action required | +| --- | --- | --- | +| Teamcenter Toolkit Module | The module was merged into TcConnector. The module no longer exists. | Update all references from `TeamcenterToolkit.*` to `TcConnector.*`. | +| Entity security | The `Create` and `Delete` rights were removed from all entities. | Remove any UI or microflow logic that relied on client-side `Create`/`Delete`. Use microflows instead. | +| Input parameter `ConfigName` renamed to `ConfigurationName` | In generated microflows, the input parameter is now called `ConfigurationName` and is optional. | Set the `ConfigurationName` or leave it empty. | +| Admin role | The **Administrator** no longer has entity access. | Assign the **User** role where needed. | +| `FileType` / `File Type` | This was renamed to `NamedReference` / `Named Reference`. | Update all references in microflows and mappings. | +| `CreateBOMWindow_Generic` | This was moved to TcConnector, and was updated to use `CreateOrReconfigureBOMWindows`. Pre-configured variants were removed. | Regenerate BOM microflows via the Extension or update manually to use `TcConnector.CreateBOMWindow_Generic`. | +| `Login` Java action | No longer returns Boolean. Throws exception on failure. | Remove Boolean result handling and wrap in error handler. | +| `Logout` Java action | Now returns Boolean. | Update callers if return value was previously ignored. | +| Error messages | Connector no longer shows in-app messages. It throws exceptions instead. | Ensure calling microflows have error handlers. | + +## Deprecated Microflows and Their Replacements {#deprecated-microflows} + +These microflows still exist in the deprecated folder, but should no longer be used. Replace them with the recommended alternatives: + +| Deprecated | Replacement | +| --- | --- | +| `AreMultipleTcConfigActive` | No replacement | +| `CloseBOMWindow`| `BOMWindow_Close` | +| `DownloadFile` | `DownloadFile` / `DownloadImage` Java action | +| `ExecuteLogin` | `Login` microflow | +| `ExecuteLogout` | `Logout` microflow | +| `HandleActiveConfigErrors` | No replacement | +| `HandleServiceErrors` | No replacement | +| `RetrieveConfigNameFromSingleActiveConfiguration` | Use `empty` for the `configurationName` parameter in Java actions. Java actions now handle active configuration in the Java code. | +| `RetrieveHttpHeaderList` | No replacement | +| `RetrieveTcSessionBasedOnConfigName` | No replacement. `TcSession` should not be manually consumed. It is automatically handled by the TcConnector module. | +| `RetrieveTeamcenterConifgurationByName` | Use `empty` for the `configurationName` parameter in Java actions. Java actions now handle active configuration in the Java code. | +| `RetrieveTeamcenterConifgurationFromTcSession` | No replacement. `TcSession` should not be manually consumed. It is automatically handled by the TcConnector module. | +| `ShowPartialErrors` | No replacement | +| `UpdateSession` | No replacement | + +## Deprecated Java Actions and Their Replacements {#deprecated-java} + +These Java actions still exist in the deprecated folder, but should no longer be used. Replace them with the recommended alternatives: + +| Java Action | Replacement | +| --- | --- | +| `PerformAction` | `PerformAction3` | +| `GetWorkflowTemplates` | `GetWorkflowTemplates2` | +| `CreateBOMWindows` | `CreateOrReConfigureBOMWindows` | +| `CreateBOMWindows2` | `CreateOrReConfigureBOMWindows` | +| `WhereUsed` | `WhereUsed2` | +| `ExpandPSOneLevel` | `ExpandPSOneLevel2` | +| `GetTcSessionInfo` | `GetTcSessionInformation` | +| `GetItemFromId` | `GetItemAndRelatedObjects` | +| `RetrieveCookie` | No replacement | + +## Automatically Migrated Items + +Not everything needs to be rebuilt from scratch. These items are automatically migrated as they are: + +* Domain model – Entities and associations generated by the previous Extension remain in your module. They are part of your app, so they do not disappear during the migration. +* Microflows – Generated microflows remain in your app. Only those affected by specific breaking changes, such as input entity naming or Toolkit module references, need to be regenerated or updated. diff --git a/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/_index.md b/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/_index.md index a46768d6dfe..b0bfebc8847 100644 --- a/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/_index.md +++ b/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/_index.md @@ -3,7 +3,7 @@ title: "Teamcenter Connector" url: /appstore/industry/teamcenter-connector/ description: "Describes the configuration and usage of the Teamcenter Connector, which allows the digital management of product and manufacturing data in the context of a product lifecycle." aliases: - _ /appstore/modules/siemens-plm/teamcenter-connector/ + - /appstore/modules/siemens-plm/teamcenter-connector/ --- ## Introduction diff --git a/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/designing-applications.md b/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/designing-applications.md index 53077d0f423..4f43f46670b 100644 --- a/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/designing-applications.md +++ b/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/designing-applications.md @@ -37,7 +37,7 @@ Ensure that you perform the following steps when designing your Mendix applicati 4. To create a new Teamcenter configuration, click **New**. {{< figure src="/attachments/partners/siemens/teamcenter/image015.png" alt="" class="no-border" >}} 5. In the **Add Teamcenter Configuration** dialog box, specify the required fields and click **Save**. -6. If you have enabled SSO, ensure that you [specify the SSO information](/appstore/modules/siemens-plm/configuring-connection/#teamcenter-sso). +6. If you have enabled SSO, ensure that you [specify the SSO information](/appstore/industry/teamcenter-connector/configuring-connection/#teamcenter-sso). ### Setting a Teamcenter Configuration as Active diff --git a/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/documentation-references.md b/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/documentation-references.md index 9c9f40a9c6e..33745f7df22 100644 --- a/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/documentation-references.md +++ b/content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/documentation-references.md @@ -11,7 +11,7 @@ aliases: Teamcenter Connector services are provided through JAVA actions. -You can refer to the [Teamcenter Connector Reference](/appstore/modules/siemens-plm/teamcenter-reference/) page. +You can refer to the [Teamcenter Connector Reference](/appstore/industry/teamcenter-connector/teamcenter-reference/) page. ## Generating the SOA API Documentation Used in Active Workspace diff --git a/content/en/docs/refguide/runtime/mendix-client/mendix-inside-teamcenter.md b/content/en/docs/refguide/runtime/mendix-client/mendix-inside-teamcenter.md index cbe0ab8e109..c086781eac8 100644 --- a/content/en/docs/refguide/runtime/mendix-client/mendix-inside-teamcenter.md +++ b/content/en/docs/refguide/runtime/mendix-client/mendix-inside-teamcenter.md @@ -11,14 +11,12 @@ beta: true {{% alert color="info" %}} Mendix inside Teamcenter is available in Mendix version 11.12.0 and above and is currently in public Beta. -The Teamcenter connector version 2606.0.0 is required but is not yet published so this documentation is currently for information purposes only. - See the [prerequisites](#prerequisites) for other version requirements. {{% /alert %}} Mendix inside Teamcenter lets you embed a Mendix web app as a native component inside Siemens Teamcenter Active Workspace. The Mendix app runs directly in the Active Workspace page as a micro-frontend using the [Embedded Client](/refguide/mendix-client/embedding-the-client/) feature. -This integration requires the [Teamcenter Connector](/appstore/modules/siemens-plm/teamcenter-connector/) to connect the Mendix app to Teamcenter data and to handle authentication. +This integration requires the [Teamcenter Connector](/appstore/industry/teamcenter-connector/) to connect the Mendix app to Teamcenter data and to handle authentication. ## Prerequisites {#prerequisites} @@ -233,6 +231,6 @@ For the full `render()` API, see [Embedding the Client](/refguide/mendix-client/ ## Read More * [Embedding the Client](/refguide/mendix-client/embedding-the-client/) -* [Teamcenter Connector](/appstore/modules/siemens-plm/teamcenter-connector/) +* [Teamcenter Connector](/appstore/industry/teamcenter-connector/) * [Setting Up the Navigation Structure](/refguide/setting-up-the-navigation-structure/) * [Configure CORS](/refguide/configure-cors/) diff --git a/static/attachments/appstore/industry-components/teamcenter/teamcenter2606/integrations-result.png b/static/attachments/appstore/industry-components/teamcenter/teamcenter2606/integrations-result.png new file mode 100644 index 00000000000..52459a1d141 Binary files /dev/null and b/static/attachments/appstore/industry-components/teamcenter/teamcenter2606/integrations-result.png differ diff --git a/static/attachments/appstore/industry-components/teamcenter/teamcenter2606/object-mapping.png b/static/attachments/appstore/industry-components/teamcenter/teamcenter2606/object-mapping.png new file mode 100644 index 00000000000..4a6f0454605 Binary files /dev/null and b/static/attachments/appstore/industry-components/teamcenter/teamcenter2606/object-mapping.png differ diff --git a/static/attachments/appstore/industry-components/teamcenter/teamcenter2606/property-mapping.png b/static/attachments/appstore/industry-components/teamcenter/teamcenter2606/property-mapping.png new file mode 100644 index 00000000000..3ec9b3e87cb Binary files /dev/null and b/static/attachments/appstore/industry-components/teamcenter/teamcenter2606/property-mapping.png differ diff --git a/static/attachments/appstore/industry-components/teamcenter/teamcenter2606/service-document-integrations.png b/static/attachments/appstore/industry-components/teamcenter/teamcenter2606/service-document-integrations.png new file mode 100644 index 00000000000..11e88abfe7a Binary files /dev/null and b/static/attachments/appstore/industry-components/teamcenter/teamcenter2606/service-document-integrations.png differ diff --git a/static/attachments/appstore/industry-components/teamcenter/teamcenter2606/service-document-settings.png b/static/attachments/appstore/industry-components/teamcenter/teamcenter2606/service-document-settings.png new file mode 100644 index 00000000000..03b89eb53a3 Binary files /dev/null and b/static/attachments/appstore/industry-components/teamcenter/teamcenter2606/service-document-settings.png differ