diff --git a/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/_index.md b/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/_index.md new file mode 100644 index 00000000000..c3e3386d0a9 --- /dev/null +++ b/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/_index.md @@ -0,0 +1,40 @@ +--- +title: "Teamcenter Connector" +url: /appstore/modules/siemens-plm/teamcenter-connector/ +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. + diff --git a/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/configuring-connection.md b/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/configuring-connection.md new file mode 100644 index 00000000000..1284ad43e2a --- /dev/null +++ b/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/configuring-connection.md @@ -0,0 +1,92 @@ +--- +title: "Configuring the Connection to Teamcenter" +url: /appstore/modules/siemens-plm/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:///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://` + 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" >}} diff --git a/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/designing-applications.md b/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/designing-applications.md new file mode 100755 index 00000000000..7375db8fdb4 --- /dev/null +++ b/content/en/docs/marketplace/platform-supported-content/modules/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: /appstore/modules/siemens-plm/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. + diff --git a/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/documentation-references.md b/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/documentation-references.md new file mode 100644 index 00000000000..a782bbcdfd5 --- /dev/null +++ b/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/documentation-references.md @@ -0,0 +1,18 @@ +--- +title: "Documentation References" +url: /appstore/modules/siemens-plm/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 Reference](/partners/siemens/teamcenter-reference/) page. + +## 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). \ No newline at end of file diff --git a/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/services-included.md b/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/services-included.md new file mode 100755 index 00000000000..96bb80dbec5 --- /dev/null +++ b/content/en/docs/marketplace/platform-supported-content/modules/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: /appstore/modules/siemens-plm/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" >}} diff --git a/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/services-not-included.md b/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/services-not-included.md new file mode 100755 index 00000000000..31accee1d0c --- /dev/null +++ b/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/services-not-included.md @@ -0,0 +1,235 @@ +--- +title: "Using Teamcenter Services Not Included with the Teamcenter Connector" +linktitle: "Using Teamcenter Services Not Included" +url: /appstore/modules/siemens-plm/services-not-included/ +weight: 6 +description: "Describes how to use Teamcenter services that are not included in the connector." +--- + +## Overview + +The Teamcenter connector provides two APIs for calling any service operation that is part of Teamcenter Services. + +* **CallTeamcenterService** — Java action + + This Java action can be used directly in any microflow and maps the Mendix domain entities to or from the JSON data structures that are used by Teamcenter Services operations. + +* **TcConnection.callTeamcenterService** — Java method + + This Java method can only be used from within the Java code and requires that the caller create and parse JSONObjects directly for the call. The **TcConnector** class also exposes an entity version of the **callTeamcenterService** method that matches the Java action. + +Both APIs have general error handling and take care of the Teamcenter server session management. The **Login** service operation must be called before calling any other service operation using these APIs. The **ShowLoginPage** and **ExecuteLogin** microflows perform this function. + +## Using the Java Action + +The **CallTeamcenterService** Java action is the entry point for calling Teamcenter service operations from a microflow. This Java action allows the developer to create a custom mapping between the Teamcenter service operation and the Mendix Domain Model entities. This Java action takes the following arguments: + +* **Service Name**: The name of the Teamcenter service operation +* **Input Argument**: The entity containing the input data for the service operation. +* **Response Object**: The entity instance to which the service operation response will be written. This may be any entity type that extends from **ServiceResponse**. +* **Operation Mapping**: The mapping definition for this service operation. +* **Business Object Mapping**: The mapping of Teamcenter business object names to Mendix entity names. +* **ConfigurationName**: The Teamcenter configuration name to be used to perform this action. In case of single active connection pass the configuration name or empty value. + +### Operation mapping + +This maps a Teamcenter service operation request and a response each to the Mendix entities. The mapping is defined as a JSON document, either a as a file or provided as an input string to the **CallTeamcenterService** Java action. The JSON schema for an operation mapping document is as follows: + +``` +{ +ServiceOperation: The operation name (Core-2011-06-Session/login). +InputType: The Entity type to map the input from. +ResponseType: The Entity type to map the response to. +ObjectMapping: The business object mappings. +OperationInput: The template for the service operation input. Must represent the complete service operation input. +OperationResponse: The template for the service operation response. May contain only the specific elements of the response that are mapped. +} +``` + +Within the **OperationInput** and **OperationResponse** templates, values are either hard coded or use the **$Input** or **$Response** substitution keywords. These substitution keys have the following syntax: + +``` +$Input[/Association][;Instruction] +$Response[/Association] +``` + +Where: + +* **Association** — Optional association name on the given entity type. Multiple associations can be sequenced, each separated by a '/'. +* **Attribute** — Optional attribute name on the given entity type. +* **Instruction** — Optional instruction to be applied to the substitution. Multiple instructions can be used, each separated with a semicolon. The supported instructions are: +* **AttributeAsArray** — single valued JSONArray for each attribute value. +* **DateFormat=Format** — Use the custom date format for serializing date attributes. +* **ignoreNull** – Use to omit the key if the value of that key is null. + +Examples of which attributes that will be mapped: + +* **$Input** – The full entity +* **$Input/TcConnector.itemRev** – The entity referenced by the **TcConnector.itemRev** association +* **$Input/TcConnector.user/person** – The person attribute on the referenced entity (TcConnector.user association) +* **$Input;DateFormat=MM/dd/yyyy** – The full entity, with any date attributes serialized in the format mm/dd/yyyy + +{{% alert color="info" %}} This is a JSON document, so the forward slash ‘/’ character in any quoted string must be escaped ‘\/’. {{% /alert %}} + +A sample mapping JSON document: + +``` +{ + "ServiceOperation": "Cad-2007-01-StructureManagement\/createBOMWindows", + "InputType": "TcConnector.CreateBomWindowInput", + "ResponseType": "TcConnector.CreateBomWindowResponse", + "ObjectMapping": "BOMLine=TcConnector.BOMLine", + "OperationInput": + { "info": + [{ "clientId": "CreateBOMWindows", + "item": "", + "itemRev": "$Input\/TcConnector.itemRev", + "bomView": "", + "objectForConfigure": "", + "activeAssemblyArrangement":"", + "revRuleConfigInfo": + { "clientId": "", + "revRule": "$Input\/TcConnector.revRule", + "props": + { "unitNo": -1, + "date": "", + "today": true, + "endItem": "", + "endItemRevision": "", + "overrideFolders": + [{ "ruleEntry": "", + "folder": "" + }] + } + } + }] + }, + "OperationResponse": + { "output": + [{"bomLine": "$Response\/TcConnector.createBomWindowResponseBOMLine" + }] + } +} +``` + +### ExpandGRMRelationsForPrimary Example + +The SOA request and response structure for ‘Core-2007-09-DataManagement/expandGRMRelationsForPrimary’ are as follows: + +{{< figure src="/attachments/partners/siemens/teamcenter/image046.png" alt="" class="no-border" >}} + +To create the operation mapping, refer to the request and response entities and substitute the corresponding entity attributes and associations for the key or the structure. In this example we have created the entities structure as follows: + +{{< figure src="/attachments/partners/siemens/teamcenter/image047.png" alt="" class="no-border" >}} + +#### Request Entities + +* **ExpandGRMPrimaryInput** – Input entity. +* **Relation** – Represents the info structure in the request. +* **relations** – Many-to-one association between ExpandGRMPrimaryInput and Relation entities. +* **primaryObjects** – One-to-one association with list of model objects represents the **primaryObjects** key in request. + +#### Response Entities + +* **ExpandGRMPrimaryResponse** – Response Entity derived from ServiceResponse +* **relationshipObject** – Represents relationshipObjects structure in the response. +* **relationshipObjects** – many to One Association between ExpandGRMPrimaryResponse and relationshipObject entities. +* **otherSideObject** – One to One association with ModelObject represents the otherSideObject key in the response. + +Following is the operation mapping file for expandGRMRelationsForPrimary SOA call: + +{{< figure src="/attachments/partners/siemens/teamcenter/image048.png" alt="" class="no-border" >}} + +### CreateWorkflow Example + +The SOA request and response structure for ‘Workflow-2014-10-Workflow/createWorkflow’ are as follows: + +{{< figure src="/attachments/partners/siemens/teamcenter/image049.png" alt="" class="no-border" >}} + +To create the operation mapping, refer the request and response entities and substitute the corresponding entity attributes and associations for the key or the structure. In this example we have created the entities structure as follows: + +{{< figure src="/attachments/partners/siemens/teamcenter/image050.png" alt="" class="no-border" >}} + +#### Request Entities + +* **CreateWorkflowInput** – Input entity. +* **createWorkflowtRelationTypes** – Entity representing attachmentRelationTypes key in the request. +* **relationTypes** – One to Many Association between **CreateWorkflowInput** and **createWorkflowtRelationTypes** entities. +* **attachments** - One to Many Association between **CreateWorkflowInput** and **ModelObject** entities representing attachments key in the request. +* **assignedUser** - One to Many Association between **CreateWorkflowInput** and **User** entities representing **assignedUserList** key in the request. +* **responsibleParty** - One to One Association between **CreateWorkflowInput** and User entities representing **responsibleParty** key in the request. +* **workflowOwner** - One to One Association between **CreateWorkflowInput** and User entities representing **workflowOwner** key in the request. +* **processName** – String attribute on **CreateWorkflowInput** entity representing **processName** key in request. +* **processDescription** – String attribute on **CreateWorkflowInput** entity representing **processDescription** key in request. +* **processTemplate** – String attribute on **CreateWorkflowInput** entity representing **processTemplate** key in request. +* **dueDate** – Date and time attribute on **CreateWorkflowInput** entity representing **dueDate** key in request. +* **attachmentRelationTypes** – String attribute on **createWorkflowtRelationTypes** entity representing the **attachmentRelationTypes** key in request, which is array of strings, so we add the instruction **AttributeAsArray** after the path to attribute. This will take care to give the input to this key in form of array of strings. + +#### Response Entities + +* **CreateWorkflowResponse** – Response Entity derived from **ServiceResponse**. +* **workflowTask** – One to Many association between **CreateWorkflowResponse** and **EPMTask** entities representing **workflowTask** structure of the response. + +Following is the operation mapping file for createWorkflow SOA call: + +{{< figure src="/attachments/partners/siemens/teamcenter/image051.png" alt="" class="no-border" >}} + +#### Entity Mapping + +Mendix Domain Model entities are mapped to Teamcenter service operation data structures based on naming conventions. The Teamcenter structure element names (keys in JSON document) map one-to-one to the entity member (attributes or associations) names, with the following caveats: + +* The entity member name is prefixed with an underscore '_', for example '_type'. In this case the '_' is ignored, thus matching the Teamcenter name of 'type'. +* The entity member name is suffixed with '__XXX', for example, 'phone__Home'. In this case the '__Home' is ignored, thus matching the Teamcenter name of 'phone'. + +When traversing entities across associations, the entity names are not used. Only the associations between entities must match or be mappable. + +#### ModelObject Mapping + +The **ModelObject** entity is the Mendix Domain Model representation of a Teamcenter business object. Any entity that extends from **ModelObject** is considered to be a **ModelObject**. The mapping of **ModelObject** entities follows the general mapping of entity mapping (see previous section), with the following additions: + +* Member names defined directly on the ModelObject entity (UID, _Type...) are ignored. +* All other entity member names are mapped one-to-one with the business object type property name. +* Attributes of type `String` are the display value or localized value of the business object property, while attributes of other types (Boolean, Decimal, and Integer, Localized Date and time), are the database value of the business object property. To map a database value of a business object String property, the attribute name must be suffixed with '__DB' that is, 'description__DB'. + +#### Business object mapping + +This refers to the mapping of Teamcenter business object type names to Mendix entity names. This mapping is applied to the business objects that are returned from the service operation. The syntax for this mapping is a semicolon-separated list of Teamcenter or Mendix names. + +``` +BOMLine=TcConnector.BOMLine;ItemRevision=TcConnector.ItemRevision +``` + +For any business object returned from the service operation that is not in this mapping (that is, EngChange_Revision), the nearest mapped parent (ItemRevision) is instantiated. + +#### Error Handling + +The **CallTeamcenterService** Java action handles all non-service errors that occur during the processing of the service request. This includes networking errors (HTTP errors connecting to the Teamcenter server), session time-out, and parsing errors. These errors are displayed as an exception, and the calling microflow must set an error handler on the Java action and then create a flow from the Java action that is set as the error handler. This flow must display the **$latestError/Message** and then exit the microflow. + +## Using the Java Method + +The **callTeamcenterService** Java method (**tcconnector.foundation.TcConnection.callTeamcenterService**) is the entry point for calling Teamcenter service operations from the Java code. This Java method differs from the **CallTeamcenterService** Java action in that the input and output data are JSONObject versus Mendix entities. The developer is responsible to creating the JSONObject input that conforms to the Teamcenter service operation definition and parsing the returned JSONObject. This Java method takes 3 arguments: + +* **Service Name** – The name of the Teamcenter service operation. +* **Input Argument** – The JSONObject containing the input data for the service operation. +* **Policy** – The Object Property Policy defining which values should be returned. + +A JSONObject is returned from this method with the contents of the service operation response. All business object references (UIDs) throughout the response structure are replaced with the full ModelObject instance from the ServiceData. JSONObject instances that represent a ModelObject or ServiceData can be cast to JModelObject or JSerivceData: + +``` +JModelObject bomLine = (JModelObject)output.getJSONObject("bomline"); +JServiceData sd = (JServiceData)response.getJSONObject("serviceData"); +``` + +Both the JModelObject and JServiceData class have methods to conveniently access data on this structure and convert to Mendix entities. + +### The JModelObject Class + +The JModelObject class (**tcconector.foundation.JModelObject**) extends the JSONObject class to represent a single Teamcenter business object (ModelObject). This class has convenience methods to access property values and other elements defined on the ModelObject type. Conversation of a JModelObject to an entity uses ModelObject Mapping. + +### The JServiceData Class + +The JServiceData class (**tcconector.foundation.JServiceData**) extends the JSONObject class to represent the ServiceData structure common to most Teamcenter service operations. This class has convenience methods to access data in the ServiceData. Conversion of JServiceData to an entity uses ModelObject Mapping. + +### The JPolicy Class + +The JPolicy class (**tcconector.foundation.JPolicy**) extends the JSONObject class to represent an Object Property Policy. The Object Property Policy defines what properties should be returned from the service operation call for the given set of business object types. The JPolicy is constructed from Business Object Mapping, which defines a policy that includes all the entity member names. diff --git a/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/teamcenter-domain-model.md b/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/teamcenter-domain-model.md new file mode 100644 index 00000000000..d24fb211887 --- /dev/null +++ b/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/teamcenter-domain-model.md @@ -0,0 +1,165 @@ +--- +title: "Teamcenter Connector Domain Model" +url: /appstore/modules/siemens-plm/teamcenter-domain-model/ +weight: 4 +description: "Describes the Teamcenter Connector domain model." +--- + +## Introduction + +The Domain Model is a data model that describes the information in your application domain in an abstract way. It is central to the architecture of your application. The Domain Model consists of [entities](/refguide/entities/) and their relations that are represented by [associations](/refguide/associations/). + +The Teamcenter Connector for Mendix Domain Model represents Teamcenter business object types and their properties. + +You can view the Teamcenter Connector Domain Model by navigating to TcConnector > Domain Model from the **Project Explorer**. + +To export the Domain Model documentation, right-click the **Project Explorer** and choose **Export documentation**. The Domain Model documentation is exported as an HTML file. + +## Guidelines to Extend the Teamcenter Connector Domain Model + +The Domain Model in Mendix consists of entities, associations, and annotations. It is analogous to the Teamcenter data model. When you want to extend the Domain Model, ensure that: + +* You extend the Domain Model in a separate module and not the Teamcenter Connector Domain Model. +* The entities and associations must match the corresponding Teamcenter object type names and their properties. You can find Teamcenter object types and properties in the Teamcenter Developer Documentation or in the Business Modeler IDE application in Teamcenter. + +## Example: Extending the Domain Model to Access Additional Information + +To access other object types or properties which are not already defined, you must add their definition to your app's Domain Model. This process is the same regardless of whether the object or property is OOTB or custom. + +The Teamcenter Business Modeler IDE view of a custom business object is as follows. It is a child of the **ItemRevision** object and contains two new properties. + +The Mendix Domain Model entity that you must create to retrieve these properties is as follows. + +{{< figure src="/attachments/partners/siemens/teamcenter/image026.png" alt="" class="no-border" >}} + +1. Examine the Teamcenter object. + Examine the Teamcenter object and determine which properties you want to retrieve. + + 1. This object has **ItemRevision** as its parent. + + {{< figure src="/attachments/partners/siemens/teamcenter/image027.png" alt="" class="no-border" >}} + + 2. It defines two properties that you want to retrieve. + + {{< figure src="/attachments/partners/siemens/teamcenter/image028.png" alt="" class="no-border" >}} + +2. Create a new domain entity. + + 1. In your module's Domain Model, create a new entity. + + 2. Change the entity's name to match the Teamcenter object type name. + + {{< figure src="/attachments/partners/siemens/teamcenter/image030.png" alt="" class="no-border" >}} + + 3. Define the new entity's generalization to match the Teamcenter parent object type. + + {{< figure src="/attachments/partners/siemens/teamcenter/image031.png" alt="" class="no-border" >}} + +3. Define new attributes to match the Teamcenter properties. + Match the Teamcenter property name, attribute type, and other parameters to create the Mendix attribute. + + * Teamcenter + {{< figure src="/attachments/partners/siemens/teamcenter/image032.png" alt="" class="no-border" >}} + * Mendix + {{< figure src="/attachments/partners/siemens/teamcenter/image033.png" alt="" class="no-border" >}} + +The process is complete, and you can now use your new Mendix domain entity and its attributes. + +{{< figure src="/attachments/partners/siemens/teamcenter/image026.png" alt="" class="no-border" >}} + +Repeat this process for each object whose properties you want to work with. + +## Extending the Domain Model while Using Available Teamcenter Services + +* Create the required entities in a separate module as a subtype of an existing entity (specialized entity). + +* For example, if you want to create an entity for the `ChangeNoticeRevision` business object, you can create it as a subtype of the `ItemRevision` entity. In this case, the `ChangeNoticeRevision` entity is a specialized entity based on the ItemRevision entity. + +* If the required entity is available but the required properties are not available, create a subtype of the entity in a new module and then add the required properties to the new entity. + + {{% alert color="info" %}} Mendix recommends that you always create new entities and not make any changes to the entities that come with Teamcenter Connector. {{% /alert %}} + +* Design a microflow as per your business logic. + +* Drag a service from the **Teamcenter** section of the toolbox into the microflow. + +* Specify inputs for the Teamcenter service. + +* Instantiate and specify input parameters to the Teamcenter service. + +* Specify business object mapping to the Teamcenter service. + +* Specify how data is retrieved. + +* Test your application. + +## Example: Extend the Domain Model to Call a Service to Create a Change Notice Revision + +1. Create a module that represents the Change management domain. Skip this step if the module exists. + + {{< figure src="/attachments/partners/siemens/teamcenter/image034.png" alt="" class="no-border" >}} + +2. Define the Domain Model. + Create ChangeNotice and ChangeNoticeRevision entities based on the **TcConnector.Item** and **TcConnector.ItemRevision** entities. Skip this step if the entities exist. Ensure that the names and properties of the defined entity match the corresponding Teamcenter business object type name and properties. The Reference properties on Teamcenter object types must be represented as associations in the Mendix Domain Model. + + {{< figure src="/attachments/partners/siemens/teamcenter/image035.png" alt="" class="no-border" >}} + + You can find Teamcenter business objects and their properties in the Teamcenter Developer Documentation. + +3. Plan your microflow and decide what services you want to use. The Teamcenter services are available in the microflow Toolbox under the Teamcenter category. For creating a Change Notice Revision, the microflow typically consists of the following activities: + + {{< figure src="/attachments/partners/siemens/teamcenter/image036.png" alt="" class="no-border" >}} + +4. Select the appropriate Teamcenter service and drag it to your microflow. For example, you can use the Create Object service under the Teamcenter category to create a change notice. + + {{< figure src="/attachments/partners/siemens/teamcenter/image037.png" alt="" class="no-border" >}} + + Your microflow now appears as follows: + + {{< figure src="/attachments/partners/siemens/teamcenter/image038.png" alt="" class="no-border" >}} + +5. In your microflow, specify the input parameters that the Teamcenter service will use. The **CreateObject** service requires two input parameters: + + * An input variable or entity that contains the information required to create the change notice. + * The mapping between Teamcenter business object names and Mendix entities. In the following example, the input entity, is the default **TcConnector.CreateInput** parameter. + + {{< figure src="/attachments/partners/siemens/teamcenter/image039.png" alt="" class="no-border" >}} + +6. In the previous step, an existing input entity served as the input parameter. If you need specific properties to be sent as an input, you must create new input entities or specialize the default input entity and instantiate it. For example, to send properties specific to Change Notice and Change Notice Revision, you must specialize the **CreateInput** entity as follows: + + * In your Change Management module, create the entities **CNCreateInput** and **CNCompoundCreateInput** deriving from the **ItemCreateInput** and **ItemRevisionCompoundCreateInput** entities that are available in the Teamcenter connector. + + {{< figure src="/attachments/partners/siemens/teamcenter/image040.png" alt="" class="no-border" >}} + + * Provide input parameters to your microflow. When creating input parameters, ensure that you instantiate it if necessary. + Your microflow appears as follows: + + {{< figure src="/attachments/partners/siemens/teamcenter/image041.png" alt="" class="no-border" >}} + + The input parameter contains the instantiated entities **CNCreateInput** and **CNCompoundCreateInput**. + +7. You must also specify the **Business object mapping**, which is the mapping between an entity and the corresponding Teamcenter business object types that the microflow is dealing with. For example, the Teamcenter business object **ChangeNotice** is represented by the **ChangeManagement.ChangeNotice** entity and **ChangeNoticeRevision**, by the **ChangeManagement.ChangeNoticeRevision** entity. Thus, the mapping can be specified as: + + ``` + 'ChangeNotice=ChangeManagement.ChangeNotice;ChangeNoticeRevision=ChangeManagement.ChangeNoticeRevision' + ``` + +8. Retrieve the objects by dragging the **Retrieve** action to your microflow. + + * To retrieve response data use the **$createObjectResponse/ResponseData** association. + + {{< figure src="/attachments/partners/siemens/teamcenter/image042.png" alt="" class="no-border" >}} + + * To retrieve partial error data, drag the **Microflow call** action into your microflow and call the use the **TcConnector.ShowPartialErrors** microflow. + + {{< figure src="/attachments/partners/siemens/teamcenter/image043.png" alt="" class="no-border" >}} + + * To retrieve created objects use the **$ServiceData/Created** association. + + {{< figure src="/attachments/partners/siemens/teamcenter/image044.png" alt="" class="no-border" >}} + + Your microflow appears as follows: + + {{< figure src="/attachments/partners/siemens/teamcenter/image045.png" alt="" class="no-border" >}} + +9. Test your microflow. diff --git a/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/teamcenter-reference.md b/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/teamcenter-reference.md new file mode 100755 index 00000000000..d5c332b104b --- /dev/null +++ b/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/teamcenter-reference.md @@ -0,0 +1,5260 @@ +--- +title: "Teamcenter Connector Reference" +url: /appstore/modules/siemens-plm/teamcenter-reference/ +weight: 8 +description: "Lists and describes the Teamcenter Connector reference parameters." +--- + +## Domain model + +### Entities + +| Name | Generalization | Documentation | +| --- | --- | --- | +| `TcSession` | | Represents the data required for maintaining a session with a Teamcenter server. | +| `Cookie` | | HTTP Cookie | +| `SoaServiceRequest` | | This entity is used by TcConnector published APIs internally. | +| `Credentials` | | Credentials of the Teamcenter user. | +| `TcServerInfo` | | Entity to store the Teamcenter server information.
(Deprecated) | +| `BaseCreateInput` | | An input entity representing the createInputs key for forming request for the Core-2015-07-DataManagement/createRelateAndSubmitObjects2 Teamcenter service.

