Skip to content

Revise migration steps for Teamcenter Connector 2606 #11653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wanchoorohan wants to merge 1 commit into
base: development
Choose a base branch
from
Open

Revise migration steps for Teamcenter Connector 2606 #11653

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
54 changes: 41 additions & 13 deletions ...r/platform-supported/teamcenter-connector/2606-configuration/migrate-to-2606.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,10 @@
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.
2. Remove resource files

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 %}}
1. In your resources folder, remove the `OperationMapping`, `TeamcenterCommon`, `TeamcenterConnector` folders > these have moved to the `TcConnector` folder
1. Keep the `TeamcenterExtension` folder for now, this can be removed once all the journeys are migrated to the new service document

3. Import the new connector.

Expand All @@ -53,11 +52,13 @@
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.
* Missing microflows/Java actions can be found in the deprecated table below.
* Deprecated microflows/java actions can be found in the internal>deprecated folder in the TcConnector module. These microflows are not used by the connector anymore, but you can include them and move them to your own module if needed.

Check failure on line 56 in content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2606-configuration/migrate-to-2606.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Mendix.Capitalization] Use ''Java'' (capitalized)

Raw Output:
{"message": "[Mendix.Capitalization] Use ''Java'' (capitalized)", "location": {"path": "content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2606-configuration/migrate-to-2606.md", "range": {"start": {"line": 56, "column": 33}}}, "severity": "ERROR"}
* References to `TeamcenterToolkit.*` in BO mappings — Change these to `TcConnector.*` (the Toolkit module is merged into TcConnector)

Check failure on line 57 in content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2606-configuration/migrate-to-2606.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/migrate-to-2606.md", "range": {"start": {"line": 57, "column": 61}}}, "severity": "ERROR"}
* 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.
* The `Login` microflow doesn't return a boolean anymore, as `Login` now throws an exception instead

Check failure on line 59 in content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2606-configuration/migrate-to-2606.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Mendix.Capitalization] Use ''Boolean'' (capitalized)

Raw Output:
{"message": "[Mendix.Capitalization] Use ''Boolean'' (capitalized)", "location": {"path": "content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2606-configuration/migrate-to-2606.md", "range": {"start": {"line": 59, "column": 50}}}, "severity": "ERROR"}
* We have deprecated microflows that use the `TcSession` entity, please don't use the `TcSession` entity in your code, if you want to know if someone is logged in please use the `RULE_TeamcenterConfiguration_IsLoggedIn`
* See also the breaking changes reference below

5. Update security.

Expand Down Expand Up @@ -90,12 +91,19 @@
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.
10. Remove the Toolkit module from your project

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.
1. Before removing the Toolkit module, it is a good moment to commit your work. Right click on the Toolkit module and select "find usages of this module"
1. Since we have merged the Toolkit module with the TcConnector module, all references to the toolkit should point to the TcConnector
- Tip: If there are still a lot of resources pointing to the toolkit, you can rename the toolkit to TcConnector2, remove the TcConnector2, rename the TcConnector to TcConnector2 and back to TcConnector. This trick connects the old resouces in the Toolkit to the new ones in the TcConnector.
1. Search (ctrl+f) on "Toolkit", to see if there are any BO mappings left that reference the Toolkit, replace these with TcConnector.

11. 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 (e.g., invalid search criteria)

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

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Mendix.Latin] Use 'for example, ' instead of 'e.g., '.

Raw Output:
{"message": "[Mendix.Latin] Use 'for example, ' instead of 'e.g., '.", "location": {"path": "content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2606-configuration/migrate-to-2606.md", "range": {"start": {"line": 105, "column": 60}}}, "severity": "ERROR"}
1. If you have automated tests, run them to ensure integration behavior is correct

## Breaking Changes {#breaking-changes}

Expand Down Expand Up @@ -150,6 +158,26 @@
| `GetItemFromId` | `GetItemAndRelatedObjects` |
| `RetrieveCookie` | No replacement |

## Deprecated Entities

The following entities have been deprecated. To indicate this, the entities have been renamed with an underscore prefix:

|Entity |
|---|
|CreateBomWindowInput|
|CreateBomWindowInput_CreateBomWindowResponse|
|CreateBomWindowResponse|
|ExpandPSOneLevelResponse|
|GetItemFromIdInput|
|GetItemFromIdResponse|
|GetWorkflowTemplatesInput|
|ItemRevisionOutput|
|RevisionIDs|
|SessionUser|
|TcServerInfo|
|WhereUsedInput|
|WhereUsedResponseInfo|

## Automatically Migrated Items

Not everything needs to be rebuilt from scratch. These items are automatically migrated as they are:
Expand Down