Overview
In general, for attributes to appear on the UI, they must be placed on the document layout.
However, there are ways to dynamically restrict a user's access to an attribute.
-
The attribute can be hidden or made read-only by changing the document view.
-
The attribute can be hidden for specific product types or product segments.
-
The attribute can be hidden using a access rule.
Administration
Navigate to the Attribute List page.
- Click Admin to go to the Admin Home Page.
-
Click Process Definition in the Commerce and Documents section.
The Processes page opens.
-
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 opens.
-
For the main document, confirm that Attributes is selected in the Navigation drop-down menu, and click List.
The Attribute List page opens.
-
Click the Name of an attribute.
The Attribute Editor page corresponding to the attribute type appears.
-
Click the Document Views tab.
The Document Views tab allows an administrator to control the access level of an attribute in each step for users in each participant profile. You can set each attribute's document view to read/write, read-only or hide.
Refer to Workflow for more details on Steps and Participant Profiles.
The FullAccess user can change the attribute access levels to the following in a certain step/ participant profile:
Access Level Description Read-Only The attribute cannot be edited in this step or participant profile for the current user. Read/Write The attribute value can be edited in this step or participant profile for the current user. Hide The attribute will not be displayed in this step or participant profile to the current user. - Click Apply to remain on the current page or Update to return to the Attributes List page.
Hiding Attributes for Product Types or Product Segments
This functionality enables you to hide attributes in documents for specified line item types (i.e Parts or Models).
Refer to Access Rules to hide actions or attributes when a pre-defined condition is met.
-
Navigate to the Attribute List page.
- Click Admin to go to the Admin Home Page.
-
Click Process Definition in the Commerce and Documents section.
The Processes page opens.
-
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 opens.
-
For the main document, confirm that Attributes is selected in the Navigation drop-down menu, and click List.
The Attribute List page opens.
-
Click the Name of an attribute.
The Attribute Editor page corresponding to the attribute type appears.
- Click the Mapping tab on the Attribute Editor.
-
Select hiding options:
Main Document Attributes:
-
Hide For Parts - Hide this main document attribute when ALL line items are Parts.
If any line items are Models, this main document attribute is displayed. -
Hide For Models - Hide this main document attribute when ALL line items are Models.
If any line items are Parts, this main document attribute is displayed. -
Specific segments - Hide this main document attribute when ALL line items are in the selected Product Family.
Sub-Document Attributes:
- Hide For Parts - Hide this sub-document attribute set in the line item grid and on the line item Details page when the line item is a Part.
-
Hide For Models - Hide this sub-document attribute set in the line item grid and on the line item Details page when the line item is a Model.
-
Specific segments - Hide this sub-document attribute set in the line item grid and on the line item Details page when the line item is in the selected Product Family.
-
-
Click Apply to save changes and remain on the page or Update to save changes and return to the Attributes List page.
Reading Commerce Attributes not on the Layout
If a Commerce attribute is not on the layout, but is not prohibited from view by the user’s Participant Profile, you can still read the current value of the attribute.
Call Bm.getAttrVal("attrVarName") from either the main document or the sub-document to pull the latest value of an attribute by providing its variable name. For sub-document attributes, the attribute value is from the current sub-document, not all sub-documents. Sub-document attributes are not available on a main document page, and main document attributes are not available on a sub-document page.
For example, you may need attribute values for attributes that it wouldn’t make sense to have on the layout for the user to see.
To use this JavaScript function, the attribute cannot be on the layout and cannot be marked as Hide by the user’s Participant Profile.
This functionality depends on the Desktop Transaction caching and Optimized Data Request size features. Turning either Desktop Transaction caching or Optimized Data Request size functionality off will disable this JavaScript function. For more information on these features, see the topic Performance Best Practices.
