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

50 Constructing XML Request Documents Reference: Sample XML Payload for the Update Operation <sp> <data> <cbo name="site" action="update"> <keys> <field name="site_id" data_type="string">int1011</field> </keys> <fields> <cbo name="address" relation="cust_primaddr2address"> <fields> <field name="address" data_type="string">009 Drive</field> <field name="city" data_type="string">royal Tower</field> <field name="state" data_type="string">uk</field> </fields> </cbo> </fields> </cbo> </data> </sp> Reference: Sample XML Payload for the Delete Operation <sp> <data> <cbo name="site" action="delete"> <keys> <field name="site_id">11111</field> </keys> </cbo> </data> </sp> 50 iway Software

51 3. Creating XML Schemas and Web Services for ClarifyCRM Reference: Sample XML Payload for the Get (Query) Operation <sp> <data> <cbo name="site" action="get"> <keys> <field name="site_id" data_type="string">int1013</field> </keys> <fields> <field name="objid" data_type="string"/> <field name="site_id" data_type="string"/> <field name="name" data_type="string"/> <field name="phone" data_type="string"/> <field name="fax" data_type="string"/> <field name="type" data_type="string"/> <field name="status" data_type="int"/> <cbo name="address" relation="cust_primaddr2address"> <fields> <field name="objid" data_type="string"/> <field name="address" data_type="string"/> <field name="city" data_type="string"/> <field name="state" data_type="string"/> <field name="zipcode" data_type="string"/> </fields> </cbo> </fields> </cbo> </data> </sp> Generating Business Services How to: Create an iway Business Service Reference: Sample iway Business Service XML Input for Get Sample iway Business Service XML Input for Insert iway Explorer provides Web developers with a simple, consistent mechanism for extending the capabilities of the iway Application System Adapter for Amdocs ClarifyCRM. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 51

52 Generating Business Services You can generate a business service (also known as a Web service) for a ClarifyCRM table. To generate a business service, you must deploy the adapter in a business services environment using iway Business Services Provider (ibsp). ibsp exposes functionality as Web services. It serves as a gateway to heterogeneous back-end applications and databases. A Web service is a self-contained, modularized function that can be published and accessed across a network using open standards. It is the implementation of an interface by a component and is an executable entity. For the caller or sender, a Web service can be considered a "black box" that may require input, and that delivers a result. Web services can be integrated within an enterprise as well as across enterprises on any communication technology stack, whether asynchronous or synchronous, in any format. You can make a Web service available to other services within a host server by generating WSDL (Web Services Description Language) from the Web service. Ensure that the servlet ibsp is properly configured. For more information on installing and deploying iway components, see the iway Installation and Configuration manual. Note: In a J2EE Connector Architecture (JCA) implementation of iway adapters, Web services are not available. When the iway adapters are deployed for use with the iway Connector for JCA, the Common Client Interface provides integration services using the adapters. For more information, see the iway Installation and Configuration manual. Procedure: How to Create an iway Business Service To create an iway business service for ClarifyCRM: 1. If you have not already done so, connect to a ClarifyCRM target as described in Connecting to ClarifyCRM on page In the left pane of iway Explorer, expand the target node to display all the tables and their methods. The list includes all the methods currently supported by the adapter. The methods exposed are generic to all the business objects of Clarify. 3. Right-click the method for which you want to create a business service (for example, INSERT), and select Create iway Business Service. 52 iway Software

53 3. Creating XML Schemas and Web Services for ClarifyCRM The Create iway Business Service dialog box opens, as shown in the following image. 4. Perform the following steps. a. From the Existing Service Names drop-down list, choose whether you want to create a new service name or use an existing service name. b. In the Service Name field, type a descriptive name for the iway Business Service. c. In the Service Description field, type a brief description of the service (optional). 5. Click Next. A second Create iway Business Service dialog box opens and prompts you for additional information. 6. Perform the following steps. a. From the License Name drop-down list, select a license definition. b. In the Method Name field, type a descriptive name for the method. c. In the Method Description field, type a brief description of the method (optional). 7. Click OK. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 53

54 Generating Business Services The iway Business Services node expands in the left pane. The new iway Business Service appears beneath the Services node. The following image shows an iway Business Service named SampleOne and, beneath that service, a method called INSERT. The right pane displays the name of the expanded iway Business Service and provides a hyperlink to the selected method, for example, INSERT. 8. Click the INSERT hyperlink in the right pane. 54 iway Software

55 3. Creating XML Schemas and Web Services for ClarifyCRM An iway Business Service test pane opens in your Web browser, as shown in the following image. When you create a new business service, test it to ensure that it functions properly. 9. In the input xml field, enter a sample XML document that will query the service. You can use copy and paste, or browse to a file and upload the content. For sample XML input, see Sample iway Business Service XML Input for Get on page 58 and Sample iway Business Service XML Input for Insert on page 59. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 55

