Overriding work queue cards

Built-in work queue use case

The information that is needed for the work item is in the businessObject field. For the standard work queue, to make a change to a specific work queue, you can use subscription overrides so that all users of a tenant see those changes to that specific work queue. Because all work queues use the same layout templates and card definitions, you must add the logical name of the work queue as a prefix to all your subscription override properties.

The following example shows a query that fetches the work queue definition from the Intelligence Suite database.

Overriding cards on the Work items tabs page

Overriding the open tab on Work queue items tabs page

The widget definition for the open tab is OPEN_WORK_QUEUE_ITEMS_V2. A subscription for OPEN_WORK_QUEUE_ITEMS_subscription.json is needed for your tenant ID.

1. Create a tenant-specific subscription for card if none exists.

   1. To get all subscriptions, make the following GET API call.

      URL	GET {{API_URL}}/api/v1/wms/subscriptions?tenantId=<MY_TENANT_ID>
      Method	GET

   2. To create a subscription, make the following POST API call.

      URL	POST _/api/v1/wms/subscriptions/subscribe_
      Method	GET
      Body	{ "widgetDefinitionId": "OPEN_WORK_QUEUE_ITEMS_V2", "state": "ACTIVE", "tenantId":"<TENANT_ID>", "subscriptionConfig": [ ...any configs for other work queues that was in the all-tenants subscription config that we want to override ...and our configurations, outlined below ]

   3. Create a subscription now with no overrides for the current definition and take note of the subscription ID. Then, you can later make a PUT API call to the following location: /api/v1/wms/subscriptions/<SUBSCRIPTION_ID>
   4. If you want to change a value of a column without overriding a transformation, access all regular nonwork item fields with the business object type in front of the attribute.

      For example, if you want to access the first global identifier and the work queue is of type "Product", you can add the following parameters to subscriptionConfig,

      
           {
                  "name": "inventoryApproachingOutOfStockCopy1.columns[1].cell.label",
                  "value": "{{ Inventory.globalIdentifiers[0].value }}"
            },

      Note: For any attribute that is overwritten to enable sorting, you must confirm that the attribute is sortable in Intelligence Suite by running the query with that attribute as sortBy first. If there is an error or if the items are not sorted afterward, then Intelligence Suite must be consulted to see whether sorting can be enabled on that particular column.
2. Overwrite the name of the first column.

   The work queue is based on a business object, and the column headers and values are based on the work queue's defaultFieldsForSelect and the data comes from the business object data. Any part of the table can be overwritten.

   {
     "name": "inventoryApproachingOutOfStockCopy1.columns[0].header.label",
     "value": "Test"
   }
   

   To hide a column entirely, set the hidden property to true. For example, the preceding changes need to be made for each tab's widget definition's subscriptions, both Open and Closed. The following ids are the ID of the widget definitions for each tab:

   • Open - OPEN_WORK_QUEUE_ITEMS_V2.
   • Closed - CLOSED_WORK_QUEUE_ITEMS_V2

   If you want to confirm, see the URL to take the layout template ID. Get the template with a GET request to /api/v1/wms/layout_templates/<layout_template_id>. Under widgets, you can see the widgetDefinitionId of each card on the page.

Overriding cards on the Work item Resolutions page

Similarly, the work item resolution page can be customized with subscription overrides by adding tenant-level subscriptions to any card that needs customization.

Hiding a card on the resolutions page

To hide a card on the resolutions page, a subscription configuration that sets the enabled property of cards to false is needed. For example, if you want to hide the research assistant card, the following subscription suffices:

{
  "id": "RESEARCH_ASSISTANT_subscription",
  "tenantId": "<TENANT_ID>",
  "widgetDefinitionId": "RESEARCH_ASSISTANT",
  "offeringId": "SCO",
  "state": "ACTIVE",
  "subscriptionConfig": [
    {
      "name": "inventoryApproachingOutOfStockCopy1.enabled",
      "value": "false"
    }
  ]
}

Because it is the only card within that accordion section, disabling the research assistant hides the entire accordion section.

Changing the layout template that is shown in Additional Details

The layout template that is rendered in the Additional Details section of the work item resolution page is by default the detail page of the associated business object of that work queue. For example, a work queue of type inventory renders the Inventory detail page there. To use a different page, complete following steps:

1. Get the layout template ID of page that you want to use.
2. Override the WORK_ITEM_ADDITIONAL_DETAILS_IFRAME widget property for your tenant ID with the iframe path of the layout template ID and the iframe query parameterss of the parameters that the layout template needs.