Agreement Attributes

Overview

Agreement Attributes support the attributes that are used to create a Price Agreement from a sales agreement-type CPQ transaction. Agreement Attributes provide the necessary mapping for Commerce attributes to the corresponding pricing attributes for Price Agreements. CPQ provides standard attributes and attribute mapping for Header, Line, and Charge entities in Agreement Attributes.

The Agreement Attributes page lists standard Agreement Attributes that are provided by CPQ.

Agreement Attributes List page

Item

Description

1

Navigate to Pricing Portal.

2

Click Actions to Manage Columns for the Agreement Attributes list. Select Custom Charge Attributes can be used to add you custom Charge attributes to Agreement Attributes.

3

Enter search criteria to filter agreement attribute results, which remain persistent while navigating within agreement attributes.

4

Sort agreement attributes using Price Entity, Name, Data Type, or Type column headers.

5

The Price Entity column indicates if the agreement attribute is a Header, Line, or Charge attribute.

6

Click the appropriate Name link to edit an existing agreement attribute.

7

Click the agreement attribute line ellipsis and select Edit to edit an existing agreement attribute.

Note: Standard agreement attributes can’t be deleted.

Administrators can navigate to the Attribute Agreement page to add and manage mappings for Agreement Attributes.

Agreement Attribute Page

Item

Description

1

Navigate to the Agreement Attributes list page.

2

Navigate to Next or Previous charge attribute in the agreement attribute list or filtered agreement attribute search results list.

3

Data Type: Currency, Date, or String

4

Pricing Entity: Header, Line, or Charge

5

Type: Standard or Custom

6

Select Edit to add, reorder, and delete attribute mappings. Select Manage Columns to manage the displayed columns.

7

Mapped Data Sources

Standard Agreement Attributes

CPQ provides the following standard agreement attributes to enable customers to author and negotiate a new sales agreement within CPQ using a productized CPQ quote for agreement. Standard agreement attributes and mappings cannot be deleted or inactivated.

Pricing Entity

Attribute Name

Variable Name

Data Type

Description

Header

Account

_account

String

Default to the Customer Name of the current.

Header

Account ID

_accountId

String

Default to the Customer Id of the current transaction.

Header

Agreement Description

_agreementDescription

String

Default to the Transaction Description of the current transaction.

Header

Agreement End Date

_agreementEndDate

Date

Default to the Contract End Date of the current transaction.

Header

Agreement Name

_agreementName

String

Default to the Contract Name of the current transaction.

Header

Agreement Number

_agreementNumber

String

A new sales agreement created will use this mapping to write back the created agreement number to the mapped quote attribute. Default to the Contract ID (_s_contractID_t).

Header

Agreement Start Date

_agreementStartDate

Date

Default to the Contract Start Date of the current transaction.

Header

Agreement Status

_agreementStatus

String

Current status of the Agreement.

Header

Source Transaction ID

_sourceTransactionId

String

Default to the Transaction Number of the current transaction.

Line

Item Contract End Date

_itemContractEndDate

Date

Default to the Contract End Date of the current transaction line.

Line

Item Contract Start Date

_itemContractStartDate

Date

Default to the Contract Start Date of the current transaction line.

Line

Part Number

_partNumber

String

Default to the Part Number of the current transaction line.

Line

Product List Price

_productListPrice

Currency

Default to the Price (List) of the current transaction line. This refers to the List price of the Product price.

Line

Product Net Price

_productNetPrice

Currency

Default to the Price (Net) of the current transaction line. This refers to the Net price of the Product price.

Line

Product Price Period

_productPricePeriod

String

Default to the Pricing Engine Price Period of the current transaction line. This refers to the Price period of the Product price.

Line

Product Price Type

_productPriceType

String

Default to the Price Type of the current transaction line. This refers to the Price type of the Product price.

Line

Rate Plan Number

_ratePlanNumber

String

Default to the Applied Rate Plan Number of the current transaction line.

Line

Service Duration

_serviceDuration

Integer

Service Duration of the agreement.

Line

Service Duration Period

_serviceDurationPeriod

String

Service Duration Period of the agreement.

Charge

Charge Definition Code

_chargeDefinitionCode

String Array

Default to the Charge Definition Code (_chargeSet_chargeDefinitionCode in Charge Set array set) of the current transaction line.

Charge

Charge Dynamic Pricing Type

_chargeDynamicPricingType

String Array

Default to the Dynamic Pricing Type (_chargeSet_dynamicPricingType in Charge Set array set) of the current transaction line.

Charge

Charge Net Price

_chargeNetPrice

Currency Array

Default to the Net Price (_chargeSet_netPrice in Charge Set array set) of the current transaction line.

Charge

Charge Price Period

_chargePricePeriod

String Array

Default to the Price Period (_chargeSet_pricePeriod in Charge Set array set) of the current transaction line.

Charge

Charge Price Type

_chargePriceType

String Array

Default to the Price Type (_chargeSet_priceType in Charge Set array set) of the current transaction line.

Charge

Charge Type

_chargeType

String Array

Default to the Charge Type (_chargeSet_chargeType in Charge Set array set) of the current transaction line.

Charge

Charge Usage UOM

_chargeUsageUom

String Array

Default to the Usage UOM (_chargeSet_usageUOM in Charge Set array set) of the current transaction line.

Charge

Rate Card Structure

_rateCardStructure

String Array

Default to the Rate Card Structure (_chargeSet_rateCardStructure in Charge Set array set) of the current transaction line.

 

Related Topics

Related Topics Link IconSee Also