Ektron 9.00
This section describes the configuration screens located in the Workarea at Settings > Commerce > Configuration and Settings > Commerce > Tax.
Use the Countries screen to modify existing country information or add new countries to eCommerce.
By default, Ektron provides information for countries on the ISO list of English country names and code elements (ISO 3166-1-alpha-2 code
).
The following is provided for each country.
The countries screen lets you enter new countries, and edit information for provided countries.
Prerequisite
The new country’s ISO codes.
To add a new country:
The Regions screen lets you define geographic regions within countries that your eCommerce site services. For example, in the United States of America, each state is a region.
Regions are used in the same way that countries are used. See Also: How Countries are Used By default, the Regions screen includes 50 United States of America, the District of Columbia, and 9 Canadian Provinces.
Prerequisite
The region’s country is defined in the Countries screen
To add more regions for this country, check this box and press Save. When you do, the screen refreshes, and the most recently selected country appears as the default.
eCommerce supports all currencies. However, customers can choose only enabled currencies. The Currency screen lets you enable and edit information for installed currencies.
By default, Ektron provides currencies on the ISO 4217 Current Currency & funds code list.
The following information is provided for each installed currency.
When users are setting prices in the Workarea or site visitors are shopping, they can only choose enabled currencies. When you install Ektron, the following currencies are enabled.
To see which currencies (other than the default) are enabled, click Action > Edit Exchange Rates from the Currencies screen. Only non-default, enabled currencies appear.
WARNING! The Euro and Australian dollar are shipped with a default exchange rate. If you will support these currencies, you should update the rate to its current value before going live. See Also: Defining and Updating Exchange Rates
To enable any installed currency:
The default currency is the reference currency when setting the exchange rate on the Edit Currency screen. For example, if the default is US dollars, USD appears on the left of the exchange rate equation, as shown below.
The default currency is also the default value in the Currency Selector server control, and on the Pricing tab of the View/Edit Catalog Entry screen. See Also: Server Control Reference
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 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: Starting Crawls Manually You will only see the new default currency in search results when that crawl is complete.
If your developer places a CurrencySelect server control on a page, a site visitor can use it to select any enabled currency. See Also: Server Control Reference
After a currency is selected, the prices change to that currency. From that point on, the cart and order use the selected currency. See Also: Defining and Updating Exchange Rates
The Edit Currency screen lets you define an exchange rate between the default and any other currency. A good website for finding exchange rates is http://www.xe.com.
The exchange rate can dynamically adjust prices when the rate changes. See Also: Alternate Currency Pricing
You can update the exchange rates using:
The following Ektron API supports calling an exchange rate service to update rates automatically: Ektron.Cms.Commerce.ExchangeRateApi
. For more information, see the Ektron API documentation (http://reference.ektron.com/developer/).
The Edit Exchange Rates screen lets you update the exchange rate for enabled currencies:
The Payment Options screen lets you determine which options are available for your customers to pay for their purchases.
Both options can be enabled, but only one gateway can be enabled at a time.
PayPal payments work like checks in that they need to be settled. After an order is placed, the payment must be marked as “settled” for the workflow to proceed.
Customers can use PayPal to pay for purchases from either of 2 points in the checkout process
IMPORTANT: PayPal requires you to place the Pay with PayPal option on both the shopping cart and payment screens.
If you access PayPal via the shopping cart screen, you follow these steps.
Here is the sequence illustrated above.
Alternatively, the site visitor can use the standard eCommerce checkout process, select PayPal on the payment screen, and complete the order using the PayPal payment screen. That sequence is illustrated below.
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 PayPal: Development & Integration Guides.
siteroot/web.config
file.web.config
’s providers/paypal
element. Save web.config
. The following illustration shows the PayPal API Username copied into the web.config
file’s PayPalUser
property.
Follow these steps to encrypt the following values in the web.config
file’s providers/paypal
element.
siteroot/web.config
file.AuthValuesEncrypted
element to true
.web.config
.C:\Program Files\Ektron\CMS400vxx\Utilities.
web.config
file’s PayPalUser
element value.PayPalPwd
and PayPalSignature
.After completing these steps, you have verified your PayPal buyer experience and are ready to begin using PayPal.
web.config
’s providers/paypal
element. Save web.config
. 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 PayPal: Development & Integration Guides.
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”
.
A payment gateway provider is a pluggable component that is integrated into the Ektron eCommerce module. A payment provider handles eCommerce customer payments by using third-party payment gateways. Ektron eCommerce module accepts payments such as credit cards or checks. Then, it passes that information to a third-party service. The third-party service processes the payment and returns a transaction ID that is stored with the customer's order.
Your company needs to set up an account with a third party payment service before using the payment provider. Ektron provides 4 standard payment gateways: authorize.net, Payflow, Sage Pay and PayFlowWebsite Payments Pro along with manual. The manual gateway accepts credit cards. In this case, the merchant emails the credit card information to the credit card company. You can customize these providers or create your own using the extendable Payment Gateway Provider architecture. See Customizing the Payment Gateway Provider.
In addition, some payment gateways might support recurring payments, while others might not. Recurring payments let you create a payment that recurs at a given interval for a specified period of time. For example, you could create a payment for $9.99 that occurs on the first of every month for the next 12 months. This is something to consider if your site relies on a subscription service.
Ektron lets you edit information on any provided gateway as well as create a new one.
The following sequence explains typical processing of credit card transactions. (source: www.authorize.net)
The following sequence explains how a payment gateway processes checks. (source: www.authorize.net)
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 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:
NOTE: To create a new payment gateway provider, see Customizing the Payment Gateway Provider.
The following sections explain how to set up standard Payment gateways.
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.
NOTE: See PayFlow's website for additional instructions on setting up the PayFlow Gateway.
When setting up a PayFlow payment gateway:
Limitations: 64 alphanumeric, case-sensitive characters.
Limitations: 6- to-32 alphanumeric, case-sensitive characters
Limitations: 64 alphanumeric, case-sensitive characters.
Limitations: 12 alphanumeric, case-sensitive characters.
The PayFlowWebsite Payments Pro payment gateway is used in the United Kingdom and Australia.
Limitations: 64 alphanumeric, case-sensitive characters.
Limitations: 6- to-32 alphanumeric, case-sensitive characters
After defining the payment gateway, you typically want to test it. See Testing a Payment Gateway
This gateway accepts only credit cards. No checks.
After defining the payment gateway, you typically want to test it. SeeTesting a Payment Gateway
NOTE: SagePay does not support recurring billing nor check payments.
After defining the payment gateway, you typically want to test it. SeeTesting a Payment Gateway and Testing SagePay 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
.
Do not use the following cards with the SagePay test card number when testing the SagePay payment gateway:
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:
siteroot/web.config
file.<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>
SimulatorMode
to false
.NOTE: You cannot delete the default gateway. If you want to delete it, you must first make another gateway the default.
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.
Use the following resources to familiarize yourself with integrating checks into your eCommerce site.
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.
Use this screen to enter types of credit cards that your eCommerce system may use. By default, Ektron’s sample sites provide the following card types.
You can edit the information provided for these types or enter a new one.
During the checkout process (managed by the Checkout server control), the Payment screen includes a drop-down list of enabled credit cards.
To create a new credit card within Ektron:
A RegExregular expression; an alias that creates a pattern. For example, blogs.aspx?blogmonth=3&blogyear=2012&blogid=41 can be a RegEx blogs/2012/03/41. From that, a site visitor can infer blogs/2012/03/40 to see the previous post, or enter blogs/2012/03 to see all March 2012 posts 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.
The eCommerce shipping screens let you specify information about where catalog entries are stocked, how they are packaged, and the available shipment methods.
Use the Warehouses screen to enter information about warehouses that stock your catalog entries. eCommerce uses this location as the “from” address when calculating shipping costs.
Only the default warehouse is used by the checkout process. Additional warehouses are unused until they are made the default. See Also: Changing the Default Warehouse
Prerequisite
Configuring Regions and Configuring Countries must be set up
NOTE: You can also specify a warehouse as the default via the Edit Warehouse screen’s Mark Default Warehouse toolbar button ().
You cannot delete the default warehouse. However, you can designate another warehouse as the default, then delete the one that was the default.
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.
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.
Use the Shipping Methods to define choices your site visitors will have for delivering their purchases.
Prerequisites
- Default warehouse with an address
- A default shipping provider is defined in the
siteroot\shipment.config
file
When you instEktron, several providers exist in the siteroot\shipment.config
file:
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.)
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.
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>
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.
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
eCommerce provides a set of tax screens in the Workarea that lets you:
During checkout, Ektron tries to find a tax rate for each catalog entry’s Tax Class and the shipping address’s geographic entity.
If a postal zone has several taxes (for example, a local tax and a regional tax), build the combined percentage into the postal code tax. So, assume New York City has a 4% tax, and New York state has a 3% tax. Enter a combined total of 7% into postal zones within New York City. See Also: Cataloging Entries that Can Be Taxed
For example, the atrium chair is assigned to the Goods Tax Class. A person who lives in New York state purchases the chair. Although no postal tax class is defined for the shipping address, a regional tax of 8.5% is set up for New York state, and so is applied to the order.
The shipping tax is separate from the other taxes, and appears on a separate line of the order.
A shipping tax is applied to an order if
web.config
and
Unlike the other tax classes, you do not apply shipping tax to catalog entries. Instead, you apply them to geographic regions only. However, each tax class compares an order's shipping address against regional tax tables to calculate the tax.
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.
You apply a shipping tax rate to geographic regions as you do with the tax classes. See Also: Applying Local Taxes, Configuring Regional Tax Tables, Configuring Country Tax Tables
Use the Tax Class screen to define classes of catalog entries that can be taxed. When you install eCommerce, the following tax classes are installed.
You can modify or delete all classes except shipping, which you can modify but not delete. You also can add new classes.
If a tax class has been assigned to a catalog entry that appears on any order, the Delete button does not appear.
Use postal code tax tables to identify local areas (cities, counties, and so on) that apply taxes to eCommerce catalog entries. The areas are identified by their postal code. For example, London, England taxes alcohol delivered to addresses within it.
You only need to create a postal tax table if the area that applies the tax is smaller than a country’s geographical regions (states, provinces, and so on). If an entire region applies a tax, use a regional tax table.
Prerequisite
The postal code’s country and region are defined in the Regions and Countries screens
Use regional tax tables to identify regions (states, provinces, and so on) that apply taxes to eCommerce catalog entries. For example, within the United States of America, the state of New Jersey applies a 5% tax on goods purchased on the internet and shipped to it.
You only need to define a regional tax table if the area that applies the tax is smaller than a country. If an entire country applies a tax, use a country 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:
Use country tax tables to identify nations that apply taxes to eCommerce catalog entries. For example, Ethiopia applies a 5% tax on goods purchased on the internet and shipped to it.
A country tax table is automatically created for every existing country. By default, tax rates are zero (0). To change any country tax rate: