Error Management Service Overview
Overview
The Error Management service allows you to export a log with processing errors for Business Events and Journals.
What Can Cause a Processing Error?
Business Events
Business Event processing errors can be caused by faulty configuration of:
- Posting Components
- Posting Patterns
- Account Lookups
- Node Configuration
- Business Event Definition Structure
- Deferred payments
- The Journal generated from the Business Event not being balanced
For more details about Business Event definition, refer to Business Event Definition. For more details about creating business rules, refer to Working with the Accounting Rules and Mapping.
Journals
Journal processing errors can be caused by:
- The Journal generated by the Accounting Engine has the Posting Date falling into a closed period
- You created a validation for Journals and the Journal failed to meet the validation’s requirements
- Internal Server Error
Internal Server Error occurs when an error outside of the scope of known errors is thrown. If an Internal Server Error appears in your Error Log, please raise a ticket with Aptitude Support to receive assistance.
Reprocessing
Fynapse supports automatic and manual reprocessing of failed Business Events, Business Event rollback, Journals, and Transactional Data Entities that failed in Flow.
Automatic Reprocessing
The failed records will be automatically resubmitted for reprocessing. Fynapse automatically submits all failed records for reprocessing according to schedules defined by users with the Fynapse System Administrator role via the Reprocessing screen. A failed record will be automatically submitted for reprocessing for a defined number of retries starting from the date it was first marked as errored. If you do not remove the cause of the error after the defined limit of retries, the record will remain in the errored status.
Currently, automatic resubmission occurs by default once a day at 8:00 UTC and the number of retries is set to 30 unless it is defined differently by a user with the Fynapse System Administrator role.
Manual Reprocessing
If you need to reprocess records between the scheduled automatic reprocessing slots, you can trigger manual reprocessing. This process will cover all records that failed up until the moment manual reprocessing is triggered.
If manual reprocessing is started while automatic reprocessing is running, the manual reprocessing will not be performed. You can trigger manual reprocessing after automatic reprocessing is completed.
For more details, refer to How Do I Know a Business Event Is Errored? in Business Event Definition and Reprocessing in Data in the Accounting Engine.
Error Categories and Subcategories
The table below lists the categories and associated subcategories of errors that can appear in the error log:
Error Log File
File Format and Name
The error log file is exported in a CSV format.
The name of the exported file is built using the following syntax:
errors_{uniqueId}
where:
- errors - denotes the file containing the error log
{uniqueId}- a unique identifier of the error log file E.g.: “errors_20220517134305”.
File Structure
The error log contains the following information:
- eventTimestamp - the date and time when the error was generated
If you open the file using Excel, the timestamp generated for each error record will be displayed incorrectly. You can adjust the date formatting in Excel.
- entityKey - unique ID that allows you to identify the record
- entityNamespace - Entities are grouped into logical sets called namespaces.
Currently, the value for this property should be defined as “fynapse“.
- entityName - the type of the record which caused the error
- entityIngestId - Ingestion ID assigned to the ingestion file from which the record was ingested into the system
- severity - the type of the log record
- error
- warning
- category - which type of controls were triggered by the record and caused an error to be thrown
- subCategory - more detailed information about the type of controls triggered
- message - the error message thrown
- technicalId - Internal Use Only
- technicalOrigin - Internal Use Only
Saving Exported Files
Fynapse uses your web browser configuration for saving downloaded files. This means that the exported file will be saved in the default download location configured in your web browser. If you configured your browser to always ask for a download location, you will be prompted to provide a location for the exported file.
Tutorials
How to Export an Error Log to a CSV File?
- Go to Error Management > Download Errors.
- Select the time range to download the error log.
Please ensure you carefully enter both the date and the time range for the error logs.
- You can add the Ingestion ID, provided to every Ingest File and available on the Ingestion screen, to further limit the number of error logs to those generated by Business Events and Journals created by data from a given ingestion file.
- Click the Export to CSV button. The error log will be downloaded to your download folder.
If you open the file using Excel, the timestamp generated for each error record will be displayed incorrectly. You can adjust the date formatting in Excel.
How to Manually Reprocess Failed Records?
- Go to Error Management > Download Errors.
- Click the Reprocess now button in the Events reprocessing section.
- Fynapse will perform the reprocessing.
