Configuration Text Attributes

Overview

Text, float, and integer attributes are all edited in a Text Attribute Editor page, although different options appear depending on which type of attribute is being edited. Text fields are displayed as a text field or text area that the user can populate with data. They can also be displayed as Single Select Menus, Multi-Select Menus, or Single Select Pick Lists.

The following images show the different display types for Text attributes.

Legacy Display Type: Text or Text Area
JET Display Type: Text or Text Area

Administration

Add a Text Attribute Watch Video

Navigate to the Attributes Administration List page.
1. Click Admin to go to the Admin Home Page.
2. Click Catalog Definition in the Products section.
  
  The Supported Products page opens.
3. In the Navigation column, select Attributes and then click List.
  
  The Attributes Administration List page opens.
Click Add. The Attribute Editor page opens.

Enter information for the fields listed below.

Note: Fields preceded by an asterisk (*) are required.

Field	Description
*Name	Enter the attribute name. The Name value appears as the attribute label when this item is added to a Configuration layout.
*Variable Name	The Variable Name field populates automatically. Variable names can only contain alpha-numeric characters and underscores. The entry can be changed before saving, but after saving the value is read-only. Note: Customers should not use any of the following names for Configuration attribute variable names. Using these values may cause issues with customer configurations and could possibly alter site functionality. action_id bm_cm_process_id _bom_ bs_id commerce_doc_url_params commerce_list_id document_id document_number folder_id formaction from_config scrollTop shopping_cart_id step_id token version_id
*Category	Select Configurable Attribute or Signed Punch-in Attribute. A Signed Punch-in Attribute functions identically to Configuration attributes except they require verification of digital signature data before pricing data is provided to the end customer. See Signed Punch-in Attributes for more information.
Array Type	Select this checkbox if the attribute can be used as a column in an array set. Refer to Managing Arrays and Sets for more information.
*Data Type	Select Text.
Attribute Type	Select Text Field, Single Select Menu, Multi Select Menu, or Single Select Pick List. Signed Punch-in Attributes cannot be Array attributes, Multi Select Menu attributes, Single Select Menu attributes, Picklist attributes, and HTML attributes. Additional sections are displayed for Single Select Menu, Multi Select Menu, or Single Select Pick List attribute types. Refer to the following topics for more information: Menu Attributes Single Select Pick Lists

Click one of the following:
- Cancel to return to the Attributes List page without saving changes.
- Add and New to save changes and create another attribute.
- Add to save changes and open the Text Attribute Editor, proceed to Edit a Text Attribute.

Edit a Text Attribute Watch Video

Navigate to the Configurable Attributes Administration List page.
1. Click Admin to go to the Admin Home Page.
2. Click Catalog Definition in the Products section.
  
  The Supported Products page opens.
3. In the Navigation column, select Attributes and then click List.
  
  The Attributes Administration List page opens.
Click the name of an attribute with Text in the Attribute Type column, or create a new attribute.

The Text Attribute Editor page opens.

Note: The Attribute Editor defines the default display type properties for all layouts.

Main Information

Field	Description
Name	The name of the attribute The Name value appears as the attribute label when this item is added to a Configuration layout.
Display Type	The following Display Types are available: Legacy Display Type: Text, Text Area JET Display Type: Text, Text Area Text Area allows you to enter more than 255 characters in the field.
Text Area Fields	Number of Rows: Enter the number of rows for the text area Number of Columns: Enter the number of columns for the text area
Description	The attribute description. When an attribute Help Icon is displayed on a layout, the description appears when the user hovers over the help icon. Refer to Help Icons for more information.

Properties

Field	Description
Set Type	None: The user can input any value without encountering an error message. Set: A recommendation rule can change the value entered by the user unless the attribute is locked by the user. Auto Lock - When Auto Lock is on, user selections made to an attribute after a Recommendation rule “Set” the attribute to a different value will be retained if the Recommendation Rule is fired again (such as upon an Update). Auto Lock Example Recommendation rule 1 runs and sets Attribute X to A. The user then sets Attribute X to B. The user then clicks Update, and Attribute X retains its value of B. The recommendation message defined in Recommendation rule 1 for option A will appear. Auto Lock is on by default for all Recommendation rules that have a set type of “Set.” The Admin can turn Auto Lock off within an attribute by selecting “Set” for the set type and by not selecting Auto Lock. If this were done to Attribute X, the user would experience the following: Recommendation rule 1 runs and sets Attribute X to A. The user then sets Attribute X to B. The user then clicks Update, and Recommendation rule 1 runs and sets Attribute X to A. Forced Set: A recommendation rule will change the value of the attributes regardless of what the user enters and if the attribute is locked or not.
Required	This will require the user to enter a value before proceeding to a commerce transaction.
Hidden	This attribute will not appear to the user. It can be used in rules.
Auto Update	This will by updated by the system without the user invoking an action.
Hide Transaction	This attribute is hidden within a commerce document.
Status	Active: An attribute that is active will appear to the buyer and/or be included in rules. All attributes are active by default. Inactive: An inactive attribute cannot appear in a rule to the user. Internal: An internal attribute will only appear to FullAccess users. Show Start/End Dates: Click to specify how long the attribute will remain in the chosen status. If no duration is specified, the attribute maintains its status until the administrator changes it.

Default Data

Select one of the following options:
- If translations are required, click Translations and provide translated values for the label and description fields.
- Click Apply to save changes and remain on the Attribute Editor page.
- Click Update to save changes and return to the Configurable Attributes Administration List.
- Click Update and New to define another attribute.
- Click Back to return to the Configurable Attributes Administration List without saving changes.

Notes

NULL and blank Integer values are treated as separate values:
- NULL= 0
- Blank = ""
Using NULL as an attribute value is strongly discouraged.
If you use logic that tests for NULL values in rule conditions or BML, confirm that the logic takes this difference into account.

Attribute range calculations are validated on the Value Punch-In.

Example: If the value was passed in the URL to the Configuration, it will be validated and an error message will appear.

This affects both Mobile and Desktop.

Have as few attributes "auto-update" as possible.

Configuration Text Attributes

Overview

Administration

Notes

Related Topics