How-To - ArcFM - Include Username or other Parameters to the Miner Event Log

Version 5



    Many of our customers use Citrix to rapidly deploy the ArcFM solution to their users.  This can pose a problem for Tech Support and Client Support if the event log from the citrix server has many users.  It becomes very difficult to narrow down a problem trail that a specific user was having.  There are some additional steps Citrix users can implement to append the username or other variables to the event logs; allowing easier identification of the user and the problem.

    Note:  A username may not be useful if all of the users still login to the Citrix system as one user.  This makes it very easy to deploy Citrix but we recommend that the customer create seperate accounts; if only for the process of troubleshooting.


    Across all ArcFM products, the logging into the event log is controlled by log4net settings.  What is logged, and at what detail, is controlled via configuration in various files.  Modifying these files will allow more information to be written to the files.


    The example below covers how to add the username into the event logs.  This can be done on any installation but is more beneficial when in a centralized deployment option such as Citrix.

    Other settings are available if you choose to add something else.  If you choose to modify additional portions of it, a reference page can be found at  here.

    1. On the ArcFM machine, open the miner.log4net.config file located in \Program Files\ArcGIS\Bin folder.  You will be making changes to this file so now is a good time to make a backup.

    2. Locate the Section in the screenshot below:


    3. Add the highlighted text into the file as seen as below:


    4. Save the file and restart ArcFM.  All future logs that appear in the event log will have the windows username.

    Note:  When the application begins to write the log out, it looks up the username and adds it to the log.  This additional step will add more overhead into the process.  Depending on the load already running on the server, this may have a performance impact to the users and you may want to try it on one box before deploying to all servers.