Use the Jolt Repository Editor to add, modify, test, export, and delete TUXEDO service definitions from the Repository based on the information available from the TUXEDO configuration file. The Jolt Repository Editor accepts TUXEDO service definitions, including the names of the packages, services, and parameters.
This chapter gives detailed information on the following areas:
The Repository is used internally by Jolt to translate Java parameters to a TUXEDO type buffer. The Repository Editor is available as a downloadable Java applet. When a 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.
The following list describes each section in this chapter:
Introduction to the Repository Editor
Repository Editor windows contain entry fields, scrollable displays, command buttons, status, and radio buttons. Figure 5-1 illustrates the parts of a sample window.
Table 5-1 details the parts of the Repository Editor window example in Figure 5-1.
Before starting the Repository Editor, make sure that you have installed all necessary Jolt software. To use the Repository Editor, you must:
Repository Editor Window
Figure 5-1 Sample Repository Editor Window
Repository Editor Window Description
Getting Started
Note:
For information on exiting the Repository Editor when you are finished inputting information, refer to "Exiting the Repository Editor" in this chapter.
Start the Repository Editor from either the JavaSoft To start the editor using the JavaSoft appletviewer
or from your Web browser.
Starting the Repository Editor Using appletviewer
appletviewer
:
CLASSPATH
to include the Jolt class directory.
If loading the applet from the Web server, type the following at the URL location:
appletviewer <full-pathname>/RE.html
appletviewer http://<www.server>/<URL path>/RE.html
To start the Repository Editor from a local file:
CLASSPATH
to include the Jolt class directory.
To start the Repository Editor from a Web server:
CLASSPATH
does not include the Jolt class directory
Note:
Before opening the file, modify the http://<www.server>/<URL path>/RE.html
applet codebase
parameter in RE.html
to match your Jolt Java classes directory.
After starting the Jolt Repository Editor, follow the directions to log on:
Note:
Unless you are logging on through the Jolt Relay, the same port number is used to configure the Jolt Listener. Refer to your UBBCONFIG
file for additional information.
The Packages and Services options are activated.
Figure 5-2 is an example of the Repository Editor logon window.
Figure 5-2 Repository Editor Logon Window
The following listing details the Repository Editor logon window.
Exit the Repository Editor when you are finished adding, editing, testing, or deleting packages, services, and parameters. Figure 5-3 is an example of the Repository Editor window before exiting. Only Packages, Services, and Close are enabled. All text entry fields are disabled.
Figure 5-3 Example of the Repository Editor Logon Window Before Exiting
To exit the Repository Editor:
The Repository Editor allows you to add, modify, or delete any of the following components:
In addition, you can test and group Services.
After logging on to the Repository Editor, two options are enabled, Packages and Services. Figure 5-4 illustrates the Repository Editor flow to help you determine which button to select. Figure 5-4 shows the Repository Editor option flow.
Select Packages to perform the following functions:
Repository Editor Flow
Figure 5-4 Repository Editor Flow Diagram
Select Services to access the Services window and perform the following functions:
Packages provide a convenient method for grouping services for Jolt administration. A service is comprised of parameters, including pin number, account number, payment, rate, term, age, or Social Security number. The Packages button can be used to:
What is a Package?
The available packages are displayed. When a package is selected, the services contained within a package display.
Figure 5-5 is an example of a Packages window.
The following listing describes the Packages window options.
Figure 5-5 Highlighted Package with Services
Packages Window Description
Viewing a Package Instructions
A service is a definition of an available TUXEDO service. Services are comprised of parameters such as pin number, account number, payment, and rate. Adding or editing a Jolt service does not affect an existing TUXEDO service. Use the Services window to add, edit, or delete services. Figure 5-6 is an example of a Services window with the available services.
Figure 5-6 Services Window
The following listing describes the Services window options:
A service is comprised of parameters, including a pin number, account number, payment, rate, term, age, or Social Security number. A parameter is one of the service components. Adding or editing a parameter does not modify or change an existing TUXEDO service. Figure 5-7 is an example of the Services window displaying a selected service and its parameters.
Figure 5-7 Services Window with Parameters
This section includes the necessary steps for setting up a package and its services:
As you are creating and editing services and parameters, it is important to regularly save information to ensure that you do not inadvertently lose any input. Selecting Save Service can prevent the need to re-enter information in the event of a system failure.
Be sure to exercise caution when you are adding or editing the parameters of a service. Add must be selected before choosing Back from the Edit Parameters window (shown in Figure 5-11) and returning to the Edit Services window (shown in Figure 5-9).
If adding a new service or modifying an existing service at the Edit Services window, ensure that Save Service is selected before choosing Back. If Back is selected before the modified information is saved, a warning briefly displays on the status line at the bottom of the window.
If you need to add a new group of services, a new package must be created before adding the services. Figure 5-8 shows how a new package, BALANCE, is added to the Packages listing.
Follow these instructions to add a package:
Saving Your Work
Adding a Package
Figure 5-8 Adding a New Package
Adding a Package Instructions
Services are definitions of available TUXEDO services and can only be a part of a Jolt package. You are not required to create a new package before creating a new service; however, you must create the service as a part of a package, even if it is moved to a different package at a later date.
The Repository Editor accepts the new service name exactly as it is typed (e.g., all capital letters, abbreviations, misspellings, etc.). Service names must not exceed 30 characters. Figure 5-9 is an example of the Adding New Service window.
Figure 5-9 Edit Services: Adding New Service Window
The following listing describes the options for adding services to a package in a package window.
To add a service, follow these instructions:
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 of a service. See also "Adding a Parameter" and "Selecting carray or string as a Parameter Data Type" in this chapter. For more information, refer to Chapter 6, "Using the Jolt Class Library."
Figure 5-10 is an example of the Edit Services window with STRING as the selected buffer type for the service.
Figure 5-10 Edit Services Window with STRING as the Selected Buffer Type
Selecting New Parameter from the Edit Services window brings up the Edit Parameters window. Review the features in Figure 5-11. Use this window to input the parameter and window information for a service.
Figure 5-11 is an example of the Edit Parameters window used to add a new parameter.
Figure 5-11 Adding a Parameter Window
The following listing describes the Edit Parameters window options.
Note:
If the buffer type is FML or VIEW, the field name must match the corresponding parameter field name in FML or VIEW.
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 of a service.
In this case, only one parameter can be added. It is recommended that the parameter name for CARRAY is "CARRAY" and the parameter name for STRING is "STRING."
See also "Adding a Service Instructions" and "Selecting CARRAY or STRING as a Service Buffer Type" in this chapter. For more information, refer to Chapter 6, "Using the Jolt Class Library."
Figure 5-12 is an example of the Edit Parameters window with string as the selected data type for the parameter. The Type defaults to string and does not allow you to modify that particular data type. The Field Name can be any name.
Figure 5-12 Edit Parameters Window with string as the Data Type
The Package Organizer moves or transfers 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).
The Package Organizer arrow buttons allow you 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 help track a service within a particular package.
Figure 5-13 and Figure 5-14 are examples of Package Organizer windows with a service selected for transfer to another package.
Figure 5-13 Example of a Selected Service
The following listing describes the options for the Package Organizer window:
Figure 5-14 Example of a Moved Service
Note:
You cannot select the same package in both the left and right display lists.
If a package, service, or parameter requires any modifications, you can make the following changes:
Note:
The Jolt 1.1 release does not allow you to edit a package name.
Edit an existing service name, 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" in this chapter. Figure 5-15 is an example of the Edit Services window.
Follow the instructions below to edit a service:
Editing a Service
Figure 5-15 Edit Services Window
Editing a Service Instructions
All parameter elements can be changed, including the name of the parameter.
Figure 5-16 Edit Parameters Window
To change a parameter, follow the instructions below:
This section details the necessary sequential steps to delete a package. Before deleting a package, all of the services must be deleted from the package. The Delete option is not enabled until all components of the package or service are deleted.
Determine which parameters to delete and follow the instructions below.
Determine which services to delete and follow these instructions. Make sure that all parameters within this service are deleted before selecting this option.
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.
To make a service available to a Jolt client, you must 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 buttons.
This section discusses:
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.
Figure 5-17 shows the Packages window. From there you can Export and Unexport services.
Follow the instructions below to export or unexport a service.
Exporting/Unexporting Services
Figure 5-17 Export and Unexport Buttons
Exporting/Unexporting a Service Instructions
Note:
The system does not display a confirmation message indicating that the service is exported or unexported. See "Reviewing the Exported/Unexported Status" in this chapter for additional information.
When a service is exported or unexported, you can review its status from the Edit Services window. Figure 5-18 shows the current status as EXPORTED.
Figure 5-18 Exported/Unexported Status
To review the current exported or unexported status of a service, follow these instructions:
A service and its parameters should be tested to ensure that they are functioning properly before they are made available to Jolt clients. Services that are currently available can be tested without making changes to the services and parameters.
Note: The Repository Editor allows you to test an existing 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 section explains the following:
Test the service to ensure that the parameter information is accurate. Although Test is enabled when parameters are not added to the service, the Service Test window (Figure 5-19) displays the parameter fields as "unused" and they are disabled. A service can only be tested when the corresponding TUXEDO server is running for the service being tested.
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.
Figure 5-19 shows an example of a Service Test window with writable and read-only text fields.
The following listing details the Service Test window in Figure 5-19.
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.
Test a service to ensure that all service and parameter information is correct. 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.
Figure 5-20 shows a typical Repository Editor service test flow.
Follow these instructions to test a service.
Repository Editor Service Test Window
Figure 5-19 Sample Service Test Window
Service Test Window Description
Testing a Service Process Flow
Figure 5-20 Test Service Flow
Testing a Service Instructions
Follow the instructions below if editing is required to pass the test.
Here are some reasons why a service test might fail and possible solutions.
If this . . . | Do this . . . |
---|---|
A parameter is incorrect. |
Edit the service. |
The Jolt server is down. |
Check the server. The TUXEDO service is down. You do not need to edit the service. |
If you encounter problems while using the Repository Editor, see Table 5-2.