56 Generating Business Services For example, the following sample XML document retrieves an item from the ClarifyCRM database. <sp> <data> <cbo name="contact_role" action="get"> <keys> <field name="objid"> </field> </keys> <fields> <field name="role_name" data_type="string" /> <field name="primary_site" data_type="string" /> <cbo name="contact" relation="contact_role2contact"> <fields> <field name="first_name" data_type="string" /> <field name="last_name" data_type="string" /> <field name="phone" data_type="string" /> </fields> </cbo> <cbo name="site" relation="contact_role2site"> <fields> <field name="site_id" data_type="string" /> <field name="name" data_type="string" /> <cbo name="address" relation="cust_primaddr2address"> <fields> <field name="address" data_type="string" /> <field name="city" data_type="string" /> <field name="state" data_type="string" /> </fields> </cbo> </fields> </cbo> </fields> </cbo> </data> </sp> 10. Click Invoke. The test response appears in the Web browser. 56 iway Software

57 3. Creating XML Schemas and Web Services for ClarifyCRM The following is the test response for the preceding XML input document. The adapter returns the requested item from the ClarifyCRM database. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 57

58 Generating Business Services Reference: Sample iway Business Service XML Input for Get <sp> <data> <cbo name="contact_role" action="get"> <keys> <field name="objid"> </field> </keys> <fields> <field name="role_name" data_type="string" /> <field name="primary_site" data_type="string" /> <cbo name="contact" relation="contact_role2contact"> <fields> <field name="first_name" data_type="string" /> <field name="last_name" data_type="string" /> <field name="phone" data_type="string" /> </fields> </cbo> <cbo name="site" relation="contact_role2site"> <fields> <field name="site_id" data_type="string" /> <field name="name" data_type="string" /> <cbo name="address" relation="cust_primaddr2address"> <fields> <field name="address" data_type="string" /> <field name="city" data_type="string" /> <field name="state" data_type="string" /> </fields> </cbo> </fields> </cbo> </fields> </cbo> </data> </sp> 58 iway Software

59 3. Creating XML Schemas and Web Services for ClarifyCRM Reference: Sample iway Business Service XML Input for Insert <sp> <data> <cbo name="contact_role" action="insert"> <fields> <field name="role_name" data_type="string">default</field> <cbo name="contact" relation="contact_role2contact"> <fields> <field name="first_name" data_type="string">harvey</field> <field name="last_name" data_type="string">walsteader</field> <field name="phone" data_type="string"> </field> </fields> </cbo> <cbo name="site" relation="contact_role2site"> <fields> <field name="site_id" data_type="string"> </field> <field name="name" data_type="string">infogain</field> <cbo name="address" relation="cust_primaddr2address"> <fields> <field name="address" data_type="string">b-17,sec-58</field> <field name="city" data_type="string">noida</field> <field name="state" data_type="string">u.p.</field> </fields> </cbo> <cbo name="address" relation="cust_billaddr2address"> <fields> <field name="address" data_type="string">b-17,sec-58</field> <field name="city" data_type="string">noida</field> <field name="state" data_type="string">u.p.</field> </fields> </cbo> <cbo name="address" relation="cust_shipaddr2address"> <fields> <field name="address" data_type="string">b-17,sec-58</field> <field name="city" data_type="string">noida</field> <field name="state" data_type="string">u.p.</field> </fields> </cbo> </fields> </cbo> </fields> </cbo> </data> </sp> iway Application System Adapter for Amdocs ClarifyCRM User s Guide 59

60 Generating Business Services 60 iway Software

61 iway 4 Listening for ClarifyCRM Events This section describes how to use the iway Application System Adapter for Amdocs ClarifyCRM to listen for events in a ClarifyCRM database table. Although this section describes the Java Swing implementation of iway Explorer, other implementations provide the same functionality by means of similar graphical user interfaces. Topics: Understanding iway Event Functionality Configuring Database Triggers and Event Tables Creating an Event Port Creating a Channel iway Application System Adapter for Amdocs ClarifyCRM User s Guide 61

62 Understanding iway Event Functionality Understanding iway Event Functionality Events are generated as a result of ClarifyCRM activity. You can use events to trigger an action in your application. After you create a connection to your application system, you can add events using iway Explorer. To create an iway event, you must create a port and a channel. Port A port is a logical definition of how to direct event data. It includes information on where to store the data and where to place it after it is processed. A port associates a particular business object exposed by an adapter with a particular disposition. A disposition defines the protocol and location of the event data. The port defines the end point of the event consumption. For example, you can use a JMS protocol to route the result of polling a table to a JMS queue hosted by a J2EE application server. For more information, see Creating an Event Port on page 66. Channel A channel defines the listening capability that detects events in the target Enterprise Information System (EIS) or database. It represents configured connections to particular instances of back-end systems or other types of systems. A channel binds one or more event ports to a particular listener managed by an adapter. For more information, see Creating a Channel on page 81. Configuring Database Triggers and Event Tables In this section: Obtaining the JDBC Driver Generating Event Triggers Before you can use the iway Application System Adapter for Amdocs ClarifyCRM to listen for events, you must configure database triggers and event tables. The adapter supports event handling with ClarifyCRM, which is facilitated by the following mechanisms. iway database triggers and an iway table 62 iway Software

