You are here: Commerce Process > Commerce Documents > Commerce Document Attributes

Commerce Attributes

OVERVIEW

Commerce attributes are the foundation for input fields for Commerce documents. They apply to a Transaction as a whole, or its specific line items, depending on in which Commerce document the attribute is created.

CPQ Cloud provides default attributes as well as default attribute sets, for collecting data such as billing, shipping, credit card and pricing information.

You can also generate custom Commerce attributes. Custom Commerce attributes are created one document at a time.

It is not possible to copy attributes from one document to another.

In general, for attributes to appear on documents, they must be included in Document views on a layout. However, you can change the access to an attribute, choose to hide or show it, use an attribute that isn't on a layout. For more information, see Accessing, Hiding, and Reading Attributes.

Basic Attribute Categories:

ClosedBasic Attributes


ClosedAttribute Sets


ClosedAdditional Attribute Types

The following attribute types are not in the Attribute Type field in the Attribute Editor when adding a new attribute.


ADMINISTRATION

ClosedAdding Attributes to a Document

By default, the Document attributes are listed on the Attribute Lists page in the order that they are created. Composite attributes are always listed last.

  1. Click Add on the Attributes List page.
  2. Enter the Label and Variable Name of the attribute.

  1. Choose the Attribute Type from the drop-down.
  2. Click Cancel to return to the Attributes List page without saving changes or click Add to save changes and open the Attribute Editor. The other fields on the Attribute Editor page depend on the attribute type.
    1. After creating Document attributes, select one of the attributes to set a tab name for the Commerce Process.

      Tabs are used to designate separate transactions on the Commerce Manager List page.
      Variable Names cannot be edited after they are created.

ClosedEditing a Document Attribute

  1. Choose the attribute or attribute set you want to edit on the Attributes List page.
  2. Do one of the following:
  3. Edit any of the fields displayed in the Attribute Editor.

    To edit the default value, access rights, layout or product mapping, click a tab name and edit the information displayed.
  4. Click Apply to remain on the current page or click Update to return to the Attributes List page. Click Cancel to return to the Attributes List page without saving changes.
    1. Document attributes can be edited at any time.
      Edits are not visible until the process is deployed (or re-deployed).
      Previously created variable names appear read-only because they are not editable.

ClosedDeleting a Document Attribute

  1. Select the checkbox next to the desired attribute.
  2. Click Delete.
  3. If you want to delete an entire attribute set, click the <attribute_set_name> and click Delete All.
    1. If you delete attributes after deploying, re-map and repopulate your data columns. Otherwise, the Transaction Manager will not work correctly.
      The remaining attribute(s), if any, will be automatically reordered when the page reloads.
      When an attribute is deleted, it is simultaneously deleted from all document views. It is not possible to recover the deleted data.

      System attributes cannot be deleted. nor can you delete individual attributes from within an attribute set.

ClosedSetting a Default Value for an Attribute

  1. ClosedNavigate to the Attribute Editor page.

    1. Click Admin to go to the Admin Home Page.
    2. Click Process Definition in the Commerce and Documents section.

      The Processes page appears.

    3. For the process you are interested in, confirm that Documents is selected in the Navigation drop-down menu, and click List.

      The Document List page appears.

    4. For the main document, confirm that Attributes is selected in the Navigation drop-down menu, and click List.

      The Attribute List page appears.

    1. Click the name of the attribute for which you want to set a default value.

      The Attribute Editor appears.

  2. Select the Default tab.
  3. Click one of the following radio button options:

    Radio Button Options Description
    None To not specify a default value, click the None radio button option.
    System Variable To set a default value based on a System attribute, click this radio button option and choose the System attribute you want to auto-populate the field.
    Data To set a static value, click this radio button option and enter a default value.
    Define Function To define a dynamic default value, click this radio button option and click Define Function. Use this advanced function editor to create a function that sets the default value into the field.
    Select a Template This is only an option for Rich Text attributes. If this option is chosen, then the Rich Text attribute is pre-populated with the selected template.
  4. Click Apply to remain on the current page or Update to save changes and return to the Attributes List page.
    1. Defaults cannot be set for the following types of actions: Summation, Read-Only Text, HTML File Attachment, Composite.

ClosedViewing Related Rules

  1. ClosedNavigate to the Attribute List page.
    1. Click Admin to go to the Admin Home Page.
    2. Click Process Definition in the Commerce and Documents section.

      The Processes page appears.

    3. For the process you are interested in, confirm that Documents is selected in the Navigation drop-down menu, and click List.

      The Document List page appears.

    4. For the main document, confirm that Attributes is selected in the Navigation drop-down menu, and click List.

      The Attribute List page appears.

  1. For an attribute with List in the Related Rules column, click List.

    The List of Related Rules page appears.

  2. Open the related rules using one of the following methods.
    • Click Edit Function to open a function editor where the attribute is referenced, with the relevant script. OR
    • If there is no Edit Function link, click the Label link to view the related rule.

      In this example, click Return to Opportunity) to open the relevant Admin Action page and click Define Destination Rule to open a Function Editor with the relevant script.


ClosedFormulas in Reconfiguration Scenarios

The Reconfigure action is split into one parent (Reconfigure) and one sub-action (Reconfigure Inbound). This eliminates the need for conditionals to segregate logic.


ClosedPrevent Posting of Read-Only Fields

An internal property gives CPQ Cloud customers the option to prevent Commerce read-only fields from being posted back to the server after a Commerce action is invoked.

While enabling this property will have nominal impact on performance, it is recommended not to post information back to the server when the data will not have changed since it was last posted.

To enable this property, open a ticket on My Oracle Support.


NOTES

    Summation, composite, and read-only text, as well as HTML attributes, are not editable by the user.

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

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

    This affects both Mobile and Desktop.
    You cannot change the type of a Menu attribute if it is already on a layout.

    User are prevented from creating or adding Quotes from Configuration to Commerce if mandatory items are missing.
    NULL and blank Integer values are treated as separate values.

    - NULL= 0
    - Blank = ""

    If you use logic that tests for NULL values in rule conditions or BML, this logic should be updated.

    Using "null" as an attribute value is strongly discouraged.

RELATED TOPICS

Related Topics Link IconSee Also