iway iway Application System Adapter for Amdocs ClarifyCRM User s Guide Version 5 Release 6 Service Manager (SM) DN

Transcription

1 iway iway Application System Adapter for Amdocs ClarifyCRM User s Guide Version 5 Release 6 Service Manager (SM) DN

2 EDA, EDA/SQL, FIDEL, FOCCALC, FOCUS, FOCUS Fusion, FOCUS Vision, Hospital-Trac, Information Builders, the Information Builders logo, Parlay, PC/FOCUS, SmartMart, SmartMode, SNAPpack, TableTalk, WALDO, Web390, WebFOCUS and WorldMART are registered trademarks, and iway and iway Software are trademarks of Information Builders, Inc. Due to the nature of this material, this document refers to numerous hardware and software products by their trademarks. In most, if not all cases, these designations are claimed as trademarks or registered trademarks by their respective companies. It is not this publisher s intent to use any of these names generically. The reader is therefore cautioned to investigate all claimed trademark rights before using any of these names other than to refer to the product described. Copyright 2009, by Information Builders, Inc. and iway Software. All rights reserved. Patent Pending. This manual, or parts thereof, may not be reproduced in any form without the written permission of Information Builders, Inc.

3 iway Contents Preface...5 Documentation Conventions...6 Related Publications...6 Customer Support...6 Help Us to Serve You Better...7 User Feedback...10 iway Software Training and Professional Services Introducing the iway Application System Adapter for Amdocs ClarifyCRM...11 Understanding the Architecture of the ClarifyCRM Framework...12 Clarify Business Objects...12 CBO Components...12 Installation Considerations...14 Installing the Adapter...15 Supported Versions and Required Library Files...17 Accessing a ClarifyCRM Business Object Through the CBO Interface...18 Accessing the Database Through a ClarifyCRM Business Object...18 Service Processing Using the CBO Interface...19 Processing a Service...20 Processing an Event...21 Known Limitations...22 Component Information...22 Component Information Roadmap...23 iway Service Manager...23 iway Explorer...24 iway Business Services Provider...24 Enterprise Connector for J2EE Connector Architecture...24 iway Application System Adapter for Amdocs ClarifyCRM User s Guide 3

4 Contents 2. Configuring and Managing Connections to ClarifyCRM...25 Starting iway Explorer (Java Swing)...26 Creating a New Configuration...27 Connecting to a New Configuration...31 Connecting to ClarifyCRM...32 Creating a New Target...32 Connecting to a Target...34 Modifying, Closing, or Removing a Target Creating XML Schemas and Web Services for ClarifyCRM...37 Generating Schemas and Business Services Overview...38 Generating Schemas...38 Constructing XML Request Documents...45 Generating Business Services Listening for ClarifyCRM Events...61 Understanding iway Event Functionality...62 Configuring Database Triggers and Event Tables...62 Obtaining the JDBC Driver...63 Generating Event Triggers...63 Creating an Event Port...66 Editing or Deleting an Event Port...79 Using the Default Event Port...80 Creating a Channel Configuring the Adapter in iway Designer...87 Using the Adapter in iway Designer...88 A. Configuring the Adapter in an iway Environment...95 Configuring the Adapter in iway Service Manager...96 Configuring the Adapter in Adapter Manager...97 Reader Comments iway Software

5 iway Preface This document is written for system integrators with programming backgrounds and an understanding of ClarifyCRM. Extensive knowledge of ClarifyCRM is not required, but it may be helpful in learning about the adapter. This document provides details on working with the adapter tools to develop online interconnections to ClarifyCRM using the iway Application System Adapter for Amdocs ClarifyCRM. How This Manual Is Organized This manual includes the following chapters: A Chapter/Appendix Introducing the iway Application System Adapter for Amdocs ClarifyCRM Configuring and Managing Connections to ClarifyCRM Creating XML Schemas and Web Services for ClarifyCRM Listening for ClarifyCRM Events Configuring the Adapter in iway Designer Configuring the Adapter in an iway Environment Contents Introduces the iway Application System Adapter for Amdocs ClarifyCRM and provides information to help you accomplish your integration projects. Describes how to configure and manage connections to ClarifyCRM using iway Explorer. Describes how to use iway Explorer to create XML schemas and Web services for ClarifyCRM. Describes how to use iway Explorer to configure the adapter to listen for ClarifyCRM events. Describes how to use the adapter within an iway Designer process flow. Describes how to assign the adapter to an iway Service Manager channel or iway Adapter Manager listener. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 5

6 Documentation Conventions Documentation Conventions The following table lists and describes the conventions that apply in this manual. Convention THIS TYPEFACE or this typeface this typeface underscore this typeface Key + Key { } Description Denotes syntax that you must type exactly as shown. Represents a placeholder (or variable), a cross-reference, or an important term. It may also indicate a button, menu item, or dialog box option you can click or select. Indicates a default setting. Highlights a file name or command. Indicates keys that you must press simultaneously. Indicates two or three choices; type one of them, not the braces. Separates mutually exclusive choices in syntax. Type one of them, not the symbol. Indicates that you can type a parameter multiple times. Type only the parameter, not the ellipsis points (...). Indicates that there are (or could be) intervening or additional commands. Related Publications To view a current listing of our publications and to place an order, visit our World Wide Web site, You can also contact the Publications Order Department at (800) Customer Support Do you have questions about this product? 6 iway Software

