TCConfiguration.xml file

Develop > Controller layer > Application developer > Trading subsystem > Extensions to terms and conditions

TCConfiguration.xml file

This table provides details for the attributes that you use to define new term types in the TCConfigurationExt.xml file.
An example TCConfigurationExt.xml file:
<TCConfiguration
xmlns="http://www.ibm.com/xmlns/prod/commerce/9/contract"  
xmlns:ecore="http://www.eclipse.org/emf/2002/Ecore"
xmlns:oa="http://www.openapplications.org/oagis/9" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.ibm.com/xmlns/prod/commerce/9/contract
TCConfiguration.xsd" 
resourceBundle="contract.customTCRB"> 
  
<TCDefinition 
type="SurChargeTC" 
existing="false" 
usage="Contract" 
         
display="true">        
<Display 
displayNameKey="SurChargeTC" 
descriptionKey="SurChargeTCDescription"/>     
<Property 
name="waiveSurCharge" 
column="INTEGERFIELD1" 
         
required="true" 
changeable="true">        
<Display 
displayNameKey="waiveSurCharge" 
descriptionKey="waiveSurChargeDescription"/>     
</Property>     
<Property 
name="surChargeAmount" 
column="FLOATFIELD1" 
         
required="false" 
changeable="true">        
<Display 
displayNameKey="surChargeAmount" 
descriptionKey="surChargeAmountDescription"/>      
</Property>    
</TCDefinition>
</TCConfiguration>  
Attribute Purpose
resourceBundle Location of the resource bundle that contains the literal values for the information displayed in the user interface. The first part of the name indicate the namespace (such as contract). The second part is the name of the resource bundle property file (such as customTCRB).
type Unique identifier for the term. The value of the type attribute for the TCDefinition element must not be "TermCondition" or the same as subtypes of existing terms.
existing True or false value to indicate whether this is an existing term or not. You should always create new terms with this value set to 'false'. Setting the value to 'true' means that this term is being modified by adding additional properties to it. The existing implementation (by EJB bean) must be modified or extended to handle the new properties. Default: false
usage 'Account' or 'Contract 'or 'All' value to indicate whether the type of term applies at the Account or Contract level, or both. This is applicable only when the 'existing' field is set to 'false'.
display True or false value to control whether WebSphere Commerce Accelerator should display this term. Default: true.
displayNameKey Key to the resource bundle for WebSphere Commerce Accelerator to get the display value for the name of the term or property. For example, the 'SurCharge' is the key if the resource bundle has the following content: SurChargeTC=Surcharge TC
descriptionKey Key to the resource bundle for WebSphere Commerce Accelerator to get the display value for the description of the term or property. For example, the 'SurChargeTCDescription' is the key if the resource bundle has the following content: SurChargeTCDescription=Surcharge term and condition is used for specifying the settings related to surcharge.
name Unique identifier for the property. The name should be unique inside a term. However, different terms can have the same property name.
column The column identifier within the TERMCOND table that holds the value for this property. For the supported columns, see Supported columns.
required True or false value to indicate whether the value of this property is required. If it is true, the extended term can be saved unless the value of this property was provided. Default: false
changeable True or false value to indicate whether this property is changeable after the contract is deployed and in 'Active' state. Default: false.
For the changeable flag to have any effect at the property level, the term as a whole must be changeable. Therefore, first ensure that the CHANGEABLE column of the TERMCOND table for this term is set to 1. (0 means no, 1 means yes.)

Related concepts

What's new in terms and conditions
Import and exporting contracts with extended terms defined
Extensions to terms and conditions

Related tasks

Add a term to a contract or account
Create an extended term and condition type for contracts and accounts
Deploy custom extended terms
Update extended terms of a contract or account

+
Search Tips | Advanced Search

Attribute	Purpose
resourceBundle	Location of the resource bundle that contains the literal values for the information displayed in the user interface. The first part of the name indicate the namespace (such as contract). The second part is the name of the resource bundle property file (such as customTCRB).
type	Unique identifier for the term. The value of the type attribute for the TCDefinition element must not be "TermCondition" or the same as subtypes of existing terms.
existing	True or false value to indicate whether this is an existing term or not. You should always create new terms with this value set to 'false'. Setting the value to 'true' means that this term is being modified by adding additional properties to it. The existing implementation (by EJB bean) must be modified or extended to handle the new properties. Default: false
usage	'Account' or 'Contract 'or 'All' value to indicate whether the type of term applies at the Account or Contract level, or both. This is applicable only when the 'existing' field is set to 'false'.
display	True or false value to control whether WebSphere Commerce Accelerator should display this term. Default: true.
displayNameKey	Key to the resource bundle for WebSphere Commerce Accelerator to get the display value for the name of the term or property. For example, the 'SurCharge' is the key if the resource bundle has the following content: SurChargeTC=Surcharge TC
descriptionKey	Key to the resource bundle for WebSphere Commerce Accelerator to get the display value for the description of the term or property. For example, the 'SurChargeTCDescription' is the key if the resource bundle has the following content: SurChargeTCDescription=Surcharge term and condition is used for specifying the settings related to surcharge.
name	Unique identifier for the property. The name should be unique inside a term. However, different terms can have the same property name.
column	The column identifier within the TERMCOND table that holds the value for this property. For the supported columns, see Supported columns.
required	True or false value to indicate whether the value of this property is required. If it is true, the extended term can be saved unless the value of this property was provided. Default: false
changeable	True or false value to indicate whether this property is changeable after the contract is deployed and in 'Active' state. Default: false. For the changeable flag to have any effect at the property level, the term as a whole must be changeable. Therefore, first ensure that the CHANGEABLE column of the TERMCOND table for this term is set to 1. (0 means no, 1 means yes.)