Creating Quality Validation Rules

Quality Validation examines if a Template fulfills specific criteria established using Rules.

In Quality Validation, a Rule can be applied to Template attributes, Step attributes and Configurations inside a Template. Different Rules can apply to different Templates based on the Contexts defined.

Creating a Rule for Template Type

Rules of Template Type check if the Template properties meet certain criteria.

To create a Template Rule:

On the main menu, go to Enterprise > Organization > Quality Validation.
The Quality Validation page opens.
Go to Rules.
Click Create Rule.
[Mandatory] Enter Name.
No Duplicate Names are allowed.
[Optional] Add Description.
[Optional] Error message appears when the Rule condition is not met.
Note
[Optional] If you select Prevent Publication when the Rule validation fails the Publish button gets disabled.
By unselecting, you will bypass the failed Rules and Publish the Template.
Select Template from the dropdown list as shown below.
The Condition can either be a single Rule or a set of Rules.
Click ADD RULE to add an individual Rule.
Click ADD GROUP to add a set of Rules.
Click the dropdown to open the list of Rule attributes.
The dropdown list appears.

Select the required Template Rule attributes. Based on your choice different condition operates.

Below are a few Template Rule attributes along with the corresponding conditional operators that are shown.

Template Rule attributes

Description with corresponding options

Where do we find it on Template/Step?

Template Title

Suite

Package

Template Description

If you select any one of the options, select one of the conditional operators.

Choose either Field or Value corresponding to the Template Properties

Template Information Editor > Template Details > Template Title

Template Information Editor >Template Details > Suite & Package

Template Information Editor > Template Details > Template Description

Part Category

If you select Part Category, select one of the conditional operators and one Part Category from the dropdown list.

Template Information Editor > Part Category

Template External ID

if you select Template External ID, you can validate all types of strings.

Template Information Editor > Template Details > External Template ID

Functional Type

If you select Functional Type, you can validate all types of strings.

Template Information Editor > Template Details > Functional Type

Estimated Duration

If you select Estimated Duration, select one of the conditional operators and set the duration of the time.

Template Information Editor > Run Estimate Duration

Step count

If you select Step Count, select one of the conditional operators.

Template Information Editor > Advanced Fields > Template Size.

Has Signoff Flow

If you select Has Signoff Flow, select one of the conditional operators.

Template Information Editor > Signoff Flow

Pin is required for Signoff Flow

If you select Pin is required for Signoff Flow, select one of the conditional operators.

Template Information Editor > Signoff Flow

Signoff Flow Expression

If you select Signoff Flow Expression, select one of the conditional operators.

Template Information Editor > Signoff Flow Expression

Is Role Conditioned

If you select Is Role Conditioned, select one of the conditional Operators from the list.

Template Information Editor > Role Conditioned

Is Component

If you select Is Component, select one of the conditional operators from the list

Template Information Editor > Component

Is Runnable

If you select Is Runnable, select one of the conditional operators.

Template Information Editor > Runnable

Has Parts

If you select Has Parts, select one of the conditional operators.

Template Information Editor > PTC

Has Tools

If you select Has Tools, select one of the conditional operators.

Template Information Editor > PTC

Has Consumables

If you select Has Consumables, select one of the conditional operators.

Template Information Editor > Has Consumables

Has Documentation Reference

If you select Has Documentation Reference, select one of the conditional operators.

Template Information Editor > Documentation Reference

All Mandatory Custom Fields have a value

If you select All Mandatory Custom Fields have a value, select one of the conditional operators.

Template Information Editor > Custom Fields

Custom Sequence in ascending order

If you select Custom Sequence in ascending order, select one of the conditional operators.

Available in Step Information Editor

Master Language

If you select Master Language, select one of the conditional operators as shown below.

Template Information Editor > Template Master Language

Parts- Components - Bill of Material

Parts Number Configurator

Tools

Consumables

If you select PTC, select one of the options from the conditional operators.

Template Information Editor >PTC

Custom Field

If you select Custom Field, select one of the options from the conditional operators.

Template Information Editor > Custom Fields

