CA Gen. Gen Studio Overview Guide. Release 8.5. Third Edition

Transcription

1 CA Gen Gen Studio Overview Guide Release 8.5 Third Edition

2 This Documentation, which includes embedded help systems and electronically distributed materials (hereinafter referred to as the Documentation ), is for your informational purposes only and is subject to change or withdrawal by CA at any time. This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. This Documentation is confidential and proprietary information of CA and may not be disclosed by you or used for any purpose other than as may be permitted in (i) a separate agreement between you and CA governing your use of the CA software to which the Documentation relates; or (ii) a separate confidentiality agreement between you and CA. Notwithstanding the foregoing, if you are a licensed user of the software product(s) addressed in the Documentation, you may print or otherwise make available a reasonable number of copies of the Documentation for internal use by you and your employees in connection with that software, provided that all CA copyright notices and legends are affixed to each reproduced copy. The right to print or otherwise make available copies of the Documentation is limited to the period during which the applicable license for such software remains in full force and effect. Should the license terminate for any reason, it is your responsibility to certify in writing to CA that all copies and partial copies of the Documentation have been returned to CA or destroyed. TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION AS IS WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION, LOST PROFITS, LOST INVESTMENT, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE. The use of any software product referenced in the Documentation is governed by the applicable license agreement and such license agreement is not modified in any way by the terms of this notice. The manufacturer of this Documentation is CA. Provided with Restricted Rights. Use, duplication or disclosure by the United States Government is subject to the restrictions set forth in FAR Sections , , and (c)(1) - (2) and DFARS Section (b)(3), as applicable, or their successors. Copyright 2015 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.

3 CA Technologies Product References This document references the following CA products: CA Gen Contact CA Technologies Contact CA Support For your convenience, CA Technologies provides one site where you can access the information that you need for your Home Office, Small Business, and Enterprise CA Technologies products. At you can access the following resources: Online and telephone contact information for technical assistance and customer services Information about user communities and forums Product and documentation downloads CA Support policies and guidelines Other helpful resources appropriate for your product Providing Feedback About Product Documentation If you have comments or questions about CA Technologies product documentation, you can send a message to techpubs@ca.com. To provide feedback about CA Technologies product documentation, complete our short customer survey which is available on the CA Support website at

4 Documentation Changes The following documentation update have been made since the last release of this documentation: Create and Publish Web Services to CA API Gateway (see page 81) - Added this topic that guide you through creating and publishing web services to CA API Gateway. Messages in Gen Studio (see page 83) - Added this chapter to include the error messages in CA Gen Studio.

5 Contents Chapter 1: Introduction 9 Working with Gen Studio... 9 Audience... 9 Perspectives vs Views in the CA Gen Studio Editor... 9 Where to Look for Additional Information Chapter 2: How to Install CA Gen Studio 13 Hardware and Software Requirements Installation Considerations Install CA Gen Studio Chapter 3: CA Gen Studio Framework 15 CA Gen Studio Welcome View CA Gen Studio Framework How to Open a View and Rearrange Views in the CA Gen Studio Editor Rearrange Views Rearrange Tabbed Views Open a View Menu Bar File Menu Edit Menu Window Menu Help Menu Tool Bar How to Set Preferences in the CA Gen Studio Editor Model Preferences Sources Preferences Perspectives Preferences Online Help Context-Sensitive Help Dynamic Help Chapter 4: Working with Models 27 Open a Model in Gen Studio Open Multiple Models Contents 5

6 Remove a Model from Navigator View Close a Model Chapter 5: Designing an HTML Application Using Adobe Dreamweaver 31 Web Application Design Web Service Access Requirements to Design a Web Application Supported HTML Controls How to Design a Web Application Customize Web Pages and Behaviors Chapter 6: Mapping Actions in Web Service Access Designer 35 Site Project Web Service Access Plug-in in Adobe Dreamweaver Behavior Rename Considerations in Adobe Dreamweaver Associate a Behavior to a Control Define an Action Set Web Service Access Designer Web Service Access Navigator Editor Properties Problems Console Web Services Web Services Standards Web Service Description Language Import WSDL Files to Web Services Map an Action in Web Service Access Designer Map Collection Parameters Specify Multiple Operations for a Single Action Reorder Operations Delete Operations How to Deploy an Application Chapter 7: Creating Custom Proxies and Web Services 55 PStep Interface Designer Interfaces View Custom Proxies View Web Services View Editor Properties Gen Studio Overview Guide

7 How to Create Interfaces Create an Interface How to Create Custom Proxies Add a Proxy Definition Add a Proxy How to Create Custom Web Services Add a Web Service Definition Add Web Services Web Operations Generate Customized Interfaces Chapter 8: Create and Publish Web Services to CA API Gateway 81 Chapter 9: Messages in Gen Studio 83 Unable to Open the Model in CA Gen Studio Glossary 85 Index 87 Contents 7

8

9 Chapter 1: Introduction This section contains the following topics: Working with Gen Studio (see page 9) Audience (see page 9) Perspectives vs Views in the CA Gen Studio Editor (see page 9) Where to Look for Additional Information (see page 10) Working with Gen Studio CA Gen Studio is a plug-in framework for CA Gen development tools that provides the common functionality required by various tools. You can integrate CA Gen Studio with supported CA Gen tools and third-party Eclipse based plug-ins. CA Gen Studio is based on Eclipse. Eclipse is a software platform comprising extensible application frameworks, tools and a runtime library for software development and management. It is written primarily in Java to provide software developers and administrators an integrated development environment (IDE). You can extend its capabilities by installing plug-ins written for the Eclipse software framework, such as development toolkits for other programming languages, and can write your own plug-in modules. Note: CA Gen Studio runs only on the Microsoft Windows operating system. More information: CA Gen Studio Framework (see page 15) Audience This guide is intended for CA Gen designers who create CA Gen applications. This guide assumes that you have the basic knowledge about using the Toolset to create CA Gen applications. Perspectives vs Views in the CA Gen Studio Editor A perspective is a window layout and a set of views. CA Gen Studio includes default perspectives. You can customize default perspectives to create your own perspectives. Chapter 1: Introduction 9

10 Where to Look for Additional Information A designer and a perspective are loosely related; each designer has a navigator and a set of views, named Perspective. A perspective includes tools to perform specific tasks pertaining to the designer. A designer can open by itself, or you can stack it with other designers in a tabbed notebook in the CA Gen Studio main window. The CA Gen Studio framework includes the following perspectives: Web Service Access Designer Defines and maps Actions to business operations. These actions execute following an event trigger in the browser. You can use Adobe Dreamweaver to design your web pages. CA Gen Studio installs a plug-in, Web Service Access, in Adobe Dreamweaver. Web Service Access Plug-in Enables mapping user interface behaviors in Adobe Dreamweaver to CA Gen Actions. Note: For more information about the Web Service Access Plug-in in Adobe Dreamweaver, see Web Service Access Plug-in in Adobe Dreamweaver (see page 35) or the Web Service Access Plug-in Help. You can access this help file by clicking on the Help button in the Web Service Access dialog in Adobe Dreamweaver. This help file is also available in the Help folder where Adobe Dreamweaver is installed. PStep Interface Designer Creates customized interfaces, proxies, and web services to CA Gen Server Procedure Steps. Web View UI Generation Generates HTML pages from an existing model. Note: For more information about the Web View UI Generation perspective, see the Web View User Guide or Web View UI Generation Help. Where to Look for Additional Information You can access the CA Gen Studio Overview Help from the Help menu. You can also access context-sensitive help by pressing the F1 key while focus is on various areas of CA Gen Studio. For specific help information about CA Gen Studio perspectives, see the following documentation: Web Service Access Plug-in in Adobe Dreamweaver Web Service Access Plug-in Help The section Web Service Access Plug-in in Adobe Dreamweaver (see page 35) 10 Gen Studio Overview Guide

11 Where to Look for Additional Information Web Service Access Designer, PStep Interface Designer Gen Studio Overview Guide Web Service Access Designer Help, PStep Interface Designer Help Web View UI Generation Web View User Guide Web View UI Generation Help Chapter 1: Introduction 11

12

