Home > .NET Client > Installing and Testing the Client


Installing and Testing the Client

This section explains how to install and test the SDK for .NET.

Minimum System Requirements

nMicrosoft .NET Framework Redistributable, installed on your system

For the minimum requirements for .NET, see the .NET home page, at
http://msdn.microsoft.com/netframework/.

nMicrosoft ASP.NET.

This application is required for the Sample Store.

n20 MB of disk space

Microsoft Visual Studio .NET is optional.

The client supports ISO-8859-1 encoding by default. However, you can configure the client to use UTF-8 instead. See Encoding.

 

Failure to configure your client API host to a unique, public IP address causes inconsistent transaction results.

The client API request ID algorithm uses a combination of IP address and system time, along with other values. In some architectures this combination might not yield unique identifiers. If it is not possible to configure your machines with unique IP addresses, CyberSource provides a client configuration parameter that you can use to identify your host. For the CyberSource SCMP API SDK for .NET, this configuration parameter is HostID, which is an ICSClient property.

Installing the Client

The CyberSource .NET Client Setup Wizard creates program folder shortcuts.

To install the client:

Step 1Download the latest .NET Client package from the Support Center.

Step 2Run the downloaded file.

The Welcome to the CyberSource .NET Client Setup Wizard window appears.

Step 3Click Next to continue.

The License Agreement window appears.

Step 4Click I Agree, then click Next to continue.

The CyberSource .NET Client Information window appears.

Step 5Click Next.

The Select Installation Folder window appears.

aIn the bottom right corner of this window, click Everyone if you want all users on that computer to be able to view the Start menu program shortcuts to the CyberSource Client. If not, then click Just Me.

bTo change the installation folder, click Browse, and choose a folder. To use the default selection, proceed to the next step.

Step 6Click Next.

The Confirm Installation window appears.

Step 7Click Next.

The Generate Keys window appears.

Step 8In the Generate Keys window, click Cancel.

 

The Generate Keys window key generation functionality has been deprecated. Instead, you must generate two security keys—one for the CyberSource production environment and one for the test environment—in the Business Center. For more information about generating and using transaction security keys, see Creating and Using Security Keys (PDF | HTML).

After you generate your security keys in the Business Center, you must edit the ICSTest.xml. This file must be updated before you run ICSTest. For more information, see Editing the ICSTest.xml File.

Step 9Click OK.

The Installation Complete window appears.

Step 10Click Close.

Downloading the package installs the directory and files listed below.

Directory or File

Description

ICSTest\

Project and source files for the ICSTest test application.

CyberSource.dll

.NET assembly.

CyberSource.xml

CyberSource API help used by Intellisense in Visual Studio .NET.

CybsSecurity.dll

Security file.

ecert.exe

ECert application that generates your certificate and private keys. Transaction security keys can also be generated in the Business Center. For more information, see Creating and Using Security Keys (PDF | HTML).

ICSTest.exe

Test application that runs a CyberSource transaction to verify that the client is installed properly.

LICENSE.rtf

License Agreement for CyberSource software.

README.rtf

Documentation and registration information.

StoreSetup.msi

CyberSource Sample Store installer.

You are ready to install the CyberSource Sample Store.

 

Installing the CyberSource Sample Store

The CyberSource Sample Store Setup Wizard installs the CyberSource Sample Store on your computer.

 

The CyberSource Sample Store is intended for testing and basic demonstration purposes only. Do not use the CyberSource Sample Store to build your web store.

To install the CyberSource Sample Store:

Step 1From your Windows desktop, click Start > Programs > CyberSource .Net Client > Install Sample Store.

The Welcome to the CyberSource Sample Store Setup Wizard window appears.

Step 2Click Next.

The Select Installation Address window appears. The default virtual directory is CyberSourceStore. The default port is 80.

Step 3Click Next.

The Confirm Installation window appears.

Step 4Click Next.

The Installation Complete window appears.

 

If the Generate Keys window appears, click Cancel. The Generate Keys window key generation functionality has been deprecated. Instead, you must generate two security keys—one for the CyberSource production environment and one for the test environment—in the Business Center. For more information about generating and using transaction security keys, see Creating and Using Security Keys (PDF | HTML).

Step 5Click Close.

Customize your Visual Studio .NET Toolbox.

 

After you generate your security keys in the Business Center, you must specify the directory location of your private keys and certificate in the web.config file. For more information, see Editing the web.config File.

 

Customizing Your Visual Studio .NET Toolbox

This section explains how to add the ICSClient component to your Visual Studio .NET Toolbox. To be able to drag and drop the CyberSource .NET Client into your web pages, you must add the ICSClient component to your Visual Studio .NET Toolbox.

 

Remove the older ICSClient if there is one.

To customize the Visual Studio .NET Toolbox:

Step 1From your Windows desktop, click Start > Programs > Microsoft Visual Studio .NET > Microsoft Visual Studio .NET.

Microsoft Visual Studio .NET opens.

Step 2Click Toolbox.

If the Toolbox tab is not visible, then click Toolbox from the View menu.

Step 3Right-click in the Toolbox window and click Add/Remove Items.

The Customize Toolbox window appears.

Step 4Click .NET Framework Components.

The .NET Framework Components tab appears.

 

Step 5Under the Name column, click ICSClient.

Step 6Click OK.

The ICSClient icon is visible on the Components tab of the Tool menu.

You are ready to test your installation.

 

Testing the .NET Client Installation

To test your .NET Client installation, run the ICSTest application and run test transactions by using the Sample Store.

 

You must generate two transaction security keys—one for the CyberSource production environment and one for the test environment. For information about generating and using security keys, see Creating and Using Security Keys (PDF | HTML).

 

Running ICSTest

