1. Modeling
  2. Build Models
  3. Actions
  4. Order List action

As a workspace administrator, you can use the Order List action to change the order of a list to match one that you set in a module. This is useful when you need a specific order for list items that you can easily update. For example, you can order an employee list based on start date or performance ranking. 

To create an Order List action, you must have an input module into which you enter the order you want the list to have.

The input module must have:

  • A single list, with at least one list item
  • At least one line item with the format Text: General, Number, Date, or Time Period

You can then enter values for the list items against the line item or items. You can then set up an order list action.  If there's more than one line item in the module, you can create multiple order list actions.

You can use Order List to order both flat and composite lists. The action orders the lowest level of the list. If you use a child list to order, the list items sort within the branches of the parent list. For example, here, the items on the child list, Employees, are ordered within the parents to which they're allocated: Canada and US.

An Employee performance dashboard displaying an Order performance action button and a grid. The grid has employees names on rows, divided by the parent countries, Canada and US. The line item rating is on columns and values are entered against each employee. The employees display according to the ascending values of the ratings, within their parents. So the child items under Canada display in order of the values 4 and 5; but the order starts over under US, with the values 2, 3, 5.

Note: You can only run the Order List action on lists with fewer than 1 million items.

Line item formats and value orders

When you run an Order List action, the list items order according to the values you entered in the module. You can choose for the order to be ascending or descending when you create the Order List action.

The action orders items by alphabetic order for Text: General format line items, numeric order for Number format, and date order for Date and Time Period formats.

If you format a line item as Text: General, you can enter both numerals and letters in the line item. For example, if you enter 1, 2, 31, 11, 3, and run the action, the list items sort by alphabetic order: 1, 11, 2, 3, 31.

If there are multiple repeated values, the action respects the original order for those values. Empty cells are treated as zero. Negative numbers or zeros display at the top of the list for ascending order, and at the bottom of the list for descending order. A list that includes -2, 1, 0, 8, -15 sorts for an ascending order as -15, -2, 0, 1, 8.

If you enter both numerals and letters in the same line item for a list, the Order List action treats the numerals as lower than any letters. For example, you if you enter a, 2, z, 11, c, and run an ascending Order List action on these values, they sort as 11, 2, a, c, z.

If you enter numbers as words in a Text: General format line item, Order List still sorts them alphabetically. So, five comes before one in ascending sort.

Example

You can use Order List to order employees by performance rating. Insert an Employee performance module that has an Employees list on one dimension and a Rating line item on another. Set the line item to either Text: General or Number, and enter numerals for the employee ratings.


Rating
Briana Builder5
Stefan Sales1
Kieran Contributor4
Anthony Analyst4
Sylvia Presales3

Add an Order List action, with ascending order, based on the Ratings line item in the Employee performance module. When you run the action, the list sorts according to the values in Employee performance. This applies everywhere you use the list in the model.


Rating
Stefan Sales1
Sylvia Presales3
Kieran Contributor4
Anthony Analyst4
Briana Builder5

If you publish the action to a dashboard and along with a list, you can see the list reorder when you select the action button.