|
| 1 | +--- |
| 2 | +title: "Getting Started with Teamcenter Connector 2606" |
| 3 | +linktitle: "Getting Started" |
| 4 | +url: /appstore/industry/teamcenter-connector/unified-teamcenter-connector-getting-started/ |
| 5 | +weight: 10 |
| 6 | +description: "Describes how to install, configure, and build your first Teamcenter Connector 2606 integration in Mendix Studio Pro, including setup, security, connection settings, and generating microflows and entities from a Teamcenter service document." |
| 7 | +--- |
| 8 | + |
| 9 | +## Installation and Setup |
| 10 | + |
| 11 | +Follow these steps to install and set up Teamcenter Connector 2606: |
| 12 | + |
| 13 | +1. Download the module from Mendix Marketplace and import it in Studio Pro 11.12. |
| 14 | + You do not need to download Teamcenter Extension separately, since it is already included. |
| 15 | + |
| 16 | +2. Add the required dependencies. Make sure your app includes Community Commons and the Encryption module. These are both available in Mendix Marketplace. |
| 17 | + |
| 18 | +3. Configure security: |
| 19 | + |
| 20 | + 1. Assign the `TcConnector.User` role to the relevant user roles in your app's security settings. |
| 21 | + {{% alert color="info" %}} The **Administrator** role now only has access to `TcConnector.TeamcenterConfiguration`. For all integration work, use the **User** role. {{% /alert %}} |
| 22 | + 2. Click **Update Security** in Studio Pro to refresh entity access rules. |
| 23 | + |
| 24 | +4. Enable the React client from your app settings. This is required for the Teamcenter service document to work properly. |
| 25 | + |
| 26 | +## Contents of a Teamcenter Service Document |
| 27 | + |
| 28 | +These are the details included in a Teamcenter service document: |
| 29 | + |
| 30 | +* **Settings** – Configure the following: |
| 31 | + |
| 32 | + * The connection to your Teamcenter instance. This is required so the Teamcenter service document can communicate with Teamcenter to retrieve business objects and properties, which allow you to build artifacts per your use case. |
| 33 | + * Your authentication method, test the connection, and manage the sign-in state. You typically configure this once per Teamcenter service document, unless you need to switch environments. |
| 34 | + |
| 35 | + {{< figure src="/attachments/appstore/industry-components/teamcenter/teamcenter2606/service-document-settings.png" alt="Settings tab of the Teamcenter service document" max-width=70% >}} |
| 36 | + |
| 37 | +* **Integrations** – View and manage integrations: |
| 38 | + |
| 39 | + * Check out an overview of all the integrations you have configured in this document. |
| 40 | + * Check out the Teamcenter integration type, the entities and microflows that were generated, and when each integration was last modified. From here, you can: |
| 41 | + |
| 42 | + * View the details of an integration. |
| 43 | + * Edit an existing integration. |
| 44 | + * Duplicate an integration. This is useful for creating variations. |
| 45 | + * Delete integrations you no longer need. |
| 46 | + * Navigate directly to the generated microflows and entities by double-clicking them. |
| 47 | + |
| 48 | + * Add new integrations. |
| 49 | + |
| 50 | + {{< figure src="/attachments/appstore/industry-components/teamcenter/teamcenter2606/service-document-integrations.png" alt="Integrations tab of the Teamcenter service document" max-width=100% >}} |
| 51 | + |
| 52 | +You can have multiple Teamcenter service documents in a single app, each in its own module. This is useful for separating concerns. For example: |
| 53 | + |
| 54 | +* A **Parts** module with a Teamcenter service document for part-related integrations. |
| 55 | +* A **Workflows** module with a Teamcenter service document for workflow-related integrations. |
| 56 | +* A **Documents** module with a Teamcenter service document for dataset and document integrations. |
| 57 | + |
| 58 | +## Creating and Building a Teamcenter Service Document |
| 59 | + |
| 60 | +The following steps walk you through creating and building a Teamcenter service document. |
| 61 | + |
| 62 | +1. Create a Teamcenter service. |
| 63 | + |
| 64 | + 1. In the App Explorer, right-click the module where you want to create your integrations. |
| 65 | + 2. Select **Add other**, then select **Teamcenter service**. |
| 66 | + 3. Give the Teamcenter service a name, such as "PartsIntegrations" or "MainTeamcenterConnection". |
| 67 | + |
| 68 | +1. Configure your connection. |
| 69 | + |
| 70 | + 1. Navigate to the **Settings** tab of the Teamcenter service document. |
| 71 | + 2. Provide your Teamcenter authentication option and credentials. For details, refer to the [Settings tab](/appstore/industry/teamcenter-extension/create-an-integration/#settings-tab) section of the Teamcenter Extension *Creating an Integration* page. |
| 72 | + |
| 73 | +1. Test your connection. |
| 74 | + Once you have entered your connection details, click **Sign In** to test the connection. |
| 75 | + {{% alert color="warning" %}} 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 are always using the correct credentials with the correct Teamcenter environment. {{% /alert %}} |
| 76 | + |
| 77 | +1. Add your Teamcenter integration. |
| 78 | + |
| 79 | + 1. Click the **Integrations** tab at the top. |
| 80 | + 2. Click **Add integration**. Tiles representing all available integration types are displayed, such as **Search Item Revisions** and **Create Item with Item Revision**. |
| 81 | + 3. Click one of the integration type tiles to start configuring that specific type of integration. The **Object Mapping** page is displayed. |
| 82 | + |
| 83 | +1. Fill in the required information on the **Object Mapping** page: |
| 84 | + |
| 85 | + {{< figure src="/attachments/appstore/industry-components/teamcenter/teamcenter2606/object-mapping.png" alt="Object Mapping window" max-width=80% >}} |
| 86 | + |
| 87 | + 1. Teamcenter objects |
| 88 | + |
| 89 | + 1. Browse the Teamcenter object hierarchy. |
| 90 | + 2. Select the business object type you want to work with, such as **Item Revision** or **Dataset**. |
| 91 | + |
| 92 | + 2. Mendix entities |
| 93 | + |
| 94 | + 1. Choose whether to create a new entity or use an existing one. |
| 95 | + If you create a new entity, the Teamcenter service generates an entity that is a specialization of the selected entity. |
| 96 | + If you use an existing entity, you can select an entity you have already defined in your domain model. |
| 97 | + 2. When you are done, click **Select** to proceed. |
| 98 | + |
| 99 | + 3. Additional properties |
| 100 | + Once you have selected the Teamcenter object type and Mendix entity, you can add additional properties, references, and relations to the list of default selected properties. Follow these steps: |
| 101 | + |
| 102 | + 1. Double-click the entity or select an entity and click **Select Elements** at the top. |
| 103 | + 2. Use the checkboxes to indicate: |
| 104 | + |
| 105 | + * **Read** — Should this property be retrieved from Teamcenter? |
| 106 | + * **Write** — Should this property be sent to Teamcenter when creating or updating? Write checkboxes are only available in integrations where you can write data to Teamcenter. |
| 107 | + |
| 108 | + 3. From the **Property Mapping** window, select the properties you need for your integration. |
| 109 | + |
| 110 | + {{< figure src="/attachments/appstore/industry-components/teamcenter/teamcenter2606/property-mapping.png" alt="Property Mapping window" max-width=80% >}} |
| 111 | + |
| 112 | + 4. Teamcenter integration-specific panels |
| 113 | + Depending on the integration type you choose, an additional configuration dialog window may be displayed. For example: |
| 114 | + |
| 115 | + * Dataset integrations let you filter by dataset type. |
| 116 | + * BOM integrations let you configure BOM window properties and revision rules. |
| 117 | + |
| 118 | + Configure these integration-specific settings as needed. |
| 119 | + For more information on each of the Teamcenter integrations, refer to the [integration guides](/appstore/industry/teamcenter-extension/create-an-integration/integrations/). |
| 120 | + |
| 121 | +1. Generate your integration. |
| 122 | + Once you have configured everything, click **Generate**. The Teamcenter service document performs the following actions: |
| 123 | + |
| 124 | + * Validates your integration to make sure everything is correct. |
| 125 | + * Generates domain model entities, which are placed in your domain model as a tree for easy visualization. |
| 126 | + * Generates microflows that implement the integration logic. |
| 127 | + * Saves the integration to the Teamcenter service document. |
| 128 | + * Navigates to the **Integrations** tab where the integration is now listed. |
| 129 | + |
| 130 | +1. Explore the results. |
| 131 | + Once the Teamcenter service document is fully generated, you are automatically returned to the **Integrations** tab. You can find your newly created integration in the list, along with links to: |
| 132 | + |
| 133 | + * The generated microflows. Double-click to jump directly to them in Studio Pro. Double-click a microflow name to open it in Studio Pro, and see what exactly was generated. |
| 134 | + * The generated entities. Double-click to jump directly to the domain model. |
| 135 | + |
| 136 | + {{< figure src="/attachments/appstore/industry-components/teamcenter/teamcenter2606/integrations-result.png" alt="Results displayed on the Integration tab of the Teamcenter service window" max-width=100% >}} |
0 commit comments