Viewing and Changing the Default Currency

When you install Ektron, the default currency is U.S. dollars, indicated by the Numeric ISO code 840. At that time, you can change this by editing the value for the web.config file’s ek_ecom_DefaultCurrencyId tag. You must enable the new default currency in the Ektron Workarea before changing it in the web.config file.

WARNING! After your eCommerce feature goes live, do not change the ek_ecom_DefaultCurrencyId value in web.config.

IMPORTANT: If you edit the siteroot/web.config file's ek_ecom_DefaultCurrencyId property, you must begin a manual crawl. See Also: eCommerce Configuration Screens You will only see the new default currency in search results when that crawl is complete.

CurrencySelect Server Control Properties

The following are Ektron-specific server control properties. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• CacheInterval (Double)

  The number of seconds that the server control’s data is cached. The default is 0 (zero). For example, if you want to cache the data for 5 minutes, set to 300. See Also: Caching with Server Controls.

• CustomXml (Code-behind Only) (String)

  Lets you inject custom XML into the generated XML before being processed by the XSLT. Enter a string of XML that you want to make available to the XSLT as follows:

  <root><customXml>custom-xml-inserted-here</customXml></root>

  See Also: Displaying Custom XML in Ektron’s Server Controls.

• DisplayXslt (String)

  If desired, enter a relative or absolute path to an Xslt that determines the display of the page.. By default, the control uses CurrencySelect.xsl. This file is located in siteroot\Workarea\Xslt\Commerce

  IMPORTANT: If you specify an external file, do not store this file in the Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade.

• DoInitFill (Boolean)

  By default, Fill occurs during the Page_Init event. Set to false if you want to postpone the fill-action until later. In this case, Fill is automatically called during the Page Render event. You might do this if you need to set or change a property on the control in code-behind and have it render with your changes shown.

• Hide (Boolean)

  Hides or displays the output of the control in design time and run time.

  • True—Hide the control output.
  • False—Display the control output.
• Language (Integer)

  Set a language for viewing content; shows results in design-time (in Visual Studio) and at run-time (in a browser).

• Stylesheet (String)

  Specify the path to a style sheet for use with this server control. The location can be relative or absolute. Leave blank to use the default style sheet.

• SuppressWrapperTags (Boolean)

  Suppresses the output of the span/div tags around the control.

  • True—Suppress wrap tags.
  • False (default)—Allow wrap tags.

PayPal Documentation

Use the following PayPal technical documentation resources when integrating PayPal into your eCommerce site: PayPal Express Checkout Integration Guide and Payflow ACH Payment Service Guide, located at https://www.x.com/developers/paypal/development-and-integration

Enabling PayPal Support

1. Create a Sandbox Account. This step includes updating Ektron’s web.config file.
2. Begin Using PayPal
3. Enable PayPal in the Workarea

Create a sandbox account

Create a Sandbox Account

1. Sign on to http://www.sandbox.paypal.com.
2. Sign up for an account.
3. You receive an email confirmation that directs you to another page.
4. Log in using the information you provided in Step 2.
5. Under Test Accounts, click Create a preconfigured buyer or seller account.
   

   

6. Create a buyer account. You will use this to test the customer experience.
7. Change the password to one you can easily remember.
   

   

8. Click Home > Test Accounts > Create a preconfigured buyer or seller account.
9. Click Account Type Seller.
   

   

10. Create a seller account. You will use this to test the merchant experience.
11. Change the password to one you can easily remember.
12. In the upper left corner of the screen, click API Credentials.
    

    

13. Open your siteroot/web.config file.
14. Copy the following values from the API Credentials screen into the web.config’s providers/paypal element. Save web.config.
    • API Username > PayPalUser
    • API Password > PayPalPwd
    • Signature > PayPalSignature

The following illustration shows the PayPal API Username copied into the web.config file’s PayPalUser property.

Encrypting PayPal authentication values

Encrypting PayPal Authentication Values

Follow these steps to encrypt the following values in the web.config file’s providers/paypal element.

• PayPalUser
• PayPalPwd
• PayPalSignature

1. Open the siteroot/web.config file.
2. Set the AuthValuesEncrypted element to true.
   

   

