Developer's Reference

This chapter contains detailed information about the menus, functions, and other topics that a DataPaint application developer needs to know.

Organization of this section

Topics in this chapter are arranged by menus.  Each menu and function is explained, starting with the DataPaint main menu.  The next page shows an overview of the DataPaint menus and functions.

Function

About Function

Add Fields Function

Add Lines Function

Add Menu

Add Text Function

Add Page Function

Convert Function

Create Function

Cut Function

Data Function

Delete Function

Form Function

Form Design Menu

Generate Function

Hold Function

Initialize Menu

Layout Function

Library Function

Main Menu

Modify Function

Modify Page Function

Page Menu

Paste Function

Save Menu

Video Function

Main Menu

This is the menu that appears when you first start DataPaint.

Initialize 

Specify the DBL, form name, and Data Sets.  This is the menu that is used first when starting work on a form.

Generate 

Automatically generate a form with all the fields from the Data Sets.

Design Display the Form Design menu.
About Display information about your environment.
Save Save the form definition or save a Process Module.

Quit 

Exit DataPaint and go back to ACCENT R command level.

Initialize Menu

Select Initialize on the DataPaint main menu to display this menu.

Library

Specify the DBL to use with this form.

Form

Specify the form name.

Oracle Log on or off the Oracle Server and declare the user name.

Data

Specify the Data Sets to use with this form.

Video Define the video attributes.

Convert

Convert an existing .FD System File created by DataPaint I to an .FD System File that can be used by DataPaint.

Return Go back to the DataPaint main menu.

Library Function

Select this function after Initialize has been chosen on the DataPaint main menu to specify the name of the DBL.

The DBL you select must contain the Data Sets that will be accessed by the form.  The generated .LYT file (Layout function) or Process Module (Create function) will be stored in this DBL.

If you already had declared a DBL before you started DataPaint, the name of that DBL will automatically appear in the window.  If you wish to change the DBL name, enter the new name and press the Return key.  If you wish to use your current declared DBL, press the Return key without entering anything.

When you quit DataPaint, the DBL that you were using before you started DataPaint will be re-declared automatically.

Form Function

Select this function after Initialize has been chosen on the DataPaint main menu to specify the name of your form.

If you enter the name of a form that does not exist, you are asked:

If you currently have a form open and you select the Form function, you are asked:

Data Function

Select this function after Initialize has been chosen on the DataPaint main menu to specify information about the Data Sets used by the form.  The Setup Data Sets menu appears.

Add 

Add a Data Set to the form.

Modify

Change the Domains or Key Lists for a Data Set.

Delete 

Remove the last Data Set from the list.

Return

Go back to the Initialize menu.  

How A Datapaint Form Uses Data Sets

DataPaint allows up to ten Data Sets to be accessed per form.  Each Data Set is assigned a "designator":

NOTE:  A field in any of the Data Sets can be used to lookup records in any of the other Data Sets (joined Data Sets).

If you specify a Data Set or Data Index that has an associated Control File (CF), or if the Data Index is an RMS file, then DataPaint will create the Process Module with the necessary logic to handle Simultaneous Update conditions.

How To Add The Main Data Set Or An Auxiliary Data Set

1. Select Add on the Setup Data Sets menu.

2. For the MAIN Data Set, enter the Mode which specifies if the Data Set is read-only or not.

I

Input Records in the MAIN Data Set will only be read.  Records will not be added, changed, or deleted.

U

Update Records in the Data Set will be read, added, changed, or deleted.  You can only use a Mode of U for the Data Set that has the MAIN designator.

For the other Data Sets, (AUX1 through AUX2), the mode is automatically set to "I".

Enter the Type:

SD

Schema Definition The form can access records in any Data Set that is associated with the specified Schema Definition.  The Data Set to be accessed is specified in the EQUATE clause of the USE PM command. Records in the Data Set are accessed in the order that they are physically stored.

DS 

Data Set Records in the Data Set are accessed in the order that they are physically stored.

DI 

Data Index Records in the Data Set are accessed through a Data Index according to the value of the key fields.

ID 

