HomeTutorialsHandheld SolutionEnable WCF Logging
 

Enabling WCF logs for analysis and troubleshooting

A Windows Communication Foundation (WCF) SQL troubleshooting log can be optionally activated at the WCF service level.  Please note that the log is for analysis and troubleshooting and should not be otherwise activated.

There are two types of troubleshooting logs available:

  1. A global WCF log where all business object calls from all Handheld devices are logged; the steps to enable this global log are detailed below
  2. A local handheld device log where a table of logged calls specific to the local handheld device are stored in the data folder of the specified device; for details, go here for instructions on how to activate this local log

To activate a log for all business object calls, select the following checkbox.  Note the location of the resulting log.

wcf webservices option

To activate the SQL log for all WCF activity, start the Windows Registry editor from the Start menu (Start-> Run-> regedit).

Navigate to the following registry key for a 32-bit server:

HKEY_LOCAL_MACHINE -> SOFTWARE-> Cadacus-> WCFService

As in this example:

Or, navigate to the following registry key for a 64-bit server:

HKEY_LOCAL_MACHINE -> SOFTWARE-> Wow6432Node->Cadacus-> WCFService

As in this example:

 

To activate the SQL log (recommended), right-click each registry name and select "Modify...", as follows:

    • SQLDatabase:  enter the SYSPRO database
    • SQLLog: set this value to "True" (not case senstive; any other value will be interpreted as "false"
    • SQLPassword: enter the SYSPRO database password
    • SQLServer: enter the SYSPRO SQL Server computer name
    • SQLUser:  enter the user name associated with the above password
      • NOTE:  the "SQLConnection" string can be entered, if known, as an alternative to the above settings
    • SQLTable:
      • For Cadacus WCF Service versions prior to February, 2014--create a SQL logging "Activity" table by downloading and running the Cadacus "WCFActivity" table script here (note: this table can be created in a separate database from SYSPRO or within the SYSPRO database)
      • For Cadacus WCF Service versions after February, 2014 (and newer), set the value of the desired table name for the "SQLTable" entry and the table will be created automatically, if it does not already exist.  If "CYMD" is added to the name of the table entry, the CYMD portion will be automatically replaced with today's date and a new table will be created every day. For example, entering "WCFActivityCYMD would create table "WCFActivity20140306" today and "WCFActivity20140307" tomorrow, and so on.  This keeps the size of the table smaller and more manageable.
    • Restart the Cadacus WCF Service
    • Enter any SYSPRO activity
    • Check the newly created SQL table to inspect the logging results, as in this example

 

Alternatively, to activate the Text log in the Registry:

    • TextLog: set this value to "True" (not case senstive; any other value will be interpreted as "false"
    • TextLogFile: optionally, a path and file name can be set for this file; note: the default path for this file is the same path in which the Cadacus WCF service resides; also, if a user-defined file name is created, it is recommended to include the "CYMD" text in the file name-- the logs will then be more manageable in size and will be separated by calendar year, month, and day
    • Restart the Cadacus WCF Service
    • Enter any SYSPRO activity
    • Check the newly created text file to inspect the logging results

 

To validate logging:

The Windows Application Event Log can be viewed from the Windows Administrative Tools to ensure logging is occurring as expected, as in this example:

 

To export a log for Technical Support:

In Microsoft SQL Server Management Studio, right-click the database containing the WCFActivity log --> Tasks --> Generate Scripts:

Select only the WCFActivity log for the day at issue, as in this example, and click "Next":

Click "Advanced" and scroll down to ensure "Types of data to script" is both "Schema and data", as in this example:

Click "OK", make note of the location the destination output SQL, click "Next" and "Finish".  The WCFActivity log should be available at the destination location for advanced troubleshooting with technical support. Please note it is recommended to compress (e.g., zip) the log prior to sharing with technical support

 

Why CADACUS SOLUTIONS FOR SYSPRO?

Since 1991, as developer of the standard EDI, Shipping, and Freight Calculator Solutions for SYSPRO, our products are fully integrated with SYSPRO and drive efficiencies for hundreds of users worldwide.

Why SYSPRO?

For 35 years, SYSPRO has had a single product focus resulting in an award-winning ERP system with a track record of success for over 14,000 customers worldwide.