3. Save and close web.config.
4. Open C:\Program Files\Ektron\CMS400v8x\Utilities.
5. Run EncryptEmailPassword.exe. The Encrypt Utility dialog appears.
   

   

6. Enter the PayPal user name into the Text field.
7. Click Encrypt. The screen displays encrypted text in the Encrypted field.
8. Copy the encrypted text and paste it into the web.config file’s PayPalUser element value.
9. Repeat Steps 6 through 8 for PayPalPwd and PayPalSignature.

Test the sandbox account

Test the Sandbox Account

1. Sign into Workarea > eCommerce > Cart.
2. Click the PayPal button.
3. Enter the buyer account user name and password that you created in Create a Sandbox Account. You proceed to the Ektron Checkout screen.

After completing these steps, you have verified your PayPal buyer experience and are ready to begin using PayPal.

Begin using PayPal

Begin Using PayPal

1. Sign on to http://www.paypal.com.
2. Create a new account.
3. Follow the instructions to obtain API credentials.
4. Copy the following values from the API Credentials screen into the web.config’s providers/paypal element. Save web.config.
   • API Username > PayPalUser
   • API Password > PayPalPwd
   • Signature > PayPalSignature
5. If you want to encrypt these values, see Encrypting PayPal Authentication Values.
6. Enable PayPal in the Workarea.
7. If desired, customize the PayPal page on your Web site.

Enable PayPal in the Workarea

Enable PayPal in the Workarea

1. From the Workarea, choose Settings > Commerce > Configuration > Payment Options.
2. Click Action > Edit Payment options. The Edit Payment Options screen appears.
3. Check PayPal.
4. Click Save.

Customizing the PayPal page

Customizing the PayPal Page

If you are using Ektron’s sample site and PayPal is enabled, the login screen contains an Ektron logo for demonstration purposes.

You can replace the logo using the apiparamHDRIMG property of the <providers> add name=”PayPal” element in the web.config file.

To change the logo, change the referenced image.

To learn how to customize other aspects of the page, see PayPal’s “Express Checkout Integration Guide” section “PayPal Page Style.” The guide is located at https://www.x.com/developers/paypal/development-and-integration

When setting values in the web.config’s providers/add name=” PayPal” element, prefix any variable with apiparam. For example, to set the header background color, enter apiparamHDRBACKCOLOR=”FFF666”.

Processing Credit Card Transactions via a Gateway

The following sequence explains typical processing of credit card transactions. (source: www.authorize.net)

1. A customer purchases a product from your site and submits payment information. 
2. Ektron passes the information to your payment gateway.
3. The payment gateway provider (PGP) receives secure transaction information and passes it via secure connection to the Merchant Bank’s Processor.
4. The Merchant Bank’s Processor submits the transaction to the Credit Card Interchange (a network of financial entities that manage credit card transactions).
5. The Credit Card Interchange sends the transaction to the customer’s Credit Card Issuer.
6. The Credit Card Issuer approves or declines the transaction, based on the customer’s available funds. It then passes the transaction results and, if approved, the appropriate funds back through the Credit Card Interchange.
7. The Credit Card Interchange relays the transaction results to the Merchant Bank’s Processor.
8. The Merchant Bank’s Processor relays the transaction results to PGP.
9. The PGP stores transaction results and sends them to the customer and/or the merchant. This communication process averages 3 seconds or less.
10. The Credit Card Interchange passes the transaction’s funds from the Credit Card Issuer to the merchant’s bank account.

Processing Check Transactions via a Gateway

The following sequence explains how a payment gateway processes checks. (source: www.authorize.net)

1. Customer authorizes merchant to charge his bank account for an amount.
2. Order and payment information is securely transmitted via the Internet to the payment gateway.
3. The transaction is accepted or rejected based on initial data validation and security criteria defined by the payment gateway.
4. If accepted, the transaction is sent to the ACH Network for settlement.
5. The ACH Network uses the transaction’s bank account information to determine the bank that holds the customer’s account (the RDFI).
6. The ACH Network instructs the RDFI to charge or refund the customer’s account.
7. The RDFI transfers funds from the customer’s account to the ACH Network. The RDFI also notifies the ACH Network of any returns (if funds could not be collected from the customer’s bank account) or charge backs (if a customer disputes a purchase).
8. The ACH Network transfers funds for the transaction to the payment gateway’s bank.
9. After a holding period, the payment gateway provider initiates a ACH transaction that deposits the funds into the merchant’s bank account.

