Skip to content
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.

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

Update teamcenter-extension.md (Version 3.0.0) #8465

Open
wants to merge 12 commits into
base: development
Choose a base branch
from
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,13 @@ Teamcenter Extension offers a list of use cases for which domain models and micr

Teamcenter Extension offers the following integration options:

* Get item revisions
* Get workspace objects
* Search item revisions
* Create item and item revision
* Update item and item revision
* Revise item revisions
* Revise Item revison
* Search datasets
* Get datasets for item revision
* Search workspace objects
* Get structures

### License {#license}
Expand All @@ -31,7 +33,9 @@ The compatibility between Teamcenter Extension and Studio Pro is as follows:

* Teamcenter Extension V 1.0.0 is compatible with Studio Pro versions between 10.6.5 and 10.7.

* Teamcenter Extension V 2.0.0 is compatible with Studio Pro version 10.12.1 or higher.
* Teamcenter Extension V 2.0.0 is compatible with Studio Pro version 10.12.1 and above.

* Teamcenter Extension V 3.0.0 is compatible with Studio Pro version 10.12.6 and above.

{{% alert color="info" %}}Teamcenter Extension is not compatible with Studio Pro versions between 10.8 to 10.11. </br></br>If you use one of these Studio Pro versions, a possible workaround is to use Teamcenter Extension in one of the compatible versions of Studio Pro first, create necessary artifacts and then import them into your version. However, Mendix always recommends using the latest MTS or LTS Studio Pro version.{{% /alert %}}

Expand All @@ -49,8 +53,9 @@ You must have these Marketplace modules installed:
| ------------- | ------------- | ------------- |
| 1.0.0 | 3.6.1, V 3.6.0, V 3.5.0 | 10.6.5 thru 10.7 |
| 2.0.0 | 2406.0.0 | 10.12.1 and above |
| 3.0.0 | 2406.3.0 | 10.12.6 and above (except 10.15.0) |