13 Chapter 2: How to Install CA Gen Studio This section contains the following topics: Hardware and Software Requirements (see page 13) Installation Considerations (see page 13) Install CA Gen Studio (see page 13) Hardware and Software Requirements The CA Gen Studio hardware and software requirements are documented in CA Gen Technical Requirements available at Installation Considerations Before installing CA Gen Studio, review the following considerations: CA Gen Studio is implemented on the Java-based Eclipse Workbench and is written in the Java programming language. Note: For more information about the Eclipse Foundation Framework, see CA Gen Studio is built on the Eclipse Workbench foundation and requires no additional Eclipse installation packages. The underlying Eclipse Workbench supports execution on non-windows platforms. However, CA Gen Studio runs only on the Microsoft Windows operating systems. To use Web Service Access Designer with Adobe Dreamweaver, install Adobe Dreamweaver before installing CA Gen Studio because CA Gen Studio installs the Web Service Access plug-in in Adobe Dreamweaver. Install CA Gen Studio You must install CA Gen Studio as instructed from the CA Gen download folder. The installation program installs all the files required to run the interface. Alternatively, you can download the installation program file from the CA Support Online website at Chapter 2: How to Install CA Gen Studio 13

14 Install CA Gen Studio If you intend to use Adobe Dreamwearver, install Adobe Dreamweaver before installing CA Gen Studio because CA Gen Studio installs required files into the Adobe Dreamweaver installation directory. Note: In CA Gen Release 8.5, if you installed Adobe Dreamweaver after installing CA Gen Studio, run the CA Gen installation again using the Repair option. The Repair option installs the Web Service Access plugin. Important! Before installing CA Gen Studio, ensure that your computer meets the system requirements (see page 13). More information: Web Service Access Plug-in in Adobe Dreamweaver (see page 35) 14 Gen Studio Overview Guide

15 Chapter 3: CA Gen Studio Framework This section contains the following topics: CA Gen Studio Welcome View (see page 15) CA Gen Studio Framework (see page 16) How to Open a View and Rearrange Views in the CA Gen Studio Editor (see page 17) Menu Bar (see page 19) Tool Bar (see page 22) How to Set Preferences in the CA Gen Studio Editor (see page 22) Online Help (see page 25) CA Gen Studio Welcome View The CA Gen Studio Welcome view contains the following items in the main window: Menu Bar Choose Perspectives Chapter 3: CA Gen Studio Framework 15

16 CA Gen Studio Framework Help Support CA Gen Studio Framework The CA Gen Studio framework contains the following items: Menu Bar Tool bar Work Area Use the CA Gen Studio framework to do the following tasks: Open or close CA Gen Studio perspectives Change the default window layout and save it as your own perspective Dock views in different positions in the framework Change the display options of the CA Gen Studio tools 16 Gen Studio Overview Guide

17 How to Open a View and Rearrange Views in the CA Gen Studio Editor More information: How to Set Preferences in the CA Gen Studio Editor (see page 22) Menu Bar (see page 19) Tool Bar (see page 22) Perspectives vs Views in the CA Gen Studio Editor (see page 9) How to Open a View and Rearrange Views in the CA Gen Studio Editor Views are information panes in the CA Gen Studio framework that define a perspective. A perspective can have many views. You can drag and drop the views to any location in the perspective. You can also save the modified layout as a new perspective. You can detach a view from the framework except the Editor view. Double-click on the tab of a view to maximize the view so it covers the full screen. The following views are available in CA Gen Studio: Navigator view Editor view Properties view Console view Problems view Welcome view Error Log view Plug-in Registry view Help view Rearrange Views You can rearrange the placement of views in the CA Gen Studio framework by dragging and dropping a view to dock (or place) it in a different location. Follow these steps: 1. Click the title bar of the view you want to rearrange and drag the view across the framework. 2. Release the mouse button to dock the view in any position in the framework. Chapter 3: CA Gen Studio Framework 17

18 How to Open a View and Rearrange Views in the CA Gen Studio Editor 3. Drag another view's title bar to dock the view in another position in the framework. The views are docked to the new positions in the framework. Note: You can save the rearranged window layout as a new perspective. Rearrange Tabbed Views You can rearrange the order of views in a tabbed view. The following procedure explains how to rearrange the Plug-in Registry view and the Error Log view. Follow these steps: 1. Drag the Error Log tab's title bar to the right of the Plug-in Registry tab until the cursor appears as a stack cursor, then release the mouse button. The Error Log tab now appears to the right of the Plug-in Registry tab. 2. Drag the Plug-in Registry tab's title bar to the right of the Error Log tab until the cursor appears as a stack cursor, then release the mouse button. The Plug-in Registry tab now appears to the right of the Error Log tab. 18 Gen Studio Overview Guide

19 Menu Bar Open a View You can open an undisplayed view in the CA Gen Studio framework. Follow these steps: 1. Click Window, Show View. CA Gen Studio shows a list of views as shown in the following illustration: 2. Click the view you want to open. CA Gen Studio displays the selected view. Menu Bar The menu bar is a collection of menus. It contains commands that execute immediately or display a window to enter additional information. Some menus contain sub-menus. Disabled menu items are not available in the current context. File Menu Menu items on the File menu open, save, and close models/site projects in CA Gen Studio. Open Model Opens a model. Open Model (ReadOnly) Opens a model in read-only view. You cannot make changes to the model when you use this command. Open Site Project Close Prompts you to browse and select the CA Gen Studio Site Project file. Closes the current editor tab in the Editor view. Chapter 3: CA Gen Studio Framework 19

20 Menu Bar Close All Sources Save Closes all the open models and site sources that are open. Saves sources associated with the current view or editor. Save All Sources Print Saves all the open model and site sources. Prints the information from the Editor view. Properties Exit Displays details about the currently selected model such as model name, subset name, code page ID, last saved date, and so on. Exits CA Gen Studio. More information: Working with Models (see page 27) Edit Menu Use the menu items in the Edit menu to manage your resources in the Editor view. Undo Redo Cut Copy Paste Reverses your most recent editing action. Re-applies the editing action that has most recently been reversed by the Undo action. Removes the selection and places it on the clipboard. Places a copy of the selection on the clipboard. Places the text or object on the clipboard at the current cursor location in the currently active view or editor. 20 Gen Studio Overview Guide

21 Menu Bar Delete Removes the current selection. Select All Selects all text or objects in the currently active view or editor. Refresh Reloads the current view reflecting the most recent changes. Window Menu Use the Window menu items to manage perspectives, show views, and to set preferences for CA Gen Studio. Show Perspective Opens a sub-menu listing the default perspectives. Show View Opens a sub-menu listing the currently known perspectives. Upon selecting a perspective, a new sub-menu opens listing the views such as Properties, Error Log, Plug-in Registry, and so on that are applicable to the current perspective. Close Perspective Closes the current perspective. Close All Perspectives Closes all the perspectives. Save Perspective As Displays a dialog to save the current perspective with a different name. Use this option to modify a default perspective to your requirements and save it as another perspective. Reset Perspective Removes changes to the current perspective. Preferences Opens a dialog with sub-panels that allow access to various preferences that configure the appearance of views and the behavior of CA Gen Studio tools. More information: How to Set Preferences in the CA Gen Studio Editor (see page 22) Perspectives vs Views in the CA Gen Studio Editor (see page 9) How to Open a View and Rearrange Views in the CA Gen Studio Editor (see page 17) Chapter 3: CA Gen Studio Framework 21

22 Tool Bar Help Menu Use the Help menu commands to access online help, plug-in details, and configuration details. More information: Online Help (see page 25) Context-Sensitive Help (see page 25) Dynamic Help (see page 26) Tool Bar Use the Tool Bar for quick access to commonly used commands in the CA Gen Studio user interface. Disabled options are not available in the current context. Save Print Saves the current open model. Prints the information from the Editor view. How to Set Preferences in the CA Gen Studio Editor You can set the following preferences in CA Gen Studio: Help Model (see page 24) Sources (see page 24) Perspectives (see page 24) 22 Gen Studio Overview Guide

23 How to Set Preferences in the CA Gen Studio Editor Follow these steps: 1. Select Window, Preferences from the menu bar. The Preferences window opens. 2. Click the option in the left pane for which you want to change the setting. 3. Change the default settings. 4. Click OK. CA Gen Studio saves the changes and closes the Preferences window. Note: You can restore the default configuration settings anytime in the Preferences window. To restore the default settings, click Restore Defaults and then click Apply. Chapter 3: CA Gen Studio Framework 23

