Agreements (UXPROD-573)

[UXPROD-2759] Enhance display of POL information in the Agreement Line display Created: 16/Oct/20  Updated: 04/Jan/21  Resolved: 04/Jan/21

Status: Closed
Project: UX Product
Components: None
Affects versions: None
Fix versions: R1 2021
Parent: Agreements

Type: New Feature Priority: TBD
Reporter: Owen Stephens Assignee: Owen Stephens
Resolution: Done Votes: 0
Labels: agreements, erm
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Defines
is defined by ERM-1228 Add POL/Inventory Instance details to... Closed
Potential Workaround: User clicks POL number, views POL in Orders app, finds the relevant information on that page including link to inventory instance
Epic Link: Agreements
Development Team: Bienenvolk
PO Rank: 25
Rank: Chicago (MVP Sum 2020): R3
Rank: Cornell (Full Sum 2021): R3
Rank: Duke (Full Sum 2021): R4
Rank: 5Colleges (Full Jul 2021): R3
Rank: GBV (MVP Sum 2020): R3
Rank: Grand Valley (Full Sum 2021): R3
Rank: hbz (TBD): R3
Rank: MO State (MVP June 2020): R3
Rank: U of AL (MVP Oct 2020): R4

 Description   

Current situation or problem:
When an agreement line is linked to a POL, a limited set of information is displayed to the user, even though the full POL data is retrieved from the orders module.

In particular when the POL is linked to an Inventory instance, there is no way for the user to navigate directly from the agreement line to the inventory instance.

Users would like to be able to see and link directly to the inventory instance from the agreement line

In scope

  • When a link POL references an inventory instance, display this information to the user including a link to the inventory instance.
  • Add more POL information to the Agreement Line display

Out of scope
Any new linking between Agreement lines and other objects (e.g. Inventory instances)
Fetching any additional information from Orders (beyond that already fetched on displaying the Agreement Line)

Use case(s)
An order (POL) for a print+electronic journal bundle is linked to the agreement line for the electronic and an inventory instance for the print. The user would like to be able to see that the print instance exists, part of the same order, and navigate to the full details.

Proposed solution/stories
The POL line data is already retrieved to be displayed with the agreement line using:
/orders/order-lines?query=id%3D%3D<POL UUID>

This returns JSON like:

{
  "poLines" : [ {
    "id" : "ccb2dac6-272e-4119-8a85-2da07982ee8e",
    "edition" : "",
    "checkinItems" : false,
    "acquisitionMethod" : "Approval Plan",
    "alerts" : [ ],
    "claims" : [ ],
    "collection" : false,
    "contributors" : [ {
      "contributor" : "Antoniou, Grigoris",
      "contributorNameTypeId" : "2b94c631-fca9-4892-a730-03ee529ffe2a"
    }, {
      "contributor" : "Van Harmelen, Frank",
      "contributorNameTypeId" : "2b94c631-fca9-4892-a730-03ee529ffe2a"
    } ],
    "cost" : {
      "listUnitPrice" : 5.0,
      "currency" : "EUR",
      "discountType" : "percentage",
      "quantityPhysical" : 1,
      "poLineEstimatedPrice" : 5.0
    },
    "details" : {
      "productIds" : [ {
        "productId" : "9780262012102",
        "productIdType" : "8261054f-be78-422d-bd51-4ed9f33c3422",
        "qualifier" : ""
      } ],
      "subscriptionInterval" : 365
    },
    "eresource" : {
      "activated" : false,
      "createInventory" : "Instance, Holding",
      "trial" : false,
      "accessProvider" : "11fb627a-cdf1-11e8-a8d5-f2801f1b9fd1"
    },
    "fundDistribution" : [ {
      "code" : "AFRICAHIST",
      "encumbrance" : "0293ef39-a638-4b2c-868c-46287dd4bd1e",
      "fundId" : "7fbd5d84-62d1-44c6-9c45-6cb173998bbd",
      "expenseClassId" : "1bcc3247-99bf-4dca-9b0f-7bc51a2998c2",
      "distributionType" : "percentage",
      "value" : 100.0
    } ],
    "instanceId" : "5bf370e0-8cca-4d9c-82e4-5170ab2a0a39",
    "isPackage" : false,
    "locations" : [ {
      "locationId" : "fcd64ce1-6995-48f0-840e-89ffa2288371",
      "quantity" : 1,
      "quantityPhysical" : 1
    } ],
    "orderFormat" : "Physical Resource",
    "paymentStatus" : "Awaiting Payment",
    "physical" : {
      "createInventory" : "Instance, Holding, Item",
      "materialType" : "1a54b431-2e4f-452d-9cae-9cee66c9a892",
      "materialSupplier" : "11fb627a-cdf1-11e8-a8d5-f2801f1b9fd1",
      "volumes" : [ ]
    },
    "poLineNumber" : "10001-1",
    "publisher" : "MIT Press",
    "purchaseOrderId" : "3d89dc3e-e13e-405f-b54e-e576d04b4546",
    "receiptStatus" : "Awaiting Receipt",
    "reportingCodes" : [ ],
    "rush" : false,
    "source" : "User",
    "titleOrPackage" : "A semantic web primer",
    "vendorDetail" : {
      "instructions" : "",
      "vendorAccount" : "1234"
    },
    "metadata" : {
      "createdDate" : "2020-10-16T07:43:00.234+00:00",
      "createdByUserId" : "e2e165a6-ba4c-54a7-9fd2-51bffe378b75",
      "updatedDate" : "2020-10-16T07:43:09.886+00:00",
      "updatedByUserId" : "e2e165a6-ba4c-54a7-9fd2-51bffe378b75"
    }
  } ],
  "totalRecords" : 1
}

This includes "instanceId" and other information such as titleOrPackage name, orderFormat...

Links to additional info
n/a

Questions
n/a


Generated at Fri Feb 09 00:26:36 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.