Click Create.
The Rule is created with the Template Type on a specific Condition. Once the Rule is created, it needs to be added to a Context to Validate the Template.

Delete

To delete a Rule:

Note

The Rule cannot be deleted unless it is unlinked from a Context.

Select a Rule, click Delete as shown below.
A confirmation message is displayed.
Click Delete.
The Rule is deleted.

Note

Until all the mandatory fields are filled for the Rule, there is a notification at the bottom of the screen as shown.

Clicking See Issues displays the issues as shown below.

Creating a Rule for Step Type

Rules of Step Type check if the Step properties meet certain criteria.

To create a Rule for Step Type:

On the main menu, go to Enterprise > Organization > Quality Validation.
The Quality Validation page opens.
Go to Rules.
Click Create Rule.
Enter Name.
[Optional] Add Description.
[Optional] Error Message appears when the Rule condition is not met.
Note
[Optional] If you select Prevent Publication when the Rule validation fails, the Publish button gets disabled.
By unselecting, you will bypass the failed Rules and Publish the Template.
Select Step from the Rule Type dropdown list as shown below.

Select either Union or Intersection from the dropdown list.

The Explanation of Sources in the Step Type is provided below.

Operator	Definition	Example: (Source A=Required Steps, Source B=Step Type Yes/No)
Union	All Steps that meet the conditions for Source A OR Source B.	All steps that are required or Yes/No.
Intersection	All Steps that meet the conditions for Source A AND Source B.	All Steps of Step type Yes/No that are marked Required.

Click Add Source.
Source: A Source defines to compare the Step Rule attributes with some properties of Steps.
Click the dropdown to open the list of options.
Type: Type is to identify Step(s) by one of its attributes/properties on which the Conditions can be applied selectively.

Select any one of the options from the list.

The Explanation of Step Types are provided below.

Step Type	Description	Where do we find it on Template/Step?
Step with Id	This Source type refers to a Step with the specified Step Id.	Step Information Editor > Step Number
Children of Step with Id	This Source Type refers to a Step, with Sub Steps. This Source would apply the Rule for all the Sub Steps under Step Id.	Step Information Editor > Step Number
Steps with Tag	This Source type refers to Steps with the Tags.	Step Information Editor > Step actions > Tags.
Steps of Type(s)	This Source type refers to a list of Steps of Type(s) in the dropdown.	Step Information Editor > Step Type.
Required Steps	This Source Type refers to the Required Steps.	Step Information Editor > Step Detail > Step Options > Required.
Steps at level	This Source Type refers to the Steps with different Levels. Parent steps or Container Steps (Form, Task, Table, etc.,) are Level 1 and Sub-Steps under them are 1.1	Step Information Editor > Steps at Level

The Condition can either be a single Rule or set of Rules.

Click ADD RULE to add an individual Rule.

Click ADD GROUP to add a set of Rules.

Click the dropdown to open the list of Rule attributes.

The dropdown list displays the list of Step Rule attributes as shown.

Below are a few Step Rule attributes along with the corresponding conditional operators that are shown.

Step Properties

Description

Conditional Operators

Where do we find it on step Information Editor?

Step Title

This condition compares the Title of the Step to the provided Value/Field.

You can choose any one of the Conditional Operator from the list

Step Information Editor > Step with Title

Step Label

This condition compares the Label of the Step to the provided Value/Field.

You can choose any one of the conditional operators from the list

Step Information Editor > Step Labe

Custom Sequence

This Condition compares the Custom Sequence to the provided Value/Field

You can choose any one of the conditional operators from the list

Step Information Editor > Step action > Generate Custom Sequence

Estimated Duration

This Condition compares the Duration provided by the Conditional Operator.

You can choose any one of the Conditional Operator from the list

Step Information Editor > Estimated Duration

Functional Type

This Condition validates all types of strings.

You can choose any one of the conditional operators from the list

Step Information Editor > Step Detail > Functional Type

Is Required

This Condition checks if the Step is marked Required or not.

You can choose any one of the conditional operators from the list

