The following topics are covered in this chapter:
The Process Design Assistant is a tool that assists you in creating contracts between applications, then forming them into process flows. This chapter provides instructions for the Business Interface Window of the Process Design Assistant. The Business Interface Window assists you in specifying contracts.
The Process Design Assistant is an eLink client/server application. Contracts are specified in the Business Interface Window, then formed into process flows in the Business Process Window. You can also import existing FML definitions (to be used as the basis for contracts) and load interfaces from text files. See Appendix A, "Interface File (*.IFCE) Reference," for more information.
The Process Design Assistant supports the description of any eLink service that uses FML32 buffer types.
Figure 3-1 shows the workflow using the Contract Repository database. The Process Design Assistant (Business Interface Window) and other key components are described in the next section.
The Process Design Assistant consists of the following components:
Overview
How It Works
Figure 3-1 Workflow for Specifying Contracts
Key Components
To learn more about the objects in the Contract Repository tree, refer to the section of this chapter on the Contract Repository Tree View.
For more information about working with objects in the repository, refer to the section of this chapter on Usage.
The Business Interface Window shows a tree view of the contracts and their components. When you select an item in the tree, its properties are displayed in the right-hand panel.
Before you can view the tree in the Process Design Assistant, you need to log on. To do this, select File—>Logon from the menu bar or click on the Logon toolbar button.
The Process Design Assistant Business Interface Window consists of the menu bar, toolbar and an attribute display. After logon, the root nodes for each Contract Repository object are shown. Figure 3-2 shows the root nodes for each type of object in the Contract Repository tree that display in the left portion of the window.
As shown in Figure 3-2, there are multiple roots in the tree, one root for each kind of object.
Business Interface Window
Accessing Contract Repository Objects
Figure 3-2 Main Tree Structure
Contract Repository Tree View
From the tree view, you can create elements, structs, operations, and interfaces.
As an example, Figure 3-3 shows the BANKAPP module expanded. Table 3-1 describes each type of object available in the tree in full detail.
During development time, the Contract Repository database may be frequently updated as objects are added, imported, deleted, or modified (by you or other eLink Process Design Assistant users). You must refresh the Process Design Assistant in order to see any changes made after you log on (that is, during a session).
To refresh the Contract Repository, choose File—>Refresh from the menu bar. This updates your view of the Contract Repository database. Note that if the object tree was expanded before you refreshed, it will re-display showing only the initial root nodes. When you re-expand the tree, you will see the updated version.
The Process Design Assistant Business Interface Window displays a series of icons, or toolbar buttons, under the menu bar used to quickly access frequently used options. Table 3-2 describes the toolbar buttons.
The following table shows the keyboard and menu shortcuts available on the Process Design Assistant.
Pop-up Menus for Tree Objects. In addition to the menus and toolbar buttons, you can get a pop-up menu of actions for a selected tree object. To do this, select an item in the tree on the Business Interface Window and click the right mouse button to display the actions. Highlight an action on the menu and click the right mouse button again to select it.
The Process Design Assistant is a tool that assists eLink users in specifying business processes.
This section explains how to work with the Repository Database using the Process Design Assistant.
The following topics are covered:
Figure 3-3 Module Tree Hierarchy
Refreshing the Contract Repository Tree View
Toolbar Buttons
Keyboard & Menu Shortcuts
Usage
Before starting the Process Design Assistant, make sure that you have installed all necessary software. For details on system requirements, supported platforms, and Process Design Assistant software installation, refer to the BEA eLink Business Process Option Operations & Maintenance Guide included with your CD-ROM.
To start the Process Design Assistant:
Logging on and Getting Started
Starting the Process Design Assistant
The BEA eLink Business Process Option opening window (shown in Figure 3-4) appears.
Figure 3-4 Process Design Assistant at Start Up
Before logging on for the first time, you must set certain logon defaults as this information is not provided by the logon dialog. If you don't set these options, you will be unable to log on to the Process Design Assistant.
Warning: If the JSL and WSL Port numbers are reversed in error, the server may lock up so check with your System Administrator to make sure that you have the correct port numbers to enter in the Logon Settings Window.
You must set your logon default settings before logging on to the Process Design Assistant.
Note: Setting the logon option defaults need only be done when a new eLink Business Process Option user logs on to the Process Design Assistant for the first time, or should the host access information change.
The first three fields in the Logon settings window must be set up to provide host information for logons. Optionally, the user name may be set as well.
Figure 3-5 Logon Settings Window
To set the logon default:
After starting the Process Design Assistant and setting the logon defaults (required), follow the directions to log on:
Or
Click on the Logon toolbar button.
Figure 3-6 Logon Window
Note:
The access information for the host displayed in the Logon window must be set up as defaults in the Settings window. See Setting the Logon Default Instructions.
The FML file import is a process that imports existing FML files into the Contract Repository. These FML files are maintained by your system administrator.
Note: FML files describing the FML fields that you will be using in eLink (as elements) must be imported before those fields can be used in operations. However, you should import an FML file describing particular FML field definitions only once to avoid overwriting subsequent changes to the operational parameters (elements).
You can import additional new files into the Contract Repository on an ongoing basis as the need for new interfaces arises. If you are unsure as to whether or not a particular FML field definition has been imported, check the properties of the corresponding element by highlighting it in the repository tree. Its properties will appear on the right side of the Business Interface Window. If an element has a non-zero FML field number, its field definition has been imported.
Note: For information on the creation of the FML files, refer to the BEA TUXEDO Programmer's Guide.
When you import FML fields, they are imported as elements. During the import, duplicate entries are updated in the Contract Repository using the new information provided in the import file. The Occurrence default is "1."
To import FML files, use the Import FML file window (shown in Figure 3-8.) The window has two display areas: Importable Files and Files for Import. The Importable Files display area contains existing FML files that currently reside on your server.
You can select one or more of the files by using the arrow keys to move the files between the display areas. If you move a file to the Files for Import display area, and then decide you do not want to import it, use the arrow keys to move it back to the Importable Files display listing.
Figure 3-7 shows how the import process works. The FML files are imported into the Contract Repository database. If you want to see the objects that you have just imported, you must refresh the tree structure of your GUI by selecting File —> Refresh from the menu bar after the import.
Figure 3-7 FML Import Procedure
Figure 3-8 FML File Import Window
To use the FML import:
Or
Click on the Import toolbar button.
Click OK to begin the import process. You can track the status of the import by referring to the messages displayed in the lower left-hand corner of the interface. (Or click Cancel if you decide not to import at this time.)
Note:
You cannot cancel an import once it has started. If you inadvertently start the import, wait until it has completed the import cycle. If the import stops due to an error, you are notified by the Alert dialog box. For more information on the Alert window, refer to the Troubleshooting section in this chapter.
If you imported a file that contained elements that you do not need, you can delete them. Refer to Deleting Objects From the Repository section in this chapter for information regarding object dependencies. Objects that are dependent on other objects cannot be deleted.
As an alternative to interactively defining operations, then grouping them into interfaces, you may wish to load text files describing these operations.
To load interfaces:
Or
Click on the Load toolbar button.
A log box will appear indicating the load actions.
You can create new objects by using the Add option from the Edit menu.
When you populate the Contract Repository, we suggest that you construct your objects from the "bottom up." Create your elements first, then structs, operations, interfaces, and finally, modules. Elements are self-contained, but each of the other objects depend on the object prior to it in the Contract Repository tree (e.g., structs depend on elements).
Follow the instructions in the sections for:
All object names that you input must conform to the format rules of C language identifiers. Each identifier must start with an alphabetic character or an underscore (e.g., fixed_occurrence). Each identifier can include alphabetic characters, underscores, and numeric characters.
You create new elements by using the Add Element window shown in Figure 3-9.
To add an element:
Format Rules for Repository Objects
Adding Elements
Figure 3-9 Add Element Window
Adding Elements Instructions
Or
Click on the Add toolbar button.
To select an element type from the Adding Elements window:
This brings up the Select Element Type window as shown in Figure 3-10.
Figure 3-10 Select Element Type Window
To select an FML field name:
This brings up the Select FML Field window as shown in Figure 3-11.
Figure 3-11 Select FML Field Window
Structs (also referred to as "structures") comprise a group of available element members. A struct cannot be nested within a struct. Each member has a name, type, and length information. Use the << or >> keys to move members between current and available status. When a member name is moved, all of the information accompanying the member is moved. See Format Rules for Repository Objects for information about object naming conventions.
Figure 3-12 Add Struct Window
To add a struct:
Or
Click on the Add toolbar button.
To add operations, the list of available parameters (based on previously defined elements) is displayed on the right scrollable list. Type the operation name in the text entry field, select the parameters, and enter the ATMI server implementation information. See Format Rules for Repository Objects for information about object naming conventions.
The Edit button is used to change a parameter's passing mode and mandatory attributes after it has been moved from the available list. See Modifying Parameters for additional information. The default fields are shown below.
|
Passing Mode |
in |
|
Mandatory |
Yes |
|
Display Name |
Parameter name |
Figure 3-13 Add Operation Window
To add an operation:
Or
Click on the Add toolbar button.
You can create an interface by accessing the Add Interface window. The available operations are displayed on the right and the current operations are displayed on the left. Use the arrow buttons to move operations in or out of the interfaces. See Format Rules for Repository Objects for information about object naming conventions.
Figure 3-14 Add Interface Window
To add an interface:
Or
Click on the Add toolbar button.
Figure 3-15 shows the Add Module window. To create a module, select the root of the module tree, choose Edit—>Add from the menu bar to display the Add Module dialog box, and type the name in the Module Name text entry field. Select the module's current interfaces by moving items from the Available Interfaces display area to the Current Interfaces display area. See Format Rules for Repository Objects for information about object naming conventions.
Figure 3-15 Add Module Window
To add a module:
Or
Click on the Add toolbar button.
You can modify objects at any time. You may choose to modify an object to incorporate a name change or any other change to the object. This section describes:
You can modify an element at any time, including when you are creating new modules or after testing an operation. The Modify Element window in Figure 3-17 is used to modify elements. An element may be altered to incorporate occurrences, disable or enable the fixed-field length, add comments, and change server implementation information. See Adding Elements for a description of the element window.
Note:
The element length can be altered only if the element type is string or carray.
To modify an element:
Modifying Elements
Figure 3-16 Element Selection Window
Modifying Elements Instructions
Or
Click on the Modify toolbar button.
Figure 3-17 Modify Element Window
(Or click Cancel to close the window without saving your changes.)
You can modify a struct from the Struct main window shown in Figure 3-18. To modify a struct, the current elements display in the left window and the available elements display in the right window as shown in Figure 3-19. The arrow buttons in the middle can be used to move elements in or out of the struct. See Adding Structs for a description of the struct window.
Figure 3-18 struct Selection Window
To modify a struct:
Or
Click on the Modify toolbar button.
Figure 3-19 Modify Struct Window
(Or click Cancel to close the window without saving your changes.)
You can modify a parameter from the Business Interface Window (by selecting it in the tree and clicking Modify as shown in Figure 3-20).
Note: You can also modify a parameter as a part of adding or modifying operations. When you select a "current parameter" in the Add Operation or Modify Operation window and click Edit, you get the Edit Parameter window, which functions in the exact same way as the Modify Parameter window. (See Adding Operations or Modifying Parameters.)
For complete instructions see Modifying Parameter Instructions. (The Modify Parameter window is shown in Figure 3-21.)
A parameter may be modified to enable or disable the return value, or change the passing mode by selecting IN, IN/OUT, OUT, or NO ACCESS. In addition, the ATMI server information can be modified to reflect a display name change, a change in the exception mode return status, and enable or disable the mandatory status.
Figure 3-20 Parameter Selection Window
To modify a parameter from the Business Interface Window:
Or
Click on the Modify toolbar button.
This brings up the Modify Parameter window shown in Figure 3-21.
Figure 3-21 Modify Parameter Window
(Or click Cancel to close the window without saving your changes.)
You can modify an operation by selecting an operation from the repository tree as shown in Figure 3-22. See Adding Operations for a description of the operation window.
Note: You can modify the components of an exported operation. You do not have to unexport the operation in order to modify its components. If you modify an exported operation, it does not automatically change to unexported status. A modified exported operation remains exported until you unexport it with the unexport toolbar button or menu option.
Figure 3-22 Operation Selection Window
To modify an operation:
Or
Click on the Modify toolbar button.
Figure 3-23 Modify Operation Windows
(Or click Cancel to close the window without saving your changes.)
You can make changes to an interface by selecting the interface from the directory tree shown in Figure 3-24. See Adding Operations for a description of the interface window.
Figure 3-24 Interface Selection Window
To modify an interface:
Or
Click on the Modify toolbar button.
Figure 3-25 Modify Interface Window
(Or click Cancel to close the window without saving your changes.)
Modify a module by selecting the object from the directory tree shown in Figure 3-26. See Adding Operations for a description of the module window.
Figure 3-26 Modules Selection Window
To modify a module:
Or
Click on the Modify toolbar button.
Figure 3-27 Modify Module Window
(Or click Cancel to close the window without saving your changes.)
This section details the necessary steps to delete an object. You can delete a module, interface, operation, parameter, struct, or element. After deletion, the object is gone. There is no recycle bin in the Contract Repository, so if you inadvertently delete an object you must create a new one to replace it.
You cannot automatically delete an object that is dependent on (or used by) another object. If you attempt to delete an object that is in use in the Contract Repository, you receive an Alert message. The Alert message shows where the object is being used. When you click OK, the Alert window closes. So, before you close the Alert window, you may want to note where the object is being used. You cannot delete the object until you remove the dependency.
A module is the only object that does not have any dependencies.
To delete an object:
Or
Click on the Delete toolbar button.
Figure 3-28 Delete Module Window
Figure 3-29 Alert Window with Dependency Information
For additional information, refer to the Modifying Objects section in this chapter.
Once you have completed building an operation, you are ready to test it. Before you can test an operation, you must export it. "Export" serves as a flag that makes it available for testing, generating palettes and templates, and web or Windows applications for use in run time.
By default, the operation is always unexported as shown in Figure 3-30.
You have the option to export or unexport all operations within the interface at one time.
You do not have to make all operations available to the client at the same time, even if your interface contains several operations.
Figure 3-30 Window with Unexported Operation
To export:
Or
Click on the Export toolbar button.
To unexport an operation:
Or
Click on the Unexport toolbar button.
You can test an operation and its parameters to ensure that all components are functioning properly before you can use the operation further.
Once an operation is exported you can test it. If the test fails and editing is required to fix the operation, you do not have to unexport the operation prior to editing.
The operation test window allows you to test previously defined operations to verify their function against the service implementation. The window contents are based on the number and type of parameters the operation expects. If an operation has multiple parameters and cannot be viewed on one screen, a scrollbar displays to navigate through the parameters.
Figure 3-32 Test Operation Window
To test an operation:
Test Operation Instructions
Or
Click on the Test toolbar button.
Follow the instructions below if editing is required to pass the test.
Log off the Process Design Assistant before exiting it. The Logoff option is only enabled after logon.
Figure 3-33 Exit Prompt
To log off and exit:
Or
Click on the Logoff toolbar button.
You are "alerted" through an alert window of any error that occurs while running the application. You will receive an alert message if the system is unable to:
The message in Figure 3-34 is an alert about an object dependency.
When the Alert window displays:
Figure 3-34 Alert Window
Alert Window Instructions
