Batch generation and design capture

About batch generation and design capture

About the batch processing wizards

About the Oracle Designer Batch Window

Performing batch processing

Specifying batch processing details using wizards

Running Batch Definition files


About batch generation and design capture

Related Topics

When you run the generator products directly from the Design Editor you must wait until processing is complete before continuing to use the Design Editor. The batch processing tools enable you to run the generators while continuing to use the Design Editor. Alternatively you can use the batch processing tools to run the generator products without invoking the Design Editor, by starting the batch tools from the command line.

The main differences between running generator products directly from the Design Editor and running them through the batch processing tools are listed below

Processing directly from the Design Editor	Processing from the batch processing tools
During processing, other activities cannot be performed within the Design Editor.	During processing, other activities may be performed.
In the Design Editor, client applications are generated and captured on a one by one basis, e.g., to generate an Oracle Forms application, you choose a module, start Form Generator and wait for generation to complete. To generate more client applications, repeat the process.	Multiple client applications of different types can be generated or captured in a single operation. For example, a combination of several Oracle Forms applications and Oracle Reports applications can be generated in a batch run.
Processing results are displayed in the Message Window, which provides navigation to the source of errors.	Processing messages are displayed in a Batch Window and can optionally be saved to a file.

The batch processing tools comprise:

•	Batch processing wizards, which you use to specify generation or design capture details.  About

•	The Oracle Designer Batch Window, which you use to perform generation or design capture based on details specified from the wizards.  About


About the batch processing wizards

Related Topics

There are two batch processing wizards:

•	Batch Generation Wizard, helps you to record generation details for Client Applications (e.g. Oracle Forms applications), Help Systems, Table API, Module Component API, Reference Code Tables, Database Administration Objects, and Server Model Objects (e.g. Database Tables).

•	Batch Design Capture Wizard, helps you to record capture details for Client Applications (e.g. Oracle Forms applications), Server Models from Files and Server Models from Databases.

The wizards allow you to specify the objects that you want to generate or capture, and to specify runtime options. How

You can optionally save your processing information to files, which can be run at a future time. These files are referred to as Batch Definition Files and are run from the Oracle Designer Batch Window.  About


About the Oracle Designer Batch Window

Related Topics

The Oracle Designer Batch Window allows you to run the generator products, e.g. Server Generator, based on options specified using the batch processing wizards.  About

The Batch Window is started automatically when you click Finish to close the Batch Generation Wizard or the Batch Design Capture Wizard. Alternatively, if you have created Batch Definition files, you can run a batch process directly from the Batch Window.  How

During batch processing, messages are displayed in the Oracle Designer Batch Window.


Performing batch processing

Related Topics

Batch processing allows you to generate or capture a large number of objects, while continuing to use Oracle Designer.  About

There are two main steps to performing batch generation or capture:

•	Specifying what you want to generate or capture.

•	Running a batch process.

For example, to generate a database, first use the Batch Generation Wizard to specify the repository tables from which the database will be generated, and generation options. In addition, you can choose to save the generation details to a Batch Definition file. When you click Finish on the Wizard, the Oracle Designer Batch Window is opened and generation is started. If you chose to save the generation details to a file, you can in future open the batch file and run it without using the wizard.

Specifying what you want to generate or capture:

When you perform batch generation or design capture for the first time, you must use a batch wizard to specify processing details.  How

Note:	The information you enter in a batch wizard is stored temporarily and is used to automatically start processing when you close the batch wizard. You can optionally save this information to a Batch Definition file, which you can use to perform batch processing in the future, without specifying the processing details again.

Running a batch process:

Before running batch generation or capture, ensure that you have done the following:

•	Set any required general generator options, e.g. scope and name of Code Control Table by choosing Options→Generator Options→General.

•	Set any required generator preferences.

This information is used during generation and is not recorded in Batch Definition files.

When you are satisfied that all options are correctly set, you are ready to run a Batch Definition file.  How


Specifying batch processing details using wizards

Related Topics

When you specify batch processing details, you can optionally save the information to Batch Definition files. You can then run these files from the from the Oracle Designer Batch Window.

Note:	When you run a batch file, the current general generator options, e.g. scope of Reference Code Tables, and preference values are used, rather than the values that were set when the file was created. Choose Options→Generator Options→General or Edit→Generator Preferences from the Design Editor to check the current settings.

