4/22/22, 10:53 AM Knowledge Base - EpicCare

Home  All Knowledge Bases  Kinetic/ERP  Technical  Enabling Client Tracing in Kinetic

Search 

Enabling Client Tracing in Kinetic KB0117989 Also in Technical

Deleting All
 Authored by Michael Agapiou •  138 Views •  5mo ago Personalization on
the System for a

Issue specific user

 2245 Views

Port, Network,
Process & Folder
Client trace logs are useful for both troubleshooting issues as well as
Exclusions /
creating customisations such as reports, or for seeing how the system
Whitelist
handles certain functions to help with DMT or REST API by  2006 Views
capturing method calls and/or full Datasets as well as other useful
information. In addition, there is the EO Browser Trace option which Additional Timeout
adjustments for
will help with Kinetic UX specific issues such as Homepage widget
SSRS Report
issues.
xml/utf-8 type error
messages
 1511 Views

Error Table UserFile

property mismatch
between sender and
N/A receiver after
appserver upgrade in
EAC
 1275 Views
Resolution Activating
Developer Mode
 1193 Views
To enable tracing select Tracing Options from the top right overflow
View all 310 articles
menu in the Kinetic Homepage:

KB Top Rated

Totals not
calculating on BOM
Cost Report


E10 - GL - FRD
How do I use the
Financial Report
Designer?

https://epiccare.epicor.com/epiccare/?id=kb_article&sys_id=b69bd3ed1b9c4550de9e6241b24bcb04 1/6
4/22/22, 10:53 AM Knowledge Base - EpicCare

Opt out of a Kinetic

form/reports/process
for all users via
Menu Maintenance
(10.2.500)
Software
Epicor  Corporation
TermsCurrent
of Use Company
| Privacy Policy
does not Allow
Default Document
Storage Error when
Attatching
Documents


Creating an
Updateable BAQ to
Delete Data

NOTE: Tracing Options can be found in Settings if you are using the
Modern UI or under Options if using the Classic UI.
The option is not available when using Kinetic/ERP via a web
KB Top Viewed
browser.

SUPPORT ALERT:
Actions to apply
Select the options you require from the Tracing Options Form:
Microsoft fix for
performance
concerns introduced
with Windows
updates from
February 2021 and
April 2021 before
the official rollout
 5668 Views

KNOWLEDGE
ARTICLE TABLE
FOR
PERFORMANCE
AND DIAGNOSTIC
TOOL (PDT)
ARTICLES
 4322 Views

Installing and Using

the Performance &
Diagnostic Tool
The main logging options and the respective log file are shown in blue (PDT) for Config
boxes, whereas the EO Browser Trace options are shown in a red box Check & Network
(only available in version 10.2.600 or later). Diagnostic
 4117 Views
Use the buttons at the bottom to apply your settings and start tracing.
February and March
2021 Windows

https://epiccare.epicor.com/epiccare/?id=kb_article&sys_id=b69bd3ed1b9c4550de9e6241b24bcb04 2/6
4/22/22, 10:53 AM Knowledge Base - EpicCare

Updates Causing
Related Links Performance Issues
 4060 Views

Epicor Data
Video article: Discovery (EDD)
Troubleshooting
KB0119025 - Enabling Client Tracing in the Kinetic Home Page Guide
 3871 Views

Notes

For more detailed information on each of the options

available, be sure to check the Online Help for up-to-
date information for your version. Alternatively, see the
list below which is taken from Kinetic 2021.2:

Tracing Options Fields

Enable Trace Logging

Select this check box to activate the tracing log. All calls made by
the user interface to the server now automatically record within
the tracing log. If this check box is already selected, it means that
the tracing log is active.

Persist Tracing Options

Indicates whether the selected tracing options are only enabled
during the current session. Leave this check box clear if you want
to trace the current session activity. Select this check box if you
want to record the current and the next session activity.
Note: When you log off and log back on, Persist Tracing Options is
automatically cleared, so for the next session tracing is turned off.
Select this check box if you want to keep the selected tracing
options enabled.

Write Full DataSet

Select this check box to record the entire dataset content including
the method parameter structure and data (if any) that passes
between the client and the server. Each time a method sends data,
it now appears in the client log with the method. When this check
box is cleared, only the structure is recorded.

Track Changes Only

Select this check box if you only want changes to the dataset
recorded in the trace log. All changes to columns in the dataset are
stored in the log.

https://epiccare.epicor.com/epiccare/?id=kb_article&sys_id=b69bd3ed1b9c4550de9e6241b24bcb04 3/6
4/22/22, 10:53 AM Knowledge Base - EpicCare

Write Call Context Dataset

If you wish to review the performance of BPM methods and
customizations, select the Write Call Context Dataset check box.
The Call Context Dataset initializes when a user activates a
program (UIApp) that either launches a customized form or a BPM
directive. As long as the program is active, method calls are sent
to the Call Context Dataset.

Write Response Data