This is an abstract entity representing object properties common across Teamcenter types. | +| `CreateInput` | TcConnector.BaseCreateInput | Represents input entity for Core-2015-07-DataManagement/createRelateAndSubmitObjects2 Teamcenter service. | +| `CompndCreateInput` | TcConnector.BaseCreateInput | Input entity representing the createInputs/compoundCreateInput key for forming request for the Core-2015-07-DataManagement/createRelateAndSubmitObjects2 Teamcenter service.

This entity holds type referenced property name available on the CreateInput descriptor of the business object type. | +| `ItemCreateInput` | TcConnector.CreateInput | Input entity representing the createInputs key for forming request for the Core-2015-07-DataManagement/createRelateAndSubmitObjects2 Teamcenter service for creating Teamcenter Item.

This entity can only have the properties available on CreateInput descriptor of the business object type Item. | +| `ItemRevisionCompoundCreateInput` | TcConnector.CompndCreateInput | Input entity representing the createInputs/compoundCreateInput key for forming request for the Core-2015-07-DataManagement/createRelateAndSubmitObjects2 Teamcenter service for creating Teamcenter Item.

This entity holds the name of the type of Item Revision business object to be created. It has the same properties as available on CreateInput descriptor of the ItemRevision type. | +| `ModelObject` | | Represents an abstract entity representing a Teamcenter business object. | +| `Property` | | Represents name of the property. | +| `PropertyValue` | | Represents value of the property | +| `User` | TcConnector.ModelObject | Represents the User business object type from Teamcenter. | +| `ServiceData` | | ServiceData is part of ServiceResponse, It contains information regarding created, updated and deleted objects. It also has partial error information. | +| `UID` | | Represents unique identifier for Teamcenter business object. | +| `ItemRevision` | TcConnector.WorkspaceObject | Represents the ItemRevision business object type from Teamcenter. | +| `WorkspaceObject` | TcConnector.POM_application_object | Represents the Workspaceobject business object type from Teamcenter. | +| `POM_application_object` | TcConnector.ModelObject | Represents the POM_application_object business object type from Teamcenter. | +| `Pair` | | Represents name value pair. | +| `SearchInput` | | Input entity for the Query-2014-11-Finder/performSearch Teamcenter service. | +| `SearchCriteriaInput` | | The criteria used to perform search (string/string). For example, for object set search, the search criteria are parentUid and object set source string. | +| `FindSavedQueryInput` | | Input entity for the Query-2010-04-SavedQuery/findSavedQueries Teamcenter service. | +| `SearchCriteria_SavedQuery` | TcConnector.SearchCriteriaInput | Represents common search criteria for saved queries.
This is active workspace provider | +| `GeneralQuery` | TcConnector.SearchCriteria_SavedQuery | Represents input criteria for General Query.
This entity is used for the active workspace provider. | +| `ItemSimpleQuery` | TcConnector.SearchCriteria_SavedQuery | Represents input criteria for Item Simple Query.
This entity is used for the active workspace provider. | +| `ImanQuery` | TcConnector.POM_application_object | Represents the ImanQuery business object type from Teamcenter. | +| `Item` | TcConnector.WorkspaceObject | Represents the Item business object type from Teamcenter. | +| `ListOfModelObject` | | Represents a list of ModelObjects. This list is introduced to access objects to be displayed on the page through association. | +| `Group` | TcConnector.ModelObject | Represents the Group business object type from Teamcenter. | +| `ReviseInputs` | | Input entity for the Core-2013-05-DataManagement/reviseObjects Teamcenter service. | +| `ReviseItemRevision` | TcConnector.ReviseInputs | Map of property name (key) and property values (values) in string format, to be set on new object being created with revise. | +| `TeamcenterConfiguration` | | Entity to store the Teamcenter configuration. | +| `Dataset` | TcConnector.WorkspaceObject | Represents the Dataset business object type in Teamcenter. | +| `PSBOMView` | TcConnector.WorkspaceObject | Represents the PSBOMView business object type from Teamcenter. | +| `RevisionRule` | TcConnector.WorkspaceObject | Represents the RevisionRule business object type from Teamcenter. | +| `BOMLine` | TcConnector.ModelObject | Represents the BOMLine business object type in Teamcenter. | +| `CreateRelationInput` | | Input entity for the Core-2006-03-DataManagement/createRelations Teamcenter service.
Primary object, Secondary object and RelationType is input for the service. | +| `SessionUser` | TcConnector.User | Represents the Teamcenter session user.
(Deprecated) | +| `ServiceResponse` | | Represents an abstract entity representing a Teamcenter service response. | +| `SearchResponse` | TcConnector.ServiceResponse | Response entity for the Query-2014-11-Finder/performSearch Teamcenter service. | +| `ErrorStack` | | Represents the Teamcenter error stack. | +| `ImanRelation` | TcConnector.POM_application_object | Represents the ImanRelation business object type from Teamcenter. | +| `CreateRelationResponse` | TcConnector.ServiceResponse | Entity representing a response returned by the Core-2006-03-DataManagement/createRelations Teamcenter service.

