Working with Report Orders: Order Collections

Introduction

The page https://bmpi.atlassian.net/wiki/pages/resumedraft.action?draftId=2796781569 covers the knowledge needed to set up the majority of orders. Expanding on that, this page teaches reporting specialists to use order collections.

Order Collection Use Cases

Running collections of orders (single or batch orders) can have multiple use cases:

Re-produce report orders since a past date after data has been corrected (e.g. all online reports since the portfolio has been updated to signed-off quality)
Regression testing
- run the same order collection on a single system before / after the release for comparison of artefacts, OR
- run the same order collection on PROD and UAT systems for comparison of artefacts
Load testing

Setting up an order collection

Order collections can only be posted via Json in the advanced mode:

Sample order collections:

Description

Order Definition

Ordering multiple orders for a single date

JSON

{
  "reportOrderCollectionId": "Mandate regression test",
  "parameters": {
    "reportingDate": "2022-10-31"
  },
  "orders": [
    "ORD1", "ORD2", "ORD3"
  ]
}

Ordering multiple orders for multiple dates

JSON

{
  "reportOrderCollectionId": "Rerun online reports",
  "parameters": {
    "reportingDate*": ["2022-10-31", "2022-11-01", "2022-11-02", "2022-11-03", "2022-11-04", "2022-11-07"]
  },
  "orders": [
    "ORD1", "ORD2", "ORD3"
  ]
}

Ordering multiple orders for specific dates

JSON

{
  "reportOrderCollectionId": "Special case",
  "orders": [
    {
      "orderId": "ORD1",
      "parameters": {
        "reportingDate": "2022-09-30"
      }
    },
    {
      "orderId": "ORD2",
      "parameters": {
        "reportingDate": "2022-10-31"
      }
    },
    {
      "orderId": "ORD3",
      "parameters": {
        "reportingDate": "2022-10-31",
        "addDebugData": true
      }
    }
  ]
}