Customization of maturity reports

Maturity reports can be customized, allowing you to define the custom rules, validation criteria, and display this on the client.

Rule validation

There are many potential rules used for validation.

• The custom rule is defined in a XML rule definition file.

• You can implement and register a custom API that validates the rule.

• You can define validation rules in an XML file using XML tags.

• The validated rule is displayed on the maturity check report view. One of the results is displayed:

  indicates that a rule validation passed.
  

indicates a rule validation failure. indicates a rule validation error.

Rule validation using a custom API

• This option requires writing a custom API, registering the API, and specifying the API in the XML rule definition file.

• Writing custom API

The first step is writing the rule validation API. This is the API that the maturity report feature calls to validate a rule. The only supported programming languages are C/C++. Refer to header file mfg_maturity_rule_interface.hxx on the signature of the API. A sample program using the custom API is specified as follows. Once the custom API is implemented, the program must be built using the Teamcenter documented compiler and linker settings for customization with output as DLL. The generated library must be copied to the Teamcenter server machine at %TC_ROOT%\bin. The variable name in the program must match that available in the user documentation.

• Example: Material report .hxx

Copy//File: Mat_report.hxx //Custom program: Header file   #include <mfg/mfg_maturity_rule_interface.hxx> #include <algorithm> #include <vector> #include <list> #include <map>   using namespace std;   #ifdef __cplusplus extern "C" { #endif   extern__declspec(dllexport) int MaturityReport_ToolRequirementTest(    const int    ruleID,               const tag_t                                        objectScope,             const tag_t                                        targetObject,            const std::map<std::string, std::string>&          ruleAttributes,    std::vector<MFG_maturity_property_data_t>&         values );   #ifdef __cplusplus } #endif

• Example: Material report .cxx

Copy`//File: Mat_report.cxx //Custom program: Source file.

#include "Mat_report.h" #include #include #include #include

using namespace std;

int toolRequirement_defined ( const tag_t targetObject, std::vector& values );

int MaturityReport_ToolRequirementTest( const int ruleID,
const tag_t objectScope,
const tag_t targetObject, const std::map<std::string, std::string>& ruleAttributes, std::vector& values ) { int err = 0; // No error

if(ruleID ==2) //Rule ID defined in XML rule definition file
{
    err = toolRequirement_defined(targetObject,values);
}
else (ruleID == 3 )
{      
// Some implementation 
}
return err;

}`

• Example: Initialization tool requirement

Copyint toolRequirement_defined ( const tag_t targetObject, std::vector<MFG_maturity_property_data_t>&         values ) { MFG_maturity_property_data_t status, display; std::vector<std::string>     statusValues, displayValues; int count = 0; tag_t *_values = 0; AOM_ask_value_tags(targetObject, "Mfg0tool_requirements", &count, &_values);   status.dataType = "string"; status.propertyName = "status"; display.propertyName = "displayValue";   std::string displayValue =  ""; if (count > 0) { char* tool_name = NULL; int stat = AOM_ask_value_string(_values[0], "Mfg0assignment_name", &tool_name);           if (tool_name != NULL ){             displayValue = tool_name;             status.value.push_back("pass");         } else {             displayValue = "Tool name not defined";             status.value.push_back("fail");     }     }     else     {         display.dataType = "string";         status.value.push_back("fail");         displayValue = "TR Not Defined";     }       display.value.push_back(displayValue);     values.push_back(status);     values.push_back(display);       return 0; }

Registering the custom API

• The custom API for the maturity report must be registered to allow the maturity report feature to locate the API. Use the install_callback utility to register the API with the tabulated parameters:

Parameter

Value

type

MATURITY_REPORT

library

Name of library that has the API , without dll extension.

function

Name of custom API.

name

Any unique name. It could be the same as the API name. The name must be used as function identifier value in the maturity rule definition file (section XML schema).

• Sample usage of utility

install_callback -u=Tc-admin-user -p=pasword -g=group -mode=create -type=MATURITY_REPORT -library=Mat_report -function=MaturityReport_ToolRequirementRule -name=MaturityReport_ToolRequirementRuleIdentifier

The value provided in the name must be added to XML rule definition file so that the maturity report feature can identify the API that it is calling.

Rule validation using XML tags

• The maturity rule can also be validated using the XML tags in the rule definition file. This approach allows you to specify a target object on which the rule needs to be validated. The result must be obtained for the target object and the result checked against a defined value to validate the rule. Refer to the following table of XML tags to define and validate the rule.

• XML tag

Description

Valid values

MaturityReport

The root element of the XML document.

MaturityReportContext

The structure context of the maturity report. Rules defined under the context are picked and validated. An XML file may have multiple contexts defined.

Mfg0PlantBOP ProductBOP Lgt0LogisticBOP

Rules

Contains rules.

ruleID

The unique rule ID. It must be a positive integer.

1, 2, 3, 4,….

ruleName

The name of the rule that is displayed on the maturity report.

Any string

targetObjectType

The target object type against which rules are evaluated and displayed on the report. A persistent object type name must be used. Example In a process structure, if a rule needs to be validated on the process line, provide the value as Process. All process lines under the scope of the line selected for report is picked as the target object. The rule is validated on this object.

The exact object type name is considered to ignore the subtype. Multiple values can be provided using |.  The valid format is