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.

System Variable Name

Data Type

Description

_auto_update_triggered_from

String

Value available only for autoupdate function of the main document; specifies variable name of the attribute triggering auto update

_mobile_device_enabled

Boolean

The Boolean value is "True" if the user is licensed for mobile, on a recognized mobile device, and on a mobile layout

_system_account_id_field

String

Unique Account Id

_system_add_from_catalog_action

String

Current Add From Catalog Action

_system_async_payload

String

Asynchronous Payload from SOAP, transient value, only valid during receiving asynchronous calls

_system_base_currency

String

Supplier's Base Currency

_system_buyside_id

String

Current Unique Buy-Side ID

_system_company_name

String

Current User's Company Name

_system_currency_conv_rate

Float

Supplier's Currency Conversion Rate

_system_current_document_currency_pref

String

Current Document's Currency Pref

_system_current_document_language

String

Current Document's Language

_system_current_document_number

String

Current Document Number

_system_current_pp_name

String

Current Participant Profile's Name

_system_current_step_var

String

Current Step's Variable Name

_system_current_user_language

String

Current User's Language Preference

_system_date

String (date)

Current Date

_system_filtered_document_numbers

String

List of Filtered Document Numbers in line item

_system_host_company_full_name

String

Host Company Full Name

_system_modify_order

String

Current Modify Order - "1" for the first modify and "2" for the second modify

_system_process_name

String

Current Process Name

_system_selected_document_number

String

Document Number of selected line item

_system_subscription_order_enabled

Boolean

Boolean value is "true" when the subscription order is enabled

_system_supplier_company_name

String

Supplier's Company Name

_system_transaction_counter_value

Integer

Current Process Transaction Counter

_system_transaction_is_locked

Boolean

Boolean value is "true" when the Transaction is locked for any user

_system_transaction_lock_user

String

Name of user who locked the Transaction; if the Transaction is unlocked, the value is null

_system_transaction_locked_date

String (date)

Date the Transaction was locked; if the Transaction is unlocked, the value is null

_system_user_bill_address

String

Current User's Billing Address

_system_user_bill_address_2

String

Current User's Billing Address 2

_system_user_bill_city

String

Current User's Billing City

_system_user_bill_company

String

Current User's Billing Company

_system_user_bill_company_2

String

Current User's Billing Company 2

_system_user_bill_country

String

Current User's Billing Country

_system_user_bill_email

String

Current User's Billing Email

_system_user_bill_fax

String

Current User's Billing Fax

_system_user_bill_first_name

String

Current User's Billing First Name

_system_user_bill_last_name

String

Current User's Billing Last Name

_system_user_bill_phone

String

Current User's Billing Phone

_system_user_bill_state_province

String

Current User's Billing State/Province

_system_user_bill_zip

String

Current User's Billing Zip

_system_user_currency_pref

String

Current User's Currency Pref

_system_user_date_pref

String

Current User's Date Preference

_system_user_email

String

Current User's Email

_system_user_fax

String

Current User's Fax

_system_user_first_name

String

Current User's First Name

_system_user_groups

String

Current User's Groups

_system_user_is_notify_email

Boolean

Current User's Notify Email

_system_user_job_title

String

Current User's Job Title

_system_user_last_name

String

Current User's Last Name

_system_user_login

String

Current User's Login

_system_user_name

String

Current User's Name

_system_user_number_format

String

Current User's Number Format

_system_user_partner_session_id

String

Current User's Partner Session Id

_system_user_phone

String

Current User's Phone

_system_user_session_id

String

Current User's Session Id

_system_user_ship_address

String

Current User's Shipping Address

_system_user_ship_address_2

String

Current User's Shipping Address 2

_system_user_ship_city

String

Current User's Shipping City

_system_user_ship_company

String

Current User's Shipping Company

_system_user_ship_company_2

String

Current User's Shipping Company 2

_system_user_ship_country

String

Current User's Shipping Country

_system_user_ship_email

String

Current User's Shipping Email

_system_user_ship_fax

String

Current User's Shipping Fax

_system_user_ship_first_name

String

Current User's Shipping First Name

_system_user_ship_last_name

String

Current User's Shipping Last Name

_system_user_ship_phone

String

Current User's Shipping Phone

_system_user_ship_state_province

String

Current User's Shipping State/Province

_system_user_ship_zip

String

Current User's Shipping Zip

_system_user_time_zone

String

Current User's Time Zone

_system_user_type

String

Current User's Type

_system_user_units

String

Current User's Units

_system_valid_stages

String

Contains the enabled stage values selected for the applicable Commerce process.

 

Administration

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 the topic Commerce Attributes.

  2. To associate a system variable value with the attribute, do one of the following:
    • For Text attributes: After defining the attribute name, variable name and attribute description, click the Default tab and enable the System Variable radio button. Then highlight the system variable you want to display.
    • For Numeric attributes: After defining the attribute name, variable name, attribute description, and any validation fields, click the Default tab and enable the Function radio button. Click Define Function, mark the system variable you want to display, scroll to the bottom of the window and click Next. In the Editor window, enter: return (<_variable_name>);

  3. Click Finish.

    ClosedXML Example 

    <current_date><![CDATA[ 05/31/2002 12:54PM ]]></current_date>
    <supplier_base_currency><![CDATA[ USD ]]></supplier_base_currency>
    <user_currency_pref><![CDATA[ AUD ]]></user_currency_pref>
    <currency_conv_rate><![CDATA[ 1.79624 ]]></currency_conv_rate>

ClosedAdd a Commerce Main Document Revenue Category Attribute

Complete the following steps to add a Revenue Category attribute to the Commerce main document.

  1. Log in to Oracle CPQ and open the Admin Home page.

  2. Click Process Definition in the Commerce and Documents section.

  3. Select Documents for the applicable Commerce process, and then click List.

  4. Select Attributes for the main document, and then click List.

  5. Click Add.

  6. Select Revenue Category from the Attribute Type drop-down menu.

    Select 'Revenue Category' Attribute Type

  7. Click Add.

    The Revenue Category (_revenueCategory_t) Single Select Menu is created with 'New', 'Renew', and 'Expansion' menu options.

    Revenue Category Attribute Editor

 

NOTES

You can use Numeric attribute types to store Commerce system variables, as long as the variable value is converted from string type to numeric type.
When Commerce system variables are included in a document, the system variable values are also included in the XML generated for the document. The values appear in XML tags named with the attribute variable names used to store system variable values.

 

Related Topics

Related Topics Link IconSee Also