How do I configure error reports and what do I need installed on a CAD / Mobile client?

CAD - Client Error Reports Configuration

NOTE: Both the CAD Client, Deployment Agent, and 32 bit WinDebug must be installed on the client machine (P1 client is 32 bit).  Without WinDebug installed, the .dmp (crash dump) will not be created/gathered within the error report. Note the “Master Server” is the external IP address for the F5.

Files Controlling the Error Report Tool

Two XML files control the output from the PremierOne Error Report tool:

• PremierOneErrRptTool.exe.config

• DeploymentAgentConfig.xml

PremierOneErrRptTool.exe.config
The PremierOneErrRptTool.exe.config file contains a variety of settings that can be used to control the type of log files that are created. You can modify this file in any text editor.

Location of PremierOneErrRptTool.exe.config:

CAD Client: C:\Program Files (x86)\Motorola\PremierOne\CADClient\PremierOneErrRptTool.exe.config.xml

Mobile Client: C:\Program Files (x86)\Motorola\PremierOne\MobileClient\PremierOneErrRptTool.exe.config.xml

NOTE: Anything in % should be replaced (including the %’s) with values appropriate to the environment, typically the "UploadPath" is the external IP address or FQDN of the P1 Production Environment for P1CAD.

<?xml version="1.0" encoding="utf-8"?>

<configuration>

  <appSettings>

    <!--true/false, enable or disable the shortcut key(Ctrl + Alt + I) in CAD client to start this tool-->

    <add key="ShortcutKeyEnabled" value="true"></add>

<!-- true/false, enable or disable taking screen shot. -->

    <add key="ScreenshotEnabled" value="true"></add>

<!-- true/false, enable or disable collecting log files. -->

    <add key="LogFileCollectEnabled" value="true"></add>

<!-- true/false, enable or disable collecting csv files -->

    <add key="CSVFileCollectEnabled" value="true"></add>

<!-- true/false, enable or disable taking db backup. -->

    <add key="DBBackupEnabled" value="true"></add>

<!-- true/false, enable or disable taking crash dump. -->

    <add key="CADClientDumpEnabled" value="true"></add>

<!--the windows debugging tool's installation path. (e.g. C:\Debugging Tools for Windows)-->

    <add key="WinDebugPath" value="%WinDebugPath%"></add>

<!-- Http/Https, choose the protocol which will be used. The default value is "http".-->

    <add key="Protocol" value="http"></add>

<!-- The upload path (IP address). -->

    <add key="UploadPath" value="%UploadPath%"></add>

<!-- true/false, enable or disable Pin the error report tool Icon to task bar. -->

    <add key="PinIconToTaskBarEnable" value="true"></add>

<!--The value for retry collecting the cpu usage information.-->

    <!--This value type is int, default value is 2.-->

    <add key="CatchExceptionRetryTimes" value="2"></add>

<!--The value for each performance counter waiting time.-->

    <!--This value type is int, unit is ms and the default value is 100.-->

    <add key="PerformanceCounterWaitingTime" value="100"></add>

<!--The value for performance counter waiting time.-->

    <!--This value type is int, unit is ms and the default value is 5000.-->

    <add key="ThreadWaitingTime" value="5000"></add>

<!--true/false, enable or disable enter the error report comments or reason.->

    <add key="ErrorReportReasonEnable" value="true"></add>

<!--true/false, enable or disable taking ProQA Paramount Log files. -->

    <add key="ProQAParamountLogCollectEnabled" value="true"></add>

<!--the ProQA Paramount Fire installation path. (e.g. C:\Program Files (x86)\Priority Dispatch\ProQA\Fire\) -->

    <add key="ProQAParamountFireLogPath" value="C:\Program Files (x86)\Priority Dispatch\ProQA\Fire\"></add>

<!--the ProQA Paramount Medical installation path. (e.g. C:\Program Files (x86)\Priority Dispatch\ProQA\Medical\) -->

    <add key="ProQAParamountMedicalLogPath" value="C:\Program Files (x86)\Priority Dispatch\ProQA\Medical\"></add>

<!--the ProQA Paramount Police installation path. (e.g. C:\Program Files (x86)\Priority Dispatch\ProQA\Police\) -->

    <add key="ProQAParamountPoliceLogPath" value="C:\Program Files (x86)\Priority Dispatch\ProQA\Police\"></add>

</appSettings>

</configuration>

