Using Jolt

Bulk Loading BEA Tuxedo Services

As a systems administrator, you may have an existing BEA Tuxedo application with multiple BEA Tuxedo services. Manually creating these definitions in the repository database may take hours to complete. The Jolt Bulk Loader is a command utility that allows you to load multiple, previously defined BEA Tuxedo services to the Jolt Repository database in a single step. Using the jbld program, the Bulk Loader utility reads the BEA Tuxedo service definitions from the specified text file and bulk loads them into the Jolt Repository. The services are loaded to the repository database in one "bulk load." After the services populate the Jolt Repository, you can create, edit, and group services with the Jolt Repository Editor.

This topic includes the following sections:

Using the Bulk Loader

The jbld program is a Java application. Before running the jbld command, set the CLASSPATH environment variable (or its equivalent) to point to the directory where the Jolt class directory (that is, jolt.jar and joltadmin.jar) is located. If the CLASSPATH variable is not set, the Java Virtual Machine (JVM) cannot locate any Jolt classes.

For security reasons, jbld does not use command-line arguments to specify user authentication information (user password or application password). Depending on the server's security level, jbld automatically prompts the user for passwords.

The Bulk Loader utility gets its input from command-line arguments and from the input file.

Activating the Bulk Loader

Type the following at the prompt (with the correct options):

java bea.jolt.admin.jbld [-n][-p package][-u usrname][-r usrrole] //host:port filename

Use the following table to correctly specify the command-line options.

Command-line Options

Table 2-1 Bulk Loader Command-line Options

Option	Description
`-u` `usrname`	Specifies the username (default is your account name). (Mandatory if required by security.)
`-r` `usrrole`	Specifies the user role (default is `admin`). (Mandatory if required by security.)
`-n`	Validates input file against the current repository; no updates are made to the repository. (Optional)
-p package	Repository package name (default is BULKPKG).
`//host:port`	Specifies the JRLY or JSL address (host name and IP port number). (Mandatory)
`filename`	Specifies the file containing the service definitions. (Mandatory)

The Bulk Load File

The bulk load file is a text file that defines services and their associated parameters. The Bulk Loader loads the services defined in the bulk loader file into the Jolt Repository using the package name "BULKPKG" by default. The -p command overrides the default and you can give the package any name you choose. If another load is performed from a bulk loader file with the same -p option, all the services in the original package are deleted and a new package is created with the services from the new bulk loader file.

If a service exists in a package other than the package you name that uses the -p option, the Bulk Loader reports the conflict and does not load a service from the bulk loader file into the repository. Use the Repository Editor to remove duplicate services and load the bulk loader file again. See Using the Jolt Repository Editor for additional information.

Syntax of the Bulk Loader Data Files

Each service definition consists of service properties and parameters that have a set number of parameter properties. Each property is represented by a keyword and a value.

Keywords are divided into two levels:

Service-level
Parameter-level

Guidelines for Using Keywords

The jbld program reads the service definitions from a text file. To use the keywords, observe the guidelines in the following table.

Table 2-2 Guidelines for Using Keywords

Guideline	Example
Each keyword must be followed by an equal sign (=) and the value.	Correct: `type=string` Incorrect: `type`
Only one keyword is allowed on each line.	Correct: `type=string` Incorrect: `type=string access=out`
Any lines not having an equal sign (=) are ignored.	Correct: `type=string` Incorrect: `type string`
Certain keywords only accept a well-defined set of values.	The keyword access accepts only these values: in, out, inout, noaccess
The input file can contain multiple service definitions.	`service=INQUIRY <service keywords and values> service=DEPOSIT <service keywords and values> service=WITHDRAWAL <service keywords and values> service=TRANSFER <service keywords and values>`
Each service definition consists of multiple keywords and values.	`service=DEPOSIT export=true inbuf=VIEW32 outbuf=VIEW32 inview=INVIEW outview=OUTVIEW`

Keyword Order in the Bulk Loader Data File

Keyword order must be maintained within the data files to ensure an error-free transfer during the bulk load.