Establishing a Relationship with a Payment Gateway Provider

You need to set up an account with a third-party payment service before using a payment provider. Each payment gateway provider accepts configuration parameters. For example, Authorize.NET requires a username and password, while PayFlow requires a Username, password, vendor, and partner.

In addition, some payment gateways do not support subscription payments. Consider this if your site relies on subscriptions. See Also: Creating a Subscription

The Default Gateway

The eCommerce checkout uses the default gateway only. Additional gateways are unused unless one is changed to the default.

You cannot delete the default gateway. If you want to delete it, you must first make another gateway the default.

To change the default gateway:

1. Go to Settings > Commerce > Configuration > Payment Options.
2. Click the Payment Gateways tab. The currently-defined default has a check in the Default column.
   

   

3. Click the radio button next to the gateway you want to make the default.
4. Choose Action > Mark as Default. A confirmation message appears.
5. Click OK.

Adding a Payment Gateway

NOTE: To create a new payment gateway provider, see Customizing the Payment Gateway Provider.

1. In Ektron, go to Settings > Commerce > Configuration > Payment Options.
2. Choose New > Payment Gateway.
3. Enter information or select options for the following fields:
   
   • Name—Enter the name of the gateway.
   • Default—Check this box if this is the default gateway. If you do, and another gateway is currently the default, it is replaced by this one.
   • User ID—Enter your User ID. This ID will identify your account with this gateway provider.
   • Password—Enter the password for your account with this gateway provider.
   • Expand Custom Values—If this gateway provider needs additional fields of information, enter those values into the Custom 1 and Custom 2 fields.
   • Credit Cards—Check if this payment gateway accepts credit cards.
   • Checks—Check if this payment gateway accepts checks.

The following sections explain how to set up standard Payment gateways.

• Setting up a PayFlow Payment Gateway
• Setting up a PayFlowWebsite Payments Pro Payment Gateway
• Setting up an Authorize.Net Payment Gateway
• Setting up a SagePay Payment Gateway

NOTE: When setting up a payment gateway, you are asked to enter authentication codes, such as user name and password. To keep them safe, Ektron encrypts these values when saving them to the database.

Setting up a PayFlow Payment Gateway

NOTE: See PayFlow's Web site for additional instructions on setting up the PayFlow Gateway.

When setting up a PayFlow payment gateway:

1. Set up an account with PayFlow. To do this, go to https://www.paypal.com/cgi-bin/webscr?cmd=_payflow-gateway-overview-outside. During this process, you should obtain a Login ID and password.
2. Go to Settings > Commerce > Configuration > Payment Options.
3. Choose New > Payment Gateway.
4. Enter information or select options for the following fields:
   • Name—Choose Payflow.
   • Default—Check this box to make PayFlow the default gateway.
   • User ID—Enter the user ID provided to you by the authorized PayPal Reseller who registered you for the Payflow SDK. If you purchased your account directly from PayPal, use PayPal.

     Limitations: 64 alphanumeric, case-sensitive characters.

   • Password—Enter the password you defined while registering for account.

     Limitations: 6- to-32 alphanumeric, case-sensitive characters

   • Expand Custom Values—Click this text to open the Custom 1 and Custom 2 fields.
     • Custom 1—Enter the merchant login ID sent to you when you registered the account.

       Limitations: 64 alphanumeric, case-sensitive characters.

     • Custom 2—Enter the Partner ID sent to you by the authorized PayPal Reseller who registered you for the Payflow SDK. If you purchased your account directly from PayPal, use PayPal.

       Limitations: 12 alphanumeric, case-sensitive characters.

   • Credit Cards—Check if this payment gateway accepts credit cards. You should verify that this payment gateway supports credit card payments.
   • Checks—Check if you will accept checks with this payment gateway. You should verify that this payment gateway supports check payments.

Setting up a PayFlowWebsite Payments Pro Payment Gateway