Created relation is output of the service and can be retrieved using TcConnector.relation association with this entity. | +| `FindSavedQueryResponse` | TcConnector.ServiceResponse | Response entity for the Query-2010-04-SavedQuery/findSavedQueries Teamcenter service. | +| `ReviseObjectsResponse` | TcConnector.ServiceResponse | Response entity for the Core-2013-05-DataManagement/reviseObjects Teamcenter service. | +| `ReviseOutputResponse` | | The target object and the newly created revised objects. | +| `ReviseTreesResponse` | | List corresponding to the input target objects that holds mapping between the original objects and the copied objects. | +| `CreateBomWindowInput` | | Input entity for Cad-2007-01-StructureManagement/createBOMWindows Teamcenter service.
Item Revision and Revision Rule is input for the service. | +| `CreateBomWindowResponse` | TcConnector.ServiceResponse | Response entity for Cad-2007-01-StructureManagement/createBOMWindows Teamcenter service.
BOMLine entity is the output for the service. | +| `ExpandPSOneLevelInput` | | Input entity for the Cad-2007-01-StructureManagement/expandPSOneLevel Teamcenter service.
BOMLine is input for the service. | +| `ExpandPSOneLevelResponse` | TcConnector.ServiceResponse | Response entity for the Cad-2007-01-StructureManagement/expandPSOneLevel Teamcenter service.
First level children (as list of BOMLines) of given parent BOMLines is the output of the service. | +| `ReleaseStatus` | TcConnector.ModelObject | Represents the release status maturity of a WorkspaceObject. ReleaseStatus adds effectivity information used by Teamcenter assembly features for configuration. | +| `FileDocument` | System.FileDocument | Represents the subtype of System.FileDocument object. | +| `SavedGeneralQuery` | | Represents the input criteria for General Query. | +| `SavedItemSimpleQuery` | | Represents the input criteria for Item Simple Query. | +| `BOMWindow` | TcConnector.ModelObject | Represents the BOMWindow business object type in Teamcenter. | +| `Relation_BOMLine` | | Dataset object references attached by given relation name are returned. | +| `ChildrenObject` | | List of ExpandPSData children found for the associated parent. | +| `GetRevisionRulesResponse` | TcConnector.ServiceResponse | Response entity for the Cad-2007-01-StructureManagement/getRevisionRules Teamcenter service.
It contains RevisionRuleInfo | +| `RevisionRulesResponseOutput` | | List of RevisionRuleInfo which contains Revision rule. | +| `CreateWorkflowInput` | | Input entity for Workflow-2014-10-Workflow/createWorkflow Teamcenter service. | +| `CreateWorkflowResponse` | TcConnector.ServiceResponse | Response entity for Workflow-2014-10-Workflow/createWorkflow Teamcenter service. | +| `EPMTask` | TcConnector.WorkspaceObject | Represents the EPMTask business object type from Teamcenter. | +| `createWorkflowtRelationTypes` | | Entity to represent Attachment Relation Types, This has association with CreateWorkflowInput entity. | +| `GetAllTasksInput` | | Input entity for Workflow-2008-06-Workflow/getAllTasks Teamcenter service. | +| `EPMJob` | TcConnector.WorkspaceObject | Represents the EPMJob business object type from Teamcenter. | +| `GetAllTasksResponse` | TcConnector.ServiceResponse | Response entity for Workflow-2008-06-Workflow/getAllTasks Teamcenter service. | +| `PerformActionInput` | | Input entity for Workflow-2012-10-Workflow/performAction2 Teamcenter service. | +| `StringObject]` | | Entity represnt the the string array in the response. | +| `IntegerObject` | | Entity represnt the the integer array in the response. | +| `UpdatedPropertiesInput` | | List of PropInfo structure which consists of information about the objects and the property values to set. | +| `ValuesInput` | | Values of the property | +| `FindUsersTasksResponse` | TcConnector.ServiceResponse | Response entity for FindUsersTasksTeamcenter service. | +| `TaskInbox` | TcConnector.WorkspaceObject | Represents the TaskInbox business object type from Teamcenter. | +| `GetWorkflowTemplatesInput` | | Input entity for Workflow-2008-06-Workflow/getWorkflowTemplates Teamcenter service. | +| `GetWorkflowTemplatesResponse` | TcConnector.ServiceResponse | Response entity for Workflow-2008-06-Workflow/getWorkflowTemplates Teamcenter service. | +| `EPMTaskTemplate` | TcConnector.POM_application_object | Represents the EPMTaskTemplate business object type from Teamcenter. | +| `TC_Project` | TcConnector.POM_application_object | Represents the TC_Project business object type from Teamcenter. | +| `VariantRule` | TcConnector.WorkspaceObject | Represents the VariantRule business object type from Teamcenter. | +| `ConfigurationContext` | TcConnector.WorkspaceObject | Represents the ConfigurationContext business object type from Teamcenter. | +| `BomWindowPropFlagMap` | | Map of property name (key) and property values (values) in string format, to be set on info input to create BOM window. | +| `ParentObject` | | List of ExpandPSData children found for the associated parent. | +| `ExpandPSAllLevelsOutput` | | Response entity for the Cad-2007-01-StructureManagement/expandPSOneLevel Teamcenter service.
First level children (as list of BOMLines) of given parent BOMLines is the output of the service. | +| `ExpandPSAllLevelsResponse` | TcConnector.ServiceResponse | Response entity for the Cad-2007-01-StructureManagement/expandPSOneLevel Teamcenter service.
First level children (as list of BOMLines) of given parent BOMLines is the output of the service. | +| `TcServerInformation` | TcConnector.ServiceResponse | Entity to store the Teamcenter server information which is response entity for Core-2007-01-Session/getTCSessionInfo teamcenter service | +| `ExtraInfo` | | Represents additional teamcenter session infomation. | +| `Role` | TcConnector.POM_application_object | Represents the Role business object type from Teamcenter. | +| `PSBOMViewRevision` | TcConnector.WorkspaceObject | | +| `CloseBOMWindowslInput` | | | +| `HomePage` | | | +| `GetItemFromIdResponse` | TcConnector.ServiceResponse | | +| `ItemRevisionOutput` | | | +| `GetItemFromIdInput` | | | +| `RevisionIDs` | | | +| `ObjectTypeNames` | | | +| `ExpandGRMInput` | | | +| `ExpandGRMResponse` | TcConnector.ServiceResponse | | +| `Relation__` | | | +| `relationshipObject` | | | +| `RootTargetAttachments` | TcConnector.WorkspaceObject | | +| `ExpandPSOneLevel2Input` | | | +| `ExpandPSOneLevel2Response` | TcConnector.ServiceResponse | | +| `ParentChildWrapper` | | | +| `Parent__` | | | +| `Child` | | | +| `relatedObjectsEntity` | | | +| `namedRefListEntity` | | | +| `ExpandBOMParentChild` | | | +| `WhereUsedInput` | | | +| `WhereUsedResponseInfo` | | | +| `BooleanObject` | | | +| `GetInitialLOVValuesInputEntity` | | | +| `LovInputEntity` | | | +| `LOVFilterDataInputEntity` | | | +| `GetLOVValuesResponse` | TcConnector.ServiceResponse | | +| `LOVDataEntity` | | | +| `LOVValuesEntity` | | | +| `LOVInternalValue` | | | +| `LOVInternalValueType` | | | +| `LOVDisplayValue` | | | +| `LOVFilterDataOutputEntity` | | | +| `ListOfValues` | TcConnector.ModelObject | | +| `DummyModelObject` | TcConnector.ModelObject | | +| `ImanFile` | | | +| `Image` | System.Image | | +| `OAuthToken` | | | + +#### Entity `TcSession` + +Represents the data required for maintaining a session with a Teamcenter server. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| HostAddress | String (200) | | The HTTP(S) address of the Teamcenter server. | +| UserName | String (50) | | The Teamcenter user name for this session. | +| RequestCount | Long | 1 | Sequential count of service requests made to the Teamcenter server. This is used for creating the unique log correlation ID. | +| SSOEnabled | Boolean | false | | +| SSORedirectURL | String (1024) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| TeamcenterSession | System.Session | OneToMany | | + +#### Entity `Cookie` + +HTTP Cookie + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| Name | String (200) | | The cookie name | +| Value | String (200) | | The cookie value | +| Path | String (200) | / | The relative path to be applied to the cookie on subsequent requests | +| Secure | Boolean | false | If true the cookie should only be used on secure (HTTPS) requests. | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| Cookies | TcConnector.TcSession | OneToMany | | + +#### Entity `SoaServiceRequest` + +This entity is used by TcConnector published APIs internally. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| ServiceURL | String (200) | | | +| Cookies | String (2000) | | | +| LogCorrelationID | String (1000) | | | +| Body | String (unlimited) | | | + +##### Associations + +Entity `SoaServiceRequest` does not own any associations. + +#### Entity `Credentials` + +Credentials of the Teamcenter user. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| user | String (200) | | The Teamcenter user name of the user. | +| password | String (2048) | | The Teamcenter password or SSO token of the user. | +| group | String (200) | | The group ID for this session. | +| role | String (200) | | The role the user is performing in the group. | +| locale | String (20) | | The locale to be used by the Teamcenter server process for this session. | +| descrimator | String (200) | | Client defined identifier for this session. | +| LastError | String (2000) | | | + +##### Associations + +Entity `Credentials` does not own any associations. + +#### Entity `TcServerInfo` + +Entity to store the Teamcenter server information. +(Deprecated) + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| Version | String (200) | | | +| Group | String (200) | | | +| Syslog | String (200) | | | +| ServerID | String (200) | | | +| Locale | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| _user | TcConnector.TcServerInfo | OneToOne | | + +#### Entity `BaseCreateInput` + +An input entity representing the createInputs key for forming request for the Core-2015-07-DataManagement/createRelateAndSubmitObjects2 Teamcenter service. + +This is an abstract entity representing object properties common across Teamcenter types. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| __boName | String (200) | | Type name of the business object. | +| object_name | String (128) | | Name of the Teamcenter business object to be created. | +| object_desc | String (240) | | Description of the Teamcenter business object to be created. | + +##### Associations + +Entity `BaseCreateInput` does not own any associations. + +#### Entity `CreateInput` + +Represents input entity for Core-2015-07-DataManagement/createRelateAndSubmitObjects2 Teamcenter service. + +##### Generalization + +TcConnector.BaseCreateInput + +##### Attributes + +Entity `CreateInput` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| compoundCreateInput__0 | TcConnector.CompndCreateInput | OneToOne | | + +#### Entity `CompndCreateInput` + +Input entity representing the createInputs/compoundCreateInput key for forming request for the Core-2015-07-DataManagement/createRelateAndSubmitObjects2 Teamcenter service. + +This entity holds type referenced property name available on the CreateInput descriptor of the business object type. + +##### Generalization + +TcConnector.BaseCreateInput + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| __referencePropName | String (200) | | This entity holds type referenced property name available on the CreateInput descriptor of the Teamcenter business object type. | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| compoundCreateInput__0 | TcConnector.CompndCreateInput | OneToOne | | + +#### Entity `ItemCreateInput` + +Input entity representing the createInputs key for forming request for the Core-2015-07-DataManagement/createRelateAndSubmitObjects2 Teamcenter service for creating Teamcenter Item. + +This entity can only have the properties available on CreateInput descriptor of the business object type Item. + +##### Generalization + +TcConnector.CreateInput + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| item_id | String (128) | | Identifier of the Teamcenter Item to be created. | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| compoundCreateInput__0 | TcConnector.CompndCreateInput | OneToOne | | + +#### Entity `ItemRevisionCompoundCreateInput` + +Input entity representing the createInputs/compoundCreateInput key for forming request for the Core-2015-07-DataManagement/createRelateAndSubmitObjects2 Teamcenter service for creating Teamcenter Item. + +This entity holds the name of the type of Item Revision business object to be created. It has the same properties as available on CreateInput descriptor of the ItemRevision type. + +##### Generalization + +TcConnector.CompndCreateInput + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| item_revision_id | String (32) | | Revision Identifier of the Teamcenter Item Revision to be created. | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| compoundCreateInput__0 | TcConnector.CompndCreateInput | OneToOne | | + +#### Entity `ModelObject` + +Represents an abstract entity representing a Teamcenter business object. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| UID | String (1000) | | | +| _Type | String (200) | | | +| ClassName | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `Property` + +Represents name of the property. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| Name | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| Properties | TcConnector.ModelObject | OneToMany | | +| Property_Property | TcConnector.Property | OneToMany | | + +#### Entity `PropertyValue` + +Represents value of the property + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| Value | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| UIValues | TcConnector.Property | OneToMany | | +| DBValues | TcConnector.Property | OneToMany | | + +#### Entity `User` + +Represents the User business object type from Teamcenter. + +##### Generalization + +TcConnector.ModelObject + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| person | String (200) | | | +| userid | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| workflowOwner | TcConnector.CreateWorkflowInput | OneToOne | | +| taskinbox__ | TcConnector.TaskInbox | OneToOne | | +| user__ | TcConnector.User | OneToOne | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `ServiceData` + +ServiceData is part of ServiceResponse, It contains information regarding created, updated and deleted objects. It also has partial error information. + +##### Attributes + +Entity `ServiceData` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| ResponseData | TcConnector.ServiceResponse | OneToOne | | + +#### Entity `UID` + +Represents unique identifier for Teamcenter business object. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| UID | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| Deleted | TcConnector.ServiceData | OneToMany | | + +#### Entity `ItemRevision` + +Represents the ItemRevision business object type from Teamcenter. + +##### Generalization + +TcConnector.WorkspaceObject + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| item_id | String (128) | | | +| item_revision_id | String (32) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| items_tag | TcConnector.ItemRevision | OneToOne | | +| itemRev__BOMWindow | TcConnector.ItemRevision | OneToOne | ItemRevision object reference. | +| itemRevOfBOMLine | TcConnector.ItemRevision | OneToOne | | +| itemRevOfBOMLine__Parent | TcConnector.ItemRevision | OneToOne | | +| parentItemRev | TcConnector.WhereUsedResponseInfo | OneToOne | | +| bl_revision | TcConnector.ItemRevision | OneToOne | | +| checked_out_user | TcConnector.User | OneToMany | | +| release_status_list | TcConnector.WorkspaceObject | ManyToMany | | +| owning_user | TcConnector.User | OneToMany | | +| last_mod_user | TcConnector.User | OneToMany | | +| owning_group | TcConnector.Group | OneToMany | | +| owning_role | TcConnector.Role | OneToMany | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `WorkspaceObject` + +Represents the Workspaceobject business object type from Teamcenter. + +##### Generalization + +TcConnector.POM_application_object + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| object_name | String (128) | | | +| object_desc | String (240) | | | +| date_released | Date and time | | | +| checked_out | String (200) | | | +| checked_out_date | Date and time | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| checked_out_user | TcConnector.User | OneToMany | | +| release_status_list | TcConnector.WorkspaceObject | ManyToMany | | +| owning_user | TcConnector.User | OneToMany | | +| last_mod_user | TcConnector.User | OneToMany | | +| owning_group | TcConnector.Group | OneToMany | | +| owning_role | TcConnector.Role | OneToMany | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `POM_application_object` + +Represents the POM_application_object business object type from Teamcenter. + +##### Generalization + +TcConnector.ModelObject + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| creation_date | Date and time | | | +| last_mod_date | Date and time | | | +| object_string | String (4000) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| owning_user | TcConnector.User | OneToMany | | +| last_mod_user | TcConnector.User | OneToMany | | +| owning_group | TcConnector.Group | OneToMany | | +| owning_role | TcConnector.Role | OneToMany | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `Pair` + +Represents name value pair. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| Name | String (unlimited) | | | +| Value | String (unlimited) | | | + +##### Associations + +Entity `Pair` does not own any associations. + +#### Entity `SearchInput` + +Input entity for the Query-2014-11-Finder/performSearch Teamcenter service. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| providerName | String (200) | Awp0SavedQuerySearchProvider | | +| startIndex | Integer | 0 | | +| maxToLoad | Integer | 50 | | +| internalPropertyName | String (200) | `` | | +| maxToReturn | Integer | 50 | | +| searchFilterFieldSortType | String (200) | Priority | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| searchCriteria | TcConnector.SearchCriteriaInput | OneToOne | | + +#### Entity `SearchCriteriaInput` + +The criteria used to perform search (string/string). For example, for object set search, the search criteria are parentUid and object set source string. + +##### Attributes + +Entity `SearchCriteriaInput` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| searchCriteria | TcConnector.SearchCriteriaInput | OneToOne | | + +#### Entity `FindSavedQueryInput` + +Input entity for the Query-2010-04-SavedQuery/findSavedQueries Teamcenter service. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| queryNames | String (200) | | | + +##### Associations + +Entity `FindSavedQueryInput` does not own any associations. + +#### Entity `SearchCriteria_SavedQuery` + +Represents common search criteria for saved queries. +This is active workspace provider + +##### Generalization + +TcConnector.SearchCriteriaInput + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| utcOffset | String (200) | 330 | | +| searchID | String (200) | `` | | +| totalObjectsFoundReportedToClient | String (200) | `` | | +| lastEndIndex | String (200) | `` | | +| typeOfSearch | String (200) | ADVANCED_SEARCH | | +| queryUID | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| searchCriteria | TcConnector.SearchCriteriaInput | OneToOne | | + +#### Entity `GeneralQuery` + +Represents input criteria for General Query. +This entity is used for the active workspace provider. + +##### Generalization + +TcConnector.SearchCriteria_SavedQuery + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| Name | String (200) | | | +| Description | String (200) | | | +| _Type | String (200) | | | +| OwningUser | String (200) | | | +| OwningGroup | String (200) | | | +| CreatedAfter | Date and time | | | +| CreatedBefore | Date and time | | | +| ModifiedAfter | Date and time | | | +| ModifiedBefore | Date and time | | | +| ReleasedAfter | Date and time | | | +| ReleasedBefore | Date and time | | | +| WorkflowTemplateName | String (200) | | | +| CurrentTask | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| searchCriteria | TcConnector.SearchCriteriaInput | OneToOne | | + +#### Entity `ItemSimpleQuery` + +Represents input criteria for Item Simple Query. +This entity is used for the active workspace provider. + +##### Generalization + +TcConnector.SearchCriteria_SavedQuery + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| Name | String (200) | | | +| ItemID | String (200) | | | +| Description | String (200) | | | +| _Type | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| searchCriteria | TcConnector.SearchCriteriaInput | OneToOne | | + +#### Entity `ImanQuery` + +Represents the ImanQuery business object type from Teamcenter. + +##### Generalization + +TcConnector.POM_application_object + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| query_name | String (128) | | | +| query_desc | String (512) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| savedQueries | TcConnector.FindSavedQueryResponse | OneToMany | | +| owning_user | TcConnector.User | OneToMany | | +| last_mod_user | TcConnector.User | OneToMany | | +| owning_group | TcConnector.Group | OneToMany | | +| owning_role | TcConnector.Role | OneToMany | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `Item` + +Represents the Item business object type from Teamcenter. + +##### Generalization + +TcConnector.WorkspaceObject + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| item_id | String (128) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| items_tag | TcConnector.ItemRevision | OneToOne | | +| checked_out_user | TcConnector.User | OneToMany | | +| release_status_list | TcConnector.WorkspaceObject | ManyToMany | | +| owning_user | TcConnector.User | OneToMany | | +| last_mod_user | TcConnector.User | OneToMany | | +| owning_group | TcConnector.Group | OneToMany | | +| owning_role | TcConnector.Role | OneToMany | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `ListOfModelObject` + +Represents a list of ModelObjects. This list is introduced to access objects to be displayed on the page through association. + +##### Attributes + +Entity `ListOfModelObject` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| PrimaryOrSecondaryObjects | TcConnector.ListOfModelObject | OneToOne | | + +#### Entity `Group` + +Represents the Group business object type from Teamcenter. + +##### Generalization + +TcConnector.ModelObject + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| name | String (128) | | | +| roles | String (unlimited) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| group__ | TcConnector.Group | OneToOne | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `ReviseInputs` + +Input entity for the Core-2013-05-DataManagement/reviseObjects Teamcenter service. + +##### Attributes + +Entity `ReviseInputs` has no attributes. + +##### Associations + +Entity `ReviseInputs` does not own any associations. + +#### Entity `ReviseItemRevision` + +Map of property name (key) and property values (values) in string format, to be set on new object being created with revise. + +##### Generalization + +TcConnector.ReviseInputs + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| item_revision_id | String (200) | | | +| object_name | String (200) | | | +| object_desc | String (200) | | | + +##### Associations + +Entity `ReviseItemRevision` does not own any associations. + +#### Entity `TeamcenterConfiguration` + +Entity to store the Teamcenter configuration. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| ConfigName | String (200) | | | +| TCURL | String (200) | | Teamcenter URL | +| FMSURL | String (200) | | | +| SSOEnabled | Boolean | false | | +| SSOLoginURL | String (200) | | | +| SSOIdentityURL | String (200) | | | +| SSOTCAppId | String (200) | | | +| SSOMendixAppId | String (200) | | | +| Active | Boolean | false | | +| IsTcX | Boolean | false | | +| TcxClientId | String (200) | | | +| TokenExchangeClientId | String (200) | | | +| TokenExchangeClientSecret | String (200) | | | +| TokenExchTokenEndPt | String (unlimited) | | | + +##### Associations + +Entity `TeamcenterConfiguration` does not own any associations. + +#### Entity `Dataset` + +Represents the Dataset business object type in Teamcenter. + +##### Generalization + +TcConnector.WorkspaceObject + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| dataset_type | String (32) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| datasets | TcConnector.ChildrenObject | OneToMany | | +| parentDatasets | TcConnector.ParentObject | OneToMany | | +| Documents | TcConnector.FileDocument | ManyToMany | | +| datasets__ | TcConnector.ItemRevisionOutput | OneToMany | | +| relatedObject | TcConnector.relatedObjectsEntity | OneToOne | | +| Images | TcConnector.Image | ManyToMany | | +| checked_out_user | TcConnector.User | OneToMany | | +| release_status_list | TcConnector.WorkspaceObject | ManyToMany | | +| owning_user | TcConnector.User | OneToMany | | +| last_mod_user | TcConnector.User | OneToMany | | +| owning_group | TcConnector.Group | OneToMany | | +| owning_role | TcConnector.Role | OneToMany | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `PSBOMView` + +Represents the PSBOMView business object type from Teamcenter. + +##### Generalization + +TcConnector.WorkspaceObject + +##### Attributes + +Entity `PSBOMView` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| bom_view | TcConnector.PSBOMView | OneToOne | | +| checked_out_user | TcConnector.User | OneToMany | | +| release_status_list | TcConnector.WorkspaceObject | ManyToMany | | +| owning_user | TcConnector.User | OneToMany | | +| last_mod_user | TcConnector.User | OneToMany | | +| owning_group | TcConnector.Group | OneToMany | | +| owning_role | TcConnector.Role | OneToMany | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `RevisionRule` + +Represents the RevisionRule business object type from Teamcenter. + +##### Generalization + +TcConnector.WorkspaceObject + +##### Attributes + +Entity `RevisionRule` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| revRule__BOMWindow | TcConnector.RevisionRule | OneToOne | The RevisionRule object used for configuration of this BOMWindow object. | +| revRule | TcConnector.RevisionRule | OneToOne | | +| rule | TcConnector.WhereUsedInput | OneToOne | | +| revision_rule | TcConnector.RevisionRule | OneToOne | | +| checked_out_user | TcConnector.User | OneToMany | | +| release_status_list | TcConnector.WorkspaceObject | ManyToMany | | +| owning_user | TcConnector.User | OneToMany | | +| last_mod_user | TcConnector.User | OneToMany | | +| owning_group | TcConnector.Group | OneToMany | | +| owning_role | TcConnector.Role | OneToMany | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `BOMLine` + +Represents the BOMLine business object type in Teamcenter. + +##### Generalization + +TcConnector.ModelObject + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| object_string | String (4000) | | Stores the Display Name value of the business objects. | +| bl_rev_object_name | String (200) | | | +| bl_has_children | Boolean | false | Has children? | +| bl_quantity | String (200) | | Quantity. Value is integer if unit of measure of the line is each. Quantities of packed lines are accumulated to the master line. | +| bl_variant_state | String (200) | | | +| bl_plmxml_abs_xform | String (1000) | | | +| bl_item_item_revision | String (400) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| bomLine__BOMWindow | TcConnector.CreateBomWindowResponse | OneToOne | Object reference for the created BOMLine | +| bomLine__ExpandPSOneLevel | TcConnector.BOMLine | OneToOne | | +| bomLine__ExpandPSAllLevel | TcConnector.BOMLine | OneToOne | | +| bomLine__Parent | TcConnector.Parent__ | OneToOne | | +| BOMLineAttachments | TcConnector.FileDocument | ManyToMany | | +| bomLine__Child | TcConnector.Child | OneToOne | | +| ChildBOMLines | TcConnector.ExpandBOMParentChild | OneToMany | | +| ParentBOMLIne | TcConnector.ExpandBOMParentChild | OneToOne | | +| bl_revision | TcConnector.ItemRevision | OneToOne | | +| top_line | TcConnector.BOMLine | OneToOne | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `CreateRelationInput` + +Input entity for the Core-2006-03-DataManagement/createRelations Teamcenter service. +Primary object, Secondary object and RelationType is input for the service. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| relationType | String (200) | | Name of the relation type to create. | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | + +#### Entity `SessionUser` + +Represents the Teamcenter session user. +(Deprecated) + +##### Generalization + +TcConnector.User + +##### Attributes + +Entity `SessionUser` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| _user | TcConnector.TcServerInfo | OneToOne | | +| workflowOwner | TcConnector.CreateWorkflowInput | OneToOne | | +| taskinbox__ | TcConnector.TaskInbox | OneToOne | | +| user__ | TcConnector.User | OneToOne | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `ServiceResponse` + +Represents an abstract entity representing a Teamcenter service response. + +##### Attributes + +Entity `ServiceResponse` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| ResponseData | TcConnector.ServiceResponse | OneToOne | | + +#### Entity `SearchResponse` + +Response entity for the Query-2014-11-Finder/performSearch Teamcenter service. + +##### Generalization + +TcConnector.ServiceResponse + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| totalFound | Integer | 0 | | +| totalLoaded | Integer | 0 | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| ResponseData | TcConnector.ServiceResponse | OneToOne | | + +#### Entity `ErrorStack` + +Represents the Teamcenter error stack. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| ClientID | String (200) | | | +| ClientIndex | Integer | 0 | | +| Code | Integer | 0 | | +| Level | Integer | 0 | | +| Message | String (unlimited) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| PartialErrors | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | + +#### Entity `ImanRelation` + +Represents the ImanRelation business object type from Teamcenter. + +##### Generalization + +TcConnector.POM_application_object + +##### Attributes + +Entity `ImanRelation` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| relation | TcConnector.CreateRelationResponse | OneToMany | The newly created relation. | +| primary_object | TcConnector.ImanRelation | OneToOne | | +| secondary_object | TcConnector.ImanRelation | OneToOne | | +| owning_user | TcConnector.User | OneToMany | | +| last_mod_user | TcConnector.User | OneToMany | | +| owning_group | TcConnector.Group | OneToMany | | +| owning_role | TcConnector.Role | OneToMany | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `CreateRelationResponse` + +Entity representing a response returned by the Core-2006-03-DataManagement/createRelations Teamcenter service. + +Created relation is output of the service and can be retrieved using TcConnector.relation association with this entity. + +##### Generalization + +TcConnector.ServiceResponse + +##### Attributes + +Entity `CreateRelationResponse` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| ResponseData | TcConnector.ServiceResponse | OneToOne | | + +#### Entity `FindSavedQueryResponse` + +Response entity for the Query-2010-04-SavedQuery/findSavedQueries Teamcenter service. + +##### Generalization + +TcConnector.ServiceResponse + +##### Attributes + +Entity `FindSavedQueryResponse` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| ResponseData | TcConnector.ServiceResponse | OneToOne | | + +#### Entity `ReviseObjectsResponse` + +Response entity for the Core-2013-05-DataManagement/reviseObjects Teamcenter service. + +##### Generalization + +TcConnector.ServiceResponse + +##### Attributes + +Entity `ReviseObjectsResponse` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| ResponseData | TcConnector.ServiceResponse | OneToOne | | + +#### Entity `ReviseOutputResponse` + +The target object and the newly created revised objects. + +##### Attributes + +Entity `ReviseOutputResponse` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| output | TcConnector.ReviseObjectsResponse | OneToMany | | + +#### Entity `ReviseTreesResponse` + +List corresponding to the input target objects that holds mapping between the original objects and the copied objects. + +##### Attributes + +Entity `ReviseTreesResponse` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| reviseTrees | TcConnector.ReviseObjectsResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| childReviseNodes | TcConnector.ReviseTreesResponse | OneToMany | | + +#### Entity `CreateBomWindowInput` + +Input entity for Cad-2007-01-StructureManagement/createBOMWindows Teamcenter service. +Item Revision and Revision Rule is input for the service. + +##### Attributes + +Entity `CreateBomWindowInput` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| itemRev__BOMWindow | TcConnector.ItemRevision | OneToOne | ItemRevision object reference. | +| revRule__BOMWindow | TcConnector.RevisionRule | OneToOne | The RevisionRule object used for configuration of this BOMWindow object. | +| configContext | TcConnector.CreateBomWindowInput | OneToOne | | +| bomWinPropFlagMap | TcConnector.BomWindowPropFlagMap | OneToOne | | +| CreateBomWindowInput_CreateBomWindowResponse | TcConnector.CreateBomWindowResponse | OneToOne | | + +#### Entity `CreateBomWindowResponse` + +Response entity for Cad-2007-01-StructureManagement/createBOMWindows Teamcenter service. +BOMLine entity is the output for the service. + +##### Generalization + +TcConnector.ServiceResponse + +##### Attributes + +Entity `CreateBomWindowResponse` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| bomLine__BOMWindow | TcConnector.CreateBomWindowResponse | OneToOne | Object reference for the created BOMLine | +| bomWindow__BOMWindow | TcConnector.BOMWindow | OneToOne | | +| CreateBomWindowInput_CreateBomWindowResponse | TcConnector.CreateBomWindowResponse | OneToOne | | +| ResponseData | TcConnector.ServiceResponse | OneToOne | | + +#### Entity `ExpandPSOneLevelInput` + +Input entity for the Cad-2007-01-StructureManagement/expandPSOneLevel Teamcenter service. +BOMLine is input for the service. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| RelationName | String (200) | | | + +##### Associations + +Entity `ExpandPSOneLevelInput` does not own any associations. + +#### Entity `ExpandPSOneLevelResponse` + +Response entity for the Cad-2007-01-StructureManagement/expandPSOneLevel Teamcenter service. +First level children (as list of BOMLines) of given parent BOMLines is the output of the service. + +##### Generalization + +TcConnector.ServiceResponse + +##### Attributes + +Entity `ExpandPSOneLevelResponse` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| ResponseData | TcConnector.ServiceResponse | OneToOne | | + +#### Entity `ReleaseStatus` + +Represents the release status maturity of a WorkspaceObject. ReleaseStatus adds effectivity information used by Teamcenter assembly features for configuration. + +##### Generalization + +TcConnector.ModelObject + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| name | String (32) | | | +| effectivity_text | String (1000) | | The property “effectivity_text” is a runtime string which represents the start to end effectivity of the “ReleaseStatus” object. “effectivity_text” will be displayed in an easy to understand format so that the user can easily identify the start date and end date effectivity of the “ReleaseStatus” object. “effectivity_text” will also display the start serial number and end serial numbers of the “ReleaseStatus” object. “effectivity_text” has a hard-coded length of up to 256 characters (This is incorrect, so the size here is limited to 1000) | +| date_released | Date and time | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| release_status_list | TcConnector.WorkspaceObject | ManyToMany | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `FileDocument` + +Represents the subtype of System.FileDocument object. + +##### Generalization + +System.FileDocument + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| datasetUID | String (200) | | | +| imanFileID | String (200) | | | + +##### Associations + +Entity `FileDocument` does not own any associations. + +#### Entity `SavedGeneralQuery` + +Represents the input criteria for General Query. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| Name | String (200) | | | +| Description | String (200) | | | +| _Type | String (200) | | | +| OwningUser | String (200) | | | +| OwningGroup | String (200) | | | +| CreatedAfter | Date and time | | | +| CreatedBefore | Date and time | | | +| ModifiedAfter | Date and time | | | +| ModifiedBefore | Date and time | | | +| ReleasedAfter | Date and time | | | +| ReleasedBefore | Date and time | | | +| WorkflowTemplateName | String (200) | | | +| CurrentTask | String (200) | | | + +##### Associations + +Entity `SavedGeneralQuery` does not own any associations. + +#### Entity `SavedItemSimpleQuery` + +Represents the input criteria for Item Simple Query. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| Name | String (200) | | | +| ItemID | String (200) | | | +| Description | String (200) | | | +| _Type | String (200) | | | + +##### Associations + +Entity `SavedItemSimpleQuery` does not own any associations. + +#### Entity `BOMWindow` + +Represents the BOMWindow business object type in Teamcenter. + +##### Generalization + +TcConnector.ModelObject + +##### Attributes + +Entity `BOMWindow` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| bomWindow__BOMWindow | TcConnector.BOMWindow | OneToOne | | +| BOMWindow_CloseBOMWindowslInput | TcConnector.CloseBOMWindowslInput | OneToMany | | +| top_line | TcConnector.BOMLine | OneToOne | | +| revision_rule | TcConnector.RevisionRule | OneToOne | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `Relation_BOMLine` + +Dataset object references attached by given relation name are returned. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| relationName | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| info | TcConnector.ExpandPSOneLevelInput | OneToMany | | + +#### Entity `ChildrenObject` + +List of ExpandPSData children found for the associated parent. + +##### Attributes + +Entity `ChildrenObject` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| children | TcConnector.ExpandPSOneLevelResponse | OneToMany | | +| itemRevOfBOMLine | TcConnector.ItemRevision | OneToOne | | +| bomLine__ExpandPSOneLevel | TcConnector.BOMLine | OneToOne | | +| children__ExpandPSAllLevels | TcConnector.ExpandPSAllLevelsOutput | OneToMany | | + +#### Entity `GetRevisionRulesResponse` + +Response entity for the Cad-2007-01-StructureManagement/getRevisionRules Teamcenter service. +It contains RevisionRuleInfo + +##### Generalization + +TcConnector.ServiceResponse + +##### Attributes + +Entity `GetRevisionRulesResponse` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| ResponseData | TcConnector.ServiceResponse | OneToOne | | + +#### Entity `RevisionRulesResponseOutput` + +List of RevisionRuleInfo which contains Revision rule. + +##### Attributes + +Entity `RevisionRulesResponseOutput` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| output__GetRevisionRule | TcConnector.GetRevisionRulesResponse | OneToMany | | +| revRule | TcConnector.RevisionRule | OneToOne | | + +#### Entity `CreateWorkflowInput` + +Input entity for Workflow-2014-10-Workflow/createWorkflow Teamcenter service. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| processName | String (200) | | | +| processDescription | String (200) | | | +| processTemplate | String (200) | | | +| dueDate | Date and time | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| workflowOwner | TcConnector.CreateWorkflowInput | OneToOne | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | + +#### Entity `CreateWorkflowResponse` + +Response entity for Workflow-2014-10-Workflow/createWorkflow Teamcenter service. + +##### Generalization + +TcConnector.ServiceResponse + +##### Attributes + +Entity `CreateWorkflowResponse` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| workflowTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| ResponseData | TcConnector.ServiceResponse | OneToOne | | + +#### Entity `EPMTask` + +Represents the EPMTask business object type from Teamcenter. + +##### Generalization + +TcConnector.WorkspaceObject + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| priority | Integer | 0 | | +| task_name | String (32) | | | +| due_date | Date and time | | | +| task_duration | Integer | 0 | | +| comments | String (4000) | | | +| fnd0StartDate | Date and time | | | +| fnd0EndDate | Date and time | | | +| job_name | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| workflowTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| allTasks | TcConnector.GetAllTasksResponse | OneToMany | | +| task | TcConnector.PerformActionInput | OneToOne | | +| tasks_to_track | TcConnector.TaskInbox | OneToMany | | +| tasks_to_perform | TcConnector.TaskInbox | OneToMany | | +| parent_process | TcConnector.EPMTask | OneToOne | | +| checked_out_user | TcConnector.User | OneToMany | | +| release_status_list | TcConnector.WorkspaceObject | ManyToMany | | +| owning_user | TcConnector.User | OneToMany | | +| last_mod_user | TcConnector.User | OneToMany | | +| owning_group | TcConnector.Group | OneToMany | | +| owning_role | TcConnector.Role | OneToMany | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `createWorkflowtRelationTypes` + +Entity to represent Attachment Relation Types, This has association with CreateWorkflowInput entity. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| attachmentRelationTypes | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| relationTypes | TcConnector.CreateWorkflowInput | OneToMany | | + +#### Entity `GetAllTasksInput` + +Input entity for Workflow-2008-06-Workflow/getAllTasks Teamcenter service. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| state | Integer | 0 | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| process | TcConnector.GetAllTasksInput | OneToOne | | + +#### Entity `EPMJob` + +Represents the EPMJob business object type from Teamcenter. + +##### Generalization + +TcConnector.WorkspaceObject + +##### Attributes + +Entity `EPMJob` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| process | TcConnector.GetAllTasksInput | OneToOne | | +| parent_process | TcConnector.EPMTask | OneToOne | | +| checked_out_user | TcConnector.User | OneToMany | | +| release_status_list | TcConnector.WorkspaceObject | ManyToMany | | +| owning_user | TcConnector.User | OneToMany | | +| last_mod_user | TcConnector.User | OneToMany | | +| owning_group | TcConnector.Group | OneToMany | | +| owning_role | TcConnector.Role | OneToMany | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `GetAllTasksResponse` + +Response entity for Workflow-2008-06-Workflow/getAllTasks Teamcenter service. + +##### Generalization + +TcConnector.ServiceResponse + +##### Attributes + +Entity `GetAllTasksResponse` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| ResponseData | TcConnector.ServiceResponse | OneToOne | | + +#### Entity `PerformActionInput` + +Input entity for Workflow-2012-10-Workflow/performAction2 Teamcenter service. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| action | String (200) | | | +| comments | String (200) | | | +| password | String (200) | | | +| supportingValue | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| task | TcConnector.PerformActionInput | OneToOne | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | + +#### Entity `StringObject` + +Entity represnt the the string array in the response. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| value | String (unlimited) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| lov_values__0 | TcConnector.LOVInternalValue | OneToMany | | +| lov_values__1 | TcConnector.LOVDisplayValue | OneToMany | | + +#### Entity `IntegerObject` + +Entity represnt the the integer array in the response. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| value | Integer | 0 | | + +##### Associations + +Entity `IntegerObject` does not own any associations. + +#### Entity `UpdatedPropertiesInput` + +List of PropInfo structure which consists of information about the objects and the property values to set. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| name | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| objectsSetProperties | TcConnector.ModelObject | OneToMany | | + +#### Entity `ValuesInput` + +Values of the property + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| value | String (unlimited) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| values | TcConnector.UpdatedPropertiesInput | OneToMany | | + +#### Entity `FindUsersTasksResponse` + +Response entity for FindUsersTasksTeamcenter service. + +##### Generalization + +TcConnector.ServiceResponse + +##### Attributes + +Entity `FindUsersTasksResponse` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| ResponseData | TcConnector.ServiceResponse | OneToOne | | + +#### Entity `TaskInbox` + +Represents the TaskInbox business object type from Teamcenter. + +##### Generalization + +TcConnector.WorkspaceObject + +##### Attributes + +Entity `TaskInbox` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| taskinbox__ | TcConnector.TaskInbox | OneToOne | | +| subscribed_inboxes | TcConnector.User | OneToMany | | +| TaskInbox_FindUsersTasksResponse | TcConnector.FindUsersTasksResponse | OneToMany | | +| checked_out_user | TcConnector.User | OneToMany | | +| release_status_list | TcConnector.WorkspaceObject | ManyToMany | | +| owning_user | TcConnector.User | OneToMany | | +| last_mod_user | TcConnector.User | OneToMany | | +| owning_group | TcConnector.Group | OneToMany | | +| owning_role | TcConnector.Role | OneToMany | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `GetWorkflowTemplatesInput` + +Input entity for Workflow-2008-06-Workflow/getWorkflowTemplates Teamcenter service. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| allOrAssignedCriteria | String (200) | SOA_EPM_All | | + +##### Associations + +Entity `GetWorkflowTemplatesInput` does not own any associations. + +#### Entity `GetWorkflowTemplatesResponse` + +Response entity for Workflow-2008-06-Workflow/getWorkflowTemplates Teamcenter service. + +##### Generalization + +TcConnector.ServiceResponse + +##### Attributes + +Entity `GetWorkflowTemplatesResponse` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| ResponseData | TcConnector.ServiceResponse | OneToOne | | + +#### Entity `EPMTaskTemplate` + +Represents the EPMTaskTemplate business object type from Teamcenter. + +##### Generalization + +TcConnector.POM_application_object + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| object_name | String (200) | | | +| object_desc | String (1024) | | | +| template_name | String (128) | | | +| task_type | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| workflowTemplates | TcConnector.GetWorkflowTemplatesResponse | OneToMany | | +| owning_user | TcConnector.User | OneToMany | | +| last_mod_user | TcConnector.User | OneToMany | | +| owning_group | TcConnector.Group | OneToMany | | +| owning_role | TcConnector.Role | OneToMany | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `TC_Project` + +Represents the TC_Project business object type from Teamcenter. + +##### Generalization + +TcConnector.POM_application_object + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| project_name | String (32) | | | +| project_desc | String (240) | | | +| project_id | String (64) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| project_list | TcConnector.ItemRevision | OneToMany | | +| project | TcConnector.TC_Project | OneToOne | | +| owning_user | TcConnector.User | OneToMany | | +| last_mod_user | TcConnector.User | OneToMany | | +| owning_group | TcConnector.Group | OneToMany | | +| owning_role | TcConnector.Role | OneToMany | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `VariantRule` + +Represents the VariantRule business object type from Teamcenter. + +##### Generalization + +TcConnector.WorkspaceObject + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| contents | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| objectsForConfigure | TcConnector.CreateBomWindowInput | OneToMany | | +| variantRulesForItemRevision | TcConnector.ItemRevision | OneToMany | | +| checked_out_user | TcConnector.User | OneToMany | | +| release_status_list | TcConnector.WorkspaceObject | ManyToMany | | +| owning_user | TcConnector.User | OneToMany | | +| last_mod_user | TcConnector.User | OneToMany | | +| owning_group | TcConnector.Group | OneToMany | | +| owning_role | TcConnector.Role | OneToMany | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `ConfigurationContext` + +Represents the ConfigurationContext business object type from Teamcenter. + +##### Generalization + +TcConnector.WorkspaceObject + +##### Attributes + +Entity `ConfigurationContext` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| configContext | TcConnector.CreateBomWindowInput | OneToOne | | +| checked_out_user | TcConnector.User | OneToMany | | +| release_status_list | TcConnector.WorkspaceObject | ManyToMany | | +| owning_user | TcConnector.User | OneToMany | | +| last_mod_user | TcConnector.User | OneToMany | | +| owning_group | TcConnector.Group | OneToMany | | +| owning_role | TcConnector.Role | OneToMany | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `BomWindowPropFlagMap` + +Map of property name (key) and property values (values) in string format, to be set on info input to create BOM window. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| show_unconfigured_variants | String (200) | false | | +| show_unconfigured_changes | String (200) | true | | +| show_suppressed_occurrences | String (200) | true | | +| is_packed_by_default | String (200) | true | | +| show_out_of_context_lines | String (200) | true | | +| fnd0show_uncnf_occ_eff | String (200) | true | | +| fnd0bw_in_cv_cfg_to_load_md | String (200) | true | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| bomWinPropFlagMap | TcConnector.BomWindowPropFlagMap | OneToOne | | + +#### Entity `ParentObject` + +List of ExpandPSData children found for the associated parent. + +##### Attributes + +Entity `ParentObject` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| bomLine__ExpandPSAllLevel | TcConnector.BOMLine | OneToOne | | +| itemRevOfBOMLine__Parent | TcConnector.ItemRevision | OneToOne | | +| parent | TcConnector.ExpandPSAllLevelsOutput | OneToOne | | + +#### Entity `ExpandPSAllLevelsOutput` + +Response entity for the Cad-2007-01-StructureManagement/expandPSOneLevel Teamcenter service. +First level children (as list of BOMLines) of given parent BOMLines is the output of the service. + +##### Attributes + +Entity `ExpandPSAllLevelsOutput` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| ExpandAllLevelsOutput | TcConnector.ExpandPSAllLevelsResponse | OneToMany | | +| parent | TcConnector.ExpandPSAllLevelsOutput | OneToOne | | + +#### Entity `ExpandPSAllLevelsResponse` + +Response entity for the Cad-2007-01-StructureManagement/expandPSOneLevel Teamcenter service. +First level children (as list of BOMLines) of given parent BOMLines is the output of the service. + +##### Generalization + +TcConnector.ServiceResponse + +##### Attributes + +Entity `ExpandPSAllLevelsResponse` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| ResponseData | TcConnector.ServiceResponse | OneToOne | | + +#### Entity `TcServerInformation` + +Entity to store the Teamcenter server information which is response entity for Core-2007-01-Session/getTCSessionInfo teamcenter service + +##### Generalization + +TcConnector.ServiceResponse + +##### Attributes + +Entity `TcServerInformation` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| group__ | TcConnector.Group | OneToOne | | +| user__ | TcConnector.User | OneToOne | | +| extraInfo__ | TcConnector.TcServerInformation | OneToOne | | +| role__ | TcConnector.Role | OneToOne | | +| project | TcConnector.TC_Project | OneToOne | | +| ResponseData | TcConnector.ServiceResponse | OneToOne | | + +#### Entity `ExtraInfo` + +Represents additional teamcenter session infomation. + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| DisplayVersion | String (200) | | | +| syslogFile | String (200) | | | +| TcServerID | String (200) | | | +| TCServerLocale | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| extraInfo__ | TcConnector.TcServerInformation | OneToOne | | + +#### Entity `Role` + +Represents the Role business object type from Teamcenter. + +##### Generalization + +TcConnector.POM_application_object + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| role_name | String (32) | | | +| object_name | String (200) | | | +| description | String (240) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| role__ | TcConnector.Role | OneToOne | | +| owning_user | TcConnector.User | OneToMany | | +| last_mod_user | TcConnector.User | OneToMany | | +| owning_group | TcConnector.Group | OneToMany | | +| owning_role | TcConnector.Role | OneToMany | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `PSBOMViewRevision` + +##### Generalization + +TcConnector.WorkspaceObject + +##### Attributes + +Entity `PSBOMViewRevision` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| bom_view | TcConnector.PSBOMView | OneToOne | | +| structure_revisions | TcConnector.ItemRevision | OneToMany | | +| checked_out_user | TcConnector.User | OneToMany | | +| release_status_list | TcConnector.WorkspaceObject | ManyToMany | | +| owning_user | TcConnector.User | OneToMany | | +| last_mod_user | TcConnector.User | OneToMany | | +| owning_group | TcConnector.Group | OneToMany | | +| owning_role | TcConnector.Role | OneToMany | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `CloseBOMWindowslInput` + +##### Attributes + +Entity `CloseBOMWindowslInput` has no attributes. + +##### Associations + +Entity `CloseBOMWindowslInput` does not own any associations. + +#### Entity `HomePage` + +##### Attributes + +Entity `HomePage` has no attributes. + +##### Associations + +Entity `HomePage` does not own any associations. + +#### Entity `GetItemFromIdResponse` + +##### Generalization + +TcConnector.ServiceResponse + +##### Attributes + +Entity `GetItemFromIdResponse` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| ResponseData | TcConnector.ServiceResponse | OneToOne | | + +#### Entity `ItemRevisionOutput` + +##### Attributes + +Entity `ItemRevisionOutput` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| itemRevOutput | TcConnector.GetItemFromIdResponse | OneToMany | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | + +#### Entity `GetItemFromIdInput` + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| ItemId | String (200) | | | +| NumberOfRevision | Integer | -1 | | +| RelationTypeName | String (200) | | | + +##### Associations + +Entity `GetItemFromIdInput` does not own any associations. + +#### Entity `RevisionIDs` + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| RevisionIDs | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| revIds | TcConnector.GetItemFromIdInput | OneToMany | | + +#### Entity `ObjectTypeNames` + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| ObjectTypeNames | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| objectTypeNames__ | TcConnector.GetItemFromIdInput | OneToMany | | +| objectTypeNames__ExpandPS | TcConnector.ExpandPSOneLevelInput | OneToMany | | + +#### Entity `ExpandGRMInput` + +##### Attributes + +Entity `ExpandGRMInput` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| PrimaryOrSecondaryObjects | TcConnector.ListOfModelObject | OneToOne | | + +#### Entity `ExpandGRMResponse` + +##### Generalization + +TcConnector.ServiceResponse + +##### Attributes + +Entity `ExpandGRMResponse` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| ResponseData | TcConnector.ServiceResponse | OneToOne | | + +#### Entity `Relation__` + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| relationTypeName | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| relations | TcConnector.ExpandGRMInput | OneToMany | | + +#### Entity `relationshipObject` + +##### Attributes + +Entity `relationshipObject` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| relationshipObjects | TcConnector.ExpandGRMResponse | OneToMany | | +| otherSideObject | TcConnector.ModelObject | OneToMany | | +| _relation | TcConnector.ImanRelation | OneToMany | | + +#### Entity `RootTargetAttachments` + +##### Generalization + +TcConnector.WorkspaceObject + +##### Attributes + +Entity `RootTargetAttachments` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| root_target_attachments | TcConnector.EPMTask | OneToMany | | +| checked_out_user | TcConnector.User | OneToMany | | +| release_status_list | TcConnector.WorkspaceObject | ManyToMany | | +| owning_user | TcConnector.User | OneToMany | | +| last_mod_user | TcConnector.User | OneToMany | | +| owning_group | TcConnector.Group | OneToMany | | +| owning_role | TcConnector.Role | OneToMany | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `ExpandPSOneLevel2Input` + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| RelationName | String (200) | | | +| NamedRefHandler | String (200) | AllNamedRefs | | +| ObjectTypeName | String (200) | | | + +##### Associations + +Entity `ExpandPSOneLevel2Input` does not own any associations. + +#### Entity `ExpandPSOneLevel2Response` + +##### Generalization + +TcConnector.ServiceResponse + +##### Attributes + +Entity `ExpandPSOneLevel2Response` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| ResponseData | TcConnector.ServiceResponse | OneToOne | | + +#### Entity `ParentChildWrapper` + +##### Attributes + +Entity `ParentChildWrapper` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| output__ExpandPSOneLevel2Response | TcConnector.ExpandPSOneLevel2Response | OneToMany | | +| parent__ParentChildWrapper | TcConnector.ParentChildWrapper | OneToOne | | + +#### Entity `Parent__` + +##### Attributes + +Entity `Parent__` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| parent__ParentChildWrapper | TcConnector.ParentChildWrapper | OneToOne | | +| bomLine__Parent | TcConnector.Parent__ | OneToOne | | + +#### Entity `Child` + +##### Attributes + +Entity `Child` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| children__ParentChildWrapper | TcConnector.ParentChildWrapper | OneToMany | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| BOMLine_childrenObj | TcConnector.BOMLine | OneToMany | | +| bomLine__Child | TcConnector.Child | OneToOne | | + +#### Entity `relatedObjectsEntity` + +##### Attributes + +Entity `relatedObjectsEntity` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| relatedObjects | TcConnector.Child | OneToMany | | +| relatedObject | TcConnector.relatedObjectsEntity | OneToOne | | + +#### Entity `namedRefListEntity` + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| namedReferenceType | String (200) | | | +| namedReferenceName | String (200) | | | +| fileTicket | String (1000) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| namedRefList | TcConnector.relatedObjectsEntity | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | + +#### Entity `ExpandBOMParentChild` + +##### Attributes + +Entity `ExpandBOMParentChild` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| ParentBOMLIne | TcConnector.ExpandBOMParentChild | OneToOne | | + +#### Entity `WhereUsedInput` + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| numLevels | Integer | 1 | | +| whereUsedPrecise | Boolean | false | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| rule | TcConnector.WhereUsedInput | OneToOne | | + +#### Entity `WhereUsedResponseInfo` + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| level | Integer | 0 | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| parentItemRev | TcConnector.WhereUsedResponseInfo | OneToOne | | +| WhereUsedResponseInfo_ModelObject | TcConnector.ModelObject | OneToMany | | + +#### Entity `BooleanObject` + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| value | Boolean | false | | + +##### Associations + +Entity `BooleanObject` does not own any associations. + +#### Entity `GetInitialLOVValuesInputEntity` + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| propertyName | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| lov | TcConnector.ModelObject | OneToOne | | +| lovInput | TcConnector.LovInputEntity | OneToOne | | +| filterData__0 | TcConnector.LOVFilterDataInputEntity | OneToOne | | +| lov__0 | TcConnector.ListOfValues | OneToOne | | + +#### Entity `LovInputEntity` + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| operationName | String (200) | | | +| boName | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovInput | TcConnector.LovInputEntity | OneToOne | | + +#### Entity `LOVFilterDataInputEntity` + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| filterString | String (200) | | | +| maxResults | Integer | 2000 | | +| numberToReturn | Integer | 25 | | +| order | Integer | 1 | | +| sortPropertyName | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| filterData__0 | TcConnector.LOVFilterDataInputEntity | OneToOne | | + +#### Entity `GetLOVValuesResponse` + +##### Generalization + +TcConnector.ServiceResponse + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| moreValuesExist | Boolean | false | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| lovData | TcConnector.GetLOVValuesResponse | OneToOne | | +| ResponseData | TcConnector.ServiceResponse | OneToOne | | + +#### Entity `LOVDataEntity` + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| style | String (200) | | | +| additionalValuesSkipped | Boolean | false | | +| currentIndex | Integer | 0 | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| lovData | TcConnector.GetLOVValuesResponse | OneToOne | | +| filterData__1 | TcConnector.LOVFilterDataOutputEntity | OneToOne | | + +#### Entity `LOVValuesEntity` + +##### Attributes + +Entity `LOVValuesEntity` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| lovValues | TcConnector.GetLOVValuesResponse | OneToMany | | +| propInternalValues | TcConnector.LOVValuesEntity | OneToOne | | +| propInternalValueTypes | TcConnector.LOVInternalValueType | OneToOne | | +| propDisplayValues | TcConnector.LOVValuesEntity | OneToOne | | + +#### Entity `LOVInternalValue` + +##### Attributes + +Entity `LOVInternalValue` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| propInternalValues | TcConnector.LOVValuesEntity | OneToOne | | + +#### Entity `LOVInternalValueType` + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| lov_values | Integer | 8 | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| propInternalValueTypes | TcConnector.LOVInternalValueType | OneToOne | | + +#### Entity `LOVDisplayValue` + +##### Attributes + +Entity `LOVDisplayValue` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| propDisplayValues | TcConnector.LOVValuesEntity | OneToOne | | + +#### Entity `LOVFilterDataOutputEntity` + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| filterString | String (200) | | | +| maxResults | Integer | 2000 | | +| numberToReturn | Integer | 25 | | +| order | Integer | 1 | | +| sortPropertyName | String (200) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| filterData__1 | TcConnector.LOVFilterDataOutputEntity | OneToOne | | + +#### Entity `ListOfValues` + +##### Generalization + +TcConnector.ModelObject + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| lov_desc | String (240) | | | +| lov_name | String (128) | | | +| lov_type | String (32) | | | +| lov_usage | Integer | 0 | | +| lov_value_type | Integer | 0 | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| lov__0 | TcConnector.ListOfValues | OneToOne | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `DummyModelObject` + +##### Generalization + +TcConnector.ModelObject + +##### Attributes + +Entity `DummyModelObject` has no attributes. + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| primary_object | TcConnector.ImanRelation | OneToOne | | +| secondary_object | TcConnector.ImanRelation | OneToOne | | +| primaryObject | TcConnector.ModelObject | OneToOne | The primary object to create the relation from | +| secondaryObject | TcConnector.ModelObject | OneToOne | The secondary object to create the relation to | +| userData | TcConnector.ModelObject | OneToOne | The user data object used to create the relation. This parameter is optional. | +| searchResults | TcConnector.SearchResponse | OneToMany | | +| ListOfModelObjects | TcConnector.ListOfModelObject | OneToMany | | +| Plain | TcConnector.ServiceData | OneToMany | | +| Updated | TcConnector.ServiceData | OneToMany | | +| Created | TcConnector.ServiceData | OneToMany | | +| ClientObject | TcConnector.ErrorStack | OneToOne | | +| revise_objects | TcConnector.ReviseOutputResponse | OneToMany | | +| originalObject | TcConnector.ModelObject | OneToOne | | +| objectCopy | TcConnector.ModelObject | OneToOne | | +| parentBomLines | TcConnector.ExpandPSOneLevelInput | OneToMany | | +| attachments | TcConnector.CreateWorkflowInput | OneToMany | | +| workflowRootTask | TcConnector.CreateWorkflowResponse | OneToOne | | +| targets | TcConnector.GetWorkflowTemplatesInput | OneToMany | | +| supportingObject | TcConnector.PerformActionInput | OneToOne | | +| ModelObject_TcSession | TcConnector.TcSession | OneToMany | | +| responsibleParty | TcConnector.CreateWorkflowInput | OneToOne | | +| assignedUser | TcConnector.CreateWorkflowInput | OneToMany | | +| Items_GetItemFromIdResponse | TcConnector.GetItemFromIdResponse | OneToOne | | +| itemRevision__ | TcConnector.ItemRevisionOutput | OneToOne | | +| parentBomLines__ | TcConnector.ExpandPSOneLevel2Input | OneToMany | | +| referenceObject | TcConnector.namedRefListEntity | OneToOne | | +| objectOfBOMLine | TcConnector.Child | OneToOne | | +| objects | TcConnector.WhereUsedInput | OneToMany | | +| lov | TcConnector.ModelObject | OneToOne | | +| owningObject | TcConnector.ModelObject | OneToOne | | +| lovs | TcConnector.LOVDataEntity | OneToMany | | + +#### Entity `ImanFile` + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| fileID | String (200) | | | +| name | String (200) | | | +| size | String (200) | | | +| creationDate | Date and time | | | +| lastModifiedDate | Date and time | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| imanFiles | TcConnector.Dataset | OneToMany | | + +#### Entity `Image` + +##### Generalization + +System.Image + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| datasetUID | String (200) | | | +| imanFileID | String (200) | | | + +##### Associations + +Entity `Image` does not own any associations. + +#### Entity `OAuthToken` + +##### Attributes + +| Name | Type | Default value | Documentation | +| --- | --- | --- | --- | +| AccessToken | String (unlimited) | | | + +##### Associations + +| Name | Connected to | Multiplicity | Documentation | +| --- | --- | --- | --- | +| TcTokens | TcConnector.TcSession | OneToMany | | + +#### Annotations + +| Caption | +| --- | +| Mendix Domain Model Entities are mapped to Teamcenter service operation data structures based on naming conventions. The Teamcenter structure element names (keys in JSON document) map one-to-one to the Entity member (Attributes or Associations) names, with the following caveats:

