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/platform-supported-content/modules/siemens/teamcenter-extension/create-an-integration/action-menu/01-search-item-revisions.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,21 +6,21 @@ weight: 1
6
6
---
7
7
8
8
## Introduction {#introduction}
9
-
The “Search Item Revisions” action allows you to generate the domain model and microflow to search for Item Revisions or its specialization. For those familiar with Teamcenter, the resulting microflow implements the out of the box saved query “Item Revision...” from Teamcenter.
9
+
The **Search Item Revisions** action allows you to generate the domain model and microflow to search for Item Revisions or its specialization. For those familiar with Teamcenter, the resulting microflow implements the out of the box saved query `Item Revision...` from Teamcenter.
10
10
11
-
This document takes you through a use case where we want to retrieve Part Revisions from Teamcenter. Part Revisions are specific iterations of a part of a product that is managed using Teamcenter. A Part Revision contains essential information like the schematics of the Part. As a Part Revision is a sub-type of an Item Revision, it can be revised.
11
+
This document takes you through a use case where we want to retrieve **Part Revisions** from Teamcenter. **Part Revisions** are specific iterations of a part of a product that is managed using Teamcenter. A **Part Revision** contains essential information like the schematics of the **Part**. As a **Part Revision** is a sub-type of an **Item Revision**, it can be revised.
12
12
13
13
## Step-by-step guide {#step-by-step-guide}
14
-
1. Make sure you have set up your credentials in the settings tab before following these instructions. For more instructions on how to configure your settings, follow the steps [here](https://marketplace.mendix.com/link/component/111627).
15
-
2. Click on the Search Item Revision button on the home page to start configuring your integration.
14
+
1. Make sure you have set up your credentials in the **Settings tab** before following these instructions. For more instructions on how to configure your settings, follow the steps [here](/appstore/modules/siemens-plm/teamcenter-extension/create-an-integration/#settings-tab).
15
+
2. Click on the **Search Item Revision** button on the home page to start configuring your integration.
3. You will land on the [import mapping page](https://docs.mendix.com/refguide/import-mappings/). This determines what data is retrieved from Teamcenter and what type of objects are created in Mendix.
17
+
3. You will land on the [import mapping page](/refguide/import-mappings/). This determines what data is retrieved from Teamcenter and what type of objects are created in Mendix.
18
18
Click on one of the placeholder entities to start the import mapping.
4. In the object mapping dialog that opens, the left side shows Teamcenter objects (out of the box and custom) retrieved from the Teamcenter instance. Since we are interested in Retrieving Part Revisions, we select `Part Revision (Part Revision)`, which can be found under `Item Revision`.
21
-
The right side shows the relevant Mendix entities for which object could be created when we retrieve Item revisions from Teamcenter. In our case, we want to have an entity specifically for Part Revisions so we can make changes and add new attributes to it. Hence, we select `TcConnector.ItemRevision` and then click on the checkbox to *Create new Specialization of selected Entity*. The entity will automatically be named `PartRevision` after the Teamcenter Object name, but it can be renamed here if required. Now click on *OK*, to finish the object mapping and close the object mapping dialog.
20
+
4. In the object mapping dialog that opens, the left side shows Teamcenter objects (out of the box and custom) retrieved from the Teamcenter instance. Since we are interested in retrieving **Part Revisions**, we select `Part Revision (Part Revision)`, which can be found under **Item Revision**.
21
+
The right side shows the relevant Mendix entities for which object could be created when we retrieve Item Revisions from Teamcenter. In our case, we want to have an entity specifically for **Part Revisions** so we can make changes and add new attributes to it. Hence, we select `TcConnector.ItemRevision` and then click on the checkbox to **Create new Specialization of selected Entity**. The entity will automatically be named `PartRevision` after the Teamcenter Object name, but it can be renamed here if required. Now click on **OK**, to finish the object mapping and close the object mapping dialog.
5. Closing the object mapping dialog opens the attributes and associations sidebar. Here you can select from all properties available on the selected Teamcenter Object the properties you want to have within your Mendix application. In this example, we want to create an integration where we retrieve additional Part Revision details. Select in the side panel the following attributes to add to the Part Revision entity.
23
+
5. Closing the object mapping dialog opens the attributes and associations sidebar. Here you can select from all properties available on the selected Teamcenter Object the properties you want to have within your Mendix application. In this example, we want to create an integration where we retrieve additional **Part Revision** details. Select in the side panel the following attributes to add to the **Part Revision** entity.
24
24
* Finish type
25
25
* Multi body
26
26
* Safety Part
@@ -30,26 +30,26 @@ The right side shows the relevant Mendix entities for which object could be crea
30
30
31
31
After this selection, click on the backdrop or on the close button to close the side panel.
6. Click on the Generate button to generate the appropriate Domain model and microflows so that you can start retrieving Part Revisions in your application
34
-
7. Once the generation is done, you will be redirected to the History tab which shows a summary of what has been generated.
33
+
6. Click on the **Generate** button to generate the appropriate domain model and microflows so that you can start retrieving **Part Revisions** in your application.
34
+
7. Once the generation is done, you will be redirected to the **History tab** which shows a summary of what has been generated.
The extension generated the following entities in your domain model.
40
-
-`PartRevision` – This is an entity to represent a `PartRevision` from Teamcenter. The objects can be retrieved via `PartRevision_SavedQueryItemRevision`.
40
+
***PartRevision** – This is an entity to represent a PartRevision from Teamcenter. The objects can be retrieved via `PartRevision_SavedQueryItemRevision`.
41
41
42
42
### Microflows {#microflows}
43
43
The extension generated the following microflows in your project.
44
-
*`PartRevision_SavedQueryItemRevision` - This microflow can be used to retrieve a list of Part Revisions from Teamcenter.
44
+
***PartRevision_SavedQueryItemRevision** - This microflow can be used to retrieve a list of Part Revisions from Teamcenter.
45
45
The microflow receives two input parameters, a `ConfigName` and `ItemRevisionSearchCriteria`.
46
-
1. The `configName` must be the *configName* on a *TcConnection.TeamcenterConfiguration* object and determines which Teamcenter configuration will be used to connect to Teamcenter.
46
+
1. The `configName` must be the **configName** on a **TcConnection.TeamcenterConfiguration** object and determines which Teamcenter configuration will be used to connect to Teamcenter.
47
47
If only one Teamcenter Configuration is used, the parameter can be left empty.
48
-
2. The `ItemRevisionSearchCriteria` is required and must be used as input arguments while searching for the ItemRevisions. [For hints on efficient use of this parameter see section here]
48
+
2. The `ItemRevisionSearchCriteria` is required and must be used as input arguments while searching for the ItemRevisions. [For hints on efficient use of this parameter see section here](#item-revision-search-criteria).
49
49
50
-
The microflow will return a list of `PartRevision` that matches the `SearchCriteria` provided in the `ItemRevisionSearchCriteria`.
50
+
The microflow will return a list of **PartRevision** that matches the `SearchCriteria` provided in the `ItemRevisionSearchCriteria`.
* It is highly recommended to provide the `_Type` field as it significantly optimizes the `ItemRevision_SavedQueryItemRevision` microflow. The `_type` field specifies which types of `ItemRevisions` will be requested. The field should be set to `PartRevision` to retrieve only `PartRevisions and specializations of it.
55
-
* The fields `Name` and `ItemID` on `ItemRevisionSearchCriteria` support wildcards. For example, if `Name` is set to `a*`, all revisions will be returned that have a name that start with an `a`.
54
+
* It is highly recommended to provide the `_Type` field as it significantly optimizes the **ItemRevision_SavedQueryItemRevision** microflow. The `_type` field specifies which types of **ItemRevisions** will be requested. The field should be set to `PartRevision` to retrieve only **PartRevisions** and specializations of it.
55
+
* The fields `Name` and `ItemID` on **ItemRevisionSearchCriteria** support wildcards. For example, if `Name` is set to `a*`, all revisions will be returned that have a name that start with an `a`.
Copy file name to clipboardExpand all lines: content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-extension/create-an-integration/action-menu/02-create-item-with-item-revision.md
+18-18Lines changed: 18 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,41 +6,41 @@ weight: 2
6
6
---
7
7
8
8
## Introduction {#introduction}
9
-
The “Create Item with Item Revision” action allows you to configure and generate the domain model and microflow to create an Item with ItemRevision or its specializations in Teamcenter. The resulting microflow implements the Create Object and Update Properties actions from the Teamcenter Connector.
9
+
The **Create Item with Item Revision** action allows you to configure and generate the domain model and microflow to create an **Item** with **ItemRevision** or its specializations in Teamcenter. The resulting microflow implements the **Create Object** and U**pdate Properties** actions from the Teamcenter Connector.
10
10
11
-
This document takes you through a use-case where you want to create Problem Reports in Teamcenter. Problem Reports, represented by the Problem Report Revision business object, are utilized to manage the documentation or reproduction of an issue. They can also be used to determine the severity and priority of the issue.
11
+
This document takes you through a use-case where you want to create **Problem Reports** in Teamcenter. **Problem Reports**, represented by the **Problem Report Revision** business object, are utilized to manage the documentation or reproduction of an issue. They can also be used to determine the severity and priority of the issue.
12
12
13
13
## Step-by-step Guide {#step-by-step-guide}
14
-
1. Make sure you have set up your credentials in the settings tab before following these instructions. For more instructions on how to configure your settings, follow the steps [here].
15
-
2. Click on the Create Item w/ Item Revision button on the home page to start configuring your integration.
14
+
1. Make sure you have set up your credentials in the **Settings tab** before following these instructions. For more instructions on how to configure your settings, follow the steps [here](/appstore/modules/siemens-plm/teamcenter-extension/create-an-integration/#settings-tab).
15
+
2. Click on the **Create Item w/ Item Revision** button on the home page to start configuring your integration.
3. You will land on the [import mapping page](https://docs.mendix.com/refguide/import-mappings/). This determines what data is retrieved from Teamcenter and what type of objects are created in Mendix.
18
-
When creating a Problem Report object in Teamcenter, two objects are created: Problem Report (sub-class of Item) and its associated Problem Report Revision (sub-class of Item Revision). Hence, in the import mapping page, we have placeholders to map both the objects with Mendix entities.
17
+
3. You will land on the [import mapping page](/refguide/import-mappings/). This determines what data is retrieved from Teamcenter and what type of objects are created in Mendix.
18
+
When creating a **Problem Report** object in Teamcenter, two objects are created: **Problem Report** (sub-class of **Item**) and its associated **Problem Report Revision** (sub-class of **Item Revision**). Hence, in the import mapping page, we have placeholders to map both the objects with Mendix entities.
19
19
Click on one of the top placeholder entities to start the import mapping.
4. In the object mapping dialog that opens, the left side shows Teamcenter objects (both out of the box and custom) retrieved from the Teamcenter instance. Since we are interested in creating Problem Reports, we select `Problem Report` found under Item -> Change Item -> Generic Problem Report.
22
-
The right side show the Mendix entities that can serve as input parameters for the microflow to create Item with Item revision. Notably, if we create our own entity here, we can ensure that additional attributes are set in Teamcenter upon creation. Hence, we select `TcConnector.Item` and then click on the checkbox to *Create new Specialization of selected Entity*. The entity will automatically be named `ProblemReport` after the Teamcenter Object name, but it can be renamed here if required. Now click on *OK*, to finish the object mapping and close the object mapping dialog.
21
+
4. In the object mapping dialog that opens, the left side shows Teamcenter objects (both out of the box and custom) retrieved from the Teamcenter instance. Since we are interested in creating **Problem Reports**, we select `Problem Report` found under **Item -> Change Item -> Generic Problem Report**.
22
+
The right side show the Mendix entities that can serve as input parameters for the microflow to create **Item** with **Item revision**. Notably, if we create our own entity here, we can ensure that additional attributes are set in Teamcenter upon creation. Hence, we select `TcConnector.Item` and then click on the checkbox to **Create new Specialization of selected Entity**. The entity will automatically be named `ProblemReport` after the Teamcenter Object name, but it can be renamed here if required. Now click on **OK**, to finish the object mapping and close the object mapping dialog.
6. Closing the object mapping dialog opens the attributes and associations sidebar. Here you can select from all properties available on the selected Teamcenter Object the properties you want to have within your Mendix application. In this example, we want to create an integration where we retrieve additional Problem Report Revision details. Select in the side panel the following attribute to add to the Problem Report Revision entity
27
+
6. Closing the object mapping dialog opens the attributes and associations sidebar. Here you can select from all properties available on the selected Teamcenter Object the properties you want to have within your Mendix application. In this example, we want to create an integration where we retrieve additional **Problem Report Revision** details. Select in the side panel the following attribute to add to the Problem Report Revision entity:
28
28
* Severity Rating
29
29
30
30
After this selection, you can click on the backdrop or on the close button to close the side panel.
The extension generated the following entities in your domain model.
39
-
*`ProblemReport` – This is an entity representing a Problem Report from Teamcenter. It can be used to create a new Item in Teamcenter.
40
-
*`ProblemReportRevision` – This is an entity representing Problem Report Revision from Teamcenter. It can be used to create a new Item Revision in Teamcenter.
41
-
*`ProblemReportCreateInput` – This is a helper entity that is used in the `ProblemReport_CreateItemAndItemRevision` microflow to Create the Item in Teamcenter.
42
-
*`ProblemReportRevisionCompoundCreateInput` – This is a helper entity that is used in the `ProblemReport_CreateItemAndItemRevision` microflow to Create the `ItemRevision` in Teamcenter.
39
+
***ProblemReport** – This is an entity representing a Problem Report from Teamcenter. It can be used to create a new Item in Teamcenter.
40
+
***ProblemReportRevision** – This is an entity representing Problem Report Revision from Teamcenter. It can be used to create a new Item Revision in Teamcenter.
41
+
***ProblemReportCreateInput** – This is a helper entity that is used in the `ProblemReport_CreateItemAndItemRevision` microflow to Create the Item in Teamcenter.
42
+
***ProblemReportRevisionCompoundCreateInput** – This is a helper entity that is used in the `ProblemReport_CreateItemAndItemRevision` microflow to Create the `ItemRevision` in Teamcenter.
43
43
### Microflows {#microflows}
44
44
The extension generated the following microflows in your project.
45
-
*`ProblemReport_CreateItemAndItemRevision` – This microflow implements the logic to create an item w/ item revision with only the necessary properties and then updates the objects with additional properties
46
-
*`ProblemReportRevision_RetrieveProblemReport` – This microflow implements the logic to retrieve problem reports revision. It’s primarily available if you are interested in retrieving problem report revisions that were created
45
+
***ProblemReport_CreateItemAndItemRevision** – This microflow implements the logic to create an item w/ item revision with only the necessary properties and then updates the objects with additional properties.
46
+
***ProblemReportRevision_RetrieveProblemReport** – This microflow implements the logic to retrieve problem reports revision. It’s primarily available if you are interested in retrieving problem report revisions that were created.
0 commit comments