The PayFlowWebsite Payments Pro payment gateway is used in the United Kingdom and Australia.

1. Set up an account with PayFlowWebsite Payments Pro. To do this, go to https://cms.paypal.com/us/cgi-bin/?&fli=true&cmd=_render-content&content_ID=developer/howto_gateway_payflow_wpp&bn_r=o.
2. In the Ektron Workarea, go to Settings > Commerce > Configuration > Payment Options.
3. Choose New > Payment Gateway.
4. Enter information or select options for the following fields:
   • Name—Choose PayFlowWebsite Payments Pro.
   • Default—Check this box to make PayFlow the default gateway. See Also: The Default Gateway
   • User ID—Enter the API username sent to you by the authorized PayPal Reseller who registered you for the Payflow SDK. For example, sellUK_1271963915_biz_api1.ektron.com. If you purchased your account directly from PayPal, use PayPal.

     Limitations: 64 alphanumeric, case-sensitive characters.

   • Password—Enter the API password you defined while registering for the account.For example,1234567891.

     Limitations: 6- to-32 alphanumeric, case-sensitive characters

   • Expand Custom Values—Click this text to open the Custom 1 and Custom 2 fields.
     • Custom 1—Enter the API signature sent to you by the authorized PayPal Reseller who registered you for the Payflow SDK. For example, AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
       Limitations: 64 alphanumeric, case-sensitive characters.
     • Custom 2—Not used
   • Credit Cards—Check if this payment gateway accepts credit cards. You should verify that this payment gateway supports credit card payments.

After defining the payment gateway, you typically want to test it. See Testing a Payment Gateway

Setting up an Authorize.Net Payment Gateway

1. Set up an account with AuthorizeNet. To do this, go to http://www.authorize.net/solutions/merchantsolutions/. During this process, you should obtain a Login ID and password.
2. In the Workarea, go to Settings > Commerce > Configuration > Payment Options.
3. Choose New > Payment Gateway.
4. Enter information or select options for the following fields:
   • Name—Choose Authorize.Net.
   • Default—Check this box to make Authorize.Net the default gateway.
   • User ID—Enter the Login ID you obtained in Step 1.
   • Password—Enter the password you obtained in Step 1.
   • Custom 1 and Custom 2—Not used.
   • Credit Cards—Check if you will accept credit cards with this payment gateway. You should verify that this payment gateway supports credit card payments.

This gateway accepts only credit cards. No checks.

After defining the payment gateway, you typically want to test it. SeeTesting a Payment Gateway

Setting up a SagePay Payment Gateway

NOTE: SagePay does not support recurring billing nor check payments.

1. Set up an account with SagePay. To do this, go to http://www.sagepay.com/products_services/bolt_ons/merchant_services. During this process, you should obtain a Login ID and password.
2. Set up a SagePay simulator account using https://support.sagepay.com/apply/RequestSimAccount.aspx.
3. From the Simulator Main Menu, click Account > Valid Currencies for this Account. Enable currencies set up in your Workarea’s Currencies screen. See Also: Currencies
4. In Ektron, go to Settings > Commerce > Configuration > Payment Options.
5. Choose New > Payment Gateway.
6. Enter information or select options for the following fields:
   • Name—Choose SagePay.
   • Default—Check this box to make SagePay the default gateway.
   • User ID—Enter the User ID you obtained in Step 1.
   • Password, Custom 1, Custom 2—Not used.
   • Credit Cards—Check if this payment gateway accepts credit cards. You should verify that the gateway supports credit card payments.
   • Checks—Not available with SagePay.

After defining the payment gateway, you typically want to test it. SeeTesting a Payment Gateway and Testing SagePay Payment Gateway

Testing a Payment Gateway

Typically, you test a default payment gateway before going live with it. eCommerce provides a test mode for this purpose. While eCommerce is in test mode, customers cannot purchase goods. So, disable test mode before going live with a new default payment gateway.

To test a payment gateway, open the siteroot/web.config file and set <ektronCommerce> ek_ecom_TestMode to true.

<ektronCommerce>
   <add key="ek_ecom_ComplianceMode" value="false" />
   <!-- This is used only when compliance mode is on, and cannot be less than 4. -->
   <add key="ek_ecom_PasswordHistory" value="4" />
   <add key="ek_ecom_OrderProcessingDisabled" value="false" />
   <add key="ek_ecom_TestMode" value="true" />
    ....

