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

Commerce System Attributes

OVERVIEW

Commerce System attributes are used in rules as inputs to determine certain behavior.

Besides the attributes listed in the table below, other User attributes, including user phone, user email, user billing city, and so on (from the User Administration page) are also available.

ADMINISTRATION

System Variable Name Description
_system_date

Returns the current date. Data type is string.

Example: 6/20/2011 15:48:32

_system_current_document_number

Returns the current document number. Data type is string.

Example: A line item document could have a value of "3".

_system_current_document_language

Returns the current document language. All documents in a transaction are in the same language.

Example: "en" stands for English - United States.

_system_current_document_currency_pref

Returns the current document currency preference. Data type is string. All documents in a transaction have the same currency preference.

Example: Currency preference code of "USD", which stands for United States Dollars.

_system_base_currency

Returns the base currency of the Host Company. Data type is string.

Example: Currency preference code of "USD", which stands for United States Dollars.

_system_currency_conv_rate

Returns the currency conversion rate for the Host Company. Data type is float.

Example: 2.7

_system_company_name Returns the name of the Host Company. Data type is string.
_system_step_var Returns the variable name of the current step that the transaction is in. Data type is string.
Example: "test_step1".
_system_buyside_id

Returns the unique numeric buyside ID of the current transaction. Data type is string.

Example: "901234"

_system_add_from_catalog_action

Returns the add from catalog action name. Data type is string.

Example: "Add Line Items".

_system_transaction_counter_value Returns the transaction counter value. Data type is Integer. You can map an attribute to this system-defined attribute in the Modify tab.
_system_user_session_id Returns the unique session ID of the user who is currently logged into the application. Data type isstring.
_system_user_partner_session_id Returns the partner session ID of the current user. Data type is string.
_system_user_name

Returns the current user's name (first name and last name). Data type is string.

Example: John Smith.

_system_user_login

Returns the current user's login. Data type is string.

Example: jsmith

_system_user_email

Returns the current user's email address. Data type is string.

Example: abc@xyz.com

_system_user_currency_pref

Returns the current user's currency preference. Data type is string.

Example: USD

_system_user_number_format

Returns the number format preference of the current user. Data type is string.

Example: ####.##

_system_user_date_pref

Returns the date format preference of the current user. Data type is string.

Example: MM/dd/yyyy h:mm a

_system_user_time_zone

Returns the time zone of the current user. Data type is string.

Example: US/Eastern

_system_user_units

Returns the units of the current user. Data type is string.

Example: Metric

_system_user_groups

Returns a plus delimited string of all the groups that the current user belongs to. Data type is string.

Example: marketing+sales_rep+order_fixer+vpsales

_system_user_type Returns the system defined type of the current user.
_system_user_is_notify_email

Returns a Boolean value for the current user's notification preference. Data type is Boolean.

Example: true

_system_modify_order

This System attribute is always initialized to a constant value (-1) for the original line items. For copied line items, it returns the value as a constant value (1).

In case of a successful Reconfigure action, the value changes to the constant (2).

In case of existing quotes, adding the Copy Line Item action, initializes the attribute to (-1) for all line items.

This variable is typically used in scripts, and the values for the variable are stored after the action is performed.

_system_selected_document_number

Returns the document number of the selected line item within the main document. This helps identify the line item selected for all actions.

Selecting multiple line items returns the document numbers of the line items in the form of a tilde-delimited string. This is typically used in scripts and the values of the variable are not stored after the action is performed.

This variable is populated in all Commerce actions in the main document. The FullAccess user is able to access a tilde-delimited list of selected documents in the Modify tab and the advanced modification and advanced validation functions of main document Commerce actions.

This tilde-delimited list of document numbers cannot be returned from the Advanced Modification.

_reconfiguration_date

Returns the reconfiguration date of the model. This is automatically populated each time the user runs reconfiguration.

Example: In case of a non-configurable line item, Parts, the system returns a constant value (-1). The variable is initially initialized to January 1, 1970 for parts and models, yet to be re-configured.

If reconfiguration fails, this date remains unchanged.

_last_modified_date Returns the last modified date of the sub-document; string "1" for the first modify and "2" for the second modify. This variable is initially initialized to January 1, 1970 for sub-documents; once the sub-document is modified, it is reset to the new modify date.
_is_recommended_price

Returns a Boolean value to help identify whether the line item has a recommended price.

True indicates that the price is derived from the advanced pricing in the Recommended Items rule.

False indicates that the price is not derived from the advanced pricing in the Recommended Items rule.

ClosedAdding Commerce System Variables to Documents

You can display Commerce System attributes on documents or make them hidden and only use them in document calculations. When Commerce System attributes are mapped to document attributes, the variable values are determined once, at document creation time. To gain access to System attribute values at other times in a document's existence, you can return them in functions associated with Modify Commerce actions.

  1. Create a Document attribute.

    Most Commerce System variables are string types that can be quickly displayed using a text attribute.

    For more information about creating an attribute, see Commerce Attributes.

  2. To associate a system variable value with the attribute, do one of the following:
  3. Click Finish.

ClosedXML Example


NOTES

RELATED TOPICS

Related Topics Link IconSee Also