{$page}

CFL is a language used for pricing calculations. As such, CFL is commonly used when working on an order - specifically, for calculating (or recalculating) a line item within that order. Using CFL, it is possible to reach into other parts of the order, customer, contact, and employee and pull information that may need to be used or displayed. Property references are used for these purposes. Here are several formulas used to call property references:

code_formatpascal

Example 1: Declare SignatureLine : “Thanks Again, {p}” + TransHeader.Salesperson1.FullName ; Declare ToLine : Contact.FullName ; IF TransDetail.ShippingAddressOverridden THEN “Special Shipping for this Line” ELSE “Bundle with Order” ENDIF ; Example 2:

IF ShipByUPS Then

    if Transheader.SalesStation.Text  "Shipped"

    THEN "Shipping Disposition does not match this selection" ENDIF

ENDIF

code

Cyrious applications use objects to model the real world. What this means is that the programs create an “Order Object” for the order, an “Account Object” for the customer, a “Contact Object” for the customer contact, and so forth. From within CFL, it is possible to access the information about a customer by referencing properties of the account object. This is what is meant by “property references”. They are powerful tools that give the user unprecedented access to information surrounding an order. For example. “text” is a property name which can be used with objects to retrieve values as in Transheader.SalesStation.text which returns the Station at Sale setting for an Order (See Coded example above).

Usage

The objects available by directly referencing them in the CFL are:

• Company – The customer or prospect for this order.
• Contact – The account's contact for this order.
• TransDetail – The line item being working on.
• TransHeader – The Overall Transaction (Order or Estimate)
• User - The logged in user

Other indirect or supporting object references (such as employees, addresses, and phone numbers) are only available from within one of the direct objects. That is, a phone number cannot be referenced without first giving a direct reference to the object whose phone number is needed. There is more information about these supporting object references in the next section.

Common Property References

These properties are available on all objects in CFL:

Company Property References
||~ Object.Field.Name ||~ Data Type ||~ Description ||

Contact Property References
|| Object.FieldName || Data Type || Description ||

Order/Estimate Heading Property References
|| Object.FieldName || Data Type || Description ||

Order/Estimate Line Item Property References
|| Object.FieldName || Data Type || Description ||

Part Property References
|| || Part Property To Capture || CFL CODE || || || ||

Product Property References
|| Object.FieldName || Data Type || Description ||

Modifier Property References
These references are only valid for CFL being evaluated inside of pricing for a modifier.
|| Object.FieldName || Data Type || Description ||

Pricing Plan Property References
These references are only valid for CFL being evaluated inside of pricing for a modifier.
|| Object.FieldName || Data Type || Description ||

Supporting Object References
Supporting object references are only available from within one of the direct objects. That is, a phone number cannot be referenced without first giving a Direct Reference to the object whose phone number is needed.
In the following property references, the user would replace the object name (like “Address”) with the appropriate direct reference, as in the example below:
code
Do not use Address.FormattedAddress ,
Instead, use TransHeader.ShippingAddressLink.FormattedAddress
code
Address Property References
|| Object.FieldName || Data Type || Description ||

Address Link Property References
|| Object.FieldName || Data Type || Description ||

Phone Number Property References
|| Object.FieldName || Data Type || Description ||

Employee Property References
|| Object.FieldName || Data Type || Description ||

Shipping Items Property References
|| Object.FieldName || Data Type || Description ||

Sample Use
code_formatpascal
DECLARE isNotContig : FALSE;
IF (TransHeader.ShippingCount > 0) THEN
DECLARE isUS;
isUS : ¹⁾;
IF (isUS) THEN
Set Is Not Contiguous if the State is in the non-contiguous list
IsNotContig : (POS(“AK;HI;AS;FM;GU;MH;MP;PW;PR;VI;AA;AE;AP”
, TransHeader.ShippingItems[0].ShipToAddress.State) > 0);
ENDIF;
ENDIF;
Now Return If Non-Contigous
IsNotContig;
code

Part Property References
You can access the part that is assigned to the line item using functions such as ||

• PartByName(“Grommet”, 1)
  * PartByVariableName(“Accessory1”, 1)
  The following properties are available for you to access information about the part using the reference notation ||

||~ Object ||~ Data Type ||~ Description ||

User Property References
|| User.FirstName || string || ||

See Also

• Backlinks include_pagepage_componentbacklinks