Search Item Revisions
Introduction
The Search Item Revisions integration allows you to generate the domain model and microflow to search for an Item Revision or its specialization. The resulting microflow implements the out of the box saved query Item Revision... from Teamcenter.
This document takes you through a use case of retrieving 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. Since a Part Revision is a subtype of an Item Revision, it can be revised.
Step-by-Step guide
Follow these steps to create the integration:
-
Make sure you have set up your credentials on the Settings tab before following these instructions. For more instructions on how to configure your settings, follow the steps in the Settings Tab section of Teamcenter Extension.
-
Click the Search Item Revision button on the home page to start configuring your integration.
-
The Import Mapping page is displayed. This determines what data is retrieved from Teamcenter, and what type of objects are created in Mendix.
Click one of the placeholder entities to start the import mapping.
-
In the object mapping panel that opens, follow these steps:
- The left side shows all Teamcenter objects retrieved from the Teamcenter instance. These can be out-of-the-box or custom. For this use case, select
Part Revision (Part Revision), which can be found underItem Revision. - The right side shows the relevant Mendix entities for which objects can be created when retrieving Item Revisions from Teamcenter. For this use case, you want to have an entity specifically for
Part Revisions, so you can make changes and add new attributes to it. As such, selectTcConnector.ItemRevision. - Select the Create new Specialization of selected entity checkbox. The entity is automatically named
PartRevisionafter the Teamcenter Object name, but it can be renamed here if required. - Click OK to finish the object mapping and close the object mapping panel.
- The left side shows all Teamcenter objects retrieved from the Teamcenter instance. These can be out-of-the-box or custom. For this use case, select
-
Once you close the object mapping panel, the attributes and associations sidebar is displayed. From here, select the properties you want to have within your Mendix app. For this use case, you want to create an integration to retrieve additional Part Revision details. From the side panel, select the following attributes to add to the
Part Revisionentity:Finish TypeMulti-bodySafety PartStandardSpare PartTechnology Intent
Once selected, click the backdrop or the close button to close the side panel.
-
Click the Generate button to generate the appropriate domain model and microflows, so that you can start retrieving Part Revisions in your application.
Once the generation is complete, you are redirected to the History tab, which displays a summary of what has been generated.
Result
The following sections describe the resulting domain model and microflows.
Domain Model
The extension generated the following entities in your domain model:
PartRevision– This entity represents aPartRevisionfrom Teamcenter. The objects can be retrieved viaPartRevision_SavedQueryItemRevision.
Microflows
The extension generated the following microflows in your project:
-
PartRevision_SavedQueryItemRevision- This microflow can be used to retrieve a list of Part Revisions from Teamcenter.
The microflow receives the following two input parameters:ConfigName– This must be theconfigNameon aTcConnection.TeamcenterConfigurationobject.
It determines which Teamcenter configuration will be used to connect to Teamcenter. If only one Teamcenter Configuration is used, the parameter can be left empty.ItemRevisionSearchCriteria– This is required and must be used as input argument while searching for Item Revisions.
For hints on how to efficiently use this parameter, refer to Item Revision Search Criteria.
The microflow returns a list of Part Revisions that matches the SearchCriteria provided in the ItemRevisionSearchCriteria.
Tips and Tricks
Item Revision Search Criteria
- It is highly recommended to provide the
_Typefield, as it significantly optimizes theItemRevision_SavedQueryItemRevisionmicroflow. The_typefield specifies which types ofItemRevisionswill be requested. The field should be set toPartRevisionto retrieve onlyPartRevisionsand specializations of it. - The
NameandItemIDfields of theItemRevisionSearchCriteriaparameter support wildcards. For example, ifNameis set toa*, all revisions whose name starts with anaare returned.