24 How to Set Preferences in the CA Gen Studio Editor Model Preferences You can change the default model settings from the Preferences window in CA Gen Studio. Automatically save model(s) Specifies to automatically save models without requiring user intervention. Save interval (in minutes) Defines the frequency to automatically save models. Sort model lists by Specifies the sort order for model lists. Model name Sorts the model list by name. Model short name Sorts the model list by short name. Recently opened Displays recently opened models. Recently saved Displays recently saved models. Sources Preferences Size of recently opened source list Defines the number of recently opened sources that you want to see. Default: 4 Perspectives Preferences You can change the default perspective settings according to your requirements. Open a new perspective Specifies to open a new perspective in the same window or a new window. Available perspectives Lists all available perspectives in CA Gen Studio. Make Default Makes the selected perspective the default perspective. 24 Gen Studio Overview Guide

25 Online Help Restore Defaults Delete Changes all the perspective settings to the default values. Note: You can see the default settings the next time you open a perspective. Removes the selected perspective. Note: You cannot delete the default CA Gen Studio perspectives. Use the Delete option to delete a perspective that you created. Online Help CA Gen Studio includes online documentation, context-sensitive help, and dynamic help. You can request online help while using any of the CA Gen Studio perspectives by clicking the Help menu and selecting the following options as needed. Help Contents Search Opens the help system for CA Gen Studio. Using this system you have access to the table of contents, the help index, and the search and bookmark facilities. Opens a Help view with search options. Type text to search for and click Go to display topics in the online documentation that contain the search text. Dynamic Help Opens a Help view and displays links to the online documentation related to the current view. Online Support Opens the CA Technical Support Web page. About CA Gen Studio Opens the About CA Gen Studio dialog with software release number and the copyright information, and a link to view the license agreement. Context-Sensitive Help CA Gen Studio includes online help for most window controls. To view the help, place the focus on the dialog or control and press F1. If the control is in the CA Gen Studio framework, CA Gen Studio opens the Help view with links to the related control. Chapter 3: CA Gen Studio Framework 25

26 Online Help If the control is on a dialog that CA Gen Studio launched, it opens an external help window with links to topics related to the control. Note: CA Gen Studio views support context-sensitive help. Help may not be available for some self-explanatory pop-up menus and window controls such as menu items, buttons, or tool bar icons. Dynamic Help When the internal help view is active in CA Gen Studio, as you move the focus between views, the help data dynamically updates to reflect the view in focus. Note: CA Gen Studio only supports dynamic help for views in CA Gen Studio. There is no dynamic help for popup menus and window controls such as menu items, buttons, or tool bar icons. The internal Dynamic Help view contains the following pages that present help topics in different ways: Related Topics page Shows description and links to topics in the online documentation related to the current context. Click More Results to view more links. All Topics page Displays the Table of Contents for online documentation arranged in a tree hierarchy that you can expand or collapse as needed. Search page Searches and displays links in the online documentation related to the search performed with a summary of topic contents. Bookmarks page Displays online help topics that you mark as personal bookmarks. 26 Gen Studio Overview Guide

27 Chapter 4: Working with Models This section contains the following topics: Open a Model in Gen Studio (see page 27) Open Multiple Models (see page 28) Remove a Model from Navigator View (see page 28) Close a Model (see page 29) Open a Model in Gen Studio Open a model and display its contents in the Navigator view of CA Gen Studio. Follow these steps: 1. Click Start, All Programs, CA, Gen xx, Gen Studio. Note: xx refers to the current release of CA Gen. For the current release number, see the Release Notes. 2. Select a perspective to open the model. Note: You can open the perspective before or after you open the model. 3. Click File, Open Model. 4. Browse to the directory that stores the model and select the ief0000.dat file. 5. Click Open. The model and its contents are available for viewing in the Navigator view. Expand the model in the Navigator view to view its contents. Important! Open the model first in Toolset so that it supports 64K strings. You can then open the model in Gen Studio. Note: If a model is loaded in CA Gen Studio but is closed in the Navigator view, you can open it by right-clicking the model in the Navigator view and selecting Open Model from the pop-up menu. You can open multiple models simultaneously. Alternatively, double-click the model to open it. You can open a model in Toolset and CA Gen Studio simultaneously but the model is read-only in one of them. If you open a model in CA Gen Studio first and then open the same model in Toolset, the model is editable in CA Gen Studio and read-only in Toolset. To work on a model in Toolset, close the model in CA Gen Studio before opening it in Toolset. Chapter 4: Working with Models 27

28 Open Multiple Models More information: Open Multiple Models (see page 28) Open Multiple Models You can open multiple models in any of the perspectives in CA Gen Studio. Follow these steps: 1. Open the first model (see page 27) as explained in the previous section. 2. Click File, Open Model...again. 3. Browse to the location where the second model is stored and select the ief0000.dat file. 4. Click OK. 5. Repeat step 2 to step 4 until you open all the models you need in CA Gen Studio. All the models are opened in CA Gen Studio. Remove a Model from Navigator View When you close a model in the Navigator view, it remains displayed in CA Gen Studio. Follow these steps: 1. Right-click the model in the Navigator view. A pop-up menu opens. 2. Select Remove From List from the pop-up menu. A Confirm Model List Removal dialog opens for confirmation. 3. Click Yes. CA Gen Studio removes the model from the Navigator view. 28 Gen Studio Overview Guide

29 Close a Model Close a Model You can close a model in CA Gen Studio when needed. Follow these steps: 1. Right-click the model in the Navigator view. A pop-up menu opens. 2. Select Close Model from the pop-up menu. A dialog opens for confirmation. 3. Click Yes. The selected model closes. Chapter 4: Working with Models 29

30

31 Chapter 5: Designing an HTML Application Using Adobe Dreamweaver This section contains the following topics: Web Application Design (see page 31) Web Service Access Requirements to Design a Web Application (see page 31) How to Design a Web Application (see page 33) Customize Web Pages and Behaviors (see page 33) Web Application Design You can either use your existing models from Toolset in CA Gen Studio or design new web pages. You can also customize web pages to access the business logic that is provided by CA Gen. CA Gen Studio supports Adobe Dreamweaver as a third-party design tool. CA Gen Studio supplies a set of JavaScript libraries to provide added value to the design experience. These libraries provide a forward migration path for existing CA Gen Window designs. CA Gen Studio installs a plug-in, Web Service Access, in Adobe Dreamweaver. This plug-in enables mapping user interface behaviors in Adobe Dreamweaver to CA Gen Actions. Web Service Access Requirements to Design a Web Application When designing web pages, consider the following requirements: Use only HTML controls to map a user interface control to Web Service Access. Follow XHTML standards when designing web pages to synchronize Adobe Dreamweaver with the Web Service Access Designer. The Web Service Access Designer uses the ID value from an HTML page to uniquely identify an HTML control. The web page designer must ensure to uniquely identify all the HTML controls on a web page in Adobe Dreamweaver. Change the action property of a button from Submit form to None when you add a button on an HTML page in Adobe Dreamweaver. The Submit form action of a button in Adobe Dreamweaver sends the request and bypasses CA Gen runtime. Chapter 5: Designing an HTML Application Using Adobe Dreamweaver 31

32 Web Service Access Requirements to Design a Web Application When you add a table control on an HTML page in Adobe Dreamweaver, the <name> tag or the <id> tag are not associated with the table by default. Without either of these tags, the table is not defined in the Web Service Action Designer perspective and the table does not appear in the Web Service Action Designer Editor view. To add the <id> tag, create the table and select Properties. Enter a unique ID for the table in the Table entry field. You can deploy Web applications on the following Application Servers: WebSphere WebLogic JBoss Note: Along with WebSphere, WebLogic, and JBoss application servers, CA Gen Studio supports any Application Server that is J2EE compliant. For more information about the supported J2EE version, see the Technical Requirements document. Supported HTML Controls CA Gen Studio supports mapping of the following HTML controls on web pages. You can map any of these HTML controls to an Action in the Web Service Access Designer. Text Field Text Area Table For all the controls types that are not supported for mapping, you can map these controls by writing JavaScript in the HTML page to map the unsupported control information to a control that is supported within the designer. Often this second control can be hidden. In general, you need to use the value property of a control to map it. Some controls do not use the value property or its use does not fit the needs required by the mapping runtime. Currently, the controls that cannot be mapped directly are listed next: Check Box input fields of type check box Radio Buttons Selection/Menu select or option controls 32 Gen Studio Overview Guide