63 4. Listening for ClarifyCRM Events You can install iway database triggers and an iway table in the ClarifyCRM database. Whenever an event occurs in the ClarifyCRM database, a new record is created in the iway table, with key fields, for example, objid, table name, and so on. iway channel You can configure an iway channel to listen on an iway table through a table listener. The channel can extract the records and pass them to a specific disposition. The output can consist of an XML document, which can be used in a process flow created with iway Designer, and which can continue from there as required. Obtaining the JDBC Driver The iway Application System Adapter for Amdocs ClarifyCRM requires JDBC access to the ClarifyCRM database for event processing. Before you install the adapter, you must install the appropriate JDBC driver. You must also set the CLASSPATH for the new driver. If the ClarifyCRM database is stored in Microsoft SQL Server, you can obtain the necessary JDBC driver from the following Web site: After you have obtained and installed the appropriate driver, you can continue with configuring the database triggers and event tables. Generating Event Triggers How to: Generate Event Triggers The following section describes how to generate event triggers for a table using iway Explorer. Procedure: How to Generate Event Triggers To generate event triggers using iway Explorer: 1. Connect to a ClarifyCRM target, as described in Connecting 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 63

64 Configuring Database Triggers and Event Tables A list of available tables in the Clarify system is displayed, as shown in the following image. 4. Right-click one of the available tables, for example, table_purchase_ord, and select Generate Triggers, as shown in the following image. 64 iway Software

65 4. Listening for ClarifyCRM Events The Generate Triggers status window opens and indicates that the triggers were created successfully. 5. Click OK. A Triggers node is added, which contains three event triggers that are now available for the table (delete, update, and insert). iway Application System Adapter for Amdocs ClarifyCRM User s Guide 65

66 Creating an Event Port Note: If you try to generate event triggers for a table that already has available triggers, the following message is displayed. Creating an Event Port In this section: Editing or Deleting an Event Port Using the Default Event Port How to: Create an Event Port for File Create an Event Port for ibse Create an Event Port for MSMQ Create an Event Port for JMSQ Create an Event Port for SOAP Create an Event Port for HTTP Create an Event Port for MQSeries The following procedures describe how to create an event port using iway Explorer. 66 iway Software

67 4. Listening for ClarifyCRM Events When you use iway Explorer with an iway Business Services Provider (ibsp) implementation, the following port dispositions are available. File. The File disposition uses a file URL to specify the destination file name or directory where the event document will be written. During run time, the destination file name may require indexing to avoid overwriting. For more information, see How to Create an Event Port for File on page 68. IBSE. The ibse disposition enables an event to launch a business service method. For more information, see How to Create an Event Port for ibse on page 70. MSMQ. The Microsoft Message Queue disposition supports public and private queues. For more information, see How to Create an Event Port for MSMQ on page 71. JMSQ. The JMSQ disposition allows an event to be enqueued to a JMS queue. For more information, see How to Create an Event Port for JMSQ on page 72. SOAP. The SOAP disposition allows an event to launch a business service specified by a WSDL file. A SOAP action is optional. The default value for a SOAP action is. For more information, see How to Create an Event Port for SOAP on page 74. HTTP. The HTTP disposition uses an HTTP URL to specify an HTTP end point to which the event document is posted. For more information, see How to Create an Event Port for HTTP on page 77. MQSeries. The MQSeries disposition enables an event to be enqueued to an MQSeries queue. You can specify both queue manager and queue name. For more information, see How to Create an Event Port for MQSeries on page 77. When you use iway Explorer with a JCA implementation, the following port dispositions are available. File. The File disposition uses a file URL to specify the destination file name or directory where the event document will be written. During run time, the destination file name may require indexing to avoid overwriting. For more information, see How to Create an Event Port for File on page 68. HTTP. The HTTP disposition uses an HTTP URL to specify an HTTP end point to which the event document is posted. For more information, see How to Create an Event Port for HTTP on page 77. JMSQ. The JMS queue allows an event to be enqueued to a JMS queue. For more information, see How to Create an Event Port for JMSQ on page 72. MQSeries. The MQSeries disposition enables an event to be enqueued to an MQSeries queue. You can specify both queue manager and queue name. For more information, see How to Create an Event Port for MQSeries on page 77. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 67

68 Creating an Event Port Procedure: How to Create an Event Port for File To create an event port for File: 1. Click the iway Events node. 2. In the left pane, expand the Clarify CBO node. The following image shows the options (Add Port and Refresh) that are available in the left pane when you right-click the Ports node. 3. Right-click the Ports node and select Add Port from the menu. The following image shows the Add Port dialog box that opens, where you supply information about the port. a. In the Name field, type a name for the port. b. In the Description field, type a brief description. c. From the Protocol drop-down list, select FILE. 68 iway Software