To specify batch processing details:

1.	From the Design Editor, do one of the following:

•	Choose Tools→Batch Generate to start the Batch Generation Wizard.

•	Choose Tools→Batch Design Capture to start the Batch Design Capture Wizard.

2.	Choose what you want to generate or capture, e.g. Server Model, then click Next.

3.	Use the remaining wizard pages to:

•	Identify the objects on which the processing will be based.

•	Optionally, change default processing options.

•	Save the processing details to a Batch Definition file for future use.

•	Optionally, specify a file to which error messages will be written.

4. 	Press Finish to close the wizard and start processing.

The Oracle Designer Batch Window is opened and processing is started.

Note:	Processing is started even if you have not saved processing details to a Batch Definition file. You can use the File→Save As option from the Oracle Designer Batch Window to create a Batch Definition file when processing is complete.


 Running Batch Definition files from the Batch Window

Related Topics

Batch definition files record batch generation and design capture details, and are created using the batch processing wizards.  About

Note:	When you run a batch file, the current general generator options, e.g. scope of Reference Code Tables, and preference values are used, rather than the values that were set when the file was created. Choose Options→Generator Options→General or Edit→Generator Preferences from the Design Editor to check the current settings.

To run a Batch Definition file from the Batch Window:

1.	Start the Oracle Designer Batch Window by clicking on dwzrun61.exe from the <ORACLE_HOME>\BIN\ directory.

2.	Choose File→Open to open the batch file that you want to run.

3.	Choose File→Run to start generation or design capture

4.	(Optional)  Stop processing at any time by choosing File→Stop Current Task or File→Stop All Tasks.

5.	(Optional)  Save the processing options to a Batch Definition file, by choosing File→Save As.


Generation/Design Capture Wizard - Select Generator page

Related Topics

Use this page to choose the type of system that you want to generate or capture, e.g., Database Administration Objects.

Note:	The selections that you make on this page determine the pages that are subsequently displayed.

Dialog box options

Do you want to generate or capture?

To identify whether you want to perform generation or capture, click the processing option you require.

Note:	This option is displayed only if you started the batch wizard from outside the Design Editor, e.g., from the command line.

Generate from Repository Definitions

Choose this option to specify generation details.

Capture Design into Repository

Choose this option to specify capture details.

What do you want to generate/capture?

To identify the type of system that you want to generate or capture, choose from the list of available options.

The following options are available for batch generation:

•	Client Applications (e.g. Oracle Forms applications)

•	Help Systems

•	Server Model (e.g. Database Tables, Views)

•	Database Administration Objects

•	Module Component API

•	Table API

•	Reference Code Tables

The following options are available for batch design capture:

•	Client Applications

•	Server Model from File

•	Server Model from Databases

Container

To identify the repository container from which you want to generate, or the repository container into which you want to place a captured design.


Generation Wizard - Set Generation Target page

Related Topics

Use this page to specify details about the target file or database that is to be created when you generate Database Administration Objects, Server Models, Table API, Module Component API or Reference Code Tables. For example, for Server Models you can specify whether the target is a DDL file or a database. You can optionally, specify further generation options.

Dialog box options

Generate < type> To

Allows you to view and optionally change generation target details. The type of object that is to be generated is identified in the title, e.g. Generate Database Objects To. The generation target, e.g. Oracle Database, is shown below the field group title. Use the Change Target button to change the target type.

Generation options

The options that are displayed on this page depend on what you have chosen to generate:

DB Admin Objects	Options correspond to those presented on the Generate Database Administration Objects dialog box in the Design Editor.  About
Server Model	Options correspond to those presented on the Database Generator Options dialog box in the Design Editor.  About
Table API	Options correspond to those presented on the Generate Table API dialog box in the Design Editor.  About
Module Component API	No generation options.
Reference Code Tables	No generation options.


Design Capture Wizard - Select Objects page

Related Topics

Use this page to identify the objects that you want to capture.

Dialog box options

Available Objects

Lists objects to be excluded from the process. Use the directional arrows to include or exclude objects from the list.

Objects to Capture

Lists objects that will be included in the batch design capture process. Use the directional arrows to include or exclude objects from the list. The objects displayed in the list boxes are determined by what you have chosen to capture from the first page of the wizard.