Index Definition The form can access any Data Index that is associated with the specified Index Definition.  The Data Index to be accessed is specified in the EQUATE clause of the USE PM command.

Records in the Data Set are accessed through a Data Index according to the value of the key fields.

If you specify DS in Type, then you will later select key fields on the Define the Main Data.

Set menu or on the Define An Auxiliary Data Set menu and specify the order that records in the Data Set are sorted.

If you specify "DI" or "ID" in Type, then you will later select Domains on the Define the Main Data Set menu or on the Define An Auxiliary Data Set menu and specify the domains within the Data Index that you want to use.

4. Enter the name of the Data Set, Data Index, Schema Definition, or Index Definition.  If you press the Slash (/) key while the cursor is positioned on the Name field, you can select the name from a list.  The window shown in Figure 48 (Select a DI) will appear, or one of the similar windows (Select a DS, Select a SD, or Select an ID).

Use the arrow keys to move to the name of the Data Index, Data Set, Schema Definition, or Index Definition and press the Return key.

5. After entering the information for the Data Set, position the cursor on the Return menu item and press the Return key to go to the window Define the Main Data Set or to the window Define An Auxiliary Data Set (see Figure 49).

There is also a Help menu item and a Cancel menu item on the window that you can use at any time.  You can position the cursor on Help and press the Return key to look at information for this window.  If you position the cursor on Cancel and press the Return key, the information you have entered so far for the Data Set will be removed and you will go back to the Setup Data Sets menu.

6. If you have not supplied all the information when you press the Return key, the message/menu appears.

If you select Cancel, you go back to the Setup Data Sets menu without adding the Data Set to your form.  If you select Continue, you can complete the information for the Data Set.

7. If the Data Set information was valid, you will now be able to choose a function from the menu Define the Main Data Set or the menu Define An Auxiliary Data Set.

Domains

Specify the domains for a Data Index or Index Definition.

Key Fields

Specify the sorted order when using a Schema Definition or Data Set.

Cancel

Remove all information entered for this Data Set.

Return