69 4. Listening for ClarifyCRM Events d. In the URL field, type a File destination to which event data is written. When pointing iway Explorer to an ibse deployment, specify the destination file using the following format: ifile://[location];errorto=[pre-defined port name or another disposition url] When pointing iway Explorer to a JCA deployment, provide the full path to the directory. The following table lists and defines the parameters for the disposition. Parameter location Description Destination and file name of the document where event data is written, for example, ifile://d:\in\x.txt;errorto=ifile://d:\error errordest Predefined port name or another disposition URL where error logs are sent. 4. Click OK. In the left pane, the event port appears beneath the Ports node. In the right pane, summary information associated with the event port that you created appears. In this example, the event port is named ClarACCevents. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 69

70 Creating an Event Port You can now associate the event port with a channel. For more information, see Creating a Channel on page 81. Procedure: How to Create an Event Port for ibse To create an event port for ibse: 1. In the left pane, click the iway Events node. 2. Expand the Clarify CBO node. 3. Right-click the Ports node and select Add Port from the menu. The Add Port dialog box opens, as shown in the following image. a. In the Name field, type a name for the port. b. In the Description field, type a brief description. c. From the Protocol drop-down list, select ibse. 70 iway Software

71 4. Listening for ClarifyCRM Events d. In the URL field, type an ibse destination in the following format: ibse:svcname.mthname;responseto=[pre-defined port name or another disposition url]; errorto=[pre-defined port name or another disposition url] The following table lists and defines the parameters for the disposition. Parameter svcname mthname responseto errorto Description Name of the service created with ibse. Name of the method created for the business service. Location where responses to the business service are posted. Predefined port name or another full URL. Optional. Location where error documents are sent. Predefined port name or another full URL. Optional. 4. Click OK. The port appears beneath the Ports node in the left pane. In the right pane, a table appears that summarizes the information associated with the event port that you created. You can now associate the event port with a channel. For more information, see Creating a Channel on page 81. Procedure: How to Create an Event Port for MSMQ To create an event port for an MSMQ queue: 1. Click the iway Events node. 2. In the left pane, expand the Clarify CBO node. 3. Right-click the Ports node and select Add Port from the menu. The Add Port dialog box opens. a. In the Name field, type a name for the port. b. In the Description field, type a brief description. c. From the Protocol drop-down list, select MSMQ. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 71

72 Creating an Event Port d. In the URL field, type an MSMQ destination in the following format: msmq:/host/private$/qname;errorto=[pre-defined port name or another disposition url] The following table lists and defines the parameters for the disposition. Parameter host queuetype queuename errorto Description Machine name where the Microsoft Message Queuing system is running. For private queues, type Private$. Private queues are queues that are not published in Active Directory. They appear only on the local computer that contains them. Private queues are accessible only by Message Queuing applications that recognize the full path name or format name of the queue. Name of the private queue where messages are placed. Location where error documents are sent. Predefined port name or another full URL. Optional. 4. Click OK. The port appears beneath the Ports node in the left pane. In the right pane, a table appears that summarizes the information associated with the port that you created. You can now associate the event port with a channel. For more information, see Creating a Channel on page 81. Procedure: How to Create an Event Port for JMSQ To create an event port for a JMS queue: 1. Click the iway Events node. 2. In the left pane, expand the Clarify CBO node. 3. Right-click the Ports node and select Add Port from the menu. The Add Port dialog box opens. a. In the Name field, type a name for the port. b. In the Description field, type a brief description. 72 iway Software

73 4. Listening for ClarifyCRM Events c. From the Protocol drop-down list, select JMSQ. d. In the URL field, type a JMS destination. When pointing iway Explorer to an ibse deployment, use the following format: jmsq:myqueuename@myqueuefac;jndiurl=[myurl];jndifactory= [myfactory];user=[user];password=[xxx];errorto=[pre-defined port name or another disposition url] When pointing iway Explorer to a JCA deployment, use the following format: jms:jmsqueue@jmsfactory;jndiurl=;jndifactory=; The following table lists and defines parameters for the disposition. Parameter queue Connection Factory jndi_url jndi_factory user password errorto Description Name of a queue to which events are emitted. A resource that contains information about the JMS Server. The URL used to contact the JNDI provider. The syntax of this URL depends on which JNDI provider is used. This value corresponds to the standard JNDI property, java.naming.provider.url Is JNDI context.initial_context_factory and is provided by the JNDI service provider. User ID associated with this queue. Password for the user ID. Location to which error logs are sent. Optional. Predefined port name or another disposition URL. The URL must be complete, including the protocol. 4. Click OK. The port appears beneath the Ports node in the left pane. In the right pane, a table appears that summarizes the information associated with the port that you created. You can now associate the event port with a channel. For more information, see Creating a Channel on page 81. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 73

