CS GetStart PDF
CS GetStart PDF
CS GetStart PDF
VERSION 3.4.1.1
© 2001-2007 nuBridges, Inc. All rights reserved.
Information in this document is subject to change without notice and does not represent a commitment on the
part of nuBridges. The documentation is provided “as is” without warranty of any kind including without
limitation, any warranty of merchantability or fitness for a particular purpose. Further, nuBridges does not
warrant, guarantee, or make any representations regarding the use, or the results of the use, of the software or
written material in terms of correctness, accuracy, reliability, or otherwise.
nuBridges is a trade name and registered trademark in the United States and other countries. The names of actual
companies and products mentioned herein may be the trademarks of their respective owners.
Table of Contents
Chapter 1: Introduction
Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
About This Document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Introduction to the Commerce Suite Documentation Set . . . . . . . . . . . . . . 3
Commerce Suite Documentation Roadmap. . . . . . . . . . . . . . . . . . . . . . . . 4
Documentation Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Introduction to AS2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
AS2 Communication Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Roadmap for Establishing nuBridges Connectivity . . . . . . . . . . . . . . . . . . 8
Typical Commerce Suite Administrator Duties . . . . . . . . . . . . . . . . . . . . . . 9
Introduction ...................................................................................................... 1
About This Document ...................................................................................... 1
Audience.......................................................................................................... 2
Introduction to the Commerce Suite Documentation Set................................. 3
Commerce Suite Documentation Roadmap .................................................... 4
Documentation Conventions............................................................................ 6
Introduction to AS2 .......................................................................................... 7
AS2 Communication Requirements................................................................. 8
Roadmap for Establishing nuBridges Connectivity .......................................... 8
Typical Commerce Suite Administrator Duties ................................................ 9
Chapter 1: Introduction
Introduction
Introduction
Welcome to the Commerce Suite Getting Started Guide. This guide describes the
nuBridges AS2 solution and how it benefits your Internet-based trading community.
This document also provides instructions for installing, configuring, and testing
Commerce Suite with nuBridges to enable connectivity between your enterprise and
nuBridges.
• Chapter 1: Introduction describes the nuBridges AS2 solution and explains how
it will benefit and simplify the exchange of EDI data.
• Chapter 2: Preparing to Install Commerce Suite describes the system
requirements necessary for installing and running Commerce Suite.
• Chapter 3: Commerce Suite Firewall Configuration Considerations provides
the necessary guidelines to facilitate configuration of your firewall for use with
the Commerce Suite application.
• Chapter 4: Licensing and Upgrading Commerce Suite describes nuBridges
licensing and how to upgrade your existing copy of Commerce Suite .
• Chapter 5: Installing Commerce Suite describes how to install Commerce
Suite on Windows and UNIX operating systems.
• Chapter 6: Configuring Commerce Suite describes how to install and configure
the Commerce Suite application.
• Chapter 7: Testing Commerce Suite describes how to test your Commerce
Suite connectivity with nuBridges.
• Chapter 8: Understanding Commerce Suite Files and Directories describes the
Commerce Suite directory structure and explains the different types of files that
will populate each subdirectory.
• Chapter 9: Post Installation Considerations describes some of the tasks you
may need to perform after installing and testing Commerce Suite.
• Appendix A: Conducting Manual Commerce Suite Operations describes how to
perform basic Commerce Suite tasks using a DOS command prompt.
1
Chapter 1: Introduction
Audience
Audience
This guide is intended primarily for use by nuBridges Commerce Suite data
administration personnel responsible for installation, configuration, maintenance, and
use of the Commerce Suite system.
This document has been written with the assumption that nuBridges Commerce Suite
administrators and users have a general understanding of the following concepts and
technologies:
2
Chapter 1: Introduction
Introduction to the Commerce Suite Documentation Set
3
Chapter 1: Introduction
Commerce Suite Documentation Roadmap
4
Chapter 1: Introduction
Commerce Suite Documentation Roadmap
5
Chapter 1: Introduction
Documentation Conventions
Documentation Conventions
This section will familiarize you with the features of this guide. As you will notice,
the left side of this guide has a section that is used for notes, references, and warnings.
These notes are identified by the following icons:
Designates a reference relevant to the adjacent text. The
reference may refer to a procedure, text in another
document, or a definition.
Designates there is additional information that is relevant
to the text on the right side.
This guide also utilizes text formatting to help you locate and identify information.
Review the table below for details on the text formatting used in this guide.
6
Chapter 1: Introduction
Introduction to AS2
Introduction to AS2
The nuBridges Commerce Suite solution provides secure exchange of data over the
Internet between companies and their business partners. Commerce Suite supports
established industry standards such as AS1, AS2, HTTP, HTTP/S, SFTP, SMTP, and
Rosettanet, enabling businesses to send and receive any type of data using multiple
communications protocols and security models.
AS1 and AS2 are draft specifications developed by the Internet Engineering Task
Force (IETF) for securely exchanging business documents over the Internet.
EDI-INT is an internet specification from the IETF for reliably exchanging structured
messages over the internet. The IETF is a large, open, international community of
network designers, operators, vendors, and researchers concerned with the evolution
of the Internet architecture and the smooth operation of the Internet.
AS2 is a draft specification first published in the IETF standard’s track. AS2 provides
an Internet solution for securely exchanging EDI over the Internet using Multipurpose
Internet Mail Extensions (MIME) and the hypertext transmission protocol (HTTP)
instead of the simple mail transport protocol (SMTP) as the transport protocol. AS2
specifies the means to connect, deliver, validate, and reply to (receipt) data in a secure
and reliable way. AS2 does not concern itself with the content of the EDI document,
only the transport.
AS2 essentially creates a wrapper around EDI flat files that enables sending them over
the Internet, instead of using a dial-up connection to a VAN (value-added network).
AS2 is a real-time technology that provides security and encryption around the HTTP
packets. A VAN is a private network provider that is hired by a company to facilitate
secure EDI.nubridges
Commerce Suite solution is certified by the Uniform Code Council (UCC) and is also
in full compliance with the IETF EDI-INT specification. This support for the EDI-INT
specification ensures that trading partners can use the Internet as a transport medium to
conduct business between their respective EDI systems and provide secure EDI over
the Internet.
The Commerce Suite application provides your enterprise with the following business
benefits:
Note: nuBridges recommends a dedicated machine to host the AS2 server, but it is not
mandatory for the application to run properly.
8
Chapter 1: Introduction
Typical Commerce Suite Administrator Duties
9
Chapter 2: Preparing to Install
Commerce Suite
Introduction .....................................................................................................11
Commerce Suite System Requirements - Windows .......................................11
Hardware Requirements ................................................................................................... 11
Software Requirements ....................................................................................................12
Administrator Rights for Windows NT and 2000 ...............................................................12
Recommended Software for Windows .............................................................................12
OS Patches.................................................................................................... 13
Chapter 2: Preparing to Install Commerce Suite
Introduction
Introduction
The Commerce Suite applications is distributed via email or FTP download within a
ZIP file or compressed archive file. The contents of the file must be extracted and
executed on your local system.
You must register with nuBridges Support to receive a user ID and password in order
to perform the connectivity testing described in Chapter 7: Testing Commerce Suite .
Go to the nuBridges website at support.nubridges.com and select the New User?
link.
Hardware Requirements
A Windows system must have the following minimum configuration to run the
Commerce Suite server.
11
Chapter 2: Preparing to Install Commerce Suite
Commerce Suite System Requirements - Windows
Software Requirements
A Windows computer must have the following software installed for the Commerce
Suite server application to function properly.
12
Chapter 2: Preparing to Install Commerce Suite
Commerce Suite System Requirements - UNIX
Hardware Requirements
A UNIX system must have the following minimum configuration to successfully
install Commerce Suite:
Software Requirements
A UNIX system must have one of the following UNIX operating systems to
successfully install Commerce Suite:
• HP-UX 11.00
• IBM AIX 4.3.3, 5.1
• Sun Solaris 8 (SunOS 5.8)
• SuSe 8.x, 9.0
• Red Hat 7.3, 8.0, 9.0
OS Patches
Patches for some operating systems are required to support the technology that
Commerce Suite uses. For a list of recommended patches, see the Commerce Suite
release notes in your installation directory.
13
Chapter 3: Commerce Suite Firewall
Configuration Settings
Introduction .................................................................................................... 15
Commerce Suite Firewall Considerations...................................................... 15
External Trading Partner Inbound Firewall Considerations ........................... 16
External Trading Partner Outbound Firewall Considerations......................... 17
Chapter 3: Commerce Suite Firewall Configuration Settings
Introduction
Introduction
The following configuration considerations will provide your firewall administrator
the information needed to make the necessary firewall configuration changes to
support communication with the Commerce Suite application.
_____________________________________________
2. Determine and record the port number that will be used for inbound AS2
messages. It is recommended that you use a port number such as 4080 or 5080.
This port number will be referred to as the external port number.
_____________________________________________
3. Determine and record the actual IP address of the internal machine running the
Commerce Suite application.
____________________________________________
4. Assign and record the port number that Commerce Suite, on the internal
machine, will use for it’s HTTP listener. The address and port number is
required during the Commerce Suite configuration process. We recommend
that you use the same port number as your external port. This port number will
be referred to as the internal port number.
_____________________________________________
15
Chapter 3: Commerce Suite Firewall Configuration Settings
External Trading Partner Inbound Firewall Considerations
5. Record the combination of your firewall IP address and your external port
number. This address will be provided to your trading partners and used by the
Commerce Suite configuration process.
_____________________________________________
1. You must configure a firewall inbound rule for the trading partner on the
external port number you selected.
2. Identify your trading partners’ sending IP address and potential port range they
will use.
_____________________________________________
The following table provides the configuration information you need in order to
conduct connectivity testing with nuBridges.
Note: All AS2 messages sent from the nuBridges Test server will originate
from the source IP address listed in table above. In addition, the nuBridges AS2
server can initiate multiple concurrent sending operations and will send from a
range of ports listed in the table above.
3. Ensure each trading partner is configured for inbound and outbound AS2 traffic
through your firewall based on their trading partner specific IP address and port
information.
16
Chapter 3: Commerce Suite Firewall Configuration Settings
External Trading Partner Outbound Firewall Considerations
Your external trading partners will provide you with the external IP address and port
on which they will receive the AS2 messages you send. You will use this information
to configure your Commerce Suite application for the trading relationship with this
partner. Additionally, you will need to configure your firewall to allow the Commerce
Suite application on the secure side of your network to send messages to the trading
partner’s AS2 server.
You must configure outbound firewall rules for each trading partner on the port
number that matches the trading partner’s external port number.
Send to nuBridges Test Server Configuration Information
Note: Each trading partner requires inbound and outbound modifications to your
firewall based on trading partner specific IP address and port information.
For outbound firewall rules, it is recommended that you configure for the primary
destination port of 4080, as well as the manual testing ports 4081 - 4088.
17
Chapter 4: Licensing and Upgrading
Commerce Suite
Introduction .................................................................................................... 19
About License Key Generation ...................................................................... 19
Licensing Requirements ................................................................................ 19
Upgrading Your Commerce Suite Software ................................................... 20
Chapter 4: Licensing and Upgrading Commerce Suite
Introduction
Introduction
The nuBridges Commerce Suite application, as shipped, starts and operates in
Demonstration mode. When the product is purchased, you are supplied with license
key material that enables you to convert the product to operate in Authorized
Installation mode.
nuBridges Technical Support creates icssvr.lic and icssvr.ini files based on your
configuration information, which contains an authentication number unique to each
machine. This authentication number, combined with a serial number in the icssvr.ini
file, are used to generate a license file (icssvr.lic). This license file allows your copy of
the software to run in Authorized Installation mode. As long as the icssvr.lic file
resides in the same directory as the icssvr binary file, you do not need to enter any
authentication codes to start the application in Authorized Installation mode.
Licensing Requirements
If you are configuring the product for Authorized Installation mode, you must
complete the following before licensing:
19
Chapter 4: Licensing and Upgrading Commerce Suite
Upgrading Your Commerce Suite Software
Upgrades for the nuBridges Commerce Suite software are available as complete
replacement modules within a ZIP or compressed archive file. As the upgrade occurs,
existing directory structures remain intact and system settings are unaffected. To
ensure your replacement module is applied, start Commerce Suite and issue a status
command to verify that you have properly upgraded your Commerce Suite
application.
20
Chapter 5: Installing Commerce Suite
Introduction .................................................................................................... 22
Installing on Windows .................................................................................... 22
Installing on UNIX .......................................................................................... 23
Installing on IBM AIX ........................................................................................................23
Installing on Linux .............................................................................................................24
Installing on HP-UX ..........................................................................................................25
Installing on Sun Solaris ...................................................................................................26
Uninstalling on UNIX...................................................................................... 27
Java 2 Runtime Environment Installation Verification .................................... 28
Chapter 5: Installing Commerce Suite
Introduction
Introduction
This chapter provides instructions for installing Commerce Suite on Windows and
UNIX operating systems as well as verifying Java 2 Runtime Environment
installation.
Installing on Windows
Follow the steps below to install Commerce Suite in a Windows environment.
3. Unzip the file using a common ZIP file manager and extract the Commerce
Suite software files into the isoft directory. The following should be present
after unzipping the file:
• isoft_csm(x).jar
• pki folder
• documentation folder
• icssvr
• test.txt
• TP_Info.ini
4. Copy the license files icssvr.lic and icssvr.ini to your c:\iSoft directory.
6. Commerce Suite has now been installed and you are ready to run Commerce
Suite Manager. Review Chapter 6: Configuring Commerce Suite for
instructions on running the Commerce Suite Manager.
22
Chapter 5: Installing Commerce Suite
Installing on UNIX
Installing on UNIX
Instructions for installing Commerce Suite on UNIX operating systems are provided
in the following sections:
2. Create an ICSSVR group. This is the recommended group name; however, you
can create a group using another name.
3. Create an ICSSVR user. This is the recommended user name; however, you can
create a user using a another name.
5. Obtain the current AIX .tar file. This .tar file contains the following files:
• isoft_csm(x).jar
• pki folder
• documentation folder
• icssvr
• test.txt
• TP_Info.ini
• buildcfg
7. Before using the Commerce Suite software, you must obtain the following files
from nuBridges:
• icssvr.lic
• icssvr.ini
23
Chapter 5: Installing Commerce Suite
Installing on UNIX
9. Enter chmod 755 icssvr to ensure that the icssvr file has executable permission.
Commerce Suite has now been installed and you are ready to run the Commerce Suite
Manager. Please review Chapter 6: Configuring Commerce Suite for instructions on
running Commerce Suite Manager.
Note: In order for Commerce Suite to operate properly on AIX 5.1 with Oracle, select:
System Management Interface Tool (SMIT) > Devices > Asynchronous I/O >
Change/Show Characteristics of Asynchronous I/O
Installing on Linux
Follow the steps below to install Commerce Suite on a Linux server.
2. Create an icssvr group. This is the recommended group name; however, you
can create a group using another name.
3. Create an icssvr user. This is the recommended user name; however, you can
create a user using a another name.
5. Obtain the current Linux .tar file. This .tar file contains the following files:
• isoft_csm(x).jar
• pki folder
• documentation folder
• icssvr
• test.txt
• TP_Info.ini
24
Chapter 5: Installing Commerce Suite
Installing on UNIX
7. Before using the Commerce Suite software, you must obtain the following files
from nuBridges:
• icssvr.lic
• icssvr.ini
8. Enter chmod 755 icssvr to ensure that the icssvr file has executable permission.
10. Enter ./icssvr to execute the icssvr binary. The message Authorized License
displays.
Commerce Suite has now been installed and you are ready to run the
application. Review Chapter 6: Configuring Commerce Suite for instructions
on running Commerce Suite Manager.
Installing on HP-UX
Follow the steps below to install Commerce Suite on an HP-UX server.
2. Create an icssvr group. This is the recommended group name; however, you
can create a group using another name.
3. Create an icssvr user. This is the recommended user name; however, you can
create a user using a another name.
5. Obtain the current HP-UX .tar file. This .tar file contains the following files:
• isoft_csm(x).jar
• pki folder
• documentation folder
• icssvr
• test.txt
• TP_Info.ini
• buildcfg
25
Chapter 5: Installing Commerce Suite
Installing on UNIX
7. Before using the Commerce Suite software, you must obtain the following files
from nuBridges:
• icssvr.lic
• icssvr.ini
8. Enter chmod 755 icssvr to ensure that the icssvr file has executable permission.
10. Enter ./icssvr to execute the icssvr binary. The message Authorized License
displays.
11. Commerce Suite has now been installed and you are ready to run Commerce
Suite Manager. Please review Chapter 6: Configuring Commerce Suite for
instructions on running Commerce Suite Manager.
2. Create an icssvr group. This is the recommended group name; however, you
can create a group using another name.
3. Create an icssvr user. This is the recommended user name; however, you can
create a user using a another name.
5. Obtain the current Sun Solaris .tar file. This .tar file contains the following
files:
• isoft_csm(x).jar
• pki folder
• documentation folder
• icssvr
• test.txt
• TP_Info.ini
26
Chapter 5: Installing Commerce Suite
Uninstalling on UNIX
• buildcfg
7. Before using the Commerce Suite software, you must obtain the following files
from nuBridges:
• icssvr.lic
• icssvr.ini
8. Enter chmod 755 icssvr to ensure that the icssvr file has executable permission.
10. Enter ./icssvr to execute the icssvr binary. The message Authorized License
displays.
Commerce Suite has now been installed and you are ready to run Commerce
Suite Manager. Please review Chapter 6: Configuring Commerce Suite for
instructions on running Commerce Suite Manager.
Uninstalling on UNIX
Follow the steps below to uninstall Commerce Suite from a UNIX computer:
rm -rf /opt/isoft
27
Chapter 5: Installing Commerce Suite
Java 2 Runtime Environment Installation Verification
Follow the steps below to verify that you have the correct version of the Sun JRE
installed.
If you have JRE version 1.4.x or later, you can use it to run Commerce Suite.
Proceed to step 8 and continue following the directions.
If you do not have JRE version 1.4.x or later, continue to proceed to step 2 for
instructions on downloading and installing the JRE software.
3. From within the Download J2SE v 1.4.x section, click Download from the JRE
column for the following software:
7. Execute the JRE installation file to install the Java Runtime Environment.
28
Chapter 5: Installing Commerce Suite
Java 2 Runtime Environment Installation Verification
Note: If you are running the nuBridges server as a service or daemon, stop it,
and run it in the foreground for the initial testing of the Commerce Suite
Manager (CSM).
10. After starting Commerce Suite (icssvr), enter the following command:
11. You are now ready to initialize Commerce Suite and configure it for
exchanging data with your trading partners.
29
Chapter 6: Configuring Commerce Suite
Introduction .................................................................................................... 31
Commerce Suite Manager Overview............................................................. 31
Commerce Suite Manager System Requirements ...........................................................31
Introduction
This section describes the steps necessary to configure Commerce Suite as a stand-
alone transport agent using a configuration file that will be read by the application
upon startup.
CSM helps you create the icssvr.cfg configuration file read by Commerce Suite upon
startup. It also helps you edit, add, and delete trading partner relationships, create
relationship certificates and key pairs, and test your Commerce Suite installation with
the nuBridges Self-Test Server.
For platforms other than Windows, please download Sun’s Java Runtime Environment
from Sun Microsystem’s Web site located at http://java.sun.com/j2se.
31
Chapter 6: Configuring Commerce Suite
Step 1 - Initializing Commerce Suite
For UNIX
Follow the steps below to start Commerce Suite Manager on AIX, HPUX, Linux, and
Solaris clients.
2. Open a terminal and navigate to the location of the isoft_csm.jar file and enter:
The Initialization dialog box displays. Please review the For Windows section
on page 33 to Step 2 within the For Windows section to continue initializing
Commerce Suite.
32
Chapter 6: Configuring Commerce Suite
Step 1 - Initializing Commerce Suite
For Windows
Perform the following steps to initialize Commerce Suite and create the icssvr.cfg
configuration file:
3. Complete the Commerce Suite Manager Initialization screen using the field
descriptions below.
My AS2 Name Enter your AS2 name. This is the AS2 name you want
associated with your business. Your trading partner will
use this name to communicate with you. This AS2 name
is a case-sensitive alphanumeric string (maximum 32
characters) that must not contain any spaces. It should
be descriptive and unique between trading partners,
33
Chapter 6: Configuring Commerce Suite
Step 1 - Initializing Commerce Suite
Yes, I have a
firewall Select this option if you do have a firewall device in
front of your Commerce Suite server. Enter the firewall
address into the Firewall IP Address field.
34
Chapter 6: Configuring Commerce Suite
Step 1 - Initializing Commerce Suite
Configure for
Wal-Mart Select Yes or No. If you select Yes to configure for Wal-
Mart, you must also select the appropriate Wal-Mart
location so that Commerce Suite Manager can create
the required configuration entries. You may choose from
the following locations: US, Canada, Mexico, UK, BR,
AR, CN, DE.
4. Click the Write Initial Configuration File button. The system creates your
Commerce Suite directories and the icssvr.cfg configuration file located in the
isoft root directory. The following screen displays.
6. Click OK. The Commerce Suite Manager main window displays. From the
main Commerce Suite Manager window, you can manage relationships,
perform testing, view log files, and adjust Commerce Suite Manager and
configuration file settings.
35
Chapter 6: Configuring Commerce Suite
Step 1 - Initializing Commerce Suite
Perform the following steps to initialize Commerce Suite when a previous nuBridges
Commerce Suite configuration file exists:
3. Click OK to dismiss the Error dialog box and display the CSM Settings page
of the Commerce Suite Manager dialog box.
36
Chapter 6: Configuring Commerce Suite
Step 1 - Initializing Commerce Suite
4. Under Certificate Detail Fields, click Edit to enable the Organization, City,
State, and Country fields. Enter your appropriate information.
8. Under Firewall Configuration, click Edit to enable the option buttons. Select
your firewall configuration.
10. Under My AS2 Names, click Add Name to specify your AS2 name.
37
Chapter 6: Configuring Commerce Suite
Step 2 - Editing a Trading Partner Profile
Follow the steps below to edit an existing trading partner profile using Commerce
Suite Manager:
2. Click the trading partner you want to edit from the Trading Partners table.
This will highlight the selected trading partner row.
3. Click Edit Trading Partner. Text fields display at the bottom of the dialog
box. Use these fields to edit the trading partner’s information.
38
Chapter 6: Configuring Commerce Suite
Step 3 - Configuring Your Inbox
The Inbox can be any directory that the Commerce Suite server can access.
Refer to the nuBridges
Commerce Suite
Command Reference for more Note: You must make sure that the directory exists before specifying it as the inbox. If
information on the addpair the inbox directory does not exist, errors are generated when attempting to receive
command.
files.
Follow the steps below to specify an inbox to be used for receiving data:
2. In the Trading Partners table, click the row that contains the trading partner
you want to edit. The selected row is highlighted.
39
Chapter 6: Configuring Commerce Suite
Step 3 - Configuring Your Inbox
3. Click Edit Trading Partner. Editable text fields display at the bottom of the
dialog box.
4. Locate the Inbox Location field and click the ... (Browse) button. Navigate to
the location you want to use as the inbox for this relationship.
5. Click Select Directory to choose the selected inbox directory. The path to that
directory displays in the Inbox Location field.
Note: If you select a directory path that contains spaces, you will receive an
error message. Ensure that the directory path does not contain spaces.
40
Chapter 6: Configuring Commerce Suite
Step 4 - Configuring Your Outbox
Follow the steps below to configure an automatic outbox using Commerce Suite
Manager.
3. In the Trading Partners table, click the row that contains the trading partner
you want to edit. The selected row is highlighted.
41
Chapter 6: Configuring Commerce Suite
Step 4 - Configuring Your Outbox
4. Click Edit Trading Partner. Editable text fields display at the bottom of the
dialog box.
42
Chapter 6: Configuring Commerce Suite
Step 4 - Configuring Your Outbox
6. Click Yes, I want an Outbox for this Trading Partner. The Auto Outbox
Configuration dialog box displays.
8. Click Save to confirm your outbox configuration. Commerce Suite will now
scan the specified directory at regular intervals looking for a file to send with an
.out extension. When a file is located, Commerce Suite sends the first file listed
in the directory.
43
Chapter 6: Configuring Commerce Suite
Step 5 - Creating Certificates and Keys
1. Start Commerce Suite Manager. The Commerce Suite Manager main window
opens.
3. In the Trading Partners table, click the row that contains the trading partner
you want to edit. The selected row is highlighted.
44
Chapter 6: Configuring Commerce Suite
Step 5 - Creating Certificates and Keys
5. Select Create new relationship key. The My Relationship Key Pair field
displays.
6. Enter a filename in the My Relationship Key Pair field. This filename should
have a .cer extension. There should not be any spaces in the filename.
45
Chapter 6: Configuring Commerce Suite
Step 5 - Creating Certificates and Keys
7. Click Save. A work order that will generate a new key pair will be written to
the workorder directory. If you have the Commerce Suite server console open,
a message confirming the generation and export of the key-pair displays once
the work order is processed.
8. Click Save Changes to keep your modified values, or click Cancel to discard
your changes.
9. Keys created by the initialization routing are placed in the Commerce Suite pki
directory and are available the next time the server is recycled.
10. From the Relationships page, click Configure Keys to make the keys active.
The Key Configuration dialog box displays.
12. Click the ... (Browse) button to select the newly created public key, which will
be located in pki/new directory.
13. Under Trading Partner Key, select the Use existing key option as your trading
partner will provide you with a certificate to be used in the trading relationship.
The TP Provided Certificate field displays.
14. Click the Browse (...) button next to the TP Provided Certificate field and
select the trading partner’s public key.
15. Click Save to save your settings and return to the Relationships page of the
CSM.
46
Chapter 6: Configuring Commerce Suite
Step 6 - Adding a New Trading Partner
Follow the steps below to define a new trading partner pair using Commerce Suite
Manager.
2. From the Relationships page, click Add New Trading Partners. The Add
New Trading Partner dialog box displays.
47
Chapter 6: Configuring Commerce Suite
Step 7 - Saving the Commerce Suite Configuration File
3. Complete the Add New Trading Partner dialog box using the field
descriptions below.
My AS2 Name Select your AS2 name from the drop down list.
Protocol From the drop down list, select the protocol to be used
for this trading relationship.
Import Trading
Partner Select your trading partner from the drop down list.
Selecting a trading partner from this list automatically
populates the remaining trading partner fields. If your
trading partner is not displayed in the list, enter the
appropriate information into the remaining trading
partner fields.
4. Click the ... (Browse) button located next to the Inbox Location, to select the
inbox for this relationship.
5. Click Add once you have entered all of the trading partner information. The
new trading partner relationship now displays within the Trading Partners list
on the Relationships page.
48
Chapter 6: Configuring Commerce Suite
Step 10 - Testing Commerce Suite Connectivity
Please review Chapter 7: Testing Commerce Suite for detailed instructions on using
the nuBridges Self-Test website to test your firewall configuration and Commerce
Suite connectivity.
When prompted from the nuBridges Self-Test Server Web site, click the appropriate
Send nuBridges Test X button to create the work order file that will be executed by
the Commerce Suite server.
In addition to using the nuBridges Self-Test server to test your connectivity with
nuBridges, you can perform a connectivity test for every trading partner you add to
your trading community.
49
Chapter 7: Testing Commerce Suite
Introduction .................................................................................................... 51
Testing Requirements .................................................................................... 52
Testing Commerce Suite Connectivity ........................................................... 53
Step 1 - Accessing and Logging In to the Self-Test Web Site...........................................53
Step 2 - Verifying the Requirements .................................................................................55
Step 3 - Uploading Files....................................................................................................56
Step 4 - Receiving Test Files ............................................................................................58
Error Code Example...................................................................................................59
Introduction
This section describes the procedures for using the nuBridges Self-Test website to test
your firewall configuration and Commerce Suite connectivity. The self-testing process
consists of the following steps:
Logging into the nuBridges Self-Test Web site authenticates your nuBridges
Customer Support credentials, allowing you to continue with the test.
• Meeting the Self-Test requirements
Ensures the necessary requirements are met prior to conducting the Self-Test.
• Uploading your public key and configuration file
Uploading your public key and configuration file is necessary for configuring
your Commerce Suite instance as a trading partner with nuBridges and for
encryption and signature verification.
• Receiving test files
The receiving test verifies that Commerce Suite can receive a file from the
nuBridges test server, return an MDN, verify a digital signature, decrypt an
encrypted file, and decompress a compressed file
• Sending test files
The sending test verifies that Commerce Suite can send a digitally-signed,
encrypted, compressed file, requesting an MDN, to the nuBridges test server.
51
Chapter 7: Testing Commerce Suite
Testing Requirements
Testing Requirements
In order to run the self-test workflow, the following is required:
• You must register with nuBridges Support to receive a user ID and password for
performing the send and receive testing. Go to support.nubridges.com and
select the New User link located under the login box.
• You must be running a standards-based Internet browser, such as Internet
Explorer 6.0 or greater.
• You must run the self-test on the same machine as Commerce Suite.
• During the self-test, you must not double click the form buttons or use the
browser’s Back button.
• If you do not already have it, you must download the ISOFTAS2TEST.cer file to
your \isoft\pki directory.
52
Chapter 7: Testing Commerce Suite
Testing Commerce Suite Connectivity
./icssvr
3. Enter the username and password given to you when you registered with
nuBridges.
53
Chapter 7: Testing Commerce Suite
Testing Commerce Suite Connectivity
5. Follow the steps on this screen in numerical order to complete the nuBridges
Self-Test procedure.
54
Chapter 7: Testing Commerce Suite
Testing Commerce Suite Connectivity
1. From the main Self-Test screen, select Requirements for Configuration Self
Test. The Requirements screen displays.
2. Make sure all the requirements listed on this screen have been met.
55
Chapter 7: Testing Commerce Suite
Testing Commerce Suite Connectivity
3. Click Upload Configuration. When the file has been uploaded successfully, a
verification screen displays.
56
Chapter 7: Testing Commerce Suite
Testing Commerce Suite Connectivity
4. Click Continue. The Upload Certificate screen displays, showing the name of
the public certificate file you need to upload.
5. Click Browse to navigate to the location of the public certificate file displayed,
and select this file from the list.
6. Click Upload Configuration. When the file has been uploaded successfully, a
verification screen displays.
57
Chapter 7: Testing Commerce Suite
Testing Commerce Suite Connectivity
1. From the main Self-Test screen, select Start Test 1. The Test 1 screen displays.
2. Click Start Test 1 to start the test. Once the test begins, the following screen
displays.
58
Chapter 7: Testing Commerce Suite
Testing Commerce Suite Connectivity
If this test is successful, the results are displayed and a file appears in your
inbox. If notices are turned on, a notice of a received file displays in your
notice directory. If the test is unsuccessful, an error message will be displayed.
If no results are returned within 3 minutes of starting the test, you should
consider the test unsuccessful and click Recheck Test 1 Results Now to repeat
the receive test.
3. When you have successfully finished the receive test, click Continue. The main
Self-Test screen displays.
59
Chapter 7: Testing Commerce Suite
Testing Commerce Suite Connectivity
Note: Ensure that the icssvr application is running before performing this test.
1. From the nuBridges Self-Test main screen, select Start Test 2. The Test 2
screen displays.
This test verifies that you can send a file to the nuBridges test server. It displays
a send command to use for testing.
60
Chapter 7: Testing Commerce Suite
Testing Commerce Suite Connectivity
3. Copy and paste the send command shown on the Send Test screen into the
Commerce Suite command window.
or
4. Click Check Test 2 Results. If this test is successful, and you have notice
records turned on, an outbound file notice is sent to the notice directory.
This completes connectivity testing on the Commerce Suite server. You can now
proceed to configuring and testing with your external trading partners.
Note: At any time during your testing, you can click Reset Tests to start the testing
procedure over from the beginning.
61
Chapter 8: Understanding Commerce Suite
Files and Directories
Introduction .................................................................................................... 63
About Commerce Suite Files and Directories................................................ 63
Chapter 8: Understanding Commerce Suite Files and Directories
Introduction
Introduction
Prior to installation, you are asked to create an nuBridges directory. The nuBridges
directory acts as a repository for files and folders used to interact with other trading
partners defined in your Commerce Suite configuration. For this reason, the nuBridges
directory can be considered a support directory for the nuBridges products installed on
your system.
The following table illustrates the directory structure created for you by Commerce
Suite Manager during Commerce Suite configuration. This directory structure also
provides an example of a typical structure you might create as a repository for files
you use when exchanging EDI data with other trading partners.
Installation Directories
Directory Contents
error Contains files that could not be sent or properly received.
inbox Default inbound document storage location.
log Contains daily log files of system activity.
notice Contains status files indicating results of document transactions.
outbox Contains outgoing files.
pki Default location for all certificate and key files.
receipt Location of AS2 receipt documents.
workorder Location of instruction (.wo) files providing parameters for sending files.
63
Chapter 9: Post Installation Considerations
Introduction .................................................................................................... 65
Starting and Stopping Commerce Suite......................................................... 65
For Windows.....................................................................................................................65
For UNIX...........................................................................................................................65
Starting Commerce Suite Server................................................................................65
Stopping Commerce Suite Server ..............................................................................65
Introduction
This chapter provides information procedures you may need to execute after installing
Commerce Suite.
For Windows
Follow the steps below to start Commerce Suite.
1. Use Windows Explorer to navigate to the directory where the icssvr.exe file is
located.
For UNIX
This section provides instructions on how to start and stop Commerce Suite on a
supported UNIX platform.
65
Chapter 9: Post Installation Considerations
Testing Trading Partner Connectivity
The trading partner test enables you to send a test file to your trading partner that will
verify that your Commerce Suite instance can send an encrypted file using a digital
certificate and requesting signed receipt.
Follow the steps below to test your connectivity with one of your trading partners.
1. Start Commerce Suite Manager. The Commerce Suite Manager main window
opens.
66
Chapter 9: Post Installation Considerations
Testing Trading Partner Connectivity
Select Trading
Partner Select a trading partner from the drop down list.
Select File To Send Enter the name of the file you want to end, or click the
browse button to select the file.
Encrypt File
Before Sending? Specify if you want to test Commerce Suite encryption.
Your choices are Yes and No.
Use Digital
Signature? Specify if you want to test using a digital signature.
Your choices are Yes and No.
Request Signed
Receipt? Specify if you want to request a signed receipt with your
test file. Your choices are Yes and No.
4. Click Send Test File. The test file is sent to the trading partner.
67
Chapter 9: Post Installation Considerations
Editing AS2 Names
1. Start Commerce Suite Manager. The Commerce Suite Manager main window
opens.
2. Click the CSM Settings tab to view your Commerce Suite settings.
4. Enter the new AS2 name in the Add AS2 Name field (maximum 32
characters).
6. Click OK. The new AS2 name displays in the My AS2 Names list.
7. Select the File menu Save Config File option to keep your modified values, or
click Cancel to discard your changes.
8. Select the File menu Write Configuration File option to write your Commerce
Suite Manager modifications to the configuration file.
9. From the File menu, select Exit. Commerce Suite Manager closes.
68
Chapter 9: Post Installation Considerations
Editing Your IP Address
1. Start the Commerce Suite Manager. The Commerce Suite Manager main
window displays.
2. Click the CSM Settings tab. Your Commerce Suite settings display.
4. This is the actual address and port of the machine that runs the Commerce Suite
server (icssvr).
5. Enter your new IP address and http port in the appropriate fields.
7. From the File menu, select the Save Config File option to keep your modified
values, or click Cancel to discard your changes.
8. From the File menu, select the Write Configuration File option to write your
Commerce Suite Manager modifications to the configuration file.
9. From the File menu, select Exit. Commerce Suite Manager closes.
1. Start Commerce Suite Manager. The Commerce Suite Manager main window
opens.
2. Click the CSM Settings tab to view your Commerce Suite settings.
4. Enter your firewall address and port number in the Firewall IP Address field.
5. Click Save.
6. From the File menu, select the Save Config File option to keep your modified
values, or click Cancel to discard your changes.
7. From the File menu, select the Write Configuration File option. Commerce
Suite Manager writes the modifications to the configuration file.
8. From the File menu, select Exit. Commerce Suite Manager closes.
69
Chapter 9: Post Installation Considerations
Configuring for HTTPS or Secure FTP
Follow the steps below to configure an HTTPS or Secure FTP trading partner using
Commerce Suite Manager.
1. Start Commerce Suite Manager. The Commerce Suite Manager main window
opens.
2. Click the CFG Settings tab. Your Commerce Suite HTTPS configuration
settings display.
3. Under HTTPS configuration, click Edit. The Public and Private Key fields
are enabled.
4. Click the ... (Browse) button next to the Public Key field to select a public key.
5. Click the ... (Browse) button next to the Private Key field to select a private
key.
7. Click Save.
8. From the File menu, select the Save Config File option to keep your modified
values, or click Cancel to discard your changes.
9. From the File menu, select the Write Configuration File option. Commerce
Suite Manager writes the modifications to the configuration file.
10. From the File menu, select Exit. Commerce Suite Manager closes.
70
Chapter 9: Post Installation Considerations
Configuring for AS1 or Alerts
Follow the steps below to configure an AS1 trading partner using the Commerce Suite
Manager.
1. Start Commerce Suite Manager. The Commerce Suite Manager main window
opens.
2. Click the CFG Settings tab. Your Commerce Suite HTTPS configuration
settings display.
3. Under SMTP/POP3 Configuration, click Edit. The SMTP and POP3 related
fields are enabled.
5. From the File menu, select the Save Config File option to keep your modified
values, or click Cancel to discard your changes.
6. From the File menu, select the Write Configuration File option. Commerce
Suite Manager writes the modifications to the configuration file.
7. From the File menu, select Exit. Commerce Suite Manager closes.
71
Chapter 9: Post Installation Considerations
Monitoring the Commerce Suite Log File
1. Start Commerce Suite Manager. The Commerce Suite Manager main window
opens.
2. Select the Logging tab. The Commerce Suite log file displays.
3. Click the ... (Browse) button next to the Select Current Log File field and
select a log file to monitor.
4. In the Number of Lines to Read field, enter the number of lines that will be
displayed from the end of the file.
72
Chapter 9: Post Installation Considerations
Monitoring the Commerce Suite Log File
5. Click View a Log File to start the file viewing cycle. The file contents will be
refreshed every 10 seconds.
6. From the File menu, select the Save Config File option to keep your modified
values, or click Cancel to discard your changes.
7. From the File menu, select the Write Configuration File option. Commerce
Suite Manager writes modifications to the configuration file.
8. From the File menu, select the Exit. Commerce Suite Manager closes.
73
Chapter 9: Post Installation Considerations
Running Commerce Suite Server as a Windows Service
• Windows can start the Commerce Suite server application during the Windows
system initialization process and stop the application when Windows is shut
down.
• The Windows system administrator can use Windows services to manually start
or stop the service from the local machine that hosts Commerce Suite.
• Multiple users of a single machine hosting the Commerce Suite application can
log on and off without disruption to the Commerce Suite application.
The following topics are provided for using Commerce Suite as a Windows service:
From a command line prompt on your Windows machine, type the following:
icssvr -install
This places the Commerce Suite application in the Windows service list. You can now
start the service either from the command line or from the Administrative Tools >
Services option in the Windows Control Panel.
Note: When running as an Windows service, Commerce Suite receives all commands
via work orders. The icssvr.cfg file must have the -of option set in order to allow
proper communication with the application. Please review the nuBridges Commerce
Suite Command Reference for more information on the -of option.
74
Chapter 9: Post Installation Considerations
Running Commerce Suite Server as a Windows Service
Follow the steps below to install Commerce Suite as a service with a specific service
name
2. Add the following two lines above the opening <xml> tag:
[Settings]
ServiceName = <service_name>
where <service_name> is the name of the specific service.
1. Select Start > Control Panel > Administrative Tools Services. The list of
installed Windows services displays.
2. Select icssvr from the services list and choose Action > Properties. The
Properties dialog displays.
3. From the Startup Type drop down list, select Manual to manually start
Commerce Suite or select Automatic to start Commerce Suite automatically
when the system is booted.
75
Chapter 9: Post Installation Considerations
Running Commerce Suite in the Background on UNIX Systems
1. Select Start > Control Panel > Administrative Tools Services. The list of
installed NT services displays.
2. Select icssvr from the services list and choose Action > Stop. This stops the
Commerce Suite application.
To stop Commerce Suite from the command line, enter the following command:
To remove Commerce Suite from the Windows services list, enter the following
command:
icssvr -remove
icssvr -e
This command completely frees the Commerce Suite application from a term session
and will survive any interruption with the exception of a hardware change.
Note: Adding nohup to the command (e.g., nohup icssvr -e) causes the daemon to
ignore SIGHUP, if needed.
76
Chapter 9: Post Installation Considerations
Running Commerce Suite as a Daemon on UNIX Systems
case “$1” in
‘start’)
if [ -f /opt/isoft/icssvr ]; then
cd /opt/icssvr
nohup icssvr -e
fi
;;
stop’)
/usr/bin/pkill -x -u 0 ‘(icssvr)’
;;
*)
echo “Usage: $0 { start | stop ]”
exit 1
;;
esac
exit 0
77
Appendix A: Conducting Manual
Commerce Suite Operations
Introduction .................................................................................................... 79
Starting and Stopping Commerce Suite......................................................... 79
Starting Commerce Suite..................................................................................................79
Stopping Commerce Suite ................................................................................................80
Checking Commerce Suite Status ....................................................................................80
Introduction
This appendix contains the following sections:
When the initialization tasks are complete, a blinking cursor appears below the
title message. The Commerce Suite application is now ready to accept
commands from the local console.
Although the Commerce Suite application can accept console command at any
time, it may be more desirable to have Commerce Suite read configuration
commands from a configuration file. It is also possible to enter configuration
commands as command-line arguments when the application is started.
79
Appendix A: Conducting Manual Commerce Suite Operations
Starting and Stopping Commerce Suite
To check the status of a Commerce Suite instance when running as an NT service, you
must use the start gui command prior to checking the status.
80
Appendix A: Conducting Manual Commerce Suite Operations
Understanding Configuration and Work Order Files
Because the icssvr.cfg file is a text file using an XML command structure, all
configuration files must begin with a beginning xml tag (<xml>) and end with an xml
tag (</xml>).
The following sample icssvr.cfg configuration file is created using the following
command categories:
81
Appendix A: Conducting Manual Commerce Suite Operations
Understanding Configuration and Work Order Files
<xml>
<comment>configuration settings</comment>
<command>set -eperror -ef</command>
<command>set -lplog -lf</command>
<command>set -npnotice -nf-</command>
<command>set -opworkorder -oswo</command>
<command>set -pppki</command>
<command>set -rpreceipt</command>
<command>set -tr300s</command>
<command>set -hno -hni</command
<comment>iSoft Testing</comment>
<comment>start services</comment>
<command>start http://127.0.0.1:5080/</command>
</xml>
82
Appendix A: Conducting Manual Commerce Suite Operations
Understanding Configuration and Work Order Files
1. Always save and copy your icssvr.cfg file before editing it.
2. If you manually edit the configuration file while the Commerce Suite
application is active, any changes you make will not be active until you restart
the application. Furthermore, any changes made through console commands
will not be made permanent unless they are added to the icssvr.cfg file.
3. No validation or value checking occurs while you are editing the icssvr.cfg file.
Any errors detected will be displayed on the console when the application
starts.
Note: If you use Notepad to edit the icssvr.cfg file, make sure that it does not
automatically append a .txt extension to the filename.
83
Appendix A: Conducting Manual Commerce Suite Operations
Understanding Configuration and Work Order Files
The following example shows the contents of a sample work order file, sendfile.wo.
<xml>
<command>send http CompanyA CompanyB -fNtest.txt↵
-n1</command>
</xml>
Commands listed in a work order file may be submitted to the Commerce Suite
command queue in the following ways:
• Work order files can be opened and executed using the Commerce Suite batch
command.
For example, the following entry in an icssvr.cfg file setups a work order
directory that Commerce Suite monitors for files that have a .wo extension:
84
Appendix A: Conducting Manual Commerce Suite Operations
Sending Data
Sending Data
Commerce Suite can be configured to perform manual one time sends or automatic
(persistent) sends depending on your organizations needs.
The following sample command provides the syntax you must use to initiate a one
time data send. Type the following command line at the console window to enable
your one-time send.
85
Appendix A: Conducting Manual Commerce Suite Operations
Sending Data
The following parameters are required when editing the icssvr.cfg file for persistent
sends: -fP, -fS, -fE, -tC, -tE.
• The send http sender receiver command specifies the trading partner sending
the data, and the trading partner receiving the data.
• The -fPout parameter specifies the path where the file being sent is located.
• The -fSout parameter specifies the name of the file to be sent.
• The -fE.sent parameter specifies to add the .sent extension to the file after it is
sent.
• The -tC60s parameter specifies that there should be an interval of 60 seconds
between directory scans to search for files to be sent.
• The -tE20040101000000 parameter specifies that the message should be sent
until the specified date and time (Year, Month, Day, Hour, Minute, Second).
86
1000 Abernathy Road · Building 400, Suite 250 · Atlanta, Georgia 30328
800.251.4930 toll free · 770.730.3600 main · 770.730.3784 fax
[email protected] · www.nubridges.com