IBM® Maximo® e-Commerce Adapter Installation Guide

Release 7.1

Installation Guide

IBM Maximo e-Commerce Adapter

This edition applies to version 7, release 1, modification 0 of IBM Maximo e-Commerce Adapter and to all subsequent releases and modifications until otherwise indicated in new editions.

© Copyright International Business Machines Corporation 2008. All rights reserved.

US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

NoteBefore using this information and the product it supports, read the information in “Notices” on page 21.

Contents

About This Publication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vIntended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v

Chapter 1: IBM Maximo e-Commerce Adapter Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Terminology and Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Chapter 2: IBM Maximo e-Commerce Adapter installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Installation fast track overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Installing from the CD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Deploying the e-Commerce Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Uninstalling previous versions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Installing the .ear files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Restarting the servers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Chapter 3: Configuring the e-Commerce Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

e-commerce enabling companies in IBM Maximo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Configure the e-Commerce credentials for your suppliers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Configure your supplier relationships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

IBM Maximo Online Commerce System Supplier Network. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Setting default vendors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Autonumbering for special order items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Configuring automatic reordering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 e-Commerce capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Buyer-initiated transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Supplier-initiated transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Receiving electronic invoices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Chapter 4: Administering the e-Commerce Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

IBM Maximo e-Commerce Adapter HOME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Setting preferences. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Transaction Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Location Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Locations summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17View IBM Maximo location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17View remote location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Edit remote location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18New location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Remote location options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Data Store activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Record set view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Record set details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

© Copyright IBM Corp. 2008 iii

iv IBM Maximo e-Commerce Adapter: Installation Guide

About This Publication

This section explains how this guide can help you to use IBM® Maximo® e-Commerce Adapter. It also provides information about other IBM Corporation resources available to you, such as additional documentation and support.

Intended Audience

This guide is intended for those who are extending the IBM® Maximo® e-commerce capabilities via the IBM Maximo e-Commerce Adapter:

System administratorsImplementation team members

© Copyright IBM Corp. 2008 v

Intended Audience

vi IBM Maximo e-Commerce Adapter: Installation Guide

x

To use the IBM® Maximo® e-Commerce Adapter you must be familiar with the terminology used and what options are available on the HOME page.

Terminology and Definitions

Several of the following terms are fully explained in the subsequent chapters; however, a brief overview will assist in understanding the component model and how components relate to each other.

What is a Location? A location is a specific communications integration point. For the IBM Maximo e-Commerce Adapter, the primary remote location is the IBM Maximo Online Commerce System hosting center. You may create other locations (such as a test location) as required.

What is the Data Store? The Data Store is a local repository for logging all transactional activity. It is a powerful debugging tool during development as well as for any trouble-shooting if error situations occur.

What is the CVO? The Common Values Object (CVO) is the superset of all transactions and fields supported by the IBM Maximo e-Commerce Adapter. Provided as a separate package, this is used for easy object-oriented reference to transactions and fields without concern of the interoperable format required by specific e-commerce partners. It also enables quick updates for enhancements of transaction definitions without impact on any existing services

This component architecture allows for two main benefits:

This CVO component may be updated and distributed independently of the entire IBM Maximo e-Commerce Adapter. This allows for a more flexible and frequent distribution.The CVO exposes all transactions and fields at an object layer for easy custom services programming reference. You need not worry about specific transaction formatting.

IBM Maximo e-Commerce Adapter Overview 1

© Copyright IBM Corp. 2008 1

Terminology and Definitions

2 IBM Maximo e-Commerce Adapter: Installation Guide

x

Installing the IBM® Maximo® e-Commerce Adapter is a two-part process. First, you install the software onto your computer, then you deploy it to your application server. These instructions are for installing the adapter on an IBM® WebSphere Application Server. Other application servers are supported; however, for the purposes of this document the instructions refer to the IBM WebSphere Application Server platform only.

Prerequisites