• The Entity member name is prefixed with a `_`, i.e. `_type`. In this case the `_` is ignored, thus matching the Teamcenter name of `type`.
• The Entity member name is suffixed with `__XXX`, i.e. `phone__Home`. In this case the `__Home` is ignored, thus matching the Teamcenter name of `phone`.
• Entity Attribute types must match the type of the business object property type. Attributes of type String are the display or localized value of the business object property, while Attributes of other types (Boolean, Decimal, and Integer, Localized Date and time), are the database value of the business object property. To map a database value of a business object String property the Attribute name must be suffixed with `__DB`, i.e. `description__DB`. | +| Following entities are used as input/output for invoking Teamcenter service Core-2006-03-DataManagement/createRelations through `Toolbox/Teamcenter/Call Teamcenter Service`, `Toolbox/Teamcenter/Create Relation` service | +| Following entities are used as input for invoking Teamcenter service Core-2015-07-DataManagement/createRelateAndSubmitObjects2 through mendix service `Toolbox/Teamcenter/Create Object` | +| Following entities are used as input/output for invoking Teamcenter service Query-2014-11-Finder/performSearch through `Toolbox/Teamcenter/CallTeamcenterService`, `Toolbox/Teamcenter/Perform Search`, `Toolbox/Teamcenter/Perform General Search`, `Toolbox/Teamcenter/Perform Item Simple Search` services | +| Following entities are used as input/output for invoking Teamcenter service Core-2013-05-DataManagement/reviseObjects through Mendix service `Toolbox/Teamcenter/Revise Object` | +| Following entities are used as input/output for invoking Teamcenter service Cad-2007-01-StructureManagement/expandPSOneLevel through Mendix service `Toolbox/Teamcenter/Expand One Level` | +| Data model definition ends | +| Following entities are used as input/output for invoking Teamcenter service Query-2008-06-SavedQuery/executeSavedQueries through Mendix service `Toolbox/Teamcenter/Saved Query Search`

