Key Concepts
What is a data quality rule?
A data quality rule allows you to validate that any required or recommended data or actions have been completed on your work at the right time and, where necessary, prevent work progression until those rules have been met. Data quality rules allow you to check items such as participants, key dates, data capture and other elements in a highly visual way that provides the users with guidance and links to the right area of the system to update the data.
The rules can be displayed throughout the life of the matter or at the key points in time to ensure that the users are given visual indicators of missing data. Data quality phase guards are used to prevent the user from progressing from one stage to another without completing the required data.
Where Do I See Data Quality Rules?
Data quality rules can be surfaced to the user on your main portal using the data quality widget. This allows users to immediately see and rectify missing pieces of information before progressing the work. In addition, on transition from one phase to the other, the user is prompted to fill out any missing or mandatory data.
How Do I Configure a Data Quality Rule?
There are three steps to creating a data quality rule:
- Create a business rule - this will be used to validate the data and determine whether or not you have missing items.
- Creating the data quality rule - this determines the actions and guidance the system will give the user when a piece of data is missing.
- Adding data quality rules as phase guards - to use a data quality to transition from one phase to another.
Are Data Quality Rules inherited between work types?
Yes, data quality rules can be inherited between work types. If you create a new derived type you will automatically inherit the phase plan from the parent work type. If you wish to also inherit the data quality rules then you can press the copy guards from parents button on the phase plan screen within your work type portal.
Data Quality Rule Details
You can create data quality rules within the modeller area of the system. Go to Modeller > Work Type Modeller and select the work type you wish to work with. In the work type portal, navigate to the data quality rules area on the left-hand navigation bar. To create a new rule, click on the new button at the top of the screen.
Data Quality Rule Settings
| Data | Description |
|---|---|
| Name | A meaningful name for your rule - this will be visible in the user interface. |
| Description | The description for the rule - this will also be seen in the user interface. |
| Active | Inactive rules will not be shown on the data quality widget or trigger phase guards. |
| Validate Rule within Phases | Indicates the phases in which the rule should be evaluated. |
| Matching Rule |
The matching rule will define the data that is checked as part of the rule. For example, this could be that a particular participant role has been filled or that a key date falls within specific boundaries. For more information on matching rules - click here. |
| Call to Action |
This determines the call to action button that will be available on the data quality rule. This can be used to open a blade, assign participants, create or edit work items. Title: The title of the call to action button. Style: the css style of the button. Icon: the font awesome icon used for the button. |
| Validation Level |
Information - will just inform the user there is missing data. Warning - presents the rules in orange to the user as missing information. Mandatory - indicates that the data is mandatory and is often used in partnership with a phase guard. |
| Preview | The preview provides you with a handy preview of what the data quality rule will look like. This is useful for making sure that what you have configured will make sense to the end user and help guide them in the completion of accurate data. |
Available Calls to Action for Data Quality Rules
The following lists commonly used calls to action for data quality rules.
| Data | Description |
|---|---|
| Advanced - Open Blade | This call to action allows you to open a specific blade. You can pass in the system name of the blade to open (find this by inspecting the element in your browser) and pass through the blade payload. |
| Open a URL |
Allows a specific url to be opened in a new window. URL to open: the url you wish to open. Relative to current portal: Allows you to open a specific page in your work type portal e.g. documents. Example: The URL of a work type is made up of the root sharedo portion and then the name of the page e.g. Use the page name and click Relative to current portal to display a page on the current work item. Open in new window: This will open the URL in a new browser window.
|
| Add participant of a particular type |
Allows the user to go straight into adding an ODS entity of a particular type or a particular party type.
|
| Add Participant Role |
Allows the user to add a specific participant role onto the work item. Mode - current work item will add the participant to the current work item, work item hiearchy allows you to find the closes ancestor of a particular type - so for example if you are on a task you could add the participant to a parent matter. Role: Allows you to specify the role that will be added.
|
| Manage Participants | Opens the manage participant blade - use the mode configuration to determine whether you want to open manage participants for the current work item or for a parent (e.g. the parent case). |
| Change Phase | Invokes the phase change blade for a work item. |
| Edit Key Dates | Opens the key dates blade for a work item where the user can add or amend key dates. |
| Edit work item | Opens the key facts blade for the work item and allows the user to edit details. |
| Trigger Execution Engine Plan |
This will allow an execution engine workflow plan to be triggered.
|
| Create work item |
Create a work item of a specific type.
|
| Open or create a child task |
Allows the user to create a task. Tag: Allows a tag to be added to the task. Type: The work type of the task that will be created. Title: The title of the task. Due Date Offset: The amount of time from now to which the due date will be set. Assign to holder of role: indicates to which role the task should be assigned. Set prepare document configuration - allows configuration to be entered around documents e.g document template etc.
|