Step Information Editor > Required

Is Editable

This Condition checks if the Step is Editable or not by the Conditional Operators.

You can choose any one of the conditional operators from the list

Look for Read only

Is Blocking

This Condition checks if the Step is Blocking or not.

You can choose any one of the conditional operators from the list

Step Information Editor > Is Blocking

Has SignOff Flow

This Condition checks if the Step Has SignOff Flow or not.

You can choose any one of the conditional operators from the list

Step Information Editor > SignOff Flow

Pin is required for Signoff Flow

This Condition checks if Pin is required for Signoff Flow or not.

Choose any of the conditional operators from the list.

Step Information Editor > Signoff Flow

Signoff Flow Expression

This Condition checks if the Step has Signoff Flow Expression or not.

Choose any one of the conditional operators from the list.

Step Information Editor > Signoff Flow

Pin is required

This Condition checks if the Step is required Pin or not

Choose any one of the conditional operators from the list.

Step Information Editor > Signoff Flow

Step is required

This Condition checks if the Step is required or not.

Choose any of the conditional operators from the list.

Step Information Editor > Is required

Is Role Conditioned

This Condition checks if the Step is Role Conditioned or not.

You can choose any one of the conditional operators from the list

Step Information Editor > Role Conditioned

Has Parts

This Condition checks if the Step Has Parts or not.

You can choose any one of the conditional operators from the list

Step Information Editor > PTC > Parts

Has Tools

This Condition checks if the Step Has Tools or not.

You can choose any one of the Conditional Operator from the list

Step Information Editor > PTC > Tools

Has Consumables

This Condition checks if the Step Has Consumables or not.

You can choose any one of the Conditional Operator from the list

Step Information Editor > PTC > Consumables

Has Documentation Reference

This condition checks if the Step has a Documentation Reference associated with it or not

You can choose any one of the options from the list

Step Information Editor > Documentation Reference

Sub-Steps Count

This condition checks if the Step has Sub-Steps count or not.

You can choose any one of the options from the list

Decimal Precision

This condition checks the Decimal Precision of a Numeric Step

You can choose any one of the options from the list

Step Information Editor > Step Detail

Step Title Linked to the Doc Key

This Condition checks whether the Step Title is linked to Doc Key.

You can choose any one of the options from the list

Step Information Editor > Documentation Reference > Add Documentation Key

All Mandatory Custom Fields have a Value

This Condition checks if the Step has All Mandatory Custom Fields with a Value or not.

You can choose any one of the options from the list

Step Information Editor > Custom Fields

Parts-Components-Bill of Materials

Consumables

This condition checks if the Step has PTC or not.

You can choose any one of the options from the list

Step Information Editor > PTC

Custom Fields.

This condition checks the values of the Custom Fields.

You can choose one of the conditional operators from the list.

Step Information Editor > Custom Fields

Click Create.
The Rule is created with the Step Type on the specific condition.

Delete

To delete a Rule:

Note

The Rule cannot be deleted unless it is unlinked from a Context.

Select a Rule, click Delete as shown below.
A confirmation message is displayed.
Click Delete.
The Rule is deleted.

Note

Until all the mandatory fields are filled for the Rule, there is a notification at the bottom of the screen as shown.

Clicking See Issues displays the issues as shown below.

Creating a Rule for Configuration Type

Quality Validation Rules can be created to check the Configurations associated with a Template.

Rules of Configuration Type check if the Configuration properties meet certain criteria.

To create a Rule for Configuration:

On the main menu, go to Enterprise > Organization > Quality Validation.
The Quality Validation page opens.
Click Create Rule.
Enter Name.
[Optional] Add Description.
[Optional] Error Message appears when Rule condition is not met.
Note
[Optional] If you select Prevent Publication, the Rule validation fails and the Publish button gets disabled.
By unselecting, you will bypass the failed Rules and Publish the Template.
Select Configuration from the dropdown list.
The Condition can either be a single Rule or a set of Rules.
Click Add rule to add an individual Rule.
Click Add group to add a set of Rules.
The Condition builder appears.