Using Data Rules in

Application Studio
Hands On Exercises
Disclaimer
This document is for informational purposes only and is subject to change without notice. This document and
its contents, including the viewpoints, dates and functional content expressed herein are believed to be
accurate as of its date of publication. However, Epicor Software Corporation makes no guarantee,
representations or warranties with regard to the enclosed information and specifically disclaims any
applicable implied warranties, such as fitness for a particular purpose, merchantability, satisfactory quality or
reasonable skill and care. As each user of Epicor software is likely to be unique in their requirements in the use
of such software and their business processes, users of this document are always advised to discuss the
content of this document with their Epicor account manager. All information contained herein is subject to
change without notice and changes to this document since printing and other important information about the
software product are made or published in release notes, and you are urged to obtain the current release
notes for the software product. We welcome user comments and reserve the right to revise this publication
and/or make improvements or changes to the products or programs described in this publication at any time,
without notice.

The usage of any Epicor software shall be pursuant to an Epicor end user license agreement and the
performance of any consulting services by Epicor personnel shall be pursuant to Epicor's standard services
terms and conditions. Usage of the solution(s) described in this document with other Epicor software or third
party products may require the purchase of licenses for such other products. Where any software is expressed
to be compliant with local laws or requirements in this document, such compliance is not a warranty and is
based solely on Epicor's current understanding of such laws and requirements. All laws and requirements are
subject to varying interpretations as well as to change and accordingly Epicor cannot guarantee that the
software will be compliant and up to date with such changes. All statements of platform and product
compatibility in this document shall be considered individually in relation to the products referred to in the
relevant statement, i.e., where any Epicor software is stated to be compatible with one product and also
stated to be compatible with another product, it should not be interpreted that such Epicor software is
compatible with both of the products running at the same time on the same platform or environment.
Additionally platform or product compatibility may require the application of Epicor or third-party updates,
patches and/or service packs and Epicor has no responsibility for compatibility issues which may be caused by
updates, patches and/or service packs released by third parties after the date of publication of this document.

Epicor ® is a registered trademark and/or trademark of Epicor Software Corporation in the United States,
certain other countries and/or the EU. All other trademarks mentioned are the property of their respective
owners.

Copyright © 2021 Epicor Software Corporation Epicor.

All rights reserved. No part of this publication may be reproduced in any form without the prior written consent
of Epicor Software Corporation.
 Using Data Rules in Application Studio

Table of Contents

Using Data Rules in Application Studio 4

Introduction 4
Learning Objectives 4
Prerequisites 4
Tips and Tricks 4
Environment Setup 5
Accessing Kinetic 5
Logging in 6
Refreshing the database 6
Exercise 1: Setting Field Value 7
Identifying Terms Code field 7
Creating a rule 7
Testing field value rule 9
Exercise 2: Applying Data Rule on a Landing Page 10
Identifying Total Order Amount field 10
Modifying landing page grid 11
Creating a rule 11
Testing landing page rule 12
Exercise 3: Comparing Fields 13
Identifying Ship By fields 13
Creating a rule 14
Test row rule 14
Exercise 4: Disabling Form Control 16
Identifying Purchase Order field 16
Identifying Close Order control 16
Creating a rule 17
Testing the rule 18
Exercise 5: Validating Input Data 20
Identifying Discount field 20
Creating a rule 20
Creating an event 21
Optional - creating a BPM directive 23
Testing the results 24
Summary 26

3 December, 2021
 Using Data Rules in Application Studio

Using Data Rules in Application Studio

Introduction
Data Rules are simple, yet powerful tools to create data-driven behaviors such as changing a color,
disabling a field, or setting its default value.

Each application comes with a set of system rules that control standard functionality, to, for example,
conditionally hide certain fields during data entry. You can copy these rules, but cannot edit or delete
them. To leverage the functionality, you can create custom data rules on top of system rules.

Each rule can have various data conditions and one or more actions that activate when the condition
is met. Also, you can set up a rule to have no condition, but still perform a required action.

This course contains a series of hands-on exercises that will help you use Data Rules in customizations
to best align Kinetic applications to your company's business processes.

Learning Objectives
After completing this course, you will be able to:

l Use field help to identify required field properties

