Add documentation for Teamcenter Connector

content/en/docs/partners/siemens/teamcenter-connector/_index.md

@@ -0,0 +1,41 @@
+---
+title: "Teamcenter Connector"
+url: /partners/siemens/teamcenter-connector/
+weight: 30
+description: "Describes the configuration and usage of the Teamcenter Connector, which allows the digital management of product and manufacturing data in the context of a product lifecycle."
+---
+
+## Introduction
+
+Teamcenter is a virtual gateway to your company’s product information, connecting all who need to collaborate with product and process knowledge. Teamcenter enables you to digitally manage your product and manufacturing data in the context of the product life cycle.
+
+Teamcenter Connector for Mendix enables Mendix developers to access product data from Teamcenter or create and modify product data in Teamcenter.
+
+This documentation provides guidance on using Teamcenter Connector for Mendix. It assumes that you are familiar with Mendix concepts, processes, and terminology for application development.
+
+## Prerequisites
+
+To use Teamcenter Connector for Mendix, you need the following:
+
+* Appropriate Teamcenter licenses
+* A running and accessible Teamcenter instance. The minimum Teamcenter version supported is version 2406.
+* The minimum Teamcenter X version supported is version 2506.
+* The minimum Teamcenter Security Services version supported is version 2406 and above.
+
+## Downloading Teamcenter Connector, the Sample Application, and Dependencies
+
+You must download the Teamcenter Connector for Mendixapp, the sample application, and the dependencies. 
+
+Teamcenter Connector for Mendix is available on the [Mendix Marketplace](https://marketplace.mendix.com/link/component/111627). To add the connector to your project:
+
+1. Open your Mendix Modeler project.
+2. Click the Marketplace icon on the menu bar to access the Mendix Marketplace.
+3. Search for or navigate to the Teamcenter Connector and click the link.
+4. On the Teamcenter Connector page, click **Download**.
+5. In the **Import Module** dialog box, click **Import**.    
+    The connector is imported in your project in the App Store Modules folder.
+6. Similarly, download the following applications from the Mendix Marketplace: 
+
+    * (Optional) Siemens PLM Software UI Resources. This application should be in the project that contains the Teamcenter Connector.
+    * (Optional) Teamcenter Connector Sample Application. The Sample Application contains sample microflows. You do not require to download the Sample Application in the same project that also contains the Teamcenter Connector.
+

content/en/docs/partners/siemens/teamcenter-connector/configuring-connection.md

@@ -0,0 +1,92 @@
+---
+title: "Configuring the Connection to Teamcenter"
+url: /partners/siemens/configuring-connection/
+weight: 1
+description: "Describes the connection configuration steps for Teamcenter."
+---
+
+## Configuring the Connection to Teamcenter
+
+To help administrators configure the connection to Teamcenter, the Teamcenter Connector contains configuration microflows and pages. To configure the connection to Teamcenter, the Mendix administrator must do the following:
+
+1. In the navigation, update the Default home page to connect to the **ExecuteAdminLogin** microflow.
+
+    {{< figure src="/attachments/partners/siemens/teamcenter/image005.png" alt="" class="no-border" >}}
+
+2. In navigation, update the **Role-based home pages** to connect to **AdminLogin** and **UserLogin** microflows based on the role.
+
+    {{< figure src="/attachments/partners/siemens/teamcenter/image010.png" alt="" class="no-border" >}}
+
+3. In navigation, update the **Home** menu items to include the **ExecuteAdminLogin** and **ExecuteLogin** microflows.
+
+    {{< figure src="/attachments/partners/siemens/teamcenter/image011.png" alt="" class="no-border" >}}
+
+4. In the security page of your project, add the respective administrator and user roles in the **User roles** tab.
+
+    {{< figure src="/attachments/partners/siemens/teamcenter/image012.png" alt="" class="no-border" >}}
+
+5. Run your project. The browser displays the AdminHomePage.
+
+    {{< figure src="/attachments/partners/siemens/teamcenter/image006.png" alt="" class="no-border" >}}
+
+6. Click the **TEAMCENTER CONFIGURATIONS** tile in the web browser.
+
+7. Click **New** in the Teamcenter Environment Configuration page.
+
+8. In the **Add Teamcenter Configuration** dialog box, specify the required fields and click **Save**.
+
+9. Once you have updated the Teamcenter configuration information, log on to Teamcenter using the **TEAMCENTER LOGIN** icon.
+
+In the previous steps, the configuration shows the Home page. If you want to customize the page that you finally see, create a new microflow that contains the **ExecuteAdminLogin** and the **ExecuteLogin** microflows. Update your **Default home page** and the **Home** menu item to connect to the microflow you created.
+
+In the security page of Teamcenter Connector, select the appropriate permissions for the new microflows you created.
+
+The Teamcenter Sample Application has a microflow called **MyAdminLogin** that uses the **ExecuteAdminLogin** service. Refer to that microflow for help.
+
+{{< figure src="/attachments/partners/siemens/teamcenter/image009.png" alt="" class="no-border" >}}
+
+## Configuring the Connection to Teamcenter with SSO {#teamcenter-sso}
+
+To configure the connection to Teamcenter with SSO, you must setup the Teamcenter connection, update Mendix settings, and specify proxy details in the host file.
+
+1. In the navigation, update the Default home page and the **Home** menu item to connect to the **ExecuteAdminLogin** microflow.
+
+    {{< figure src="/attachments/partners/siemens/teamcenter/image005.png" alt="" class="no-border" >}}
+
+2. Add the **SSO_RegisterRequestHandlers** microflow to your startup microflow. You can perform this step in the **Runtime** tab of the **Settings** panel.
+
+     {{< figure src="/attachments/partners/siemens/teamcenter/image007.png" alt="" class="no-border" >}}   
+
+3. Add any Teamcenter SSL certificates to the **Certificates** tab.
+
+4. Specify the proxy host details in the host file.
+
+    {{< figure src="/attachments/partners/siemens/teamcenter/proxy-host-details.png" alt="" class="no-border" >}}
+
+5. Run your project. The browser displays the AdminHomePage.
+
+    {{< figure src="/attachments/partners/siemens/teamcenter/image006.png" alt="" class="no-border" >}}
+
+6. Click the **TEAMCENTER CONFIGURATIONS** tile.
+
+7. Click **New** in the Teamcenter Environment Configuration page.
+
+8. In the **Add Teamcenter Configuration** dialog box, specify the required fields:
+
+    * **SSO Login Server URL**    
+      Specify the SSO Login Server URL in this format: `http://<hostname:portname>/login-service/weblogin/login_redirect`    
+      Example: `http://10.134.57.23/ssol/weblogin/login_redirect`
+
+    * **SSO Identity Server URL**    
+      Specify the SSO Identity Server URL in this format: `http://<hostname:portname/identity-service>`    
+      Example: `http://10.134.57.23/ssoi`
+
+    * **Teamcenter Application ID**    
+      Provide the existing Teamcenter Application ID from the Teamcenter Security Services Identity Service configuration.
+
+    * **Mendix Application ID**    
+      Create a new **Application Id** for your Mendix app in the Teamcenter Security Services Identity Service configuration and enter your Mendix application root URL in the Identity Service **Application Root URL** field.    
+      This action is required to redirect the browser to your Mendix app after successful authentication with Teamcenter Security Services.    
+      For more information about using SSO with Teamcenter, see the [Teamcenter Security Services](https://docs.sw.siemens.com/doc/282219420/PL20241125556497283.tss00001/xid373993) help.
+
+    {{< figure src="/attachments/partners/siemens/teamcenter/tc_connection_configuration.png" alt="" class="no-border" >}}

content/en/docs/partners/siemens/teamcenter-connector/designing-applications.md

@@ -0,0 +1,58 @@
+---
+title: "Designing Mendix Applications with Single or Multiple Active Teamcenter Configurations"
+linktitle: "Designing Mendix applications"
+url: /partners/siemens/designing-applications/
+weight: 3
+description: "Describes the process of designing Mendix application with single of multiple active Teamcenter configurations."
+---
+
+## Introduction
+
+Ensure that you perform the following steps when designing your Mendix applications, depending on single or multiple Teamcenter configurations.
+
+### Applications with a Single Active Teamcenter Configuration
+
+* Ensure that the value of the **EnableMultipleActiveConfig** constant in Mendix is **False**.
+
+   {{< figure src="/attachments/partners/siemens/teamcenter/image017.png" alt="" class="no-border" >}}
+
+* Ensure that the value of the **ConfigurationName** parameter in the java action to be used is empty.
+
+### Applications with Multiple Active Teamcenter Configurations
+
+* Ensure that the value of the **EnableMultipleActiveConfig** constant in Mendix is **True**.
+* Note down the value of the configuration name when designing the Mendix application with multiple Teamcenter configurations.
+* Ensure that the value of the **ConfigurationName** parameter in the java action has the configuration you want to use.
+* The configuration name can be passed dynamically or can be hardcoded. If it is hardcoded, ensure that the configuration name after application deployment is the same as that in the **ConfigurationName** parameter in the java actions.
+* To pass the configuration dynamically, add the logic to the application using microflows or java actions.
+
+### Creating Configurations that Contain Teamcenter Connection Information
+
+1. Run your project.
+2. Go to the Home page.
+3. Click the **TEAMCENTER CONFIGURATIONS** tile in the web browser.
+    {{< figure src="/attachments/partners/siemens/teamcenter/image006.png" alt="" class="no-border" >}}
+4. To create a new Teamcenter configuration, click **New**.
+    {{< figure src="/attachments/partners/siemens/teamcenter/image015.png" alt="" class="no-border" >}}
+5. In the **Add Teamcenter Configuration** dialog box, specify the required fields and click **Save**.
+6. If you have enabled SSO, ensure that you [specify the SSO information](/partners/siemens/configuring-connection/#teamcenter-sso).
+
+### Setting a Teamcenter Configuration as Active
+
+1. Run your project.
+2. Go to the Home page.
+3. Click the **TEAMCENTER CONFIGURATIONS** tile in the web browser.
+    {{< figure src="/attachments/partners/siemens/teamcenter/image006.png" alt="" class="no-border" >}}
+4. Select a Teamcenter configuration that you want to set as active or inactive and click **Toggle Active**.
+    {{< figure src="/attachments/partners/siemens/teamcenter/image015.png" alt="" class="no-border" >}}
+
+If you have setup multiple Teamcenter configurations, you can choose a specific Teamcenter configuration as follows:
+
+1. Run your project.
+2. Go to the Home page.
+3. Click the **TEAMCENTER CONFIGURATIONS** tile in the web browser.
+    {{< figure src="/attachments/partners/siemens/teamcenter/image006.png" alt="" class="no-border" >}}
+4. From the configurations list, click **Login** against the configuration that you want to use.
+    {{< figure src="/attachments/partners/siemens/teamcenter/image016.png" alt="" class="no-border" >}}
+5. In the page that appears, log on to the chosen configuration.
+

content/en/docs/partners/siemens/teamcenter-connector/documentation-references.md

@@ -0,0 +1,18 @@
+---
+title: "Documentation References"
+url: /partners/siemens/references/
+weight: 7
+description: "Provides information on obtaining additional documentation."
+---
+
+## Accessing the Teamcenter Connector Services JAVA Actions Documentation
+
+Teamcenter Connector services are provided through JAVA actions.
+
+You can refer to the Teamcenter Connector for Mendix - Domain Model, Microflows, and Services Reference documentation on Support Center. <!-- add html reference? -->
+
+## Generating the SOA API Documentation Used in Active Workspace
+
+You can generate SOA APIs that are used in Active Workspace by running the genSoaApi script.
+
+For more information, refer to the [Active Workspace Customization documentation](https://docs.sw.siemens.com/doc/282219420/PL20241125556497283.Configuration/xid1211135).

content/en/docs/partners/siemens/teamcenter-connector/services-included.md

@@ -0,0 +1,59 @@
+---
+title: "Using Teamcenter Services Included with the Teamcenter Connector"
+linktitle: "Using Included Teamcenter Services"
+url: /partners/siemens/using-included-services/
+weight: 5
+description: "Describes how to use Teamcenter services that are included in the connector."
+---
+
+## Introduction
+
+Teamcenter services are provided through Java actions. You can see the available services in the **Teamcenter** section of the **Toolbox**.
+
+{{< figure src="/attachments/partners/siemens/teamcenter/image019.png" alt="" class="no-border" >}}
+
+## Using Teamcenter Services through the Teamcenter Connector: Process Workflow
+
+{{< figure src="/attachments/partners/siemens/teamcenter/image018.png" alt="" class="no-border" >}}
+
+## Using Teamcenter Services Available in the Teamcenter Connector
+
+1. Design a microflow as per your business logic.
+2. Drag a service from the Teamcenter category of the toolbox into the microflow.
+3. Specify input parameters for the Teamcenter service.
+4. Specify how data is retrieved.
+5. Test your application.
+
+## Example: Using the Available Teamcenter Services
+
+The Sample Application has microflows that use the available services such as **CreateItem** and **Search**. Download the Teamcenter Connector Sample Application from the [Mendix Marketplace](https://appstore.mendix.com/link/component/111688), and import it into your project.
+
+## Handling Errors
+
+It is a good practice to set up error handling on all your Teamcenter services in a microflow.
+
+Use the **HandleServiceErrors** microflow to handle errors. To handle errors:
+
+1. In your microflow, right-click your Teamcenter service and choose **Set error handling**.
+2. In the **Error handling** dialog box, choose the [error handling component](/refguide/error-handling-in-microflows/).
+
+    {{< figure src="/attachments/partners/siemens/teamcenter/image020.png" alt="" class="no-border" >}}
+
+3. Drag the **Microflow call** service from the **Toolbox** to your microflow.
+
+    * Update the **Action** section of the microflow and select the **TcConnector.HandleServiceErrors** microflow.
+    * Update the **ServiceExeption** parameter and specify the type of error.
+
+       {{< figure src="/attachments/partners/siemens/teamcenter/image021.png" alt="" class="no-border" >}}
+
+4. Connect the **Microflow call** service with the service from where the error will originate.
+
+    {{< figure src="/attachments/partners/siemens/teamcenter/image022.png" alt="" class="no-border" >}}
+
+5. Right-click the anchor point of the Teamcenter service and choose **Set as error handler**.
+
+    {{< figure src="/attachments/partners/siemens/teamcenter/image023.png" alt="" class="no-border" >}}
+
+6. Specify an end event for your **Handle Service Errors** service.
+
+    {{< figure src="/attachments/partners/siemens/teamcenter/image024.png" alt="" class="no-border" >}}