Rs Validating Product Data NX Checkmate
Rs Validating Product Data NX Checkmate
Teamcenter
Rapid Start 12.2
Validating Product
Data with NX
Check-Mate
RS037 • 12.2
Contents
Configure Validation The Validation Manager administrator or the system administrator must
Manager configure one or more validation agents and validation checkers. The
Validation Manager administrator or the system administrator may also need
to modify the preferences settings for Validation Manager.
Start Validation
Manager Click Validation Manager in the navigation pane.
Note
You must have Validation Manager administrator or system administrator privileges to
create new agent or checker objects.
Note
If your administrator has defined mandatory properties for the type
of relation by which the pasted object reference (secondary object)
is associated to the primary object, a dialog box lets you define
attribute values for the objects.
• Deleting objects
When objects are deleted, the system loads the objects and
then deletes them. The only point in this process at which
the Soft Abort button can be used to stop the process is
between when the object is loaded and when it is deleted,
or if deleting multiple objects, the process can be stopped
between when the previous object has been deleted and the
next object is loaded.
• Running searches
When a query is run, the system executes the query and then
loads the objects. The only point at which the operation can
be stopped is after the query has run but before the objects
are loaded.
Removes a selected data object reference and places it on the
Cut
clipboard. You must have read privileges on the object and write
privileges on its container (object folder, item revision) to cut an
object reference.
Button Description
Duplicates an object reference. You must have read privileges for
Copy the object that you want to copy.
Tip
You can create a copy of an object reference in a
different application by dragging the object from My
Teamcenter to the other application.
Agent Displays the New Agent dialog box in which you choose an agent
type and specify the required properties for it. The properties
shown in this dialog box are defined by Business Modeler IDE
and vary depending on the agent type you choose.
Checker Displays the New Checker dialog box in which you choose a
checker type and specify the required properties for it. The
properties shown in this dialog box are defined by Business
Modeler IDE and vary depending on the checker type you choose.
Transfers ownership of the selected agent or checker to the
Take Ownership
currently logged-on Validation Manager administrator.
Command Description
Run Validations Displays the Run Validation dialog box listing available validation agents and
checkers and selected validation agents and checkers.
Command Description
View Results Displays Validation Results Viewer in the Validation Manager perspective
to show the validation results of the selected targets. Results are rendered
with these icons: Show Not-Run, Show Out-of-Date, Show Up-to-Date,
Show Passed, Show Failed, Show Passed Evaluation, and Show Failed
evaluation.
• A validation checker may provide the information on a specific validation functionality that
a validation application performs.
A validation checker is created in Teamcenter under its associated validation agent.
Teamcenter already provides agent and checker classes to integrate with these validation
applications:
• NX Check-Mate
• BOM Grading
NX Check-Mate and NX RDDV agents are created when the database is initially populated. You can
create checkers for these validation applications and agents and checkers for others in Validation
Manager.
To create a custom validation agent to integrate with a custom validation application, you must run the
Business Modeler IDE application to create new business objects that are used to instantiate the
custom validation agent and validation data objects. You can then create agents and checkers for
the custom application in Validation Manager.
Validation Manager lets you specify validation rules to verify the selected targets. Validation rules are
defined in a validation rule XML file. The validation rule XML file is stored in a ValidationRuleSet
dataset. The ValidationRuleSet dataset is then used to examine validation results on a target to
decide whether a target conforms to standards and can be released or baselined.
Validation results contain information on a validation target object. Validation Manager lets you view
and manage the validation results. Validation results then can be used as the basis for deciding
whether a target conforms to standards and can be released. Validation Manager stores the results of
the validation process in a viewable form associated with the selected item revision.
• A Validation Manager administrator can also modify or delete validation agents and validation
checkers.
The Override Approver role is a role under the Validation Administration group that can approve
or reject override requests. The Override Approver can approve or reject the override request using
the Validation Results Viewer view or a Workflow process.
Note
It is a Teamcenter administrative task to create new users with the Validation
Administration group and roles or add existing users into Validation Administration
group and roles before using Validation Manager.
There are various Teamcenter administrative tasks related to the Validation Manager or validation
objects:
• Create new users with, or add existing users to, Validation Administration groups and roles.
• Define closure rules for traversal scope of a validation checker for NX Check-Mate.
• Configure the workflow to approve the override request of validation results using these templates
and handlers:
o ResultOverrideApproval
o VAL-approve-result-overrides
o VAL-reject-result-overrides
o VAL-set-condition-result-overrides
• Configure the workflow and baseline operation to evaluate validation results based on validation
rules using these handlers:
o VAL-check-validation-result
o VAL-check-validation-result-with-rules
o VAL-set-condition-by-check-validation-result
• Configure the PLM XML transfer mode for import/export validation results.
• Configure the Business Modeler IDE handler to copy validation results when the target object
is copied.
Users can perform the following typical tasks related to Validation Manager or validation objects.
• Run validations
After a Validation Manager administrator defines some validation agents and validation checkers,
any user can select some objects, and choose Teamcenter Tools→Validation→Run Validation,
and then select some validation checkers under an agent to run validation against the selected
objects. After the validation process completes, the corresponding validation results are
generated by the agent.
• View results
You can view the validation results associated with selected objects in the Validation Results
Summary view or you can view the results with or without rule evaluation in the Validation
Results Viewer view.
• Override results
You can request to override a certain validation result status from fail to pass or vice versa by
creating an override request and selecting an Override Approver to review the request using
the Validation Results Viewer. You can also start a workflow process to assign the Override
Approver to review the request
Run validations
Users can view the generated validation results associated with the target, view the detailed report
file stored in the results or delete the selected results. Validation results can also be used as the basis
to determine whether a target conforms to standards and can be released.
The Tools→Validation→Run Validations menu command lets you specify validation checkers
under an agent to verify the selected targets by performing the validation process defined by the
agent. The validation process can store the results of the validation process as validation results
associated with the selected targets.
Note
Validation Manager requires special setup and configuration with third-party validation tools
and Teamcenter workflow processes. This feature may not be available at your site. For
more information, see your local administrator.
1. Select one or more folders, items, item revisions, reuse design element, or shape design
elements in the My Teamcenter or Structure Manager tree.
3. Choose a validation agent from the Available Validation Agents shortcut menu.
Note
If the user defined the agent class names with the
TC_VALIDATION_run_validation_hidden_agents preference, the corresponding
agent revisions are hidden from the list.
4. Select one or more validation checkers in the left pane of the Run Validations dialog box.
• If a validation checker item revision is mandatory, it is marked with a red star at the end. If
the TC_VALIDATION_mandatory_checkers_required preference is set to True, after you
select an agent revision, all the mandatory validation checkers under it are automatically
added into the Selected Validation Checkers tree, and they cannot be removed from it
unless you select another agent revision.
• If you select the top agent revision node from the Available Validation Checkers tree and
click the button, all validation checkers are added into the Selected Validation Checkers
tree.
• If you deselect the top agent revision node from the Selected Validation Checkers tree,
all the validation checkers nodes under the agent revision are removed from the Selected
Validation Checkers tree. However, all mandatory checkers are not removed when the
TC_VALIDATION_mandatory_checkers_required preference is set to True.
Note
Use the add and remove buttons ( and ) to add or remove checkers. Or
double-click the selected checker in the left or right pane to add or remove checkers.
5. Review the Selected Objects pane at the bottom of the window to confirm the objects on which
the validation is run.
6. Click OK.
The system displays a status message to indicate the validation process has started.
Note
If Validation Manager applications are not configured, a message dialog box appears,
and you are instructed to contact your Teamcenter administrator.
If you have write access to the selected item revision, the system attaches a validation result summary
to the item revision. This summary lists the result of each specific validation, either Pass or Fail.
Note
If you want to run validation under single sign-on mode, you must first install Security
Services and configure it on the rich client and the server.
• Configure the TC_BIN\ug_check_part.bat/pl file according to the comments inside
the file before running validation from the client side or the server side.
• After NX 7.5
If you want to run validation from the client side, no more configuration is required. Use
the standard ug_check_part.bat/pl file under the TC_BIN directory.
If you want to run validation from the server side, there are two ways to configure it
before running validation:
o Set the following environment variables before starting the TCServer instance.
For example, you can add them in TC_DATA\tc_profilevars.bat file.
set TC_SSO_LOGIN_URL=SSO-login-url
set TC_SSO_APP_ID=SSO-application-ID
1. In My Teamcenter, expand the item revision, and open the Validation Results Summary object
to view all the results for the item revision.
3. Click Open.
The log content appears automatically unless there are multiple files under the validation result
log dataset. If so, the system displays the Validation Reports dialog box.
Note
Some validations may not return report files. Also, a report file must
correspond by its file extension to one of the accepted file types defined by the
TC_VALIDATION_FILE_TYPES preference.
4. If there are multiple files under the validation result, select the report file from the list and click
Open.
Note
Validation requirement results are similar to the validation results created by the NX
Check-Mate agent, but they are created by the NX RDDV agent, and they contain
extra information about the requirements used for checking.
o It contains two tabs to show validation results with or without validation rule file-based
evaluation.
o The viewer pane contains result filters, a result table, and a collapsible information area.
o You can add or remove columns from the result table at run time.
o When opened, the detail information area displays detailed information regarding attributes
from the selected results in the results table.
When you select a target object from My Teamcenter, you can use four methods to open the
Validation Results Viewer view:
• In any application, right-click an object and choose Send To→Validation Manager.
The Validation Results Viewer view is displayed for the selected object in Validation Manager.
• Click the HOME toolbar button in Validation Manager and select an object.
The associated validation results are displayed in the Validation Results Viewer view.
Note
The system does not traverse child BOM lines when you view validation results from the
Structure Manager window. Only selected BOM lines are listed in the navigator tree in
the Validation Results Viewer view. To view validation results from the entire Structure
Manager tree or subtree, expand the tree in Structure Manager and select all expanded
BOM lines.
Selected Workspace Object tree Controls the display in the Validation Results Viewer view.
The tree is a Teamcenter component view similar to My
Teamcenter.
List boxes Provide filter function according to agent name, checker name
and target type of results.
Buttons Enable filter function according to not-run, up-to-date,
out-of-date, pass, and fail status of results.
Results data table Provides specific information about the validation results.
By default, the Validation Results Viewer view and Selected Workspace Object view are not
shown in Validation Manager perspective. Only when you use these methods to start the Validation
Results Viewer view to see results can the two views be displayed.
When you select a workspace object or multiple objects from My Teamcenter, and choose Send
To→Validation Manager, it not only opens the Selected Workspace Object view, but also opens
the Validation Results Viewer view. If you select multiple objects and send them to the Validation
Result Viewer view, multiple Selected Workspace Object views are opened just like you send
multiple objects to My Teamcenter. The selected folders, items, and revisions are displayed in the
Selected Workspace Object view similar to My Teamcenter.
Summary view options include:
Option Description
Agent Displays the validation agent. Results generated from the selected validation
agent are listed in the results table.
Checker Displays validation checker names. Results generated from selected validation
checker (for example, an NX Check-Mate checker) are listed in the results
table.
Target Type Lists the validation target dataset types. Results with selected validation target
dataset type are listed in the results table.
Button Description
Show Sets the display of out-of-date results. Display is enabled by default.
Out-of-Date
Show Up-to-Date Sets the display of up-to-date results. Display is enabled by default.
Show Not-Run Lists all targets that are not validated against selected validation checkers.
Show Passed Sets the display of items that pass validation.
Show Failed Sets the display of items that fail validation.
Data Description
Validation Target Lists the datasets associated with the item revision for which the validations
were performed.
Validation Name Displays the checkers that are run.
Validation Agent Lists the validation agent. A check that belongs to this validation agent is
performed against the target object, for example, the NX Check-Mate agent.
Override Indicates the override status of the validation result: Pending, Approved,
Request State or Rejected.
Validation Date Lists the date and time each validation was performed.
Data Description
Up-to-date Specifies whether validation was run on the current target object.
Validation Result Indicates a Pass or Fail result for each validation performed. If the current
result is overridden from fail to pass, it shows pass, and vice versa.
Validation User Displays the validation user ID string.
Note
You can customize the Summary view by modifying the validation result summary
rendering style sheet. For example, a link to a requirement object can be added and
displayed for a selected RDDV result. Click the link and the requirement objects appear in
a window.
Note
The results table is implemented based on the standard Teamcenter table tree. You can
add or remove columns, sort tables per column, and so on.
Validation Status Displays results status from the validation rule file evaluation.
This status may be different from the status that originally
returned from the Validation Manager application. A result with
up-to-date status or failed status from the Validation Manager
application may pass a validation rule file evaluation if the
check is defined as nonmandatory in the validation rule file.
Evaluate button Unavailable by default, this button is available when the
Workspace objects from the left navigator tree and validation
rule file are selected. Click this button to evaluate validation
results.
Note
• Include the validation rule item revisions in the
TC_VALIDATION_RULE_SET_ITEM_REVISIONS preference to list them in
the Rule Set menu.
• Validation rule file should be defined in validation rule XML format and saved as the
ValidationRuleSet dataset. Attach the ValidationRuleSet dataset to an item revision
with the TC_Validation relation. There should be one ValidationRuleSet dataset
under one item revision.
• When there is no validation rule file available or you do not want to select any validation
rule file, view validation results from the Summary view.
Status Description
Evaluation The validation results pass the rule evaluation.
passes
Result out of The part Last-Modified Date is later than the date that the validation was
date due to part performed, and the result was saved into Teamcenter.
changed
Result failed The validation result status fails for a mandatory check.
Parameter The validation passes and is up-to-date, but the parameter verification fails.
verification failed Parameters listed in the validation rule are verified by first comparing the name
and value pairs with the validation_parameters attribute of validation result
object and then the log file if the first step returned a fail decision.
Result not found The validation result is not found. The validation is not performed or the result
is not saved into Teamcenter.
Missing result The validation result log dataset or file is missing. This failure is checked only
log file when a validation rule contains a parameter condition.
• VO - Validation Result
Displays all validation results from the specified search criteria.
Note
The Teamcenter administrator must use the Organization application to add members to
the validation administration group and the override approver role.
Note
If users select a child checker result inside a NX Check-Mate profile, they can create, view,
edit, or delete override requests for the child result.
1. Right-click the validation result from the Validation Results Viewer view and choose
Override→Create.
The system displays the Create Override dialog box.
• Permanent
The approved override request always applies to the validation result until the original
request user deletes the override request.
• Temporary
The approved override request applies only to the validation result until the test reruns
and validation result updates. The system automatically removes the approved override
request and updates the validation result after the test reruns.
e. Type a reason for the override request in the Detailed Reason box.
Note
In the Create Override dialog box, the Category, Brief Reason, and Detailed
Reason inputs are optional unless Override Reason Is Mandatory is selected in
the New Agent dialog box when the administrator creates an agent object.
f. (Optional) Select a proposed decision user from the Override Decision User list in the
Create Override dialog box and Edit Override dialog box. The Override Decision User list
shows all the users under the Override Approver role in the Validation Administration
group. This box is optional so you can leave it blank. If you select a user from the Override
Decision User list or change to a different decision user, notification mails are sent to the
current selected decision user and/or the previous selected decision user.
Note
If the company’s best practice is to approve or reject an override request from the
Validation Manager application, specify a user from the Override Decision User
list when creating a request, so the suggested approver is notified to review the
request. On the other hand, if the company’s best practice is to approve or reject
an override request in a workflow process, leave the Override Decision User box
blank, because the workflow already has a separate notification mechanism.
3. Click OK.
3. Check the Override Request State column for the override status of the validation result.
• Pending
The override is awaiting review.
• Approved
The reviewers accept the override. The Result column shows the override result.
• Rejected
One or more of the reviewers deny the request. The Result column shows the original
validation result.
4. View the detail status and provide comments in the Detail Information box.
Note
For override requests with Approved or Rejected status, when you edit the override
request, the system resets the request to Pending status.
Note
Only the user who made the original request can edit an override request.
3. Click Yes.
Note
Only the original request user can delete an override request.
5. Click OK.
The updated Validation Results Viewer view appears.
• When the override request is approved, the Override Request State column indicates the
Approved status, and the Result column displays the overridden result.
• When the override request is rejected, the Override Request State column indicates the
Rejected status, and the Result column displays the original status.
The signoff team members can now perform the override approval task.
1. Choose New→Process.
Note
Signoff team members must belong to the validation administration group and the
override approver role.
After the select-signoff-team task is complete, the process continues in the workflow and members of
the signoff team receive the signoff task.
2. Choose Actions→Perform.
The system displays the Signoff Decision dialog box.
5. Click OK.
Note
By default, validation override notifications are sent through operating
system mail. To send notifications through Teamcenter mail, set the
TC_VALIDATION_send_envelope_for_override preference to TRUE.
• An email notifying the approver of an override request includes these messages to either approve
or reject the request:
Send the attachment to the Validation Results Viewer
Right click on this result.
Choose Override→Review
• An email notifying the old approver and the new approver that their assignments have changed
includes this message:
You are no longer the approver of this override request.
• An email notifying the requester that the override request has been approved includes this
message:
Your override request is approved by [Approver].
• An email notifying the requester that the override request has been rejected includes this
message:
Your override request is rejected by [Approver].
• An email notifying the approver and the requester that the override request has been deleted
includes this message:
The override request is deleted.
See comment on the Result Detail panel.
• An email notifying the approver that the override request has been updated includes this message:
The override request is updated by [Requester].
• VAL-check-validation-result-with-rules
• VAL-set-condition-by-check-validation-result
Note
These three handlers and the extension are applicable to the validation results generated
by the NX Check-Mate and NX RDDV validation agents.
The ResultOverrideApproval workflow template can be used to approve or reject the override
requests on the validation results associated with the workflow targets.
This template can be used independently or within any customer’s workflow templates for privileged
users to approve all override requests associated with the workflow targets.
In the ResultOverrideApproval workflow template, the overridecondition task has a Start action
handler (VAL-set-condition-result-overrides) that sets the condition to EPM_RESULT_True if there
are pending result override requests for the workflow targets. If there are any pending result override
requests, the workflow continues to OverrideReviewTask for privileged users to signoff; otherwise,
the workflow continues to OverrideOrTask, then completes.
The OverrideReviewTask has Validation Administration/Override Approver/1 as
the default signoff profile. Two action handlers (VAL-approve-result-overrides and
VAL-reject-result-overrides) are used to set the approval state of the associated overrides whose
current state is not approved. When triggered, the VAL-approve-result-overrides action handler
sets all requested overrides to an approved state, while the VAL-reject-result-overrides action
handler sets all requested overrides to a rejected state.
Headquarters
Europe
Granite Park One
Stephenson House
5800 Granite Parkway
Sir William Siemens Square
Suite 600
Frimley, Camberley
Plano, TX 75024
Surrey, GU16 8QD
USA
+44 (0) 1276 413200
+1 972 987 3000
Asia-Pacific
Americas
Suites 4301-4302, 43/F
Granite Park One
AIA Kowloon Tower, Landmark East
5800 Granite Parkway
100 How Ming Street
Suite 600
Kwun Tong, Kowloon
Plano, TX 75024
Hong Kong
USA
+852 2230 3308
+1 314 264 8499