7 Preface Call Information Builders Customer Support Services (CSS) at (800) or (212) Customer Support Consultants are available Monday through Friday between 8:00 A.M. and 8:00 P.M. EST to address all your questions. Information Builders consultants can also give you general guidance regarding product capabilities and documentation. Be prepared to provide your six-digit site code (xxxx.xx) when you call. You can also access support services electronically, 24 hours a day, with InfoResponse Online. InfoResponse Online is accessible through our World Wide Web site, You can connect to the tracking system and knownproblem database at the Information Builders support center. Registered users can open, update, and view the status of cases in the tracking system and read descriptions of reported software issues. New users can register immediately for this service. The technical support section also provides usage techniques, diagnostic tips, and answers to frequently asked questions. To learn about the full range of available support services, ask your Information Builders representative about InfoResponse Online, or call (800) 969-INFO. Help Us to Serve You Better To help our consultants answer your questions effectively, be prepared to provide specifications and sample files and to answer questions about errors and problems. The following table lists the environment information our consultants require. Platform Operating System OS Version JVM Vendor JVM Version The following table lists the deployment information our consultants require. Adapter Deployment Container For example, JCA, iway Business Services Provider, iway Service Manager For example, WebSphere Version iway Application System Adapter for Amdocs ClarifyCRM User s Guide 7

8 Help Us to Serve You Better Enterprise Information System (EIS) - if any EIS Release Level EIS Service Pack EIS Platform The following table lists iway-related information needed by our consultants. iway Adapter iway Release Level iway Patch The following table lists the types of iway Explorer. Specify the version (and platform, if different than listed previously) in the columns provided. iway Explorer Type Swing Servlet Eclipse Embedded in iway Designer Version Platform The following table lists additional questions to help us serve you better. Request/Question Error/Problem Details or Information Did the problem arise through a service or event? Provide usage scenarios or summarize the application that produces the problem. 8 iway Software

9 Preface Request/Question Error/Problem Details or Information When did the problem start? Can you reproduce this problem consistently? Describe the problem. Describe the steps to reproduce the problem. Specify the error message(s). Any change in the application environment: software configuration, EIS/database configuration, application, and so forth? Under what circumstance does the problem not occur? Following is a list of error/problem files that might be applicable: Input documents (XML instance, XML schema, non-xml documents) Transformation files Error screen shots Error output files Trace files Service Manager package to reproduce problem Custom functions and services in use Diagnostic Zip Transaction log For information on tracing, see the iway Service Manager User's Guide. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 9

10 User Feedback User Feedback In an effort to produce effective documentation, the Documentation Services staff welcomes your opinions regarding this manual. Please use the Reader Comments form at the end of this manual to communicate suggestions for improving this publication or to alert us to corrections. You can also go to our Web site, and use the Documentation Feedback form. Thank you, in advance, for your comments. iway Software Training and Professional Services Interested in training? Our Education Department offers a wide variety of training courses for iway Software and other Information Builders products. For information on course descriptions, locations, and dates, or to register for classes, visit our World Wide Web site, or call (800) 969-INFO to speak to an Education Representative. Interested in technical assistance for your implementation? Our Professional Services department provides expert design, systems architecture, implementation, and project management services for all your business integration projects. For information, visit our World Wide Web site, 10 iway Software

11 iway Introducing the iway Application System 1 Adapter for Amdocs ClarifyCRM The iway Application System Adapter for Amdocs ClarifyCRM provides a means to exchange real-time business data between ClarifyCRM systems and other application, database, or external business partner systems. The adapter enables inbound and outbound processing with ClarifyCRM systems. It provides scalable, reliable, and secure access, enabling you to use ClarifyCRM data and functions within your business processes. Topics: Understanding the Architecture of the ClarifyCRM Framework Installation Considerations Accessing a ClarifyCRM Business Object Through the CBO Interface Known Limitations Component Information iway Application System Adapter for Amdocs ClarifyCRM User s Guide 11

12 Understanding the Architecture of the ClarifyCRM Framework Understanding the Architecture of the ClarifyCRM Framework In this section: Clarify Business Objects CBO Components ClarifyCRM is a Customer Relationship Management (CRM) system developed by Amdocs. This system can be integrated through Clarify Business Objects (CBOs). ClarifyCRM provides the following types of APIs to integrate through CBOs: Generic CBO-specific Currently, the iway Application System Adapter for Amdocs ClarifyCRM supports the generic APIs to integrate with Clarify. The adapter also uses the CASE CBO-specific APIs. In a future release, the adapter will support integration using CBO-specific APIs. Clarify Business Objects Clarify Business Objects (CBOs) are part of the ClarifyCRM framework. You can use them to develop applications for the ClarifyCRM database. These business objects are C++ objects with Java and ActiveX layers that provide access to data in the ClarifyCRM database. Applications can use CBOs to query and update data in the database. Each type of business object implements part of the ClarifyCRM data model and encapsulates the application logic for working with that part of the model. The CBO Data Service is a set of routines and drivers that provide an intermediate service layer between CBO and the database server that is used. Several ClarifyCRM products (including Web applications) use CBO and the CBO Data Service to communicate with ClarifyCRM databases. These applications are called CBO applications. CBO Components CBO provides a programmatic interface to ClarifyCRM data. Different layers are used, depending on the application type. For example: ClarifyCRM Web applications use the Java layer. ClarifyCRM eresponse Manager uses the ActiveX layer. Routing Server and the Data Dictionary Editor directly use the C++ object layer. 12 iway Software