When testing is done, change the value of ek_ecom_TestMode to false.

Testing SagePay payment gateway

Testing SagePay Payment Gateway

Do not use the following cards with the SagePay test card number when testing the SagePay payment gateway:

• Japan Credit Bureau (JCB)
• Mastercard
• Visa Electron UK Debit
• Visa Delta Debit
• American Express

Because these cards do not have a cardholder field, the following error is displayed: The CardHolder field should be between 1 and 50 characters long.

To test the SagePay Payment Gateway:

1. Follow instructions in Testing a Payment Gateway.
2. Open your siteroot/web.config file.
3. Set <EktronPaymentGateway>/<providers> SagePay SimulatorMode to true.

   <EktronPaymentGateway defaultProvider="Automatic">
      <providers>
          .
          .
         <add name="SagePay" type="Ektron.Cms.Commerce.Providers.Payment.SagePayGateway"
          SagePayVersion="2.23" SimulatorMode="true" Description="Ektron CMS Order" />
       </providers>
   </EktronPaymentGateway>

4. When testing is complete, change the value of SimulatorMode to false.

Editing a Payment Gateway

1. Go to Workarea > Settings > Commerce > Configuration > Payment Options.
2. Click the payment gateway that you want to edit.
3. Click Edit.
4. Edit any of the fields, which are described in Adding a Payment Gateway.
5. Click Save.

Deleting a Payment Gateway

NOTE: You cannot delete the default gateway. If you want to delete it, you must first make another gateway the default.

1. From Workarea, choose Settings > Commerce > Configuration > Payment Options.
2. Click the payment gateway that you want to delete.
3. Click Delete (). A confirmation message appears.
4. Click OK.

Check Support

Payment gateways generally offer 2 payment mechanisms: credit cards and checks. You can enable or disable check support for a gateway via the Settings > Commerce > Configuration > Payment options > Edit Payment Gateway screen.

If checks are enabled for the default payment gateway, a site visitor can pay by Check on the payment screen. If check support is not enabled, the Payment Method field does not appear.

Check support integration documentation

Check Support Integration Documentation

Use the following resources to familiarize yourself with integrating checks into your eCommerce site.

• Authorize.Net: http://www.authorize.net/files/echecknetuserguide.pdf
• PayFlow: https://cms.paypal.com/cms_content/US/en_US/files/developer/PP_PayflowLink_Guide.pdf ; see the chapter “Integrating TeleCheck Transactions.”

Effect of check payment on order processing

Effect of Check Payment on Order Processing

The following describes a typical sequence of events when processing a check for eCommerce payment.

However, Ektron is very flexible and does not enforce this sequence. For example, you can enter a tracking number and mark an order shipped even though its payment has not been captured yet.

1. eCommerce user accesses the View Payment screen’s Capture option, which submits a payment request to the customer’s bank.
   

   

2. A few days later, the funds are transferred to the merchant’s account.
3. eCommerce user accesses the View Payment screen’s Mark as Settled option to confirm the receipt of funds.
   

   

4. If goods are tangible, eCommerce user ships the merchandise, using the View Payment screen’s Enter Tracking Number option to insert the tracking number and confirm the shipment.
   

   

5. If goods are not tangible, the workflow sends the customer an email with purchase details, such as how to download it.

Using Regex Expressions for Validation