74 Creating an Event Port Procedure: How to Create an Event Port for SOAP To create an event port for a SOAP disposition: 1. Click the iway Events node. 2. In the left pane, expand the Clarify CBO node. 3. Right-click the Ports node and select Add Port from the menu. The Add Port dialog box opens. a. In the Name field, type a name for the port. b. In the Description field, type a brief description. c. From the Protocol drop-down list, select SOAP. 74 iway Software

75 4. Listening for ClarifyCRM Events d. In the URL field, type an SOAP destination, using the following format: soap:[wsdl-url];soapaction=[myaction];method=[web service method];namespace=[namespace];responseto=[pre-defined port name or another disposition URL];errorTo=[pre-defined port name or another disposition url] The following table lists and defines the parameters for the disposition. Parameter wsdl-url Description The URL to the WSDL file that is required to create the SOAP message, for example, webservice.ibs?wsdl where: webservice Is the name of the Web service that you created using iway Explorer. To find this value, navigate to the iway Business Services node, expand the Services node, select the service that you created, and click Service Description on the right. The WSDL URL appears in the Address field of the window that opens. You can also open the WSDL file in a third-party XML editor (for example, XMLSpy) and view the SOAP request settings to find this value. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 75

76 Creating an Event Port Parameter soapaction method namespace responseto errorto Description The method called by the SOAP disposition. For example: where: webservice Is the name of the Web service that you created using iway Explorer. method Is the method that is used. test Is the license that is used by the Web service. You can find this value by navigating to the iway Business Services node and opening the Service Description link in a new window. Perform a search for soapaction. You can also open the WSDL file in a third-party XML editor (for example, XMLSpy) and view the SOAP request settings to find this value. The Web service method that you are using. This value is found in the WSDL file. The XML namespace that you are using. This value is found in the WSDL file. The location to which responses are posted, which can be a predefined port name or another URL. Optional. The location to which error logs are posted, which can be a predefined port name or another URL. Optional. 4. Click OK. The event port appears beneath the Ports node in the left pane. In the right pane, a table appears that summarizes the information associated with the event port that you created. You can now associate the event port with a channel. For more information, see Creating a Channel on page iway Software

77 4. Listening for ClarifyCRM Events Procedure: How to Create an Event Port for HTTP To create an event port for an HTTP disposition: 1. Click the iway Events node. 2. In the left pane, expand the Clarify CBO node. 3. Right-click the Ports node and select Add Port from the menu. The Add Port dialog box opens. To point iway Explorer to an ibse deployment, follow the steps in How to Create an Event Port for ibse on page 70. To point iway Explorer to a JCA deployment, use the following format: The following table lists and defines the parameters for the disposition. Parameter host port uri Description Name of the host on which the Web server resides. Port number on which the Web server is listening. Universal resource identifier that completes the URL specification. 4. Click OK. The event port appears beneath the Ports node in the left pane. In the right pane, a table appears that summarizes the information associated with the event port that you created. You can now associate the event port with a channel. For more information, see Creating a Channel on page 81. Procedure: How to Create an Event Port for MQSeries To create an event port for an MQSeries queue: 1. Click the iway Events node. 2. In the left pane, expand the Clarify CBO node. 3. Right-click the Ports node and select Add Port from the menu. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 77

78 Creating an Event Port The Add Port dialog box opens. a. In the Name field, type a name for the port. b. In the Description field, type a brief description. c. From the Protocol drop-down list, select MQSeries. d. In the URL field, type an MQSeries destination. When pointing iway Explorer to an ibse deployment, use the following format: mqseries:/qmanager/qname;host=[hostname]; port=[port];channel=[channelname]; errorto=[predefined port name or another disposition url] When pointing iway Explorer to a JCA deployment, use the following format: mq:qmanager@respqueue;host=;port=;channel= The following table lists and defines the parameters for the disposition. Parameter qmanager qname or respqueue host port channel errorto Description Name of the queue manager to which the server must connect. Name of the queue where messages are placed. Name of the host on which MQSeries resides (MQ client only). Number that connects to an MQ server queue manager (MQ client only). Case-sensitive name of the channel that connects with the remote MQ Server queue manager (MQ client only). The default channel name is SYSTEM.DEF.SVRCONN. Location where error documents are sent. Predefined port name or another full URL. Optional. 4. Click OK. The port appears beneath the Ports node in the left pane. In the right pane, a table appears that summarizes the information associated with the event port that you created. You can now associate the event port with a channel. For more information, see Creating a Channel on page iway Software

79 4. Listening for ClarifyCRM Events Editing or Deleting an Event Port How to: Edit an Event Port Delete an Event Port The following procedures describe how to edit or delete an event port using iway Explorer. Procedure: How to Edit an Event Port To edit an existing event port using iway Explorer: 1. Right-click the event port that you want to edit. The following image shows the options (Edit and Delete) that appear in the left pane when you right-click the event port. In this example, the selected event port is named FilePort. 2. Select Edit from the menu. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 79

