Diagnostics
Estimated reading time: 12 minutesOverview
The Diagnostics feature of Interject allows users to set and change numerous configurations within Excel as well as utilize various tools for diagnostics and debugging. It is located in the Advanced Menu of Interject:
Depending on your company's settings, you will have access to a number of tools.
Diagnostic Pane Fields
There are 5 fields within the Diagnostic pane:
- <Execute Selected Action>: Execute the selected tool (some tools require an input first)
- Navigation: Shows a hierarchy list of tools
- Instructions: Displays information about the currently selected tool
- Input: Put your input code here. Some tools require an input for execution.
- Results: The results of the execution are displayed here
Public
The Public tools involves Logging, Cache, and Bug Fixes.
| Setting | Description |
|---|---|
| Clear External Login Cookies | Click Execute to clear external login cookies. This will delete any saved form data in the login window as well. If you log in with an external auth provider you may be offered an option to remember your login. This may create a security risk in some cases. You can use this feature to clear the data stored for your login so other users can not log in with your cached auth cookie. |
| Toggle Verbose Logging | Click Execute Selected Action to toggle Verbose Logging. This adds very detailed logs on hundreds of application events for detailed analysis by support folks. |
| Toggle Memory Logging | Click Execute Selected Action to toggle Verbose Logging. This adds very detailed logs on hundreds of application events for detailed analysis by support folks. No input required. You may change the default 3000 millisecond delay by replacing this text with the number of milliseconds required. The setting must be between 1000 and 30000 milliseconds. |
| Toggle DataCell Audit Mode | Click 'Execute Selected Action' to Enable or Disable the Formula Auditing Mode for DataCell calculations. This will provide you exact cell address data for errors noted when you re-run the reports. |
| Reset Settings Cache | This will reset the user setting cache so the system will be forced to repull from the central database. |
| Open User Folders | Click Execute to open the folders for user application data, client shared data and report file cache. |
| Apply Special Features | This allows a user to enable special features that may be needed for their environment. Codes to use: Workaround for Microsoft Animations Bug: BugFix1=ON or BugFix1=OFF Workaround for Microsoft Repaint Bug: BugFix2=ON or BugFix2=OFF Macro security features must be setup in the Portal Website or through Interject Support |
System Tools
The System Tools involve various systems settings.
| Setting | Description |
|---|---|
| List DataPortals | Click Execute Selected Action to show the DataPortal List for the active user. |
| Toggle Double Click Events | Click 'Execute Selected Action' to enable or disable the Interject_DoubleClick custom property in the current workbook [TestsTypes.xlsx]. By setting to true it will enable the double click events for the drill. The in-memory setting is set to False. |
| Set RunOnOpen For Workbook | Click 'Execute Selected Action' to enable or disable the Interject_RunOnOpen custom property in the current workbook [TestsTypes.xlsx]. By setting this property the workbook can automatically pull data when opened. Input allowed: No input will toggle between true and false. True will pull data on the activesheet when opened. 'Prompt' = will show Pull Data form when file is opened. 'T:Sheet1|F:!A5' = will pull data for the tab Sheet1 but will exclude A5 from the report action, but will run the rest. 'F:A5' = will pull data for the active sheet for only the report formula in cell A5. 'T:Sheet1' = will pull data for the tab Sheet1 for all report formulas. 'RunOnce,T:Sheet1' = Will do the same as above, but the setting will be cleared afterwards. 'T:Sheet1,T:Sheet2|F:CellName' = will pull for all of Sheet1, then pull for Sheet2 but for only the report formulas in the range name 'CellName'. To test various settings against the current workbook, and view a sample execution plan, use: 'Test=' and then the instructions Test= T:Sheet1|F:A5' Test= true Test= T:Sheet1 Test= F:A5 … then click Execute Selected Action |
| Toggle Log Truncation | Click 'Execute Selected Action' to Enable or Disable the truncation of logs. |
| Reset Settings Cache - All Users | This will mark all users in the client to repull their settings cache from the central database at the next opportunity. Only users with the ClientAdmin role can execute this action. |
| Reset File Cache | This will remove all files that were previously downloaded and cached as well as reset the users settings cache. |
| Open Application Folders | Click Execute to open the folders for AppData, UserData, and UserConfig Click once installations use a subdirectory of: C:\Users\MyUserName\AppData\Local\Apps\2.0 |
| Set Enterprise Connection | Paste a Connection String in the Input box. Click Execute Selected Action to save this connection string encrypted for use in Enterprise installations. To clear the connection string, leave the 'Input' box empty and then Execute. If 'Encrypted:' is shown at the start of the connection string, it is currently stored encrypted. Example: "server=My_Server_Name;database=My_Database_Name;integrated security=true"; or "server=My_Server_Name;database=My_Database_Name;User Id=myUsername;Password=myPassword;" |
| Reset Cursor | Click 'Execute Selected Action' to reset a wait cursor that has not reset properly. |
| Open Install Configuration | Click Execute Action to open the configuration window |
| Force Garbage Collector on Dead Memory | Click Execute to clear unused RAM memory (aka Garbage Collection) |
| Find All Workbook Formulas | Click 'Execute Selected Action' to Find all formulas in the active workbook. |
| Replace Data Portal Codes | Click 'Execute Selected Action' to Replace all DataPortalCodes in the current workbook input text should contain oldName_One = NewName_One anotherOldName = anotherNewName |
Support
The Support tools involve tools that support the Interject/Excel environment.
| Setting | Description |
|---|---|
| Clear Data Cell Cache | This will clear the Data Cells cache in memory. It is used for troubleshooting only. |
| Change ShortKey | Allows you to reassign a shortkey. After a shortkey is reassigned you must close and reopen Excel. Changes create configurations to your local IdsSettings.xml file such as Input reassignments here such as 'ReportLibrary=Ctrl+Shift+A'. To disable or re-enable all shortkey reassignments input 'DisableAll' or 'EnableAll' Currently shortkey reassignments are enabled. Allows for multiple lines of commands to be input. |
| Clear Error Log | Click Execute Selected Action to clear the error log at C:\Users<YourName>\AppData\Local\Interject\Settings\ErrorLog.xml. |
| Re-Initiate Interject | Click Execute Selected Action to make sure that basic setup information is in place for Interject to run. If Interject has already been initiated, this process will reset and clear certain settings. |
| Set Application Data Source | Click Execute Selected Action to set Interject's application data source. NOTE: Which data sources are available to you will depend on your Interject subscription. Possible sources are: EnterpriseDatabase InterjectPlatform |
| Launch the License Management Form | Click Execute Selected Action to open the License management form. |