If you did not update the ICSTest.xml file when you generated keys during the .NET Client installation, then you must edit the ICSTest.xml file before you run ICSTest application.

Editing the ICSTest.xml File

To edit the ICSTest.xml file:

Step 1Using a text editor, open the ICSTest.xml file. The file is located in <directory>\ ICSTest, where <directory> is the directory where the CyberSource Client for .NET is installed.

Step 2Find <MerchantID>your_merchant_id</MerchantID>, and change the value to your Merchant ID.

Step 3Find <KeysDir>directory_containing_your_keys</KeysDir>, and change the value to the location of your public and private keys.

Step 4Save and close the ICSText.xml file.

 

Running ICSTest

To run the ICSTest:

Step 1From your Windows desktop, click Start > Programs > CyberSource .NET Client > Run ICSTest.

A Command Prompt window opens.

Step 2Run the ICSTest.exe application.

If your installation was successful, the request and reply appear in the Command Prompt window.

 

If your transaction was not successful, make sure your certificate and private key files were properly generated. For more information, see Creating and Using Security Keys (PDF | HTML).

If you continue to receive an error message, review your ICSTest.xml file. For more information see Editing the ICSTest.xml File.

 

The ICSTest directory contains the project and source files, which can be loaded in Visual Studio .NET. You must add a reference to the CyberSource .NET Client to build the project. For more information on adding a reference, see Using the .NET Client with Other .NET Applications.

Using the Sample Store

If you did not update the web.config file when you generated keys during the .NET Client installation, then you must edit the web.config file before you use the Sample Store.

Editing the web.config File

To edit the web.config file:

Step 1Using a text editor, open the web.config file. The file is located in the inetpub\wwwroot\<VirtualDir> directory, where <VirtualDir> is the one you selected during the Sample Store installation. The default is CyberSourceStore.

Step 2Find the <appsettings> element. It is similar to the following:

<appsettings>

...

</appsettings>

Step 3Find <add key="icsClient.KeysDir" value= "directory_containing_your_keys" />, and change the value to the location of your public and private keys.

Step 4Find <add key="icsClient.MerchantId" value= "your_merchant_id" />, and change the value to your merchant ID.

Step 5Save and close the web.config file.

 

Using the Sample Store

To use the Sample Store:

Step 1Using a web browser, go to http://localhost/<virtualdirectory>/, where <virtualdirectory> is the one you selected during the Sample Store installation.

The Shopping Cart page appears showing a pre-filled order.

Step 2Click Checkout.

The Enter Shopper Information page appears. The field entries may be modified.

Step 3Click Submit.

The Order Summary page appears. Tax and the order total are computed.

Step 4Click Proceed with Checkout.

The Enter Credit Card Information page appears. Be sure the Credit Card Number is a test value. The Card Verification Number can be a three- or four-digit value.

Step 5Click Submit.

If the .NET Client is working properly, the Order Complete page appears.

If you receive an error message, review your web.config. For more information see Editing the web.config File.

Step 6If you click Shop again, you are returned to the Shopping Cart.

 

Sample Store Files

The following files are in the Sample Store directory located in the Solution Explorer—My Store.

nDefault — the Shopping Cart page

nDisplayError — shows the error page and prints out the exception

nDisplaySuccess — shows that your order is completed successfully, and displays the order number

nDisplaySummary — displays the total amount after tax; calls the ics_tax service and displays the Shopping Cart with tax, shipping and handling, and total amount

nGetCreditCardInfo — where the credit card information is displayed; calls the ics_score and ics_auth service after the Submit button is clicked.

nGetShoppingInfo — where the billing address and the ship-to address information are entered by the customer

nGlobal.asax — contains the ICSClient data member, which is used in DisplaySummer.aspx and GetCreditCardInfo.aspx

 

The Sample Store also includes the project and source files, which can be loaded in Visual Studio .NET. You must add a reference to the CyberSource .NET Client to build the project. For more information about adding a reference, see Using the .NET Client with Other .NET Applications.

Going Live

When you complete all of your system testing and are ready to accept real transactions from your customers, your deployment is ready to go live. When your deployment goes live, you can send transactions to CyberSource’s production server. Provide your banking information to CyberSource so that your processor can deposit funds to your merchant bank account.

To send transactions to the CyberSource production server:

Step 1Log in to the test Business Center.

Step 2In the left navigation panel of the test Business Center, click Support Center.

Step 3On the Support Center home page, in the Search Knowledgebase search well, type go live, and then click Search.

Step 4In the search results, depending on what version of CyberSource you use, click How do I go live? (Enterprise) or How do I go live? (Small Business).

These knowledgebase articles provide instructions that describe how to activate your account to process live transactions.

 

Once CyberSource has confirmed that your deployment is live, make sure to update your system so that you send requests to the production server (ics2a.ic3.com) instead of the test server (ics2testa.ic3.com).

After your deployment goes live, use real card numbers and other data to test every card type, currency, and CyberSource application that your integration supports. Because these are real transactions, use small monetary amounts to do the tests. Process an authorization, capture, and credit for each configuration. Use your bank statements to verify that money is deposited into and withdrawn from your merchant bank account. If you have more than one CyberSource merchant ID, test each one separately.

Uninstalling the .NET Client

To uninstall the CyberSource client for .NET and the CyberSource Sample Store:

Step 1From your Windows desktop, click Start > Settings > Control Panel > Add/Remove Programs.

The Add/Remove Programs window appears.

Step 2In the left navigation bar, click Change or Remove Programs.

Step 3Click CyberSource Sample Store.

Step 4Click Remove.

The CyberSource Sample Store is removed.

Step 5Click CyberSource .NET Client, noting the version number.

Step 6Click Remove.

The CyberSource .NET Client is removed.

Step 7Click Close.