Define an entity representing Search Criteria of the Saved Query to be executed. Search criteria entity attributes should be defined based on Teamcenter L10NKeys for its corresponding search criteria attribute.
e.g. If the Teamcenter Saved Query has search criteria entry for `Item ID` and its corresponding L10NKey is ItemID, then in Mendix, define the Search Criteria Entity with `ItemID` as attribute name.

Note: Criteria attribute L10NKeys does not change for locale and thus would work for non-english locales too.

e.g. Refer to Teamcenter Query Locale keys from
<TC_ROOT>\lang\textserver\en_US\qry_user_entry_names_locale.xml | +| Below entities are used as input/output for invoking following Teamcenter workflow services
Workflow-2014-10-Workflow/createWorkflow ,
Workflow-2008-06-Workflow/getAllTasks,
Workflow-2012-10-Workflow/performAction2
Workflow-2008-06-Workflow/getWorkflowTemplates | +| Following entities are used as input for invoking Teamcenter serviceCore-2010-09-DataManagement/setProperties through Mendix service `Toolbox/Teamcenter/UpdateProperties` | +| Following entities are used as input/output for invoking Teamcenter serviceCad-2007-01-StructureManagement/getRevisionRules through Mendix service `Toolbox/Teamcenter/Get Revision Rules` | +| Generic Service Response and Business objects in teamcenter | +| Teamcenter Coniguration and Session Management

These Entities are used to configure a connection with a Teamcenter server and manage a user's Teamcenter session. | +| Following entities are used as input/output for invoking Teamcenter service Cad-2013-05-StructureManagement/createBOMWindows2 through Mendix service `Toolbox/Teamcenter/Create BOM Windows2` | +| Below entities are used as input/output for invoking following Teamcenter services
Core-2007-01-DataManagement/getItemFromId
Core-2007-09-DataManagement/expandGRMRelationsForPrimary
Core-2007-09-DataManagement/expandGRMRelationsForSecondary | +| Following entities are used as input/output for invoking Teamcenter service Cad-2008-06-StructureManagement/expandPSOneLevel through Mendix service `Toolbox/Teamcenter/Expand One Level` | +| Following entities are used as input/output for invoking Teamcenter serviceCore-2007-01-DataManagement/whereUsed through Mendix service `Toolbox/Teamcenter/Where Used` | +| Following entities are used to read LOV values for a Business Object property | +| Activities GetInitialLOVValues/GetNextLOVValues returns ListOfValues as ModelObject and NOT as ListOfValues object with these properties. To read the properties of ListOfValues or any of its subtype, use GetProperties activity.

GetAttachedLOV activity returns ListOfValues along with properties available on the Entity. | + +### Microflows + +| Name | Return type | Documentation | +| --- | --- | --- | +| `SSO_RegisterRequestHandlers` | Boolean | Microflow called during startup of application to enable SSO. | +| `AdminLogin` | Nothing | This microflow allow users to set the landing page after Teamcenter login. | +| `UserLogin` | Nothing | This microflow allow users to set the landing page after Teamcenter login. | +| `ExecuteAdminLogin` | Boolean | This microflow enables the configuration option for administrators. Other users will not see the configuration page. | +| `ExecuteLogout` | Nothing | Microflow to perform Teamcenter log out for given teamcenter configuration. | +| `ShowLoginPage` | Boolean | This microflow displays the login page. | +| `PerformTokenExchangeAndLoginToTC` | Boolean | | +| `ExecuteLogin` | Nothing | Microflow to perform Teamcenter login. | +| `AreMultipleTcConfigActive` | Boolean | Microflow to returns true if multiple teamcenter congigurations are active else returns false. | +| `RetrieveTeamcenterConifgurationFromTcSession` | TcConnector.TeamcenterConfiguration | Microflow to retrieve Teamcenter configuration from database. | +| `RetrieveTeamcenterConifgurationByName` | TcConnector.TeamcenterConfiguration | Microflow to retrieve Teamcenter configuration from database. | +| `RetrieveHttpHeaderList` | List of System.HttpHeader | | +| `RetrieveConfigNameFromSingleActiveConfiguration | String | Microflow to retrieve Teamcenter configuration if single teamcenter configuration is active. | +| `RetrieveTcSessionBasedOnConfigName` | TcConnector.TcSession | Microflow to retrieve Tc session from database for given Teamcenter configuration. | +| `DownloadFile` | Boolean | | +| `CloseBOMWindow` | TcConnector.ServiceResponse | | +| `HandleActiveConfigErrors` | Nothing | | +| `ShowPartialErrors` | Nothing | This microflow retrieves partial errors from service data. | +| `HandleServiceErrors` | Nothing | Microflow to handle service errors. | +| `GetBlankCredential` | TcConnector.Credentials | | +| `SaveTeamcenterConfiguration` | Nothing | | +| `SSO_CreateRedirectURL` | String | This microflow constructs Teamcenter SSO redirect URL. | +| `UpdateSession` | Nothing | | +| `GetStatusofConfiguration` | TcConnector.Cookie | | +| `CreateBlankHomePage` | TcConnector.HomePage | | +| `LoginToMultipleTeamcenters` | Nothing | Microflow to perform Teamcenter log in if multiiple teamcenter configurations are active. | +| `SendService` | System.HttpResponse | | +| `ChangeActiveTeamcenterConfiguration` | Nothing | Microflow to set Teamcenter configuration as active. | +| `TeamcenterConfiguration_ValidateMandatorySSOAttributes` | Boolean | | +| `TeamcenterConfiguration_EnsureSingleTCConfigurationsIsActive]` | Boolean | Event handler to validate the only single configuration is active if EnableMultipleActiveConfig is set to false. | + +#### Microflow `SSO_RegisterRequestHandlers` + +Microflow called during startup of application to enable SSO. + +##### Parameters + +This has no parameters. + +##### Return type + +Boolean + +#### Microflow `AdminLogin` + +This microflow allow users to set the landing page after Teamcenter login. + +##### Parameters + +This has no parameters. + +##### Return type + +Nothing + +#### Microflow `UserLogin` + +This microflow allow users to set the landing page after Teamcenter login. + +##### Parameters + +This has no parameters. + +##### Return type + +Nothing + +#### Microflow `ExecuteAdminLogin` + +This microflow enables the configuration option for administrators. Other users will not see the configuration page. + +##### Parameters + +This has no parameters. + +##### Return type + +Boolean + +#### Microflow `ExecuteLogout` + +Microflow to perform Teamcenter log out for given teamcenter configuration. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| TeamcenterConfiguration | TcConnector.TeamcenterConfiguration | | + +##### Return type + +Nothing + +#### Microflow `ShowLoginPage` + +This microflow displays the login page. + +##### Parameters + +This has no parameters. + +##### Return type + +Boolean + +#### Microflow `PerformTokenExchangeAndLoginToTC` + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| AccessToken | String | | +| TcXConfigName | String | | +| TcSession | TcConnector.TcSession | | +| TeamcenterConfiguration | TcConnector.TeamcenterConfiguration | | +| TcSessionObj | TcConnector.TcSession | | + +##### Return type + +Boolean + +#### Microflow `ExecuteLogin` + +Microflow to perform Teamcenter login. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| Credentials | TcConnector.Credentials | Teamcenter credentials. | +| TeamcenterConfiguration | TcConnector.TeamcenterConfiguration | | + +##### Return type + +Nothing + +#### Microflow `AreMultipleTcConfigActive` + +Microflow to returns true if multiple teamcenter congigurations are active else returns false. + +##### Parameters + +This has no parameters. + +##### Return type + +Boolean + +#### Microflow `RetrieveTeamcenterConifgurationFromTcSession` + +Microflow to retrieve Teamcenter configuration from database. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| TcSession | TcConnector.TcSession | | + +##### Return type + +TcConnector.TeamcenterConfiguration + +#### Microflow `RetrieveTeamcenterConifgurationByName` + +Microflow to retrieve Teamcenter configuration from database. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| ConfigName | String | | + +##### Return type + +TcConnector.TeamcenterConfiguration + +#### Microflow `RetrieveHttpHeaderList` + +##### Parameters + +This has no parameters. + +##### Return type + +List of System.HttpHeader + +#### Microflow `RetrieveConfigNameFromSingleActiveConfiguration` + +Microflow to retrieve Teamcenter configuration if single teamcenter configuration is active. + +##### Parameters + +This has no parameters. + +##### Return type + +String + +#### Microflow `RetrieveTcSessionBasedOnConfigName` + +Microflow to retrieve Tc session from database for given Teamcenter configuration. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| ConfigName | String | | + +##### Return type + +TcConnector.TcSession + +#### Microflow `DownloadFile` + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| Dataset | TcConnector.Dataset | | +| ConfigurationName | String | | +| FileDownloadType | Enumeration TcConnector.FileDownloadType | | + +##### Return type + +Boolean + +#### Microflow `CloseBOMWindow` + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| BOMWindow | TcConnector.BOMWindow | | +| configName | String | | + +##### Return type + +TcConnector.ServiceResponse + +#### Microflow `HandleActiveConfigErrors` + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| ConfigException | System.Error | | + +##### Return type + +Nothing + +#### Microflow `ShowPartialErrors` + +This microflow retrieves partial errors from service data. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| ServiceResponse | TcConnector.ServiceResponse | | + +##### Return type + +Nothing + +#### Microflow `HandleServiceErrors` + +Microflow to handle service errors. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| ServiceException | System.Error | | + +##### Return type + +Nothing + +#### Microflow `GetBlankCredential` + +##### Parameters + +This has no parameters. + +##### Return type + +TcConnector.Credentials + +#### Microflow `SaveTeamcenterConfiguration` + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| TeamcenterConfiguration | TcConnector.TeamcenterConfiguration | | + +##### Return type + +Nothing + +#### Microflow `SSO_CreateRedirectURL` + +This microflow constructs Teamcenter SSO redirect URL. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| TeamcenterConfiguration | TcConnector.TeamcenterConfiguration | Teamcenter configuration detail. | + +##### Return type + +String + +#### Microflow `UpdateSession` + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| TcSession | TcConnector.TcSession | | + +##### Return type + +Nothing + +#### Microflow `GetStatusofConfiguration` + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| TeamcenterConfiguration | TcConnector.TeamcenterConfiguration | | + +##### Return type + +TcConnector.Cookie + +#### Microflow `CreateBlankHomePage` + +##### Parameters + +This has no parameters. + +##### Return type + +TcConnector.HomePage + +#### Microflow `LoginToMultipleTeamcenters` + +Microflow to perform Teamcenter log in if multiiple teamcenter configurations are active. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| TeamcenterConfiguration | TcConnector.TeamcenterConfiguration | | + +##### Return type + +Nothing + +#### Microflow `SendService` + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| SoaServiceRequest | TcConnector.SoaServiceRequest | | + +##### Return type + +System.HttpResponse + +#### Microflow `ChangeActiveTeamcenterConfiguration` + +Microflow to set Teamcenter configuration as active. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| TeamcenterConfiguration | TcConnector.TeamcenterConfiguration | Teamcenter configuration detail. | + +##### Return type + +Nothing + +#### Microflow `TeamcenterConfiguration_ValidateMandatorySSOAttributes` + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| TeamcenterConfiguration | TcConnector.TeamcenterConfiguration | | + +##### Return type + +Boolean + +#### Microflow `TeamcenterConfiguration_EnsureSingleTCConfigurationsIsActive` + +Event handler to validate the only single configuration is active if EnableMultipleActiveConfig is set to false. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| TeamcenterConfiguration | TcConnector.TeamcenterConfiguration | | + +##### Return type + +Boolean + +### Java actions + +| Name | Return type | Documentation | +| --- | --- | --- | +| `ExpandPSAllLevels` | TcConnector.ExpandPSAllLevelsResponse | SOA URL:
Cad-2007-01-StructureManagement/expandPSAllLevels

Description:
This actions finds the chilren at all levels given parent bomline.

Returns:
An entity of type ExpandPSAllLevelsResponse. Expanded child bomlines with respective parents can be retrieved using association TcConnector.ExpandPSAllLevelsOutput. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. | +| `ExpandPSOneLevel2` | TcConnector.ExpandPSOneLevel2Response | SOA URL:
Cad-2008-06-StructureManagement/expandPSOneLevel

Description:
This actions finds the first level children of given parent bomlines.
InputBOMLine(ParentBOMLine) will be updated with Child Objects (BOMLine_childrenObj).
DownloadFiles flag if set true, will download the files attached to Datasets.

Returns:
InputBOMLine(ParentBOMLine) will be updated with Child Objects (BOMLine_childrenObj)
Ecah Child Object Consits of follwoing Object
ChildBOMLine(TcConnector.bomLine__Child)
ItemRevision of the ChildBOMLine (TcConnector.objectOfBOMLine)
NamedRefrenceList of attachedched Dataset can be retrived from ChildBOMLine (TcConnector.BOMLineAttachments)
Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. | +| `GetVariantRule` | Boolean | SOA URL:
Cad-2007-01-StructureManagement/getVariantRules

Description:
The GetRevisionRules service gets all the variant rule related with given Item Revision.

Returns:
Input Item Revision entity's TcConnector.variantRulesForItemRevision association will be updated with related variant rules. | +| `CreateBOMWindows2` | TcConnector.CreateBomWindowResponse | SOA URL:
Cad-2013-05-StructureManagement/createBOMWindows2

Description:
This actions Creates a BOMWindow and sets the input Item Revision as the top line , this action takes additional input such as variant rule , configuration context and bomWinPropFlagMap

Returns:
An entity of type CreateBomWindowResponse. Top line can be retrieved using association TcConnector.bomLine__BOMWindow. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. | +| `GetRevisionRules` | TcConnector.GetRevisionRulesResponse | SOA URL:
Cad-2007-01-StructureManagement/getRevisionRules

Description:
The GetRevisionRules service gets all the persistent revision rules in the database.

Returns:
GetRevisionRulesResponse which contains RevisionRuleInfo. RevisionRuleInfo has the revision rule. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. | +| `ExpandPSOneLevel` | TcConnector.ExpandPSOneLevelResponse | SOA URL:
Cad-2007-01-StructureManagement/expandPSOneLevel

Description:
This actions finds the first level children of given parent bomline

Returns:
An entity of type ExpandPSOneLevelResponse. Expanded child bomlines can be retrieved using association TcConnector.children. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. | +| `CreateBOMWindows` | TcConnector.CreateBomWindowResponse | SOA URL:
Cad-2007-01-StructureManagement/createBOMWindows

Description:
This actions Creates a BOMWindow and sets the input Item Revision as the top line

Returns:
An entity of type CreateBomWindowResponse. Top line can be retrieved using association TcConnector.bomLine__BOMWindow. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. | +| `GetWorkflowTemplates` | TcConnector.GetWorkflowTemplatesResponse | SOA URL:
Workflow-2008-06-Workflow/getWorkflowTemplates

Description:
Get the list of workflow templates given the list of target workspace objects and the All or Assigned criteria.
Returns:
An entity of type GetWorkflowTemplatesResponse. WorkflowTemplates can be retrieved using association TcConnector.workflowTemplates.Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. | +| `GetAllTasks` | TcConnector.GetAllTasksResponse | SOA URL:
Workflow-2008-06-Workflow/getAllTasks

Description:
This actions gets all the tasks in a process
Returns:
An entity of type GetAllTasksResponse. AllTask can be retrieved using association TcConnector.allTasks.Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. | +| `PerformAction` | TcConnector.ServiceResponse | SOA URL:
Workflow-2012-10-Workflow/performAction2

Description:
This actions performs an action on a workflow task. The following actions are supported:
Assign
Start
Complete
Skip
Suspend
Resume
Undo
Perform
Approve
Reject
Promote
Demote
Claim

Returns:
Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. | +| `CreateWorkflow` | TcConnector.CreateWorkflowResponse | SOA URL:
Workflow-2014-10-Workflow/createWorkflow

Description:
This actions relates a workflow process given the process template name, workflow owner, responsible party, attachments and attachment types.
Returns:
An entity of type CreateWorkflowResponse. WorkflowTask can be retrieved using association TcConnector.workflowTask.Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. | +| `FindUsersTasks` | TcConnector.FindUsersTasksResponse | SOA URL:
Core-2007-01-Session/getTCSessionInfo
Core-2006-03-DataManagement/getProperties

Tc Version:
Teamcenter 2007

Description:
This actions finds Task Inboxes of logged-in user, Task Inboxes contains `Task to Perform` and `Task to Track`
Returns:
An entity of type FindUsersTasksResponse. Task Inboxes can be retrieved using association TcConnector.TaskInbox_FindUsersTasksResponse. tasks_to_perform and tasks_to_track is a association between EPMTask and TaskInbox.Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. | +| `ExecuteSavedQueriesWithObjectRefresh` | TcConnector.ServiceResponse | SOA URL:
Query-2010-04-SavedQuery/findSavedQueries
Query-2008-06-SavedQuery/executeSavedQueries

This is generic action to perform the search for the saved queries. It takes query name and corresponding search criteria entity for the given query.

Returns:
An entity of type ServiceResponse. Search Results can be retrieved using association TcConnector.ResponseData/TcConnector.plain. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. | +| `PerformGeneralQuerySearchAW` | TcConnector.SearchResponse | SOA URL:
Query-2010-04-SavedQuery/findSavedQueries
Query-2014-11-Finder/performSearch

Description:
This is a specific action to send the request to and receive the response from a the data provider `Awp0SavedQuerySearchProvider` for query `General...`. The input criteria for GeneralSearch query is passed through the generalQuerySearchInput object which is extended from .SearchInput Object.

Returns:
An entity of type SearchResponse. Search Results can be retrieved using association TcConnector.searchResultsList. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors.

NOTE:
This action will work only if the teamcenter enviornment has active workspace installation . | +| `PerformItemSimpleQuerySearchAW` | TcConnector.SearchResponse | SOA URL:
Query-2010-04-SavedQuery/findSavedQueries
Query-2014-11-Finder/performSearch

Description:
This is a specific action to send the request to and receive the response from a the data provider `Awp0SavedQuerySearchProvider` for query `Item - simple`. The input criteria for GeneralSearch query is passed through the generalQuerySearchInput object which is extended from .SearchInput Object.

Returns:
An entity of type SearchResponse. Search Results can be retrieved using association TcConnector.searchResultsList. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors.

NOTE:
This action will work only if the teamcenter enviornment has active workspace installation . | +| `FindSavedQueries` | TcConnector.FindSavedQueryResponse | SOA URL:
Query-2010-04-SavedQuery/findSavedQueries

Description:
This is a generic action finds the saved queries of interest by passing in the criteria such as query name and description. The input for find saved queries is passed through FindSavedQueryInput entity.This operation returns the queries matching the input criteria names and descriptions.

Returns:
An entity of type FindSavedQueryResponse. Saved Queries can be retrieved using association TcConnector.savedQueries. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. | +| `ExecuteSavedQueries` | TcConnector.ServiceResponse | SOA URL:
Query-2010-04-SavedQuery/findSavedQueries
Query-2008-06-SavedQuery/executeSavedQueries

This is generic action to perform the search for the saved queries. It takes query name and corresponding search criteria entity for the given query.

Returns:
An entity of type ServiceResponse. Search Results can be retrieved using association TcConnector.ResponseData/TcConnector.plain. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. | +| `PerformSearch` | TcConnector.SearchResponse | SOA URL:
Query-2014-11-Finder/performSearch

Description:
This is a generic action to send the request to and receive the response from a the data provider. It routes search request to a specific provider specified as providerName in the searchInput, assuming the searchCriteria for the provider is represented in the searchCriteriaInput object e.g. `Awp0SavedQuerySearchProvider` is provider that is used for general search. The input criteria for GeneralSearch is passed through the searchCriteriaInput object.

Returns:
An entity of type SearchResponse. Search Results can be retrieved using association TcConnector.searchResultsList. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. | +| `RetrieveCookie` | System.HttpHeader | This Java action retrieves cookies of an established session between Teamcenter and Mendix. User is expected to be logged in before this Java action is invoked.
Java action is expected to throw an error if there are no valid cookies. Application devloper is expected to handle the errors. | +| `CallTeamcenterService` | TcConnector.ServiceResponse | Tc Version:
Teamcenter 10.1.5

Description:
The CallTeamcenterService Java Action is the entry point for calling Teamcenter service operations from a Microflow. This Java Action allows the developer to create a custom mapping between the Teamcenter service operation and the Mendix Domain Model Entities.

Returns:
Service response of type TcConnector.ServiceResponse. The returned list of model objects can be retrieved using appropriate association. Partial errors can be retrieved using TcConnector.ResponseData/TcConnector.PartialErrors

For more information on the usage of this Java Action kindly refer to connector documentation. | +| `GetAttachedLOV` | TcConnector.ListOfValues | SOA URL:
Core-2007-06-LOV/getAttachedLOVs

Description:
Get attached LOV based on input type name and property names structure. The LOV object is returned in the response and service data.

Returns:
LOV Entity | +| `GetInitialLOVValues` | TcConnector.GetLOVValuesResponse | SOA URL:
Core-2013-05-LOV/getInitialLOVValues

Description:
This activity is invoked to query the data for a property having an LOV attachment. The results returned from the server also take into consideration any filter string to be applied on the LOV values to be retrieved.

Returns:
This activity returns both LOV meta data as necessary for the client to render the LOV and partial LOV values list as specified. Maximum number of results to be returned are specified in the LOVFilterDataInputEntity entity. If there are more results, the moreValuesExist flag in the GetLOVValuesResponse Entity will be set to true. If the flag is true, more values can be retrieved with a call to the GetNextLOVValues activity.

