Skip to main content
Version: 2.3

Ordering

The Ordering module in the tSM system provides a set of components to manage orders, quotes, and related entities. These components facilitate efficient display and interaction with order data through both tabular layouts and dropdown selections.

Layout Components​

Order Task List​

Order task list in a tabular view with filtering and editing options.

  • Selector: tsm-order-task-list
  • Type: Layout Component
  • Properties:
    • scrollHeight (string = null): Height of the scrollable area.
    • scrollable (boolean = true): Indicates if the table is scrollable.
    • profileCategory (string = null): Category of the profile.
    • openDetailType ('entity' | 'task') = 'task': Type of detail to open.
    • outputContext (EventEmitter = null): Event emitter for output context.
    • showExport (boolean = true): Indicates if export option is shown.
    • showFilters (boolean = true): Indicates if filters are shown.
    • showRefresh (boolean = true): Indicates if refresh option is shown.
    • showPaginator (boolean = true): Indicates if paginator is shown.
    • showManagerColumns (boolean = true): Indicates if manager columns are shown.
    • showProfiles (boolean = true): Indicates if profiles are shown.
    • showManagerSort (boolean = true): Indicates if manager sort is shown.
    • showManagerColor (boolean = true): Indicates if manager color is shown.
    • showListingConfig (boolean = true): Indicates if listing config is shown.
  • Value Example:
{
  "title": "Order Task List",
  "widget": {
    "type": "tsm-order-task-list"
  },
  "type": "layout",
  "config": {
    "pageSize": "10"
  }
}

Related Entity Order List​

Related entity order list in a tabular view with filtering and editing options.

  • Selector: tsm-order-list-related-entity-widget
  • Type: Layout Component
  • Properties:
    • profileCategory (string): Category of the profile.
    • showExport (boolean = true): Toggle to show export option.
    • showFilters (boolean = true): Toggle to show filters.
    • showRefresh (boolean = true): Toggle to show refresh button.
    • showPaginator (boolean = true): Toggle to show paginator.
    • showManagerColumns (boolean = true): Toggle to show manager columns.
    • showProfiles (boolean = true): Toggle to show profiles.
    • showManagerSort (boolean = true): Toggle to show manager sort.
    • showManagerColor (boolean = true): Toggle to show manager color.
    • extendTqlWhere (string): Extended TQL where clause.
    • externalTqlSort (string): External TQL sort clause.
    • disabledOutputContext (boolean = false): Disables output context.
    • hiddenDataViewMode (boolean = false): Toggle to hide data view mode.
    • hideButtonGroup (boolean = false): Toggle to hide button group.
    • refId (string): Reference ID.
    • refType (string): Reference type.
    • ticketId (string): Ticket ID.
  • Value Example:
{
  "title": "Related Entity Order List",
  "widget": {
    "type": "tsm-order-list-related-entity-widget"
  },
  "type": "layout",
  "config": {}
}

Orders Bookmark​

Order list in a tabular view with filtering and editing options.

  • Selector: tsm-orders-bookmark
  • Type: Layout Component
  • Properties:
    • quoteId (string = null): Triggers assignedOrders$ observable when set.
    • personRoles (PersonRole[] = null): Used to filter person roles for an order.
    • accountId (string = null): Used in the editor component but not directly in the main component.
    • customerId (string = null): Used in the editor component but not directly in the main component.
  • Value Example:
{
  "title": "Order List",
  "widget": {
    "type": "tsm-orders-bookmark"
  },
  "type": "layout",
  "config": {
    "pageSize": "10"
  }
}

Order Line Bookmark​

Simple list of order lines in a tabular view.

  • Selector: tsm-order-line-bookmark
  • Type: Layout Component
  • Properties:
    • catalogSpecificationDefaultViewMode (DataViewModeEnum = DataViewModeEnum.TREE_FULLSCREEN): Configured in the editor component with allowed values.
    • order (Order): Triggers additional logic when set.
    • entitySpecificationFilter (any): Complex object with multiple fields.
    • type (OrderLineType): Triggers additional logic when set.
    • layoutingType ('runtime' | 'design'): Determines the layout type.
    • showAddNewConfiguration (boolean = true): Shows add new configuration option.
    • showAddExistsConfiguration (boolean = true): Shows add existing configuration option.
    • showChooseWorkOnService (boolean = true): Shows choose work on service option.
    • showOperation (boolean = true): Shows operation column.
    • showName (boolean = true): Shows name column.
    • showCategory (boolean = true): Shows category column.
    • showWork (boolean = true): Shows work column.
    • showProductId (boolean = true): Shows product ID column.
    • showProductCode (boolean = true): Shows product code column.
    • showPrice (boolean = true): Shows price column.
    • otherOrderLineColumns ({field: string; header: string}[] = []): Array of additional columns to display.
  • Value Example:
{
  "type": "layout",
  "widget": {
    "type": "tsm-order-line-bookmark"
  }
}

Quotes Bookmark​

Simple list of quotes in a tabular view.

  • Selector: tsm-quotes-bookmark
  • Type: Layout Component
  • Properties:
    • accountId (string): Configured in both the main and editor component.
    • customerId (string): Configured in both the main and editor component.
    • filter (any): Configured in both the main and editor component.
  • Value Example:
{
  "type": "layout",
  "widget": {
    "type": "tsm-quotes-bookmark"
  }
}

Order Status Bar​

Overview of the current status of the order with quick switching options.

  • Selector: tsm-order-steps
  • Type: Layout Component
  • Properties:
    • order (Order = null): This input is used to set the order and trigger the status filtering logic.
  • Value Example:
{
  "type": "layout",
  "widget": {
    "type": "tsm-order-steps"
  }
}

Order Task List​

(Repeated entry; see above under Layout Components.)

Note: Only one Order Task List is documented.

Order List​

This entry is already covered under "Orders Bookmark".

Data Components​

Order Select​

Selection of an order from a dropdown list.

  • Selector: tsm-order-lov
  • Type: Select Component
  • Properties:
    • customerId (string): ID of the customer to filter orders.
  • Value Example:
{
  "type": "string",
  "title": "Select an Order",
  "widget": {
    "type": "tsm-order-lov"
  }
}

Order Type Select​

Selection of an order type from a dropdown list.

  • Selector: tsm-order-type-lov
  • Type: Select Component
  • Properties:
    • tsmModuleCode (string): Code for the TSM module.
    • orderTypeCodes (string[]): Array of order type codes.
  • Value Example:
{
  "type": "string",
  "title": "Select an order type",
  "widget": {
    "type": "tsm-order-type-lov",
    "readonly": false
  }
}

Order Status Select​

Selection of an order status from a dropdown list.

  • Selector: tsm-order-status-lov
  • Type: Select Component
  • Properties: (No additional properties specified.)
  • Value Example:
{
  "type": "string",
  "title": "Select an order status",
  "widget": {
    "type": "tsm-order-status-lov",
    "readonly": false
  }
}