Remove ‘%’ in appSettings. For example, <add key="UploadPath" value="%UploadPath%"></add> would look like this: <add key="UploadPath" value="10.100.169.40"></add>.   Use the external front end IP address of the F5.  If the customer has a DR system, then the DNS name, in place of the IP Address, to production must be used or error reports will not upload to DR in the event of a failover.   The <appSettings> element is where you state what types of reports you want to collect (Screenshots, Log Files, CSV Files, DB Backups, and/or CAD Client Dumps) by giving a value of “True” or “False”. The attributes are set to “False” by default. You also give the WinDebugPath, the Upload Path. 

Within the PremierOneErrRptTool.exe.config.xml you want to make sure that all the file gathering entries are set to true.  Several customers have experienced issues creating the .dmp file.  Typically the problem is either that the "CADClientDumpEnabled" or, for Mobiles the "MobileClientDumpEnabled" value is set to false. If this value is set to "true”, check the "WinDebugPath” path, it could be missing or is incorrect.  To troubleshoot that problem, make sure that the proper version of WinDebug is installed and that the path to that program is entered correctly.

Within the PremierOneErrRptTool.exe.config.xml, we’ve added an upload path. However, this file only determines the path. It does not address automatic daily uploads.  There is a separate file for this and it’s only present if the Deployment Agent has been installed. The Deployment Agent is required to perform automatic error report and daily client uploads.

DeploymentAgentConfig.xml

The DeploymentAgentConfig.xml file contains a variety of settings that can be used to control the remote deployments on the workstation. This file controls when/how error reports are uploaded to the server automatically. You can modify this file in any text editor. 

Location of DeploymentAgentConfig.xml:

C:\Program Files (x86)\Motorola\PremierOne\DeploymentAgent\ PSWGS.Service.DeploymentAgent\DeploymentAgentConfig.xml 

The DeploymentAgentConfig.xml file is shown here: 

<?xml version="1.0" encoding="utf-8"?>

<AgentConfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http:// www.mot.com/pswgs/service/DeploymentAgents"> 

<Staging>.\LocalRepository</Staging>

<ProcessDisplayName>PSWGS.Client.Shell</ProcessDisplayName>

<InstallParameter>/s /f1"%InstallScriptPath%" /p"%Password%" / z"%ConfigToolScriptPath%" </InstallParameter> 

<UninstallParameter>/removeonly /z"Deployment" </UninstallParameter> 

<RetryTimes>2</RetryTimes> 

<RetryInterval>1000</RetryInterval>

<UserDelayTime>5</UserDelayTime>

 <RegisterInterval>60000</RegisterInterval>

 <!-- Get client extended propertied interval time-->

 <UpdateClientExtendedPropertiesInterval>600000</UpdateClientExtendedPropertiesInterval>

 <EnableP1ErrorReportUpload>false</EnableP1ErrorReportUpload>

 <EnableDailyLogUpload>false</EnableDailyLogUpload>

 <UploadStartTime>23:30:00</UploadStartTime>

 <!-- This section is used for deployment mobile agent notifier.-->

 <RegisterNotifierInterval>15000</RegisterNotifierInterval>

 <RetrieveNotificationInterval>5000</RetrieveNotificationInterval>

 <!-- This section is used for Aio Staging comparer, if force datetime compare with current deployment datetime which more than 30 minutes,  then do Aio staging first then install at the force datetime or manual install by the user-->

<AioStagingBufferTime>1800000</AioStagingBufferTime>

<ServiceElement>

<ServiceName>PSWGS.Service.DeploymentAgent.DeploymentAgentService</ServiceName>

<ServiceEndpointName>DeploymentAgentRemote</ServiceEndpointName>

<DeploymentServiceEndpointName>DeploymentServiceRemote</DeploymentServiceEndpointName>

</ServiceElement>

</AgentConfig>

Note the yellow highlighted values. One pertains to user created error reports, the second for the daily client logs, and the final entry is the time in which the automatic upload will be performed.  If a customer actually does want to enable automatic uploads, it’s suggested that they stagger the time for multiple clients.  Let’s say a customer has 500 mobile clients.  We don’t want them to all upload their daily error reports at 2330 as it would bog down the system. Have them stagger the times for some clients at 2330, others at 2345, others at 0000, and so on.

Restart the Deployment Agent after making changes, but before testing.

Error Report Location on clients:

When an error report is created it resides within a hidden folder on the client machine in the following location(s):

• C:\ProgramData\CAD Client\PremierOneErrRpt

• C:\ProgramData\Mobile Client\PremierOneErrRpt

The files we are looking for are the following:

For CAD:

• ErrRpt_CAD_Logs_....zip

• ErrRpt_CAD_Other_....zip

For Mobile:

• ErrRpt_Mobile_Logs_....zip

• ErrRpt_Mobile_Other_....zip