For sample usage, kindly download and refer to latest version of `Teamcenter Connector Sample Application` | +| `GetNextLOVValues` | TcConnector.GetLOVValuesResponse | SOA URL:
Core-2013-05-LOV/getNextLOVValues

Description:
This activity is invoked after a call to GetInitialLOVValues if the moreValuesExist flag is true in the GetLOVValuesResponse Entity returned from a call to the GetInitialLOVValues activity. The activity will retrieve the next set of LOV values.

Returns:
LOV Search Results (GetLOVValuesResponse entity instance). Response contains LOV metadata information (LOV usage, LOV style, etc.). It also contains the instance data (LOV values) that the client can use to render the LOV UI widget. The output also contains information as to whether there are more results to be processed in which case a user can page to get next set of values (this triggers a call to the subsequent GetNextLOVValues activity).

For sample usage, kindly download and refer to latest version of `Teamcenter Connector Sample Application` | +| `GetTcSessionInformation` | TcConnector.TcServerInformation | SOA URL:
Core-2007-01-Session/getTCSessionInfo

Description:
Retrieves information about the Teamcenter Server session. | +| `GetTcSessionInfo` | TcConnector.TcServerInfo | (Deprecated)

SOA URL:
Core-2007-01-Session/getTCSessionInfo

Description:
Retrieves information about the Teamcenter Server session. | +| `Logout` | Boolean | SOA URL:
Core-2006-03-Session/logout

Tc Version:
TcEng 2005 SR1

Description:
Retrieves the Teamcenter Session for the user and attempts to log them out of Teamcenter.

Once logged out the cookies associated with the session will be deleted and the Teamcenter Host Address within the session will be set to an empty string. | +| `LoginSSO` | Boolean | SOA URL:
Core-2011-06-Session/login

Tc Version:
Teamcenter 9.0

Description:
Authenticates the users credentials and initialize a Teamcenter session for this client. The operation will throw an InvalidCredentialsException if the username, password or group is not valid.
When the client application is deployed to a 4Tier environment (communication through HTTP or TCCS) the login operation also contributes to the assignment of a Teamcenter server instance to the client session. The Teamcenter architecture varies from other client server architectures in that there is a dedicated instance of the Teamcenter server per client application. However, there are use cases where it is desirable for a single user to have multiple desktop applications running and each sharing a single instance of a Teamcenter server. This is controlled through the following elements:

hostPath From the Connection class constructor, this specifies the address (URI) the Teamcenter server is hosted on.
username From this login operation, this specifies the user's Teamcenter user name.
sessionDiscriminator From this login operation, this identifies the client session.

The hostPath argument determines the server machine that the client connects to. Once there, the pool manager on that host uses the username and sessionDiscriminator arguments of the login request to determine which Teamcenter server instance to assign the client to. If the pool manager has an existing Teamcenter server instance with the username/sessionDiscriminator key, the client is assigned to that existing instance of the Teamcenter server, and therefore sharing the server with another client; otherwise, a new instance of the Teamcenter server is used. There are a few general scenarios for the sessionDiscriminator argument:

Blank If the user jdoe logs on to Teamcenter using two or more client applications using a blank sessionDiscriminator argument (for example, jdoe/ ), all of those clients are assigned to the same Teamcenter server instance. These client applications can be running on the same or different client hosts.
Constant If the user jdoe logs on to Teamcenter using two or more client applications using a constant or fixed sessionDiscriminator argument (for example, jdoe/MyApp ), those clients are assigned to the same Teamcenter server instance. This is similar to the blank sessionDiscriminator argument; the difference is that only multiple instances of the client application using myApp started by jdoe share the same Teamcenter server instance.
Unique If the user jdoe logs on using a unique random-generated string (for example, jdoe/akdk938lakc), the client application will be assigned to a dedicated instance of the Teamcenter server.

The scenario you use depends on how your client application is used in the integrated environment. The most common case is the unique sessionDiscriminator value.

Returns:
Basic information about the server and Partial Errors are returned when the authentication is successful but requested role or locale is not supported:

214102: The login is accepted, however the requested role is not valid, and the default role will be used.
214109: The login is accepted, however the login group was empty so default role will be used.
128003: The logon is accepted. However, data entry should be done using certain locales, as specified by the TC_language_data_entry preference. The details of the data entry are returned in the error message.
128004: The logon is accepted. However, data entry should only contain characters that belong to the encoding of the database instance. The information is in the error message.
Throws:
InvalidCredentialsException - When the credentials supplied are invalid or the requested locale is not allowed.

515143: The logon was refused due to invalid username or password.
515144: The logon was refused due to invalid username or password.
515142: The logon was refused due to an invalid group.
128001: The logon was refused due to conflict with the encoding of the database instance.
128002: The logon was refused due to missing localization. | +| `Login` | Boolean | SOA URL:
Core-2011-06-Session/login

Tc Version:
Teamcenter 9.0

Description:
Authenticates the user's credentials and initialize a Teamcenter session for this client. The operation will throw an InvalidCredentialsException if the username, password or group is not valid.
When the client application is deployed to a 4Tier environment (communication through HTTP or TCCS) the login operation also contributes to the assignment of a Teamcenter server instance to the client session. The Teamcenter architecture varies from other client server architectures in that there is a dedicated instance of the Teamcenter server per client application. However, there are use cases where it is desirable for a single user to have multiple desktop applications running and each sharing a single instance of a Teamcenter server. This is controlled through the following elements:

hostPath From the Connection class constructor, this specifies the address (URI) the Teamcenter server is hosted on.
username From this login operation, this specifies the user's Teamcenter user name.
sessionDiscriminator From this login operation, this identifies the client session.

The hostPath argument determines the server machine that the client connects to. Once there, the pool manager on that host uses the username and sessionDiscriminator arguments of the login request to determine which Teamcenter server instance to assign the client to. If the pool manager has an existing Teamcenter server instance with the username/sessionDiscriminator key, the client is assigned to that existing instance of the Teamcenter server, and therefore sharing the server with another client; otherwise, a new instance of the Teamcenter server is used. There are a few general scenarios for the sessionDiscriminator argument:

Blank If the user jdoe logs on to Teamcenter using two or more client applications using a blank sessionDiscriminator argument (for example, jdoe/ ), all of those clients are assigned to the same Teamcenter server instance. These client applications can be running on the same or different client hosts.
Constant If the user jdoe logs on to Teamcenter using two or more client applications using a constant or fixed sessionDiscriminator argument (for example, jdoe/MyApp ), those clients are assigned to the same Teamcenter server instance. This is similar to the blank sessionDiscriminator argument; the difference is that only multiple instances of the client application using myApp started by jdoe share the same Teamcenter server instance.
Unique If the user jdoe logs on using a unique random-generated string (for example, jdoe/akdk938lakc), the client application will be assigned to a dedicated instance of the Teamcenter server.

The scenario you use depends on how your client application is used in the integrated environment. The most common case is the unique sessionDiscriminator value.

Returns:
Basic information about the server and Partial Errors are returned when the authentication is successful but requested role or locale is not supported:

214102: The login is accepted, however the requested role is not valid, and the default role will be used.
214109: The login is accepted, however the login group was empty so default role will be used.
128003: The logon is accepted. However, data entry should be done using certain locales, as specified by the TC_language_data_entry preference. The details of the data entry are returned in the error message.
128004: The logon is accepted. However, data entry should only contain characters that belong to the encoding of the database instance. The information is in the error message.
Throws:
InvalidCredentialsException - When the credentials supplied are invalid or the requested locale is not allowed.

515143: The logon was refused due to invalid username or password.
515144: The logon was refused due to invalid username or password.
515142: The logon was refused due to an invalid group.
128001: The logon was refused due to conflict with the encoding of the database instance.
128002: The logon was refused due to missing localization. | +| `UploadFiles` | Boolean | SOA URL:
Core-2010-04-DataManagement/createDatasets
Core-2006-03-FileManagement/commitDatasetFiles

Uploads one or more files\*\* to Teamcenter using teamcenter FMS service.

Input -
- Dataset.Documents association should hold files to be uploaded

Output -
- Action returns True or False in case of success and failure respectively.
- In addtion to this UID property is updated on Dataset object which is passed as an input to action.


\*\* - Only one file upload is supported at the moment | +| `GetImanFiles` | List of TcConnector.ImanFile | SOA URL:
Core-2006-03-DataManagement/getProperties

Read the meta properties of type ImanFile objects associated with input Dataset object

Input -
- Dataset object having UID

Output -
- Returns List of ImanFiles associated with input Dataset object | +| `WhereUsed` | Boolean | SOA URL:
Core-2007-01-DataManagement/whereUsed

Description:
This action returns all the parent Item and ItemRevision objects in the structure where the input Item or ItemRevision is used

Returns:
Input Object will be updated with WhereUsedResponseInfo objects which consits of level and parentItemRev details.
WhereUsedResponseInfo can be retrived using TcConnector.WhereUsedResponseInfo_ModelObject association | +| `GetFileTypesForDatasetType` | List of TcConnector.Pair | SOA URL:
Core-2007-06-DataManagement/getDatasetTypeInfo

Returns list of NamedReference names applicable for given Dataset Type. This NamedReference names is required while creating a dataset.

Input -
- Dataset Type

Output -
- List of valid NamedReference names for the input Dataset Type | +| `ExpandGRMRelationsForPrimary` | TcConnector.ExpandGRMResponse | SOA URL:
Core-2007-09-DataManagement/expandGRMRelationsForPrimary

Description:
This action returns the secondary objects that are related to the input primary objects.

Returns:
An entity of type ExpandGRMResponse, relationshipObject can be retrieved using association TcConnector.relationshipObjects. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. | +| `DownloadImages` | Boolean | SOA URL:
Core-2006-03-DataManagement/getProperties
Core-2006-03-FileManagement/getFileReadTickets

Downloads all the files associated with the Dataset as TcConnector.Image entity

Input -
- Dataset object having UID

Output -
- Action returns True or False in case of success and failure respectively.
- Input object's Dataset.Documents association will be updated to point to downloaded files if any. | +| `GetAvailableDatasetTypes` | List of TcConnector.Pair | SOA URL:
Core-2010-04-DataManagement/getAvailableTypesWithDisplayNames

Tc Version:
Teamcenter 8.2

Returns list of available Dataset Types. This Dataset Type is required while creating a dataset.

Input -
- None

Output -
- List of Teamcenter Dataset Types | +| `GetItemFromId` | TcConnector.GetItemFromIdResponse | SOA URL:
Core-2007-01-DataManagement/getItemFromId

Description:
This action returns Items, Item Revisions, and Dataset based on the input item id.

Returns:
An entity of type GetItemFromIdResponse. ItemRevisionOutput which contains item revisions and datasets can be retrieved using association TcConnector.itemRevOutput. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. | +| `GetProperties` | Boolean | SOA URL:
Core-2006-03-DataManagement/getProperties

Description:
This service operation is provided to get property values of Model Objects,
Input entities will be updated with new property values.

Returns:
Action returns True or False in case of success and failure respectively. | +| `UploadTemporaryFiles` | List of TcConnector.StringObject | SOA URL:
Core-2007-01-FileManagement/getTransientFileTicketsForUpload

Uploads one or more to Teamcenter Transient Volume using teamcenter FMS service\*.

Input -
- List of Files to be uploaded

Output -
- List of StringObject. Each StringObject holds File-Ticket information corresponding to input File.

\* - By default "deleteFlag" on uploaded transient files is set to true. It indicates the file would be deleted from temporary storage after it is read. | +| `SetProperties` | TcConnector.ServiceResponse | SOA URL:
Core-2010-09-DataManagement/setProperties

Description:
Updates Teamcenter objects corresponding to input model object entities.
Updated properties will be retrive from inut entiies , updated properties list not required.

Returns:
An entity of type TcConnector.ServiceResponse. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. List of modified model objects can be retrieved using TcConnector.ResponseData/TcConnector.Updated association. | +| `CreateRelation` | TcConnector.CreateRelationResponse | SOA URL:
Core-2006-03-DataManagement/createRelations

Description:
Creates the specified relation between the input objects (primary and secondary objects). If the primary object has a relation property by the specified relation name, then the secondary object is associated with the primary object through the relation property.

Returns:
The created relations. The partial error is returned for any request relation types that are not valid relation type name. | +| `CreateObject` | TcConnector.ServiceResponse | SOA URL:
Core-2015-07-DataManagement/createRelateAndSubmitObjects2

Description:
This is a generic action for creating any Teamcenter business objects. This will also create any secondary (compounded) objects that need to be created, assuming the CompoundCreateInput for the secondary object is represented in the recursive CompoundCreateInput object e.g. Item is primary object that also creates Item Master and ItemRevision. ItemRevision in turn creates ItemRevision Master. The input for all these levels is passed in through the recursive CompoundCreateInput object.

Returns:
An entity of type ServiceResponse.
Created objects can be retrieved using TcConnector.ServiceResponse/TcConnector.ResponseData/TcConnector.Created association. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. | +| `ReviseObjects` | TcConnector.ReviseObjectsResponse | SOA URL:
Core-2015-07-DataManagement/getDeepCopyData
Core-2013-05-DataManagement/reviseObjects

Description:
This is a generic revise operation for revisable business objects. This operation revises the given objects and copies or creates new objects using the data for the property values and deep copy data, assuming the reviseInput for the object is provided. The input for revise object is passed through reviseInput entity.

Returns:
An entity of type ReviseObjectsResponse. Revised objects can be retrieved using association TcConnector.revise_output and the revise tree can be retrieved using TcConnector.reviseTrees. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. | +| `ExpandGRMRelationsForSecondary` | TcConnector.ExpandGRMResponse | SOA URL:
Core-2007-09-DataManagement/expandGRMRelationsForSecondary

Description:
This action returns the primary objects that are related to the input secondary objects

Returns:
An entity of type ExpandGRMResponse, relationshipObject can be retrieved using association TcConnector.relationshipObjects. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. | +| `DownloadFiles` | Boolean | SOA URL:
Core-2006-03-DataManagement/getProperties
Core-2006-03-FileManagement/getFileReadTickets

Downloads all the files associated with the Dataset as TcConnector.FileDocument entity

Input -
- Dataset object having UID

Output -
- Action returns True or False in case of success and failure respectively.
- Input object's Dataset.Documents association will be updated to point to downloaded files if any. | +| `__SSOCallBackRequest` | Boolean | | +| `CloseBOMWindows` | TcConnector.ServiceResponse | SOA URL:
Cad-2007-01-StructureManagement/closeBOMWindows

Description:
Closes a BOMWindow. Must be used to close the BOMWindow created during Create BOM Window after calls to Expand Product Structure services are complete.

Returns:
Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. | + +#### Java action `ExpandPSAllLevels` + +SOA URL: +`Cad-2007-01-StructureManagement/expandPSAllLevels ` + +Description: +This actions finds the chilren at all levels given parent bomline. + +Returns: +An entity of type ExpandPSAllLevelsResponse. Expanded child bomlines with respective parents can be retrieved using association TcConnector.ExpandPSAllLevelsOutput. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| InputEntity | TcConnector.ExpandPSOneLevelInput | Input for ExpandPSAllLevels. | +| BusinessObjectMappings | String | SOA URL:
Cad-2007-01-StructureManagement/expandPSAllLevels

Tc Version: Teamcenter 2007

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;ItemRevision=TcConnector.ItemRevision) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | +| populateServiceDataObjects | Boolean | Indicates whether to populate service data with Created/Updated/Plain objects while constructing a service response.
Following are the valid values:
true - Populates Service Data with model objects and partial errors if any.
false - Does not populate Service Data with any model object however partial errors can still be read if any. | + +##### Return type + +TcConnector.ExpandPSAllLevelsResponse + +#### Java action `ExpandPSOneLevel2` + +SOA URL: +`Cad-2008-06-StructureManagement/expandPSOneLevel` + +Description: +This actions finds the first level children of given parent bomlines. +InputBOMLine(ParentBOMLine) will be updated with Child Objects (BOMLine_childrenObj). +DownloadFiles flag if set true, will download the files attached to Datasets. + +Returns: +InputBOMLine(ParentBOMLine) will be updated with Child Objects (BOMLine_childrenObj) +Ecah Child Object Consits of follwoing Object +ChildBOMLine(TcConnector.bomLine__Child) +ItemRevision of the ChildBOMLine (TcConnector.objectOfBOMLine) +NamedRefrenceList of attachedched Dataset can be retrived from ChildBOMLine (TcConnector.BOMLineAttachments) +Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| InputEntity | TcConnector.ExpandPSOneLevel2Input | Input for creating ExpandPSOneLevel2 | +| DownloadFiles | Boolean | DownloadFiles flag if set true, will download the files attached to Datasets. | +| BusinessObjectMappings | String | SOA URL:
Cad-2008-06-StructureManagement/expandPSOneLevel API

Tc Version: Teamcenter 8.0

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;ItemRevision=TcConnector.ItemRevision) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | +| populateServiceDataObjects | Boolean | Indicates whether to populate service data with Created/Updated/Plain objects while constructing a service response.
Following are the valid values:
true - Populates Service Data with model objects and partial errors if any.
false - Does not populate Service Data with any model object however partial errors can still be read if any. | + +##### Return type + +TcConnector.ExpandPSOneLevel2Response + +#### Java action `GetVariantRule` + +SOA URL: +`Cad-2007-01-StructureManagement/getVariantRules` + +Description: +The GetRevisionRules service gets all the variant rule related with given Item Revision. + +Returns: +Input Item Revision entity's TcConnector.variantRulesForItemRevision association will be updated with related variant rules. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| ItemRevision | TcConnector.ItemRevision | References of ItemRevision to get variant rules | +| BusinessObjectMappings | String | SOA URL:
Cad-2007-01-StructureManagement/getVariantRules

Tc Version: Teamcenter 2007

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;ItemRevision=TcConnector.ItemRevision) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +Boolean + +#### Java action `CreateBOMWindows2` + +SOA URL: +`Cad-2013-05-StructureManagement/createBOMWindows2` + +Description: +This actions Creates a BOMWindow and sets the input Item Revision as the top line , this action takes additional input such as variant rule , configuration context and bomWinPropFlagMap + +Returns: +An entity of type CreateBomWindowResponse. Top line can be retrieved using association TcConnector.bomLine__BOMWindow. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| InputEntity | TcConnector.CreateBomWindowInput | Input for creating CreateBOMWindows2 | +| BusinessObjectMappings | String | SOA URL:
Cad-2013-05-StructureManagement/createBOMWindows2

Tc Version: Teamcenter 10.1

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;ItemRevision=TcConnector.ItemRevision) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.CreateBomWindowResponse + +#### Java action `GetRevisionRules` + +SOA URL: +`Cad-2007-01-StructureManagement/getRevisionRules` + +Description: +The GetRevisionRules service gets all the persistent revision rules in the database. + +Returns: +GetRevisionRulesResponse which contains RevisionRuleInfo. RevisionRuleInfo has the revision rule. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| BusinessObjectMappings | String | SOA URL:
Cad-2007-01-StructureManagement/getRevisionRules

Tc Version: Teamcenter 2007

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;ItemRevision=TcConnector.ItemRevision) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.GetRevisionRulesResponse + +#### Java action `ExpandPSOneLevel` + +SOA URL: +`Cad-2007-01-StructureManagement/expandPSOneLevel` + +Description: +This actions finds the first level children of given parent bomline + +Returns: +An entity of type ExpandPSOneLevelResponse. Expanded child bomlines can be retrieved using association TcConnector.children. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| inputEntity | TcConnector.ExpandPSOneLevelInput | Input for expand one level. | +| businessObjectMapping | String | SOA URL:
Cad-2007-01-StructureManagement/expandPSOneLevel

Tc Version: Teamcenter 2007

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;ItemRevision=TcConnector.ItemRevision) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | +| populateServiceDataObjects | Boolean | Indicates whether to populate service data with Created/Updated/Plain objects while constructing a service response.
Following are the valid values:
true - Populates Service Data with model objects and partial errors if any.
false - Does not populate Service Data with any model object however partial errors can still be read if any. | + +##### Return type + +TcConnector.ExpandPSOneLevelResponse + +#### Java action `CreateBOMWindows` + +SOA URL: +`Cad-2007-01-StructureManagement/createBOMWindows` + +Description: +This actions Creates a BOMWindow and sets the input Item Revision as the top line + +Returns: +An entity of type CreateBomWindowResponse. Top line can be retrieved using association TcConnector.bomLine__BOMWindow. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| InputData | TcConnector.CreateBomWindowInput | Input for creating CreateBOMWindows2 | +| BusinessObjectMappings | String | SOA URL:
Cad-2013-05-StructureManagement/createBOMWindows2

Tc Version: Teamcenter 10.1

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;ItemRevision=TcConnector.ItemRevision) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.CreateBomWindowResponse + +#### Java action `GetWorkflowTemplates` + +SOA URL: +`Workflow-2008-06-Workflow/getWorkflowTemplates` + +Description: +Get the list of workflow templates given the list of target workspace objects and the All or Assigned criteria. +Returns: +An entity of type GetWorkflowTemplatesResponse. WorkflowTemplates can be retrieved using association TcConnector.workflowTemplates.Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| InputData | TcConnector.GetWorkflowTemplatesInput | Input for getWorkflowTemplates service | +| BusinessObjectMappings | String | SOA URL:
Workflow-2008-06-Workflow/getWorkflowTemplates

Tc Version: Teamcenter 8.0

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;ItemRevision=TcConnector.ItemRevision) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.GetWorkflowTemplatesResponse + +#### Java action `GetAllTasks` + +SOA URL: +`Workflow-2008-06-Workflow/getAllTasks` + +Description: +This actions gets all the tasks in a process +Returns: +An entity of type GetAllTasksResponse. AllTask can be retrieved using association TcConnector.allTasks.Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| InputData | TcConnector.GetAllTasksInput | Input for getAllTask service | +| BusinessObjectMappings | String | SOA URL:
Workflow-2008-06-Workflow/getAllTasks

Tc Version: Teamcenter 8.0

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;ItemRevision=TcConnector.ItemRevision) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.GetAllTasksResponse + +#### Java action `PerformAction` + +SOA URL: +`Workflow-2012-10-Workflow/performAction2` + +Description: +This actions performs an action on a workflow task. The following actions are supported: + +* Assign +* Start +* Complete +* Skip +* Suspend +* Resume +* Undo +* Perform +* Approve +* Reject +* Promote +* Demote +* Claim + +Returns: +Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| InputData | TcConnector.PerformActionInput | Input for performAction Service | +| BusinessObjectMappings | String | SOA URL:
Workflow-2012-10-Workflow/performAction2