Before you install the e-Commerce Adapter, IBM® Maximo® Asset Management must be installed.

You need the following information to install the adapter:

e-Commerce server name and the IP addresse-Commerce server port numberIBM Maximo administrator user nameIBM Maximo administrator password

Installation fast track overview

You can install the e-Commerce Adapter by following this overview, or start with the section "Installing from the CD," on page 4.

1. Pre-installation requirements

You must have the following items before installing the e-Commerce Adapter:

IBM Maximo Asset Management IBM Websphere Application Server

2. Install IBM Maximo e-Commerce Adapter

From the IBM Maximo eCommerce Adapter CD run the ecommerce.exe file and follow the installation process.

3. Configure your Web server

Log in to your application server, as administrator:

Delete any previously deployed e-Maximo or Maximo applications.Deploy the eca-core.ear file.Deploy the e-maximo.ear file.

4. Configure your e-Commerce credentials

Define your user and supplier relationships.

IBM Maximo e-Commerce Adapter installation 2


Installing from the CD

In the IBM Maximo Online Commerce System, for each unique supplier or group of suppliers you must do the following:

Register a buying company at the IBM Maximo Online Commerce System site where the e-commerce partner suppliers are listed and request access to the supplier. The supplier must be registered in the IBM Maximo Online Commerce System.

Record the ID the buying company was assigned.

In IBM Maximo, open the Companies application and, for each unique supplier or group of suppliers you must do the following:

Update or create each buyer company as registered in the IBM Maximo Online Commerce System.

For each associated user, assign this company as the default Ship To address.

5. Configure your supplier e-commerce credentials

If the e-commerce partner supplier supports a catalogue in the IBM Maximo Online Commerce System hosted environment, that is, an IBM Maximo Online Commerce System Premier™ Supplier, then you must set the following fields in the Company Master application:

6. Configure your supplier relationships

In IBM Maximo, open the Organizations application go to the Organization tab and from the Select Action menu, choose e-Commerce Setup. For each relationship, select New Row and provide the following information:

Installing from the CD

To install from the IBM Maximo eCommerce Adapter CD, run the ecommerce.exe file and follow the instructions in the installer.

Field Value

Punchout enabled? Yes

Catalog Name The IBM Maximo Online Commerce System catalog assigned to each supplier.

e-Commerce Supplier Location

Remote Location Alias for the possible supplier associations with different remote locations.

Field Value

Site Leave the default value.

Vendor Select a supplier

MarketPlace ID Enter the MROID of the buying company.

MarketPlace ID Domain Type MROID


Deploying the e-Commerce Adapter


Before you can use the e-Commerce Adapter, you must deploy the .ear files onto the application server. If you are upgrading from a previous version, you must unistall the previous version first.

Uninstalling previous versions

You must log into the web server and uninstall any previous versions of the e-Commerce Adapter before installing this version.

1 Log into the Web server as administrator.

2 In the left pane, select Servers > Application Servers.

3 Stop the Application Server where the adapter is being deployed:

4 In the left pane, select Applications > Enterprise Applications. If there is e-MAXIMO or eca-core, uninstall them.

Installing the .ear files

You must install the eca-core.ear and the e-maximo.ear files as part of the deloyment. Install one, then the other using the following procedure.

To install an ear file:

1 In the left pane, select Applications > Install New Application.

2 Find the appropriate ear file and click Next.

3 Complete the steps of the wizard using the following information:

Field Value

Distribute application Select

Application Name Type e-Commerce Adapter Server

Create MBeans for resources Select

Validate Input Select Warn

All other check boxes Cleared

IBM Maximo e-Commerce Adapter installation 5


Restarting the servers

After you deploy the .ear files, restart the servers.

1 In the left pane, select Servers > Application Servers.

2 Select the server you are starting and click Start.


x

After installing and deploying the e-commerce files, you must configure your system to communicate with other e-commerce users.

e-commerce enabling companies in IBM Maximo