33 How to Design a Web Application How to Design a Web Application Follow these steps: 1. Create a web project. 2. Plan and design web pages. Use any feature in the Adobe Dreamweaver to design your web pages. 3. Associate Behaviors with browser events. 4. Map only HTML controls in the web pages to Web View. Note: For a list of supported HTML controls, see Supported HTML Controls (see page 32). 5. Save the web project. Notes: For detailed information about designing web pages using Adobe Dreamweaver, see the Adobe Dreamweaver documentation. For more information about associating Behaviors with browser events, see the CA Gen Studio Overview Guide or the CA Gen Studio Help. Customize Web Pages and Behaviors You can customize existing HTML pages using Adobe Dreamweaver and can integrate CA Gen web products in your web pages using Web Service Access. You can use Adobe Dreamweaver toolkits and libraries to enhance the look and feel of your web application. For more information, see the Adobe Dreamweaver documentation. Note: You must follow Web Service Access specific requirements while customizing HTML pages. For more information about these requirements, see Web Service Access Requirements (see page 31). Chapter 5: Designing an HTML Application Using Adobe Dreamweaver 33

34

35 Chapter 6: Mapping Actions in Web Service Access Designer This section contains the following topics: Site Project (see page 35) Web Service Access Plug-in in Adobe Dreamweaver (see page 35) Web Service Access Designer (see page 40) Web Services (see page 45) Map an Action in Web Service Access Designer (see page 47) Map Collection Parameters (see page 49) Specify Multiple Operations for a Single Action (see page 51) How to Deploy an Application (see page 51) Site Project A.project file is created when you add an action from Adobe Dreamweaver. If the HTML file is located in the WebViewUI directory of a model, then the.project file is saved in the root directory of the model. This project is used by CA Gen Studio for both the model and the site project as a model-based project. If the HTML file is located in any other location then the.project file is saved in the same location as the.html file. A.project file is also created when a model is opened and it is located in the model root directory. To open a site project, start CA Gen Studio and click File, Open Site Project. If the project is a model-based project, then opening it from either the Open Model or Open Site Project opens the same project. Web Service Access Plug-in in Adobe Dreamweaver Install Adobe Dreamweaver before installing CA Gen Studio. CA Gen Studio installs a plug-in, Web Service Access, in Adobe Dreamweaver. This plug-in enables mapping user interface behaviors in Adobe Dreamweaver to CA Gen Actions. Note: For the supported version of Adobe Dreamweaver, see the Technical Requirements document. Chapter 6: Mapping Actions in Web Service Access Designer 35

36 Web Service Access Plug-in in Adobe Dreamweaver When you install CA Gen Studio, the following files are added to Adobe Dreamweaver installation directories: Web Service Access.html webserviceaccess.js webserviceaccesshelp.js Launcher.dll Web Service Access Plug-in.chm These files integrate a plug-in in Adobe Dreamweaver and add a behavior, Web Service Access, in the Adobe Dreamweaver Behavior drop-down. You can designate behaviors for any event that occurs at runtime by selecting this behavior for an HTML control. The Web Service Access plug-in in Adobe Dreamweaver is synchronized with the Web Service Access Designer in CA Gen Studio using a Web Service. The Web Service Access Designer must be in sync with the Adobe Dreamweaver to immediately reflect the changes you make. You do not have to refresh the user interface to see the action changes that you make in Adobe Dreamweaver appear in the Web Service Access Designer. Important! Follow XHTML standards when designing web pages to synchronize Adobe Dreamweaver with the Web Service Access Designer. Note: For more information about the Web Service Access plug-in, see the Web Service Access Plug-in Help. You can access this help file either by clicking Help on the Web Service Access dialog in Adobe Dreamweaver or from the \\Adobe Dreamweaver <version>\help folder, where <version> is the release number of Adobe Dreamweaver installed in your system. Behavior Rename Considerations in Adobe Dreamweaver You can modify an existing Behavior in Adobe Dreamweaver. An Action corresponding to the Behavior may or may not exist in CA Gen Studio. Consider the following changes while renaming Behaviors in Adobe Dreamweaver: If the Behavior name is not changed in Adobe Dreamweaver If the Behavior name is changed in Adobe Dreamweaver New Action exists in CA Gen Studio New Action does not exist in CA Gen Studio 36 Gen Studio Overview Guide

37 Web Service Access Plug-in in Adobe Dreamweaver If the Behavior name is not changed in Adobe Dreamweaver If the Behavior name is changed in Adobe Dreamweaver If the old Action exists in CA Gen Studio No changes in CA Gen Studio New Action exists in CA Gen Studio No changes in CA Gen Studio New Action does not exist in CA Gen Studio Rename existing Action in CA Gen Studio If the old Action does not exist in CA Gen Studio Create new Action in CA Gen Studio No changes in CA Gen Studio Create new Action in CA Gen Studio Associate a Behavior to a Control Use any of the Adobe Dreamweaver features to design web pages but use only HTML controls to map a user interface control to an Action in CA Gen Studio. Adobe Dreamweaver Behaviors place JavaScript code in web pages so that you can customize a web page or initiate certain tasks. Follow these steps: 1. Select an HTML control on the web page. 2. Click Window, Behaviors. The Behaviors panel opens. Chapter 6: Mapping Actions in Web Service Access Designer 37

38 Web Service Access Plug-in in Adobe Dreamweaver 3. Click the plus symbol drop-down in the Behaviors panel. Web Service Access appears in the Behaviors drop-down. 38 Gen Studio Overview Guide

39 Web Service Access Plug-in in Adobe Dreamweaver 4. Click Web Service Access. An HTML file must exist before you can add an Action. If the Web Service Access plug-in does not find an HTML file, it prompts you to save one. The Web Service Access dialog appears prompting you to enter a Web Service Access action name. If CA Gen Studio is not already open, it opens. The Web Service Access dialog is disabled until CA Gen Studio opens. Note: The time taken to open CA Gen Studio may vary depending on various factors such as machine bandwidth, configuration, workspace, and so on. 5. Enter a name for the Web Service Action. You can enter only alphanumeric characters for a Web Service Action; special characters, except underscore, or spaces are not supported. CA Gen Studio opens the Web Service Access Designer perspective and the action name that you entered in the Web Service Access dialog is referenced as an Action in the Web Service Access Navigator view. This action is added under <site project>\action Sets\<HTML file name>.html. An editor is also opened for this action as shown next. A.project file is created when you add an action from Adobe Dreamweaver. This.project file is saved in the same location where the.html file is saved. This.project file is associated with the Web Service Access Designer perspective in CA Gen Studio and it is named Site Project. Note: For more information about applying behaviors to controls on a web page, see the Adobe Dreamweaver documentation. Chapter 6: Mapping Actions in Web Service Access Designer 39

40 Web Service Access Designer Define an Action Set Each Behavior that you create in Adobe Dreamweaver is defined as an Action. An Action Set can contain any number of Actions that are associated with a web page. Each HTML page is considered as a separate Action Set by the Web Service Access Designer. Each Action has a number of steps defined to complete its task. These steps are named Action Steps. Actions can trigger the execution of one or more Action Steps. Design and customize web pages using Adobe Dreamweaver before defining an Action Set. Follow these steps: 1. Associate behaviors to the HTML controls on a web page (see page 37). For each Behavior, the Web Service Access plug-in adds an Action in the Web Service Access Navigator view. An editor is opened for each Action. 2. Repeat Step 1 for each Action on the web page. The Action Set for the current web page is defined. Similarly, you can define Action Sets for other web pages. More information: Associate a Behavior to a Control (see page 37) Web Service Access Designer Web Service Access Designer is a perspective in CA Gen Studio. You can define and map Actions to business operations using this designer. These Actions execute when an event triggers in the browser. You can map any browser event to any Web Service Access action. The implementation of Web Service Access Designer on Mozilla Firefox can only invoke EJB,.NET, or third-party Web Services that are on the same domain. This can be done by either adding manually packaged WAR file, which contains your HTML and other script files, or individual HTML files in the additional files feature section of assembly dialog box. If additional WAR file is used, the application.xml file needs to be updated including additional WAR file information. Third-party web services on cross-domain cannot be invoked on Firefox unless the third-party Web Service supports appropriate response against OPTIONS request. CA Gen Server Procedure Steps are treated as Web Services. You can do the following tasks in this designer: Use any third-party Web Services Use Web Service Operations as Actions Steps within Actions triggered by web events 40 Gen Studio Overview Guide

