Configure a verification request

You can configure a verification request by creating an analysis definition, updating the SOA mapping and client policy files, and modifying the verification request style sheet for accurate dataset display.

Procedure

1. Create the analysis definition

   Each verification request is based on a template called the analysis definition. You must create an analysis definition for each request type that a user can create in your business.

   You specify each analysis definition in a separate XML file that lists the input and output item types permitted in a verification request.

   A default analysis configuration file is created whenever an analysis definition object is created. You can replace or remove the configuration file if necessary. However, you must validate a new file against the specified XML schema.

   Example format:

   <?xml version="1.0" encoding="UTF-8"?>
   <configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:noNamespaceSchemaLocation="Crt0ContractPkgSchema.xsd">
     <input>
       <objectType type="Fnd0LogicalBlockRevision" quantity="*"/>
       <objectType type="Requirement Revision" quantity="*"/>
       <objectType type="RequirementSpec Revision" quantity="*"/>
       <objectType type="DocumentRevision" quantity="*"/>
       <objectType type="ItemRevision" quantity="*"/>
     </input>
     <output>
       <objectType type="DocumentRevision" quantity="*"/>
       <objectType type="ItemRevision" quantity="*"/>
     </output>
   </configuration>
   

2. Update the SOA mapping file

   The Get Analysis Request API does not return the properties for certain parameters, such as properties for object_name, object_desc, and object_type in the Verification Request Revision object. To resolve this, add the required objects and their properties to the ARObjectPropertyConfiguration.xml file. This file is located in the TC_ROOT/bhm/config folder.

   Example — adding the Verification Request Revision object and its properties:

   <Object Type="Crt0VldnContractRevision" >
     <Property Name="object_name" />
     <Property Name="object_type" />
     <Property Name="object_desc" />
     <Property Name="crt0Configuration" />
     <Property Name="crt0Domain" />
     <Property Name="crt0Purpose" />
     <Property Name="crt0Result" />
     <Property Name="crt0State" />
   </Object>
   

3. Update the BHM client policy file

   If you want additional properties of an object returned by the Get Analysis Request API, modify the BHMClient.policy file on the server as follows:

   • Navigate to the TC_ROOT/tcdata/soa/policies folder.
   • Open the BHMClientPolicy.xml file.
   • Update the following in the ObjectType section of Awb0Connection:

   <ObjectType name="Awb0Connection" >
     <Property name="awb0End1" withProperties="true" />
     <Property name="awb0End2" withProperties="true" />
   </ObjectType>
   

   • Make similar changes to the BHMClientPolicy.xml file located in the TC_DATA/soa/policies folder.

4. Client side verification request mapping

   Configure the files and datasets that can be associated with the verification request results by updating the AR_IntegrationDefinition.xml file.

   This file is located in the TC_ROOT\bhm\config folder.

5. Update the verification request style sheet

   Update the verification request style sheet to display the datasets in the Output section of the Results tab.

   The style sheet is named Crt0VldnContractRevSummary.xml. Search for the dataset Crt0VldnContractRevSummary and modify the associated named reference XML file.

   Update the tc_xrt_Reports section with the dataset types.

   Example — to add a PDF type, update the source attribute of objectSet as a comma-separated entry:

   Crt1AnalysisRequestOutProvider.Text,
   Crt1AnalysisRequestOutProvider.PDF
   

After completing this configuration, you can:

• Refer to the List of optional server-side configurations for Teamcenter MBSE Integration Services topic to see other configurations.
• Refer to the MBSE Integration Services deployment checklist to see next steps.