In IBM® Maximo® you must set your IBM Maximo Online Commerce System e-commerce credentials as well as that of your partners.

Each IBM Maximo buyer can identify a unique relationship to one or more suppliers and catalogues within the IBM Maximo Online Commerce System or you may have only one.

As IBM Maximo is highly configured, the following are only a sample to represent an IBM Maximo view. Your site may vary.

1 Log into IBM Maximo.

2 From the Go To navigation options select one of the following: To set credentials for yourself, select Purchasing > Companies.To set credentials for a supplier, select Purchasing > Company Master.

3 Search & edit or create the required company.

4 If you have not yet entered the e-commerce credentials for your IBM Maximo buyers, the minimum e-commerce configuration requires entries for the following fields:

5 For each user with connectivity, assign the default SHIP TO address for purchase requisition to match the Buyer company name entered in step 4. This indicates the ID of the buying company of the user for the IBM Maximo Online Commerce System.

Configuring the e-Commerce Adapter 3

Field Value

Company Name

Currency Defaults to USD

e-Commerce Enabled Yes (check the box)

e-Commerce Supplier ID This is your assigned MROID or other valid ID for the company.


e-commerce enabling companies in IBM Maximo

Configure the e-Commerce credentials for your suppliers

You must indicate how you interact with each company you deal with regarding e-commerce functions.

In the Company Master application, for each supplier, set the fields as shown in the following table:

Configure your supplier relationships

For each external e-commerce configuration an organization must be defined and referenced within the supplier company.

To configure your supplier relationships:

1 Open the Organizations application.

2 Search & edit or create the required organization.

3 For each organization, from the Select Action menu, select E-Commerce Setup.

4 For each relationship, fill in the fields as shown in the following table:

Field Value

Company Name

Currency Defaults to USD.

e-Commerce Enabled Yes

e-Commerce Supplier ID Enter the MROID or other valid ID of the e-commerce partner company.

Organization This associates the supplier with a particular group external access. Each organization represents a unique external access configuration.

Punchout Enabled (Optional) Check if the supplier supports a catalogue in the IBM Maximo Online Commerce System hosted environment (or elsewhere).

Catalog Name (Optional) The IBM Maximo Online Commerce System catalogue name for the hosted supplier catalog.

E-Commerce Supplier Location

(Optional) Remote Location Alias for the supplier associations with different remote locations

Field Value

Site Leave the default value.


IBM Maximo Online Commerce System Supplier Network

5 For a new relationship, click New Row.

Repeat for each unique supplier relationship required.

IBM Maximo Online Commerce System Supplier Network

Select this from the IBM Maximo Online Commerce System Adapter home page to link to the hosted IBM Maximo Online Commerce System network site. There, you can login and manage your IBM Maximo Online Commerce System options.

Setting default vendors

You can set default vendors for items that users order in Desktop Requisitions. This data is stored at the Organization level.

For example, you can specify a default vendor for some non-stocked items. The buyer can change the vendor.

Primary vendor is another type of default vendor you use with the reorder process in Purchase Orders and Purchase Requisitions. You specify it in the Primary Vendor field on the Reorder Details tab in Inventory.

If no primary vendor is specified for an item, the reorder process checks whether a default vendor is specified and takes that value if it exists. The primary vendor data is stored at the Site/Storeroom level.

To set default vendors:

1 Open the Item Master application.

2 Display the appropriate item record and open the Vendors tab.

3 In the Vendors table window, click Details for the appropriate vendor.

4 Check the Default Vendor field.

5 Save the record.

You can set the default vendor in the Inventory application using the Reorder Details tab.

Vendor Set to the supplier added in the preceding steps.

MarketPlace ID Set to the buyer company MROID or other valid ID as previously entered.

MarketPlace ID Domain

Enter MROID or other valid domain name.

Field Value


Autonumbering for special order items

When a user requisitions this item in Desktop Requisitions, and the Store Location field is empty, the default vendor appears in the Vendor field.

