Batch voucher export hangs at 'Pending' indefinitely for batches with multiple vouchers, no export file produced

Description

Overview: Batch voucher export in Orchid hangs at 'Pending' indefinitely for multiple voucher export and does not produce an export file (nor an error).
Steps to Reproduce:

  1. Log into FOLIO Orchid as a user with Invoice creation, approval, payment and batch voucher export permission

  2. Select the Invoices app.

  3. Create, approve and pay multiple invoices with 'Export to accounting' selected.

  4. From Invoices > Actions select Batch Voucher Export

  5. Select a Batch group (FOLIO default) and > Run manual export.

Expected Results: Export status enters Pending, then progresses to Generated - with a downloadable export file generated and available.
Actual Results: Export status enters Pending and remains so indefinitely. No export file generated or available, no errors reported. (Cannot subsequently process vouchers for payment.)

Additional Information:

  • Reproduced in folio-orchid.dev.folio.org environment.

  • Single voucher/invoice export generates a downloadable file OK.

  • Same simple invoices created for successful single voucher/invoice export were created for multiple voucher export.

  • Manual export only attempted. No schedule set in Batch group config.

  • Export format set to XML

URL: https://folio-orchid.dev.folio.org/invoice/voucher-export?exportToAccounting=true&limit=50&offset=0
Interested parties:
cc: ,  

 

CSP justification

Describe issue impact on business

This service is what allows a library to export financial activity to an accounts payable department. Without this funcitonality it would not be possible for libraries to pay vendors in a timely manner. Late payments could result in additional costs incurred by the library, late fees, breach of contract etc.

What institutions are affected? (field “Effected Institutions” in Jira to be populated)

All

What is the workaround if exists?

Approve 1 invoice at a time and export 1 voucher at a time. Not a reasonable workaround for libraries that approve 100s of invoices for multiple vendors per month

What areas will be impacted by fix (i.e. what areas need to be retested)

  • Run batch voucher export

  • Upload batch voucher export to ftp

  • Download batch voucher export file from UI

Brief explanation of technical implementation and the level of effort (in workdays) and technical risk (low/medium/high)

1 day work (JIRAs)
Negative case fixed by avoiding NPE inside error handler.
Positive case (with more than 1 invoice) fixed by encoding URL before making request for retrieving invoice lines as part of batch voucher export flow

Low technical risk - This fix involves a change to logic that is only used for batch voucher export. This functionality occurs at the end of the workflow and thus testing can be very targeted.

Brief explanation of testing required and level of effort (in workdays). Provide test plan agreed with by QA Manager and PO.

TBD - 0.5 days work

Test plan:

Each scenario where the particular code would be triggered will need to be tested with >1 records of the appropriate type. Test rails test cases will be designed for each scenario and the test plan is to complete each of these test cases successfully. One for >1 voucher of the same vendor and One for >1 voucher with different vendors but assigned to the same batch group

The process will be:

Tests

What is the roll back plan in case the fix does not work?

The fix will be implemented by a patch version of <<module>> and an update to platform-complete to depend on the newly released patch version. If the fix doesn't work / causes issues the roll back will be a further patch version of <<module>> with the code changes reverted, and a further update to platform-complete to depend on the patch version with the reverted changes

CSP Request Details

Approved at May 30

CSP Rejection Details

None

Potential Workaround

None

Attachments

8
  • 07 Nov 2023, 08:09 AM
  • 06 Nov 2023, 08:40 AM
  • 06 Nov 2023, 08:18 AM
  • 06 Nov 2023, 07:44 AM
  • 01 Jun 2023, 03:13 PM
  • 30 May 2023, 07:48 AM
  • 30 May 2023, 07:48 AM
  • 25 May 2023, 07:48 AM

Checklist

hide

TestRail: Results

Activity

Show:

Mikita Siadykh June 5, 2023 at 8:46 AM

3 SPs: fix, karate + release in scope of this ticket

Dennis Bridges June 1, 2023 at 4:45 PM

Test successful in bugfest-orchid

NinaChistova June 1, 2023 at 3:20 PM

Verified on https://bugfest-orchid.int.aws.folio.org/

Works as expected

Dennis Bridges May 31, 2023 at 9:02 PM

Test successful in folio-snapshot.

 

NinaChistova May 31, 2023 at 7:07 AM

Test cases for retest were successfully passed as well on https://folio-snapshot.dev.folio.org/

could you please review? Thank you!

Done

Details

Assignee

Reporter

Labels

Priority

Story Points

Sprint

Development Team

Thunderjet

Fix versions

Release

Orchid (R1 2023) Service Patch #1

RCA Group

Legitimate regression

CSP Approved

Yes

Affected releases

Orchid (R1 2023)

Affected Institution

!!!ALL!!!

TestRail: Cases

Open TestRail: Cases

TestRail: Runs

Open TestRail: Runs
Created May 25, 2023 at 7:49 AM
Updated November 7, 2023 at 8:09 AM
Resolved May 31, 2023 at 9:02 PM
TestRail: Cases
TestRail: Runs