13 1. Introducing the iway Application System Adapter for Amdocs ClarifyCRM CBO uses the CBO Data Service to perform any database queries or updates. The CBO Data Service, in turn, uses the database client software, for example, Microsoft SQL Server, to connect to the database and perform database operations. CBO and the CBO Data Service also manage login sessions. They keep a cache of metadata used by the business objects, such as database schema information, strings, and application pop-up lists. The following diagram illustrates the architecture of a CBO application. It shows how a CBO application, CBO, the CBO Data Service, the database client software, and the ClarifyCRM database interact. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 13

14 Installation Considerations Installation Considerations In this section: Installing the Adapter Supported Versions and Required Library Files When you install CBO applications, you must comply with the following rules and options for deploying the individual CBO components. CBO and the CBO application must be installed on the same machine. The CBO application uses CBO within its own process. For non-web applications, CBO and the CBO Data Service should be installed on the same machine. In this configuration, the CBO Data Service also runs within the CBO application process. This deployment configuration is called an In Process CBO Data Service (also known as InProc). 14 iway Software

15 1. Introducing the iway Application System Adapter for Amdocs ClarifyCRM The following diagram illustrates a system installation in which CBO and the CBO Data Service are installed on the same machine. Installing the Adapter How to: Install the Adapter Perform the following procedure to install the iway Application System Adapter for Amdocs ClarifyCRM. Note: The iway Application System Adapter for Amdocs ClarifyCRM is supported only on Windows platforms with a Microsoft SQL Server database. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 15

16 Installation Considerations Procedure: How to Install the Adapter To install the adapter: 1. Install your CBO application (for example, ClarifyCRM esupport) using Server mode on the same machine where the iway Application System Adapter for Amdocs ClarifyCRM is installed. 2. Copy the required.jar files for the Clarify CBO APIs (for example, ClfyCbo.jar) to the following directory iway_home\lib where: iway_home Is the root installation directory for iway Service Manager (for example, iway56sm). For more information on the.jar library files, see Supported Versions and Required Library Files on page Configure the Path and CLASSPATH environment variables to include the iway56sm\lib directory. The following image shows a sample value for the Path, with the iway56sm\lib directory. 4. Ensure that the following folder for the CBO application is available on the system path: \\ClarifyCRM13.1\eSupport\Clarify\bin 5. Install the database client software that is used by ClarifyCRM, for example, Microsoft SQL Server, on the same machine where the iway Application System Adapter for Amdocs ClarifyCRM will run. 6. To test the installation, execute the TestCboInstallJava utility or the Run_TestCboInstallJava utility that is provided by Clarify. 16 iway Software

17 1. Introducing the iway Application System Adapter for Amdocs ClarifyCRM For more information on installing Clarify and the configurations that are required for a CBO integration, see Configuring CBO Settings in the Amdocs Clarify System Administration Guide. Supported Versions and Required Library Files Following are the Clarify versions that are supported and the library files that are required by the iway Application System Adapter for Amdocs ClarifyCRM. Supported Versions Amdocs CRM Version 6 Required Library Files For ClarifyCRM version 10.1, 11.5, 12.0, and 12.5: ClfyCbo.jar For Amdocs CRM Version 6: ClfyCbo.jar jdom.jar The.jar files must reside in the install_drive:\program Files\iway56sm\lib directory. You must add the iway56sm\lib directory to the Path and CLASSPATH environment variables, as described in How to Install the Adapter on page 16. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 17

18 Accessing a ClarifyCRM Business Object Through the CBO Interface Accessing a ClarifyCRM Business Object Through the CBO Interface In this section: Accessing the Database Through a ClarifyCRM Business Object Service Processing Using the CBO Interface Processing a Service Processing an Event ClarifyCRM Business Objects (CBOs) are part of the ClarifyCRM business Framework for developing applications for the ClarifyCRM efrontoffice (CeFO) database. These business objects are C++ objects with a Java layer. They provide access to data in the CeFO database. Each type of business object implements part of the ClarifyCRM data model and encapsulates the application logic for working with that part of the model. Accessing the Database Through a ClarifyCRM Business Object The iway Application System Adapter for Amdocs ClarifyCRM provides controlled access to the data contained in the ClarifyCRM database through the CBO interface. You can use the iway Application System Adapter for Amdocs ClarifyCRM to perform inserts, updates, deletes, and gets against ClarifyCRM objects stored in the ClarifyCRM database. You also can use the adapter to integrate ClarifyCRM with non-clarifycrm systems. A business object has methods and properties that are used to query, manipulate, and update data in a CeFO database table. The get method is issued through an XML document the same way as insert, update, and delete. The results of the get are contained in an XML response document. Each business object contains a row set, which is an in-memory copy of a set of rows from a CeFO database table. When you query a database table, the business object holds the results of the query in its row set. You can select a row in the row set and obtain the values of the fields in that row. You can use the row set to make changes to data in the database table. You can modify the values of fields in rows and commit the changed rows back to the database. If you must add new rows to the database table, you add the rows to the row set in the business object and commit the new rows to the database. 18 iway Software

