C Troubleshooting an Integrated Excel Workbook

C.3.2.1 How to Generate Log Files using a Configuration File

You create an XML-based configuration file named adfdi-excel-client.dll.config in the same directory as the adfdi-excel-client.dll file. The parent element in the adfdi-excel-client.dll.config file is <configuration>. Table C-4 describes child elements and attributes that this configuration file contains and describes the attribute values that you supply to write different types of information to different formats of log file such as .log,.txt, or .xml.

For more information about the TraceSource class and the configuration file that controls output by instances of this class, see the documentation for the Microsoft .NET Framework.

To create the configuration file for client-side logging:

1. In the Oracle ADF Desktop Integration Designer, click About Oracle ADF 11g Desktop Integration.

2. Click the Properties tab and note the value for the directory path that appears in the Configuration field.

   For example, a directory path similar to the following:

   C:\Documents and Settings\john\Local Settings\Apps\2.0\51O97ALD.VNY\OG48YJLC.Q0Y\orac..tion_ca85d24b89a948e6_000b.0001_61767b25443cf62e\adfdi-excel-client.dll.config
   

3. Navigate to the directory that you identified in Step 2.

4. Create an XML-based file named adfdi-excel-client.dll.config in the directory with a <configuration> parent element.

5. Add additional child elements and attributes as described in Table C-4.

6. Save the file.

   Example C-1 shows a sample configuration file that generates two different log files with different formats (.txt and .xml). These files capture different types of information such as ThreadId, ProcessId, and DateTime at a Verbose logging level.

   Example C-1 Sample Configuration File

   <?xml version="1.0"?>
   <configuration>
     <system.diagnostics>
       <sources>
         <source name="adfdi-common" switchValue="Verbose">
           <listeners>
             <add type="System.Diagnostics.DelimitedListTraceListener"
               name="adfdi-common-excel.txt"
               initializeData="c:\logs\adfdi-common-excel.txt"
               delimiter="|"
               traceOutputOptions="ThreadId, ProcessId, DateTime"/>
             <add type="System.Diagnostics.XmlWriterTraceListener"
               name="adfdi-common-excel.xml"
               initializeData="c:\logs\adfdi-common-excel.xml"
               traceOutputOptions="None"/>
           </listeners>
         </source>
       </sources>
     </system.diagnostics>
   </configuration>
   

   For your reference, a sample adfdi-excel-client.dll.config configuration file is available in the ADFDI_HOME\bin\excel\samples directory.

C.3.2.2 How to Configure Logging Using User Environment Variables

You add two user environment variables to configure the logging level and location for XML log files. Use this option when you cannot access the adfdi-excel-client.dll.config file to make changes to it.

To add or configure user environment variables on Windows:

1. Click the Windows Start button and then click Settings > Control Panel.

   The Control Panel opens.

2. In the Control Panel, select and open System.

   The System Properties dialog box opens.

3. Click the Advanced view tab and then click the Environment Variables button.

   The Environment Variables dialog box opens.

4. In the input field User variables for username, click New and add variables as described in the following table.

   Enter a variable named...	With a value...
   adfdi-common-file	That defines the directory path and file name for the XML file that captures logging information.
   adfdi-common-level	That specifies the level of logging. Table C-3 lists valid values.

   
   

5. Click OK.

C.3.2.3 What You May Need to Know About adfdi-common Object

The adfdi-common object is an instance of the TraceSource class from the System.Diagnostics namespace in the Microsoft .NET Framework. This object is used to generate log files that capture information about events triggered by the Excel workbook that you integrate with your Fusion web application.

For more information about TraceSource class, see Microsoft Developer Network.