l Populate field values using Data Rules
l Highlight controls and grid rows to notify users
l Conditionally disable application controls
l Validate data input using Data Rules and Events

Remember! What you see, you remember, but what you do, you understand.

Prerequisites
l Product version 2021.2.
l Make sure you have Customize Privileges enabled for your user account.

Tips and Tricks

If you are a new user or you have been using Kinetic (Epicor ERP) for years, you might benefit from
using the following tips and tricks as you go through the course:

4 December, 2021
 Using Data Rules in Application Studio

l Whether you are interested in a particular field, check box, or program, use the Application Help
that you launch from within Kinetic.
l Work with fully expanded programs. This enhances visual experience and prevents incorrect
selections.
l Properly read the workshop descriptions so you know what follows.
l Take your time and do not rush.

Environment Setup

Accessing Kinetic
While you can use a web (browser) or smart (desktop) client to access Kinetic interchangeably, some
system management programs are only available in Classic UI. The course instructions will guide you to
launch the desktop client whenever you need to use such program.

In all other cases for the best user experience, we recommend using a Kinetic browser client. Choose
any of the two options below to open Kinetic in a browser:

l In the smart (desktop) client from the Home Page, go to the User menu and select the Open
Kinetic in Browser option.

The system automatically launches the Home Page in your web browser. Note that you may be
required to re-enter your user password to log in.

l In the web browser, directly enter the URL of your Home Page using the following format:

https://[ServerName]/[KineticInstance]/apps/erp/home/ - for example, https://sfo-

euvm.local/Kinetic2021_2/apps/erp/home/.

On the Kinetic login page that displays, enter your credentials.

Supported browsers
Make sure you use the latest version of any browser from the list below:

5 December, 2021
 Using Data Rules in Application Studio

l Microsoft Edge®

l Mozilla Firefox®

l Apple Safari ® (for Mac OS ®)

l Google™ Chrome

Logging in
l Log in to the training environment using the epicor/epicor credentials.

l Make sure you are logged into the Epicor Education Company/Main Plant.

l If you are a cloud-based Kinetic customer, then note the following about your Epicor-hosted
education company. All logins referenced in the course (such as manager, or epicor) should be
prefixed with the <site ID>-. For example, if your site ID is 98315, then wherever you are
instructed to use the login epicor, instead use 98315-epicor. The password is 'Train18!'.

Refreshing the database

l We recommend refreshing the database before starting the course.

6 December, 2021
 Using Data Rules in Application Studio

Exercise 1: Setting Field Value

Let's start our journey by demonstrating how you can populate a field with a specific value.

Assume that for customer Barriston, you want a global alert to be sent for each shipped order. A global
alert is an automatic message that is released to selected recipients when a change occurs in the
database. To accomplish this task, you want to enable the Alert On Shipment check box for this
customer by default.

Identifying Terms Code field

We first need to identify the fields for which we want to create the rules.

1. Use the Browse field on the Menu to open Order Entry .

We will be using Sales Order Entry application across the course.

2. Select any existing order.

3. Press Full Screen to expand the Order Detail card.

4. Select Help to invoke the Help and support center and enable Display Field Level Help.
5. On the Order Detail page, locate the following fields, press the little help icon to invoke Field
Help panel and take note of their EpBinding values:
l Customer (Sold To) - Orderhed.CustomerCustID.
l Alert On Shipment - OrderHed.SndAlrtShp.
6. Collapse the Help and support panel.

7. Select the Overflow menu , scroll down and select Application Studio.

Creating a rule
1. From the Sidebar, select Data Rules > Add New.
2. In the Header section, enter or select the following:
Field Value

Name EnableShipAlert

7 December, 2021
 Using Data Rules in Application Studio

Field Value

Description Ship Alert defaults for Barriston

Action Data View OrderHed

Row Rule Criteria Condition

3. Press Select Condition > Condition and specify the following:

Field Value

DataView OrderHed

Field CustomerCustID

Operator Equal

Value/Field Value

Value Barriston

4. Press Select Condition > Condition to create another condition to apply this rule when a new
order is created. Accept the default AND operator between conditions.

Tables contain a column called RowMod at the bottom of the record. This
property defines if a record has been Added, Updated, Changed, or Deleted.

Field Value

DataView OrderHed

Field RowMod

Operator Equal

Value/Field Value