19 1. Introducing the iway Application System Adapter for Amdocs ClarifyCRM Service Processing Using the CBO Interface The iway Application System Adapter for Amdocs ClarifyCRM connects one application to another when those applications are not designed to communicate with one another. The adapter sends requests to ClarifyCRM and manipulates data. In some cases, rows are returned. In other cases, data is modified or inserted. The iway Application System Adapter for Amdocs ClarifyCRM supports both services and events, that is, it supports full, bidirectional access to the ClarifyCRM applications. Services Applications use this capability to initiate a service request to access or manipulate data through CBOs. For example, the adapter can perform inserts, updates, deletes, and gets against ClarifyCRM objects stored in the ClarifyCRM database. The adapter receives an XML request document from a client and issues the appropriate CBO method call. The ClarifyCRM application processes the call and returns a service response. The iway Application System Adapter for Amdocs ClarifyCRM supports synchronous services. With a synchronous service, the client application waits for the response before proceeding with further processing. Service processing includes: Receiving an XML-based service request from an external client. Interpreting the request document and making the appropriate CBO method calls. Transforming a response from a ClarifyCRM-specific data format to an XML document. The XML document conforms to the XML response schema for the service. The schema is based on ClarifyCRM metadata. Events Applications use this capability if they require access to ClarifyCRM data only when a ClarifyCRM business event occurs. When the adapter detects an event in ClarifyCRM, it is processing an event. The adapter monitors a ClarifyCRM database that represents current data in a ClarifyCRM system. When the adapter retrieves that data, it is formatted as an XML document. Adaptersupplied database triggers move only the relevant data about a ClarifyCRM business process into an event database. After the event is processed successfully, the event data is deleted from the event database. Event processing includes: Applying triggers to specified tables within the ClarifyCRM application. Polling the ClarifyCRM event database at user-configured time intervals. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 19

20 Accessing a ClarifyCRM Business Object Through the CBO Interface Translating the event information to XML. The adapter provides a Java-based utility that enables the browsing of CBO-based tables and the creation of adapter-based triggers within the desired CBO tables. When a row within one of the tables is affected by an update, insert, or delete, the trigger moves key related information to a custom table supplied by the adapter installation process. The adapter polls this custom event table and returns the data in an XML response document. The adapter maintains the logic to process only the current ("unprocessed") row from the event table. Processing a Service The following diagram illustrates the framework for processing a service with the iway Application System Adapter for Amdocs ClarifyCRM. It shows the flow of an XML document, passing to the application server with the adapter, to the Clarify client API, and then to the ClarifyCRM Server and the ClarifyCRM database. When the iway Application System Adapter for Amdocs ClarifyCRM processes a service: 1. The adapter receives an XML service request document. 2. The adapter interprets the document and issues the corresponding CBO method calls to the ClarifyCRM Server. 3. The ClarifyCRM Server processes the calls and returns the service response, if any, to the adapter. 20 iway Software

21 1. Introducing the iway Application System Adapter for Amdocs ClarifyCRM 4. From the response, the adapter generates an XML response document. The document conforms to the service response schema. 5. The adapter returns the XML response document. Processing an Event The following diagram illustrates the framework for processing an event with the iway Application System Adapter for Amdocs ClarifyCRM. It shows the ClarifyCRM Server connected to the ClarifyCRM database event tables. The adapter monitors the database event tables for a change. The adapter acknowledges a database trigger (an event), and then produces an XML document. When the iway Application System Adapter for Amdocs ClarifyCRM processes an event: 1. A business process (for example, a booked service request or a completed sales call) is completed against a ClarifyCRM application. 2. Data changes within the ClarifyCRM system, which triggers the relevant event data to be copied to the event table. 3. The adapter periodically polls the event table with a specified SQL query. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 21

22 Known Limitations Known Limitations When the event table contains rows that satisfy the query, the iway Application System Adapter for Amdocs ClarifyCRM obtains the data and packages it in XML format. Following are the known limitations for the iway Application System Adapter for Amdocs ClarifyCRM. The adapter provides generic metadata (XML schema) for all the CBOs through operations such as insert, update, delete, and get (query). The adapter does not provide the metadata in terms of CBO. The adapter does not expose the full list of CBOs. It provides only a set of generic operations for all CBOs. The adapter integrates ClarifyCRM through generic CBO APIs and CASE CBO-specific APIs. It does not use any other CBO-specific APIs. Since the adapter does not use CBO-specific APIs, it cannot execute the business logic and workflows behind all the CBOs, except CASE CBO. When you use the adapter with the CASE CBO, some of the workflow operations require the sequential execution of multiple payloads. This may also be applicable to other CBOs. The adapter supports only functions such as insert, update, delete, and get (query) for services with Clarify. It does not support any other functions. Clarify adapter services and events are supported only for Microsoft SQL Server. Component Information In this section: Component Information Roadmap iway Service Manager iway Explorer iway Business Services Provider Enterprise Connector for J2EE Connector Architecture The iway Application System Adapter for Amdocs ClarifyCRM works with one of the following components: iway Service Manager iway Business Services Provider (ibsp) 22 iway Software