41 Web Service Access Designer Map the Web Service Operation parameters to literals, fields, table, row, column, list, or none. The following views are available, by default, in the Web Service Access Designer perspective of CA Gen Studio: Web Service Access Navigator (see page 42) Editor (see page 43) Properties (see page 44) Problems (see page 44) Console (see page 45) Chapter 6: Mapping Actions in Web Service Access Designer 41

42 Web Service Access Designer Web Service Access Navigator The Web Service Access Navigator provides a tree hierarchy of Actions and Web Services. It displays the following objects in a tree structure: CA Gen Model/Site Project Action Sets folder HTML page Action Web Services folder Web Service Port Operation 42 Gen Studio Overview Guide

43 Web Service Access Designer Editor The Editor opens multipage editors for the Actions in the Web Service Access Navigator view. You can display more than one editor in the Editor view, and each Action opens in a separate editor. The Editor view also displays parameters and mapping information of the Web Service in the currently selected Editor. Changes made to selections in the Editor are not saved until you save it manually. An asterisk symbol (*) appears before the site project name in the Navigator view if it is not yet saved. You can undo or redo the changes you made in the Editor as long as it is open. Chapter 6: Mapping Actions in Web Service Access Designer 43

44 Web Service Access Designer Properties The Properties view provides information about the parameter selected in the Editor or the Web Service Access Navigator. Problems The Problems view displays warnings and synchronization messages between CA Gen Studio and Adobe Dreamweaver. 44 Gen Studio Overview Guide

45 Web Services Console The Console view displays system output. Web Services A Web Service is a software system designed to support interoperable machine-to-machine interaction over a network. Web pages can communicate with the CA Gen EJBs and third party EJBs using Web Services. This communication helps Web Service Access Designer provide a loose coupling between client and server components. Web Services Standards You can use third-party Web Services in Web Service Access Designer only if the Web Services conform to the following standards: SOAP 1.0 or 1.1 WS-I Basic Profile 1.1 Note: For more information about WS-I compliance, see WSDL 1.1 Web Service Description Language Web Services Description Language (WSDL) is a standard specification for describing XML-based Web Services. A WSDL file is a set of definitions that define services as collections of network endpoints. Chapter 6: Mapping Actions in Web Service Access Designer 45

46 Web Services Import WSDL Files to Web Services You can import WSDL files to Web Services in a site project. Follow these steps: 1. Right-click the Web Services node in the Web Service Access Navigator. The Import Web Service pop-up menu opens. 2. Click the Import Web Service pop-up menu. The Import Web Service dialog opens. 3. Click Browse to select a valid WSDL directory. All the WSDL files available in the WSDL directory are listed. Note: By default, all the WSDL files are selected. Use Select All or Deselect All to change your selection. 46 Gen Studio Overview Guide

47 Map an Action in Web Service Access Designer 4. Click Finish. The selected WSDL files are added under the Web Services node in the Web Service Access Navigator. Note: You can also drag-and-drop the WSDL files from the file location in your system onto the Web Services node in the Web Service Access Navigator to add the WSDL file to Web Services. Map an Action in Web Service Access Designer You can add any number of Action Sets to a single site project in the Web Service Access Designer. You need to map the Actions to access the business logic in the WSDL file. Follow these steps: 1. Right-click an Action in the Web Service Access Navigator and click Open. The Action displays in an editor in the Editor view. 2. Expand the Web Services node to the desired operation in the Web Service Access Navigator. Note: The Web Services should be already imported. For more information, see Import WSDL Files to Web Services (see page 46). 3. Right-click the Web Service operation and click Add to Action Steps. Note: You can also drag-and-drop Web Service operations. The operation is added to the Action Steps in the Editor view. 4. Click the operation in the Editor view. The parameters' information displays in the mapping tabs. You can navigate to input or output mapping using the Input Mapping and Output Mapping tabs. Be default, the Input Mapping tab is active. Parameter Indicates the name of the parameter. You cannot change the name of the parameter. Data Type Indicates the data type of the parameter. You cannot change the data type of the parameter. Chapter 6: Mapping Actions in Web Service Access Designer 47

48 Map an Action in Web Service Access Designer Mapping Style Specifies the mapping style of the parameter. Select any one of the following mapping styles: None Identifies that no mapping is required for this parameter. You can choose not to assign a mapping for a parameter. This results in the parameter not being used on the user interface. Field Identifies that a request to a Web Service or response from a Web Service is a text field. If the user enters an invalid value for a parameter that has a list of permitted values, then the default value of the parameter is automatically assigned. Literal Identifies that a request to a Web Service or response from a Web Service is a value. Not Set Indicates that no mapping is required for this parameter. Table Identifies that a request to a Web Service or response from a Web Service is a two-dimensional array. Use this mapping style to map fields to columns. You must specify a collection parameter as a Table and define the table through a separate dialog box before you map the child parameters to columns. Column When a collection parameter is defined as a Table, you must map the child parameters to columns. Map one parameter to one column. Columns are identified by indices (0-based). Row Selects a single row of data from a collection that can be mapped to individual fields in the HTML page. The fields in the HTML page must contain a unique id attribute to be mapped. Mapping Defines any data specific to the parameter. If you select Field as the Mapping Style, use this column to map a field to text, textarea, or td. If you select Row or Column as the Mapping Style, use this column to add any numeric data. Non-numeric values are not saved. If you select Table as the Mapping Style, a < > button shows in the Mapping field, which opens a dialog box prompting for inputs like Table Name, Max Rows, Max Columns, Starting Row, Fixed Size, and Unbound. Note: You may see a red X symbol in the Web Service Access Navigator, the action name, or the parameter name in the Editor view. This means that all the parameters showing the red X symbol need to be resolved. 5. Navigate to the Output Mapping tab to map the output fields after you finish mapping the HTML controls on a web page as inputs to the Web Services. You must map the input parameters as well as the output parameters. 48 Gen Studio Overview Guide

49 Map Collection Parameters 6. Save the site project. The mapping information will eventually allow the Web Service Access Designer to generate the required XML and XSL files for data access in the site directory. If you delete an HTML control or rename the ID/name of an HTML control in Adobe Dreamweaver that is mapped in the Web Service Access Designer perspective, an error is displayed in the Problems view. More information: How to Deploy an Application (see page 51) Map Collection Parameters If you want to populate a group view or display information on the user interface in an HTML table format, you need to map the output parameters using arrays. Note: When you add a table control on an HTML page in Adobe Dreamweaver, the <name> tag or the <id> tag are not associated with the table by default. Without either of these tags, the table does not appear in the Web Service Action Designer Editor view. To add the <id> tag, create the table and select Properties. Enter a unique ID for the table in the Table entry field. Chapter 6: Mapping Actions in Web Service Access Designer 49

50 Map Collection Parameters Follow these steps: 1. Select <Table> from the Mapping Style drop-down for the array parameter. 2. Click the browse button in the Mapping field. The Define Table dialog prompting to enter the number of rows and columns opens. 3. Enter the details in their respective fields. A table populates data only for the number of rows that are defined. Additional rows are omitted. Table Name Defines the name of the table created in Adobe Dreamweaver (in the.html file). Max Rows Defines the maximum number of rows in the table. Max Columns Defines the maximum number of columns in the table. Starting Row Defines the row number from where the table should be populated. If the first row in the table is a heading, the Starting Row should be 1. For tables without any heading, the Starting Row should be Gen Studio Overview Guide