The first keyword definition in the bulk loader data text file must be the initial service=<NAME> keyword definition (shown in the listing "Keyword Hierarchical Order in a Data File"). Following the service=<NAME> keyword, all remaining service keywords that apply to the named service must be specified before the first param=<NAME> definition. These remaining service keywords can be in any order.

All parameters associated with the service must be specified. Following each param=<NAME> keywords are all the parameter keywords that apply to the named parameter until the next occurrence of a parameter definition. These remaining parameter keywords can be in any order. When all the parameters associated with the first service are defined, specify a new service=<NAME> keyword definition.

Listing 2-1 Keyword Hierarchical Order in a Data File

service=<NAME>
<service keyword>=<value>
<service keyword>=<value>
<service keyword>=<value>
param=<NAME>
<parameter keyword>=<value>
<parameter keyword>=<value>
param=<NAME>
<parameter keyword>=<value>
<parameter keyword>=<value>

Using Service-Level Keywords and Values

A service definition must begin with the service=<NAME> keyword. Services using CARRAY, STRING, or XML buffer types should only have one parameter in the service. The recommended parameter name for a service that uses a CARRAY buffer type is CARRAY with carray as the data type. For a service that uses a STRING buffer type, the recommended parameter name is STRING with string as the data type. For a service that uses a XML buffer type, the recommended parameter name is XML with xml as the data type.

The following table contains the guidelines for use of the service-level keywords and acceptable values for each.

Table 2-3 Service-Level Keywords and Values

Keyword	Value
`service`	Any BEA Tuxedo service name
`export`	True or false (default is false)
`inbuf/outbuf`	Select one of these buffer types: `FML FML32 VIEW VIEW32 STRING CARRAY` XML `X_OCTET` `X_COMMON` `X_C_TYPE`
`inview`	Any view name for input parameters (This keyword is optional only if one of the following buffer types is used: `VIEW`, `VIEW32`, `X_COMMON`, `X_C_TYPE`.)
`outview`	Any view name for output parameters (Optional)

Using Parameter-Level Keywords and Values

A parameter begins with the param=<NAME> keyword followed by a number of parameter keywords. It ends when another param or service keyword, or end-of-file is encountered. The parameters can be in any order after the param=<NAME> keyword.

The following table contains the guidelines for use of the parameter-level keywords and acceptable values for each.

Table 2-4 Parameter-Level Keywords and Values

Keyword	Values
`param`	Any parameter name
`type`	`byte short integer float double string carray` xml
`access`	`in out inout noaccess`
`count`	Maximum number of occurrences (default is 1). The value for unlimited occurrences is 0. Used only by the Repository Editor to format test screens.

Troubleshooting

If you encounter problems using the Bulk Loader utility, refer to the following table. For a complete list of Bulk Loader utility error messages and solutions, see "System Messages."

Table 2-5 Bulk Loader Troubleshooting Table

If . . .	Then . . .
The data file is not found	Check to ensure that the path is correct.
The keyword is invalid	Check to ensure that the keyword is valid for the package, service, or parameter.
The value of the keyword is null	Type a value for the keyword.
The value is invalid	Check to ensure that the value of a parameter is within the allocated range for that parameter.
The data type is invalid	Check to ensure that the parameter is using a valid data type.

Sample Bulk Load Data

The following listing contains a sample data file in the correct format using the UNIX command cat servicefile. This sample loads TRANSFER, LOGIN, and PAYROLL service definitions to the BULKPKG.

Listing 2-2 Sample Bulk Load Data

service=TRANSFER
export=true
inbuf=FML
outbuf=FML
param=ACCOUNT_ID
type=integer
access=in
count=2
param=SAMOUNT
type=string
access=in
param=SBALANCE
type=string
access=out
count=2
param=STATLIN
type=string
access=out

service=LOGIN
inbuf=VIEW
inview=LOGINS
outview=LOGINR
export=true
param=user
type=string
access=in
param=passwd
type=string
access=in
param=token
type=integer
access=out

service=PAYROLL
inbuf=FML
outbuf=FML
param=EMPLOYEE_NUM
type=integer
access=in
param=SALARY
type=float
access=inout
param=HIRE_DATE
type=string
access=inout