Skip to content

Commit d537068

Browse files
authored
Add getting started guide for Teamcenter Connector 2606
Added a comprehensive guide for getting started with the Teamcenter Connector 2606, including installation, setup, and integration steps.
1 parent 06bfcc3 commit d537068

1 file changed

Lines changed: 129 additions & 0 deletions

File tree

  • content/en/docs/marketplace/industry/xcelerator/platform-supported/teamcenter-connector/Unified Teamcenter Connector 2606
Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
## Getting Started
2+
3+
### Installation and Setup
4+
5+
1. **Download and import the module**
6+
* Open Mendix Studio Pro 11.12, and go to the Marketplace tab. Download Teamcenter Connector 2606. Remember: you don't need to download Teamcenter Extension separately since its already included.
7+
* Alternatively, you can download Teamcenter Connector 2606 from the Mendix Marketplace and import it into your Mendix 11.12 project.
8+
9+
2. **Add required dependencies**
10+
* Make sure your app includes Community Commons and the Encryption module. These are both available from the Marketplace.
11+
12+
3. **Configure security**
13+
* Assign the `TcConnector.User` role to the relevant user roles in your app's security settings. **Important**: The Administrator role now only has access to `TcConnector.TeamcenterConfiguration`. For all integration work, use the User role.
14+
* Click "Update Security" in Studio Pro to refresh entity access rules.
15+
16+
4. **Enable React client**
17+
- Make sure the React client is enabled in your app settings (Project → Settings → Runtime). This is required for the Teamcenter service document to work properly.
18+
19+
---
20+
21+
### What a Teamcenter service document contains
22+
23+
1. **Settings**
24+
* This is where you 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 so you can build artifacts as per your use case.
25+
* Set up your authentication method, test the connection, and manage sign-in state.
26+
* You typically configure this once per Teamcenter service document, unless you need to switch environments.
27+
28+
<img width="2339" height="1168" alt="image" src="https://github.com/user-attachments/assets/cfeb4f6a-83cf-4524-a2da-462447144f7d" />
29+
30+
2. **Integrations**
31+
* It shows an overview of all the integrations you've configured in this document.
32+
* You can see the Teamcenter integration type, the entities and microflows that were generated, and when each integration was last modified.
33+
* From here, you can:
34+
* View details of an integration.
35+
* Edit an existing integration.
36+
* Duplicate an integration (useful for creating variations).
37+
* Delete integrations you no longer need.
38+
* Navigate directly to the generated microflows and entities by double-clicking on them.
39+
* This is also where you can add new integrations.
40+
41+
<img width="3544" height="1700" alt="image" src="https://github.com/user-attachments/assets/33937f02-6003-4016-be11-95f18d03f62e" />
42+
43+
---
44+
45+
**You can have multiple Teamcenter service documents**
46+
You can create several Teamcenter service documents in a single app, each in its own module. This is useful for separating concerns. For example:
47+
* A "Parts" module with a Teamcenter service document for part-related integrations.
48+
* A "Workflows" module with a Teamcenter service document for workflow-related integrations.
49+
* A "Documents" module with a Teamcenter service document for dataset and document integrations.
50+
51+
---
52+
53+
### Create and build your first Teamcenter service document
54+
55+
#### 1. Create a Teamcenter service document
56+
* In the App Explorer, right-click on the module where you want to create your integrations.
57+
* Select "Add other" → "Teamcenter service".
58+
* Give it a name (e.g., "PartsIntegrations" or "MainTeamcenterConnection").
59+
60+
#### 2. Open the Settings tab
61+
* Navigate to the Settings tab of the Teamcenter service document (it's one of the tabs at the top of the document)
62+
63+
#### 3. Configure your connection
64+
* In the Settings tab, provide your Teamcenter authentication option along with credentials. Please refer to the [old Teamcenter Extension](https://docs.mendix.com/appstore/modules/siemens-plm/teamcenter-extension/create-an-integration/#settings-tab) settings page for more details.
65+
66+
#### 4. Test your connection
67+
* Once you've entered your connection details, click the "Sign In" button to test the connection.
68+
69+
>[!NOTE] Important note about auto-logout
70+
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.
71+
72+
#### 5. **Add your first Teamcenter integration**
73+
* Click on the "Integrations" tab at the top. Right now, it's empty—this is normal for a new Teamcenter service document.
74+
* Click on "Add integration".
75+
* You'll see tiles representing all available integration types (like "Search Item Revisions," "Create Item with Item Revision," etc.).
76+
* Click on one of these tiles to start configuring that type of integration.
77+
* This will take you to the Import Mapping page.
78+
79+
#### 6. **Use the Import Mapping Mapping Page**
80+
Double-click on any one of the boxes to open the object mapping dialog.
81+
82+
<img width="2562" height="1989" alt="image" src="https://github.com/user-attachments/assets/eaa4fb09-d1d8-4c39-9a8c-65004f4adc41" />
83+
84+
**Teamcenter side (left)**
85+
* Browse the Teamcenter object hierarchy.
86+
* Select the business object type you want to work with (for example, "Item Revision" or "Dataset").
87+
88+
**Mendix side (right)**
89+
* Choose whether to create a new entity or use an existing one.
90+
* If creating new, the Teamcenter service will generate an entity that is a specialization of the selected entity.
91+
* If using existing, you can select an entity you've already defined in your domain model.
92+
* When you're done, choose the **Select** button at the bottom to proceed.
93+
94+
**Mapping additional properties**
95+
* Once you've selected the Teamcenter object type and Mendix entity, you can add additional properties/references/relations to the list of default selected properties.
96+
* Double-click on the entity or select an entity and click Select Elements at the top.
97+
* Use the checkboxes to indicate:
98+
* "Read" — should this property be retrieved from Teamcenter?
99+
* "Write" — should this property be sent to Teamcenter when creating or updating (note the write checkboxes are only available in integrations where you can write data to Teamcenter).
100+
* Select the properties you need for your integration.
101+
102+
<img width="2551" height="1975" alt="image" src="https://github.com/user-attachments/assets/a137c186-da2c-4c8e-bd59-d6a2a4eea222" />
103+
104+
**Teamcenter integration-specific panels**
105+
* Depending on the integration type, you'll be presented with additional configuration dialog.
106+
* For example:
107+
* Dataset integrations let you filter by dataset type.
108+
* BOM integrations let you configure BOM window properties and revision rules.
109+
* Configure these integration-specific settings as needed.
110+
* For more information on each of the Teamcenter integrations, refer to [integration guides](https://docs.mendix.com/appstore/modules/siemens-plm/teamcenter-extension/create-an-integration/integrations/).
111+
112+
#### 7. **Generate your integration**
113+
* Once you've configured everything, click the "Generate" button.
114+
* The Teamcenter service document will:
115+
* Validate your integration to make sure everything is correct.
116+
* Generate domain model entities (placed in your domain model as a tree for easy visualization).
117+
* Generate microflows that implement the integration logic.
118+
* Save the integration to the Teamcenter service document
119+
* Navigate to the Integrations tab where the integration is now listed
120+
121+
#### 8. **Explore the results**
122+
* After generation completes, you'll automatically return to the Integrations tab.
123+
* Find your newly created integration in the list.
124+
* You'll see links to:
125+
* The generated microflows (double-click to jump directly to them in Studio Pro).
126+
* The generated entities (double-click to jump directly to the Domain model).
127+
* Double click on a microflow name for Studio to open that microflow, and you can see exactly what was generated.
128+
129+
<img width="3529" height="1688" alt="image" src="https://github.com/user-attachments/assets/ca67bf73-c51d-4059-80f8-be2dc2d879ad" />

0 commit comments

Comments
 (0)