Value A

5. Now create an Action. Press Select Action > Set Value and specify the below parameters:
Field Value

Actions SetColumnValue

Field SndAlrtShp

8 December, 2021
 Using Data Rules in Application Studio

Field Value

Value/Field Value

Value True

6. Press Save All and specify the below:

l Layer Name - XXX-SalesOrder (where XXX are your initials).
l Description - Sales Order customization.
7. Press Save Layer.

Testing field value rule

1. Press Preview.

2. Select New Order.

The Order Detail card displays.

3. For Customer, type Barriston and press Tab.

4. Click Full Screen to expand the Order Detail card. Verify the Alert On
Shipment field is enabled by default.
Now we will verify the rule is only applied to customer Barriston.

5. From the Overflow menu , select Clear.

6. To the Clear Confirmation message, respond Yes.

7. Press New Order again.

8. This time, for Customer, enter Addison and press Tab.

9. Click Full Screen and verify the Alert On Shipment field is clear.
10. Remain in Sales Order Entry.

9 December, 2021
 Using Data Rules in Application Studio

Exercise 2: Applying Data Rule on a Landing Page

In some cases, it is desired to have specific data highlighted or color coded to make it stand out on a
grid. Data Rules are a great way to highlight controls or grid rows to notify users.

In this scenario, we will modify the Sales Order Landing Page to include the Total Order Amount
column. We will then create a rule to highlight large orders so users pay special attention them.

Identifying Total Order Amount field

1. Close the Preview and return to Application Studio.
2. In Application Map, select the Details page and press Edit.

3. With the Order Detail card in focus, locate the Order Total field at the bottom of the Summary
column
4. Press the Help icon to open Field Level Help.
5. Take note of FieldName (DocOrderAmt) and EpBinding (OrderHed.DocOrderAmt).
6. Collapse the Field Help panel.

10 December, 2021
 Using Data Rules in Application Studio

Modifying landing page grid

1. In Application Map, select the Sales Orders Landing Page at the very top and press Edit.

2. Click inside the grid and select Properties.

3. Expand Data > Grid Model > Columns. This is where Landing Page grid columns are defined. You
can review the list of columns using the drop-down control.

4. Press Add Column.

5. Enter the below properties:
l Field - DocOrderAmt
l Title - Order Amount

6. Press Save All.

7. Preview your changes and verify the new column displays in the grid.

8. Close the Preview.

Creating a rule
1. From the Sidebar, select Data Rules > Add New.
2. In the Header section, enter or select the following:
Field Value

Name LandingPage

Description Highlight Large Orders

Action Data View LandingPage

11 December, 2021
 Using Data Rules in Application Studio

Field Value

Row Rule Criteria Conditions

3. Press Select Condition > Condition and specify the following:

Field Value

DataView LandingPage

Field DocOrderAmt

Operator GreaterThanEqual

Value/Field Value

Data View 10000

4. Now create an Action. Press Select Action > Setting Style and specify the below parameters:
Field Value

Actions SettingStyle.RowStatus

Status Highlight

5. Press Save All.

Testing landing page rule

1. Select Preview.
2. Scroll through the orders on the Landing Page grid.
3. Verify orders with total amount exceeding $10.000 are highlighted.

4. Close the Preview.

12 December, 2021
 Using Data Rules in Application Studio

Exercise 3: Comparing Fields

In this scenario, we would like to alert users when the Ship By Date on the Line doesn't match the date
on Order Header. We will compare both fields and highlight lines where difference occurs.

Identifying Ship By fields

1. In Application Studio, select the Details tab (page).
2. Locate the Ship By field found in the Dates column, press the Help icon and take note of
EpBinding (OrderHed.RequestDate).
3. Collapse the Field Help panel.
4. Select the Application Map tab and open the Lines Detail page for editing.

5. Locate the Ship By field and take note of EpBinding (OrderDtl.RequestDate).

6. Collapse the Field Help panel.

13 December, 2021
 Using Data Rules in Application Studio

Creating a rule
1. From the Sidebar, select Data Rules > Add New.
2. In the Header section, enter or select the following:
Field Value

Name WarningOnShipBy

Description Ship By dates mismatch

Action Data View OrderDtl

Row Rule Criteria Conditions

3. Press Select Condition > Condition and specify the following:

