Using variables

Any function that you create will use variables . Think of a variable as a container with a name. You can place data into these containers and then simply refer to the data by using the variable name.

Declare the variables

You should start each function with a declaration of the variables you are going to use within the function. Variables are declared with the var keyword. At a minimum, you should define the following variables. These variables have been used in the Example cost scripts . You can use whatever variable names you want, but we recommend the following naming conventions.

The following table provides some suggestions for other commonly used variables, however, you can define any variables you want.

Example

////////////////////////
//  DECLARE VARIABLES //
////////////////////////

//1. TOTALS - Declare variables used to calculate totals 
//and sub-totals.
  var items = [];
  var perCopyCost = 0;
  var subtotalCostLineItem;
  var subtotal = 0;
  var total = 0;

// 2. PRINTING COSTS - Declare variables used to calculate 
//Printing costs - this includes PaperCost and Color/Mono 
//Printing line items.
  var numberOfPages = 0;
  var paperCost = 0;
  var tonerCost = 0;
  var printingCostLineItem;

// 3. FINISHING COSTS - Declare variables used for finishing costs.
  var bindingCost = 0;
  var bindingSubAttributeCost = 0;
  var finishingCost = 0;
  var finishingBackCoverCost = 0;
  var finishingCostLineItem;
  var finishingFrontCoverCost = 0;
  var finishingStaplingCost = 0;

// 4. DELIVERY - Declare variables used to calculate Delivery costs.
  var deliveryCost = 0;
  var deliveryCostLineItem;

Initialize the variables

After you have declared your variables, you can initialize them, that is, define the data that will be stored in each variable. You can use any JavaScript language features, however, you will mainly use:

• Strings
• Numbers
• Order object attributes
• Variables
• Conditional statements

Strings

You can use text strings in your description. A text string is zero or more characters that appear as literal text. In javascript, strings are written inside of single or double quotation marks.

frontCoverText = "Front cover: " + order.frontCover.name

Numbers

You can use numerical values in your calculations. For example, you could specify an exact amount for Delivery costs that will be applied to every order.

deliveryCosts = 5

Order object attributes

Values specified in configuration files (for example, the cost or name of a selected option) can be referenced in your costing script using a method. For more information about the available methods, see Using Order object attributes .

As described in Step 1: Allocate a cost to product and delivery options , costs can be assigned to all options in the product and delivery options configuration files. Your cost script can reference these individual costs.

Each option defined in a product or delivery option configuration file has a corresponding Order object attribute that will return the configured value.

"frontCover": {
    "options": [
        {
            "name": "No Cover",
            "image": "cover_none.jpg",
            "printable": false
        },
        {
            "name": "Clear Acetate",
            "description": "A clear plastic cover that gives a professional look to documents.",
            "image": "cover_clear.jpg",
            "printable": false,
            "cost" : 4.75
        },
        {
            "name": "Frosted Acetate",
            "description": "A frosted plastic cover. Use when an opaque look is required.",
            "image": "cover_frost.jpg",
            "printable": false,
            "cost" : 5.75
        }
    ]
},

frontCoverText = order.frontCover.name;

frontCoverCost = order.frontCover.cost;

Binding sub-attribute options

Displays the value for a Binding sub-attribute option selected by the customer (for example, the cost or the name of the Binding Edge selected by the customer for Comb Binding).

The syntax of the Order object attribute used to return a binding sub-attribute option value is slightly different because it needs to specify the sub-attribute. A zero-based array is used, which allows you to specify the sub-attribute.

bindingCombBindingText = order.binding.attributes[0].option.name;

bindingCombBindingCost = order.binding.attributes[0].option.cost;

Variables

Your variables can include a reference to other variables .

finishingText = frontCoverText + ", " + backCoverText + ", " + bindingText + ", " + holePunchingText + ", " + laminatingText

Example - Cost calculation variable

You might want a line item that calculates the Finishing cost, which is the sum of the Front cover, Back cover, Binding, Hole punching, and Laminating costs. In this case, you would need to firstly define the cost calculation variables for each element in the Finishing costs calculation, for example, laminatingCost = order.laminating.cost

Secondly, you would define the Finishing cost variable by referencing the cost calculation variables for each of the individual elements:

finishingCost = frontCoverCost + backCoverCost + bindingCost + holePunchingCost + laminatingCost

You might also want to display a sub-total for the product cost separately to the delivery costs. To calculate the product cost per copy:

perCopyCost = printingCost + finishingCost;

To calculate the product cost for all copies ordered:

subtotalCost = perCopyCost * order.copies.quantity;

Conditional statements

You can use conditional statements (such as if and else statements) in your cost scripts. For example, you can use a conditional statement to calculate loadings or discounts on costs, or descriptive text based on a options selected in an order.

if (order.backCover.name != 'No Cover') { 
  backCoverText = "Back cover: " + order.backCover.name; 
}

if (order.color.enabled) { 
  colorCost = order.paperStock.cost * 1.5; 
} else { 
  colorCost = order.paperStock.cost; 
}

if (order.copies.quantity > 10) { 
  total = subtotal \* 0.5; 
} else { 
  total = subtotal;
}