23 1. Introducing the iway Application System Adapter for Amdocs ClarifyCRM Enterprise Connector for J2EE Connector Architecture (JCA) When hosted in an iway environment, the adapter is configured through iway Service Manager and iway Explorer. iway Explorer is used to configure adapter connections and event capabilities and to create Web services. When the adapter is hosted in a third-party application server environment, iway Explorer (used to configure ClarifyCRM connections and event capabilities and to create Web services) can be configured to work in a Web services environment in conjunction with ibsp or JCA. In a JCA environment, the connector uses the Common Client Interface (CCI) to provide fast integration services using adapters instead of Web services. Component Information Roadmap The following table lists the deployment component and the location of component information for the iway Application System Adapter for Amdocs ClarifyCRM. Deployed Component iway Service Manager iway Explorer iway Business Services Provider (ibsp) iway Enterprise Connector for J2EE Connector Architecture (JCA) For more information, see Appendix A of this guide iway Service Manager User's Guide Chapters 2, 3, and 4 of this guide iway Installation and Configuration iway Installation and Configuration iway Installation and Configuration iway Service Manager iway Service Manager is the heart of the Universal Adapter Framework. It is an open transport service bus. Service Manager uses graphical tools to create sophisticated integration services without the need for custom integration code by: Creating metadata from target applications. Transforming and mapping interfaces. Managing stateless processes. Its capability to manage complex adapter interactions makes it an ideal foundation for a service-oriented architecture. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 23

24 Component Information iway Explorer iway Explorer uses a tree metaphor to introspect the ClarifyCRM system metadata. The Explorer enables you to create XML schemas and Web services for the associated object. In addition, you can create ports and channels to listen for events in ClarifyCRM. External applications that access ClarifyCRM through the iway Application System Adapter for Amdocs ClarifyCRM use either XML schemas or Web services to pass data between the external application and the adapter. iway Business Services Provider The iway Business Services Provider (ibsp) exposes, as Web services, enterprise assets that are accessible from adapters regardless of the programming language or the particular operating system. ibsp simplifies the creation and execution of Web services when running: Custom and legacy applications. Database queries and stored procedures. Packaged applications. Terminal emulation and screen-based systems. Transactional systems. Coupled with a platform and language independent messaging protocol called SOAP (Simple Object Access Protocol), XML enables application development and integration by assembling previously built components from multiple Web services. Enterprise Connector for J2EE Connector Architecture The Enterprise Connector for J2EE Connector Architecture (JCA) enables developers of JCAcompliant applications to deploy adapters as JCA resources. The connector is supported on J2EE-compliant application servers, such as your application server. The Connector for JCA is distributed as a standard Resource Adapter Archive (RAR) for deployment to the application server. Thus, the connector can be used in systems that are non-compliant, although services such as pooled connections are not available. 24 iway Software

25 iway Configuring and Managing Connections to 2 ClarifyCRM This section describes how to configure and manage connections to ClarifyCRM using iway Explorer. Topics: Starting iway Explorer (Java Swing) Creating a New Configuration Connecting to a New Configuration Connecting to ClarifyCRM iway Application System Adapter for Amdocs ClarifyCRM User s Guide 25

26 Starting iway Explorer (Java Swing) Starting iway Explorer (Java Swing) How to: Start iway Explorer This topic describes how to start iway Explorer. Procedure: How to Start iway Explorer To start iway Explorer: 1. Ensure iway Explorer is installed. For more information on installing and configuring iway Explorer, see the iway Installation and Configuration manual. 2. From the Windows Start menu, select Programs, iway 5.6 SM, and tools, and click iway Explorer - SWING. A status window indicates the loading progress of iway Explorer. The iway Explorer window then opens. The following image shows the iway Explorer window that opens after iway Explorer loads. A navigation pane is on the left. The navigation pane contains the root node, iway Configurations. 26 iway Software

27 2. Configuring and Managing Connections to ClarifyCRM Creating a New Configuration How to: Create a Repository for ibsp Create a Repository for JCA Before you can use iway Explorer with iway adapters, you must create a repository where your XML schemas, Web services, and event data are stored. Since you can deploy iway Explorer using the iway Business Services Provider (ibsp) or J2EE Connector Architecture (JCA), each implementation requires that you configure a specific repository before you can explore Enterprise Information System (EIS) metadata. The ibsp exposes, as Web services, enterprise assets that are accessible from adapters regardless of the programming language or the particular operating system. In addition, you can use ibsp as a stand-alone Java application running in iway Service Manager. The iway Connector for JCA runs on J2EE Connector Architecture compliant application servers. It uses the Common Client Interface (CCI) to provide integration services using iway adapters. After you deploy the connector, you have access to adapters installed with iway 5.6 SM. Procedure: How to Create a Repository for ibsp To create a repository for ibsp using iway Explorer: 1. Start iway Explorer. The following image shows the New option that is available in the left pane of the iway Explorer window when you right-click the iway Configurations node. 2. Right-click iway Configurations and select New. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 27