Tc Version: Teamcenter 9.1.2

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;ItemRevision=TcConnector.ItemRevision) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.ServiceResponse + +#### Java action `CreateWorkflow` + +SOA URL: +`Workflow-2014-10-Workflow/createWorkflow` + +Description: +This actions relates a workflow process given the process template name, workflow owner, responsible party, attachments and attachment types. +Returns: +An entity of type CreateWorkflowResponse. WorkflowTask can be retrieved using association TcConnector.workflowTask.Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| InputData | TcConnector.CreateWorkflowInput | Input for Create Workflow service | +| BusinessObjectMappings | String | SOA URL:
Workflow-2014-10-Workflow/createWorkflow

Tc Version: Teamcenter 11.1

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;ItemRevision=TcConnector.ItemRevision) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.CreateWorkflowResponse + +#### Java action `FindUsersTasks` + +SOA URL: +Core-2007-01-Session/getTCSessionInfo +Core-2006-03-DataManagement/getProperties + +Tc Version: +Teamcenter 2007 + +Description: +This actions finds Task Inboxes of logged-in user, Task Inboxes contains `Task to Perform` and `Task to Track` +Returns: +An entity of type FindUsersTasksResponse. Task Inboxes can be retrieved using association TcConnector.TaskInbox_FindUsersTasksResponse. tasks_to_perform and tasks_to_track is a association between EPMTask and TaskInbox.Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.FindUsersTasksResponse + +#### Java action `ExecuteSavedQueriesWithObjectRefresh` + +SOA URL: +`Query-2010-04-SavedQuery/findSavedQueries` +`Query-2008-06-SavedQuery/executeSavedQueries` + +This is generic action to perform the search for the saved queries. It takes query name and corresponding search criteria entity for the given query. + +Returns: +An entity of type ServiceResponse. Search Results can be retrieved using association TcConnector.ResponseData/TcConnector.plain. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. + +##### Type parameters + +| Name | +| --- | +| searchCriteria | + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| QueryName | String | The Name of query for which executesaved Quey is to be performed | +| InputData | Type parameter `searchCriteria` | This is a searchCriteria entity which represents the information required for Searching the business object. | +| BusinessObjectMappings | String | SOA URL:
Query-2010-04-SavedQuery/findSavedQueries
Query-2008-06-SavedQuery/executeSavedQueries

Tc Version: Teamcenter 8.2 and Teamcenter 8.0

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;ItemRevision=TcConnector.ItemRevision;WorkspaceObject=TcConnector.WorkspaceObject) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.ServiceResponse + +#### Java action `PerformGeneralQuerySearchAW` + +SOA URL: +`Query-2010-04-SavedQuery/findSavedQueries` +`Query-2014-11-Finder/performSearch` + +Description: +This is a specific action to send the request to and receive the response from a the data provider `Awp0SavedQuerySearchProvider` for query `General...`. The input criteria for GeneralSearch query is passed through the generalQuerySearchInput object which is extended from .SearchInput Object. + +Returns: +An entity of type SearchResponse. Search Results can be retrieved using association TcConnector.searchResultsList. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. + +NOTE: +This action will work only if the teamcenter enviornment has active workspace installation . + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| generalQuerySearchInput | TcConnector.SearchInput | This is a type of SearchInput entity which represents the information required for Searching the business object. | +| businessObjectMapping | String | SOA URL:
Query-2010-04-SavedQuery/findSavedQueries
Query-2014-11-Finder/performSearch

Tc Version: Teamcenter 8.2
Tc Version: Teamcenter 9.1.3

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;ItemRevision=TcConnector.ItemRevision;WorkspaceObject=TcConnector.WorkspaceObject) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.SearchResponse + +#### Java action `PerformItemSimpleQuerySearchAW` + +SOA URL: +`Query-2010-04-SavedQuery/findSavedQueries` +`Query-2014-11-Finder/performSearch` + +Description: +This is a specific action to send the request to and receive the response from a the data provider `Awp0SavedQuerySearchProvider` for query `Item - simple`. The input criteria for GeneralSearch query is passed through the generalQuerySearchInput object which is extended from .SearchInput Object. + +Returns: +An entity of type SearchResponse. Search Results can be retrieved using association TcConnector.searchResultsList. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. + +NOTE: +This action will work only if the teamcenter enviornment has active workspace installation . + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| itemSimpleQuerySearchInput | TcConnector.SearchInput | This is a type of SearchInput entity which represents the information required for Searching the business object. | +| businessObjectMapping | String | SOA URL:
Query-2010-04-SavedQuery/findSavedQueries
Query-2014-11-Finder/performSearch

Tc Version: Teamcenter 8.2
Tc Version: Teamcenter 9.1.3
A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;WorkspaceObject=TcConnector.WorkspaceObject) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.SearchResponse + +#### Java action `FindSavedQueries` + +SOA URL: +`Query-2010-04-SavedQuery/findSavedQueries` + +Description: +This is a generic action finds the saved queries of interest by passing in the criteria such as query name and description. The input for find saved queries is passed through FindSavedQueryInput entity.This operation returns the queries matching the input criteria names and descriptions. + +Returns: +An entity of type FindSavedQueryResponse. Saved Queries can be retrieved using association TcConnector.savedQueries. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| InputData | TcConnector.FindSavedQueryInput | This is a type of FindSavedQueryInput entity which represents the information required for Fetching business object of the given query name. | +| BusinessObjectMappings | String | SOA URL:
Query-2010-04-SavedQuery/findSavedQueries

Tc Version: Teamcenter 8.2

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(ImanQuery=TcConnector.ImanQuery) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.FindSavedQueryResponse + +#### Java action `ExecuteSavedQueries` + +SOA URL: +`Query-2010-04-SavedQuery/findSavedQueries` +`Query-2008-06-SavedQuery/executeSavedQueries` + +This is generic action to perform the search for the saved queries. It takes query name and corresponding search criteria entity for the given query. + +Returns: +An entity of type ServiceResponse. Search Results can be retrieved using association TcConnector.ResponseData/TcConnector.plain. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. + +##### Type parameters + +| Name | +| --- | +| searchCriteria | + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| QueryName | String | The Name of query for which executesaved Quey is to be performed | +| InputData | Type parameter `searchCriteria` | This is a searchCriteria entity which represents the information required for Searching the business object. | +| BusinessObjectMappings | String | SOA URL:
Query-2010-04-SavedQuery/findSavedQueries
Query-2008-06-SavedQuery/executeSavedQueries

Tc Version: Teamcenter 8.2 and Teamcenter 8.0

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;ItemRevision=TcConnector.ItemRevision;WorkspaceObject=TcConnector.WorkspaceObject) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.ServiceResponse + +#### Java action `PerformSearch` + +SOA URL: +`Query-2014-11-Finder/performSearch` + +Description: +This is a generic action to send the request to and receive the response from a the data provider. It routes search request to a specific provider specified as providerName in the searchInput, assuming the searchCriteria for the provider is represented in the searchCriteriaInput object e.g. `Awp0SavedQuerySearchProvider` is provider that is used for general search. The input criteria for GeneralSearch is passed through the searchCriteriaInput object. + +Returns: +An entity of type SearchResponse. Search Results can be retrieved using association TcConnector.searchResultsList. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| InputData | TcConnector.SearchInput | This is a type of SearchInput entity which represents the information required for Searching the business object. | +| BusinessObjectMappings | String | SOA URL:
Query-2014-11-Finder/performSearch

Tc Version: Teamcenter 9.1.3

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;ItemRevision=TcConnector.ItemRevision;WorkspaceObject=TcConnector.WorkspaceObject) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.SearchResponse + +#### Java action `RetrieveCookie` + +This Java action retrieves cookies of an established session between Teamcenter and Mendix. User is expected to be logged in before this Java action is invoked. +Java action is expected to throw an error if there are no valid cookies. Application devloper is expected to handle the errors. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| Cookie | TcConnector.Cookie | Input Cookie | + +##### Return type + +System.HttpHeader + +#### Java action `CallTeamcenterService` + +Tc Version: +Teamcenter 10.1.5 + +Description: +The CallTeamcenterService Java Action is the entry point for calling Teamcenter service operations from a Microflow. This Java Action allows the developer to create a custom mapping between the Teamcenter service operation and the Mendix Domain Model Entities. + +Returns: +Service response of type TcConnector.ServiceResponse. The returned list of model objects can be retrieved using appropriate association. Partial errors can be retrieved using TcConnector.ResponseData/TcConnector.PartialErrors + +For more information on the usage of this Java Action kindly refer to connector documentation. + +##### Type parameters + +| Name | +| --- | +| InputArguments | + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| ServiceName | String | Fully qualified name of the service operation (Core-2011-06-Session/login) | +| InputArgument | Type parameter `InputArguments` | The input Entity for the service operation. | +| ResponseObject | TcConnector.ServiceResponse | The returned object. If null an instance of ServiceResponse will be created for the return. | +| OperationMapping | String | Path (relative to resources/OperationMappings) for the operation mapping definition.
The InputArgument and Response are mapped to the service operation input/output based on the definition in the mapping file. | +| BusinessObjectMappings | String | A semicolon separated list of Teamcenter business object names and Entity names (BOMLine=TcConnector.BOMLine;ItemRevision=TcConnector.ItemRevision) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.ServiceResponse + +#### Java action `GetAttachedLOV` + +SOA URL: +`Core-2007-06-LOV/getAttachedLOVs` + +Description: +Get attached LOV based on input type name and property names structure. The LOV object is returned in the response and service data. + +Returns: +LOV Entity + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| typeName | String | | +| propertyName | String | | +| configurationName | String | | + +##### Return type + +TcConnector.ListOfValues + +#### Java action `GetInitialLOVValues` + +SOA URL: +`Core-2013-05-LOV/getInitialLOVValues` + +Description: +This activity is invoked to query the data for a property having an LOV attachment. The results returned from the server also take into consideration any filter string to be applied on the LOV values to be retrieved. + +Returns: +This activity returns both LOV meta data as necessary for the client to render the LOV and partial LOV values list as specified. Maximum number of results to be returned are specified in the LOVFilterDataInputEntity entity. If there are more results, the moreValuesExist flag in the GetLOVValuesResponse Entity will be set to true. If the flag is true, more values can be retrieved with a call to the GetNextLOVValues activity. + +For sample usage, kindly download and refer to latest version of `Teamcenter Connector Sample Application` + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| inputEntity | TcConnector.GetInitialLOVValuesInputEntity | Input entity comprising information about Business Object, Property for which LOV information is to be read. It also contains information about number of values to fetch in this call and if any filtering to be applied on the list of values to be retrieved. | +| configurationName | String | Teamcenter Configuraiton name. Request will be made to a Teamcenter instance specified in the input configuration. | + +##### Return type + +TcConnector.GetLOVValuesResponse + +#### Java action `GetNextLOVValues` + +SOA URL: +`Core-2013-05-LOV/getNextLOVValues` + +Description: +This activity is invoked after a call to GetInitialLOVValues if the moreValuesExist flag is true in the GetLOVValuesResponse Entity returned from a call to the GetInitialLOVValues activity. The activity will retrieve the next set of LOV values. + +Returns: +LOV Search Results (GetLOVValuesResponse entity instance). Response contains LOV metadata information (LOV usage, LOV style, etc.). It also contains the instance data (LOV values) that the client can use to render the LOV UI widget. The output also contains information as to whether there are more results to be processed in which case a user can page to get next set of values (this triggers a call to the subsequent GetNextLOVValues activity). + +For sample usage, kindly download and refer to latest version of `Teamcenter Connector Sample Application` + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| lovDataEntity | TcConnector.LOVDataEntity | Input entity comprising information about LOV object is to be read. It also contains information about number of values to fetch in this call and if any filtering to be applied on the list of values to be retrieved. | +| configurationName | String | Teamcenter Configuraiton name. Request will be made to a Teamcenter instance specified in the input configuration. | + +##### Return type + +TcConnector.GetLOVValuesResponse + +#### Java action `GetTcSessionInformation` + +SOA URL: +`Core-2007-01-Session/getTCSessionInfo` + +Description: +Retrieves information about the Teamcenter Server session. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| businessObjectMapping | String | SOA URL:
Core-2007-01-Session/getTCSessionInfo

Tc Version: Teamcenter 2007

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;ItemRevision=TcConnector.ItemRevision) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.TcServerInformation + +#### Java action `GetTcSessionInfo` + +(Deprecated) + +SOA URL: +`Core-2007-01-Session/getTCSessionInfo` + +Description: +Retrieves information about the Teamcenter Server session. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.TcServerInfo + +#### Java action `Logout` + +SOA URL: +`Core-2006-03-Session/logout` + +Tc Version: +TcEng 2005 SR1 + +Description: +Retrieves the Teamcenter Session for the user and attempts to log them out of Teamcenter. + +Once logged out the cookies associated with the session will be deleted and the Teamcenter Host Address within the session will be set to an empty string. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +Boolean + +#### Java action `LoginSSO` + +SOA URL: +`Core-2011-06-Session/login` + +Tc Version: +Teamcenter 9.0 + +Description: +Authenticates the user's credentials and initialize a Teamcenter session for this client. The operation will throw an InvalidCredentialsException if the username, password or group is not valid. +When the client application is deployed to a 4Tier environment (communication through HTTP or TCCS) the login operation also contributes to the assignment of a Teamcenter server instance to the client session. The Teamcenter architecture varies from other client server architectures in that there is a dedicated instance of the Teamcenter server per client application. However, there are use cases where it is desirable for a single user to have multiple desktop applications running and each sharing a single instance of a Teamcenter server. This is controlled through the following elements: + +hostPath From the Connection class constructor, this specifies the address (URI) the Teamcenter server is hosted on. +username From this login operation, this specifies the user's Teamcenter user name. +sessionDiscriminator From this login operation, this identifies the client session. + +The hostPath argument determines the server machine that the client connects to. Once there, the pool manager on that host uses the username and sessionDiscriminator arguments of the login request to determine which Teamcenter server instance to assign the client to. If the pool manager has an existing Teamcenter server instance with the username/sessionDiscriminator key, the client is assigned to that existing instance of the Teamcenter server, and therefore sharing the server with another client; otherwise, a new instance of the Teamcenter server is used. There are a few general scenarios for the sessionDiscriminator argument: + +Blank If the user jdoe logs on to Teamcenter using two or more client applications using a blank sessionDiscriminator argument (for example, jdoe/ ), all of those clients are assigned to the same Teamcenter server instance. These client applications can be running on the same or different client hosts. +Constant If the user jdoe logs on to Teamcenter using two or more client applications using a constant or fixed sessionDiscriminator argument (for example, jdoe/MyApp ), those clients are assigned to the same Teamcenter server instance. This is similar to the blank sessionDiscriminator argument; the difference is that only multiple instances of the client application using myApp started by jdoe share the same Teamcenter server instance. +Unique If the user jdoe logs on using a unique random-generated string (for example, jdoe/akdk938lakc), the client application will be assigned to a dedicated instance of the Teamcenter server. + +The scenario you use depends on how your client application is used in the integrated environment. The most common case is the unique sessionDiscriminator value. + +Returns: +Basic information about the server and Partial Errors are returned when the authentication is successful but requested role or locale is not supported: + +214102: The login is accepted, however the requested role is not valid, and the default role will be used. +214109: The login is accepted, however the login group was empty so default role will be used. +128003: The logon is accepted. However, data entry should be done using certain locales, as specified by the TC_language_data_entry preference. The details of the data entry are returned in the error message. +128004: The logon is accepted. However, data entry should only contain characters that belong to the encoding of the database instance. The information is in the error message. +Throws: +InvalidCredentialsException - When the credentials supplied are invalid or the requested locale is not allowed. + +515143: The logon was refused due to invalid username or password. +515144: The logon was refused due to invalid username or password. +515142: The logon was refused due to an invalid group. +128001: The logon was refused due to conflict with the encoding of the database instance. +128002: The logon was refused due to missing localization. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| UserCredentials | TcConnector.Credentials | Credentials to use for Logging int to Teamcenter. | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | +| TcSession | TcConnector.TcSession | | + +##### Return type + +Boolean + +#### Java action `Login` + +SOA URL: +`Core-2011-06-Session/login` + +Tc Version: +Teamcenter 9.0 + +Description: +Authenticates the user's credentials and initialize a Teamcenter session for this client. The operation will throw an InvalidCredentialsException if the username, password or group is not valid. +When the client application is deployed to a 4Tier environment (communication through HTTP or TCCS) the login operation also contributes to the assignment of a Teamcenter server instance to the client session. The Teamcenter architecture varies from other client server architectures in that there is a dedicated instance of the Teamcenter server per client application. However, there are use cases where it is desirable for a single user to have multiple desktop applications running and each sharing a single instance of a Teamcenter server. This is controlled through the following elements: + +hostPath From the Connection class constructor, this specifies the address (URI) the Teamcenter server is hosted on. +username From this login operation, this specifies the user's Teamcenter user name. +sessionDiscriminator From this login operation, this identifies the client session. + +The hostPath argument determines the server machine that the client connects to. Once there, the pool manager on that host uses the username and sessionDiscriminator arguments of the login request to determine which Teamcenter server instance to assign the client to. If the pool manager has an existing Teamcenter server instance with the username/sessionDiscriminator key, the client is assigned to that existing instance of the Teamcenter server, and therefore sharing the server with another client; otherwise, a new instance of the Teamcenter server is used. There are a few general scenarios for the sessionDiscriminator argument: + +Blank If the user jdoe logs on to Teamcenter using two or more client applications using a blank sessionDiscriminator argument (for example, jdoe/ ), all of those clients are assigned to the same Teamcenter server instance. These client applications can be running on the same or different client hosts. +Constant If the user jdoe logs on to Teamcenter using two or more client applications using a constant or fixed sessionDiscriminator argument (for example, jdoe/MyApp ), those clients are assigned to the same Teamcenter server instance. This is similar to the blank sessionDiscriminator argument; the difference is that only multiple instances of the client application using myApp started by jdoe share the same Teamcenter server instance. +Unique If the user jdoe logs on using a unique random-generated string (for example, jdoe/akdk938lakc), the client application will be assigned to a dedicated instance of the Teamcenter server. + +The scenario you use depends on how your client application is used in the integrated environment. The most common case is the unique sessionDiscriminator value. + +Returns: +Basic information about the server and Partial Errors are returned when the authentication is successful but requested role or locale is not supported: + +214102: The login is accepted, however the requested role is not valid, and the default role will be used. +214109: The login is accepted, however the login group was empty so default role will be used. +128003: The logon is accepted. However, data entry should be done using certain locales, as specified by the TC_language_data_entry preference. The details of the data entry are returned in the error message. +128004: The logon is accepted. However, data entry should only contain characters that belong to the encoding of the database instance. The information is in the error message. +Throws: +InvalidCredentialsException - When the credentials supplied are invalid or the requested locale is not allowed. + +515143: The logon was refused due to invalid username or password. +515144: The logon was refused due to invalid username or password. +515142: The logon was refused due to an invalid group. +128001: The logon was refused due to conflict with the encoding of the database instance. +128002: The logon was refused due to missing localization. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| UserCredentials | TcConnector.Credentials | Credentials to use for Logging int to Teamcenter. | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +Boolean + +#### Java action `UploadFiles` + +SOA URL: +`Core-2010-04-DataManagement/createDatasets` +`Core-2006-03-FileManagement/commitDatasetFiles` + +Uploads one or more files to Teamcenter using teamcenter FMS service. +Only one file upload is supported at the moment. + +Input + +* Dataset.Documents association should hold files to be uploaded + +Output + +* Action returns True or False in case of success and failure respectively. +* In addtion to this UID property is updated on Dataset object which is passed as an input to action. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| DatasetParameter | TcConnector.Dataset | SOA URL:
Core-2010-04-DataManagement/createDatasets
Core-2006-03-FileManagement/commitDatasetFiles

Tc Version: Teamcenter 8.2 and TcEng 2005 SR1

Placeholder to maintain the file(s) to be uplaoded to Teamcenter. Dataset.Documents association should hold files to be uploaded
Input Dataset object would be updated with UID for reference once all the files are uploaded to Teamcenter. UID can be used in future to download the files from Teamcenter. | +| NamedReference | String | Reference name to be used to associate Uploaded File(s) to the Dataset.

Please use getFileTypesForDatasetType Java Action to get list of valid NamedReference names for the given dataset type. | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +Boolean + +#### Java action `GetImanFiles` + +SOA URL: +Core-2006-03-DataManagement/getProperties + +Read the meta properties of type ImanFile objects associated with input Dataset object + +Input + +* Dataset object having UID + +Output + +* Returns List of ImanFiles associated with input Dataset object + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| DatasetParameter | TcConnector.Dataset | SOA URL:
Core-2006-03-DataManagement/getProperties
Core-2006-03-FileManagement/getFileReadTickets

Tc Version: TcEng 2005 SR1

Must contain UID of the Teamcenter dataset whose files are to be downloaded. | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +List of TcConnector.ImanFile + +#### Java action `WhereUsed` + +SOA URL: +Core-2007-01-DataManagement/whereUsed + +Description: +This action returns all the parent Item and ItemRevision objects in the structure where the input Item or ItemRevision is used + +Returns: +Input Object will be updated with WhereUsedResponseInfo objects which consits of level and parentItemRev details. +WhereUsedResponseInfo can be retrived using TcConnector.WhereUsedResponseInfo_ModelObject association + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| InputEntity | TcConnector.WhereUsedInput | Input for whereUsed Service | +| BusinessObjectMappings | String | SOA URL:
Core-2007-01-DataManagement/whereUsed

Tc Version: Teamcenter 2007

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;ItemRevision=TcConnector.ItemRevision) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +Boolean + +#### Java action `GetFileTypesForDatasetType` + +SOA URL: +`Core-2007-06-DataManagement/getDatasetTypeInfo` + +Returns list of NamedReference names applicable for given Dataset Type. This NamedReference names is required while creating a dataset. + +Input + +* Dataset Type + +Output + +* List of valid NamedReference names for the input Dataset Type + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| dataset_type | String | SOA URL:
Core-2007-06-DataManagement/getDatasetTypeInfo

Tc Version: Teamcenter 8.2