80 Creating an Event Port The following image shows a sample Edit Port dialog box that opens. 3. Make the required changes to the event port configuration fields. 4. Click OK. Procedure: How to Delete an Event Port To delete an existing event port using iway Explorer: 1. Right-click the event port that you want to delete. 2. Select Delete from the menu. The event port disappears from the list in the left pane. Using the Default Event Port When you use iway Explorer to connect to ClarifyCRM and listen for events, a default event port is available at all times, as shown in the following image. 80 iway Software

81 4. Listening for ClarifyCRM Events You can use the default event port for testing purposes or when you do not want to route event data to a specific port that you have configured. The default port is enabled when you start a channel that does not have a specific event port assigned. The default event data is a file disposition that writes to an out.xml file in the following output directory: ifile://./eventout/out.xml Creating a Channel How to: Create a Channel Edit a Channel Delete a Channel The following procedure describes how to use iway Explorer (Java Swing) to create a channel for a ClarifyCRM event. All defined event ports must be associated with a channel. Procedure: How to Create a Channel To create a channel using iway Explorer: 1. In the left pane, expand the iway Events node beneath the configuration that you created, for example, SampleConfig. The list of adapters appears. 2. Expand the Clarify CBO node. The following image shows the Ports and Channels nodes that appear beneath the Clarify CBO node. 3. Right-click Channels. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 81

82 Creating a Channel The following image shows the option (Add Channel) that is available when you rightclick Channels. 4. Select Add Channel. The following image shows the Add Channel dialog box that opens, where you supply information about the channel. a. In the Name field, type a name for the channel, for example,clarifychannel. 82 iway Software

83 4. Listening for ClarifyCRM Events b. In the Description field, type a brief description. c. From the Protocol drop-down list, select Clarify Listener. d. From the Available Port(s) list, select a port that you want to assign to this channel, and click the right arrow to move it to the Selected Port(s) list. 5. Click Next. To select all the ports in the Available Port(s) list, click the double right arrow. The following image shows a sample SQL Server Table Listener dialog box that opens, where you supply information about the table listener and provide parameters. 6. Type the values according to the information in the following table. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 83

84 Creating a Channel The table lists and describes the required parameters for the SQL Server Table Listener. Parameter Host Port Database Name User Password Polling Interval Table Name Event type Description The name of the server on which the ClarifyCRM database instance resides. The port number on which the database is listening. The name of the database. The ClarifyCRM database user ID that has access to the ClarifyCRM database underlying the ClarifyCRM system. The user ID must have database access to the applicable interface tables. The password associated with the specified user ID. The interval, in milliseconds, at which to check for new input. The name of the table that is polled. The type of event for which the table is polled. The possible values are ANY, INSERT, UPDATE, and DELETE. 7. After you provide the required information, click OK. The following image shows the channel that you created beneath the Channels node in the left pane. In this example, the channel is named ClarifyChannel. An X over the icon indicates that the channel is currently disconnected. You must start the channel to activate the event configuration. In the right pane, a table summarizes the information associated with the channel. You are ready to start the channel to listen for events. 8. In the left pane, right-click the channel, for example, ClarifyChannel, and select Start. 84 iway Software

85 4. Listening for ClarifyCRM Events The channel that you created is now active. a. To stop the channel at any time, right-click the channel. b. Select Stop. Procedure: How to Edit a Channel To edit an existing channel: 1. In the left pane, right-click the channel that you want to edit, for example,clarifychannel. 2. Select Edit. The Edit Channel dialog box opens. 3. Make the required changes to the channel configuration and click OK. Procedure: How to Delete a Channel To delete an existing channel: 1. In the left pane, right-click the channel that you want to delete, for example, ClarifyChannel. 2. Select Delete. The channel disappears from the list in the left pane. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 85

86 Creating a Channel 86 iway Software

87 iway 5 Configuring the Adapter in iway Designer After you successfully configure the adapter to represent a particular adapter target, you can use the adapter within an iway Designer process flow. Topics: Using the Adapter in iway Designer iway Application System Adapter for Amdocs ClarifyCRM User s Guide 87

88 Using the Adapter in iway Designer Using the Adapter in iway Designer How to: Add a Previously Defined Adapter Define a New Adapter in iway Designer You can make an adapter available to a process flow created in iway Designer. iway Designer is a GUI-based tool used to build stateless process flows that execute within iway Service Manager. You can incorporate the adapter as a node, called an Adapter object, in an iway process flow, allowing you to integrate it easily into a business process solution. When creating an Adapter object, you can add an adapter to the object in one of two ways. You can add an adapter that has already been defined either in an iway Designer process flow or in iway Service Manager. For more information, see How to Add a Previously Defined Adapter on page 88. You can add an adapter that has not been previously defined in iway Designer or iway Service Manager. For more information, see How to Define a New Adapter in iway Designer on page 90. To use an adapter in a process flow, you must first configure a target for the adapter within iway Explorer. For more information on configuring a target, see Configuring and Managing Connections to ClarifyCRM on page 25. Before you begin, ensure that you have created a project and created a process for that project. To create a process, right-click the Processes folder in your project and select New Process from the menu. For more information, see the iway Designer User's Guide. Procedure: How to Add a Previously Defined Adapter To add a previously defined adapter: 1. In the left pane of iway Designer, select the process to which you want to add the adapter. 2. From the button bar, click and drag the Adapter object icon to the workspace. 88 iway Software