Autonumbering for special order items

Special order items are items that you do not stock in inventory, so they have no inventory item numbers. You must order them by description. This is generally sufficient for ordering and tracking.

To generate item numbers for special order items:

1 Open the Organizations application and select the appropriate Organization.

2 From the Select Action menu, choose Purchasing Options > PO Options.

3 Select the Allow the Generation of Special Order Items? box.

4 Click OK.

5 Click Save Organization.

Configuring automatic reordering

In the Inventory application, you reorder storeroom items from the Select Action menu item Reorder. You can run this process automatically.

Use the Cron Task Setup application to specify the schedule and these parameters. For information about the Cron Task Setup application, see the IBM Maximo System Administration Guide.

Field Description

ignorereorderpoint Whether reorder cron task ignores the reorder point of the storeroom.1 = true; 0 = false

logfile The complete path of the log file for reorder cron task result, or stdout = system standard output, stderror = system standard error.If not specified, the file specified by mxe.msgLogFile is used.

emailto The e-mail address where the reorder result is sent. Results for each storeroom are sent as individual e-mails.The mxe.adminEmail and mail.smtp.host properties must be specified to receive e-mail.


e-Commerce capability


To engage in e-commerce transactions, your Organization and the supplier must be e-commerce enabled.

e-commerce suppliers have their catalog available at the IBM Corporation Operations Center or on an external Web site. The supplier and buyer may approve relationships and create accounts with each other.

Users generate requisitions using Desktop Requisitions and Purchase Requisitions, which include searching and requisitioning screens.

You can configure your site to generate approved purchase orders automatically from requisitions, and route them directly to e-commerce enabled suppliers.

Route requisitions through a workflow process to purchasing agents or other appointed individuals in your organization.

Approved purchase orders are sent to suppliers via Open Applications Group (OAG) XML transactions. Further transactions and notifications regarding the status of the purchase order are handled electronically.

Use the Security Groups application to grant Desktop Requisition or work order users access to Search Catalogs.

directissue A list of Sites (semicolon-separated Site IDs) for which the reorder cron task processes direct issue items.If it is an empty string, direct order items are not reordered for any Site. For example: site1;site2

useagreement Whether reorder cron task considers agreements.1 = true; 0 = false

leadtime The extra lead time the reorder cron task includes, in days. Default = 0.

storeroom A list of storerooms (semicolon-separated storeroom comma Site pair) the reorder cron task processes at each run.If the property has an empty string, no storeroom is reordered. For example: site1,storeroom1;site2,storeroom2;

Field Description



Buyer-initiated transactions

These are transactions that can be initiated by a buyer:

Supplier-initiated transactions

These are transactions that can be initiated by a supplier:

For supplier companies you regularly do business with, create a company record in Maximo and complete its e-commerce Details section. See the Companies Help for more information.

Purchasing agents can create a Person record in Maximo, to have the ability to receive transaction e-mail notifications, like Vendor Order Status or Advance Ship Notice. Administrative users can create this record for them.

Requisitioners can receive these notifications if they select the TRANSEMAILELECTION in the Profile Page of Desktop Requisitions.

Receiving electronic invoices

You can configure the ability to receive electronic invoices and (optional) to have the receipt of the invoice initiate a Workflow process.

1 In the Companies application, display the company record.

2 In the e-Commerce Details section of the Company tab, select the e-Commerce Enabled check box.

3 Select the Vendor Sends Invoice check box.

Transaction Description

PO Transaction Sends the purchase order to the supplier. Is the first transaction sent to the supplier.

Cancel PO Sends the purchase order cancellation notice to the supplier.

Catalog Search Allows the buyer to search external supplier catalogs and retrieve items to add to Desktop Requisition or Materials Requisition

Transaction Description

Acknowledge PO Confirms the supplier received the purchase order. Is the first transaction received from the supplier.

Advance Ship Notice (ASN)

Provides information detailing intents to transport specific quantities of items from a supplier to a single destination.