51 Specify Multiple Operations for a Single Action Fixed Size Specifies if the table should have a fixed size. Unbound 4. Click OK. Specifies the limit for the number of rows in the table. If you select this option, there is no maximum limit for the number of rows in the table. The table parameters are mapped. Specify Multiple Operations for a Single Action You can specify one or more operations for a single Action. Drag-and-drop the operation from the Web Service Access Navigator into the Editor view. The operations will be processed in the order that they appear in the Action Steps list. Reorder Operations You can reorder the operations after they have been added to the Action Steps list. Use the arrow keys on your keyboard along with the Alt key to reorder the operations. Delete Operations If you want to remove an operation from the Action Steps list, select the operation and right-click to select Delete from the pop-up menu. Note: You can also select Edit, Delete from the main menu or press the Delete key to remove an operation from the Action Steps list in the Editor view. How to Deploy an Application You need to generate the required files into the site project directory to deploy an application. When you generate an Action Set, a separate directory is created for each Action Set as shown next: <site directory>/action Sets/<action set name>.html Chapter 6: Mapping Actions in Web Service Access Designer 51

52 How to Deploy an Application This Action Set directory includes the following: a sub-directory for each Action within the Action Set an XML file corresponding to each Action within the Action Set (for example, <action name>.xml) The Action directory includes the following files that are generated for each operation contained in the Action: Op_<index>_<operation name>.soap.xml Op_<index>_<operation name>.send.xsl Op_<index>_<operation name>.result.xsl After generating the Action Sets, you can include the generated files in the Web View application WAR file using Build Tool. Note: For more information about including generated files in the WAR file, see the Build Tool User Guide or the Build Tool Help. Follow these steps: 1. Open the site project in Web Service Access Designer. 2. Right-click the HTML file in the Web Service Access Navigator and select Generate Action Set. All the required XML and XSL files are generated into the site project directory. 3. Open the HTML file in a browser window. 4. Execute the actions defined in Adobe Dreamweaver. The generated XSL files are executed and the result is displayed in the browser. Follow these steps: 1. Assemble the generated application in the Build Tool. Note: For information about assembling an application using Build Tool, see the Build Tool User Guide. 2. Update PATH to include <JDKDIR>\bin. PATH=<JDKDIR>\bin;%PATH% <JDKDIR> Defines the root folder of a J2SE JDK installation. 3. Use the jar command to package everything in the Adobe DreamWeaver site project folder where a.project file exists. cd <DreamWeaverSiteProjectFolder> jar cvf..\<dreamweaversiteproject>.war 52 Gen Studio Overview Guide

53 How to Deploy an Application <DreamWeaverSiteProjectFolder> Defines the folder name where the site project is available. <DreamWeaverSiteProject> Defines the name of the.war file to be created. 4. Extract the.ear file from Build Tool to an empty folder with the jar command. cd <NewJarFileFolder> jar xvf <PathToCAGenModel>\Java\deploy.j2ee\<CAGenModel>.ear <NewJarFileFolder> Defines the path where the new jar file is to be created. <PathToCAGenModel> Define the path where the CA Gen model is available. <CAGenModel> Defines the name of the CA Gen model. 5. Copy the.war file created in Step 3 into the folder where the.ear file was extracted. copy <PATHtoTheWarFile>\ <DreamWeaverSiteProject>.war <PATHtoTheWarFile> Defines the path where the new.war file is to be created. 6. Edit META-INF\application.xml to include the following XML elements. <module> <web> <web-uri> <DreamWeaverSiteProject>.war</web-uri> <context-root> <DreamWeaverSiteProject> </context-root> </web> </module> If the <module> tag already exists in the application.xml file, merge this code fragment. 7. Recreate the jar file with the updated contents in the folder. jar cvf..\<newgenmodel>.ear <NewGenModel> Defines the name of the new CA Gen model. The application is deployed to the Application Server. Chapter 6: Mapping Actions in Web Service Access Designer 53

54

55 Chapter 7: Creating Custom Proxies and Web Services This section contains the following topics: PStep Interface Designer (see page 55) How to Create Interfaces (see page 61) How to Create Custom Proxies (see page 68) How to Create Custom Web Services (see page 73) PStep Interface Designer The PStep Interface Designer is another perspective in CA Gen Studio. Use the PStep Interface Designer to do the following tasks: Create interfaces to CA Gen Server Procedure Steps Define custom proxies from the interfaces Define custom web services from the interfaces Define multiple interfaces for each entry point Generate WSDL and XSL files related to custom web services This perspective includes the following views: Interfaces Custom Proxies Web Services Editor Properties Chapter 7: Creating Custom Proxies and Web Services 55

56 PStep Interface Designer Interfaces View You must create an interface in the Interfaces view before you can declare it as a proxy in the Custom Proxies view or as a Web service in the Web Services view. The Interfaces view displays the following objects in a tree structure. CA Gen Model Business System Procedure Steps Interfaces 56 Gen Studio Overview Guide

57 PStep Interface Designer Custom Proxies View You can manage custom proxies of a model using the Custom Proxies view. You can create, rename, or delete custom proxies in the Custom Proxies view. The Custom Proxies view displays the following objects in a tree structure. CA Gen Model Proxy Definition folder Proxy The Proxy Definitions folder is a placeholder and can contain zero or more Proxy Definitions. A Proxy Definition can contain zero or more Proxies. Chapter 7: Creating Custom Proxies and Web Services 57

58 PStep Interface Designer Web Services View You can manage a model s web services using the Web Services view. You can create, rename, or delete Web Service Definitions, Web Services, and Web Operations in the Web Services view. The Web Services view displays the following objects in a tree structure. CA Gen Model Web Service Definitions folder Web Service Definition Web Service Port Web Operation 58 Gen Studio Overview Guide

59 PStep Interface Designer A Web Service Definitions folder is a placeholder for Web Services related artifacts. It may contain zero or more Web Service Definitions. A Web Service Definition can contain zero or more Web Services, and a Web Service may contain zero or more Web Operations. Chapter 7: Creating Custom Proxies and Web Services 59

60 PStep Interface Designer Editor Use the Editor view to access and customize interfaces. Using a tabular format the editor provides you with editing capabilities so that certain characteristics of an interface, proxy, or web operation can be modified. 60 Gen Studio Overview Guide

61 How to Create Interfaces Properties The Properties view displays detailed information about the current selection in any of the other views. You may also use the Properties view to update certain properties. How to Create Interfaces Interfaces are the starting point for creating custom proxies and web services. The Custom Proxies and Web Services views are used to manage the same set of interfaces from two different points of view. An interface can be a proxy, a Web Service or both. Therefore, the user must define interfaces out of the import and export views of existing procedure steps. Interfaces are based on Procedure Steps in the model. To qualify as an interface, the Procedure Step must be packaged cooperatively and it must not have any screens associated with it. Note: For more information about import and export views, see the Distributed Processing-Overview Guide. Follow these steps: 1. Create an interface 2. Customize the interface Chapter 7: Creating Custom Proxies and Web Services 61

62 How to Create Interfaces Create an Interface Create an interface from a procedure step of a business system. Later, you can edit the interface to customize its details. Follow these steps: 1. Open a model in Gen Studio (see page 27) in the PStep Interface Designer perspective. 2. Expand the model to show all the Business Systems. 3. Expand the Business System for which you want to create an Interface. The Procedure Steps of the Business System are displayed. 4. Right-click the Procedure Step and click Create Interface. 62 Gen Studio Overview Guide

63 How to Create Interfaces 5. Accept the suggested name or type a new name for the Interface. Note: The Interface name can include alphanumeric characters and special characters. It does not accept spaces and converts a space to an underscore character. You cannot create duplicate Interfaces. You cannot name an interface after the procedure step it is originating from, or after any other procedure step in the model. 6. Specify the initial mapping style of the parameters. The mapping style determines which attributes are included as part of the interface and which attributes to exclude. System attributes are not included. After the interface is created, you can change individual attribute mapping styles within the editor. Default: <None> <None> Specifies that no attributes of the interface are exposed to the end user. <Variable> Specifies that all the attributes of the interface are exposed to the end user and allows the end user to enter data into this parameter. You can rename this parameter to add a user-friendly name. Note: If you want to expose only a few attributes of the interface, specify the Mapping Style as <Variable>. You can modify the attribute details later while customizing the interface. 7. Select the Views to Set. This option is available only when you specify the Mapping Style as <Variable>. Both Import Export 8. Click Finish. Indicates that attributes in both import and export views are mapped according to the mapping style set in the previous step. Indicates that only attributes in the import view are mapped according to the mapping style set in the previous step. Indicates that only attributes in the export view are mapped according to the mapping style set in the previous step. The interface is added under the procedure step in the Interfaces view. Chapter 7: Creating Custom Proxies and Web Services 63

