Reprocessing statements for statement forwards (enterprise only)

Useful for when we need to reprocess statements for a statement forward in support cases. Ensure statement forward is re-enabled if not already before reprocessing statements.

Check after the requeue, the statement forward document’s reprocessingStatus as well as the completedForwardingLog on the statements to confirm requeue is successful.

Usage

Through the API (available in SDC enterprise from 13.32.0)

You will need the statement forward ID (copyable from UI, using the copy button next to the title).

  1. Count the number of missing statements by sending GET request to
    https://{SDC_BASE_URL}/api/statementforwarding/reprocess/{STATEMENT_FORWARD_ID}/count

    Response should be 200, SF’s reprocessingStatus's status field should be "COUNT FINISHED" and the missedStatementCount should be populated.

  2. Search the number of missing statements by sending GET request to
    https://{SDC_BASE_URL}/api/statementforwarding/reprocess/{STATEMENT_FORWARD_ID}/search

    Response should be 200, SF's reprocessingStatus's status should be "SEARCH_FINISHED", the searchResultCount, firstSearchResults and the lastSearchResults should be populated.

  3. Requeue the number of missing statements by sending GET request to
    https://{SDC_BASE_URL}/api/statementforwarding/reprocess/{STATEMENT_FORWARD_ID}/forward

    Response should be 200, SF's reprocessingStatus's status should be "FINISHED", the forwardedCount indicates how many have been successfully requeued.

  4. Cancel reprocessing by sending POST request to
    https://{SDC_BASE_URL}/api/statementforwarding/reprocess/{STATEMENT_FORWARD_ID}/cancel

    Response should be 200, SF's reprocessingStatus's status should be "CANCELLED".

  5. If the reprocessingStatus is FORWARDING or SEARCHING, reprocessing can be paused by sending POST request to
    https://{SDC_BASE_URL}/api/statementforwarding/reprocess/{STATEMENT_FORWARD_ID}/pause

    Response should be 200, SF's reprocessingStatus's status should be "FORWARDING_PAUSED" or “SEARCHING_PAUSED”.

Troubleshooting (TODO)

 

Through the UI (available to site admins only)

https://www.loom.com/share/63ed24a327504ec0b22f2eb75bf4bf40

What is a Missed Statement

A statement is matched in the search stage if it meets the following criteria:

  • Matches the SFs filter

  • Statement’s stored time is after the createdAt  time of the SF

  • Statement hasn’t been forwarded by this SF (completedForwardingQueue doesn’t include the SF’s _id )

  • Statement is not currently awaiting forwarding for this SF (pendingForwardingQueue doesn’t include the SF’s _id)

  • Statement isn’t still in one of the forwarding queues (processingQueues doesn’t include STATEMENT_FORWARDING_QUEUE or STATEMENT_FORWARDING_PERSONA_DEPENDENT_QUEUE)

  • Organisation of statement and SF are the same

Essentially statements that would have been forwarded if the SF was active and no errors occur

Learning Locker and the Squirrel logo are trademark of Learning Pool 2020 | Learning Locker is licensed under GPL 3.0.