Document Mendix inside Teamcenter (public Beta, 11.12)#11384
Conversation
|
Jonathan Diehl seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
wanchoorohan
left a comment
There was a problem hiding this comment.
Provided few suggestions.
|
@jdiehl |
MarkvanMents
left a comment
There was a problem hiding this comment.
I started reviewing this, but realize that there are a lot of things which are still awaiting confirmation/more documentation.
Can you let me know when this is ready for me to do more work on it?
|
I resolved all comments. @MarkvanMents can you continue your review? |
|
Thanks. Working on this. I'll let you know if I have any questions. |
Fixes grammar, punctuation, formatting, and clarity in the Mendix Inside Teamcenter feature documentation and cross-reference in the Teamcenter Connector page. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
MarkvanMents
left a comment
There was a problem hiding this comment.
Thanks for this PR @jdiehl, @brambrink, and @wanchoorohan
I've done some proofreading and have a number of questions/suggestions.
I have also asked @NicoletaComan to have a quick look as she is familiar with the Teamcenter documentation.
Please let me know if you have any questions about my changes in ad233c0.
| For information about embedding a Mendix web app as a native component inside Siemens Teamcenter Active Workspace, see [Mendix Inside Teamcenter](/refguide/mendix-client/mendix-inside-teamcenter/). This requires you to be using Mendix version 11.12.0 or above. | ||
|
|
There was a problem hiding this comment.
This seems much too specialized to have in the introduction of the Mendix Client page.
I think this might be better somewhere like https://docs.mendix.com/appstore/modules/siemens-plm/teamcenter-connector/ where people will be looking for Teamcenter information.
I've moved it there.
| For information about embedding a Mendix web app as a native component inside Siemens Teamcenter Active Workspace, see [Mendix Inside Teamcenter](/refguide/mendix-client/mendix-inside-teamcenter/). This requires you to be using Mendix version 11.12.0 or above. |
|
|
||
| | | Mendix | Teamcenter | Teamcenter Connector | | ||
| | --- | --- | --- | --- | | ||
| | **Beta** | 11.12 | 2512 | 2606.0.0 or above | |
There was a problem hiding this comment.
I still don't see this connector version in the Marketplace.
|
|
||
| #### CORS for TcSSO Published REST Service | ||
|
|
||
| Configure the [CORS settings](/refguide/cors-settings/) for the TcSSO Published REST Service that is included in the Teamcenter Connector and add your teamcenter host `https://your-teamcenter.example.com` to the Allowed Origins. |
There was a problem hiding this comment.
Imported the Teamcenter Connector but couldn't find where to change this setting. I couldn't see a Published REST Service as part of TcConnector 2512.1.1. Is it in 2606, or am I looking in the wrong place?
|
|
||
| ### Adding the Component to Active Workspace | ||
|
|
||
| 1. Obtain the `MendixEmbedded` component from [GitHub](TBD). |
| To display the Mendix app on an Active Workspace page, add a card definition for it to the relevant `layoutsViewModel.json` file in your Active Workspace stage repository. Set `declarativeKeyContext` to the URL of your Mendix runtime: | ||
|
|
||
| ```json | ||
| "Mendix": { |
There was a problem hiding this comment.
I assume this is just an example name? I think we should make it clearer that this is an example.
| } | ||
| ``` | ||
|
|
||
| Add `"Mendix"` to the relevant layout handler grid and rebuild Active Workspace. If the Mendix card does not appear after rebuilding, clear the browser cache to ensure the new chunk is loaded. |
There was a problem hiding this comment.
Is this "Mendix" as in the json object, or "Mendix" as in the "title" of the json object?
| For the GA release we plan to offer an alternative authentication flow that is fully invisible and does not require a popup. | ||
| {{% /alert %}} | ||
|
|
||
| Follow these steps to configure authentication. Steps 1–3 require Teamcenter administrator access. |
There was a problem hiding this comment.
You say that administrator access is required on each step. I don't think we need it here as well.
|
|
||
| Register the Mendix app in the Teamcenter Deployment Center so TcSS can authenticate it. For instructions, see [Registering Your App for Teamcenter SSO](/appstore/modules/siemens-plm/configuring-connection-2512/#register-your-app-for-teamcenter-sso). | ||
|
|
||
| This step requires administrator access to Teamcenter. |
There was a problem hiding this comment.
Perhaps make this more obvious?
And the other ones below as well?
| This step requires administrator access to Teamcenter. | |
| {{% alert color="info" %}}This step requires administrator access to Teamcenter.{{% /alert %}} |
|
|
||
| ## Known Limitations (Beta) | ||
|
|
||
| * **Cross-site cookies:** The browser must allow cross-site cookies for the Mendix domain. This is required because the Mendix app runs on a different origin than Active Workspace. Configure this per-domain via organization policy (for example, Intune). |
There was a problem hiding this comment.
Is this really a limitation? It is not something that we can even change so I would say it is a prerequisite.
|
|
||
| * **Cross-site cookies:** The browser must allow cross-site cookies for the Mendix domain. This is required because the Mendix app runs on a different origin than Active Workspace. Configure this per-domain via organization policy (for example, Intune). | ||
| * **Authentication popup:** During Beta, the Teamcenter Connector SSO flow opens a popup window. This can be automated to require zero additional clicks after the user is already authenticated with TcSS. | ||
| * **Optional parameters fallback:** If an optional startup parameter is omitted, the embedded client shows the fallback page rather than using the parameter's default value. This is a known limitation of the embedded client. See [Embedding the Client](/refguide/mendix-client/embedding-the-client/). |
There was a problem hiding this comment.
This is currently noted as a known issue. I think we should be consistent in the language here. If it is an issue there is an implication that we will fix it in the future.
| * **Optional parameters fallback:** If an optional startup parameter is omitted, the embedded client shows the fallback page rather than using the parameter's default value. This is a known limitation of the embedded client. See [Embedding the Client](/refguide/mendix-client/embedding-the-client/). | |
| * **Optional parameters fallback:** If an optional startup parameter is omitted, the embedded client shows the fallback page rather than using the parameter's default value. This is a known issue with the embedded client. See [Embedding the Client](/refguide/mendix-client/embedding-the-client/). |
| * The browser allows cross-site cookies for the Mendix domain. This can be configured per-domain via organization policy (for example, using Intune). | ||
| * There is bidirectional network connectivity between the user's browser and both the Mendix runtime and the Teamcenter server. | ||
|
|
||
| For Teamcenter Connector prerequisites, see [Teamcenter Connector](/appstore/modules/siemens-plm/teamcenter-connector/). |
There was a problem hiding this comment.
Direct path to the prereqs: /appstore/modules/siemens-plm/teamcenter-connector/#prerequisites
| * **Use persistable object IDs only.** Pass `Item` UIDs or `ItemRevision` UIDs. These are stable and unique across sessions. | ||
| * **Avoid non-persistable IDs.** BOM line IDs are runtime calculation results that lose synchronization when Teamcenter configuration rules change. Do not use them as parameters. | ||
| * **Prefer `Item` IDs over `ItemRevision` IDs** where possible. `Item` IDs are context-independent and do not depend on the revision rule in effect. | ||
| * **Discover available parameters** by referring to the Active Workspace documentation for a list of available context parameters. |
There was a problem hiding this comment.
Is there a link we can add to "Active Workspace documentation"?
| ## Known Limitations (Beta) | ||
|
|
||
| * **Cross-site cookies:** The browser must allow cross-site cookies for the Mendix domain. This is required because the Mendix app runs on a different origin than Active Workspace. Configure this per-domain via organization policy (for example, Intune). | ||
| * **Authentication popup:** During Beta, the Teamcenter Connector SSO flow opens a popup window. This can be automated to require zero additional clicks after the user is already authenticated with TcSS. |
There was a problem hiding this comment.
Small typo. Should be "pop-up".
|
|
||
| | | Mendix | Teamcenter | Teamcenter Connector | | ||
| | --- | --- | --- | --- | | ||
| | **Beta** | 11.12 or above | 2512 | 2606.0.0 or above | |
There was a problem hiding this comment.
| Beta | 11.12 or above | 2512 | 2606.0.0 or above |
@jdiehl, has version 2606.0.0 been released?
Description
New reference page under
/refguide/mendix-client/mendix-inside-teamcenter/documenting how to embed a Mendix web app as a native component inside Siemens Teamcenter Active Workspace using the embedded client.This builds on the embedded client documentation added by @WimJongeneel in #11204 and is tied to the 11.12 release.
Changes
refguide/runtime/mendix-client/mendix-inside-teamcenter.mdrefguide/runtime/mendix-client/_index.mdwith a cross-reference to the new pageCoverage
The new page covers:
MendixEmbeddedAWC component and registering it on a pagegateway/config.jsondirectives)