{{% alert color="info" %}}If you use Teamcenter Extension V 1.0.0 with Teamcenter Connector V 3.6.1 or below, and want to upgrade to Teamcenter Extension V 2.0.0 and Teamcenter Connector V 2406.0.0, see the [Upgrading Teamcenter Extension V 1.0.0 to V 2.0.0](#upgrade) section.{{% /alert %}}
{{% alert color="info" %}}If you use Teamcenter Extension V 1.0.0 with Teamcenter Connector V 3.6.1 or below, and want to upgrade to Teamcenter Extension V 3.0.0 and Teamcenter Connector V 2406.3.0, see the [Upgrading Teamcenter Extension V 1.0.0 to V 3.0.0](#upgrade) section.{{% /alert %}}

### Demo App {#demoapp}

Expand All @@ -64,29 +69,37 @@ Follow the instructions in [Using Marketplace Content](/appstore/use-content/) t

### Actions

#### Get Item Revisions from Teamcenter {#getitemrevision}
#### Search Item Revisions from Teamcenter {#getitemrevision}

The `Get ItemRevision` action allows you to generate the domain model and microflow to search for and retrieve `ItemRevisions` or its specialization. The resulting microflow implements the saved query `Item Revision...` from Teamcenter.

#### Get Workspace Objects {#getworkspaceobjects}

The `Get Workspace Objects` action allows you to configure and generate the domain model and microflow to search for and retrieve Workspace Objects or their specialization from Teamcenter. This action implements the saved query `General..` from Teamcenter
This action allows you to generate the domain model and microflow to search for and retrieve `ItemRevisions` or its specialization. The resulting microflow implements the saved query `Item Revision...` from Teamcenter.
Luyao-Zhang-1 marked this conversation as resolved.
Show resolved Hide resolved

#### Create Item and Item Revision {#createitem-and-itemrevision}

The `Create Item and 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. With the `Create Object` action, the `Item` and `ItemRevision` get created in Teamcenter, setting the Teamcenter properties that need to be set upon creation. With the `Update Properties` action, the remaining properties are updated in Teamcenter.
This 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. With the `Create Object` action, the `Item` and `ItemRevision` get created in Teamcenter, setting the Teamcenter properties that need to be set upon creation. With the `Update Properties` action, the remaining properties are updated in Teamcenter.
Luyao-Zhang-1 marked this conversation as resolved.
Show resolved Hide resolved

#### Update Item and Item Revision {#updateitem-and-itemrevision}

The `Update Item and Item Revision` action allows you to generate the domain model and microflow to update an `Item` with `ItemRevision` or their specializations in Teamcenter. The resulting microflows implements the `Update Properties` action from the Teamcenter Connector.
This action allows you to generate the domain model and microflow to update an `Item` with `ItemRevision` or their specializations in Teamcenter. The resulting microflows implements the `Update Properties` action from the Teamcenter Connector.
Luyao-Zhang-1 marked this conversation as resolved.
Show resolved Hide resolved

#### Revise Item Revision {#reviseitem-and-itemrevision}

The `Revise Item and Item Revision` action allows you to generate the domain model and microflow to revise an `ItemRevision` or its specializations in Teamcenter. The resulting microflow implements the `Revise Object and Update Properties` actions from the Teamcenter Connector. With the `Revise Object` action, a new `ItemRevision` is created, setting the Teamcenter properties that need to be set upon revising. With the `Update Properties` action, the remaining properties are updated in Teamcenter.
This allows you to generate the domain model and microflow to revise an `ItemRevision` or its specializations in Teamcenter. The resulting microflow implements the `Revise Object and Update Properties` actions from the Teamcenter Connector. With the `Revise Object` action, a new `ItemRevision` is created, setting the Teamcenter properties that need to be set upon revising. With the `Update Properties` action, the remaining properties are updated in Teamcenter.
Luyao-Zhang-1 marked this conversation as resolved.
Show resolved Hide resolved

#### Search Datasets {#getdatasets}

This allows you to generate the domain model and microflow to search for and retrieve `Datasets` or its specialization. The resulting microflow implements the saved query `Datasets` from Teamcenter.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be possible to replace "this" with the actual name of the action here? If so, could you please add it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as before.

That makes the first statement as - The "Search Datasets" action allows you to....


#### Get Datasets from Item Revision {#getdatasetsfromitemrevision}

This action allows you to generate the domain model and microflow to retrieve datasets for an Item Revision and subsequently download files inside the dataset.
Luyao-Zhang-1 marked this conversation as resolved.
Show resolved Hide resolved

#### Get Workspace Objects {#getworkspaceobjects}

This action allows you to configure and generate the domain model and microflow to search for and retrieve Workspace Objects or their specialization from Teamcenter. This action implements the saved query `General..` from Teamcenter.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be possible to replace "this action" with the actual name of the action here? If so, could you please add it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is shown twice. We should remove the earlier section and keep this one

Copy link
Collaborator

@Luyao-Zhang-1 Luyao-Zhang-1 Oct 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed the following section:

Search Item Revisions from Teamcenter {#getitemrevision}

This action allows you to generate the domain model and microflow to search for and retrieve ItemRevisions or its specialization. The resulting microflow implements the saved query Item Revision... from Teamcenter.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To me, The "#### Get Workspace Objects {#getworkspaceobjects}" section is shown twice so I guess that should be removed?


#### Get Structures

The `Get Structures` action allows you to generate the domain model and microflows to configure a BOM window and retrieve structure data from Teamcenter. This feature supports the retrieval of structures with the following:
This allows you to generate the domain model and microflows to configure a BOM window and retrieve structure data from Teamcenter. This feature supports the retrieval of structures with the following:
Luyao-Zhang-1 marked this conversation as resolved.
Show resolved Hide resolved

* `RevisionRule` (or default `RevisionRule`)
* `VariantRule`
Expand All @@ -106,14 +119,14 @@ To work with structures, such as BOMs, you need to first create a BOM window in

This feature is designed specifically for generating microflows and domain models to retrieve and display simple BOM structures (unconfigured or configured). For other scenarios, consider alternative solutions. See the table below:

| Scenario | Suggested Solution |
| Scenario                                                 | Suggested Solution             |
| -------------------------------------------------------- | ------------------------------ |
| Work with large or complex BOM structures | Use Active Workspace |
| Have performance concerns | Use Active Workspace |
| Work with large or complex BOM structures                | Use Active Workspace           |
| Have performance concerns                                | Use Active Workspace           |
| Transfer an entire BOM from Teamcenter to another system | Use Active Integration Gateway |
| Compare BOMs from different systems | Use Active Integration Gateway |
| Author BOMs | Use Active Workspace |
| Create BOM configurations | Use Active Workspace |
| Compare BOMs from different systems                      | Use Active Integration Gateway |
| Author BOMs                                              | Use Active Workspace           |
| Create BOM configurations                                | Use Active Workspace           |

### Landing Page {#homepage}

Expand Down Expand Up @@ -224,30 +237,30 @@ Once you finished import mapping, click **Generate** to create microflows for th

{{< figure src="/attachments/appstore/platform-supported-content/modules/teamcenter-extension/microflow.png" >}}

## Upgrading Teamcenter Extension V 1.0.0 to V 2.0.0 {#upgrade}
## Upgrading Teamcenter Extension V 1.0.0 to V 3.0.0 {#upgrade}

If you use Teamcenter Extension V 1.0.0 with Teamcenter Connector V 3.6.1 or below, and want to upgrade to Teamcenter Extension V 2.0.0 and Teamcenter Connector V 2406.0.0, perform the following procedure:
If you use Teamcenter Extension V 1.0.0 with Teamcenter Connector V 3.6.1 or below, and want to upgrade to Teamcenter Extension V 3.0.0 and Teamcenter Connector V 2406.3.0, perform the following procedure:

1. Open your app in Studio Pro version 10.12.1 or higher.
2. Follow the instructions in [How to Use Marketplace Content in Studio Pro](/appstore/general/app-store-content/) to download [Teamcenter Extension V 2.0.0](https://marketplace.mendix.com/link/component/225544) from the Marketplace and install it.
1. Open your app in Studio Pro version 10.12.6 or higher.
2. Follow the instructions in [How to Use Marketplace Content in Studio Pro](/appstore/general/app-store-content/) to download [Teamcenter Extension V 3.0.0](https://marketplace.mendix.com/link/component/225544) from the Marketplace and install it.
3. When a warning dialog box opens, click **Trust module and enable extension**. Otherwise, Teamcenter Extension will not be installed.
4. Follow the instructions in [How to Upgrade the Module to a Newer Version](/appstore/use-content/#update-module) to upgrade Teamcenter Connector to V 2406.0.0. Teamcenter Connector V 2406.0.0 has updated domain model that made certain entities and associations in Teamcenter Extension V 1.0.0 redundant. As a result, you get errors after the upgrade.

5. To resolve the errors, use one of the solutions described the sections below:

* [Solution 1](#solution-1)
    * [Solution 1](#solution-1)

* [Solution 2](#solution-2) – Using Solution 2 has an advantage: after completing the procedure, the integrations will appear on the **History** tab.
    * [Solution 2](#solution-2) – Using Solution 2 has an advantage: after completing the procedure, the integrations will appear on the **History** tab.

### Resolving the Errors – Solution 1 {#solution-1}

Follow the instructions in the table below:

| Error message | How to Solve the Error |
| Error message                                           | How to Solve the Error                                       |
| ------------------------------------------------------- | ------------------------------------------------------------ |
| `TeamcenterToolkit.BOMWindow` no longer exists | <ol><li>Update all references to <br/>`TcConnector.BOMWindow`.</li><li>Search for `TeamcenterToolkit.BOMWindow` to find `BOMapping` parameters where the entity is used, and change it to `TcConnector.BOMWindow`.</li></ol> |
| `TeamcenterToolkit.top_line` no longer exists | Update all associations to `TcConnector.top_line`. |
| The selected Java action parameter […] no longer exists | Set all the Java action parameters again. |
| `TeamcenterToolkit.BOMWindow` no longer exists          | <ol><li>Update all references to <br/>`TcConnector.BOMWindow`.</li><li>Search for `TeamcenterToolkit.BOMWindow` to find `BOMapping` parameters where the entity is used, and change it to `TcConnector.BOMWindow`.</li></ol> |
| `TeamcenterToolkit.top_line` no longer exists           | Update all associations to `TcConnector.top_line`.           |
| The selected Java action parameter […] no longer exists | Set all the Java action parameters again.                    |

### Resolving the Errors – Solution 2 {#solution-2}

Expand All @@ -258,5 +271,5 @@ Using Solution 2 has an advantage: after completing the procedure, the integrati
As an alternative to solution 1, you can perform the following steps:

1. Delete the microflows generated with Teamcenter Extension V 1.0.0. This will cause errors in the locations where these microflows were used. Keep these errors so that you can identify where the microflows need to be implemented again.
2. Go to Teamcenter Extension V 2.0.0 and repeat the steps you did before in Teamcenter Extension V 1.0.0. Simply select the same entities and associations, as they already exist in your domain model.
3. Go over the errors caused by the missing microflows and implement the newly-generated microflows.
2. Go to Teamcenter Extension V 3.0.0 and repeat the steps you did before in Teamcenter Extension V 1.0.0. Simply select the same entities and associations, as they already exist in your domain model.
3. Go over the errors caused by the missing microflows and implement the newly-generated microflows. 
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.