Invoice Provides invoicing information on items shipped.



If the e-Commerce Enabled box is selected, but the Vendor Sends Invoice box is not, the company must send manual invoices.

When an electronic invoice is received, it creates a record in the Invoices application, populating the INVOICE and INVOICELINE tables.




x

IBM Maximo e-Commerce Adapter HOME

Access to each of the IBM Maximo e-Commerce Adapter Services is available via links on the HOME page. These links include the following items:

Data Store Activity: This provides access to logging and testing tools to track the transaction communications to and from the IBM Maximo Online Commerce System.

Location Manager: Used for the configuration of remote location services, defining where and in what format transactions must be sent. After the IBM Maximo e-Commerce Adapter is installed, all IBM Maximo locations are automatically available.

Transaction Manager: Displays the installed IBM Maximo e-Commerce transactions and allows definition of destinations and enable or disable options per transaction.

Preferences: Logging options and administrator’s notification options are defined here.

IBM Maximo Online Commerce System Suppler Network: Auto-link to the main IBM Maximo Online Commerce System Supplier Network site.

Sign Out: Exit the IBM Maximo e-Commerce Adapter configuration services.

Setting preferences

There are global options available for the IBM Maximo e-Commerce Adapter, specifically for logging and administrator notification options.

To set the preferences for the e-Commerce Adapter:

1 Select Preferences.

Administering the e-Commerce Adapter 4


Transaction Manager

2 Define the fields as shown in the following table.

Transaction Manager

The Transaction Manager displays the IBM® Maximo® transaction list:

The installed IBM Maximo transaction set is displayed with each transaction provided with the following fields:

The Send Transaction Handlers has the following fields:

Linking from the Send Transaction Destination field allows selection of a new location from any location defined in the Location Manager.

Field Value

Mail server address Enter the URL of the mail server for any e-mail error notifications.

Administrator Enter the e-mail address of the administrator to receive the notification.

Notification Reply-To Enter the e-mail address for any replies to the notification.

Default Transaction set label

Identifies the format for the transactions e-Commerce transactions.

Field Description

Enabled flag Indicates whether the transaction is currently enabled. This provides a quick way to turn off or on specific transactions for testing

Persistent flag Indicates that for the Data Store you wish to store the transaction data for debugging or review.

Field Description

Enabled flag Indicates whether the transaction is currently enabled. This provides a quick way to turn off or on specific transactions for testing

Persistent flag Indicates that for the Data Store you wish to store the transaction data for debugging or review.

Destination This identifies and links to the selection of a location destination as created and defined in the Location Manager. Each transaction, therefore may be routed to different destinations.


Location Manager

Location Manager

The Location Manager views and defines all communication locations. Typically there are only one or two you may be concerned with. All IBM Maximo locations automatically appear after the IBM Maximo e-Commerce Adapter is installed.

Remote connections are listed, with the adapter pre-configured with the IBM Maximo Online Commerce System location. You change this to and from test locations as required.

Locations summary

All IBM Maximo locations are automatically detected and displayed.

Each IBM Maximo location is identified with:Server nameHost Address

Clicking on the IBM Maximo server name will link to the View IBM Maximo Location

The defined remote location is shown with:AliasTypeHostPortTransaction Set

Contact IBM Maximo Support to establish and test your adapter integration when ready.

From the Locations Summary, you can:View/Edit Remote Locations Details by linking on the Alias nameAdd Remote Locations.

View IBM Maximo location

An IBM Maximo Location defines the internal IBM Maximo installations available to the IBM Maximo e-Commerce Adapter.

Each IBM Maximo Location displays the server name and the host address in addition to session definitions for all e-Commerce enabled companies identified within IBM Maximo, including:

Company IDCompany DomainOrganizationSiteVendorUser


Location Manager

View remote location

A remote location defines external E-Commerce connections, primarily intended for IBM Maximo Online Commerce System integrations.

