IDI version 26.8 is now available.  Click here for details: IDI Updates.

Managing Packages in a Transaction

Prev Next

The Orders module supports viewing and editing individual items within a package. You can do this while adding items to an order, as well as after an item has been added while you’re still assembling the order.

Viewing Items Within an Added Package

From the Order Detail view you can display/hide the contents of a package by toggling the expand/collapse icon (>) next to the package name in the left pane. The package contents are hidden by default. When selected, each individual item displays in the Order Details in the same manner as standalone products added independent of a package.

Show Picture

UG template for Help

Editing an Added Package’s Items

To edit a line item for a package added to the order, simply click to expand the package contents, select the item you want to edit and then click the edit (pencil icon) in the right hand pane. You can also remove the selected item by clicking the remove (trash can) icon.

Show Picture

UG template for Help

Clicking the edit icon displays the staging dialog for the selected item where you can select views and edit applicable fields (consistent with functionality for standalone products).

Show Picture

UG template for Help

Managing Package Contents While Adding Items

When you add a package to an order, the package is presented in the right side pane for staging. In this view there is a button (unique to packages) that lets you drill down into the package and select one or more component items for staging.

Show Picture

UG template for Help

Clicking this button displays a dialog listing all items within the package. Select one or more check box(es) corresponding to the item(s) you need to stage, then click the STAGE button.

Show Picture

UG template for Help

The staging dialogs for the selected items are displayed below the package’s staging dialog (one dialog for each of the selected items). These staging dialogs provide the same functionality as when you’re adding a standalone product to an order.

Show Picture

UG template for Help

Notes:

  • You can remove an item within package if needed by clicking the corresponding X icon in the upper right corner.

  • Items with undefined required fields cannot be removed in this manner. This is covered in the Auto-staging section below.

Handling One-Price Packages

As in IDI Desktop Client, if you edit the charge of a product within a one-price package, that change is ignored. One-price packages only evaluate the charge of the package itself, not the total of its components. This includes one-price packages (or any packages, for that matter) within a one-price package. If the top-level item is a one-price package, only its charge will be evaluated and the charge of items within it will be ignored.

Presenting Package Hierarchy While Adding items

The staging dialog for any component item shows the name of its parent package directly below the item’s description. There is the potential to stage multiple items from multiple packages at both the service level and account level. Showing the parent’s name helps you keep track of the items and the parent packages to which they belong.

Show Picture

UG template for Help

In addition to this, you can see hierarchical relationships within the list of staging dialogs by following the blue line that runs vertically to the left of those dialogs. The top-level package has no blue line. The line starts with component items (including packages embedded within a higher level package) and gets thicker/bolder with each lower level.

Show Picture

UG template for Help

Auto-staging for items with Required Fields

When you add a package that has child items with required fields, the staging dialogs for those items are automatically displayed without having to click the Select Package Items to Stage button.

Show Picture

UG template for Help

Note

Only items with undefined required fields are auto-staged; however, you can choose to stage additional items within the package using the Select Package Items to Stage icon. Items with undefined required fields cannot be removed via the staging dialog (X icon is not available, see above picture). To remove these items:

  • In the Add Item dialog:

    • Define all required fields.

    • Add the staged items to the order.

  • In the Order Details view:

    • In the left pane, expand the package and select the item.

    • In the right pane, click the remove (trash can) icon to remove the selected item.

Web Service/API

The API logic enforces the following exclusivity scenarios:

  • You cannot manually specify your own hierarchy of items in the order. Any specified child items that have a CatalogID/SKU not matching a child item configured for the direct parent package in the Product Catalog will be an error.

  • IDI Desktop Client and the web API do not allow the same CatalogID/SKU to be placed inside a package more than once.