28 Creating a New Configuration The following image shows the New Configuration dialog box that opens, where you supply a name for the configuration. 3. Type a name for the configuration, for example, SampleConfig, and click OK. The following image shows additional fields on the New Configuration dialog box, where you select the service provider and supply the ibsp URL. 4. From the Service Provider drop-down list, select ibse. You are prompted for the ibsp URL. Use one of the following two options. To access the stand-alone ibsp that is installed as part of iway Service Manager, provide the following URL where: hostname Is the name of the host on which iway is installed. If you changed the default SOAP port, substitute the correct value accordingly. To access Servlet ibsp, provide the following URL 28 iway Software

29 2. Configuring and Managing Connections to ClarifyCRM where: hostname port 5. Click OK. Is the host name of your application server. Is the port number used by your application server. The following image shows the node representing the new configuration that appears beneath the root iway Configurations node. In this image, the node is named SampleConfig. Procedure: How to Create a Repository for JCA To create a repository for JCA using iway Explorer: 1. Start iway Explorer. The following image shows the New option that is available in the left pane of the iway Explorer window when you right-click the iway Configurations node. 2. Right-click iway Configurations and select New. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 29

30 Creating a New Configuration The following image shows the New Configuration dialog box that opens, where you supply a name for the configuration. 3. Type a name for the configuration, for example, SampleConfig, and click OK. The following image shows additional fields on the New Configuration dialog box, where you select the service provider and supply the name of the iway home directory. 4. From the Service Provider drop-down list, select JCA. 5. In the iway Home field, type the full path to your iway 5.6 SM installation. This path is used to locate the adapter and store the repository and XML schemas. For example: C:\Program Files\iway56sm 6. Click OK. 30 iway Software

31 2. Configuring and Managing Connections to ClarifyCRM The following image shows the node representing the new configuration that appears beneath the root iway Configurations node. In this image, the node is named SampleConfig. Connecting to a New Configuration How to: Connect to a New Configuration Once you have created a new configuration using iway Explorer, you must connect to it before you can use the iway Application System Adapter for Amdocs ClarifyCRM. Procedure: How to Connect to a New Configuration To connect to a new configuration: 1. Right-click the configuration to which you want to connect, for example, SampleConfig. The following image shows the options (Connect and Delete) that are available in the left pane of the iway Explorer window when you right-click the SampleConfig node. 2. Select Connect. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 31

32 Connecting to ClarifyCRM The following image shows the left pane, where nodes appear for iway Adapters, iway Events, and iway Business Services (also known as Web services). Use the iway Adapters node to create inbound interaction with an Enterprise Information System (EIS). For example, you use the Clarify CBO node beneath the iway Adapters node to configure a service that updates the ClarifyCRM system. Use the iway Events node to configure listeners that listen for events in ClarifyCRM. Use the iway Business Services node to test business services created in the iway Adapters node. You can also control security settings for the business services that are available. Connecting to ClarifyCRM In this section: Creating a New Target Connecting to a Target Modifying, Closing, or Removing a Target To browse and work with ClarifyCRM metadata, you must create a target for ClarifyCRM. This target serves as your connection point. You must establish a connection to ClarifyCRM every time that you start iway Explorer or after you disconnect from the system. Creating a New Target How to: Create a New Target A target serves as the connection point to your Enterprise Information System (EIS). It is automatically saved after you create it. To connect to ClarifyCRM for the first time, you must create a new target. 32 iway Software

33 2. Configuring and Managing Connections to ClarifyCRM Procedure: How to Create a New Target To create a new target: 1. In the left pane, expand the iway Adapters node and select the Clarify CBO node. 2. Right-click the Clarify CBO adapter node and select Add Target. The Add Target dialog box opens. 3. In the Name field, type a descriptive name for the target, for example, ClarifyTarget. 4. In the Description field, type a brief description of the connection (optional). 5. Click OK. The Basic dialog box opens, as shown in the following image. 6. Provide the appropriate values for the following fields: Clarify Server Name Clarify Database Name User Name User Password 7. Click OK. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 33

34 Connecting to ClarifyCRM The new target, for example, ClarifyTarget, appears in the left pane beneath the Clarify CBO node. Connecting to a Target How to: Connect to a Target You must use a defined target to connect to an instance of ClarifyCRM. Procedure: How to Connect to a Target To connect to an existing target: 1. In the left pane, expand the Clarify CBO node and select the target that you defined, for example, ClarifyTarget. 2. In the right pane, type the password for ClarifyCRM. 3. Right-click the target. 4. Select Connect. In the left pane, the ClarifyTarget node changes to reflect that a connection was made. 5. Expand the target node to reveal the business objects for ClarifyCRM. 34 iway Software