89 5. Configuring the Adapter in iway Designer The New Adapter Object dialog box opens, as shown in the following image. a. Type a descriptive name, for example, ClarifyCRM, and a brief description (optional) for the Adapter object. b. If you have updated adapter target information in iway Explorer, click Refresh Adapters. 3. Click Next. Note: The Deactivate option allows you to configure the object, but suppress its function within the process flow (usually used for debugging). The Design mode option allows you to insert the object without configuring it, so that it acts as a placeholder in the process flow. You are prompted to select the adapter type from the Defined Adapters list. 4. Select the adapter from the Defined Adapters drop-down list. If you do not see the adapter in the list, you must complete the procedure for defining the adapter. For instructions, see How to Define a New Adapter in iway Designer on page Click Next. The Properties dialog box for the selected adapter opens. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 89

90 Using the Adapter in iway Designer In this dialog box, you can review and change the properties associated with the target. To change a property, click in the field and edit it directly. If multiple dialog boxes appear, continue to click Next to review all the properties. 6. Click Finish. An icon representing the Adapter object appears in the workspace, and the adapter is available to your iway process flow. For information on defining relationships between the Adapter object and other objects in your iway process flow, see the iway Designer User's Guide. Procedure: How to Define a New Adapter in iway Designer From the New Adapter Object dialog box, you can create an adapter object that has not been previously defined in the repository. 1. Select the process to which you want to add the adapter object. 2. From the button bar, click and drag the Adapter Object icon to the workspace. 90 iway Software

91 5. Configuring the Adapter in iway Designer The New Adapter Object - Adapter Name and Description dialog box opens, as shown in the following image. a. Provide a descriptive name and a brief description (optional) for the Adapter object. b. If you have updated adapter target information in iway Explorer, click Refresh Adapters. 3. Click Next. 4. In the Adapter Type dialog box, click New. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 91

92 Using the Adapter in iway Designer The New Adapter Definition - Adapter Name and Description dialog box opens, as shown in the following image. 5. Type a unique, descriptive name that will be used as an alias and a brief description (optional) for the adapter you are defining. 6. Click Next. 92 iway Software

93 5. Configuring the Adapter in iway Designer The Define Adapter - ibsp URL dialog box opens, as shown in the following image. 7. Select an available ibsp URL from the drop-down list, or type a URL in the following format where host port 8. Click Next. Is the name of the machine on which iway Service Manager is installed. Is the port number on which ibsp listens for SOAP requests. The default value is The Adapter/Target dialog box opens. a. From the Adapter drop-down list, select the adapter. b. From the Target drop-down list, select the target that you want to use in your iway process flow. 9. Click Next. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 93

94 Using the Adapter in iway Designer The descriptor properties for the adapter and target that you selected appear. You can review and change the parameters associated with the target. To change a parameter, click in the field and edit it directly. If multiple dialog boxes appear, continue to click Next to review all of the parameters. 10. Click Next at the last New Adapter Define dialog box. The main Properties dialog box appears. You can review and change the properties for the new adapter definition. 11. Click Finish. The Adapter Type dialog box appears, with the newly created adapter in the Defined Adapters field. 12. To use this adapter to create the Adapter object, click Next. The adapter and target properties for the Adapter object appear in the Properties dialog box. You can review all parameters associated with the target again. Continue to click Next to move through the dialog boxes. 13. At the final Properties dialog box, click Finish. An icon representing the Adapter object appears in the workspace, and the adapter is available to your iway process flow. For information on defining relationships between the Adapter object and other objects in your iway process flow, see the iway Designer User's Guide. 94 iway Software

95 iway Configuring the Adapter in an iway A Environment After you successfully configure the adapter to represent a particular adapter target, you can assign the adapter to an iway Service Manager channel or iway Adapter Manager listener. Topics: Configuring the Adapter in iway Service Manager Configuring the Adapter in Adapter Manager iway Application System Adapter for Amdocs ClarifyCRM User s Guide 95

96 Configuring the Adapter in iway Service Manager Configuring the Adapter in iway Service Manager How to: Define the Adapter Modify or Update an Adapter Connection Before configuring the adapter in iway Service Manager, you must create a target, which represents a connection to a back-end system, using iway Explorer. For more information on configuring targets and connections using iway Explorer, see Configuring and Managing Connections to ClarifyCRM on page 25. You configure the adapter in the iway Service Manager console. The configuration process creates run-time connection and persistent data files within Service Manager. The configuration process interrogates the Service Manager repository entries that were built when the target and connection were created using iway Explorer. The define adapter process creates the run-time repository based on the design-time repository. Procedure: How to Define the Adapter To define the adapter: 1. In the Service Manager console, select Registry, then Adapters. 2. Click Add. The ibsp URL pane opens, as shown in the following image. 3. Type your ibsp URL, which is the location of the Service Manager repository, for example, The value for this field is required. 4. Click Next. An adapter selection pane opens. 5. From the Adapter drop-down list, select the adapter, and then click Next. 6. From the Target drop-down list, select a target that you configured for the adapter in iway Explorer, then click Next. 96 iway Software