Directional arrows

	Design Capture Selection arrow Moves selected objects to the Objects to Capture list box. Double-click on an object to move it to the opposite list.
	Don't Capture Selection arrow Moves selected objects to the Available Objects list box. Double-click on an object to move it to the opposite list.
	Capture All arrow Moves all objects to the Objects to Capture list box.
	Don't Capture All arrow Moves all objects to the Available Objects list box.


Generation Wizard - Select Objects for Generation page

Related Topics

Use this page to identify the database objects that you want to generate.

Dialog box options

Database / Database Users (For Server Model and Table API only)

This dropdown list allows you to specify the database to which Database Administration Objects are to be generated, or the Database User for which Server Model object or Table API objects are to be generated. The content of this dropdown list is determined by what you have chosen to generate from the first page of the wizard.

Available Objects

Lists objects to be excluded from the process. Use the directional arrows to include or exclude objects from the list.

Objects to Generate

Lists objects that will be included in the batch generation process. Use the directional arrows to include or exclude objects from the list.

Directional arrows

	Generate Selection arrow Moves selected objects to the Objects to Generate list box. Double-click on an object to move it to the opposite list.
	Don't Generate Selection arrow Moves selected objects to the Available Objects list box. Double-click on an object to move it to the opposite list.
	Generate All arrow Moves all objects to the Objects to Generate list box.
	Don't Generate All arrow Moves all objects to the Available Objects list box.


Generation Wizard - Select Modules page
Generation Wizard - Select Modules for Generation page

Related Topics

Use this page to identify the module definitions from which you want to generate client applications or their help systems. You can choose to generate client applications of different types, e.g. Oracle Forms applications and Visual Basic applications, by placing them in the Objects to Generate list box.

Dialog box options

Available Objects

Lists modules to be excluded from the process. Use the directional arrows to include or exclude modules from the list.

Objects to Generate

Lists modules that will be included in the batch generation process. Use the directional arrows to include or exclude modules from the list. The modules displayed in the list boxes are determined by what you have chosen to generate from the first page of the wizard, i.e. Client Applications or Help System.

Directional arrows

	Generate Selection arrow Moves selected modules to the Objects to Generate list box. Double-click on a module to move it to the opposite list.
	Don't Generate Selection arrow Moves selected modules to the Available Objects list box. Double-click on a module to move it to the opposite list.
	Generate All arrow Moves all modules to the Objects to Generate list box.
	Don't Generate All arrow Moves all modules to the Available Objects list box.


Generation Wizard - Enter Module Generation Details and Options page

Related Topics

Use this page to identify the options that are to be used for generating client applications, such as, Oracle Forms applications.

Dialog box options

This page displays a tab for each of the module languages selected for generation. The information on each tab corresponds to the information presented on the Generate dialog boxes in the Design Editor. For information about these options refer to:

•	Generate Form dialog box

•	Generate Library dialog box

•	Generate Report dialog box

•	Generate Visual Basic dialog box

•	Generate Web PL/SQL dialog box

Save changes to Repository

Check this box if warnings flagged during generation are to result in automatic update of module definitions in the repository.


Generation Wizard - Enter Help Generation Details and Options page

Related Topics

You can use MS Help Generator to generate MS Help source files from module design specifications held in the repository.

Use this page to generate new MS Help source files from the selected module (or module network), or update existing MS Help file source files. You must compile the help source files manually after generation to create the help file (.hlp).

Note:	This dialog box page also allows you to update Form Generator Help Tables.

Dialog box options

Each of the options on this page correspond to the options shown on the Generate Help System dialog box in the Design Editor. For more information, see Generate Help System dialog box


Design Capture Wizard - Enter Database Capture Details page

Related Topics

This page allows you to specify options for capturing a Server Model from File, or Server Model from Database.

Dialog box options

Capture objects from (Applicable only for capturing Server Model from Database)

Identifies the online database (and user) from which a database design is to be captured. Use the Change Source button to change the database or username from which the design will be captured.

Owner

Optional field allowing you to browse and capture database objects for a user other than the user you have specified to connect to the database.

You specify the owner in the format:

<username>

Capture objects to

Identifies the repository database definition into which objects or files will be captured.

Database

