e-docs > Tuxedo > Using JOLT > Using the Jolt Repository Editor |
Using JOLT |
Using the Jolt Repository Editor
Use the Jolt Repository Editor to add, modify, test, export, and delete BEA Tuxedo service definitions from the Repository based on the information available from the BEA Tuxedo configuration file. The Jolt Repository Editor accepts BEA Tuxedo service definitions, including the names of the packages, services, and parameters.
This topic includes the following sections:
Introduction to the Repository Editor
The Jolt Repository is used internally by Jolt to translate Java parameters to a BEA Tuxedo type buffer. The Repository Editor is available as a downloadable Java applet. When a BEA Tuxedo service is added to the repository, it must be exported to the Jolt server to ensure that the client requests can be made from a Jolt client.
Repository Editor Window
Repository Editor windows contain entry fields, scrollable displays, command buttons, status, and radio buttons. The figure Sample Repository Editor Window illustrates the parts of the window. The table Repository Editor Window Parts contains details about each part.
Figure 4-1 Sample Repository Editor Window
Repository Editor Window Description The following table details the parts of the Repository Editor window shown in the previous figure.
Getting Started
Before starting the Repository Editor, make sure that you install the minimally required components, the Jolt Server and the Jolt Client.
To use the Repository Editor:
Note: For information about exiting the Repository Editor after you enter information, refer to Exiting the Repository Editor.
Starting the Repository Editor Using the Java Applet Viewer
appletviewer <full-pathname>/RE.html
Starting the Repository Editor from Your Web Browser
Use one of the following procedures to start the Repository Editor from your Web Browser.
To Start from a Local File
file:<full-pathname>/RE.html
To Start from a Web Server
http://<www.server>/<URL path>/RE.html
Logging On to the Repository Editor
Note: If you are using the JDK 1.3 appletviewer to start the Jolt Repository Editor, you will not be able to connect to a remote machine, only to a local host JSL. This is due to a security restriction imposed in the JDK 1.3 appletviewer. Also, for JDK 1.2, you must use the -nosecurity option in the appletviewer if you are connecting to a remote machine JSL.
The following table, Repository Editor Logon Window Description, describes Repository Editor logon window elements.
Repository Editor Logon Window Description
Table 4-2 Repository Editor Logon Window Description
Exiting the Repository Editor Exit the Repository Editor when you finish adding, editing, testing, or deleting packages, services, and parameters. Prior to exit, the window is displayed as shown in the figure BEA Jolt Repository Editor Logon Window Prior to Exit. Figure 4-3 BEA Jolt Repository Editor Logon Window Prior to Exit
.
Note that only the Packages, Services, and Log Off command buttons are enabled. All of the text entry fields are disabled. Follow the steps below to exit the Repository Editor:
Main Components of the Repository Editor
The Repository Editor allows you to add, modify, or delete any of the following components:
You can also test and group services.
Repository Editor Flow
After you log on to the Repository Editor, two buttons are enabled, Packages and Services.
The following figure illustrates the Repository Editor flow to help you determine which of these two buttons to select.
Figure 4-4 Repository Editor Flow Diagram
Select Packages to open the Packages window and perform the following functions:
Refer to What Is a Package? for complete details.
Select Services to open the Services window and perform the following functions:
Refer to What Is a Service? for complete details.
What Is a Package?
Packages provide a convenient method for grouping services for Jolt administration. (A service consists of parameters, such as pin number, account number, payment, rate, term, age, or Social Security number.)
You use the Packages window to perform the following:
Click the Packages button in the Jolt Repository Editor logon window to display the available packages. When you select a specific package from the display list, its services within that package are displayed.
The following figure contains a sample Packages window. The BANKAPP package is selected, and the services within the BANKAPP package is displayed.
Figure 4-5 Sample Packages Window
Instructions for Viewing a Package
What Is a Service?
A service is a definition of an available BEA Tuxedo service. Services include parameters such as pin number, account number, payment, and rate. Adding or editing a Jolt service does not affect an existing BEA Tuxedo service.
You use the Services Window to add, edit, or delete services.
The following figure is an example of a Services window with the BANKAPP package selected, and the display list of services and parameters available for this package (parameters are detailed later).
Figure 4-6 Sample Services Window
Instructions for Viewing a Service
Working with Parameters
A service contains parameters, which may be a pin number, account number, payment, rate, term, age, or Social Security number. The following figure shows a Services window displaying a selected service and its parameters.
Note: Adding or editing a parameter does not modify or change an existing BEA Tuxedo Service.
Figure 4-7 Sample Services Window with Parameters List
Instructions for Viewing a Parameter
Setting Up Packages and Services
This section includes the necessary steps for setting up a package and its services:
Saving Your Work
As you create and edit services and parameters, it is important to regularly save information to avoid losing input. Clicking Save Service in the Edit Services window can prevent the need to re-enter information in the event of a system failure.
Caution: When you add or edit the parameters of a service, you must select Add before choosing Back from the Edit Parameters window and returning to the Edit Services window.
If adding a new service or modifying an existing service in the Edit Services window, be sure to select Save Service before choosing Back. If you select Back before you save the modified information, a warning is briefly displayed on the status line at the bottom of the window.
Adding a Package
When you need to add a new group of services, you create a new package before adding the services. The Package Organizer Window and the following procedure show how to add a new package, BALANCE, to the Packages listing.
Figure 4-8 Package Organizer Window
Instructions for Adding a Package
Adding a Service
Services are definitions of available BEA Tuxedo services and can only be a part of a Jolt package.You must create the service as a part of a new or existing package.
The Repository Editor accepts the new service name exactly as it is typed (that is, all uppercase letters, abbreviations, misspellings are accepted). Service names must not exceed 30 characters.
The following figure shows the Edit New Services window for adding a service.
Figure 4-9 Edit Services Window: Add a New Service to a Package
Adding a Service Window Description The following table describes the options for adding services to a package in a package window.
Instructions for Adding a Service
Selecting CARRAY or STRING as a Service Buffer Type
If CARRAY or STRING is selected as the buffer type for a new service, only CARRAY or STRING can be added as the data type for the accompanying parameters. See also Adding a Parameter and Selecting CARRAY or STRING as a Parameter Data Type. For additional information, refer to Using the Jolt Class Library..
The following figure shows an example Edit Services window with STRING selected as the buffer type for the service SIMPAPP.
Figure 4-10 Edit Services Window: Select STRING Buffer Type
Adding a Parameter Clicking New under the label Parameter level actions in the Edit Services window is displayed in the Edit Parameters window. Review the features in the following figure. Use this window to enter the parameter and screen information for a service. Figure 4-11 Edit Parameters Window: Add a Parameter
Adding a Parameter Window Description
Instructions for Adding a Parameter
Selecting CARRAY or STRING as a Parameter Data Type
If CARRAY or STRING is the selected buffer type for a new service, only CARRAY or string can be added as the data type for the accompanying parameters.
In this case, only one parameter can be added. It is recommended that you use the parameter name "CARRAY" for a CARRAY buffer type, and the parameter name "STRING" for a STRING buffer type.
See also Instructions for Adding a Service and Selecting CARRAY or STRING as a Service Buffer Type. For additional information, refer to Using the Jolt Class Library..
The following figure is an example of the Edit Parameters window with string as the selected data type for the parameter. The Data Type defaults to string and does not allow you to modify that particular data type. The Field Name can be any name.
Figure 4-12 Edit Parameters Window: string Data Type
Grouping Services Using the Package Organizer
The Package Organizer moves services between packages. You may want to group related services in a package (for example, WITHDRAWAL services that are exported only at a certain time of the day can be grouped together in a package).
Use the Package Organizer arrow buttons to move a service from one package to another. These buttons are useful if you have several services to move between packages. The packages and services display listings to help track a service within a particular package.
The following figure is an example of a Package Organizer window with a service selected for transfer to another package.
Figure 4-13 Package Organizer Window
Package Organizer Window Description
Instructions for Grouping Services with the Package Organizer
These keys are activated only when both packages (left and right are displayed) and a service are selected. The keys are only active in the direction of the package where the service is to be moved. The previous figure, Example of a Moved Service, shows that the INQUIRY service has been moved to the BANK package on the right.
Modifying Packages, Services, and Parameters
You can make the following changes to packages, services, and parameters:
Editing a Service
You can edit an existing service name or service information, or access the window to add new parameters to an existing service. For a description of the Edit Services window, see Adding a Service Window Description. The following figure is an example of the Edit Services window.
Figure 4-15 Edit Services Window
Instructions for Editing a Service Follow these steps to edit a service:
Editing a Parameter
All parameter elements can be changed, including the name of the parameter.
Warning: If you create a new parameter using an existing name, the system overwrites the existing parameter.
The following figure is an example of the Edit Parameters window.
Figure 4-16 Edit Parameters Window
.
Instructions for Editing a Parameter Follow these steps to change a parameter:
Deleting Parameters, Services, and Packages
This section describe how to delete a package. Before deleting a package, all the services must be deleted from the package. The Delete option is not enabled until all components of the package or service are deleted.
Warning: The system does not display a prompt to confirm that items are to be deleted. Be certain that the parameter, service, or package is scheduled to be deleted or has been moved to another location before selecting Delete.
Deleting a Parameter
Determine which parameters to delete and follow these steps:
Deleting a Service
Determine which services to delete and follow these steps:
Note: Make certain that all parameters within this service are deleted before selecting this option.
Deleting a Package
Determine which packages to delete and follow these instructions. Make sure all services contained in this package are deleted or moved to another package before selecting this option.
Making a Service Available to the Jolt Client
To make a service available to a Jolt client, you export it. All services in a package must be exported or unexported as a group. A service is made available by using the Export and Unexport radio buttons.
This topic includes the following sections:
Exporting and Unexporting Services
Determine which services are being made available or unavailable to the Jolt client. Services are exported to ensure that the Jolt client can access the most current service definitions from the Jolt server.
The following figure shows the Packages window, where you can export and unexport services.
Figure 4-17 Packages Window: Export and Unexport Buttons
Follow these steps to export or unexport a service:
Caution: The system does not display a confirmation message indicating that the service is exported or unexported. See Reviewing the Exported and Unexported Status for additional information.
Reviewing the Exported and Unexported Status
When a service is exported or unexported, you can review its status from the Edit Services window.
The following figure displays the Export radio button as active, for Export Status; therefore, the current status for the service TRANSFER is exported.
Figure 4-18 Export Status
To review the current exported or unexported status of a service, follow these steps:
Testing a Service
Test a service and its parameters before you make them available to Jolt clients. You can test currently available services without making changes to the services and parameters.
Note: The Jolt Repository Editor allows you to test an existing BEA Tuxedo service with Jolt, without writing a line of Java code.
An exported or unexported service can be tested; if you need to change a service and its parameters, unexport the service prior to editing.
This topic includes the following sections:
Jolt Repository Editor Service Test Window
Use the Run button to test the service to ensure that the parameter information is accurate. A service can only be tested when the corresponding BEA Tuxedo server is running for the service being tested.
Although the Test button in the Edit Services window is enabled when parameters are not added to the service, the Service Test window displays unused in the parameter fields, and they are disabled. Refer to Sample Service Test Window for an example of unused parameter fields.
Note: The Service Test window displays up to 20 items of any multiple-occurrence parameters. All items that follow the twentieth occurrence of a parameter cannot be tested.
The following figure is an example of a Service Test window with both writable and read-only text fields.
Figure 4-19 Sample Service Test Window
Service Test Window Description The following table describes the Service Test window options. Note: You can enter a two-digit hexadecimal character (0-9, a-f, A-F) for each byte in the CARRAY data field. For example, the hexadecimal value for 1234 decimal is 0422.
Testing a Service
You can test a service without making changes to the service or its parameters. You can also test a service after editing the service or its parameters.
Test Service Process Flow
The following figure shows a typical Repository Editor service flow test.
Figure 4-20 Test Service Flow
Instructions for Testing a Service Follow these steps to test a service. For troubleshooting information, see the first two entries in the Repository Editor Troubleshooting table.
If Edits are Required After Testing
Follow these steps if editing is required to pass the test:
Repository Editor Troubleshooting
Consult the following table if you encounter problems while using the Repository Editor.