97 A. Configuring the Adapter in an iway Environment The connection information associated with the target selected is displayed. a. Choose whether or not to return an error document when an error occurs. b. Choose whether or not an adapter connection will be reused between executes. c. Review the connection information that you specified in iway Explorer. You can change or update any information. 7. Click Next. 8. Provide a name and, optionally, a description, for the adapter, and click Finish. The adapter appears in the Adapters list. Procedure: How to Modify or Update an Adapter Connection To modify or update an adapter connection: 1. From the Adapters list, click the adapter reference that you defined. The pane that displays the target connection information opens. You cannot change the name of the adapter or the target, but you can edit the connection information. 2. After you modify the connection information, click Update Connection Properties. 3. After you make changes or additions to the adapter target in iway Explorer, click Update Adapter Data. 4. Click Finish. Configuring the Adapter in Adapter Manager How to: Configure the Adapter Modify or Update an Adapter Connection Before configuring the adapter in Adapter Manager, you must create a target using iway Application Explorer. The target represents a connection to a back-end system. For more information on configuring targets and connections using Application Explorer, see the Application Explorer User's Guide. You configure the adapter in the Adapter Manager console. The configuration process creates run-time connection and persistent data files within Adapter Manager. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 97

98 Configuring the Adapter in Adapter Manager The configuration process interrogates the Adapter Manager repository entries that were built when the target and connection were created using Application Explorer. The define adapter process creates the run-time repository based on the design-time repository. Procedure: How to Configure the Adapter To configure the adapter: 1. In the left pane of the Adapter Manager console, click Configuration, select Defines, and then click Adapters. The Adapter Defines pane opens, as shown in the following image. a. In the Name field, type the name of the adapter, for example, ClarifyCRM. b. In the Description field (optional), type a description of the adapter, for example, Sample Adapter. 2. Click Add. The following pane opens. A value for the ibsp URL is required in the Parameter Value field, as shown in the image. 3. Type the ibsp URL, which is the location of the Adapter Manager repository, or accept the default value, 4. Click Next. 98 iway Software

99 A. Configuring the Adapter in an iway Environment The following pane, which consists of four columns, opens. The first column lists the parameter name, the second column provides drop-down lists and check boxes where you can select a value for each parameter, the third column lists the parameter type, and the fourth column provides a description for each parameter. a. From the Adapter drop-down list in the Parameter Value column, select the iway adapter. b. From the Target drop-down list, select the target corresponding to the adapter that you configured in Application Explorer. c. To return an error document, select the Create Error Document check box (optional). d. To enable a persistent connection, select the Persist Connection check box (optional). 5. Click Next. The target connection information pane opens and displays the connection information that was previously configured in Application Explorer and the Logon pane. The first column lists the parameter name, the second column provides a value for each connection parameter, the third column lists the parameter type, and the fourth column provides a description for each parameter. 6. Review the imported configuration and if you wish, modify or update the connection information. 7. Click Finish. The adapter that you configured, ClarifyCRM, appears in the Adapter Defines list, as shown in the following image. The name of the adapter and a description (optional) are displayed. iway Application System Adapter for Amdocs ClarifyCRM User s Guide 99

100 Configuring the Adapter in Adapter Manager Procedure: How to Modify or Update an Adapter Connection To modify or update an adapter connection: 1. From the Adapter Defines list, select the adapter you defined, in this example, ClarifyCRM. You are returned to the pane that displays the target connection information. You cannot change the name of the adapter or the target, but you can edit the connection information. a. After you modify the connection information, click Update Connection Properties. b. After you make changes or additions to the adapter target in Application Explorer, click Update Adapter Data. 2. Click Save. 100 iway Software

101 iway Reader Comments In an ongoing effort to produce effective documentation, the Documentation Services staff at Information Builders welcomes any opinion you can offer regarding this manual. Please use this form to relay suggestions for improving this publication or to alert us to corrections. Identify specific pages where applicable. You can contact us through the following methods: Mail: Fax: Web form: Name: Company: Address: Telephone: Comments: Documentation Services - Customer Support Information Builders, Inc. Two Penn Plaza New York, NY (212) [email protected] Date: Information Builders, Two Penn Plaza, New York, NY (212) iway Application System Adapter for Amdocs ClarifyCRM User s Guide DN Version 5 Release 6 Service Manager (SM)

102 Reader Comments Information Builders, Two Penn Plaza, New York, NY (212) iway Application System Adapter for Amdocs ClarifyCRM User s Guide DN Version 5 Release 6 Service Manager (SM)