Manage Custom Attributes

Attributes and attribute groups are created and managed in the Order Management Attribute Manager. Attribute values for specific objects are set on the pages used to edit those objects. You can specify whether you want attributes to be visible, searchable, editable, or clonable. Note that if the Clonable option is selected, then that attributes can be copied when executing an even swap, reshipment, or adjustment in Customer Service Center.

Note: A custom attribute, WarehouseBatchPrinter, can be created in Settings > Attributes to enable batch printing from different printers in a warehouse location. See Configuring Multiple Printers for Batch Printing.

Creating Custom Attributes

To create a custom attribute, follow these steps:

  1. In Order Management Administration: click Settings > Attributes.
  2. From the Attribute Manager, select an attribute group in the list on the left side of the page. The new attribute belongs to the selected group. To not assign the attribute to any group, select Ungrouped.
  3. Enter a name for the attribute in the text box above the Attribute Group list.
  4. Select Attribute from the list next to the text box.
  5. Click Add. A new Edit Legacy Attribute Information page opens.
  6. Edit the various fields on the page as described in Editing Custom Attributes.
  7. To save the new attribute, click Update. (Clicking Cancel discards changes to the attribute fields, but does not delete the attribute itself.)
  8. Create the value, such as string, dropdown list, number for the Choice Values attribute.

Editing Custom Attributes

To edit a custom attribute, first search for it in one of the following ways:

The following table describes the fields used to define an attribute:

Field Type Description Required/ Optional
Group Dropdown list The attribute group to which the attribute is assigned Optional (the empty list item is selected if not assigned to a group)
Id Text An identifier used to reference the attribute in code Optional (required for use in templates or web service/ API calls)
Label Text An identifier used to reference the attribute in the various user interface pages. Required
Short Label Text An abbreviated identifier used to reference the attribute in the various Order Management pages. Optional
Description Text A detailed description of the attribute Optional
Tag Text A text field that can be referenced in code as desired Optional
Multiple Values Checkbox If checked, then the attribute can store multiple values. If not checked, then the attribute can only hold a single value. (Default: unchecked) Optional
Range Values Checkbox If checked, then the attribute can store a range of values. If not checked, then the attribute can only hold a single value. (Default: unchecked) Optional
Other Checkbox Only affects choice value attributes. If checked, then the attribute can hold a value other than the ones defined in its list of choice values. (Default: unchecked) Optional
Visible Checkbox If checked, then the attribute is visible in the Order Management page when viewing an object of an associated type. If unchecked, then it's hidden from the page. (Default: checked) Optional
Searchable Checkbox If checked, then the attribute is searchable. If unchecked, then it isn't searchable. (Default: unchecked) Optional
Clonable Checkbox If checked, then the attribute can be cloned when executing even swaps, reships, and adjustments in Customer Service Center. If unchecked, then the attribute is not cloned. (Default: unchecked) Optional
Publicly Visible Checkbox If checked, then the attribute can be made visible to Customers when viewing an object of an associated type. If unchecked, then it's hidden from customers. (Default: unchecked) Optional
Publicly Searchable Checkbox If checked, then customers can search on the attribute. If unchecked, then customers cannot search on it. (Default: unchecked) Optional
Publicly Editable Checkbox If checked, then customers can edit the attribute when viewing an object of an associated type.

This feature includes editing of order-level and item-level custom attributes in Customer Service.

If unchecked, then customers cannot edit it. (Default: unchecked)

Optional
Configuration Type List The base datatype of the attribute value. Options include: Required
Configuration Subtype List The display format of the attribute's value. Only applies to attributes of type String or Choice Value.
  • String Subtypes:
    • Singleline Text
    • Multiline Text
    • HTML
    • XML
  • Choice Value Subtypes:
    • List
    • Check Buttons
    • Choice List
Required
Attach Object List and button Attach the attribute to an object type by selecting the type from the list and clicking Attach to Object. The attached object type appears below the list. You can attach the attribute to multiple object types. The attribute is available to be set on all objects of types to which it is attached. Optional (Attribute must be assigned to at least one object type to be used.)
Note: When creating allocation rules, create a fulfillment site attribute and then associate that attribute to the Fulfillment Site Object type. Then associate the value you want to set for the fulfillment site attribute, such as string, number, or choice value.

Creating Values for Choice Value Attributes

When creating a choice value attribute, you must define the values that can be chosen. Define them via the Choice Values form. After selecting Choice Value as the configuration type, click Update. The Choice Values form appears on the page.

There are two ways to create the values: they can be typed individually, or can be imported as a set of character-delimited values. The methods can be combined. Each method is described following.

Typing values

To enter the values by typing them one at a time, follow these steps:

  1. Type a label for the value in the text field on the right side of the Choice Values form.
  2. Click Add. The value appears in the list.
  3. To open the Edit Value Information window, click the label of the value.
  4. Enter the following information for the value in the corresponding text fields as desired:
    • Code
    • Label (required)
    • Short Label
    • Description
    • Tag
    • Order (required)
    The Order defines the display order of the attribute's values. Values with lower numbers appear first; the order of values with equal numbers can vary.
  5. Click Update.
  6. Repeat the process for each value.

Importing values

To import a set of values, either copy them from a character-delimited file or type them as a set of character-delimited fields, one value per line. Valid delimiters include tab, pipe (|), and comma (,). Follow these steps:

  1. Click Import on the right side of the Choice Values form.
  2. The Label field is always the first field on each line. Select the order of the other fields to import by selecting each in turn from the dropdown list that appears next to the previous field. Only the Label field is required. If you don't enter an Order value, it defaults to 0.
  3. Type or paste the value data into the text box, one Value per line, fields separated by delimiter characters.
  4. Click Import.

You can change the display order of values in the list using the red arrows on the right side of each value's row. Doing so automatically assignsorder numbers to all values in the list.

To delete a value, click the trash can icon on the right side of its row. To delete all values, click Delete All on the right side of the form. Deletions can't be undone.

Creating Custom Attribute Groups

To create a custom attribute group, do the following:

  1. Enter a name in the text box above the Attribute Group list.
  2. Select Group from the list next to the text box.
  3. Click Add. The new group appears in the list in alphabetical order.
Note: When an attribute group has been created, it can't be deleted. However, it doesn't have to contain any attributes.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. By continuing to use this site you are giving us your consent to do this.