Field Value

DataView OrderDtl

Field RequestDate

Operator NotEqual

Value/Field Field

Data View OrderHed

Field RequestDate

4. Now create an Action. Press Select Action > Setting Style and specify the below parameters:
Field Value

Actions SettingStyle.RowStatus

Status Error

5. Press Save All.

Test row rule

1. Select Preview.

2. Press New Order.

14 December, 2021
 Using Data Rules in Application Studio

3. For Customer, enter Addison.

4. In the Ship By field, select today's date and Save the record.

5. In the Tree view, click on Lines. On the Lines card, press New Line.
6. Enter the following information:
l Part - DSS-1010
l Order Quantity - 5
7. Verify the Ship By date defaults to current date.
8. Modify the Ship By date and notice the row turns red.
9. Save the record and exit the Preview.

15 December, 2021
 Using Data Rules in Application Studio

Exercise 4: Disabling Form Control

In this example, you require a Purchase Order (PO) number must be filled in. When the PO is missing,
you want to draw attention to the field and you want to prevent closing an order unless the value is
filled.

Identifying Purchase Order field

1. In Application Studio, select the Details tab (page).
2. Locate the Purchase Order field, press the Help icon and take note of EpBinding
(OrderHed.PONum).
3. Collapse the Field Help panel.

Identifying Close Order control

1. On the Application Map, select the Sales Orders Landing Page tab.

2. Select the Sales Orders EpView component above the grid.

EpView is the primary component for displaying Kinetic applications. This is

where the Overflow Menu controls for each application are defined. These
controls have EpBinding properties defined which makes them available for use
in Data Rules.

16 December, 2021
 Using Data Rules in Application Studio

3. Select Properties. Locate the ToolOrderHedClose control, expand it and take note of EpBinding
(OrderHed.CloseOrderTool).

Creating a rule
1. From the Sidebar, select Data Rules > Add New.
2. In the Header section, enter or select the following:
Field Value

Name PORequired

Description Purchase Order Field mandatory

Action Data View OrderHed

Row Rule Criteria Conditions

3. Press Select Condition > Condition and specify the following:

Field Value

DataView OrderHed

Field PONum

Operator Equal

Value/Field Value

Value Blank (do not enter a value)

4. Now create the first Action to highlight a field. Press Select Action > Setting Style and specify the
below parameters:
Field Value

Actions SettingStyle.Status

Field PONum (scroll down and select this field from the list)

Status Error

5. Create another action to disable the Close Order control. Press Select Action > Setting Style and
specify the below parameters:

17 December, 2021
 Using Data Rules in Application Studio

Field Value

Actions SettingStyle.Disabled

Field CloseOrderTool (only fields pertaining to the OrderHed data view display on
the list of available columns, you need to type this value in)

6. Press Save All.

The rule should looks as follows:

Testing the rule

1. Select Preview.

2. Press New Order.

3. In the Customer field, enter Addison and tab our of the field.
The Purchase Order field displays red as no value is entered.

4. Select the Overflow menu and verify the Close Order control is disabled.

18 December, 2021
 Using Data Rules in Application Studio

5. Enter any PO number. The field is no longer highlighted and the Close Order option becomes
available.

6. Close the Preview.

One more exercise to go!

19 December, 2021
 Using Data Rules in Application Studio

Exercise 5: Validating Input Data

In this exercise, learn how Data Rules, coupled with Events and Business Process Management (BPM)
give you a complete control over data entries. In this exercise we want to achieve the following:

l When the Discount exceeds 20%, the field becomes highlighted and a user is presented with a
warning message.
l When the Discount exceeds 30%, a user is warned that a sales order with unapproved discount
will be placed on hold. When a record is saved, a sales order is put on hold.
Let's take Data Rules to another level!

Identifying Discount field

1. In Application Studio, select the Details tab (page).
2. Scroll down, locate the Disc % field found in Additional column and take note of the EpBinding
field (OrderHed.DiscountPercent).

Creating a rule
1. From the Sidebar, select Data Rules > Add New.
2. In the Header section, enter or select the following:
Field Value

Name DiscountRule

Description Discount exceeds 20%

Action Data View OrderHed

Row Rule Criteria Conditions

3. Press Select Condition > Condition and specify the following:

