You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2606-configuration/getting-started.md
+38-38Lines changed: 38 additions & 38 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,14 +8,14 @@ description: "Describes how to install, configure, and build your first Teamcent
8
8
9
9
## Installation and Setup
10
10
11
-
Follow these steps and install and set up Teamcenter Connector 2606
11
+
Follow these steps to install and set up Teamcenter Connector 2606:
12
12
13
13
1. Download the module from Mendix Marketplace and import it in Studio Pro 11.12.
14
-
Remember that you don't need to download Teamcenter Extension separately, since it is already included.
14
+
You do not need to download Teamcenter Extension separately, since it is already included.
15
15
16
16
2. Add the required dependencies. Make sure your app includes Community Commons and the Encryption module. These are both available in Mendix Marketplace.
17
17
18
-
3. Configure security. To do that, follow these steps:
18
+
3. Configure security:
19
19
20
20
1. Assign the `TcConnector.User` role to the relevant user roles in your app's security settings.
21
21
{{% alert color="info" %}} The **Administrator** role now only has access to `TcConnector.TeamcenterConfiguration`. For all integration work, use the **User** role. {{% /alert %}}
@@ -27,17 +27,17 @@ Follow these steps and install and set up Teamcenter Connector 2606
27
27
28
28
These are the details included in a Teamcenter service document:
29
29
30
-
***Settings** – This is what you can do:
30
+
***Settings** – Configure the following:
31
31
32
-
*Configure 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.
33
-
*Configure 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.
32
+
*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.
33
+
*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.
34
34
35
35
{{< figure src="/attachments/appstore/industry-components/teamcenter/teamcenter2606/service-document-settings.png" alt="Settings tab of the Teamcenter service document" max-width=70% >}}
36
36
37
-
***Integrations** – This is what you can do:
37
+
***Integrations** – View and manage integrations:
38
38
39
-
*See an overview of all the integrations you've configured in this document.
40
-
*See the Teamcenter integration type, the entities and microflows that were generated, and when each integration was last modified. From here, you can:
39
+
*Check out an overview of all the integrations you have configured in this document.
40
+
*Check out the Teamcenter integration type, the entities and microflows that were generated, and when each integration was last modified. From here, you can:
41
41
42
42
* View the details of an integration.
43
43
* Edit an existing integration.
@@ -55,11 +55,11 @@ You can have multiple Teamcenter service documents in a single app, each in its
55
55
* A **Workflows** module with a Teamcenter service document for workflow-related integrations.
56
56
* A **Documents** module with a Teamcenter service document for dataset and document integrations.
57
57
58
-
## Creating and Building Your First Teamcenter Service Document
58
+
## Creating and Building a Teamcenter Service Document
59
59
60
60
The following steps walk you through creating and building a Teamcenter service document.
61
61
62
-
1. Create a Teamcenter service document.
62
+
1. Create a Teamcenter service.
63
63
64
64
1. In the App Explorer, right-click the module where you want to create your integrations.
65
65
2. Select **Add other**, then select **Teamcenter service**.
@@ -68,55 +68,55 @@ The following steps walk you through creating and building a Teamcenter service
68
68
1. Configure your connection.
69
69
70
70
1. Navigate to the **Settings** tab of the Teamcenter service document.
71
-
2.On the **Settings** tab, provide your Teamcenter authentication option along with credentials. For details, refer to the previous [Teamcenter Extension settings page](/appstore/industry/teamcenter-extension/create-an-integration/#settings-tab)information.
71
+
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.
72
72
73
73
1. Test your connection.
74
74
Once you have entered your connection details, click **Sign In** to test the connection.
75
-
{{% 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're always using the correct credentials with the correct Teamcenter environment. {{% /alert %}}
75
+
{{% 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 %}}
76
76
77
-
1. Add your first Teamcenter integration.
77
+
1. Add your Teamcenter integration.
78
78
79
-
1. Click the **Integrations** tab at the top. At this point, the tab is empty. This is normal for a new Teamcenter service document.
80
-
2. Click **Add integration**. Tiles representing all available integration types, such as **Search Item Revisions**, **Create Item with Item Revision**, are displayed.
79
+
1. Click the **Integrations** tab at the top.
80
+
2. Click **Add integration**. Tiles representing all available integration types are displayed, such as **Search Item Revisions** and **Create Item with Item Revision**.
81
81
3. Click one of the integration type tiles to start configuring that specific type of integration. The **Object Mapping** page is displayed.
82
82
83
83
1. Fill in the required information on the **Object Mapping** page:
2. Select the business object type you want to work with, such as **Item Revision** or **Dataset**.
89
+
1. Browse the Teamcenter object hierarchy.
90
+
2. Select the business object type you want to work with, such as **Item Revision** or **Dataset**.
91
91
92
-
* Mendix entities
92
+
2. Mendix entities
93
93
94
-
1. Choose whether to create a new entity or use an existing one.
95
-
If you create a new entity, the Teamcenter service will generate an entity that is a specialization of the selected entity.
96
-
If you use an existing entity, you can select an entity you've already defined in your domain model.
97
-
2. When you're done, click **Select** to proceed.
94
+
1. Choose whether to create a new entity or use an existing one.
95
+
If you create a new entity, the Teamcenter service generates an entity that is a specialization of the selected entity.
96
+
If you use an existing entity, you can select an entity you have already defined in your domain model.
97
+
2. When you are done, click **Select** to proceed.
98
98
99
-
* Additional properties
100
-
Once you've selected the Teamcenter object type and Mendix entity, you can add additional propertiesreferences/relations to the list of default selected properties. Follow these steps:
99
+
3. Additional properties
100
+
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:
101
101
102
-
1. Double-click the entity or select an entity and click **Select Elements** at the top.
103
-
2. Use the checkboxes to indicate:
102
+
1. Double-click the entity or select an entity and click **Select Elements** at the top.
103
+
2. Use the checkboxes to indicate:
104
104
105
-
***Read** — Should this property be retrieved from Teamcenter?
106
-
***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.
105
+
***Read** — Should this property be retrieved from Teamcenter?
106
+
***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.
107
107
108
-
3. From the **Property Mapping** window, select the properties you need for your integration.
108
+
3. From the **Property Mapping** window, select the properties you need for your integration.
Depending on the integration type you choose, you might be presented with an additional configuration dialog window. For example:
112
+
4.Teamcenter integration-specific panels
113
+
Depending on the integration type you choose, an additional configuration dialog window may be displayed. For example:
114
114
115
-
* Dataset integrations let you filter by dataset type.
116
-
* BOM integrations let you configure BOM window properties and revision rules.
115
+
* Dataset integrations let you filter by dataset type.
116
+
* BOM integrations let you configure BOM window properties and revision rules.
117
117
118
-
Configure these integration-specific settings as needed.
119
-
For more information on each of the Teamcenter integrations, refer to the [integration guides](/appstore/modules/siemens-plm/teamcenter-extension/create-an-integration/integrations/).
118
+
Configure these integration-specific settings as needed.
119
+
For more information on each of the Teamcenter integrations, refer to the [integration guides](/appstore/modules/siemens-plm/teamcenter-extension/create-an-integration/integrations/).
120
120
121
121
1. Generate your integration.
122
122
Once you have configured everything, click **Generate**. The Teamcenter service document performs the following actions:
Copy file name to clipboardExpand all lines: content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/2606-configuration/migrate-to-2606.md
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."
5
+
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."
6
6
---
7
7
8
8
## Introduction
9
9
10
-
Teamcenter Connector 2606 contains both the Teamcenter Connector and the Teamcenter Extension. This means that, from this version onwards, the Teamcenter Extension doesn't need to be downloaded seperately. If you have an existing app using Teamcenter Connector 2512 and the Teamcenter Extension v4.x, you can migrate to version 2606.
10
+
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.
11
11
12
-
This migration involves some breaking changes, but they are outweighted by the benefits:
12
+
This migration involves some breaking changes, but they are outweighed by the benefits:
13
13
14
14
* Unified module
15
15
* Modern Extension framework
@@ -37,8 +37,8 @@ Follow these steps in this exact order to ensure a proper migration:
37
37
2. Move the Toolkit contents to the TcConnector module.
38
38
39
39
1. Remove the old TcConnector module from your project, and ignore the errors for now.
40
-
1. Rename the old TeamcenterToolkit module to TcConnector module, then remove the module. By doing this, the old Toolkit references in the project are now pointing to the TcConnector module.
41
-
{{% alert color="info" %}} This step doesn't change the BOMapping. This will be fixed in a later step. {{% /alert %}}
40
+
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.
41
+
{{% alert color="info" %}} This step does not change the BOMapping. This is fixed in a later step. {{% /alert %}}
42
42
43
43
3. Import the new connector.
44
44
@@ -48,7 +48,8 @@ Follow these steps in this exact order to ensure a proper migration:
48
48
49
49
4. Resolve breaking changes.
50
50
51
-
1. Studio Pro will display errors where your microflows or domain model reference things that have changed. Work through these systematically.
51
+
1. Studio Pro displays errors where your microflows or domain model reference things that have changed. Work through these systematically.
52
+
52
53
The most common issues you will encounter are:
53
54
54
55
* 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.
@@ -61,7 +62,7 @@ Follow these steps in this exact order to ensure a proper migration:
61
62
5. Update security.
62
63
63
64
1. Click **Update Security** in Studio Pro.
64
-
1. Make sure that all atrributes 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.
65
+
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.
65
66
66
67
6. Enable the React client.
67
68
@@ -81,7 +82,7 @@ Follow these steps in this exact order to ensure a proper migration:
81
82
82
83
9. Recreate your integrations.
83
84
84
-
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 that they are compatible with the new connector. To do that, follow these steps:
85
+
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:
85
86
86
87
1. In the Service Document, click **+Add integration** and start a journey that matches each of your existing integrations.
87
88
1. Configure the integration the same way as before. The journey types and options are the same.
@@ -98,7 +99,7 @@ Follow these steps in this exact order to ensure a proper migration:
98
99
99
100
## Breaking Changes {#breaking-changes}
100
101
101
-
This is a comprehensive table of breaking changes and actions to take each one:
102
+
This is a comprehensive table of breaking changes and actions to take for each one:
102
103
103
104
| Area | Change | Action required |
104
105
| --- | --- | --- |
@@ -114,7 +115,7 @@ This is a comprehensive table of breaking changes and actions to take each one:
114
115
115
116
## Deprecated Microflows and Their Replacements {#deprecated-microflows}
116
117
117
-
These microflows still exist in the deprecated folder, but can no longer be used. Replace them with the recommended alternatives:
118
+
These microflows still exist in the deprecated folder, but should no longer be used. Replace them with the recommended alternatives:
118
119
119
120
| Deprecated | Replacement |
120
121
| --- | --- |
@@ -135,7 +136,7 @@ These microflows still exist in the deprecated folder, but can no longer be used
135
136
136
137
## Deprecated Java Actions and Their Replacements {#deprecated-java}
137
138
138
-
These Java actions still exist in the deprecated folder, but can no longer be used. Replace them with the recommended alternatives:
139
+
These Java actions still exist in the deprecated folder, but should no longer be used. Replace them with the recommended alternatives:
139
140
140
141
| Java Action | Replacement |
141
142
| --- | --- |
@@ -153,5 +154,5 @@ These Java actions still exist in the deprecated folder, but can no longer be us
153
154
154
155
Not everything needs to be rebuilt from scratch. These items are automatically migrated as they are:
155
156
156
-
* Domain model — Entities and associations generated by the previous Extension remain in your module. They are part of your app, so they don't disappear during the migration.
157
-
* 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.
157
+
* 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.
158
+
* 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.
0 commit comments