35 2. Configuring and Managing Connections to ClarifyCRM Modifying, Closing, or Removing a Target How to: Edit a Target Disconnect From a Target Delete a Target After you create a target for ClarifyCRM using iway Explorer, you can edit the information that you provided when you created the target. Although you can maintain multiple open connections to different application systems, it is recommended that you close connections when they are not in use. You can also delete any targets that are not required. Procedure: How to Edit a Target To edit a target: 1. In the left pane, right-click the target, for example, ClarifyTarget. 2. Select Edit. The Basic dialog box opens, as shown in the following image. 3. Modify the connection information and click OK. Procedure: How to Disconnect From a Target To disconnect from a target: 1. In the left pane, right-click the target to which you are connected, for example, ClarifyTarget. 2. Select Disconnect. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 35

36 Connecting to ClarifyCRM The ClarifyTarget node changes to reflect that the connection was terminated. Procedure: How to Delete a Target To delete a target: 1. In the left pane, right-click the target to which you are connected, for example, ClarifyTarget. 2. Select Delete. The ClarifyTarget node is removed from the left pane. 36 iway Software

37 iway Creating XML Schemas and Web Services for 3 ClarifyCRM This section describes how to use iway Explorer (Java Swing) to generate XML schemas that define request and response documents for your ClarifyCRM tables. It also describes how to create business services (also known as Web services) for your tables. Topics: Generating Schemas and Business Services Overview Generating Schemas Constructing XML Request Documents Generating Business Services iway Application System Adapter for Amdocs ClarifyCRM User s Guide 37

38 Generating Schemas and Business Services Overview Generating Schemas and Business Services Overview To generate request and response document schemas, or a business service, perform the following tasks. 1. Start iway Explorer and open a new or existing connection to the ClarifyCRM database, as described in Configuring and Managing Connections to ClarifyCRM on page 25. Using iway Explorer, expand the iway Adapters node to see the adapters installed on your system. 2. Generate XML schemas that define request and response documents for your SQL statements and stored procedures, as described in Generating Schemas on page 38. You can use the schemas when you create request documents and when you develop logic to process responses. 3. Create request documents for each operation against each table, and for each stored procedure. You can use a third-party XML tool to generate a request document from the XML schema. See Constructing XML Request Documents on page 45 for an example. 4. Generate a business service (also known as a Web service) for an SQL statement or stored procedure. See Generating Business Services on page 51 for details. Generating Schemas How to: Create an XML Schema for a ClarifyCRM Table Reference: Schema Location XML schemas define service request documents and the corresponding response documents. When you deploy the adapter in an iway Enterprise Connector for J2EE Connector Architecture (JCA) environment, you can generate schemas to define these documents. When you deploy the adapter in a business services environment, you are not required to generate a schema. For more information, see Generating Business Services on page 51. Reference: Schema Location By default, iway Explorer stores the schemas it creates in subdirectories beneath the iway home directory of the machine on which it is installed. However, using iway Explorer, you can also export these schemas to any location that you specify on your file system. 38 iway Software

39 3. Creating XML Schemas and Web Services for ClarifyCRM The exact location of the schemas differs, depending on whether you deploy iway Explorer with an ibsp configuration or a JCA configuration. When you use the adapter with an ibsp configuration, iway Explorer stores the schemas beneath a \schemas subdirectory of the iway home directory, for example, C:\Program Files\iway56sm\config\base\wsdl\schemas\service\Clarify CBO\ClarifyTarget where: ClarifyTarget Is the name of the connection (target) to the ClarifyCRM system that you defined using iway Explorer. Beneath this directory, iway Explorer creates subdirectories containing schemas. When you use the adapter with a JCA configuration, iway Explorer stores the schemas beneath a \schemas subdirectory of the iway home directory, for example, C:\Program Files\iway56sm\config\base\schemas\Clarify CBO\ClarifyTarget where: ClarifyTarget Is the name of the connection (target) to the ClarifyCRM system that you defined using iway Explorer. iway Explorer stores the schemas in this directory. You create XML schemas for ClarifyCRM methods (for example, the get method) using iway Explorer. After you create schemas, you can view them and use them to create request and response documents. Procedure: How to Create an XML Schema for a ClarifyCRM Table To create an XML schema for a ClarifyCRM table: 1. Connect to a ClarifyCRM target, as described in Configuring and Managing Connections to ClarifyCRM on page In the left pane, expand the target node. 3. Click the Tables node. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 39

40 Generating Schemas A list of available tables in the Clarify system is displayed, as shown in the following image. 4. Select one of the available tables, for example, table_account. A list of available methods for the table is displayed, as shown in the following image. 5. Select one of the available methods, for example, INSERT. 40 iway Software

41 3. Creating XML Schemas and Web Services for ClarifyCRM XML request, response, and event schemas for the table are automatically created and displayed. The Detail, Request Schema, Response Schema, and Event Schema tabs appear on the right. 6. Click the Request Schema tab in the right pane. The XML request schema appears in the right pane, as shown in the following image. 7. Click the Response Schema tab in the right pane. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 41

42 Generating Schemas The XML response schema appears in the right pane, as shown in the following image. 8. Click the Event Schema tab in the right pane. 42 iway Software

43 3. Creating XML Schemas and Web Services for ClarifyCRM The XML event schema appears in the right pane, as shown in the following image. 9. To export XML schemas, right-click the method in the left pane, and select Export Schema(s), as shown in the following image. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 43

