:
KB Articles
KB Article # 9222
Topic/Category: Advanced Reporting
Ephesoft Version: 3x
Issue: “Variable @black is undefined” displayed in web browser
Analysis:
The report information may have existed in Batch Class at one time, but the BC may have been re-defined to not use that plugin. The Advanced Reporting module will not automatically synchronize this change and will continue to expect that Plugin’s report data even when it no longer is created. The Advanced Reporting module needs to be manually adjusted to account for this change.
Solution:
For the purpose of this example, let’s say that Document_Assembler_Scripting_Plugin has been removed from BC and that is the error that is reported missing in logs.
Since the Document_Assembler_Scripting_Plugin has been removed, Adv. Reporting is no longer able to find the corresponding XML backup in the report-data entry for batches processed by this BC. The error the client is seeing is this failed file search. Since it can’t find the XML to analyze, Adv. Reporting isn’t able to process the batch as a whole. To begin processing finished batches after this BC change, you’ll need to do the following:
- Inspect all BCs that the client requires Adv. Reporting to obtain data for.
- If they are only considered with one BC, then you only need to focus on that one.
- List all the plugins in use by these BCs in order of their execution.
- You’ll need to identified the following 3 plugins:
- Which plugin is common to all required BCs and is the last to execute before Review. This is the “bca.pre.review.end.state.pattern”
- Which plugin is common to all required BCs and is the last to execute before Validation. This is the “bca.extraction.end.state.pattern”
- Which plugin is common to all required BCs and is the last to execute before Cleanup/Finishing. This is the “bca.final.end.state.pattern”
- Once you have those plugins identified, verify that each of those plugins has a corresponding XML backup in the BI folders under SharedFolders/report-data.
- Adv. Reporting will expect at least those three XML backups to be present.
- If they are not present for newly finished batches, you’ll need to investigate why those backups aren’t being created.
- Now we’ve verified that those XML backups are present, we can configured Adv. Reporting to use those.
- Locate batch-class-analysis.properties on the client’s installation.
- Take a backup of batch-class-analysis.properties and edit the following:
- Edit the value of “bca.pre.review.end.state.pattern” to match the pattern of the XML backups created for the plugin identified in step 3.1.
- Example: Document_Assembler_Scripting_Plugin_batch_bak
- Edit the value of “bca.extraction.end.state.pattern” to match the pattern of the XML backups created for the plugin identified in step 3.2.
- Example: Extraction_Scripting_Plugin_batch_bak
- Edit the value of “bca.final.end.state.pattern” to match the pattern of the XML backups created for the plugin identified in step 3.3.
- Example: Export_Scripting_Plugin_batch_bak
- Edit the value of “bca.pre.review.end.state.pattern” to match the pattern of the XML backups created for the plugin identified in step 3.1.
- Restart Adv. Reporting’s containing service for the change to take effect.
From the logs, it looks like it’ll be most important to change “bca.extraction.end.state.pattern” since this is the one that currently isn’t being found.