When a method call has a <returnType> other than void, selecting
this check box causes the dataset returned from the server to
display on the tracing log. Numerous method calls occur where the
data is passed down, modified, not written to the database, and
then returned to the client. Selecting this check box places these
hidden calls on the trace log. This only applies to datasets that get
updated or returned from the server call. Examples of these
methods include Credit Checking, Part Verification and Pricing, and
GetNewXXX (where XXX is the name of a record). You may need to
clear this check box if your system has performance issues when
tracing is enabled.

Tip:
You typically select this option when you are developing a Service
Connect workflow and need to see when a non-obvious value is
set by a method call. The tracing log displays “Before” and
“After” images of the dataset.

Include Server Trace

Select this check box to include information from server processing
in the client trace log. This option is useful if you want to diagnose
how client activity affects the application server. For example,
select this check box to see what server side calls interact with the
client.
You can also add server profiles and traces to the client log. Then
when you select the Include Server Trace check box, the client log
captures these additional options. Use this feature when you want
to track server activity from a client machine instead to reduce the
impact on performance. To add these profiles and traces to the
client log, update the .sysconfig file that launches the client
installation. For more information, review the Performance
Tuning Guide in the application help. The Custom Trace Logs
section documents how you add these server options.

Trigger Hits
When a record is sent to the database to be added, updated, or
deleted (Write/Update/Delete), the framework creates an event in
which SQL Server intercepts the call and performs table specific
logic. After this event is processed, the record is sent to the
database. Select this check box to record these trigger events in
the server log.

ERP DB Hits

https://epiccare.epicor.com/epiccare/?id=kb_article&sys_id=b69bd3ed1b9c4550de9e6241b24bcb04 4/6
4/22/22, 10:53 AM Knowledge Base - EpicCare

Activate this check box to track how the Epicor ERP application
interacts with the database. You can review each database hit as
well as how long it took each hit to complete.

BPM Logging
Select this check box to record Business Process Management
(BPM) method calls. Each time user activity activates a BPM
directive, the application server log records the business object
method that was called and how long this call took to complete.
This option is production friendly.

BAQ Logging
Select this check box to record Business Activity Query (BAQ)
database calls. Each time user activity activates a BAQ, the
application server log records which query was called and how long
it took this BAQ to gather the data results. This option is
production friendly.

Other Flags (comma delimited list)

Use this field if you want to include additional traces in the log. You
can review the available client and server trace options in the
Customize Logs chapter of the Performance Tuning Guide. Note
that when you enter multiple trace options, you should delimit
them using commas.

Enable EO Browser Trace Logging

Select this check box to record EO Browser error and console
messages. ERP programs that have a Kinetic user interface (UI)
can be launched as Kinetic applications in the embedded EO
Browser. The EO Browser maintains an internal running log that
may provide useful information to troubleshoot a problem. The
Enable EO Browser Trace Logging option allows to silently
collect this log and save it to a file on the Epicor application server.

Log File
Use this field to define the path and file name for the EO Browser
trace log. By default, the path is set to C:\Users\
<ClientUserName>\AppData\Roaming\epicor\log and once
the trace is activated, the log is saved to a default txt file - for
example, console7536 (where numbers are random).
You can change the default path either in the Trace Options UI or
in the UserSettings section of the application server .sysconfig
file located in the Client\config directory. Please refer to the
startup configuration documentation in the Application Help for
details on EO Browser settings in the app server system
configuration file.

Current Log File

Displays the directory path and filename for the tracing log. If your
system administrator activates the client log through User
Account Security Maintenance, the default directory path
https://epiccare.epicor.com/epiccare/?id=kb_article&sys_id=b69bd3ed1b9c4550de9e6241b24bcb04 5/6
4/22/22, 10:53 AM Knowledge Base - EpicCare

defined on the user account displays in this field. However you can
enter a different directory path in this field or click the Browse
(...) button to find and select it. After you click Apply or OK, this
custom directory path becomes the default location that stores the
generated log files for this client.
If the client can no longer find this location, the default path
specified in the epicor.exe.config file is used instead; this .config
file is available in the Client directory. You enter the directory path
and folder you want in the UITraceFileDefaultDirectory setting.
If the client cannot find this directory path location, the client then
writes the client logs to the default %appdata%\epicor\log
location; for example: C:\Users\
<ClientUserName>\AppData\Roaming\epicor\log

Mark Text
Use this optional value to organize the tracing log, making it easier
to review. Enter the text you need, then click the Write button. All
the calls that reference this mark text will group together in the
same section of the tracing log. For example:

abccode lookup

Tip:
Mark Text values also display as options within the .xml version of
the tracing log.

XML File
Defines the directory path and file used for the .xml version of the
tracing log. You can enter this path and file name directly or click
the Browse (...) button to find and select it.
When you have defined the path and filename, click the Create
XML button. The tracing log now saves using the default .xml
format designed for this feature. Any Mark Text values you enter
for this log also appear as options on the .xml file.

Helpful? Yes No

Rate this article     

https://epiccare.epicor.com/epiccare/?id=kb_article&sys_id=b69bd3ed1b9c4550de9e6241b24bcb04 6/6