A Regex expression is a simple way to validate a credit card account number. (See Also: http://regexlib.com/.) Validation occurs when a site visitor completes the Checkout procedure’s Submit Order screen

Regex prevents the submission of invalid account numbers to a payment gateway, which may charge a fee for such failures.

Ektron provides a Regex expression for the credit cards supplied with the medical sample site. You can modify them as needed. If you enter a new credit card, you can enter a Regex expression for it.

Message Variables

An eCommerce message can include the following variables, which pull order information into the message:

• @CustomerFirstName@—Customer’s first name
• @CustomerLastName@—Customer’s last name
• @OrderCouponTotal@—The order’s coupon discounts
• @OrderId@—The order’s ID number
• @OrderItemQuantity@—The quantity of any item on the order
• @OrderItemSalePrice@—The sale price of any item on the order
• @OrderItemStart@ and @OrderItemEnd@— Use the start and end markers to show information for ordered items.

  The markers show no information by themselves. Instead, they repeat the variables between them for every item on the order.So, for example, assume an order has 10 items, and your message looks like this:

  @OrderItemStart@
@OrderItemTitle@
@OrderItemQuantity@
@OrderItemSalePrice@
@OrderItemTotal@
@OrderItemEnd@
  

  The message prints the title, quantity, sale price, and total for each item on the order.

• @OrderItemTitle@—The title of any item on the order
• @OrderItemTotal@—The total cost of one item. For example, if orderItemSalePrice = $10 and orderItemQuantity = 2, orderItemTotal = $20.
• @OrderShippingTotal@—The order’s shipping cost
• @OrderSubTotal@—The order’s subtotal, that is the amount of ordered items prior to shipping costs, taxes, and coupon discounts
• @OrderTaxTotal@—The order’s tax amount
• @OrderTotal@—The order’s final cost (which includes taxes, shipping, and coupon discounts)
• @TrackingUrl@—The link to a Web page that tracks your package. It is usually a combination of the shipper’s URL and the tracking number.

Creating a Warehouse

1. Go to Settings > Commerce > Shipping > Warehouses.
2. Choose New > Warehouse.
3. Enter information or select options as follows:
   • Name—Enter the warehouse’s name.
   • Street1, Street2—Enter the warehouse’s street address
   • City—Enter the warehouse’s city.
   • Postal Code—Enter the warehouse’s postal code.
   • Country—Select the warehouse’s country from the pull-down list.
   • State/Province—Select the warehouse’s state or province from the pull-down list.
   • Default Warehouse—This check box indicates if this is the default warehouse.
4. Click Save.

Changing the Default Warehouse

NOTE: You can also specify a warehouse as the default via the Edit Warehouse screen’s Mark Default Warehouse toolbar button ().

1. Go to Workarea > Settings > Commerce > Shipping > Warehouses.
2. Click the radio button next to the warehouse that you want to make the default.
3. Choose Action > Mark Default Warehouse. A confirmation dialog appears.
4. Click OK.

Editing a Warehouse

1. Go to Workarea > Settings > Commerce > Shipping > Warehouses.
2. Click the warehouse that you want to edit.
3. Click Edit.
4. Edit any of the fields as described in Creating a Warehouse.
5. Click Save.

Deleting a Warehouse

You cannot delete the default warehouse. However, you can designate another warehouse as the default, then delete the one that was the default.

1. Go to Workarea > Settings > Commerce > Shipping > Warehouse.
2. Click the warehouse that you want to delete.
3. Click Delete (). A confirmation message appears.
4. Click OK. The warehouse is deleted.

How Packaging Information Is Used

Each item in an order has size and weight dimensions. The shipping calculator uses them to fit the order into the smallest-sized and fewest packages. It then passes packaging information (number, sizes and weight) to the shipping provider, which returns the order’s shipping costs. If a catalog entry’s dimensions exceed all box sizes, eCommerce passes those dimensions to the shipping provider.

NOTE: Some shipping providers, FedEx and UPS for example, have size and weight limits on packages. If the size or weight exceeds the limit, shipping rates may not be returned when a site visitor is checking out. In this case, a site visitor cannot continue the checkout process and an application error is logged in the Event Viewer.

Size and Weight Units of Measure

By default, Ektron uses English units of measure (inches and pounds) for package size and weight. At the beginning of your eCommerce implementation, you can change to metric units of measure by updating the web.config file’s ek_measurementsystem tag value to metric.

WARNING! After your eCommerce feature goes live, do not change the web.config ek_measurementsystem value.

Creating a New Package

1. Go to Settings > Commerce > Shipping > Packages.
2. Click New > Package.
3. Enter package information in the following fields: 
   • Name—Enter a text description of this package size.
   • Length—Enter the package’s length in the units of measure that appear to the right (inches or centimeters). See Also: Size and Weight Units of Measure
   • Height—Enter the package’s height in the units of measure that appear to the right (inches or centimeters).
   • Width—Enter the package’s width in the units of measure that appear to the right (inches or centimeters).
   • Max Weight—Enter the package’s weight in the units of measure that appear to the right (pounds or kilograms).
4. Click Save.

Editing a Package

1. Go to Workarea > Settings > Commerce > Shipping > Packages.
2. Click the package that you want to edit.
3. Click Edit.
4. Edit any of the fields, which are described in Creating a New Package.
5. Click Save.

Deleting a Package

1. From the Workarea, choose Settings > Commerce > Shipping > Packages.
2. Click the package that you want to delete.
3. Click Delete (). A confirmation message appears.
4. Click OK. The package is deleted.

Defining Shipping Providers

When you instEktron, several providers exist in the siteroot\shipment.config file:

• FedExShipmentProvider
• FlatRateShipmentProvider
• UPSShipmentProvider

However, the FedEx and UPS information is for testing purposes only. To use FedEx, UPS, or another shipping provider, obtain the following information from them. (The information can vary slightly for each provider.)

• service URL
• key
• password
• account number
• meter number
• transactionId

Then, enter that information into shipment.config, following the format of providers already in the file.

The shipment.config file also contains name and type properties for each provider. The specific text you insert is not important, but the name and type strings must match.

name="FedExShipmentProvider" 
type="Ektron.Cms.Commerce.Shipment.Services.FedExShipmentProvider, 
Ektron.Cms.Commerce"

To define a custom shipping provider, see Customizing the Shipment Provider.

Defining the Default Shipping Provider

While you can define any number of shipping providers in the shipment.config file, only one can be active. The active provider appears on the Settings > Commerce > Shipping > Methods > New > Shipping Method screen when you click View Options.

Specify the default shipping provider via the defaultprovider property in siteroot\shipment.config.

<?xml version="1.0" encoding="utf-8" ?>
<shipmentProvider defaultProvider="FedExShipmentProvider">
	<providers>
		<add name="FedExShipmentProvider" .
	.
</shipmentProvider>

Adding a Shipping Method

Use the Add Shipping Method screens to select shipping methods you will support. When a site visitor submits an order, these shipping choices appear on the Shipping screen.

1. Go to Workarea > Settings > Commerce > Shipping > Methods.
2. Choose New > Shipping Method. The Add Shipping Method screen appears.
3. Enter information or make selections in the following fields.
   • Name—Enter the name of the shipping method. Site visitors select a shipping method for their order using this name
   • Active—Check this box if you want site visitors to be able to select this shipping method.
   • Provider Service—As explained in Defining the Default Shipping Provider, a default shipping provider is defined in your site’s shipment.config file. To view the methods offered by that provider, click View Options. Then, select from the drop-down list that appears.
4. Click Save.

Editing a Shipping Method

1. Go to Workarea > Settings > Commerce > Shipping > Methods.
2. Click the Shipping Method that you want to edit. The View Shipping Method screen appears.
3. Click Edit ().
4. Edit the fields described in Adding a Shipping Method.

Deleting a Shipping Method

1. Go to Workarea > Settings > Commerce > Shipping > Methods.
2. Click the Shipping Method that you want to edit.The View Shipping Method screen appears.
3. Click Delete ().

Changing the Order of the Shipping Method

Each shipping method you define has an Order field. This determines the sequence in which shipping methods appear on the Shipping Rates screen when a site visitor is submitting an order.

The shipping method with 1 in the Order field appears at the top of the list.

By default, every shipping method’s order is set to 1. To set a sequence for shipping methods, follow these steps

1. Go to Workarea > Settings > Commerce > Shipping > Methods.
2. Choose Action > Reorder Items.
3. Use the selection bar and arrows to arrange methods in the desired sequence.
   

   

4. Choose Action > Save.

Enabling the Shipping Tax within Ektron

To enable the shipping tax, open your siteroot/web.config file and change the value of the ek_ecom_ApplyTaxestoShipping element to True.

Enabling the Shipping Tax for a Geographic Region

You apply a shipping tax to every applicable geographic region. As explained in Calculating an Order’s Tax Amount, the eCommerce module first looks for a tax applied to the order's postal code. If one is found, that shipping tax is applied. If none is found, eCommerce looks for a shipping tax applied to the order's region. If no regional shipping tax is found, eCommerce looks for a shipping tax applied to the order's country.

Applying a Shipping Tax to a Geographic Region

You apply a shipping tax rate to geographic regions as you do with the tax classes. See Also: Postal Tax Tables, Regional Tax Tables, Country Tax Tables

Creating a New Tax Class

1. Go to Settings > Commerce > Tax > Classes.
2. Choose New > Tax Class.
3. Enter the name of the tax class.
4. Click Save.

Editing a Tax Class

1. Go to Settings > Commerce > Tax > Classes.
2. Click the Tax Class that you want to edit.
3. Click Edit.
4. Edit the name of the tax class.

5. Click Save.

Deleting a Tax Class

If a tax class has been assigned to a catalog entry that appears on any order, the Delete button does not appear.

1. Go to Settings > Commerce > Tax > Classes.
2. Click the Tax Class that you want to delete.
3. Click Delete (). A confirmation message appears.
4. Click OK. The Tax Class is deleted.

Creating a New Postal Code Tax Table

Prerequisite: The postal code’s country and region are defined in the Regions and Countries screens

1. Go to Settings > Commerce > Tax > Postal Tax Tables.
2. Choose New > Postal Code.
3. Enter information into the following fields:
   • Postal Code—Enter the postal code for which you want to enter a tax rate. If this is for a US state, the code must consist of 5 or 9 digits.
   • Region—Enter the geographic region (for example, state or province) in which the postal code resides.
   • Country—Enter the country in which the postal code resides.
4. Select the Tax Rates tab and specify values for the tax rates, for example, Alcohol, Goods, Services, Shipping, Tobacco. For any tax class, enter a tax rate as a whole number. For example, if the tax is 7%, enter 7.
5. Click Save.

Editing a Postal Code Tax Table

1. Go to Settings > Commerce > Tax > Postal Tax Tables.
2. Click the ID of the tax table that you want to edit.
3. Click Edit.
4. Edit the fields described in Creating a New Postal Code Tax Table.
5. Click Save.

Deleting a Postal Code Tax Table

1. Go to Settings > Commerce > Tax > Postal Tax Tables.
2. Click the ID of the tax table that you want to delete.
3. Click Delete (). A confirmation message appears.
4. Click OK. The postal code tax table is deleted.

Editing a Regional Tax Table

A regional tax table is automatically created for every existing region. By default, tax rates are zero (0). To change any tax rate:

1. Go to Settings > Commerce > Tax > Regional Tax Tables.
2. Click on the name of the region for which you want to set tax rates. The View Region Tax Rate screen appears.
   

   

3. Click Click here to edit the tax rates.
   

   

4. Click Edit.
5. Enter information into the following fields.
   • Name—Select the region for which you want to enter a tax rate.
   • Enabled—Enable or disable the regional tax entry as required.
6. Select the Tax Rates tab and specify regional tax rates by class. For example, Alcohol, Goods, Services, Tobacco, and Shipping. For any tax class, enter a tax rate.
7. Click Save.

Deleting a Regional Tax Table

1. Go to Settings> Commerce > Tax > Regional Tax Tables.
2. Click the ID of the tax table that you want to delete.
3. Click Delete (). A confirmation message appears.
4. Click OK. The regional tax table is deleted.

Editing a Country Tax Table

A country tax table is automatically created for every existing country. By default, tax rates are zero (0). To change any country tax rate:Country Tax Tables

1. Go to Workarea > Settings > Commerce > Tax > Country Tax Tables.
2. Select the country for which you want to edit a tax table. The View Country Tax Rate screen appears.
3. Click Click here to edit the tax rates.
4. Click Edit.
5. Select the Tax Rates tab and edit the tax rates, for example, Alcohol, Goods, Services, Tobacco, and Shipping. For any tax class, enter a tax rate.
6. Click Save.

Deleting a Country Tax Table

1. Go to Workarea > Settings > Commerce> Tax > Country Tax Tables.
2. Click the ID of the tax table that you want to delete.
3. Click Delete (). A confirmation message appears.
4. Click OK. The country tax table is deleted.