Knowledge Base

 View Only

How Set Key and Item Type Key Changes Work

By Carmen Santos posted 09-24-2015 13:21


The Item Type Key allows you to identify an item's type through its Unique ID. The Set Key allows you to identify the type of items within a set. The reason why items of the same type can have customized keys is so they can be differentiated through their IDs, for organization and reporting purposes. 

You can set a default Item Type Key under Admin > Item Types > Edit. This configuration will affect all items in all projects.

The result will be that when creating a set, the Set Key field will be pre-filled with the default value, although it can be changed.

After creating a set, its key can still be changed at any time, through the Explorer Tree > right-clicking the set > Change Set Key

In order to update the key of the pre-existing items within a set, the Regenerate Item IDs option must be selected.

If this option is not selected, the old key is kept for the existing items and only new items will inherit the set's new key.

If Regenerate Item IDs is selected, the existing items are updated with the new key and they are also renumbered.

This option triggers a count that sums all items with the same key in all sets in a project and orders those items by creation date. This will not sum between projects, although the same key can be used in different projects.

Other important considerations:
  • After changing the ID, the items can lose the numbers associated with the previous key. This happens both if the Set Key is changed (and the ID is regenerated) or if the Item Type is converted. 
  • Key types are not reverted through the items' version restore option. 
  • To revert a Key change, the Set Key can be modified again or the item reconverted, though it will be placed in a different order when associated back to the older key type.
  • When moving an item to a different set with the same key, the item will not change its key or its order number.



06-20-2018 14:20

Is it possible to restart numbering at 1 for a Set Key's IDs? For example, if the Set Key was changed away from an initial value, and back to that initial value, can you restart at 1 so that the ID numbers do not just continue to increment?

09-24-2015 13:35

This is one of those subtle features that we've found can be very useful if one is aware of it.  We've used it to some advantage in building filters.  Didn't know you could regenerate keys!  :-)