Go back to the Initialize menu (if all Data Set information is complete.

 

8. If the Type you entered for the Data Set was "ID" or "DI", you need to select Domains from the menu and follow the appropriate procedure that is explained below:

If the Type you entered for the Data Set was "SD" or "DS", you need to select Key Fields from the menu and follow the appropriate procedure that is explained below:

How To Specify A Domain For The Main Data Index Or Index Definition

1. If a Data Index has been specified, select Domains from the Define the Main Data Set menu.  The Main Domain Definition window appears.

2. Enter the field Domain Name.  If you press the Slash (/) key while the cursor is positioned on this field, you can select the domain name from a list.  Use the arrow keys to move to the name of the domain and press the Return key.

You may set up one to five of the domains in the Data Index on this screen.  If more than one domain is set up, the end-user of the form can use the Access Order function to choose a domain to specify the sequence in which to retrieve records.  The first domain in the list is used as the default if the user does not select a sequence through the Access Order function.

3. Optionally, you can enter the field Alternate Title.  The text you enter in this field will prompt window for Get Match.  This feature lets you assign a name to the domain that is meaningful to an end user.

The alternate name cannot contain quotes.

If you do not assign an alternate name, the first 30 characters of the domain name in the Data Index or Index Definition will be used.

4. After entering all the domains for the Data Index, move the cursor to the Return menu item and press the Return key.  You will go back to the Define the Main Data Set menu.  Select the Return menu item to go back to the Setup Data Sets menu.

There is also a Help menu item and a Cancel menu item on the window that you can use at any time.  You can position the cursor on Help and press the Return key to look at help information for this window.  If you position the cursor on Cancel and press the Return key, the information you have entered so far for the domain will be removed and you will go back to the Define the Main Data Set menu.

How To Specify Key Fields For The Main Data Set Or Schema Definition

1. If you specified a Schema Definition or a Data Set, select Key Fields on the Define the Main Data Set menu.  You use this function to specify the sorted order of the Data Set.  The window Main Key Field Definition is displayed.

2. Enter the field name on which the Data Set is sorted.  If you press the Slash (/) key, you can select the field name from a list.  Use the arrow keys to move to the name of the field and press the Return key.

3. After entering all the key fields for the Data Set, move the cursor to the Return menu item and press the Return key.  You will go back to the Define the Main Data Set menu.  Select the Return menu item to go back to the Setup Data Sets menu.

4. There is also a Help menu item and a Cancel menu item on the window that you can use at any time.  You can position the cursor on Help and press the Return key to look at help information for this window.  If you position the cursor on Cancel and press the Return key, the information you have entered so far for the key fields will be removed and you will go back to the Define the Main Data Set menu.

How To Specify A Domain For An Auxiliary Data Index Or Index Definition

1. After entering the Data Set information, select Domain on the Define An Auxiliary Data Set menu.  The window called Auxiliary Domain Definition appears.

2. For Default Domain, enter the name of a domain in this Data Index.  If you press the Slash (/) key, you can select the domain from a list.  Use the arrow keys to move the cursor to the domain that you want to select and press the Return key.

3. For Source, enter the designator of another Data Set that contains the field to be used as a lookup for this Data Set.  If you press the Slash (/) key, you can select the designator from a list.  Use the arrow keys to move the cursor to the designator of the Data Set that you want to select and press the Return key.

4. For Key Fields, enter the name of the field from the Data Set specified by the designator entered in Source that is to be used as the lookup key in this Data Set.  If you press the Slash (/) key, you can select the field name from a list.  Use the arrow keys to move the cursor to the field that you want to select and press the Return key.

5. After entering the required domains for the Data Set, move the cursor to the Return menu item and press the Return key.  You will go back to the Define an Auxiliary Data Set menu.  Select the Return menu item to go back to the Setup Data Sets menu.

There is also a Help menu item and a Cancel menu item on the window that you can use at any time.  You can position the cursor on Help and press the Return key to look at help information for this window.  If you position the cursor on Cancel and press the Return key, the information you have entered so far for the domains will be removed and you will go back to the Define an Auxiliary Data Set menu.

How To Specify Key Fields For An Auxiliary Data Set Or Schema Definition

1. After entering the information about the Data Set or Schema Definition, select Key Fields on the Define An Auxiliary Data Set menu.  The window called Auxiliary Key Field Definition appears.

2. For Sorted on Key Field, enter the name of the field on which the Data Set is sorted.  If you press the Slash (/) key, you can select the field name from a list.  Use the arrow keys to move the cursor to the field that you want to select and press the Return key.

3. For Source, enter the designator of another Data Set that contains the field to be used as a lookup for this Data Set.  If you press the Slash (/) key, you can select the designator from a list.  Use the arrow keys to move the cursor to the designator of the Data Set that you want to select and press the Return key.

4. For Key Fields, enter the name of the field from the Data Set specified by the designator entered in Source that is to be used as the lookup key in this Data Set.  If you press the Slash (/) key, you can select the field name from a list.  Use the arrow keys to move the cursor to the field that you want to select and press the Return key.

5. After entering the required key fields for the Data Set, move the cursor to the Return menu item and press the Return key.  You will go back to the Define an Auxiliary Data Set menu.  Select the Return menu item to go back to the Setup Data Sets menu.

There is also a Help menu item and a Cancel menu item on the window that you can use at any time.  You can position the cursor on Help and press the Return key to look at help information for this window.  If you position the cursor on Cancel and press the Return key, the information you have entered so far for the key fields will be removed and you will go back to the Define an Auxiliary Data Set menu.

How To Modify A Data Set

1. Select the Modify function on the Setup Data Sets menu to change the Domains or Key Fields for one of the Data Sets in your list.

2. Move the cursor to the Data Set you wish to modify and press the Return key.

As appropriate, follow the instructions shown above:

How To Delete A Data Set

1. Select Delete on the Setup Data Sets menu.  A window will appear that asks you to confirm that you want to delete the last Data Set.

2. Move the cursor to Yes or No and press the Return key.  If you select Yes, the last Data Set will be removed from the window.  If you select No, no changes will be made to the Data Sets.  In either case, you will go back to the Setup Data Sets menu.