44 Generating Schemas The Select Export Directory dialog box opens, as shown in the following image. 10. Navigate to a directory on your file system where you want to export the XML schemas. The file path is displayed in the File Name field. 11. Click OK. The XML request, response, and event schemas are now exported to your local file system. 44 iway Software

45 3. Creating XML Schemas and Web Services for ClarifyCRM Constructing XML Request Documents Example: Creating a Payload to Insert a New Record Into the SITE CBO Reference: Sample XML Payload for the Update Operation Sample XML Payload for the Delete Operation Sample XML Payload for the Get (Query) Operation The iway Application System Adapter for Amdocs ClarifyCRM generates the generic schema in terms of operation (insert, update, delete, and get functions). It does not generate the schema in terms of CBO and all the related operations supported by the CBOs. The schema does not show CBO-specific tables and fields. As a result, you must manually create the payload (XML request document) for services by adding and editing the table names, relations between table names, and field names in the payload. Creating the payload requires advanced technical and functional knowledge of Clarify. For more information, see the Core Business Objects Reference Guide and the Data Dictionary for Objects Guide from Amdocs Clarify. This documentation is specific to each version of Amdocs Clarify. The following example shows how to create a payload to insert a new record into the SITE CBO. Example: Creating a Payload to Insert a New Record Into the SITE CBO 1. Refer to the Core Business Objects Reference Guide for ClarifyCRM to determine the specific table and related CBOs for SITE. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 45

46 Constructing XML Request Documents The following diagram provides an overview of the SITE CBO. It shows the table name, dependent CBOs, tables for dependent CBOs, and how the other CBOs are related to the SITE CBO. 2. Using this knowledge in Clarify, determine the mandatory CBOs with which the SITE CBO has a dependency. For example, the Address is a mandatory CBO with which the SITE CBO has a dependency. Note the different types of address and their relations. CBO Site Address Table Site Address 46 iway Software

47 3. Creating XML Schemas and Web Services for ClarifyCRM BillToAddress : cust_billaddr2address PrimaryAddress : cust_primaddr2address ShipToAddress : cust_shipaddr2address 3. Refer to the Data Dictionary for Objects Guide for the Site and Address tables that you located earlier. 4. Make a list of the fields that are mandatory for inserting a new record into the Site and Address tables. 5. Connect to a target configured for the iway Application System Adapter for Amdocs ClarifyCRM using iway Explorer. 6. Expand the Tables node, and select the table named table_site. 7. Right-click the insert operation and select Export Schemas. 8. Using an XML editor, for example, XMLSpy, open the XML schema that you exported. 9. Generate a sample XML document, for example: <?xml version="1.0" encoding="utf-8"?> <!--Sample XML file generated by XMLSPY v5 rel. 4 U ( <sp xmlns="urn:iwaysoftware:adapter:clarifycbo:feb2004" xmlns:xsi=" xsi:schemalocation="urn:iwaysoftware:adapter:clarifycbo:feb2004 X:\Temp\insert_request.xsd"> <data> <cbo name="string" action="insert"> <fields> <field name="string">string</field> </fields> </cbo> </data> </sp> 10. Locate the following section: <cbo name="string" action="insert"> <fields> <field name="string">string</field> </fields> </cbo> 11. Update values such as cbo name, action, and fields. 12. If there are any dependent CBOs, embed them within the field's elements. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 47

48 Constructing XML Request Documents For example: <cbo name="string" action="insert"> <fields> <field name="string">string</field> <cbo name="string" relation="insert"> <fields> <field name="string">string</field> </fields> </cbo> <cbo name="string" action="insert"> <fields> <field name="string">string</field> </fields> </cbo> </fields> </cbo> 48 iway Software

49 3. Creating XML Schemas and Web Services for ClarifyCRM When you are finished, the XML payload for the insert operation of the SITE CBO has the following structure: <sp> <data> <cbo name="site" action="insert"> <fields> <field name="site_id" data_type="string">int1012</field> <field name="name" data_type="string">information Builders</field> <field name="type" data_type="int">3</field> <field name="status" data_type="int">0</field> <field name="phone" data_type="string"> </field> <field name="fax" data_type="string"> </field> <cbo name="address" relation="cust_primaddr2address"> <fields> <field name="address" data_type="string">tenn Plaza</field> <field name="city" data_type="string">newyork</field> <field name="state" data_type="string">ny</field> <field name="zipcode" data_type="string">10121</field> </fields> </cbo> <cbo name="address" relation="cust_billaddr2address"> <fields> <field name="address" data_type="string">twenn Plaza</field> <field name="city" data_type="string">newyork</field> <field name="state" data_type="string">ny</field> <field name="zipcode" data_type="string">10121</field> </fields> </cbo> <cbo name="address" relation="cust_shipaddr2address"> <fields> <field name="address" data_type="string">tonn Plaza</field> <field name="city" data_type="string">newyork</field> <field name="state" data_type="string">ny</field> <field name="zipcode" data_type="string">10121</field> </fields> </cbo> </fields> </cbo> </data> </sp> 13. Repeat these steps to create XML payload documents for other operations, such as update, delete, and get (query). iway Application System Adapter for Amdocs ClarifyCRM User s Guide 49