This defines your connection with the IBM Maximo Online Commerce System which manages all subsequent routing and formatting to all your e-Commerce partners for you.

The IBM Maximo e-Commerce Adapter comes pre-configured with a Hosted Online Commerce Service location defined. You may not need to do anything else; however, you have the option to change this during testing.

The Adapter comes pre-configured with a standard IBM Maximo Online Commerce System remote location; however, should you need to review or update this configuration, the details of a location definition are summarized in the following information.

Edit remote location

Administrators have the option to edit a remote location. All of the options viewed may be added or changed as required.

New location

This is used by the administrator to create a location from the Location Summary page. All of the options added or changed as required.

Remote location options

There are settings that are optional. These are listed here.

Location: The name assigned to the remote location.

URL: The full address for the destination.

Data formatting: The Transaction Set format for the transaction to this location is selected. Standard options include:

OAG:7.2.1OAG:6.1

However, other transaction sets and formats may be defined within the Transaction Manager component of the IBM Maximo e-Commerce Adapter and subsequently selected here. Additional formats may be available or developed using Services.

Attachments destination Several transactions have the option to indicate an attachment reference. These attachments may be sent separately from the transaction in their native format via ftp.

For the IBM Maximo e-Commerce Adapter, the ftp destination and parameters are defined for attachments. IBM Maximo will transport the attachments accordingly.

Enter the ftp parameters for:Host Name or IP Address


Data Store activity

Port Number Remote directory Mode (Binary/ASCII)Transfer Type (Active/Passive)Authentication:

Use anonymous login? (No/Yes)User Name Password

Data Store activity

The Data Store records all the activity within the adapter. Interactive query allows for trouble-shooting and investigation of transactions sent and received via the adapter, in addition to easy-to-use test tools.

Record set view

The Data Store provides a quick view of all transaction activity in and out of the IBM Maximo e-Commerce Adapter. You may select to refresh at any time. The list displays all the record sets ordered by most recent listed first.

A record set consists of a transaction pair, either:the transaction sent and the reply received, or the transaction received and the reply sent.

Record set details

Linking from the Data Store Registered Record Set Reference ID displays the Record Set Details. In this example we see both the originating PROCESS_PO and the returned ACKNOWLEGE_PO transactions.

The Record Set summary contains the following information:

A link is available for each transaction to the Transaction Details by linking from the Reference ID.

Field Description

Reference ID The unique Reference ID for each transaction.

Transaction ID The type of the transaction.

Supplier ID The Supplier ID contained in the transaction (if available).

Supplier ID The Supplier ID contained in the transaction (if available).

Creation Date The date the transaction was sent or received.

Last Modification Date

The date the transaction was sent or received.


Data Store activity

Linking from a Record Set transaction’s Reference ID will produce a sectioned display of the selected transaction. A transaction may have one or many sections, such as:

Control Area As per OAG standardsHeader Header level details of the transactionLine Items Repeatable "line items" of the transactionUser Area non-OAG standard tags created for custom processingMiscellaneous other special tags


Notices

This information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to:

IBM World Trade Asia CorporationLicensing2-31 Roppongi 3-chome, Minato-kuTokyo 106-0032, Japan

The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law:

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.

Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those


Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact:

IBM Corporation2Z4A/10111400 Burnet RoadAustin, TX 78758 U.S.A.

Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee.

The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us.

Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.

All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only.

This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental.

If you are viewing this information softcopy, the photographs and color illustrations may not appear.

Trademarks

The following terms are trademarks of International Business Machines Corporation in the United States, other countries, or both:

IBMAIXDB2developerWorksEveryplaceibm.comLotus


MaximoNotesQuickPlaceTivoliWebSphere

Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States, and/or other countries.

Java and all Java-based trademarks and logos are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.

Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.

Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo, Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries.

Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.

UNIX is a registered trademark of The Open Group in the United States and other countries.

23


Documents

IBM® Maximo® e-Commerce Adapter Installation Guide