64 How to Create Interfaces Manage Interfaces Do the following tasks to manage interfaces: To rename an interface, right-click the interface and click Rename. Change the interface name in the Rename Interface dialog and click Finish. You cannot name an interface after the procedure step it is originating from, nor can you name an interface after any other procedure step in the model. To delete one or more interfaces, select the interfaces you must delete, right-click them, and click Delete. A confirmation for deleting is displayed. Deleting an interface will delete its references to custom proxies and web services. To sort interfaces alphabetically in ascending order, click on the Interfaces view. To hide empty procedure steps in the tree structure that do not contain interfaces, click. This icon is a toggle button. Customize an Interface You can customize an interface in the Editor view. Use the Editor view to manage the mapping functions for all the parameters that are associated with the current interface. You can customize the import view in the Input Mapping tab and the export view in the Output Mapping tab in the Editor view. 64 Gen Studio Overview Guide

65 How to Create Interfaces To demonstrate the use of custom interfaces, the following illustration shows the Action Diagram of the Employee Detail Procedure Step from the sample model with both the Import Views and Export Views expanded: You can customize one or more interfaces using the import and export views as defined in the preceding procedure step. Follow these steps: 1. Open a model in Gen Studio (see page 27) in the PStep Interface Designer perspective. 2. Expand the model in the Interfaces tab to show the Business System, Procedure Steps, and Interfaces. Chapter 7: Creating Custom Proxies and Web Services 65

66 How to Create Interfaces 3. Double-click the interface in the Interfaces view. The Editor view opens and displays the parameters of the import and export views as defined by its associated procedure step. If you double-click more than one interface, each interface displays on a different tab in the Editor view. 4. Change the values, as needed, for those parameters that are associated with the newly created custom interface using the Input Mapping tab and the Output Mapping tab: Parameter Defines the name of the parameter. You can change the name of this parameter to add a user-friendly name including view names. Gen Name Identifies the original name of the parameter. This column is read-only. Gen Attribute Identifies the data type of the parameter. This column is read-only. XSD Data Type Specifies the data type of the parameter that conforms to the XML schema definition. Map the Gen Data Type to the XSD Data Type. 66 Gen Studio Overview Guide

67 How to Create Interfaces Mapping Style Specifies the mapping style of the parameter. Default: <None> <None>: The parameter is not exposed to the end user as it is eliminated from the interface. Set the Mapping Style to <None> to omit the parameter. <Literal>: The parameter is not exposed to the end user but the value you add in the Mapping field is hard-coded to this parameter. <Variable>: The parameter is exposed to the end user and allows the end user to enter data into this parameter. You can change the name of this parameter to add a user-friendly name. To change the mapping style of all the parameters in an entity or group view simultaneously, you can select the mapping style cell for the entity or group view. Example: To change the Mapping Style of the ImportEmployee parameter, select the Mapping Style from the drop-down and press the Enter key. Chapter 7: Creating Custom Proxies and Web Services 67

68 How to Create Custom Proxies The Mapping Style for the parameter is changed. Mapping Defines any data specific to the parameter of the interface. You can edit this field only if you select the Mapping Style value as <Literal>. 5. Save the model to keep all your changes. How to Create Custom Proxies A CA Gen Proxy is an interface that enables a user-written client application to communicate with a generated CA Gen server. Proxies allow applications that are not generated using CA Gen, to use the procedure step logic provided as part of a Distributed Processing Server (DPS). In general, proxies provide application developers additional flexibility in creating multi-tier applications. Proxies also allow applications that are not generated using CA Gen, to access the interfaces and methods defined as components within a CBD-compliant model. Note: For more information about proxies, see the Distributed Processing Overview Guide. 68 Gen Studio Overview Guide

69 How to Create Custom Proxies You can declare any number of interfaces for a procedure step. You can create custom proxies out of the interfaces that you created for a procedure step. Follow these steps: 1. Add a proxy definition 2. Add a proxy 3. Customize the proxy Add a Proxy Definition A proxy definition is a collection of proxies. To exist, a proxy definition must be associated with a business system. Follow these steps: 1. Open a model (see page 27) in the Custom Proxies view. 2. Expand the Proxy Definitions folder in the Custom Proxies view to display all the proxy definitions. 3. Right-click the Proxy Definitions folder and click Add Proxy Definition. Chapter 7: Creating Custom Proxies and Web Services 69

70 How to Create Custom Proxies The Add Proxy Definition dialog opens. 4. (Optional) Type a name for the proxy definition in the Proxy Definition Name field. Note: The proxy definition name may include alphanumeric characters and special characters. A space is converted to an underscore character. You cannot create duplicate proxy definitions. 5. Select the business system to which you need to add the proxy definition from the drop down menu and click Finish. The proxy definition is added to the model tree in the Custom Proxies view. Note: Although proxy definition names are not limited to a certain length, their names must be unique within the first 32 characters. This is due to legacy rules governing names of certain metamodel objects. Note that in the Proxy Code Generation dialog in CA Gen Toolset only the first 32 characters of the web service definition are displayed. 70 Gen Studio Overview Guide

71 How to Create Custom Proxies Manage Proxy Definitions Do the following tasks to manage proxy definitions: To rename a proxy definition, right-click it and click Rename. The Rename Proxy Definition dialog opens. Type the name of the proxy definition and click Finish. To delete a proxy definition, select the proxy definition, right-click it and click delete. A confirmation message is displayed. Deleting a proxy definition will delete all its proxies, but the interfaces referenced by proxies will remain intact. Add a Proxy To add a proxy, you must identify an interface and add it to an existing proxy definition. A proxy must be added to a proxy definition. You can either create a proxy definition and then add a proxy to the proxy definition or add a proxy to an existing proxy definition. Follow these steps: 1. Right-click the proxy definition to which you want to add a proxy and click Add Proxy. Chapter 7: Creating Custom Proxies and Web Services 71

72 How to Create Custom Proxies The Add Proxy dialog opens displaying all the interfaces of the model. 2. If there are many interfaces, type the initial letters of an interface to filter the interface that you want to add as a proxy. Else, move to the next step. Note: The Interfaces field is case sensitive. Interfaces that were already added as proxies to the proxy definition are not listed in the dialog. That is, you cannot add the same interface more than once to a proxy definition. 3. Select the interface and click Finish. The proxy is added under the proxy definition in the Custom Proxies view. By default, new proxies will be named using the names of their interfaces. 72 Gen Studio Overview Guide

73 How to Create Custom Web Services Manage Proxies Do the following tasks to manage proxies: To rename a proxy, right-click the proxy and click Rename. Change the proxy name in the Rename Proxy dialog and click Finish. You cannot name a proxy after the procedure step that originated its interface, nor can you name a proxy after any procedure step in the model. To remove proxies, select the required proxies, right-click the proxies in the Custom Proxies view and click Remove. A confirmation message is displayed. Removing a proxy will remove its reference to the interface but not the interface itself. To delete proxies, select the required proxies, right-click the proxies and click Delete. Deleting a proxy will delete its referenced interface as well as any other proxy under the same name even if it resides in another proxy definition. In addition, deleting a proxy will also delete any web operation that references the same interface. Edit a Custom Proxy Custom Proxy Generation Editing a custom proxy is same as customizing an interface. To generate custom proxies, use Proxy Code Generation dialog in CA Gen Toolset. For more information about generating custom proxies, see Toolset Help. How to Create Custom Web Services Follow these steps: 1. Add a Web Service Definition (see page 73). 2. Add Web Services (see page 75). 3. Add Web Operations (see page 76). 4. Customize Web Operations (see page 77). 5. Generate Custom Web Services (see page 78). Add a Web Service Definition A web service definition is a collection of Web Services. An existing Web Service definition must be associated to a business system. Chapter 7: Creating Custom Proxies and Web Services 73