Identifies the name of the repository database definition into which objects or files will be captured. Choose from existing database definitions or enter the name of a new database definition.

Type

If you have chosen to capture to an existing database, this field displays the type of that database. If you have entered the name of a new database use this field to specify the type of that database.

User

Identifies the name of the repository user definition for which objects or files will be captured. Choose from existing user definitions or enter the name of a new user definition.

Options

Identifies whether indexes, triggers or constraints are to be captured.

The options shown here correspond to options presented on the Capture Server Model dialog box in the Design Editor. For help about these options, see Capture Server Model dialog box


Design Capture Wizard - Select Files for Capture page
Design Capture Wizard - Select Files for Design Capture page

Related Topics

Use this page to specify which client applications or DDL files are to be captured into the repository.

The dialog box options displayed on this page depend on your choice from the first page of this wizard, i.e., whether you have chosen to capture:

•	Server Model from file

•	Client Applications

Dialog box options (for capturing Server Model from File)

DDL Files

Identifies the .DDL files that you want to capture into the repository. Optionally, use the Browse button to locate files in the file system.

Database Type

Identifies the type of database you want to capture.

Dialog box options (for capturing Client Applications)

Application

Identifies the client application files that you want to capture into the repository. You can capture the following types of client applications:

Application type	File extension
Oracle Forms applications	(.FMB)
Oracle Reports applications	(.RDF)
Oracle Library files	(.PLD or .PLL)
Visual Basic project files	(.VBP)
Enter the names of the applications and their file extensions. Optionally, use the Browse button to locate files in the file system.

Destination Module

Identifies the Short Name of the repository module into which the file will be captured.

If you do not specify a name and you do not check the Merge with existing repository destination module checkbox (on the Batch Processing Capture options page), the Generators create a new module and give it a Short Name based on the name of the client application file being captured.

If you do not specify a name and you do check the Merge with existing repository destination module checkbox, the Generators attempt to locate a module with the same name (i.e. unique Implementation Name, or Short Name if the module does not have an Implementation Name) as the name of the client application file being captured. If one (and only one) existing repository module is located, the client application file being captured is merged with the existing module. If no such existing repository module is located (or if more than one module is located), the Generators create a new module and give it a Short Name based on the name of the client application file being captured.


Design Capture Wizard - Client Capture options page

Related Topics

Use this page to identify the options that are to be used during design capture of client applications.

This page displays a tab for each module language to be captured.

Dialog box options

Tabs may be displayed for Oracle Forms applications, Oracle Reports applications, Oracle Common Libraries, and for Visual Basic applications. The information on each tab corresponds to information presented on the Capture Design dialog boxes in the Design Editor. For information about these options refer to:

Note:	During batch application capture, the generator products do not prompt you with the option to merge captured modules with existing module definitions. Instead, a Merge with existing repository definition module check box allows you to specify in advance whether modules should be merged.  About
This check box is not applicable when capturing Visual Basic applications.

•	Capture Form Design dialog box

•	Capture Library Design dialog box

•	Capture Report Design dialog box

•	Capture Visual Basic Design dialog box


Generation/Design Capture Wizard - Select log file page
Generation / Design Capture Wizard - Enter Log File Details page

Related Topics

Use this page to specify whether the information that you have specified is to be saved to a Batch Definition File, and whether messages that are issued during processing are to be written to a log file.

This is the final page of the wizard.

Dialog box options

Save <generation/capture> details

To identify whether generation/design capture details are to be saved to a file choose Yes or No.

Saving the details to a file, allows you to run the file at a future time, without having to specify the information again.

If you choose Yes, you must specify a File Name. Enter the drive and directory you require. Alternatively, click Browse to select the location.

If you choose No, generation details are not saved .

Note:	Both batch generation files and batch design capture files have the same extension (.gbu). You may want to use a naming convention that allows you to differentiate between generation and design capture files.

Save <generation/capture> messages to file

To save processing messages files in a specific directory, enter the drive and directory you require. Alternatively, click Browse to select the location.

If no location is specified, a log file is saved to the working directory of the program item or shortcut used to start Oracle Designer. The default location is <ORACLE_HOME>\BIN\.

When you have completed this page of the wizard, Click Finish.

The Oracle Designer Batch Window opens and starts to process the information that you have specified in the wizard.