Dataset Type for which list of NamedReference names is to be returned. | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +List of TcConnector.Pair + +#### Java action `ExpandGRMRelationsForPrimary` + +SOA URL: +`Core-2007-09-DataManagement/expandGRMRelationsForPrimary` + +Description: +This action returns the secondary objects that are related to the input primary objects. + +Returns: +An entity of type ExpandGRMResponse, relationshipObject can be retrieved using association TcConnector.relationshipObjects. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| InputEntity | TcConnector.ExpandGRMInput | Input for ExpandGRMRelationsForPrimary | +| BusinessObjectMappings | String | SOA URL:
Core-2007-09-DataManagement/expandGRMRelationsForPrimary

Tc Version: Teamcenter 2007

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;ItemRevision=TcConnector.ItemRevision) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.ExpandGRMResponse + +#### Java action `DownloadImages` + +SOA URL: +`Core-2006-03-DataManagement/getProperties` +`Core-2006-03-FileManagement/getFileReadTickets` + +Downloads all the files associated with the Dataset as TcConnector.Image entity + +Input + +* Dataset object having UID + +Output + +* Action returns True or False in case of success and failure respectively. +* Input objec's Dataset.Documents association will be updated to point to downloaded files if any. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| DatasetParameter | TcConnector.Dataset | SOA URL:
Core-2006-03-DataManagement/getProperties
Core-2006-03-FileManagement/getFileReadTickets

Tc Version: TcEng 2005 SR1

Must contain UID of the Teamcenter dataset whose files are to be downloaded. | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +Boolean + +#### Java action `GetAvailableDatasetTypes` + +SOA URL: +`Core-2010-04-DataManagement/getAvailableTypesWithDisplayNames` + +Tc Version: +Teamcenter 8.2 + +Returns list of available Dataset Types. This Dataset Type is required while creating a dataset. + +Input + +* None + +Output + +* List of Teamcenter Dataset Types + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +List of TcConnector.Pair + +#### Java action `GetItemFromId` + +SOA URL: +`Core-2007-01-DataManagement/getItemFromId` + +Description: +This action returns Items, Item Revisions, and Dataset based on the input item id. + +Returns: +An entity of type GetItemFromIdResponse. ItemRevisionOutput which contains item revisions and datasets can be retrieved using association TcConnector.itemRevOutput. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| InputEntity | TcConnector.GetItemFromIdInput | Input for GetItemFromId Service | +| BusinessObjectMappings | String | SOA URL:
Core-2007-01-DataManagement/getItemFromId

Tc Version: Teamcenter 2007

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;ItemRevision=TcConnector.ItemRevision) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.GetItemFromIdResponse + +#### Java action `GetProperties` + +SOA URL: +Core-2006-03-DataManagement/getProperties + +Description: +This service operation is provided to get property values of Model Objects, +Input entities will be updated with new property values. + +Returns: +Action returns True or False in case of success and failure respectively. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| InputObjects | List of TcConnector.ModelObject | List of Mendix objects whose properties are to be fetched. All the properties available on the input object will be retrieved. | +| BusinessObjectMappings | String | SOA URL:
Core-2006-03-DataManagement/getProperties

Tc Version: TcEng 2005 SR1

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(ImanQuery=TcConnector.ImanQuery) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +Boolean + +#### Java action `UploadTemporaryFiles` + +SOA URL: +`Core-2007-01-FileManagement/getTransientFileTicketsForUpload` + +Uploads one or more to Teamcenter Transient Volume using teamcenter FMS service. +By default, `deleteFlag` on uploaded transient files is set to true. It indicates the file would be deleted from temporary storage after it is read. + +Input + +* List of Files to be uploaded + +Output + +* List of StringObject. Each StringObject holds File-Ticket information corresponding to input File. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | +| Files | List of TcConnector.FileDocument | List of files to be uploaded to Teamcenter Transient Volume. | + +##### Return type + +List of TcConnector.StringObject + +#### Java action `SetProperties` + +SOA URL: +`Core-2010-09-DataManagement/setProperties` + +Description: +Updates Teamcenter objects corresponding to input model object entities. +Updated properties will be retrive from inut entiies , updated properties list not required. + +Returns: +An entity of type TcConnector.ServiceResponse. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. List of modified model objects can be retrieved using TcConnector.ResponseData/TcConnector.Updated association. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| modelObjects | List of TcConnector.ModelObject | List of model object entities ( with updated values ) whose corresponding Teamcenter objects to be updated on Teamcenter site. | +| businessObjectMapping | String | SOA URL:
Core-2010-09-DataManagement/setProperties

Tc Version: Teamcenter 8.3

Business object mappings
e.g. ItemRevision=TcConnector.ItemRevision | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.ServiceResponse + +#### Java action `CreateRelation` + +SOA URL: +`Core-2006-03-DataManagement/createRelations` + +Description: +Creates the specified relation between the input objects (primary and secondary objects). If the primary object has a relation property by the specified relation name, then the secondary object is associated with the primary object through the relation property. + +Returns: +The created relations. The partial error is returned for any request relation types that are not valid relation type name. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| InputData | TcConnector.CreateRelationInput | Input argument for invoking createRelations service. | +| BusinessObjectMappings | String | SOA URL:
Core-2006-03-DataManagement/createRelations

Tc Version: TcEng 2005 SR1

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(ImanRelation=TcConnector.ImanRelation) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.CreateRelationResponse + +#### Java action `CreateObject` + +SOA URL: +`Core-2015-07-DataManagement/createRelateAndSubmitObjects2` + +Description: +This is a generic action for creating any Teamcenter business objects. This will also create any secondary (compounded) objects that need to be created, assuming the CompoundCreateInput for the secondary object is represented in the recursive CompoundCreateInput object e.g. Item is primary object that also creates Item Master and ItemRevision. ItemRevision in turn creates ItemRevision Master. The input for all these levels is passed in through the recursive CompoundCreateInput object. + +Returns: +An entity of type ServiceResponse. +Created objects can be retrieved using TcConnector.ServiceResponse/TcConnector.ResponseData/TcConnector.Created association. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| createInput | TcConnector.CreateInput | This is a type of CreateInput entity which represents the information required for Creating the business object. | +| businessObjectMapping | String | SOA URL:
Core-2015-07-DataManagement/createRelateAndSubmitObjects2

Tc Version: Teamcenter 11.2

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;ItemRevision=TcConnector.ItemRevision) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.ServiceResponse + +#### Java action `ReviseObjects` + +SOA URL: +`Core-2015-07-DataManagement/getDeepCopyData` +`Core-2013-05-DataManagement/reviseObjects` + +Description: +This is a generic revise operation for revisable business objects. This operation revises the given objects and copies or creates new objects using the data for the property values and deep copy data, assuming the reviseInput for the object is provided. The input for revise object is passed through reviseInput entity. + +Returns: +An entity of type ReviseObjectsResponse. Revised objects can be retrieved using association TcConnector.revise_output and the revise tree can be retrieved using TcConnector.reviseTrees. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| objectToRevise | TcConnector.WorkspaceObject | The target business object being revised. | +| reviseInput | TcConnector.ReviseInputs | This is a type of ReviseInput entity which represents the information required for revising the business object. | +| businessObjectMapping | String | SOA URL:
Core-2015-07-DataManagement/getDeepCopyData
Core-2013-05-DataManagement/reviseObjects
Core-2007-09-DataManagement/loadObjects

Tc Version: Teamcenter 11.2
Tc Version: Teamcenter 10.1
Tc Version: Teamcenter 2007.1 MP1

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;ItemRevision=TcConnector.ItemRevision;WorkspaceObject=TcConnector.WorkspaceObject) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.ReviseObjectsResponse + +#### Java action `ExpandGRMRelationsForSecondary` + +SOA URL: +`Core-2007-09-DataManagement/expandGRMRelationsForSecondary` + +Description: +This action returns the primary objects that are related to the input secondary objects + +Returns: +An entity of type ExpandGRMResponse, relationshipObject can be retrieved using association TcConnector.relationshipObjects. Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| InputEntity | TcConnector.ExpandGRMInput | Input for ExpandGRMRelationsForSecondary | +| BusinessObjectMappings | String | SOA URL:
Core-2007-09-DataManagement/expandGRMRelationsForSecondary

Tc Version: Teamcenter 2007

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;ItemRevision=TcConnector.ItemRevision) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.ExpandGRMResponse + +[Back to top](https://docs.sw.siemens.com/documentation/external/PL20250618245080666/en-US/TcConnectorAPI/TCConnector_2506.html#top) + +#### Java action `DownloadFiles` + +SOA URL: +`Core-2006-03-DataManagement/getProperties` +`Core-2006-03-FileManagement/getFileReadTickets` + +Downloads all the files associated with the Dataset as TcConnector.FileDocument entity + +Input + +* Dataset object having UID + +Output + +* Action returns True or False in case of success and failure respectively. +* Input object's Dataset.Documents association will be updated to point to downloaded files if any. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| DatasetParameter | TcConnector.Dataset | SOA URL:
Core-2006-03-DataManagement/getProperties
Core-2006-03-FileManagement/getFileReadTickets

Tc Version: TcEng 2005 SR1

Must contain UID of the Teamcenter dataset whose files are to be downloaded. | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +Boolean + +#### Java action `__SSOCallBackRequest` + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| contextPath | String | | + +##### Return type + +Boolean + +#### Java action `CloseBOMWindows` + +SOA URL: +`Cad-2007-01-StructureManagement/closeBOMWindows` + +Description: +Closes a BOMWindow. Must be used to close the BOMWindow created during Create BOM Window after calls to Expand Product Structure services are complete. + +Returns: +Partial errors can be retrieved using association TcConnector.ResponseData/TcConnector.PartialErrors. + +##### Type parameters + +This has no type parameters. + +##### Parameters + +| Name | Type | Documentation | +| --- | --- | --- | +| InputEntity | TcConnector.CloseBOMWindowslInput | Input for creating CloseBOMWindows | +| BusinessObjectMappings | String | SOA URL:
Cad-2007-01-StructureManagement/closeBOMWindows

Tc Version: Teamcenter 2007

A semicolon separated list of Teamcenter business object names and Entity names. e.g.(Item=TcConnector.Item;ItemRevision=TcConnector.ItemRevision) | +| ConfigurationName | String | The teamcenter configuration name for which the action is to be performed. In case of single active connection pass the configuration name or empty value. | + +##### Return type + +TcConnector.ServiceResponse + +### Enumerations + +| Name | Documentation | +| --- | --- | +| `FileDownloadType` | | + +#### Enumeration `FileDownloadType` + +##### Values + +| Name | Caption | +| --- | --- | +| FileDocument | FileDocument | +| Image | Image | + +### ModuleRoles + +| Name | Documentation | +| --- | --- | +| Administrator | This module role gives the admin rights to the assigned user roles. | +| User | This module role only give the user rights to the assigned user roles. | + +### Pages + +| Title | Documentation | Allowed Roles | +| --- | --- | --- | +| Teamcenter Home | | | +| Admin Home | | | +| Teamcenter Configuration | | TcConnector.Administrator | +| Teamcenter Configurations | | TcConnector.Administrator | +| Teamcenter Login | | | +| Teamcenter Login | | | +| Active Configurations | | TcConnector.Administrator, TcConnector.User | + +### Constants + +| Name | Value | Documentation | +| --- | --- | --- | +| EnableMultipleActiveConfig | False | Set to true to use multiple configuration active at same time, false value with only allow single active configuration. | +| Version | 2412.0225.0 | | +| SSO_ContextURLPath | TCSSO | | +| UseSharedSession | True | Set to true to share a single TcServer session for a given user across all Mendix sessions.
When set to false, a new TcServer is assinged for each Mendix session. | + +### Snippets + +| Name | Documentation | +| --- | --- | +| _TCSSO_Connector_Documentation | | +| _TCX_Connector_Documentation | | diff --git a/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/teamcenterx.md b/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/teamcenterx.md new file mode 100755 index 00000000000..46265c30c00 --- /dev/null +++ b/content/en/docs/marketplace/platform-supported-content/modules/siemens/teamcenter-connector/teamcenterx.md @@ -0,0 +1,76 @@ +--- +title: "Configuring the Connection to Teamcenter X" +url: /appstore/modules/siemens-plm/teamcenterx/ +weight: 2 +description: "Describes the steps to connect to Teamcenter X." +--- + +## Prerequisites + +Before setting up the connection to Teamcenter X, you must get some information from your Teamcenter representative: + +* **OIDC configuration information** + * Mendix app client ID + * Mendix app secret + +* **SAM Auth information** + * Token Exchange Client ID + * Token Exchange Client Secret + * Token end point + * Teamcenter X Client ID + +* **Teamcenter X environment information** + * Teamcenter Host URL + * Teamcenter FMS URL + +## Configuring the Mendix OIDC Module + +To allow users of your Mendix app to log on via Single Sign-On (SSO), you must set up the OIDC module. +Ensure that the [Mendix OIDC module](/appstore/modules/oidc/) and its dependent modules are added to your Mendix app. + +1. Install the following dependent modules from the Mendix Marketplace: + + * Community Commons + * Nanoflow Commons + * Mx Model Reflection + * User Commons + * OIDC Module + +2. In Mendix, navigate to **App Users** and assign admin and user roles to their respective equivalents. +3. Set the constant **Encryption.EncryptionKey** with a random 32-character string. +4. Setup Mx Model Reflection and synchronize all module entities and microflows. + For more information, see the [Mx Model Reflection documentation](/appstore/modules/oidc/#mxmodelreflection). +Setup SAMAuth registration in the configuration folder of the OIDC module by [setting the following constants](/appstore/modules/oidc/#deploy-time-idps-for-sso-and-api-security-configuration). + +| **Field** | **Description** | +| --------- | ----------------| +| **Client Alias** | A custom name for the client. | +| **Client Id** | The ID for the Mendix app registered with SamAuth. | +| **Client Secret** | The secret key for the Mendix app registered with SamAuth. | +| **AutomaticConfigurationURL** | The well-known config URL that provides metadata for the SamAuth configuration.
For example, `https://samauth.us-east-1.sws.siemens.com/.well-known/openid-configuration`. | +| **SelectedScope** | The scope for **openid** and **sam_account**.
Multiple values can be separated by a space. | + +## Configuring the Mendix OIDC Module with your Mendix App + +To allow users of your Mendix app to log on via Single Sign-On (SSO), you must set up the OIDC module. + +1. Assign admin and user roles to their respective equivalents. +2. Give the admin and user roles access to the following elements in the OIDC module: + + | **Element** | **Element name** | + | ------- | ------------ | + | Microflow | **DS_GetClientConfigurationList**
**GetAuthorizationURL** | + | Nanoflow | **ACT_StartWebSignIn**
**DS_GetReturnURL**
**DS_StartWebLogin** | + | Entities | **ClientConfig**
**ClientConfig_Ext** | + | Pages | **Login_Web_Button** | + +## Connecting the Teamcenter Connector to Teamcenter X + +To connect Teamcenter Connector for Mendix with Teamcenter X, you must specify the connection details in the Teamcenter Environment Configuration page. + +1. Run your project. The browser displays the AdminHomePage. +2. Click **TEAMCENTER CONFIGURATIONS**. +3. Click **New** in the Teamcenter Environment Configuration page. +4. Within Add Teamcenter Configuration, set the **Is TcX Environment** option to **Yes** and complete the fields with the information you received from your Siemens representative. + {{< figure src="/attachments/partners/siemens/teamcenter/tc_connector_configuration_initial.png" alt="" class="no-border" >}} +5. Click **Save**. diff --git a/static/attachments/partners/siemens/teamcenter/image005.png b/static/attachments/partners/siemens/teamcenter/image005.png new file mode 100644 index 00000000000..e8704b6789e Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image005.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image006.png b/static/attachments/partners/siemens/teamcenter/image006.png new file mode 100644 index 00000000000..d1a1c15c265 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image006.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image007.png b/static/attachments/partners/siemens/teamcenter/image007.png new file mode 100644 index 00000000000..7afc9cef3c4 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image007.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image009.png b/static/attachments/partners/siemens/teamcenter/image009.png new file mode 100644 index 00000000000..1812ce13a35 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image009.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image010.png b/static/attachments/partners/siemens/teamcenter/image010.png new file mode 100644 index 00000000000..037c1d44118 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image010.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image011.png b/static/attachments/partners/siemens/teamcenter/image011.png new file mode 100644 index 00000000000..5f5d45e0850 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image011.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image012.png b/static/attachments/partners/siemens/teamcenter/image012.png new file mode 100644 index 00000000000..cd73b694d3a Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image012.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image015.png b/static/attachments/partners/siemens/teamcenter/image015.png new file mode 100644 index 00000000000..1bdcd9aecc3 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image015.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image016.png b/static/attachments/partners/siemens/teamcenter/image016.png new file mode 100644 index 00000000000..a3277ab0290 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image016.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image017.png b/static/attachments/partners/siemens/teamcenter/image017.png new file mode 100644 index 00000000000..2fc4916ddab Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image017.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image018.png b/static/attachments/partners/siemens/teamcenter/image018.png new file mode 100644 index 00000000000..e1ff9a121de Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image018.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image019.png b/static/attachments/partners/siemens/teamcenter/image019.png new file mode 100644 index 00000000000..59c10776c54 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image019.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image020.png b/static/attachments/partners/siemens/teamcenter/image020.png new file mode 100644 index 00000000000..e8e6db1bca9 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image020.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image021.png b/static/attachments/partners/siemens/teamcenter/image021.png new file mode 100644 index 00000000000..849211c208d Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image021.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image022.png b/static/attachments/partners/siemens/teamcenter/image022.png new file mode 100644 index 00000000000..a267a13aa73 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image022.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image023.png b/static/attachments/partners/siemens/teamcenter/image023.png new file mode 100644 index 00000000000..752c8984600 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image023.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image024.png b/static/attachments/partners/siemens/teamcenter/image024.png new file mode 100644 index 00000000000..6f6444b487f Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image024.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image025.jpg b/static/attachments/partners/siemens/teamcenter/image025.jpg new file mode 100644 index 00000000000..c3cf459d767 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image025.jpg differ diff --git a/static/attachments/partners/siemens/teamcenter/image026.png b/static/attachments/partners/siemens/teamcenter/image026.png new file mode 100644 index 00000000000..3ca1510abaa Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image026.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image027.png b/static/attachments/partners/siemens/teamcenter/image027.png new file mode 100644 index 00000000000..98e596f7554 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image027.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image028.png b/static/attachments/partners/siemens/teamcenter/image028.png new file mode 100644 index 00000000000..df71fc49097 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image028.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image029.png b/static/attachments/partners/siemens/teamcenter/image029.png new file mode 100644 index 00000000000..0ea5848110e Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image029.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image030.png b/static/attachments/partners/siemens/teamcenter/image030.png new file mode 100644 index 00000000000..4525a33d963 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image030.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image031.png b/static/attachments/partners/siemens/teamcenter/image031.png new file mode 100644 index 00000000000..5ef47348c08 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image031.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image032.png b/static/attachments/partners/siemens/teamcenter/image032.png new file mode 100644 index 00000000000..cbe642d21d6 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image032.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image033.png b/static/attachments/partners/siemens/teamcenter/image033.png new file mode 100644 index 00000000000..ab319e6c23e Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image033.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image034.png b/static/attachments/partners/siemens/teamcenter/image034.png new file mode 100644 index 00000000000..77cecfde20c Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image034.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image035.png b/static/attachments/partners/siemens/teamcenter/image035.png new file mode 100644 index 00000000000..da99858df1f Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image035.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image036.png b/static/attachments/partners/siemens/teamcenter/image036.png new file mode 100644 index 00000000000..a7f57974367 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image036.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image037.png b/static/attachments/partners/siemens/teamcenter/image037.png new file mode 100644 index 00000000000..97c5ef6f27c Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image037.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image038.png b/static/attachments/partners/siemens/teamcenter/image038.png new file mode 100644 index 00000000000..0ecfa2cf841 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image038.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image039.png b/static/attachments/partners/siemens/teamcenter/image039.png new file mode 100644 index 00000000000..8fa833493e3 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image039.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image040.png b/static/attachments/partners/siemens/teamcenter/image040.png new file mode 100644 index 00000000000..2a2ccd23aac Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image040.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image041.png b/static/attachments/partners/siemens/teamcenter/image041.png new file mode 100644 index 00000000000..958afbce80b Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image041.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image042.png b/static/attachments/partners/siemens/teamcenter/image042.png new file mode 100644 index 00000000000..942b78584a7 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image042.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image043.png b/static/attachments/partners/siemens/teamcenter/image043.png new file mode 100644 index 00000000000..28173a68902 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image043.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image044.png b/static/attachments/partners/siemens/teamcenter/image044.png new file mode 100644 index 00000000000..f96cea97f23 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image044.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image045.png b/static/attachments/partners/siemens/teamcenter/image045.png new file mode 100644 index 00000000000..08c5d803974 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image045.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image046.png b/static/attachments/partners/siemens/teamcenter/image046.png new file mode 100644 index 00000000000..ae24e705583 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image046.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image047.png b/static/attachments/partners/siemens/teamcenter/image047.png new file mode 100644 index 00000000000..baa6a39e8ef Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image047.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image048.png b/static/attachments/partners/siemens/teamcenter/image048.png new file mode 100644 index 00000000000..86342140e5d Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image048.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image049.png b/static/attachments/partners/siemens/teamcenter/image049.png new file mode 100644 index 00000000000..2b0acff4b40 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image049.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image050.png b/static/attachments/partners/siemens/teamcenter/image050.png new file mode 100644 index 00000000000..75a427c91f5 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image050.png differ diff --git a/static/attachments/partners/siemens/teamcenter/image051.png b/static/attachments/partners/siemens/teamcenter/image051.png new file mode 100644 index 00000000000..6053a2e088d Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/image051.png differ diff --git a/static/attachments/partners/siemens/teamcenter/proxy-host-details.png b/static/attachments/partners/siemens/teamcenter/proxy-host-details.png new file mode 100644 index 00000000000..e9a8b3d8ee4 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/proxy-host-details.png differ diff --git a/static/attachments/partners/siemens/teamcenter/tc_connection_configuration.png b/static/attachments/partners/siemens/teamcenter/tc_connection_configuration.png new file mode 100644 index 00000000000..3492ab5a930 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/tc_connection_configuration.png differ diff --git a/static/attachments/partners/siemens/teamcenter/tc_connector_configuration_initial.png b/static/attachments/partners/siemens/teamcenter/tc_connector_configuration_initial.png new file mode 100644 index 00000000000..ba4ce464c07 Binary files /dev/null and b/static/attachments/partners/siemens/teamcenter/tc_connector_configuration_initial.png differ