Field Value

DataView OrderHed

20 December, 2021
 Using Data Rules in Application Studio

Field Value

Field DiscountPercent

Operator GreaterThan

Value/Field Value

Data View 20

4. Now create an Action. Press Select Action > Setting Style and specify the below parameters:
Field Value

Actions SettingStyle.Status

Field DiscountPercent

Status Error

5. Press Save All.

Creating an event
We will now use the Event Designer to evaluate the Discount field and conditionally trigger messages.

1. From the Sidebar, select Events > Add New.

2. Click on NewEvent and enter the below Event identifiers:
Field Value

Id DiscountCheck

Description Check for Order Discount

3. Click on No Trigger to displays Trigger Properties. We want to fire this event when the Discount
field changes. Configure the Trigger as follows:
Field Value

Type DataTable

Hook Column Changed

Targer OrderHed

21 December, 2021
 Using Data Rules in Application Studio

Field Value

Columns DiscountPercent

4. Let's add the first condition. Select the Toolbox tab, search for condition and drag it on the
canvas.

5. Select the condition and go to Properties. Press Advanced > Param to expand condition
parameters.
6. We will first check if the Discount exceeds 30%. Enter the below expression:
{OrderHed.DiscountPercent} > 30

7. Press True. Now we need to specify what action is taken when the condition evaluates to true.
8. Search for and select erp-message-handler. In the message properties, expand Advanced > Param
and configure message parameters as follows:
Field Value

Type Toast

Level error

Message You have entered unapproved {OrderHed.DiscountPercent}% discount.

Saving the record will place order {OrderHed.OrderNum} on hold.

Note that the message retrieves data from the current order record.

9. Select the condition again, expand Advanced > Param and press False. We will add another
condition that checks if the discount exceeds 20%. Search for and select condition to place it on
the canvas.
10. Select the second condition and go to Properties. Expand Advanced > Param category and enter
the below expression:
{OrderHed.DiscountPercent} > 20

11. Add another message when this criteria is met. Select True, search for and select erp-message-
handler.

22 December, 2021
 Using Data Rules in Application Studio

12. In erp-message-handler properties, expand Advanced > Param and configure the message as
follows:
Field Value

Type Toast

Level warning

Message Warning - the Discount exceeds 20%!

13. Press Save All.

Verify your event looks as follows:

Optional - creating a BPM directive

Here's how you can complete the process by creating a Method Directive to put sales order with
excessive discount on hold.

1. In your ERP smart client, use the Browse field on the Menu to open Method Directives
Maintenance.
2. Create a Pre-Processing directive for Erp.BO.SalesOrder.Update method.
3. Create a workflow as per below with the following attributes:
l Discount >= 30- This condition checks for value entered in the Discount Percent field:
The ds.OrderHed.DiscountPercent field of the changed rowis more equal to the 30
expression

23 December, 2021
 Using Data Rules in Application Studio

l Set Hold - This Set Field action sets the OrderHeld field to true if the condition is met:
Set the ds.OrderHed.OrderHeld field of the changed row to the true expression

l On Hold Message - This is Show Message action with custom text to inform a user:
Show informational message based on the Order Placed On Hold template

4. Save and Enable the directive.

For more information on BPM functionality, see Application Help.

Testing the results

1. Navigate back to your Sales Order customization and open the Preview mode.
2. Select any Open order.

3. Click Full Screen to expand the Order Detail card.

4. In the Disc % field, first enter a value below 20 % and verify no action is taken.

24 December, 2021
 Using Data Rules in Application Studio

5. Next enter a value between 20 - 30 %. The Discount field turns red and you are provided with the
first warning message.

6. You now enter a value above 30. You are now provided with the second message.

7. If you performed the optional task to create a BPM directive, Save the order.
Verify the order is put on hold.

You have completed all exercises!

25 December, 2021
 Using Data Rules in Application Studio

Summary
In this course, you learned how to:

l Use field help to help you design Data Rules

l Set default field values
l Draw the users attention to fields and rows by highlighting them
l Control availability of application controls
l Examine field values using Data Rules, Events and BPM directives
We love feedback! Once you have closed this course and you are back on the Course Details page,
please use the Feedback button to let us know how well this course met your needs and
expectations. Thank you.

26 December, 2021