74 How to Create Custom Web Services Each Web Service Definition has a special property named Web Service URL. After a Web Service Definition is created, the value of this property will be prepopulated with a URL as follows: <WSD-name> Specifies the name of the Web Service Definition that is created. To reflect your environment, change the host and port values. The host and port values reflect the application server host where the application and its custom web services are being deployed to. Note: In addition, override the host and port values in the Web Services pane of the EAR File Assemble Details dialog in the Build Tool. The override values affect ALL web service definition modules being assembled. However, the default <WSD-name> value is changed. If you change this value, verify that no two Web Service Definitions have the same value. Follow these steps: 1. Open a model in Gen Studio (see page 27) in the Web Services view. 2. Expand the Web Service Definitions folder to display all web service definitions. 3. Right-click the Web Service Definitions folder and click Add Web Service Definition. 4. Type a name for the new Web Service Definition or click Finish to accept the default name. Notes: The Web Service Definition name includes alphanumeric characters and special characters. The name does not accept spaces and converts a space to an underscore character. You cannot create duplicate Web Service Definitions. 5. Select the business system to which you want to add the web service definition from the drop-down list and click Finish. The Web Service Definition is added under the Web Services view. 74 Gen Studio Overview Guide

75 How to Create Custom Web Services Manage Web Service Definitions Do the following tasks to manage web service definitions: To rename a web service definition, right-click it and click Rename. The Rename dialog is displayed. Type the name of the web service definition and click Finish. To delete a web service definition, select the web service definition, right-click it and click delete. A confirmation message is displayed. Deleting a web service definition will delete all its web services and web operations. But the interfaces that gave origin to those web operations will remain intact. Although web service definition names are not limited to a certain length, their names must be unique within the first 32 characters. This is due to legacy rules governing names of certain metamodel objects. Note that in the Proxy Code Generation dialog box in the CA Gen Toolset only the first 32 characters of the web service definition will be displayed. Add Web Services Manage Web Services For each web service you add to a Web Service Definition, two nodes appear under the Web Service Definition node the Web Service itself and the Port underneath it. By default, a port name is a concatenated string of the Web Service name and a suffix, SoapPort. This implementation of web services is based on SOAP. A Web Service Definition contains zero or more Web Services. Note: CA Gen Studio supports only SOAP Web Services. SOAP is the transport protocol. Follow these steps: 1. Right-click the Web Service Definition in the Web Services view and click Add Web Service. 2. Type a name for the new Web Service or click Finish to accept the default name. Note: You cannot duplicate Web Services within the same Web Service Definition. 3. Click Finish. The Web Service and its port are added to the Web Service Definition in the Web Services view. Do the following tasks to manage web services: To rename a web service, right-click the web service and click Rename. Change the web service name in the Rename Web Service dialog and click Finish. To delete web services, select the required web services, right-click the web services and click Delete. Deleting a web service will delete its associated web operations, but not the interfaces that those operations reference. Chapter 7: Creating Custom Proxies and Web Services 75

76 How to Create Custom Web Services Web Operations Add Web Operation Web Operations are based on Procedure Steps in the model. To qualify as a Web Operation, the Procedure Step is packaged cooperatively and no screens that are associated with it. Note: If you are sending any Web Service for third-party to use, CA Gen naming conventions are not applicable to your customers. You can rename the Web Operations accordingly. You can move or copy only Web Operations in the Web Services view. To move a Web Operation across different Ports, drag the Web Operation from the source Port and drop it in the destination Port. To copy a Web Operation, press the Ctrl key and then drag-and-drop the Web Operation. Note: You can move multiple Web Operations simultaneously. Web Operations are based on Procedure Steps in the model. Note: If you are sending any Web Service for a third-party to use, CA Gen naming conventions are not applicable to your customers. You can rename the Web Operations accordingly. You can move or copy only Web Operations in the Web Services view. To move a Web Operation across different Ports, drag the Web Operation from the source Port and drop it in the destination Port. To copy a Web Operation, press and hold the Ctrl key and then drag-and-drop the Web Operation. Note: You can move multiple Web Operations simultaneously. 76 Gen Studio Overview Guide

77 How to Create Custom Web Services Customize Web Operations A web operation must be added to a web service. To add a web operation, identify an interface and add it to an existing web service. You can either create a web service and then add a web operation to the web service or add a web operation to an existing web service. Follow these steps: 1. Right-click the port node of a Web Service in the Web Services view and click Add Web Operation. 2. If there are many interfaces, type the initial letters of an interface to filter the interface that you want to add as a web operation. Else, skip to the next step. Notes: The Interfaces field is case-sensitive. Interfaces that were already added as web operations to the web service are not listed. That is, you cannot add the same interface more than once for a web service. 3. Select the interface and click Finish. The web operation is added under the web service in the Web Services view. By default, new web operations are named using the names of their interfaces. A Web Operation has a set of input parameters and a set of output parameters. You can change the default values of these parameters in the Input Mapping tab and the Output Mapping tab in the Editor view. The input parameters match the import views of the associated interface and the output parameters match the export views of the associated interface. In addition, both the Input Mapping tab and the Output Mapping tab contain a set of system defined parameters. These parameters are also available to the operation. System defined parameters are available to all the models. Mapping the exitstate output system parameter to <Variable> causes two other pieces of information to appear in the response SOAP message. These additional pieces of information are exitstatemsg and exitstatetype and these parameters appear as attributes of the Export element in the SOAP message. Although exitstatemsg and exitstatetype are not currently part of the default set of output system attributes available in the designer, they are available in the SOAP response message. Future releases of the PStep Interface Designer may make these parameters available in the Editor view. Mapping the exitstate output system parameter to <None> removes all the three pieces from the SOAP response message. Currently, PStep Interface Designer supports only the mapping of exitstate numbers. Chapter 7: Creating Custom Proxies and Web Services 77

78 How to Create Custom Web Services Customizing a Web Operation is same as customizing an interface. Generate Customized Interfaces For each Web Service Definition, you generate a WSDL document that describes in detail Web Services and their custom operations. In addition, a set of XSL files is also created. These files contain transformation rules to be used at runtime. These rules dictate the customization that EJB bound SOAP messages must follow when sent between the application server and clients. After you create and customize your Web Service Definitions, you can generate customized interfaces. To generate the WSDL file and the corresponding XSL files for a Web Service Definition, right-click the Web Service Definition in the Web Services view and click Generate Custom Interface. Alternatively, you can click Generate and Install Custom Interface. This option invokes the Build Tool immediately after generation is complete. The Build Tool proceeds to build the newly created module. After generation, the WSDL documents are stored in the following folder: \\<model directory>\java\web Services\wsdls The XSL files are stored in the following folder: \\<model directory>\java\web Services\transformations In addition, CA Gen Studio generates an ICM file to be used by the Build Tool. This file is similar to the ICM files generated by the Toolset. It contains necessary information that the Build Tool uses to build and package resources that are needed by the web application at runtime. After this file is generated, it will be located in the folder \\<model directory>\java. This file is named as <WSD-name>.WSD.icm, where <WSD-name> is the given name of the web service definition for which the generation is being done. In either case, the new module must be built and assembled with the rest of the application using the Build Tool. In the Build Tool, you select at least one module of type SRVR with the WSD module (which in the Build Tool shows as being of type SRVR_ROUTER). You cannot create an EAR file out of a WSD war file alone. The SRVR module is generated when you select EJB Web Services as TP monitor in the Generation Defaults dialog. At the end of the assembly your EAR file contains the following information: One or more EJB jar files The CA Gen runtime jar file One or more web service definition war files (modules of type SRVR ROUTER) 78 Gen Studio Overview Guide

79 How to Create Custom Web Services The application.xml file The Manifest.mf file Make sure that you include the correct WSD files with the appropriate EJB jar files. The following illustration from the Build Tool shows the build status after the application is assembled using the SAMPLE model that is provided with CA Gen. Two Web Service Definition modules, defining custom web services, have been assembled into an EAR file with a server module. The CASCADE module is included too because the application accesses a database. Note: When publishing or exposing your customized Web Services that it is necessary to use the generated WSDL residing in the Web Service Definition module (war file) within the assembled ear file instead of the generated WSDL found in the \\<model directory>\java\web Services\wsdls directory. This is due to WSDL post processing activity during assembly time. Selection of the target application server determines the difference between the two WSDL documents. Use third-party tools to extract the WSDL. Note: For more information about the different tasks that are required to assemble CA Gen applications, see the Build Tool User Guide. Chapter 7: Creating Custom Proxies and Web Services 79